feat(chromium): add support for custom headers function

.husky/commit-msg

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no -- commitlint --edit ${1}

src/chromium/converters/markdown.converter.ts

@@ -103,7 +103,8 @@ export class MarkdownConverter extends Converter {
             this.endpoint,
             data,
             Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
+            Chromiumly.getGotenbergApiBasicAuthPassword(),
+            await Chromiumly.getAddCustomHeadersFn()()
         );
     }
 }

src/chromium/converters/url.converter.ts

@@ -100,7 +100,8 @@ export class UrlConverter extends Converter {
             this.endpoint,
             data,
             Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
+            Chromiumly.getGotenbergApiBasicAuthPassword(),
+            await Chromiumly.getAddCustomHeadersFn()()
         );
     }
 }

src/common/gotenberg.utils.ts

@@ -30,16 +30,21 @@ export class GotenbergUtils {
      * @param {string} username - The username for basic authentication.
      * @param {string} password - The password for basic authentication.
      * @param {FormData} data - The FormData object to be sent in the POST request.
+     * @param {Record<string, string>} customHeaders - List of custom headers to include in the fetch
      * @returns {Promise<Buffer>} A Promise that resolves to the response body as a Buffer.
      * @throws {Error} Throws an error if the HTTP response status is not OK.
      */
     public static async fetch(
         endpoint: string,
         data: FormData,
         username?: string,
-        password?: string
+        password?: string,
+        customHeaders: Record<string, string> = {}
     ): Promise<Buffer> {
-        const headers: Record<string, string> = { ...data.getHeaders() };
+        const headers: Record<string, string> = {
+            ...data.getHeaders(),
+            ...customHeaders
+        };
 
         if (username && password) {
             const authHeader =

src/libre-office/libre-office.ts

@@ -62,7 +62,8 @@ export class LibreOffice {
             endpoint,
             data,
             Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
+            Chromiumly.getGotenbergApiBasicAuthPassword(),
+            await Chromiumly.getAddCustomHeadersFn()()
         );
     }
 }

src/main.config.ts

@@ -53,6 +53,14 @@ export class Chromiumly {
     private static gotenbergApiBasicAuthPassword: string | undefined =
         Gotenberg.password;
 
+    /**
+     * An async function that returns a set of headers to use for the fetch call to gotenberg service
+     * @type {string | undefined}
+     */
+    private static addCustomHeadersFn:
+        | (() => Promise<Record<string, string>>)
+        | undefined = undefined;
+
     /**
      * The path for Chromium-related conversions.
      * @type {string}
@@ -118,6 +126,7 @@ export class Chromiumly {
         endpoint: string;
         username?: string;
         password?: string;
+        addCustomHeadersFn?: () => Promise<Record<string, string>>;
     }): void {
         this.gotenbergEndpoint = config.endpoint;
 
@@ -127,6 +136,9 @@ export class Chromiumly {
         if (config.password !== undefined) {
             this.gotenbergApiBasicAuthPassword = config.password;
         }
+        if (config.addCustomHeadersFn !== undefined) {
+            this.addCustomHeadersFn = config.addCustomHeadersFn;
+        }
     }
 
     /**
@@ -156,4 +168,14 @@ export class Chromiumly {
     public static getGotenbergApiBasicAuthPassword(): string | undefined {
         return this.gotenbergApiBasicAuthPassword;
     }
+
+    /**
+     * Gets the function to build/send custom headers with fetch
+     * @returns () => Promise<Record<string, string>>
+     */
+    public static getAddCustomHeadersFn(): () => Promise<
+        Record<string, string>
+    > {
+        return this.addCustomHeadersFn ?? (async () => ({}));
+    }
 }