chromiumly 2.5.1 → 2.6.0

package/dist/chromium/converters/html.converter.d.ts

@@ -32,8 +32,12 @@ export declare class HtmlConverter extends Converter {
      * @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.
      */
-    convert({ html, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
+    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
         html: PathLikeOrReadStream;
+        assets?: {
+            file: PathLikeOrReadStream;
+            name: string;
+        }[];
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
         properties?: PageProperties;

package/dist/chromium/converters/html.converter.js

@@ -39,10 +39,13 @@ class HtmlConverter extends converter_1.Converter {
      * @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.
      */
-    convert({ html, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
+    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
             yield converter_utils_1.ConverterUtils.addFile(data, html, "index.html");
+            if (assets === null || assets === void 0 ? void 0 : assets.length) {
+                yield Promise.all(assets.map(({ file, name }) => converter_utils_1.ConverterUtils.addFile(data, file, name)));
+            }
             yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,

package/dist/chromium/converters/html.converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"html.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/html.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA6E;AAK7E,8DAAwD;AACxD,2CAAsC;AACtC,mDAAgD;AAEhD;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,qBAAS;IACxC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACI,IAAI,EACJ,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAcxC;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,MAAM,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBACjC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aAC1B,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA1ED,sCA0EC"}
+{"version":3,"file":"html.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/html.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA6E;AAK7E,8DAAwD;AACxD,2CAAsC;AACtC,mDAAgD;AAEhD;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,qBAAS;IACxC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACI,IAAI,EACJ,MAAM,EACN,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAexC;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,CAAC;gBACjB,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/F,CAAC;YAED,MAAM,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBACjC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aAC1B,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AAhFD,sCAgFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromiumly",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "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,26 @@
     "@types/config": "3.3.3",
     "@types/dotenv": "8.2.0",
     "@types/form-data": "2.5.0",
-    "@types/jest": "29.5.11",
-    "@types/node": "20.10.4",
-    "@types/node-fetch": "2.6.9",
-    "@typescript-eslint/eslint-plugin": "6.13.2",
-    "@typescript-eslint/parser": "6.13.2",
+    "@types/jest": "29.5.12",
+    "@types/node": "20.11.19",
+    "@types/node-fetch": "2.6.11",
+    "@typescript-eslint/eslint-plugin": "7.0.1",
+    "@typescript-eslint/parser": "7.0.1",
     "commitizen": "4.3.0",
-    "eslint": "8.55.0",
-    "husky": "8.0.3",
+    "eslint": "8.56.0",
+    "husky": "9.0.11",
     "inquirer": "8",
     "jest": "29.7.0",
     "jest-junit": "16.0.0",
-    "release-it": "17.0.1",
-    "ts-jest": "29.1.1",
-    "ts-node": "10.9.1",
+    "release-it": "17.0.5",
+    "ts-jest": "29.1.2",
+    "ts-node": "10.9.2",
     "tslib": "2.6.2",
     "typescript": "5.3.3"
   },
   "dependencies": {
-    "config": "3.3.9",
-    "dotenv": "16.3.1",
+    "config": "3.3.11",
+    "dotenv": "16.4.4",
     "file-type": "16.5.4",
     "form-data": "4.0.0",
     "node-fetch": "2.7.0"

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

@@ -44,6 +44,7 @@ export class HtmlConverter extends Converter {
      */
     async convert({
                       html,
+                      assets,
                       header,
                       footer,
                       properties,
@@ -57,6 +58,7 @@ export class HtmlConverter extends Converter {
                       failOnConsoleExceptions,
                   }: {
         html: PathLikeOrReadStream;
+        assets?: { file: PathLikeOrReadStream, name: string }[]
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
         properties?: PageProperties;
@@ -73,6 +75,10 @@ export class HtmlConverter extends Converter {
 
         await ConverterUtils.addFile(data, html, "index.html");
 
+        if (assets?.length) {
+            await Promise.all(assets.map(({ file, name }) => ConverterUtils.addFile(data, file, name)))
+        }
+
         await ConverterUtils.customize(data, {
             header,
             footer,

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

@@ -25,7 +25,12 @@ describe("HtmlConverter", () => {
         const mockPromisesAccess = jest.spyOn(promises, "access");
         const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
         const mockFormDataAppend = jest.spyOn(FormData.prototype, "append");
-        
+
+        const assets = [
+            { file: Buffer.from('asset1'), name: 'asset1' },
+            { file: Buffer.from('asset2'), name: 'asset2' }
+        ]
+
         beforeEach(() => {
             (createReadStream as jest.Mock) = jest.fn()
         });
@@ -92,6 +97,19 @@ describe("HtmlConverter", () => {
             });
         });
 
+        describe("when assets parameter is passed", () => {
+            it("should return a buffer", async () => {
+                mockFetch.mockResolvedValue(new Response("content"));
+                const buffer = await converter.convert({
+                    html: Buffer.from("data"),
+                    assets,
+                });
+
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
+                expect(buffer).toEqual(Buffer.from("content"));
+            });
+        });
+
         describe("when emulatedMediaType parameter is passed", () => {
             it("should return a buffer", async () => {
                 mockFetch.mockResolvedValue(new Response("content"));
@@ -110,13 +128,14 @@ describe("HtmlConverter", () => {
                 mockFetch.mockResolvedValue(new Response("content"));
                 const buffer = await converter.convert({
                     html: Buffer.from("data"),
+                    assets,
                     header: Buffer.from("header"),
                     footer: Buffer.from("footer"),
                     pdfFormat: PdfFormat.A_1a,
                     emulatedMediaType: "screen",
                     properties: {size: {width: 8.3, height: 11.7}},
                 });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(7);
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(9);
                 expect(buffer).toEqual(Buffer.from("content"));
             });
         });