chromiumly 2.6.0 → 2.8.0

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

@@ -1,78 +1,82 @@
 export const LIBRE_OFFICE_EXTENSIONS = [
-    "bib",
-    "doc",
-    "xml",
-    "docx",
-    "fodt",
-    "html",
-    "ltx",
-    "txt",
-    "odt",
-    "ott",
-    "pdb",
-    "pdf",
-    "psw",
-    "rtf",
-    "sdw",
-    "stw",
-    "sxw",
-    "uot",
-    "vor",
-    "wps",
-    "epub",
-    "png",
-    "bmp",
-    "emf",
-    "eps",
-    "fodg",
-    "gif",
-    "jpg",
-    "met",
-    "odd",
-    "otg",
-    "pbm",
-    "pct",
-    "pgm",
-    "ppm",
-    "ras",
-    "std",
-    "svg",
-    "svm",
-    "swf",
-    "sxd",
-    "sxw",
-    "tiff",
-    "xhtml",
-    "xpm",
-    "fodp",
-    "potm",
-    "pot",
-    "pptx",
-    "pps",
-    "ppt",
-    "pwp",
-    "sda",
-    "sdd",
-    "sti",
-    "sxi",
-    "uop",
-    "wmf",
-    "csv",
-    "dbf",
-    "dif",
-    "fods",
-    "ods",
-    "ots",
-    "pxl",
-    "sdc",
-    "slk",
-    "stc",
-    "sxc",
-    "uos",
-    "xls",
-    "xlt",
-    "xlsx",
-    "tif",
-    "jpeg",
-    "odp",
+    'bib',
+    'doc',
+    'xml',
+    'docx',
+    'fodt',
+    'html',
+    'ltx',
+    'txt',
+    'odt',
+    'ott',
+    'pdb',
+    'pdf',
+    'psw',
+    'rtf',
+    'sdw',
+    'stw',
+    'sxw',
+    'uot',
+    'vor',
+    'wps',
+    'epub',
+    'png',
+    'bmp',
+    'emf',
+    'eps',
+    'fodg',
+    'gif',
+    'jpg',
+    'met',
+    'odd',
+    'otg',
+    'pbm',
+    'pct',
+    'pgm',
+    'ppm',
+    'ras',
+    'std',
+    'svg',
+    'svm',
+    'swf',
+    'sxd',
+    'sxw',
+    'tiff',
+    'xhtml',
+    'xpm',
+    'fodp',
+    'pages',
+    'potm',
+    'pot',
+    'pptx',
+    'pps',
+    'ppt',
+    'pwp',
+    'sda',
+    'sdd',
+    'sti',
+    'sxi',
+    'uop',
+    'wmf',
+    'csv',
+    'dbf',
+    'dif',
+    'fods',
+    'ods',
+    'ots',
+    'pxl',
+    'sdc',
+    'slk',
+    'stc',
+    'sxc',
+    'uos',
+    'xls',
+    'xlt',
+    'xlsx',
+    'tif',
+    'jpeg',
+    'odp',
+    'odg',
+    'dotx',
+    'xltx'
 ];

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

@@ -1,13 +1,13 @@
-import {constants, createReadStream, promises, ReadStream} from "fs";
-import path from "path";
+import { constants, createReadStream, promises, ReadStream } from 'fs';
+import path from 'path';
 
-import {fromStream, fromBuffer} from "file-type";
+import { fromStream, fromBuffer } from 'file-type';
 
-import FormData from "form-data";
+import FormData from 'form-data';
 
