chromiumly 2.4.0 → 2.5.1

package/src/common/constants.ts

@@ -1,5 +1,5 @@
 export enum PdfFormat {
-  A_1a = "PDF/A-1a",
-  A_2b = "PDF/A-2b",
-  A_3b = "PDF/A-3b",
+    A_1a = "PDF/A-1a",
+    A_2b = "PDF/A-2b",
+    A_3b = "PDF/A-3b",
 }

package/src/common/gotenberg.utils.ts

@@ -1,25 +1,44 @@
 import FormData from "form-data";
 import fetch from "node-fetch";
 
+/**
+ * Utility class for common tasks related to the Gotenberg service.
+ */
 export class GotenbergUtils {
-  public static assert(condition: boolean, message: string): asserts condition {
-    if (!condition) {
-      throw new Error(message);
+    /**
+     * Asserts that a condition is true; otherwise, throws an error with the specified message.
+     *
+     * @param {boolean} condition - The condition to assert.
+     * @param {string} message - The error message to throw if the condition is false.
+     * @throws {Error} Throws an error with the specified message if the condition is false.
+     */
+    public static assert(condition: boolean, message: string): asserts condition {
+        if (!condition) {
+            throw new Error(message);
+        }
     }
-  }
 
-  public static async fetch(endpoint: string, data: FormData): Promise<Buffer> {
-    const response = await fetch(endpoint, {
-      method: "post",
-      body: data,
-      headers: {
-        ...data.getHeaders(),
-      },
-    });
+    /**
+     * Performs a POST request to the specified Gotenberg endpoint with the provided FormData.
+     *
+     * @param {string} endpoint - The Gotenberg endpoint URL.
+     * @param {FormData} data - The FormData object to be sent in the POST request.
+     * @returns {Promise<Buffer>} A Promise that resolves to the response body as a Buffer.
+     * @throws {Error} Throws an error if the HTTP response status is not OK.
+     */
+    public static async fetch(endpoint: string, data: FormData): Promise<Buffer> {
+        const response = await fetch(endpoint, {
+            method: "post",
+            body: data,
+            headers: {
+                ...data.getHeaders(),
+            },
+        });
 
-    if (!response.ok) {
-      throw new Error(`${response.status} ${response.statusText}`);
+        if (!response.ok) {
+            throw new Error(`${response.status} ${response.statusText}`);
+        }
+
+        return response.buffer();
     }
-    return response.buffer();
-  }
-}
+}

package/src/common/index.ts

@@ -1,2 +1,3 @@
-export { PdfFormat } from "./constants";
-export { GotenbergUtils } from "./gotenberg.utils";
+export {PdfFormat} from "./constants";
+export {GotenbergUtils} from "./gotenberg.utils";
+export {PathLikeOrReadStream} from "./types"

package/src/common/tests/gotenberg.utils.test.ts

@@ -1,71 +1,71 @@
 import fetch from "node-fetch";
 import FormData from "form-data";
 
-import { GotenbergUtils } from "./../gotenberg.utils";
+import {GotenbergUtils} from "./../gotenberg.utils";
 
-const { Response, FetchError } = jest.requireActual("node-fetch");
+const {Response, FetchError} = jest.requireActual("node-fetch");
 
 jest.mock("node-fetch", () => jest.fn());
 
 describe("GotenbergUtils", () => {
-  afterEach(() => {
-    jest.resetAllMocks();
-  });
-
-  describe("assert", () => {
-    const errorMessage = "error message";
-    describe("when condition is true", () => {
-      it("should pass", () => {
-        expect(() => GotenbergUtils.assert(true, errorMessage)).not.toThrow();
-      });
-    });
-    describe("when condition is false", () => {
-      it("should return error message", () => {
-        expect(() => GotenbergUtils.assert(false, errorMessage)).toThrow(
-          errorMessage
-        );
-      });
+    afterEach(() => {
+        jest.resetAllMocks();
     });
-  });
 
-  describe("fetch", () => {
-    const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
-    const data = new FormData();
-    const endpoint = "http://localhost:3000/forms/chromium/convert/html";
-
-    describe("when fetch request succeeds", () => {
-      it("should return a buffer", async () => {
-        mockFetch.mockResolvedValueOnce(new Response("content"));
-        const response = await GotenbergUtils.fetch(endpoint, data);
-        await expect(response).toEqual(Buffer.from("content"));
-      });
+    describe("assert", () => {
+        const errorMessage = "error message";
+        describe("when condition is true", () => {
+            it("should pass", () => {
+                expect(() => GotenbergUtils.assert(true, errorMessage)).not.toThrow();
+            });
+        });
+        describe("when condition is false", () => {
+            it("should return error message", () => {
+                expect(() => GotenbergUtils.assert(false, errorMessage)).toThrow(
+                    errorMessage
+                );
+            });
+        });
     });
 
-    describe("when fetch request fails", () => {
-      describe("when there is a known error", () => {
-        it("should throw an error", async () => {
-          const errorMessage =
-            "FetchError: request to http://localhost:3000/forms/chromium/convert/html failed";
-          mockFetch.mockRejectedValueOnce(new FetchError(errorMessage));
-          await expect(() =>
-            GotenbergUtils.fetch(endpoint, data)
-          ).rejects.toThrow(errorMessage);
+    describe("fetch", () => {
+        const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
+        const data = new FormData();
+        const endpoint = "http://localhost:3000/forms/chromium/convert/html";
+
+        describe("when fetch request succeeds", () => {
+            it("should return a buffer", async () => {
+                mockFetch.mockResolvedValueOnce(new Response("content"));
+                const response = await GotenbergUtils.fetch(endpoint, data);
+                await expect(response).toEqual(Buffer.from("content"));
+            });
         });
-      });
 
-      describe("when there is an unknown error", () => {
-        it("should throw an error", async () => {
-          mockFetch.mockResolvedValueOnce(
-            new Response(
-              {},
-              { status: 500, statusText: "Internal server error" }
-            )
-          );
-          await expect(() =>
-            GotenbergUtils.fetch(endpoint, data)
-          ).rejects.toThrow("500 Internal server error");
+        describe("when fetch request fails", () => {
+            describe("when there is a known error", () => {
+                it("should throw an error", async () => {
+                    const errorMessage =
+                        "FetchError: request to http://localhost:3000/forms/chromium/convert/html failed";
+                    mockFetch.mockRejectedValueOnce(new FetchError(errorMessage));
+                    await expect(() =>
+                        GotenbergUtils.fetch(endpoint, data)
+                    ).rejects.toThrow(errorMessage);
+                });
+            });
+
+            describe("when there is an unknown error", () => {
+                it("should throw an error", async () => {
+                    mockFetch.mockResolvedValueOnce(
+                        new Response(
+                            {},
+                            {status: 500, statusText: "Internal server error"}
+                        )
+                    );
+                    await expect(() =>
+                        GotenbergUtils.fetch(endpoint, data)
+                    ).rejects.toThrow("500 Internal server error");
+                });
+            });
         });
-      });
     });
-  });
 });

package/src/common/types.ts

@@ -0,0 +1,3 @@
+import {PathLike, ReadStream} from "fs";
+
+export type PathLikeOrReadStream = PathLike | ReadStream

package/src/gotenberg.ts

@@ -8,14 +8,23 @@ import config from "config";
 const envFile = `.env.${process.env.NODE_ENV}`;
 const envFileFallback = ".env";
 
-const dotenvConfig = dotenv.config({ path: path.resolve(envFile) });
+const dotenvConfig = dotenv.config({path: path.resolve(envFile)});
 
 // Fallback to loading the default environment file.
 if (dotenvConfig.error) {
-  dotenv.config({ path: path.resolve(envFileFallback) });
+    dotenv.config({path: path.resolve(envFileFallback)});
 }
 
+/**
+ * Class representing configuration for interacting with Gotenberg service.
+ */
 export class Gotenberg {
-  public static endpoint: string =
-    process.env.GOTENBERG_ENDPOINT || config.get<string>("gotenberg.endpoint");
+    /**
+     * The Gotenberg service endpoint.
+     * Defaults to the value from the environment variable `GOTENBERG_ENDPOINT`, or falls back to the configuration file.
+     * @type {string}
+     */
+    public static endpoint: string =
+        process.env.GOTENBERG_ENDPOINT || config.get<string>("gotenberg.endpoint");
 }
+

package/src/libre-office/index.ts

@@ -1,2 +1,2 @@
-export { PageProperties } from "./interfaces/libre-office.types";
-export { LibreOfficeUtils } from "./utils/libre-office.utils";
+export {PageProperties} from "./interfaces/libre-office.types";
+export {LibreOfficeUtils} from "./utils/libre-office.utils";

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

@@ -1,4 +1,4 @@
 export type PageProperties = {
-  landscape?: boolean; // Set the paper orientation to landscape (default false)
-  nativePageRanges?: { from: number; to: number }; // Page ranges to print
+    landscape?: boolean; // Set the paper orientation to landscape (default false)
+    nativePageRanges?: { from: number; to: number }; // Page ranges to print
 };

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

@@ -1,78 +1,78 @@
 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",
+    "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",
 ];

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

@@ -1,47 +1,82 @@
-import { constants, createReadStream, PathLike, promises } from "fs";
+import {constants, createReadStream, promises, ReadStream} from "fs";
 import path from "path";
 
+import {fromStream, fromBuffer} from "file-type";
+
 import FormData from "form-data";
 
-import { GotenbergUtils } 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.
+ */
 export class LibreOfficeUtils {
-  public static async injectFiles(files: PathLike[], data: FormData) {
-    for (const file of files) {
-      await promises.access(file, constants.R_OK);
-      const filename = path.basename(file.toString());
-      const extension = path.extname(filename);
-      if (LIBRE_OFFICE_EXTENSIONS.includes(extension)) {
-        data.append(filename, createReadStream(file));
-      } else {
-        throw new Error(`${extension} is not supported`);
-      }
-    }
-  }
-
-  public static injectPageProperties(
-    data: FormData,
-    pageProperties: PageProperties
-  ): void {
-    if (pageProperties.landscape) {
-      data.append("landscape", String(pageProperties.landscape));
+    /**
+     * 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) {
+        for (const [key, value] of files.entries()) {
+            let file = value;
+            let fileInfo;
+
+            if (Buffer.isBuffer(value)) {
+                fileInfo = await fromBuffer(value);
+            } else if (value instanceof ReadStream) {
+                fileInfo = await fromStream(value);
+            } else {
+                await promises.access(value, constants.R_OK);
+                const filename = path.basename(value.toString());
+                fileInfo = {ext: path.extname(filename).slice(1)};
+                file = createReadStream(value)
+            }
+
+            if (!fileInfo) {
+                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}`);
+            } else {
+                throw new Error(`${extension} is not supported`);
+            }
+        }
     }
 
-    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}`
-      );
+    /**
+     * 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}`
+            );
+        }
     }
-  }
 }