chromiumly 2.6.0 → 2.8.0

package/src/chromium/utils/converter.utils.ts

@@ -1,12 +1,10 @@
-import {constants, createReadStream, promises} from "fs";
-import FormData from "form-data";
+import FormData from 'form-data';
 
 import {
     ConversionOptions,
-    PageProperties,
-} from "../interfaces/converter.types";
-import {GotenbergUtils, PathLikeOrReadStream} from "../../common";
-import {ReadStream} from "fs";
+    PageProperties
+} from '../interfaces/converter.types';
+import { GotenbergUtils } from '../../common';
 
 /**
  * Utility class for handling common tasks related to conversion.
@@ -22,94 +20,86 @@ export class ConverterUtils {
         data: FormData,
         pageProperties: PageProperties
     ): void {
+        if (pageProperties.singlePage) {
+            data.append('singlePage', String(pageProperties.singlePage));
+        }
+
         if (pageProperties.size) {
             GotenbergUtils.assert(
-                pageProperties.size.width >= 1.0 && pageProperties.size.height >= 1.5,
-                "size is smaller than the minimum printing requirements (i.e. 1.0 x 1.5 in)"
+                pageProperties.size.width >= 1.0 &&
+                    pageProperties.size.height >= 1.5,
+                'size is smaller than the minimum printing requirements (i.e. 1.0 x 1.5 in)'
             );
 
-            data.append("paperWidth", pageProperties.size.width);
-            data.append("paperHeight", pageProperties.size.height);
+            data.append('paperWidth', pageProperties.size.width);
+            data.append('paperHeight', pageProperties.size.height);
         }
 
         if (pageProperties.margins) {
             GotenbergUtils.assert(
                 pageProperties.margins.top >= 0 &&
-                pageProperties.margins.bottom >= 0 &&
-                pageProperties.margins.left >= 0 &&
-                pageProperties.margins.left >= 0,
-                "negative margins are not allowed"
+                    pageProperties.margins.bottom >= 0 &&
+                    pageProperties.margins.left >= 0 &&
+                    pageProperties.margins.left >= 0,
+                'negative margins are not allowed'
             );
 
-            data.append("marginTop", pageProperties.margins.top);
-            data.append("marginBottom", pageProperties.margins.bottom);
-            data.append("marginLeft", pageProperties.margins.left);
-            data.append("marginRight", pageProperties.margins.right);
+            data.append('marginTop', pageProperties.margins.top);
+            data.append('marginBottom', pageProperties.margins.bottom);
+            data.append('marginLeft', pageProperties.margins.left);
+            data.append('marginRight', pageProperties.margins.right);
         }
 
         if (pageProperties.preferCssPageSize) {
             data.append(
-                "preferCssPageSize",
+                'preferCssPageSize',
                 String(pageProperties.preferCssPageSize)
             );
         }
 
         if (pageProperties.printBackground) {
-            data.append("printBackground", String(pageProperties.printBackground));
+            data.append(
+                'printBackground',
+                String(pageProperties.printBackground)
+            );
         }
 
         if (pageProperties.omitBackground) {
-            data.append("omitBackground", String(pageProperties.omitBackground));
+            data.append(
+                'omitBackground',
+                String(pageProperties.omitBackground)
+            );
         }
 
         if (pageProperties.landscape) {
-            data.append("landscape", String(pageProperties.landscape));
+            data.append('landscape', String(pageProperties.landscape));
         }
 
         if (pageProperties.scale) {
             GotenbergUtils.assert(
                 pageProperties.scale >= 0.1 && pageProperties.scale <= 2.0,
-                "scale is outside of [0.1 - 2] range"
+                'scale is outside of [0.1 - 2] range'
             );
 
-            data.append("scale", pageProperties.scale);
+            data.append('scale', pageProperties.scale);
         }
 
         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}`
             );
         }
     }
 
-    /**
-     * Adds a file to the FormData object.
-     *
-     * @param {FormData} data - The FormData object to which the file will be added.
-     * @param {PathLikeOrReadStream} file - The file to be added (either a PathLike or a ReadStream).
-     * @param {string} name - The name to be used for the file in the FormData.
-     * @returns {Promise<void>} A Promise that resolves once the file has been added.
-     */
-    public static async addFile(data: FormData, file: PathLikeOrReadStream, name: string) {
-        if (Buffer.isBuffer(file)) {
-            data.append("files", file, name);
-        } else if (file instanceof ReadStream) {
-            data.append("files", file, name);
-        } else {
-            await promises.access(file, constants.R_OK);
-            data.append("files", createReadStream(file), name);
-        }
-    }
-
     /**
      * Customizes the FormData object based on the provided conversion options.
      *
@@ -122,25 +112,25 @@ export class ConverterUtils {
         options: ConversionOptions
     ): Promise<void> {
         if (options.pdfFormat) {
-            data.append("pdfa", options.pdfFormat);
+            data.append('pdfa', options.pdfFormat);
         }
 
         if (options.pdfUA) {
-            data.append("pdfua", String(options.pdfUA));
+            data.append('pdfua', String(options.pdfUA));
         }
 
         if (options.header) {
-            const {header} = options;
-            await ConverterUtils.addFile(data, header, "header.html")
+            const { header } = options;
+            await GotenbergUtils.addFile(data, header, 'header.html');
         }
 
         if (options.footer) {
-            const {footer} = options;
-            await ConverterUtils.addFile(data, footer, "footer.html")
+            const { footer } = options;
+            await GotenbergUtils.addFile(data, footer, 'footer.html');
         }
 
         if (options.emulatedMediaType) {
-            data.append("emulatedMediaType", options.emulatedMediaType);
+            data.append('emulatedMediaType', options.emulatedMediaType);
         }
 
         if (options.properties) {
@@ -148,26 +138,43 @@ export class ConverterUtils {
         }
 
         if (options.waitDelay) {
-            data.append("waitDelay", options.waitDelay);
+            data.append('waitDelay', options.waitDelay);
         }
 
         if (options.waitForExpression) {
-            data.append("waitForExpression", options.waitForExpression);
+            data.append('waitForExpression', options.waitForExpression);
         }
 
         if (options.userAgent) {
-            data.append("userAgent", options.userAgent);
+            data.append('userAgent', options.userAgent);
         }
 
         if (options.extraHttpHeaders) {
-            data.append("extraHttpHeaders", JSON.stringify(options.extraHttpHeaders));
+            data.append(
+                'extraHttpHeaders',
+                JSON.stringify(options.extraHttpHeaders)
+            );
+        }
+
+        if (options.failOnHttpStatusCodes) {
+            data.append(
+                'failOnHttpStatusCodes',
+                JSON.stringify(options.failOnHttpStatusCodes)
+            );
         }
 
         if (options.failOnConsoleExceptions) {
             data.append(
-                "failOnConsoleExceptions",
+                'failOnConsoleExceptions',
                 String(options.failOnConsoleExceptions)
             );
         }
+
+        if (options.skipNetworkIdleEvent) {
+            data.append(
+                'skipNetworkIdleEvent',
+                String(options.skipNetworkIdleEvent)
+            );
+        }
     }
 }

package/src/chromium/utils/screenshot.utils.ts

@@ -0,0 +1,115 @@
+import {
+    ImageProperties,
+    ScreenshotOptions
+} from './../interfaces/screenshot.types';
+import FormData from 'form-data';
+
+import { GotenbergUtils } from '../../common';
+
+/**
+ * Utility class for handling common tasks related to screenshot.
+ */
+export class ScreenshotUtils {
+    /**
+     * Adds page properties to the FormData object based on the provided imageProperties.
+     *
+     * @param {FormData} data - The FormData object to which page properties will be added.
+     * @param {ImageProperties} imageProperties - The page properties to be added to the FormData.
+     */
+    public static addImageProperties(
+        data: FormData,
+        imageProperties: ImageProperties
+    ): void {
+        data.append('format', imageProperties.format);
+
+        if (imageProperties.quality) {
+            GotenbergUtils.assert(
+                imageProperties.format === 'jpeg',
+                'Compression quality is exclusively supported for JPEG format.'
+            );
+            GotenbergUtils.assert(
+                imageProperties.quality >= 0 && imageProperties.quality <= 100,
+                'Invalid compression quality. Please provide a value between 0 and 100.'
+            );
+
+            data.append('quality', imageProperties.quality);
+        }
+
+        if (imageProperties.omitBackground) {
+            data.append(
+                'omitBackground',
+                String(imageProperties.omitBackground)
+            );
+        }
+    }
+
+    /**
+     * Customizes the FormData object based on the provided screenshot options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ScreenshotOptions} options - The screenshot options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    public static async customize(
+        data: FormData,
+        options: ScreenshotOptions
+    ): Promise<void> {
+        if (options.header) {
+            const { header } = options;
+            await GotenbergUtils.addFile(data, header, 'header.html');
+        }
+
+        if (options.footer) {
+            const { footer } = options;
+            await GotenbergUtils.addFile(data, footer, 'footer.html');
+        }
+
+        if (options.emulatedMediaType) {
+            data.append('emulatedMediaType', options.emulatedMediaType);
+        }
+
+        if (options.properties) {
+            ScreenshotUtils.addImageProperties(data, options.properties);
+        }
+
+        if (options.waitDelay) {
+            data.append('waitDelay', options.waitDelay);
+        }
+
+        if (options.waitForExpression) {
+            data.append('waitForExpression', options.waitForExpression);
+        }
+
+        if (options.extraHttpHeaders) {
+            data.append(
+                'extraHttpHeaders',
+                JSON.stringify(options.extraHttpHeaders)
+            );
+        }
+
+        if (options.failOnHttpStatusCodes) {
+            data.append(
+                'failOnHttpStatusCodes',
+                JSON.stringify(options.failOnHttpStatusCodes)
+            );
+        }
+
+        if (options.failOnConsoleExceptions) {
+            data.append(
+                'failOnConsoleExceptions',
+                String(options.failOnConsoleExceptions)
+            );
+        }
+
+        if (options.skipNetworkIdleEvent) {
+            data.append(
+                'skipNetworkIdleEvent',
+                String(options.skipNetworkIdleEvent)
+            );
+        }
+
+        if (options.optimizeForSpeed) {
+            data.append('optimizeForSpeed', String(options.optimizeForSpeed));
+        }
+    }
+}