chromiumly 2.5.0 → 2.5.1

package/src/main.config.ts

@@ -1,37 +1,82 @@
 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",
 }
 
+/**
+ * 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}
+     */
     public static readonly GOTENBERG_ENDPOINT = Gotenberg.endpoint;
 
+    /**
+     * The path for Chromium-related conversions.
+     * @type {string}
+     */
     public static readonly CHROMIUM_PATH = "forms/chromium/convert";
+
+    /**
+     * 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,
     };
 
+    /**
+     * Routes for LibreOffice conversions.
+     * @type {Object}
+     */
     public static readonly LIBRE_OFFICE_ROUTES = {
         convert: LibreOfficeRoute.CONVERT,
     };
-}
+}

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

@@ -1,21 +1,42 @@
-import {PathLike, promises} from "fs";
+import {promises} from "fs";
 import path from "path";
 
 import FormData from "form-data";
 
 import {Chromiumly} from "../main.config";
-import {GotenbergUtils, PdfFormat} from "../common";
+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.
+ */
 export class PDFEngine {
-    public static async merge({files}: { files: PathLike[] }): Promise<Buffer> {
+    /**
+     * 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}: { 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}`;
         return GotenbergUtils.fetch(endpoint, data);
     }
 
+    /**
+     * 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 {PdfFormat} [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,
@@ -23,7 +44,7 @@ export class PDFEngine {
                                     pdfUA,
                                     merge,
                                 }: {
-        files: PathLike[];
+        files: PathLikeOrReadStream[];
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;
@@ -54,6 +75,13 @@ export class PDFEngine {
         return GotenbergUtils.fetch(endpoint, data);
     }
 
+    /**
+     * 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

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

@@ -4,10 +4,20 @@ import path from "path";
 import FormData from "form-data";
 import {PathLikeOrReadStream} from "../../common";
 
+/**
+ * Utility class for handling common tasks related to PDF engine operations.
+ */
 export class PDFEngineUtils {
+    /**
+     * 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}`
+            const filename = `file${key}.pdf`
             if (Buffer.isBuffer(file)) {
                 data.append("files", file, filename);
             } else if (file instanceof ReadStream) {