chromiumly 3.0.1 → 3.2.0

package/src/gotenberg.ts

@@ -20,11 +20,35 @@ if (dotenvConfig.error) {
  */
 export class Gotenberg {
     /**
-     * The Gotenberg service endpoint.
-     * Defaults to the value from the environment variable `GOTENBERG_ENDPOINT`, or falls back to the configuration file.
+     * The endpoint for the Gotenberg service.
      * @type {string}
      */
-    public static endpoint: string =
-        process.env.GOTENBERG_ENDPOINT ||
-        config.get<string>('gotenberg.endpoint');
+    static get endpoint(): string {
+        return (
+            process.env.GOTENBERG_ENDPOINT ||
+            config.get<string>('gotenberg.endpoint')
+        );
+    }
+
+    /**
+     * The username for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    static get username(): string | undefined {
+        const hasUsername = config.has('gotenberg.api.basicAuth.username');
+        return hasUsername
+            ? config.get<string>('gotenberg.api.basicAuth.username')
+            : process.env.GOTENBERG_API_BASIC_AUTH_USERNAME;
+    }
+
+    /**
+     * The password for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    static get password(): string | undefined {
+        const hasPassword = config.has('gotenberg.api.basicAuth.password');
+        return hasPassword
+            ? config.get<string>('gotenberg.api.basicAuth.password')
+            : process.env.GOTENBERG_API_BASIC_AUTH_PASSWORD;
+    }
 }

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

@@ -144,6 +144,7 @@ export type PageProperties = {
     landscape?: boolean; // Set the paper orientation to landscape (default false)
     nativePageRanges?: { from: number; to: number }; // Page ranges to print
     exportFormFields?: boolean; // Set whether to export the form fields or to use the inputted/selected content of the fields (default true)
+    singlePageSheets?: boolean; // Set whether to render the entire spreadsheet as a single page. (default false)
 };
 
 export type ConversionOptions = {

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

@@ -51,6 +51,11 @@ export class LibreOffice {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 }

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

@@ -85,6 +85,13 @@ export class LibreOfficeUtils {
                 String(pageProperties.exportFormFields)
             );
         }
+
+        if (pageProperties.singlePageSheets) {
+            data.append(
+                'singlePageSheets',
+                String(pageProperties.singlePageSheets)
+            );
+        }
     }
 
     /**

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

@@ -137,5 +137,20 @@ describe('LibreOfficeUtils', () => {
                 });
             });
         });
+
+        describe('Single page sheets', () => {
+            describe('when singlePageSheets parameter is set', () => {
+                it('should append singlePageSheets to data', () => {
+                    LibreOfficeUtils.addPageProperties(data, {
+                        singlePageSheets: true
+                    });
+                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
+                    expect(data.append).toHaveBeenCalledWith(
+                        'singlePageSheets',
+                        'true'
+                    );
+                });
+            });
+        });
     });
 });

package/src/main.config.ts

@@ -38,6 +38,20 @@ export class Chromiumly {
      */
     public static readonly GOTENBERG_ENDPOINT = Gotenberg.endpoint;
 
+    /**
+     * The username for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    public static readonly GOTENBERG_API_BASIC_AUTH_USERNAME =
+        Gotenberg.username;
+
+    /**
+     * The password for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    public static readonly GOTENBERG_API_BASIC_AUTH_PASSWORD =
+        Gotenberg.password;
+
     /**
      * The path for Chromium-related conversions.
      * @type {string}

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

@@ -42,7 +42,12 @@ export class PDFEngines {
             metadata
         });
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -73,7 +78,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -91,7 +101,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -115,7 +130,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**