chromiumly 3.3.0 → 3.3.2

package/src/main.config.ts

@@ -1,157 +0,0 @@
-import { Gotenberg } from './gotenberg';
-
-/**
- * Enum representing the available Chromium routes for conversion.
- * @enum {string}
- */
-export enum ChromiumRoute {
-    URL = 'url',
-    HTML = 'html',
-    MARKDOWN = 'markdown'
-}
-
-/**
- * Enum representing the available routes for the PDF engine.
- * @enum {string}
- */
-enum PdfEngineRoute {
-    MERGE = 'merge',
-    READ_METADATA = 'metadata/read',
-    WRITE_METADATA = 'metadata/write'
-}
-
-/**
- * Enum representing the available routes for LibreOffice.
- * @enum {string}
- */
-enum LibreOfficeRoute {
-    CONVERT = 'convert'
-}
-
-/**
- * Class providing constants and routes for interacting with the Gotenberg service and related engines.
- */
-export class Chromiumly {
-    /**
-     * The Gotenberg service endpoint.
-     * @type {string}
-     */
-    private static gotenbergEndpoint: string | undefined = Gotenberg.endpoint;
-
-    /**
-     * The username for basic authentication with the Gotenberg service.
-     * @type {string | undefined}
-     */
-    private static gotenbergApiBasicAuthUsername: string | undefined =
-        Gotenberg.username;
-
-    /**
-     * The password for basic authentication with the Gotenberg service.
-     * @type {string | undefined}
-     */
-    private static gotenbergApiBasicAuthPassword: string | undefined =
-        Gotenberg.password;
-
-    /**
-     * The path for Chromium-related conversions.
-     * @type {string}
-     */
-    public static readonly CHROMIUM_CONVERT_PATH = 'forms/chromium/convert';
-
-    /**
-     * The path for Chromium-related screenshots.
-     * @type {string}
-     */
-    public static readonly CHROMIUM_SCREENSHOT_PATH =
-        'forms/chromium/screenshot';
-
-    /**
-     * The path for PDF engine-related operations.
-     * @type {string}
-     */
-    public static readonly PDF_ENGINES_PATH = 'forms/pdfengines';
-
-    /**
-     * The path for LibreOffice-related conversions.
-     * @type {string}
-     */
-    public static readonly LIBRE_OFFICE_PATH = 'forms/libreoffice';
-
-    /**
-     * Routes for Chromium conversions.
-     * @type {Object}
-     */
-    public static readonly CHROMIUM_ROUTES = {
-        url: ChromiumRoute.URL,
-        html: ChromiumRoute.HTML,
-        markdown: ChromiumRoute.MARKDOWN
-    };
-
-    /**
-     * Routes for PDF engine operations.
-     * @type {Object}
-     */
-    public static readonly PDF_ENGINE_ROUTES = {
-        merge: PdfEngineRoute.MERGE,
-        readMetadata: PdfEngineRoute.READ_METADATA,
-        writeMetadata: PdfEngineRoute.WRITE_METADATA
-    };
-
-    /**
-     * Routes for LibreOffice conversions.
-     * @type {Object}
-     */
-    public static readonly LIBRE_OFFICE_ROUTES = {
-        convert: LibreOfficeRoute.CONVERT
-    };
-
-    /**
-     * Configures the Gotenberg service endpoint and other optional parameters.
-     * @param {Object} config - Configuration object.
-     * @param {string} config.endpoint - The Gotenberg service endpoint.
-     * @param {string} [config.username] - The username for basic authentication.
-     * @param {string} [config.password] - The password for basic authentication.
-     */
-    public static configure(config: {
-        endpoint: string;
-        username?: string;
-        password?: string;
-    }): void {
-        this.gotenbergEndpoint = config.endpoint;
-
-        if (config.username !== undefined) {
-            this.gotenbergApiBasicAuthUsername = config.username;
-        }
-        if (config.password !== undefined) {
-            this.gotenbergApiBasicAuthPassword = config.password;
-        }
-    }
-
-    /**
-     * Gets the Gotenberg service endpoint.
-     * @returns {string}
-     */
-    public static getGotenbergEndpoint(): string {
-        if (!this.gotenbergEndpoint)
-            throw new Error(
-                'Gotenberg endpoint is not set. Please ensure that the Gotenberg service endpoint is configured correctly in your environment variables or through the configure method.'
-            );
-        return this.gotenbergEndpoint;
-    }
-
-    /**
-     * Gets the username for basic authentication.
-     * @returns {string | undefined}
-     */
-    public static getGotenbergApiBasicAuthUsername(): string | undefined {
-        return this.gotenbergApiBasicAuthUsername;
-    }
-
-    /**
-     * Gets the password for basic authentication.
-     * @returns {string | undefined}
-     */
-    public static getGotenbergApiBasicAuthPassword(): string | undefined {
-        return this.gotenbergApiBasicAuthPassword;
-    }
-}

