feat: Add new config option requestHeaders

src/lib/ctx.ts

@@ -1,4 +1,4 @@
-import { Context, Env, WebConfig, MobileConfig, basicAuth } from '../types.js'
+import { Context, Env, WebConfig, MobileConfig, basicAuth, authToken } from '../types.js'
 import constants from './constants.js'
 import { version } from '../../package.json'
 import { validateConfig } from './schemaValidation.js'
@@ -11,7 +11,8 @@ export default (options: Record<string, string>): Context => {
     let env: Env = getEnv();
     let webConfig: WebConfig;
     let mobileConfig: MobileConfig;
-    let basicAuthObj: basicAuth
+    let basicAuthObj: basicAuth;
+    let requestHeaderObj: authToken;
     let config = constants.DEFAULT_CONFIG;
     let port: number;
     let resolutionOff: boolean;
@@ -60,6 +61,10 @@ export default (options: Record<string, string>): Context => {
     if (config.basicAuthorization) {
         basicAuthObj = config.basicAuthorization
     }
+    if (config.requestHeaders){
+        requestHeaderObj = config.requestHeaders
+    }
+
 
     return {
         env: env,
@@ -75,7 +80,8 @@ export default (options: Record<string, string>): Context => {
             scrollTime: config.scrollTime || constants.DEFAULT_SCROLL_TIME,
             allowedHostnames: config.allowedHostnames || [],
             basicAuthorization: basicAuthObj,
-            smartIgnore: config.smartIgnore ?? false
+            smartIgnore: config.smartIgnore ?? false,
+            requestHeaders: requestHeaderObj
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/processSnapshot.ts

@@ -146,12 +146,23 @@ async function processSnapshot(snapshot: Snapshot, ctx: Context): Promise<Record
             // handle discovery config
             ctx.config.allowedHostnames.push(new URL(snapshot.url).hostname);
             if (ctx.config.enableJavaScript) ALLOWED_RESOURCES.push('script');
-            if (ctx.config.basicAuthorization) {
-                ctx.log.debug(`Adding basic authorization to the headers for root url`);
-                let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString('base64');
+
+            if (ctx.config.basicAuthorization || ctx.config.requestHeaders) {
+                ctx.log.debug(`Adding basic authorization to the headers for url ${requestUrl}`);
+                let basicToken;
+                if (ctx.config.basicAuthorization){
+                    if(ctx.config.basicAuthorization.username && ctx.config.basicAuthorization.password){
+                        let token = Buffer.from(`${ctx.config.basicAuthorization.username}:${ctx.config.basicAuthorization.password}`).toString('base64');
+                        basicToken = `Basic ${token}`
+                    }
+                } else if (ctx.config.requestHeaders) {
+                    if(ctx.config.requestHeaders.auth){
+                        basicToken = ctx.config.requestHeaders.auth
+                    }
+                }
                 requestOptions.headers = {
                     ...request.headers(),
-                    Authorization: `Basic ${token}`
+                    Authorization: basicToken
                 };
             }
 

src/lib/schemaValidation.ts

@@ -150,6 +150,15 @@ const ConfigSchema = {
                     errorMessage: "Invalid config; password is mandatory"
                 },
             }
+        },
+        requestHeaders: {
+            type: "object",
+            properties: {
+                auth: {
+                    type: "string", 
+                    errorMessage: "Invalid config; auth is mandatory"
+                },
+            }
         }
     },
     anyOf: [

src/types.ts

@@ -25,6 +25,7 @@ export interface Context {
         allowedHostnames: Array<string>;
         basicAuthorization: basicAuth | undefined;
         smartIgnore: boolean;
+        requestHeaders: authToken | undefined
     };
     uploadFilePath: string;
     webStaticConfig: WebStaticConfig;
@@ -148,3 +149,7 @@ export interface basicAuth {
     username: string;
     password: string;
 }
+
+export interface authToken {
+    auth: string;
+}