chromiumly 2.4.0 → 2.5.1

package/dist/main.config.d.ts

@@ -1,27 +1,70 @@
+/**
+ * Enum representing the available Chromium routes for conversion.
+ * @enum {string}
+ */
 export declare enum ChromiumRoute {
     URL = "url",
     HTML = "html",
     MARKDOWN = "markdown"
 }
+/**
+ * Enum representing the available routes for the PDF engine.
+ * @enum {string}
+ */
 declare enum PdfEngineRoute {
     MERGE = "merge"
 }
+/**
+ * Enum representing the available routes for LibreOffice.
+ * @enum {string}
+ */
 declare enum LibreOfficeRoute {
     CONVERT = "convert"
 }
+/**
+ * Class providing constants and routes for interacting with the Gotenberg service and related engines.
+ */
 export declare class Chromiumly {
+    /**
+     * The Gotenberg service endpoint.
+     * @type {string}
+     */
     static readonly GOTENBERG_ENDPOINT: string;
+    /**
+     * The path for Chromium-related conversions.
+     * @type {string}
+     */
     static readonly CHROMIUM_PATH = "forms/chromium/convert";
+    /**
+     * The path for PDF engine-related operations.
+     * @type {string}
+     */
     static readonly PDF_ENGINES_PATH = "forms/pdfengines";
+    /**
+     * The path for LibreOffice-related conversions.
+     * @type {string}
+     */
     static readonly LIBRE_OFFICE_PATH = "forms/libreoffice";
+    /**
+     * Routes for Chromium conversions.
+     * @type {Object}
+     */
     static readonly CHROMIUM_ROUTES: {
         url: ChromiumRoute;
         html: ChromiumRoute;
         markdown: ChromiumRoute;
     };
+    /**
+     * Routes for PDF engine operations.
+     * @type {Object}
+     */
     static readonly PDF_ENGINE_ROUTES: {
         merge: PdfEngineRoute;
     };
+    /**
+     * Routes for LibreOffice conversions.
+     * @type {Object}
+     */
     static readonly LIBRE_OFFICE_ROUTES: {
         convert: LibreOfficeRoute;
     };

package/dist/main.config.js

@@ -2,35 +2,78 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Chromiumly = exports.ChromiumRoute = void 0;
 const gotenberg_1 = require("./gotenberg");
+/**
+ * Enum representing the available Chromium routes for conversion.
+ * @enum {string}
+ */
 var ChromiumRoute;
 (function (ChromiumRoute) {
     ChromiumRoute["URL"] = "url";
     ChromiumRoute["HTML"] = "html";
     ChromiumRoute["MARKDOWN"] = "markdown";
 })(ChromiumRoute || (exports.ChromiumRoute = ChromiumRoute = {}));
+/**
+ * Enum representing the available routes for the PDF engine.
+ * @enum {string}
+ */
 var PdfEngineRoute;
 (function (PdfEngineRoute) {
     PdfEngineRoute["MERGE"] = "merge";
 })(PdfEngineRoute || (PdfEngineRoute = {}));
+/**
+ * Enum representing the available routes for LibreOffice.
+ * @enum {string}
+ */
 var LibreOfficeRoute;
 (function (LibreOfficeRoute) {
     LibreOfficeRoute["CONVERT"] = "convert";
 })(LibreOfficeRoute || (LibreOfficeRoute = {}));
+/**
+ * Class providing constants and routes for interacting with the Gotenberg service and related engines.
+ */
 class Chromiumly {
 }
 exports.Chromiumly = Chromiumly;
+/**
+ * The Gotenberg service endpoint.
+ * @type {string}
+ */
 Chromiumly.GOTENBERG_ENDPOINT = gotenberg_1.Gotenberg.endpoint;
+/**
+ * The path for Chromium-related conversions.
+ * @type {string}
+ */
 Chromiumly.CHROMIUM_PATH = "forms/chromium/convert";
+/**
+ * The path for PDF engine-related operations.
+ * @type {string}
+ */
 Chromiumly.PDF_ENGINES_PATH = "forms/pdfengines";
+/**
+ * The path for LibreOffice-related conversions.
+ * @type {string}
+ */
 Chromiumly.LIBRE_OFFICE_PATH = "forms/libreoffice";
+/**
+ * Routes for Chromium conversions.
+ * @type {Object}
+ */
 Chromiumly.CHROMIUM_ROUTES = {
     url: ChromiumRoute.URL,
     html: ChromiumRoute.HTML,
     markdown: ChromiumRoute.MARKDOWN,
 };
+/**
+ * Routes for PDF engine operations.
+ * @type {Object}
+ */
 Chromiumly.PDF_ENGINE_ROUTES = {
     merge: PdfEngineRoute.MERGE,
 };
+/**
+ * Routes for LibreOffice conversions.
+ * @type {Object}
+ */
 Chromiumly.LIBRE_OFFICE_ROUTES = {
     convert: LibreOfficeRoute.CONVERT,
 };

package/dist/main.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.config.js","sourceRoot":"","sources":["../src/main.config.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;AACvB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED,IAAK,cAEJ;AAFD,WAAK,cAAc;IACjB,iCAAe,CAAA;AACjB,CAAC,EAFI,cAAc,KAAd,cAAc,QAElB;AAED,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACnB,uCAAmB,CAAA;AACrB,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AACD,MAAa,UAAU;;AAAvB,gCAoBC;AAnBwB,6BAAkB,GAAG,qBAAS,CAAC,QAAQ,CAAC;AAExC,wBAAa,GAAG,wBAAwB,CAAC;AACzC,2BAAgB,GAAG,kBAAkB,CAAC;AACtC,4BAAiB,GAAG,mBAAmB,CAAC;AAExC,0BAAe,GAAG;IACvC,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;CACjC,CAAC;AAEqB,4BAAiB,GAAG;IACzC,KAAK,EAAE,cAAc,CAAC,KAAK;CAC5B,CAAC;AAEqB,8BAAmB,GAAG;IAC3C,OAAO,EAAE,gBAAgB,CAAC,OAAO;CAClC,CAAC"}
+{"version":3,"file":"main.config.js","sourceRoot":"","sources":["../src/main.config.ts"],"names":[],"mappings":";;;AAAA,2CAAsC;AAEtC;;;GAGG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;AACzB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED;;;GAGG;AACH,IAAK,cAEJ;AAFD,WAAK,cAAc;IACf,iCAAe,CAAA;AACnB,CAAC,EAFI,cAAc,KAAd,cAAc,QAElB;AAED;;;GAGG;AACH,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACjB,uCAAmB,CAAA;AACvB,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AAED;;GAEG;AACH,MAAa,UAAU;;AAAvB,gCAkDC;AAjDG;;;GAGG;AACoB,6BAAkB,GAAG,qBAAS,CAAC,QAAQ,CAAC;AAE/D;;;GAGG;AACoB,wBAAa,GAAG,wBAAwB,CAAC;AAEhE;;;GAGG;AACoB,2BAAgB,GAAG,kBAAkB,CAAC;AAE7D;;;GAGG;AACoB,4BAAiB,GAAG,mBAAmB,CAAC;AAE/D;;;GAGG;AACoB,0BAAe,GAAG;IACrC,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;CACnC,CAAC;AAEF;;;GAGG;AACoB,4BAAiB,GAAG;IACvC,KAAK,EAAE,cAAc,CAAC,KAAK;CAC9B,CAAC;AAEF;;;GAGG;AACoB,8BAAmB,GAAG;IACzC,OAAO,EAAE,gBAAgB,CAAC,OAAO;CACpC,CAAC"}

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAA4E;AAAnE,yGAAA,aAAa,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,wGAAA,YAAY,OAAA;AACvD,6CAA0C;AAAjC,wGAAA,SAAS,OAAA"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA6C;AAArC,sGAAA,SAAS,OAAA;AACjB,uCAA0E;AAAlE,yGAAA,aAAa,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,wGAAA,YAAY,OAAA;AACtD,6CAAwC;AAAhC,wGAAA,SAAS,OAAA"}