-import {GotenbergUtils, PathLikeOrReadStream} from "../../common";
-import {LIBRE_OFFICE_EXTENSIONS} from "./constants";
-import {PageProperties} from "../interfaces/libre-office.types";
+import { GotenbergUtils, PathLikeOrReadStream } from '../../common';
+import { LIBRE_OFFICE_EXTENSIONS } from './constants';
+import { PageProperties } from '../interfaces/libre-office.types';
 
 /**
  * Utility class for handling common tasks related to LibreOffice conversions.
@@ -20,7 +20,10 @@ export class LibreOfficeUtils {
      * @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) {
+    public static async addFiles(
+        files: PathLikeOrReadStream[],
+        data: FormData
+    ) {
         for (const [key, value] of files.entries()) {
             let file = value;
             let fileInfo;
@@ -32,18 +35,18 @@ export class LibreOfficeUtils {
             } else {
                 await promises.access(value, constants.R_OK);
                 const filename = path.basename(value.toString());
-                fileInfo = {ext: path.extname(filename).slice(1)};
-                file = createReadStream(value)
+                fileInfo = { ext: path.extname(filename).slice(1) };
+                file = createReadStream(value);
             }
 
             if (!fileInfo) {
-                throw new Error("File type could not be determined");
+                throw new Error('File type could not be determined');
             }
 
             const extension = fileInfo.ext;
 
             if (LIBRE_OFFICE_EXTENSIONS.includes(extension)) {
-                data.append("files", file, `${key}.${extension}`);
+                data.append('files', file, `${key}.${extension}`);
             } else {
                 throw new Error(`${extension} is not supported`);
             }
@@ -61,20 +64,20 @@ export class LibreOfficeUtils {
         pageProperties: PageProperties
     ): void {
         if (pageProperties.landscape) {
-            data.append("landscape", String(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"
+                    pageProperties.nativePageRanges.to > 0 &&
+                    pageProperties.nativePageRanges.to >=
+                        pageProperties.nativePageRanges.from,
+                'page ranges syntax error'
             );
 
             data.append(
-                "nativePageRanges",
+                'nativePageRanges',
                 `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`
             );
         }

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

@@ -1,14 +1,14 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import {promises, createReadStream} from "fs";
-import {LibreOfficeUtils} from "../libre-office.utils";
+import { promises, createReadStream } from 'fs';
+import { LibreOfficeUtils } from '../libre-office.utils';
 
-import FormData from "form-data";
-import FileType from "file-type";
+import FormData from 'form-data';
+import FileType from 'file-type';
 
-describe("LibreOfficeUtils", () => {
-    const mockPromisesAccess = jest.spyOn(promises, "access");
-    const mockFormDataAppend = jest.spyOn(FormData.prototype, "append");
-    const mockFromBuffer = jest.spyOn(FileType, "fromBuffer");
+describe('LibreOfficeUtils', () => {
+    const mockPromisesAccess = jest.spyOn(promises, 'access');
+    const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
+    const mockFromBuffer = jest.spyOn(FileType, 'fromBuffer');
 
     const data = new FormData();
 
@@ -22,67 +22,70 @@ describe("LibreOfficeUtils", () => {
         jest.resetAllMocks();
     });
 
-    describe("addFiles", () => {
-        describe("when files exist", () => {
-            describe("when files parameter contains paths", () => {
-                it("should append each file to data", async () => {
+    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"],
+                        ['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 () => {
+            });
+            describe('when files parameter contains a buffer', () => {
+                it('should append each file to data', async () => {
                     mockPromisesAccess.mockResolvedValueOnce();
                     mockFromBuffer.mockResolvedValueOnce({
-                        ext: "docx",
-                        mime: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
-                    })
+                        ext: 'docx',
+                        mime: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+                    });
                     await LibreOfficeUtils.addFiles(
-                        [Buffer.from("data"), "path/to/file.bib"],
+                        [Buffer.from('data'), 'path/to/file.bib'],
                         data
                     );
                     expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
                 });
-            })
+            });
         });
 
-        describe("when one of the files has undetermined format", () => {
-            it("should throw an error", async () => {
+        describe('when one of the files has undetermined format', () => {
+            it('should throw an error', async () => {
                 mockPromisesAccess.mockResolvedValueOnce();
-                mockFromBuffer.mockResolvedValueOnce(undefined
-                )
+                mockFromBuffer.mockResolvedValueOnce(undefined);
 
-                await expect(LibreOfficeUtils.addFiles(
-                    [Buffer.from("data"), "path/to/file.bib"],
-                    data
-                )).rejects.toThrow("File type could not be determined");
+                await expect(
+                    LibreOfficeUtils.addFiles(
+                        [Buffer.from('data'), 'path/to/file.bib'],
+                        data
+                    )
+                ).rejects.toThrow('File type could not be determined');
             });
-        })
+        });
 
-        describe("when one of the files has unsupported format", () => {
-            it("should throw an error", async () => {
+        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"],
+                        ['path/to/file.rar', 'path/to/file.pdf'],
                         data
                     )
-                ).rejects.toThrow("rar is not supported");
+                ).rejects.toThrow('rar is not supported');
             });
         });
 
-        describe("when one of the files does not exist", () => {
-            it("should throw an error", async () => {
+        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));
+                mockPromisesAccess.mockRejectedValueOnce(
+                    new Error(errorMessage)
+                );
                 await expect(() =>
                     LibreOfficeUtils.addFiles(
-                        ["path/to/file.pdf", "path/to/another-file.pdf"],
+                        ['path/to/file.pdf', 'path/to/another-file.pdf'],
                         data
                     )
                 ).rejects.toThrow(errorMessage);
@@ -90,27 +93,33 @@ describe("LibreOfficeUtils", () => {
         });
     });
 
-    describe("addPageProperties", () => {
-        describe("Page landscape", () => {
-            describe("when landscape parameter is set", () => {
-                it("should append landscape to data", () => {
+    describe('addPageProperties', () => {
+        describe('Page landscape', () => {
+            describe('when landscape parameter is set', () => {
+                it('should append landscape to data', () => {
                     LibreOfficeUtils.addPageProperties(data, {
-                        landscape: true,
+                        landscape: true
                     });
                     expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith("landscape", "true");
+                    expect(data.append).toHaveBeenCalledWith(
+                        'landscape',
+                        'true'
+                    );
                 });
             });
         });
 
-        describe("Page ranges", () => {
-            describe("when nativePageRanges is valid", () => {
-                it("should append nativePageRanges to data", () => {
+        describe('Page ranges', () => {
+            describe('when nativePageRanges is valid', () => {
+                it('should append nativePageRanges to data', () => {
                     LibreOfficeUtils.addPageProperties(data, {
-                        nativePageRanges: {from: 1, to: 6},
+                        nativePageRanges: { from: 1, to: 6 }
                     });
                     expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
-                    expect(data.append).toHaveBeenCalledWith("nativePageRanges", "1-6");
+                    expect(data.append).toHaveBeenCalledWith(
+                        'nativePageRanges',
+                        '1-6'
+                    );
                 });
             });
         });

package/src/main.config.ts

@@ -1,13 +1,13 @@
-import {Gotenberg} from "./gotenberg";
+import { Gotenberg } from './gotenberg';
 
 /**
  * Enum representing the available Chromium routes for conversion.
  * @enum {string}
  */
 export enum ChromiumRoute {
-    URL = "url",
-    HTML = "html",
-    MARKDOWN = "markdown",
+    URL = 'url',
+    HTML = 'html',
+    MARKDOWN = 'markdown'
 }
 
 /**
@@ -15,7 +15,7 @@ export enum ChromiumRoute {
  * @enum {string}
  */
 enum PdfEngineRoute {
-    MERGE = "merge",
+    MERGE = 'merge'
 }
 
 /**
@@ -23,7 +23,7 @@ enum PdfEngineRoute {
  * @enum {string}
  */
 enum LibreOfficeRoute {
-    CONVERT = "convert",
+    CONVERT = 'convert'
 }
 
 /**
@@ -40,19 +40,25 @@ export class Chromiumly {
      * The path for Chromium-related conversions.
      * @type {string}
      */
