chromiumly 3.3.0 → 3.3.1

package/src/libre-office/interfaces/libre-office.types.ts

@@ -1,156 +0,0 @@
-import { ReadStream } from 'fs';
-import { Metadata, PdfFormat } from '../../common';
-
-type FileExtension =
-    | '123'
-    | '602'
-    | 'abw'
-    | 'bib'
-    | 'bmp'
-    | 'cdr'
-    | 'cgm'
-    | 'cmx'
-    | 'csv'
-    | 'cwk'
-    | 'dbf'
-    | 'dif'
-    | 'doc'
-    | 'docm'
-    | 'docx'
-    | 'dot'
-    | 'dotm'
-    | 'dotx'
-    | 'dxf'
-    | 'emf'
-    | 'eps'
-    | 'epub'
-    | 'fodg'
-    | 'fodp'
-    | 'fods'
-    | 'fodt'
-    | 'fopd'
-    | 'gif'
-    | 'htm'
-    | 'html'
-    | 'hwp'
-    | 'jpeg'
-    | 'jpg'
-    | 'key'
-    | 'ltx'
-    | 'lwp'
-    | 'mcw'
-    | 'met'
-    | 'mml'
-    | 'mw'
-    | 'numbers'
-    | 'odd'
-    | 'odg'
-    | 'odm'
-    | 'odp'
-    | 'ods'
-    | 'odt'
-    | 'otg'
-    | 'oth'
-    | 'otp'
-    | 'ots'
-    | 'ott'
-    | 'pages'
-    | 'pbm'
-    | 'pcd'
-    | 'pct'
-    | 'pcx'
-    | 'pdb'
-    | 'pdf'
-    | 'pgm'
-    | 'png'
-    | 'pot'
-    | 'potm'
-    | 'potx'
-    | 'ppm'
-    | 'pps'
-    | 'ppt'
-    | 'pptm'
-    | 'pptx'
-    | 'psd'
-    | 'psw'
-    | 'pub'
-    | 'pwp'
-    | 'pxl'
-    | 'ras'
-    | 'rtf'
-    | 'sda'
-    | 'sdc'
-    | 'sdd'
-    | 'sdp'
-    | 'sdw'
-    | 'sgl'
-    | 'slk'
-    | 'smf'
-    | 'stc'
-    | 'std'
-    | 'sti'
-    | 'stw'
-    | 'svg'
-    | 'svm'
-    | 'swf'
-    | 'sxc'
-    | 'sxd'
-    | 'sxg'
-    | 'sxi'
-    | 'sxm'
-    | 'sxw'
-    | 'tga'
-    | 'tif'
-    | 'tiff'
-    | 'txt'
-    | 'uof'
-    | 'uop'
-    | 'uos'
-    | 'uot'
-    | 'vdx'
-    | 'vor'
-    | 'vsd'
-    | 'vsdm'
-    | 'vsdx'
-    | 'wb2'
-    | 'wk1'
-    | 'wks'
-    | 'wmf'
-    | 'wpd'
-    | 'wpg'
-    | 'wps'
-    | 'xbm'
-    | 'xhtml'
-    | 'xls'
-    | 'xlsb'
-    | 'xlsm'
-    | 'xlsx'
-    | 'xlt'
-    | 'xltm'
-    | 'xltx'
-    | 'xlw'
-    | 'xml'
-    | 'xpm'
-    | 'zabw';
-
-type FileInfo = {
-    data: Buffer | ReadStream;
-    ext: FileExtension;
-};
-
-export type PathLikeOrReadStream = string | FileInfo;
-
-export type PageProperties = {
-    landscape?: boolean; // Set the paper orientation to landscape (default false)
-    nativePageRanges?: { from: number; to: number }; // Page ranges to print
-    exportFormFields?: boolean; // Set whether to export the form fields or to use the inputted/selected content of the fields (default true)
-    singlePageSheets?: boolean; // Set whether to render the entire spreadsheet as a single page. (default false)
-};
-
-export type ConversionOptions = {
-    properties?: PageProperties;
-    merge?: boolean;
-    pdfa?: PdfFormat;
-    pdfUA?: boolean;
-    metadata?: Metadata;
-};

package/src/libre-office/libre-office.ts