package/dist/pdf-engines/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pdf-engines/index.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pdf-engines/index.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAA/B,uGAAA,SAAS,OAAA"}

package/dist/pdf-engines/pdf.engine.d.ts

@@ -1,18 +1,44 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { PathLike } from "fs";
-import { PdfFormat } from "../common";
+import { PathLikeOrReadStream, PdfFormat } from "../common";
 import { PageProperties } from "../libre-office";
+/**
+ * Class representing a PDF engine for various operations such as merging and conversion.
+ */
 export declare class PDFEngine {
+    /**
+     * 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.
+     */
     static merge({ files }: {
-        files: PathLike[];
+        files: PathLikeOrReadStream[];
     }): Promise<Buffer>;
+    /**
+     * 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.
+     */
     static convert({ files, properties, pdfFormat, pdfUA, merge, }: {
-        files: PathLike[];
+        files: PathLikeOrReadStream[];
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;
         merge?: boolean;
     }): Promise<Buffer>;
+    /**
+     * 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.
+     */
     static generate(filename: string, buffer: Buffer): Promise<void>;
 }

package/dist/pdf-engines/pdf.engine.js

@@ -9,15 +9,36 @@ const main_config_1 = require("../main.config");
 const common_1 = require("../common");
 const libre_office_1 = require("../libre-office");
 const engine_utils_1 = require("./utils/engine.utils");