package/src/main.ts

@@ -1,13 +0,0 @@
-export { Chromiumly } from './main.config';
-
-export { PdfFormat } from './common/constants';
-export {
-    HtmlConverter,
-    HtmlScreenshot,
-    MarkdownConverter,
-    MarkdownScreenshot,
-    UrlConverter,
-    UrlScreenshot
-} from './chromium';
-export { PDFEngines } from './pdf-engines';
-export { LibreOffice } from './libre-office';

package/src/pdf-engines/index.ts

@@ -1 +0,0 @@
-export { PDFEngines } from './pdf-engines';

package/src/pdf-engines/interfaces/pdf-engines.types.ts

@@ -1,10 +0,0 @@
-import { Metadata, PdfFormat } from '../../common';
-
-export type ConversionOptions = {
-    pdfa?: PdfFormat;
-    pdfUA?: boolean;
-};
-
-export type MergeOptions = ConversionOptions & {
-    metadata?: Metadata;
-};

package/src/pdf-engines/pdf-engines.ts

@@ -1,156 +0,0 @@
-import { promises } from 'fs';
-import path from 'path';
-
-import FormData from 'form-data';
-
-import { Chromiumly } from '../main.config';
-import {
-    GotenbergUtils,
-    PathLikeOrReadStream,
-    PdfFormat,
-    Metadata
-} from '../common';
-import { PDFEnginesUtils } from './utils/pdf-engines.utils';
-
-/**
- * Class uses PDF engines for various operations such as merging and conversion.
- */
-export class PDFEngines {
-    /**
-     * Merges multiple PDF files into a single PDF document.
-     *
-     * @param {Object} options - Options for the merge operation.
-     * @param {PathLikeOrReadStream[]} options.files - An array of PathLikes or ReadStreams to the PDF files to be merged.
-     * @returns {Promise<Buffer>} A Promise resolving to the merged PDF content as a Buffer.
-     */
-    public static async merge({
-        files,
-        pdfa,
-        pdfUA,
-        metadata
-    }: {
-        files: PathLikeOrReadStream[];
-        pdfa?: PdfFormat;
-        pdfUA?: boolean;
-        metadata?: Metadata;
-    }): Promise<Buffer> {
-        const data = new FormData();
-        await PDFEnginesUtils.addFiles(files, data);
-        await PDFEnginesUtils.customize(data, {
-            pdfa,
-            pdfUA,
-            metadata
-        });
-        const endpoint = `${Chromiumly.getGotenbergEndpoint()}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
-        return GotenbergUtils.fetch(
-            endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-
-    /**
-     * Converts various document formats to PDF.
-     *
-     * @param {Object} options - Options for the conversion operation.
-     * @param {PathLikeOrReadStream[]} options.files - An array of PathLikes or ReadStreams to the files to be converted to PDF.
-     * @param {pdfa} [options.pdfa] - PDF format options.
-     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
-     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
-     */
-    public static async convert({
-        files,
-        pdfa,
-        pdfUA
-    }: {
-        files: PathLikeOrReadStream[];
-        pdfa?: PdfFormat;
-        pdfUA?: boolean;
-    }): Promise<Buffer> {
-        const data = new FormData();
-
-        await PDFEnginesUtils.addFiles(files, data);
-        await PDFEnginesUtils.customize(data, {
-            pdfa,
-            pdfUA
-        });
-
-        const endpoint = `${Chromiumly.getGotenbergEndpoint()}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
-
-        return GotenbergUtils.fetch(
-            endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-
-    /**
-     * Reads metadata from the provided files.
-     *
-     * @param {PathLikeOrReadStream[]} files An array of PathLikes or ReadStreams to the PDF files.
-     * @returns {Promise<Buffer>} A Promise resolving to the metadata buffer.
-     */
-    public static async readMetadata(
-        files: PathLikeOrReadStream[]
-    ): Promise<Buffer> {
-        const data = new FormData();
-
-        await PDFEnginesUtils.addFiles(files, data);
-
-        const endpoint = `${Chromiumly.getGotenbergEndpoint()}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
-
-        return GotenbergUtils.fetch(
-            endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-
-    /**
-     * Writes metadata to the provided PDF files.
-     *
-     * @param {PathLikeOrReadStream[]} files - An array of PathLikes or ReadStreams to the PDF files.
-     * @param {Metadata} metadata - Metadata to be written.
-     * @returns {Promise<Buffer>} A Promise that resolves to the PDF file containing metadata as a buffer.
-     */
-    public static async writeMetadata({
-        files,
-        metadata
-    }: {
-        files: PathLikeOrReadStream[];
-        metadata: Metadata;
-    }): Promise<Buffer> {
-        const data = new FormData();
-        data.append('metadata', JSON.stringify(metadata));
-
-        await PDFEnginesUtils.addFiles(files, data);
-
-        const endpoint = `${Chromiumly.getGotenbergEndpoint()}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
-
-        return GotenbergUtils.fetch(
-            endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-
-    /**
-     * Generates a PDF file from a buffer and saves it to the "__generated__" directory.
-     *
-     * @param {string} filename - The filename for the generated PDF.
-     * @param {Buffer} buffer - The PDF content as a Buffer.
-     * @returns {Promise<void>} A Promise that resolves once the file is generated and saved.
-     */
-    public static async generate(
-        filename: string,
-        buffer: Buffer
-    ): Promise<void> {
-        const __generated__ = path.resolve(process.cwd(), '__generated__');
-        await promises.mkdir(path.resolve(__generated__), { recursive: true });
-        await promises.writeFile(path.resolve(__generated__, filename), buffer);
-    }
-}

package/src/pdf-engines/tests/pdf.engine.test.ts

@@ -1,163 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { createReadStream, promises } from 'fs';
-import FormData from 'form-data';
-import fs from 'fs/promises';
-import fetch from 'node-fetch';
-import path from 'path';
-
-import { PdfFormat } from '../../common';
-import { PDFEngines } from '../pdf-engines';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('PDFEngines', () => {
-    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()
-            .mockImplementation((file) => file);
-    });
-
-    afterEach(() => {
-        jest.resetAllMocks();
-    });
-
-    describe('convert', () => {
-        describe('when no properties are passed', () => {
-            it('should return a buffer', async () => {
-                mockPromisesAccess.mockResolvedValue();
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await PDFEngines.convert({
-                    files: ['path/to/file_1.pdf', 'path/to/file_2.pdf']
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-            });
-        });
-
-        describe('when properties are passed', () => {
-            it('should return a buffer', async () => {
-                mockPromisesAccess.mockResolvedValue();
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await PDFEngines.convert({
-                    files: ['path/to/file_1.pdf', 'path/to/file_2.pdf'],
-                    pdfa: PdfFormat.A_2b,
-                    pdfUA: true
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(4);
-            });
-        });
-    });
-
-    describe('merge', () => {
-        it('should return a buffer', async () => {
-            mockPromisesAccess.mockResolvedValue();
-            mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngines.merge({
-                files: ['path/to/file.pdf', 'path/to/another-file.pdf'],
-                pdfa: PdfFormat.A_2b,
-                pdfUA: true,
-                metadata: { Author: 'John Doe' }
-            });
-            expect(buffer).toEqual(Buffer.from('content'));
-            expect(mockFormDataAppend).toHaveBeenCalledTimes(5);
-        });
-    });
-
-    describe('readMetadata', () => {
-        it('should return a buffer', async () => {
-            mockPromisesAccess.mockResolvedValue();
-            mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngines.readMetadata(['path/to/file.pdf']);
-            expect(buffer).toEqual(Buffer.from('content'));
-            expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-        });
-    });
-
-    describe('writeMetadata', () => {
-        it('should return a buffer', async () => {
-            mockPromisesAccess.mockResolvedValue();
-            mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngines.writeMetadata({
-                files: ['path/to/file.pdf'],
-                metadata: {
-                    Author: 'John Doe',
-                    Copyright: 'John Doe',
-                    CreationDate: Date.now(),
-                    Creator: 'Chromiumly',
-                    Keywords: ['first', 'second'],
-                    Marked: true,
-                    ModDate: Date.now(),
-                    PDFVersion: 1.7,
-                    Producer: 'Chromiumly',
-                    Subject: 'Sample',
-                    Title: 'Sample',
-                    Trapped: 'Unknown'
-                }
-            });
-            expect(buffer).toEqual(Buffer.from('content'));
-            expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-        });
-    });
-
-    describe('generate', () => {
-        const mockFilename = 'test.pdf';
-        const mockBuffer = Buffer.from('mock pdf content');
-
-        afterAll(() => {
-            jest.restoreAllMocks();
-        });
-
-        it('should generate a PDF file', async () => {
-            const mockGeneratedDir = path.join(process.cwd(), '__generated__');
-            const mockGeneratedFilePath = path.join(
-                mockGeneratedDir,
-                mockFilename
-            );
-
-            const mockPromisesMkDir = jest
-                .spyOn(fs, 'mkdir')
-                .mockResolvedValueOnce(mockGeneratedDir);
-
-            const mockPromisesWriteFile = jest
-                .spyOn(fs, 'writeFile')
-                .mockResolvedValueOnce();
-
-            await PDFEngines.generate(mockFilename, mockBuffer);
-
-            expect(mockPromisesMkDir).toHaveBeenCalledWith(mockGeneratedDir, {
-                recursive: true
-            });
-
-            expect(mockPromisesWriteFile).toHaveBeenCalledWith(
-                mockGeneratedFilePath,
-                mockBuffer
-            );
-        });
-
-        it('should handle errors during file generation', async () => {
-            jest.spyOn(fs, 'mkdir').mockRejectedValueOnce(
-                new Error('Cannot create directory')
-            );
-
-            await expect(
-                PDFEngines.generate(mockFilename, mockBuffer)
-            ).rejects.toThrow('Cannot create directory');
-        });
-
-        it('should handle errors during file writing', async () => {
-            jest.spyOn(fs, 'writeFile').mockRejectedValueOnce(
-                new Error('Failed to write to file')
-            );
-
-            await expect(
-                PDFEngines.generate(mockFilename, mockBuffer)
-            ).rejects.toThrow('Failed to write to file');
-        });
-    });
-});

package/src/pdf-engines/utils/pdf-engines.utils.ts

@@ -1,68 +0,0 @@
-import { constants, createReadStream, promises, ReadStream } from 'fs';
-import path from 'path';
-
-import FormData from 'form-data';
-import { PathLikeOrReadStream } from '../../common';
-import {
-    ConversionOptions,
-    MergeOptions
-} from '../interfaces/pdf-engines.types';
-
-/**
- * Utility class for handling common tasks related to PDF engine operations.
- */
-export class PDFEnginesUtils {
-    /**
-     * Adds PDF files to the FormData object.
-     *
-     * @param {PathLikeOrReadStream[]} files - An array of PDF files to be added to the FormData.
-     * @param {FormData} data - The FormData object to which PDF files will be added.
-     * @throws {Error} Throws an error if the file extension is not supported.
-     */
-    public static async addFiles(
-        files: PathLikeOrReadStream[],
-        data: FormData
-    ) {
-        for (const [key, file] of files.entries()) {
-            const filename = `file${key}.pdf`;
-            if (Buffer.isBuffer(file)) {
-                data.append('files', file, filename);
-            } else if (file instanceof ReadStream) {
-                data.append('files', file, filename);
-            } else {
-                await promises.access(file, constants.R_OK);
-                const filename = path.basename(file.toString());
-                const extension = path.extname(filename);
-                if (extension === '.pdf') {
-                    data.append(filename, createReadStream(file));
-                } else {
-                    throw new Error(`${extension} is not supported`);
-                }
-            }
-        }
-    }
-
-    /**
-     * Customizes the FormData object based on the provided conversion options.
-     *
-     * @param {FormData} data - The FormData object to be customized.
-     * @param {ConversionOptions | MergeOptions} options - The 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 | MergeOptions
-    ): Promise<void> {
-        if (options.pdfa) {
-            data.append('pdfa', options.pdfa);
-        }
-
-        if (options.pdfUA) {
-            data.append('pdfUA', String(options.pdfUA));
-        }
-
-        if ('metadata' in options && options.metadata) {
-            data.append('metadata', JSON.stringify(options.metadata));
-        }
-    }
-}

package/src/pdf-engines/utils/tests/pdf-engines.utils.test.ts

@@ -1,71 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { createReadStream, promises } from 'fs';
-import FormData from 'form-data';
-import { PDFEnginesUtils } from '../pdf-engines.utils';
-
-describe('PDFEnginesUtils', () => {
-    const mockPromisesAccess = jest.spyOn(promises, 'access');
-    const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
-    const data = new FormData();
-
-    beforeEach(() => {
-        (createReadStream as jest.Mock) = jest
-            .fn()
-            .mockImplementation((file) => file);
-    });
-
-    afterEach(() => {
-        jest.resetAllMocks();
-    });
-
-    describe('addFiles', () => {
-        describe('when files exist', () => {
-            describe('when files parameter contains paths', () => {
-                it('should append each file to data', async () => {
-                    mockPromisesAccess.mockResolvedValue();
-                    await PDFEnginesUtils.addFiles(
-                        ['path/to/file.pdf', 'path/to/another-file.pdf'],
-                        data
-                    );
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                });
-            });
-            describe('when files parameter contains a buffer', () => {
-                it('should append each file to data', async () => {
-                    mockPromisesAccess.mockResolvedValue();
-                    await PDFEnginesUtils.addFiles(
-                        [Buffer.from('data'), 'path/to/another-file.pdf'],
-                        data
-                    );
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                });
-            });
-        });
-
-        describe('when one of the files is not PDF', () => {
-            it('should throw an error', async () => {
-                mockPromisesAccess.mockResolvedValue();
-                await expect(() =>
-                    PDFEnginesUtils.addFiles(
-                        ['path/to/file.docx', 'path/to/file.pdf'],
-                        data
-                    )
-                ).rejects.toThrow('.docx is not supported');
-            });
-        });
-
-        describe('when one of the files 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(() =>
-                    PDFEnginesUtils.addFiles(
-                        ['path/to/file.pdf', 'path/to/another-file.pdf'],
-                        data
-                    )
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-});