-    public static readonly CHROMIUM_PATH = "forms/chromium/convert";
+    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";
+    public static readonly PDF_ENGINES_PATH = 'forms/pdfengines';
 
     /**
      * The path for LibreOffice-related conversions.
      * @type {string}
      */
-    public static readonly LIBRE_OFFICE_PATH = "forms/libreoffice";
+    public static readonly LIBRE_OFFICE_PATH = 'forms/libreoffice';
 
     /**
      * Routes for Chromium conversions.
@@ -61,7 +67,7 @@ export class Chromiumly {
     public static readonly CHROMIUM_ROUTES = {
         url: ChromiumRoute.URL,
         html: ChromiumRoute.HTML,
-        markdown: ChromiumRoute.MARKDOWN,
+        markdown: ChromiumRoute.MARKDOWN
     };
 
     /**
@@ -69,7 +75,7 @@ export class Chromiumly {
      * @type {Object}
      */
     public static readonly PDF_ENGINE_ROUTES = {
-        merge: PdfEngineRoute.MERGE,
+        merge: PdfEngineRoute.MERGE
     };
 
     /**
@@ -77,6 +83,6 @@ export class Chromiumly {
      * @type {Object}
      */
     public static readonly LIBRE_OFFICE_ROUTES = {
-        convert: LibreOfficeRoute.CONVERT,
+        convert: LibreOfficeRoute.CONVERT
     };