@@ -1,61 +0,0 @@
-import FormData from 'form-data';
-
-import { Chromiumly } from '../main.config';
-import { GotenbergUtils, PdfFormat, Metadata } from '../common';
-import {
-    PageProperties,
-    PathLikeOrReadStream
-} from './interfaces/libre-office.types';
-import { LibreOfficeUtils } from './utils/libre-office.utils';
-
-/**
- * Class representing a LibreOffice for various operations such as merging and conversion.
- */
-export class LibreOffice {
-    /**
-     * 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 {PageProperties} [options.properties] - Page properties for the conversion.
-     * @param {pdfa} [options.pdfFormat] - PDF format options.
-     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
-     * @param {boolean} [options.merge] - Indicates whether to merge the resulting PDFs.
-     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
-     */
-    public static async convert({
-        files,
-        properties,
-        pdfa,
-        pdfUA,
-        merge,
-        metadata
-    }: {
-        files: PathLikeOrReadStream[];
-        properties?: PageProperties;
-        pdfa?: PdfFormat;
-        pdfUA?: boolean;
-        merge?: boolean;
-        metadata?: Metadata;
-    }): Promise<Buffer> {
-        const data = new FormData();
-
-        await LibreOfficeUtils.addFiles(files, data);
-        await LibreOfficeUtils.customize(data, {
-            properties,
-            merge,
-            pdfa,
-            pdfUA,
-            metadata
-        });
-
-        const endpoint = `${Chromiumly.getGotenbergEndpoint()}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
-
-        return GotenbergUtils.fetch(
-            endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-}

package/src/libre-office/tests/libre-office.test.ts

@@ -1,56 +0,0 @@
-import { LibreOffice } from '../libre-office';
-// 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';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('LibreOffice', () => {
-    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 LibreOffice.convert({
-                    files: ['path/to/file.docx', 'path/to/file.bib']
-                });
-                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 LibreOffice.convert({
-                    files: ['path/to/file.docx', 'path/to/file.bib'],
-                    properties: { landscape: true },
-                    pdfa: PdfFormat.A_2b,
-                    pdfUA: true,
-                    metadata: { author: 'John Doe' },
-                    merge: true
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(7);
-            });
-        });
-    });
-});

package/src/libre-office/utils/constants.ts

@@ -1,132 +0,0 @@
-export const LIBRE_OFFICE_EXTENSIONS = [
-    '123',
-    '602',
-    'abw',
-    'bib',
-    'bmp',
-    'cdr',
-    'cgm',
-    'cmx',
-    'csv',
-    'cwk',
-    'dbf',
-    'dif',
-    'doc',
-    'docm',
-    'docx',
-    'dot',
-    'dotm',
-    'dotx',
-    'dxf',
-    'emf',
-    'eps',
-    'epub',
-    'fodg',
-    'fodp',
-    'fods',
-    'fodt',
-    'fopd',
-    'gif',
-    'htm',
-    'html',
-    'hwp',
-    'jpeg',
-    'jpg',
-    'key',
-    'ltx',
-    'lwp',
-    'mcw',
-    'met',
-    'mml',
-    'mw',
-    'numbers',
-    'odd',
-    'odg',
-    'odm',
-    'odp',
-    'ods',
-    'odt',
-    'otg',
-    'oth',
-    'otp',
-    'ots',
-    'ott',
-    'pages',
-    'pbm',
-    'pcd',
-    'pct',
-    'pcx',
-    'pdb',
-    'pdf',
-    'pgm',
-    'png',
-    'pot',
-    'potm',
-    'potx',
-    'ppm',
-    'pps',
-    'ppt',
-    'pptm',
-    'pptx',
-    'psd',
-    'psw',
-    'pub',
-    'pwp',
-    'pxl',
-    'ras',
-    'rtf',
-    'sda',
-    'sdc',
-    'sdd',
-    'sdp',
-    'sdw',
-    'sgl',
-    'slk',
-    'smf',
-    'stc',
-    'std',
-    'sti',
-    'stw',
-    'svg',
-    'svm',
-    'swf',
-    'sxc',
-    'sxd',
-    'sxg',
-    'sxi',
-    'sxm',
-    'sxw',
-    'tga',
-    'tif',
-    'tiff',
-    'txt',
-    'uof',
-    'uop',
-    'uos',
-    'uot',
-    'vdx',
-    'vor',
-    'vsd',
-    'vsdm',
-    'vsdx',
-    'wb2',
-    'wk1',
-    'wks',
-    'wmf',
-    'wpd',
-    'wpg',
-    'wps',
-    'xbm',
-    'xhtml',
-    'xls',
-    'xlsb',
-    'xlsm',
-    'xlsx',
-    'xlt',
-    'xltm',
-    'xltx',
-    'xlw',
-    'xml',
-    'xpm',
-    'zabw'
-];

package/src/libre-office/utils/libre-office.utils.ts

@@ -1,128 +0,0 @@
-import { constants, createReadStream, promises } from 'fs';
-import path from 'path';
-
-import FormData from 'form-data';
-
-import { GotenbergUtils } from '../../common';
-import { LIBRE_OFFICE_EXTENSIONS } from './constants';
-import {
-    ConversionOptions,
-    PageProperties,
-    PathLikeOrReadStream
-} from '../interfaces/libre-office.types';
-
-/**
- * Utility class for handling common tasks related to LibreOffice conversions.
- */
-export class LibreOfficeUtils {
-    private static async getFileInfo(file: PathLikeOrReadStream) {
-        if (typeof file === 'string') {
-            await promises.access(file, constants.R_OK);
-            const filename = path.basename(path.parse(file).base);
-            return {
-                data: createReadStream(file),
-                ext: path.extname(filename).slice(1)
-            };
-        } else {
-            return { data: file.data, ext: file.ext };
-        }
-    }
-
-    /**
-     * Adds files to the FormData object for LibreOffice conversion.
-     *
-     * @param {PathLikeOrReadStream[]} files - An array of files to be added to the FormData.
-     * @param {FormData} data - The FormData object to which files will be added.
-     * @throws {Error} Throws an error if the file extension is not supported.
-     */
-    public static async addFiles(
-        files: PathLikeOrReadStream[],
-        data: FormData
-    ) {
-        await Promise.all(
-            files.map(async (file, key) => {
-                const fileInfo = await this.getFileInfo(file);
-                if (!LIBRE_OFFICE_EXTENSIONS.includes(fileInfo.ext)) {
-                    throw new Error(`${fileInfo.ext} is not supported`);
-                }
-                data.append('files', fileInfo.data, `${key}.${fileInfo.ext}`);
-            })
-        );
-    }
-
-    /**
-     * 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.landscape) {
-            data.append('landscape', String(pageProperties.landscape));
-        }
-
-        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}`
-            );
-        }
-
-        if (pageProperties.exportFormFields === false) {
-            data.append(
-                'exportFormFields',
-                String(pageProperties.exportFormFields)
-            );
-        }
-
-        if (pageProperties.singlePageSheets) {
-            data.append(
-                'singlePageSheets',
-                String(pageProperties.singlePageSheets)
-            );
-        }
-    }
-
-    /**
-     * 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.pdfa) {
-            data.append('pdfa', options.pdfa);
-        }
-
-        if (options.pdfUA) {
-            data.append('pdfUA', String(options.pdfUA));
-        }
-
-        if (options.merge) {
-            data.append('merge', String(options.merge));
-        }
-
-        if (options.metadata) {
-            data.append('metadata', JSON.stringify(options.metadata));
-        }
-
-        if (options.properties) {
-            LibreOfficeUtils.addPageProperties(data, options.properties);
-        }
-    }
-}

package/src/libre-office/utils/tests/libre-office.utils.test.ts

@@ -1,156 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { promises, createReadStream } from 'fs';
-import { LibreOfficeUtils } from '../libre-office.utils';
-
-import FormData from 'form-data';
-
-describe('LibreOfficeUtils', () => {
-    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 LibreOfficeUtils.addFiles(
-                        ['path/to/file.docx', 'path/to/file.bib'],
-                        data
-                    );
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                });
-            });
-            describe('when files parameter contains a buffer', () => {
-                it('should append each file to data', async () => {
-                    mockPromisesAccess.mockResolvedValueOnce();
-                    await LibreOfficeUtils.addFiles(
-                        [
-                            { data: Buffer.from('data'), ext: 'csv' },
-                            'path/to/file.bib'
-                        ],
-                        data
-                    );
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                });
-            });
-        });
-
-        describe('when one of the files has undetermined format', () => {
-            it('should throw an error', async () => {
-                mockPromisesAccess.mockResolvedValueOnce();
-
-                await expect(
-                    LibreOfficeUtils.addFiles(
-                        [
-                            { data: Buffer.from('data'), ext: 'docx' },
-                            'path/to/file.none'
-                        ],
-                        data
-                    )
-                ).rejects.toThrow('none is not supported');
-            });
-        });
-
-        describe('when one of the files has unsupported format', () => {
-            it('should throw an error', async () => {
-                mockPromisesAccess.mockResolvedValueOnce();
-                await expect(() =>
-                    LibreOfficeUtils.addFiles(
-                        ['path/to/file.rar', 'path/to/file.pdf'],
-                        data
-                    )
-                ).rejects.toThrow('rar 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.mockRejectedValueOnce(
-                    new Error(errorMessage)
-                );
-                await expect(() =>
-                    LibreOfficeUtils.addFiles(
-                        ['path/to/file.pdf', 'path/to/another-file.pdf'],
-                        data
-                    )
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-
-    describe('addPageProperties', () => {
-        describe('Page landscape', () => {
-            describe('when landscape parameter is set', () => {
-                it('should append landscape to data', () => {
-                    LibreOfficeUtils.addPageProperties(data, {
-                        landscape: true
-                    });
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith(
-                        'landscape',
-                        'true'
-                    );
-                });
-            });
-        });
-
-        describe('Export form fields', () => {
-            describe('when exportFormFields parameter is set', () => {
-                it('should append exportFormFields to data', () => {
-                    LibreOfficeUtils.addPageProperties(data, {
-                        exportFormFields: false
-                    });
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith(
-                        'exportFormFields',
-                        'false'
-                    );
-                });
-            });
-        });
-
-        describe('Page ranges', () => {
-            describe('when nativePageRanges is valid', () => {
-                it('should append nativePageRanges to data', () => {
-                    LibreOfficeUtils.addPageProperties(data, {
-                        nativePageRanges: { from: 1, to: 6 }
-                    });
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith(
-                        'nativePageRanges',
-                        '1-6'
-                    );
-                });
-            });
-        });
-
-        describe('Single page sheets', () => {
-            describe('when singlePageSheets parameter is set', () => {
-                it('should append singlePageSheets to data', () => {
-                    LibreOfficeUtils.addPageProperties(data, {
-                        singlePageSheets: true
-                    });
-                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith(
-                        'singlePageSheets',
-                        'true'
-                    );
-                });
-            });
-        });
-    });
-});