+/**
+ * Class representing a PDF engine for various operations such as merging and conversion.
+ */
 class PDFEngine {
+    /**
+     * 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.
+     */
     static merge({ files }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
-            yield engine_utils_1.PDFEngineUtils.injectFiles(files, data);
+            yield engine_utils_1.PDFEngineUtils.addFiles(files, data);
             const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.PDF_ENGINES_PATH}/${main_config_1.Chromiumly.PDF_ENGINE_ROUTES.merge}`;
             return common_1.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.
+     */
     static convert({ files, properties, pdfFormat, pdfUA, merge, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
@@ -31,13 +52,20 @@ class PDFEngine {
                 data.append("merge", String(merge));
             }
             if (properties) {
-                libre_office_1.LibreOfficeUtils.injectPageProperties(data, properties);
+                libre_office_1.LibreOfficeUtils.addPageProperties(data, properties);
             }
-            yield libre_office_1.LibreOfficeUtils.injectFiles(files, data);
+            yield libre_office_1.LibreOfficeUtils.addFiles(files, data);
             const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.LIBRE_OFFICE_PATH}/${main_config_1.Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
             return common_1.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.
+     */
     static generate(filename, buffer) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const __generated__ = path_1.default.resolve(process.cwd(), "__generated__");

package/dist/pdf-engines/pdf.engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAAwC;AACxC,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAAsD;AACtD,kDAAmE;AACnE,uDAAsD;AAEtD,MAAa,SAAS;IACb,MAAM,CAAO,KAAK,CAAC,EAAE,KAAK,EAAyB;;YACxD,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YACzH,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEM,MAAM,CAAO,OAAO,CAAC,EAC1B,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,GAON;;YACC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACjC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACtC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACtC,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACf,+BAAgB,CAAC,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC1D,CAAC;YAED,MAAM,+BAAgB,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAEhD,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAE9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEM,MAAM,CAAO,QAAQ,CAC1B,QAAgB,EAChB,MAAc;;YAEd,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;YACnE,MAAM,aAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,MAAM,aAAQ,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC1E,CAAC;KAAA;CACF;AAtDD,8BAsDC"}
+{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAA4B;AAC5B,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA0C;AAC1C,sCAA0E;AAC1E,kDAAiE;AACjE,uDAAoD;AAEpD;;GAEG;AACH,MAAa,SAAS;IAClB;;;;;;OAMG;IACI,MAAM,CAAO,KAAK,CAAC,EAAC,KAAK,EAAoC;;YAChE,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YACzH,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAO,OAAO,CAAC,EACI,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,GAOpC;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACnC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACb,+BAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,+BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE7C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAE9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,QAAgB,EAChB,MAAc;;YAEd,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;YACnE,MAAM,aAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;YACrE,MAAM,aAAQ,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;CACJ;AA/ED,8BA+EC"}

package/dist/pdf-engines/utils/engine.utils.d.ts

@@ -1,6 +1,15 @@
-/// <reference types="node" />
-import { PathLike } from "fs";
 import FormData from "form-data";
+import { PathLikeOrReadStream } from "../../common";
+/**
+ * Utility class for handling common tasks related to PDF engine operations.
+ */
 export declare class PDFEngineUtils {
-    static injectFiles(files: PathLike[], data: FormData): Promise<void>;
+    /**
+     * 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.
+     */
+    static addFiles(files: PathLikeOrReadStream[], data: FormData): Promise<void>;
 }

package/dist/pdf-engines/utils/engine.utils.js

@@ -4,18 +4,37 @@ exports.PDFEngineUtils = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
+/**
+ * Utility class for handling common tasks related to PDF engine operations.
+ */
 class PDFEngineUtils {
-    static injectFiles(files, data) {
+    /**
+     * 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.
+     */
+    static addFiles(files, data) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            for (const file of files) {
-                yield fs_1.promises.access(file, fs_1.constants.R_OK);
-                const filename = path_1.default.basename(file.toString());
-                const extension = path_1.default.extname(filename);
-                if (extension === ".pdf") {
-                    data.append(filename, (0, fs_1.createReadStream)(file));
+            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 fs_1.ReadStream) {
+                    data.append("files", file, filename);
                 }
                 else {
-                    throw new Error(`${extension} is not supported`);
+                    yield fs_1.promises.access(file, fs_1.constants.R_OK);
+                    const filename = path_1.default.basename(file.toString());
+                    const extension = path_1.default.extname(filename);
+                    if (extension === ".pdf") {
+                        data.append(filename, (0, fs_1.createReadStream)(file));
+                    }
+                    else {
+                        throw new Error(`${extension} is not supported`);
+                    }
                 }
             }
         });

package/dist/pdf-engines/utils/engine.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"engine.utils.js","sourceRoot":"","sources":["../../../src/pdf-engines/utils/engine.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AACrE,wDAAwB;AAIxB,MAAa,cAAc;IAClB,MAAM,CAAO,WAAW,CAAC,KAAiB,EAAE,IAAc;;YAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,aAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;gBAC5C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACzC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;oBACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;gBAChD,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;KAAA;CACF;AAbD,wCAaC"}
+{"version":3,"file":"engine.utils.js","sourceRoot":"","sources":["../../../src/pdf-engines/utils/engine.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AACrE,wDAAwB;AAKxB;;GAEG;AACH,MAAa,cAAc;IACvB;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CAAC,KAA6B,EAAE,IAAc;;YACtE,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;gBACxC,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;gBACjC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,IAAI,IAAI,YAAY,eAAU,EAAE,CAAC;oBACpC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACJ,MAAM,aAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;oBAC5C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAChD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;oBAClD,CAAC;yBAAM,CAAC;wBACJ,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;oBACrD,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;KAAA;CACJ;AA3BD,wCA2BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromiumly",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "description": "A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -47,26 +47,27 @@
     "@types/config": "3.3.3",
     "@types/dotenv": "8.2.0",
     "@types/form-data": "2.5.0",
-    "@types/jest": "29.5.10",
-    "@types/node": "20.10.2",
+    "@types/jest": "29.5.11",
+    "@types/node": "20.10.4",
     "@types/node-fetch": "2.6.9",
-    "@typescript-eslint/eslint-plugin": "6.13.1",
-    "@typescript-eslint/parser": "6.13.1",
+    "@typescript-eslint/eslint-plugin": "6.13.2",
+    "@typescript-eslint/parser": "6.13.2",
     "commitizen": "4.3.0",
     "eslint": "8.55.0",
     "husky": "8.0.3",
     "inquirer": "8",
     "jest": "29.7.0",
     "jest-junit": "16.0.0",
-    "release-it": "17.0.0",
+    "release-it": "17.0.1",
     "ts-jest": "29.1.1",
     "ts-node": "10.9.1",
     "tslib": "2.6.2",
-    "typescript": "5.3.2"
+    "typescript": "5.3.3"
   },
   "dependencies": {
     "config": "3.3.9",
     "dotenv": "16.3.1",
+    "file-type": "16.5.4",
     "form-data": "4.0.0",
     "node-fetch": "2.7.0"
   }

package/src/chromium/converters/converter.ts

@@ -1,9 +1,22 @@
-import { Chromiumly, ChromiumRoute } from "../../main.config";
+import {Chromiumly, ChromiumRoute} from "../../main.config";
 
+/**
+ * Abstract class representing a generic converter.
+ * Concrete converter classes should extend this class and implement specific conversion logic.
+ */
 export abstract class Converter {
-  readonly endpoint: string;
+    /**
+     * The endpoint URL for the converter.
+     */
+    readonly endpoint: string;
 
-  constructor(route: ChromiumRoute) {
-    this.endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.CHROMIUM_PATH}/${Chromiumly.CHROMIUM_ROUTES[route]}`;
-  }
+    /**
+     * Creates an instance of the Converter class.
+     * Initializes the endpoint URL based on the provided ChromiumRoute.
+     *
+     * @param {ChromiumRoute} route - The ChromiumRoute enum value representing the conversion route.
+     */
+    constructor(route: ChromiumRoute) {
+        this.endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.CHROMIUM_PATH}/${Chromiumly.CHROMIUM_ROUTES[route]}`;
+    }
 }

package/src/chromium/converters/html.converter.ts

@@ -1,71 +1,92 @@
-import { constants, createReadStream, PathLike, promises } from "fs";
-
 import FormData from "form-data";
 
-import { GotenbergUtils, PdfFormat } from "../../common";
+import {GotenbergUtils, PathLikeOrReadStream, PdfFormat} from "../../common";
 import {
-  EmulatedMediaType,
-  PageProperties,
+    EmulatedMediaType,
+    PageProperties,
 } from "../interfaces/converter.types";
-import { ConverterUtils } from "../utils/converter.utils";
-import { Converter } from "./converter";
-import { ChromiumRoute } from "../../main.config";
+import {ConverterUtils} from "../utils/converter.utils";
+import {Converter} from "./converter";
+import {ChromiumRoute} from "../../main.config";
 
+/**
+ * Class representing an HTML converter that extends the base Converter class.
+ * This class is used to convert HTML content to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 export class HtmlConverter extends Converter {
-  constructor() {
-    super(ChromiumRoute.HTML);
-  }
+    /**
+     * Creates an instance of HtmlConverter.
+     * Initializes the converter with the HTML conversion route.
+     */
+    constructor() {
+        super(ChromiumRoute.HTML);
+    }
 
-  async convert({
-    html,
-    header,
-    footer,
-    properties,
-    pdfFormat,
-    pdfUA,
-    emulatedMediaType,
-    waitDelay,
-    waitForExpression,
-    userAgent,
-    extraHttpHeaders,
-    failOnConsoleExceptions,
-  }: {
-    html: PathLike;
-    header?: PathLike;
-    footer?: PathLike;
-    properties?: PageProperties;
-    pdfFormat?: PdfFormat;
-    pdfUA?: boolean;
-    emulatedMediaType?: EmulatedMediaType;
-    waitDelay?: string;
-    waitForExpression?: string;
-    userAgent?: string;
-    extraHttpHeaders?: Record<string, string>;
-    failOnConsoleExceptions?: boolean;
-  }): Promise<Buffer> {
-    const data = new FormData();
+    /**
+     * Converts HTML content to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @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 {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
+    async convert({
+                      html,
+                      header,
+                      footer,
+                      properties,
+                      pdfFormat,
+                      pdfUA,
+                      emulatedMediaType,
+                      waitDelay,
+                      waitForExpression,
+                      userAgent,
+                      extraHttpHeaders,
+                      failOnConsoleExceptions,
+                  }: {
+        html: PathLikeOrReadStream;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
+        properties?: PageProperties;
+        pdfFormat?: PdfFormat;
+        pdfUA?: boolean;
+        emulatedMediaType?: EmulatedMediaType;
+        waitDelay?: string;
+        waitForExpression?: string;
+        userAgent?: string;
+        extraHttpHeaders?: Record<string, string>;
+        failOnConsoleExceptions?: boolean;
+    }): Promise<Buffer> {
+        const data = new FormData();
 
-    if (Buffer.isBuffer(html)) {
-      data.append("files", html, "index.html");
-    } else {
-      await promises.access(html, constants.R_OK);
-      data.append("files", createReadStream(html), "index.html");
-    }
+        await ConverterUtils.addFile(data, html, "index.html");
 
-    ConverterUtils.customize(data, {
-      header,
-      footer,
-      properties,
-      pdfFormat,
-      pdfUA,
-      emulatedMediaType,
-      waitDelay,
-      waitForExpression,
-      userAgent,
-      extraHttpHeaders,
-      failOnConsoleExceptions,
-    });
+        await ConverterUtils.customize(data, {
+            header,
+            footer,
+            properties,
+            pdfFormat,
+            pdfUA,
+            emulatedMediaType,
+            waitDelay,
+            waitForExpression,
+            userAgent,
+            extraHttpHeaders,
+            failOnConsoleExceptions,
+        });
 
-    return GotenbergUtils.fetch(this.endpoint, data);
-  }
-}
+        return GotenbergUtils.fetch(this.endpoint, data);
+    }
+}