-}
+}

package/src/main.ts

@@ -1,3 +1,10 @@
-export {PdfFormat} from "./common/constants";
-export {HtmlConverter, MarkdownConverter, UrlConverter} from "./chromium";
-export {PDFEngine} from "./pdf-engines";
+export { PdfFormat } from './common/constants';
+export {
+    HtmlConverter,
+    HtmlScreenshot,
+    MarkdownConverter,
+    MarkdownScreenshot,
+    UrlConverter,
+    UrlScreenshot
+} from './chromium';
+export { PDFEngine } from './pdf-engines';

package/src/pdf-engines/index.ts

@@ -1 +1 @@
-export {PDFEngine} from "./pdf.engine";
+export { PDFEngine } from './pdf.engine';

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

@@ -1,12 +1,12 @@
-import {promises} from "fs";
-import path from "path";
+import { promises } from 'fs';
+import path from 'path';
 
-import FormData from "form-data";
+import FormData from 'form-data';
 
-import {Chromiumly} from "../main.config";
-import {GotenbergUtils, PathLikeOrReadStream, PdfFormat} from "../common";
-import {LibreOfficeUtils, PageProperties} from "../libre-office";
-import {PDFEngineUtils} from "./utils/engine.utils";
+import { Chromiumly } from '../main.config';
+import { GotenbergUtils, PathLikeOrReadStream, PdfFormat } from '../common';
+import { LibreOfficeUtils, PageProperties } from '../libre-office';
+import { PDFEngineUtils } from './utils/engine.utils';
 
 /**
  * Class representing a PDF engine for various operations such as merging and conversion.
@@ -19,7 +19,11 @@ export class PDFEngine {
      * @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}: { files: PathLikeOrReadStream[] }): Promise<Buffer> {
+    public static async merge({
+        files
+    }: {
+        files: PathLikeOrReadStream[];
+    }): Promise<Buffer> {
         const data = new FormData();
         await PDFEngineUtils.addFiles(files, data);
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
@@ -38,12 +42,12 @@ export class PDFEngine {
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
     public static async convert({
-                                    files,
-                                    properties,
-                                    pdfFormat,
-                                    pdfUA,
-                                    merge,
-                                }: {
+        files,
+        properties,
+        pdfFormat,
+        pdfUA,
+        merge
+    }: {
         files: PathLikeOrReadStream[];
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
@@ -53,15 +57,15 @@ export class PDFEngine {
         const data = new FormData();
 
         if (pdfFormat) {
-            data.append("pdfa", pdfFormat);
+            data.append('pdfa', pdfFormat);
         }
 
         if (pdfUA) {
-            data.append("pdfUA", String(pdfUA));
+            data.append('pdfUA', String(pdfUA));
         }
 
         if (merge) {
-            data.append("merge", String(merge));
+            data.append('merge', String(merge));
         }
 
         if (properties) {
@@ -86,8 +90,8 @@ export class PDFEngine {
         filename: string,
         buffer: Buffer
     ): Promise<void> {
-        const __generated__ = path.resolve(process.cwd(), "__generated__");
-        await promises.mkdir(path.resolve(__generated__), {recursive: true});
+        const __generated__ = path.resolve(process.cwd(), '__generated__');
+        await promises.mkdir(path.resolve(__generated__), { recursive: true });
         await promises.writeFile(path.resolve(__generated__, filename), buffer);
     }
 }