donobu 2.18.4 → 2.19.0

package/dist/esm/utils/BrowserUtils.js

@@ -0,0 +1,340 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserUtils = void 0;
+const playwright_1 = require("playwright");
+const JsonUtils_1 = require("./JsonUtils");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
+const path_1 = __importDefault(require("path"));
+const envVars_1 = require("../envVars");
+const Logger_1 = require("./Logger");
+class BrowserUtils {
+    /**
+     * Loads all the pre-canned browser device configurations from the local
+     * filesystem.
+     *
+     * The returned map keys the devices by their name (ex: 'Desktop Firefox').
+     *
+     * See `assets/devices.json` for details.
+     */
+    static getSupportedDevices() {
+        const rawDevices = JsonUtils_1.JsonUtils.readResourceAsJson(path_1.default.join('devices.json'));
+        if (!rawDevices) {
+            throw new Error('Failed to load devices configuration');
+        }
+        return new Map(Object.entries(rawDevices));
+    }
+    static async create(browserConfig, outputDir, storageState) {
+        const type = browserConfig.using.type;
+        let browser;
+        let browserContext;
+        switch (type) {
+            case 'device': {
+                ({ browser, browserContext } = await BrowserUtils.forDevice(browserConfig.using.deviceName ?? BrowserUtils.DEFAULT_DEVICE_NAME, browserConfig.using.headless ?? false, outputDir, storageState));
+                BrowserUtils.patchClose(browserContext, () => browser.close());
+                break;
+            }
+            case 'remoteInstance': {
+                ({ browser, browserContext } = await BrowserUtils.forRemoteBrowser(browserConfig.using.url, outputDir, storageState));
+                BrowserUtils.patchClose(browserContext, () => browser.close());
+                break;
+            }
+            case 'browserBase': {
+                let browserBaseData;
+                ({ browser, browserContext, browserBaseData } =
+                    await BrowserUtils.forBrowserBase(browserConfig.using.sessionArgs, outputDir, storageState));
+                BrowserUtils.patchClose(browserContext, async () => {
+                    try {
+                        await browser.close();
+                    }
+                    catch (_error) {
+                        // Ignore, the browser may have already been closed and that is fine.
+                    }
+                    const body = {
+                        projectId: browserBaseData.projectId,
+                        status: 'REQUEST_RELEASE',
+                    };
+                    const password = process.env[envVars_1.ENV_VAR_NAMES.BROWSERBASE_API_KEY] ?? '';
+                    const options = {
+                        method: 'POST',
+                        headers: {
+                            'X-BB-API-Key': password,
+                            'Content-Type': 'application/json',
+                        },
+                        body: JSON.stringify(body),
+                    };
+                    try {
+                        await fetch(`https://api.browserbase.com/v1/sessions/${browserBaseData.id}`, options);
+                    }
+                    catch (error) {
+                        // Ignore, BrowserBase sessions expire automatically anyway.
+                        Logger_1.appLogger.warn('Failed to release BrowserBase session', error);
+                    }
+                });
+                break;
+            }
+            default: {
+                throw new InvalidParamValueException_1.InvalidParamValueException('type', type);
+            }
+        }
+        await BrowserUtils.attachSessionStorageToBrowserContext(browserContext, storageState);
+        return browserContext;
+    }
+    /**
+     * Gets the browser storage state including cookies, localStorage, and sessionStorage.
+     *
+     * @param browserContext The browser context to extract storage state from.
+     * @returns A promise that resolves to the complete browser storage state.
+     */
+    static async getBrowserStorageState(browserContext) {
+        let result;
+        try {
+            // First get the standard storage state (cookies and localStorage)
+            result = await browserContext.storageState({
+                indexedDB: true,
+            });
+        }
+        catch (error) {
+            Logger_1.appLogger.warn('Failed to get storage state with indexedDB, falling back to cookies only', error);
+            result = await browserContext.storageState({
+                indexedDB: false,
+            });
+        }
+        // Get all pages in the context
+        const pages = browserContext.pages();
+        // Process each page to collect sessionStorage data
+        for (const page of pages) {
+            try {
+                // Get the origin for the current page
+                const pageOrigin = new URL(page.url()).origin;
+                // Find if we already have an entry for this origin
+                let originEntry = result.origins.find((entry) => entry.origin === pageOrigin);
+                // If not, create a new entry
+                if (!originEntry) {
+                    originEntry = {
+                        origin: pageOrigin,
+                        localStorage: [],
+                        sessionStorage: [],
+                    };
+                    result.origins.push(originEntry);
+                }
+                else if (!('sessionStorage' in originEntry)) {
+                    // If the entry exists but doesn't have sessionStorage yet, add the property
+                    originEntry.sessionStorage = [];
+                }
+                // Extract sessionStorage from the page
+                const sessionStorageItems = await page.evaluate(() => {
+                    const items = [];
+                    for (let i = 0; i < sessionStorage.length; i++) {
+                        const name = sessionStorage.key(i);
+                        if (name) {
+                            items.push({
+                                name,
+                                value: sessionStorage.getItem(name) || '',
+                            });
+                        }
+                    }
+                    return items;
+                });
+                // Add sessionStorage items to the origin entry
+                originEntry.sessionStorage = sessionStorageItems;
+            }
+            catch (error) {
+                Logger_1.appLogger.warn(`Failed to extract sessionStorage for page: ${page.url()}`, error);
+                // Skip pages that might have navigation errors or are about:blank.
+                continue;
+            }
+        }
+        return result;
+    }
+    /**
+     * Connects to an existing Chromium browser using the Chrome DevTools Protocol (CDP) at the given
+     * URL.
+     */
+    static async forRemoteBrowser(remoteBrowserInstanceUrl, outputDir, storageState) {
+        try {
+            const browser = await playwright_1.chromium.connectOverCDP(remoteBrowserInstanceUrl);
+            try {
+                const contextOptions = {
+                    recordVideo: { dir: outputDir },
+                };
+                if (storageState) {
+                    contextOptions.storageState = storageState;
+                }
+                return {
+                    browser: browser,
+                    browserContext: await browser.newContext(contextOptions),
+                };
+            }
+            catch (error) {
+                await browser.close();
+                throw error;
+            }
+        }
+        catch (_) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('remoteBrowserInstanceUrl', remoteBrowserInstanceUrl);
+        }
+    }
+    /**
+     * If {@link storageState} is present, must be an object conforming to what is returned by
+     * {@link BrowserContext.storageState()}.
+     */
+    static async forDevice(deviceName, headless, outputDir, storageState) {
+        const device = BrowserUtils.getSupportedDevices().get(deviceName);
+        if (!device) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('deviceName', deviceName);
+        }
+        const contextOptions = {
+            userAgent: device.userAgent,
+            recordVideo: {
+                dir: outputDir,
+                size: {
+                    width: device.viewport?.width ?? 1280,
+                    height: device.viewport?.height ?? 720,
+                },
+            },
+            viewport: {
+                width: device.viewport?.width ?? 1280,
+                height: device.viewport?.height ?? 720,
+            },
+            screen: {
+                width: device.screen?.width ?? device.viewport?.width ?? 1280,
+                height: device.screen?.height ?? device.viewport?.height ?? 720,
+            },
+            deviceScaleFactor: device.deviceScaleFactor ?? 1.0,
+            isMobile: device.isMobile ?? false,
+            hasTouch: device.hasTouch ?? false,
+        };
+        if (storageState) {
+            contextOptions.storageState = storageState;
+        }
+        const launchOptions = {
+            headless,
+            args: [
+                '--ignore-certificate-errors',
+                '--disable-blink-features=AutomationControlled',
+            ],
+        };
+        let browser;
+        switch (device.defaultBrowserType.toLowerCase()) {
+            case 'firefox':
+                browser = await playwright_1.firefox.launch(launchOptions);
+                break;
+            case 'chromium':
+                browser = await playwright_1.chromium.launch(launchOptions);
+                break;
+            case 'chrome':
+                browser = await playwright_1.chromium.launch({
+                    ...launchOptions,
+                    channel: 'chrome',
+                });
+                break;
+            case 'webkit':
+            case 'ios':
+                browser = await playwright_1.webkit.launch(launchOptions);
+                break;
+            default:
+                throw new InvalidParamValueException_1.InvalidParamValueException('browserType', device.defaultBrowserType);
+        }
+        try {
+            const browserContext = await browser.newContext(contextOptions);
+            return { browser, browserContext };
+        }
+        catch (error) {
+            await browser.close();
+            throw error;
+        }
+    }
+    /**
+     * Creates a BrowserBase session. Using this method requires the
+     * BROWSERBASE_API_KEY environment variable to be set.
+     *
+     * The returned browserBaseData object conforms to the response of the session
+     * creation API endpoint. See...
+     * https://docs.browserbase.com/reference/api/create-a-session#response-id
+     */
+    static async forBrowserBase(sessionArgs, outputDir, storageState) {
+        const browserBaseData = await BrowserUtils.establishBrowserBaseSession(sessionArgs);
+        const browser = await playwright_1.chromium.connectOverCDP(browserBaseData.connectUrl);
+        const contextOptions = {
+            recordVideo: { dir: outputDir },
+        };
+        if (storageState) {
+            contextOptions.storageState = storageState;
+        }
+        return {
+            browser: browser,
+            browserContext: await browser.newContext(contextOptions),
+            browserBaseData: browserBaseData,
+        };
+    }
+    /**
+     * Establishes a BrowserBase session. The returned structure matches the
+     * response structore from the BrowserBase session API. See...
+     * https://docs.browserbase.com/reference/api/create-a-session#response-id
+     */
+    static async establishBrowserBaseSession(sessionArgs) {
+        const password = process.env[envVars_1.ENV_VAR_NAMES.BROWSERBASE_API_KEY];
+        if (!password) {
+            throw new InvalidParamValueException_1.InvalidParamValueException(envVars_1.ENV_VAR_NAMES.BROWSERBASE_API_KEY, null);
+        }
+        const options = {
+            method: 'POST',
+            headers: { 'X-BB-API-Key': password, 'Content-Type': 'application/json' },
+            body: JSON.stringify(sessionArgs),
+        };
+        const browserBaseData = await fetch('https://api.browserbase.com/v1/sessions', options).then((response) => response.json());
+        if (browserBaseData.error) {
+            throw new InvalidParamValueException_1.InvalidParamValueException(envVars_1.ENV_VAR_NAMES.BROWSERBASE_API_KEY, '(redacted)', `${browserBaseData.error}: ${browserBaseData.message}`);
+        }
+        return browserBaseData;
+    }
+    static async attachSessionStorageToBrowserContext(browserContext, storageState) {
+        // Add init script to restore sessionStorage if storage state is provided
+        if (storageState && storageState.origins) {
+            // Transform the storage state to map origins to their sessionStorage
+            const sessionStorageByOrigin = {};
+            for (const origin of storageState.origins) {
+                if (origin.sessionStorage && origin.sessionStorage.length > 0) {
+                    // Create a key-value map for this origin's sessionStorage
+                    const sessionStorageMap = {};
+                    for (const item of origin.sessionStorage) {
+                        sessionStorageMap[item.name] = item.value;
+                    }
+                    sessionStorageByOrigin[origin.origin] = sessionStorageMap;
+                }
+            }
+            // Add the init script to restore sessionStorage based on the page's origin
+            await browserContext.addInitScript((storageData) => {
+                // Get current origin
+                const currentOrigin = window.location.origin;
+                // Check if we have sessionStorage data for this origin
+                if (storageData[currentOrigin]) {
+                    // Restore the sessionStorage items
+                    for (const [key, value] of Object.entries(storageData[currentOrigin])) {
+                        window.sessionStorage.setItem(key, value);
+                    }
+                    console.log(`Restored ${Object.keys(storageData[currentOrigin]).length} sessionStorage items for ${currentOrigin}`);
+                }
+            }, sessionStorageByOrigin);
+        }
+    }
+    static patchClose(ctx, extra) {
+        const original = ctx.close.bind(ctx);
+        ctx.close = async (...args) => {
+            try {
+                await original(...args);
+            }
+            catch { }
+            try {
+                await extra();
+            }
+            catch { }
+        };
+    }
+}
+exports.BrowserUtils = BrowserUtils;
+BrowserUtils.DEFAULT_DEVICE_NAME = 'Desktop Chromium';
+//# sourceMappingURL=BrowserUtils.js.map

package/dist/esm/utils/BrowserUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserUtils.js","sourceRoot":"","sources":["../../../src/utils/BrowserUtils.ts"],"names":[],"mappings":";;;;;;AAMA,2CAAuD;AACvD,2CAAwC;AACxC,yFAAsF;AAGtF,gDAAwB;AAExB,wCAA2C;AAC3C,qCAAqC;AAErC,MAAa,YAAY;IAEvB;;;;;;;OAOG;IACI,MAAM,CAAC,mBAAmB;QAC/B,MAAM,UAAU,GAAG,qBAAS,CAAC,kBAAkB,CAC7C,cAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CACO,CAAC;QAEnC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,GAAG,CAAwB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,aAA4B,EAC5B,SAAiB,EACjB,YAAkC;QAElC,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;QACtC,IAAI,OAAgB,CAAC;QACrB,IAAI,cAA8B,CAAC;QAEnC,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,YAAY,CAAC,SAAS,CACzD,aAAa,CAAC,KAAK,CAAC,UAAU,IAAI,YAAY,CAAC,mBAAmB,EAClE,aAAa,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,EACrC,SAAS,EACT,YAAY,CACb,CAAC,CAAC;gBACH,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC/D,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAChE,aAAa,CAAC,KAAK,CAAC,GAAG,EACvB,SAAS,EACT,YAAY,CACb,CAAC,CAAC;gBACH,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC/D,MAAM;YACR,CAAC;YACD,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,IAAI,eAAe,CAAC;gBACpB,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE;oBAC3C,MAAM,YAAY,CAAC,cAAc,CAC/B,aAAa,CAAC,KAAK,CAAC,WAAW,EAC/B,SAAS,EACT,YAAY,CACb,CAAC,CAAC;gBACL,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;oBACjD,IAAI,CAAC;wBACH,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;oBACxB,CAAC;oBAAC,OAAO,MAAM,EAAE,CAAC;wBAChB,qEAAqE;oBACvE,CAAC;oBAED,MAAM,IAAI,GAAG;wBACX,SAAS,EAAE,eAAe,CAAC,SAAS;wBACpC,MAAM,EAAE,iBAAiB;qBAC1B,CAAC;oBACF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;oBACtE,MAAM,OAAO,GAAG;wBACd,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE;4BACP,cAAc,EAAE,QAAQ;4BACxB,cAAc,EAAE,kBAAkB;yBACnC;wBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;qBAC3B,CAAC;oBAEF,IAAI,CAAC;wBACH,MAAM,KAAK,CACT,2CAA2C,eAAe,CAAC,EAAE,EAAE,EAC/D,OAAO,CACR,CAAC;oBACJ,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,4DAA4D;wBAC5D,kBAAS,CAAC,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;oBACjE,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,uDAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAED,MAAM,YAAY,CAAC,oCAAoC,CACrD,cAAc,EACd,YAAY,CACb,CAAC;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CACxC,cAA8B;QAE9B,IAAI,MAA2B,CAAC;QAEhC,IAAI,CAAC;YACH,kEAAkE;YAClE,MAAM,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC;gBACzC,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,kBAAS,CAAC,IAAI,CACZ,0EAA0E,EAC1E,KAAK,CACN,CAAC;YACF,MAAM,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC;gBACzC,SAAS,EAAE,KAAK;aACjB,CAAC,CAAC;QACL,CAAC;QAED,+BAA+B;QAC/B,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;QAErC,mDAAmD;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,sCAAsC;gBACtC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;gBAE9C,mDAAmD;gBACnD,IAAI,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CACnC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU,CACvC,CAAC;gBAEF,6BAA6B;gBAC7B,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,WAAW,GAAG;wBACZ,MAAM,EAAE,UAAU;wBAClB,YAAY,EAAE,EAAE;wBAChB,cAAc,EAAE,EAAE;qBACnB,CAAC;oBACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACnC,CAAC;qBAAM,IAAI,CAAC,CAAC,gBAAgB,IAAI,WAAW,CAAC,EAAE,CAAC;oBAC9C,4EAA4E;oBAC3E,WAAmB,CAAC,cAAc,GAAG,EAAE,CAAC;gBAC3C,CAAC;gBAED,uCAAuC;gBACvC,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;oBACnD,MAAM,KAAK,GAAG,EAAE,CAAC;oBAEjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/C,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;wBAEnC,IAAI,IAAI,EAAE,CAAC;4BACT,KAAK,CAAC,IAAI,CAAC;gCACT,IAAI;gCACJ,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE;6BAC1C,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBAEH,+CAA+C;gBAC9C,WAAmB,CAAC,cAAc,GAAG,mBAAmB,CAAC;YAC5D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,kBAAS,CAAC,IAAI,CACZ,8CAA8C,IAAI,CAAC,GAAG,EAAE,EAAE,EAC1D,KAAK,CACN,CAAC;gBACF,mEAAmE;gBACnE,SAAS;YACX,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,wBAAgC,EAChC,SAAiB,EACjB,YAAkC;QAElC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,qBAAQ,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;YAExE,IAAI,CAAC;gBACH,MAAM,cAAc,GAA0B;oBAC5C,WAAW,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE;iBAChC,CAAC;gBAEF,IAAI,YAAY,EAAE,CAAC;oBACjB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;gBAC7C,CAAC;gBAED,OAAO;oBACL,OAAO,EAAE,OAAO;oBAChB,cAAc,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;iBACzD,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,uDAA0B,CAClC,0BAA0B,EAC1B,wBAAwB,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5B,UAAkB,EAClB,QAAiB,EACjB,SAAiB,EACjB,YAAkC;QAElC,MAAM,MAAM,GAAG,YAAY,CAAC,mBAAmB,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAElE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,uDAA0B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,cAAc,GAA0B;YAC5C,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,WAAW,EAAE;gBACX,GAAG,EAAE,SAAS;gBACd,IAAI,EAAE;oBACJ,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;oBACrC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;iBACvC;aACF;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;gBACrC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;aACvC;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,IAAI,IAAI;gBAC7D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG;aAChE;YACD,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,IAAI,GAAG;YAClD,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;YAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,KAAK;SACnC,CAAC;QAEF,IAAI,YAAY,EAAE,CAAC;YACjB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;QAC7C,CAAC;QAED,MAAM,aAAa,GAAkB;YACnC,QAAQ;YACR,IAAI,EAAE;gBACJ,6BAA6B;gBAC7B,+CAA+C;aAChD;SACF,CAAC;QAEF,IAAI,OAAgB,CAAC;QAErB,QAAQ,MAAM,CAAC,kBAAkB,CAAC,WAAW,EAAE,EAAE,CAAC;YAChD,KAAK,SAAS;gBACZ,OAAO,GAAG,MAAM,oBAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,UAAU;gBACb,OAAO,GAAG,MAAM,qBAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,GAAG,MAAM,qBAAQ,CAAC,MAAM,CAAC;oBAC9B,GAAG,aAAa;oBAChB,OAAO,EAAE,QAAQ;iBAClB,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,QAAQ,CAAC;YACd,KAAK,KAAK;gBACR,OAAO,GAAG,MAAM,mBAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC7C,MAAM;YACR;gBACE,MAAM,IAAI,uDAA0B,CAClC,aAAa,EACb,MAAM,CAAC,kBAAkB,CAC1B,CAAC;QACN,CAAC;QAED,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAChE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,KAAK,CAAC,cAAc,CACjC,WAAmC,EACnC,SAAiB,EACjB,YAAkC;QAMlC,MAAM,eAAe,GACnB,MAAM,YAAY,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,MAAM,qBAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,cAAc,GAA0B;YAC5C,WAAW,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE;SAChC,CAAC;QAEF,IAAI,YAAY,EAAE,CAAC;YACjB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;QAC7C,CAAC;QAED,OAAO;YACL,OAAO,EAAE,OAAO;YAChB,cAAc,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;YACxD,eAAe,EAAE,eAAe;SACjC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAC9C,WAAmC;QAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAa,CAAC,mBAAmB,CAAC,CAAC;QAEhE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,uDAA0B,CAClC,uBAAa,CAAC,mBAAmB,EACjC,IAAI,CACL,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,kBAAkB,EAAE;YACzE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;SAClC,CAAC;QAEF,MAAM,eAAe,GAAG,MAAM,KAAK,CACjC,yCAAyC,EACzC,OAAO,CACR,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAEtC,IAAI,eAAe,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,uDAA0B,CAClC,uBAAa,CAAC,mBAAmB,EACjC,YAAY,EACZ,GAAG,eAAe,CAAC,KAAK,KAAK,eAAe,CAAC,OAAO,EAAE,CACvD,CAAC;QACJ,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,oCAAoC,CACvD,cAA8B,EAC9B,YAAkC;QAElC,yEAAyE;QACzE,IAAI,YAAY,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;YACzC,qEAAqE;YACrE,MAAM,sBAAsB,GAA2C,EAAE,CAAC;YAE1E,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC1C,IAAI,MAAM,CAAC,cAAc,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9D,0DAA0D;oBAC1D,MAAM,iBAAiB,GAA2B,EAAE,CAAC;oBAErD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;wBACzC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;oBAC5C,CAAC;oBAED,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC;gBAC5D,CAAC;YACH,CAAC;YAED,2EAA2E;YAC3E,MAAM,cAAc,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,EAAE;gBACjD,qBAAqB;gBACrB,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAE7C,uDAAuD;gBACvD,IAAI,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC/B,mCAAmC;oBACnC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CACvC,WAAW,CAAC,aAAa,CAAC,CAC3B,EAAE,CAAC;wBACF,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBAC5C,CAAC;oBACD,OAAO,CAAC,GAAG,CACT,YAAY,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,6BAA6B,aAAa,EAAE,CACvG,CAAC;gBACJ,CAAC;YACH,CAAC,EAAE,sBAAsB,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,UAAU,CACvB,GAAmB,EACnB,KAA0B;QAE1B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,GAAG,CAAC,KAAK,GAAG,KAAK,EACf,GAAG,IAAyC,EAC7B,EAAE;YACjB,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YACV,IAAI,CAAC;gBACH,MAAM,KAAK,EAAE,CAAC;YAChB,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACZ,CAAC,CAAC;IACJ,CAAC;;AA3bH,oCA4bC;AA3byB,gCAAmB,GAAG,kBAAkB,CAAC"}

package/dist/esm/utils/PlaywrightUtils.d.ts

@@ -28,7 +28,21 @@ export declare class PlaywrightUtils {
      * Note that if the Donobu control panel is present in the page, it will be
      * excluded from the screenshot.
      */
-    static takeScreenshot(page: Page, type?: 'png' | 'jpeg'): Promise<Buffer>;
+    static takeViewportScreenshot(page: Page, type?: 'png' | 'jpeg'): Promise<Buffer>;
+    /**
+     * Captures up to three screenshots of the given page.
+     *
+     * - `viewport`  : exact current viewport
+     * - `aboveViewport` : up to half-viewport preview just above the fold (cropped to exclude main viewport)
+     * - `belowViewport` : up to half-viewport preview just below the fold (cropped to exclude main viewport)
+     *
+     * All images are returned as JPEG buffers.
+     */
+    static takePageScreenshots(page: Page): Promise<{
+        aboveViewport: Buffer | null;
+        viewport: Buffer;
+        belowViewport: Buffer | null;
+    }>;
     /**
      * Generate valid selectors for the given element. The generated selectors are
      * in a priority order based on their ability to identify the given element.
@@ -59,15 +73,5 @@ export declare class PlaywrightUtils {
      * it is logged and ignored. If page is null, this function has no effect.
      */
     static waitForPageStability(page: Page | null): Promise<void>;
-    /**
-     * Takes a screenshot of the webpage as if it were scrolled down by one viewport.
-     * If the page cannot be scrolled as a whole, tries to find and scroll individual
-     * scrollable elements on the page. After taking the screenshot, it reverts to
-     * the original scroll position.
-     *
-     * @param page The Playwright Page to take a screenshot of
-     * @returns An image buffer of the scrolled down view, or undefined if scrolling isn't possible
-     */
-    static getScrolledDownScreenShot(page: Page): Promise<Buffer | undefined>;
 }
 //# sourceMappingURL=PlaywrightUtils.d.ts.map

package/dist/esm/utils/PlaywrightUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlaywrightUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/PlaywrightUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAUlD;;;GAGG;AACH,qBAAa,eAAe;IAC1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CACkB;IAE3E;;;;;OAKG;IACH,gBAAuB,oCAAoC,SACmB;IAE9E;;;;;;;;OAQG;WACiB,cAAc,CAChC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE,KAAK,GAAG,MAAe,GAC5B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;OAMG;WACiB,iBAAiB,CAAC,OAAO,EAAE;QAC7C,QAAQ,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAMrB;;;;;OAKG;WACiB,wBAAwB,CAC1C,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,IAAI,CAAC;IAWhB;;;OAGG;WACW,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;WAkBhC,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;WAI7C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDnE;;;;OAIG;WACiB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB1E;;;;;;;;OAQG;WACiB,yBAAyB,CAC3C,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CA4I/B"}
+{"version":3,"file":"PlaywrightUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/PlaywrightUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAUlD;;;GAGG;AACH,qBAAa,eAAe;IAC1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CACkB;IAE3E;;;;;OAKG;IACH,gBAAuB,oCAAoC,SACmB;IAE9E;;;;;;;;OAQG;WACiB,sBAAsB,CACxC,IAAI,EAAE,IAAI,EACV,IAAI,GAAE,KAAK,GAAG,MAAe,GAC5B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;OAQG;WACiB,mBAAmB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC;QAC3D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC;IA8HF;;;;;;OAMG;WACiB,iBAAiB,CAAC,OAAO,EAAE;QAC7C,QAAQ,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAMrB;;;;;OAKG;WACiB,wBAAwB,CAC1C,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,IAAI,CAAC;IAWhB;;;OAGG;WACW,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;WAkBhC,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;WAI7C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDnE;;;;OAIG;WACiB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAuB3E"}

package/dist/esm/utils/PlaywrightUtils.js

@@ -26,7 +26,7 @@ class PlaywrightUtils {
      * Note that if the Donobu control panel is present in the page, it will be
      * excluded from the screenshot.
      */
-    static async takeScreenshot(page, type = 'jpeg') {
+    static async takeViewportScreenshot(page, type = 'jpeg') {
         try {
             const style = `#${ControlPanel_1.ControlPanel.DONOBU_CONTROL_PANEL_ELEMENT_ID} { display: none !important; }`;
             return await page.screenshot({
@@ -43,6 +43,115 @@ class PlaywrightUtils {
             }
         }
     }
+    /**
+     * Captures up to three screenshots of the given page.
+     *
+     * - `viewport`  : exact current viewport
+     * - `aboveViewport` : up to half-viewport preview just above the fold (cropped to exclude main viewport)
+     * - `belowViewport` : up to half-viewport preview just below the fold (cropped to exclude main viewport)
+     *
+     * All images are returned as JPEG buffers.
+     */
+    static async takePageScreenshots(page) {
+        const screenshotStyleOverride = `#${ControlPanel_1.ControlPanel.DONOBU_CONTROL_PANEL_ELEMENT_ID} { display: none !important; }`;
+        // Take the screenshot of the current viewport immediately – this is always available.
+        const viewportBuffer = await PlaywrightUtils.takeViewportScreenshot(page, 'jpeg');
+        // If the viewport size is not available we cannot reliably scroll.
+        const viewportSize = page.viewportSize();
+        if (!viewportSize) {
+            return {
+                aboveViewport: null,
+                viewport: viewportBuffer,
+                belowViewport: null,
+            };
+        }
+        const viewportHeight = viewportSize.height;
+        const halfViewport = Math.floor(viewportHeight / 2);
+        // Capture original scroll position & page dimensions so we can both
+        // determine if we *can* scroll and later restore state.
+        const { originalScrollY, scrollHeight } = await page.evaluate(() => {
+            return {
+                originalScrollY: window.scrollY || window.pageYOffset || 0,
+                scrollHeight: document.documentElement.scrollHeight ||
+                    document.body.scrollHeight ||
+                    0,
+            };
+        });
+        let aboveBuffer = null;
+        let belowBuffer = null;
+        // Always wrap scrolling logic with try/finally so that we restore the
+        // initial scroll position even when an unexpected error occurs.
+        try {
+            /************************************************************
+             * Capture the area *above* the current viewport ("just above the fold")
+             ************************************************************/
+            if (originalScrollY > 0) {
+                const targetY = Math.max(0, originalScrollY - halfViewport);
+                await page.evaluate((y) => window.scrollTo(0, y), targetY);
+                // Give the browser a tiny bit of time – many sites throttle paint.
+                await page.waitForTimeout(100);
+                // Calculate the non-overlapping portion to capture
+                const overlapPixels = Math.max(0, targetY + viewportHeight - originalScrollY);
+                const cropHeight = viewportHeight - overlapPixels;
+                if (cropHeight > 0) {
+                    // Use Playwright's clip parameter to capture only the non-overlapping portion
+                    aboveBuffer = await page.screenshot({
+                        style: screenshotStyleOverride,
+                        type: 'jpeg',
+                        clip: {
+                            x: 0,
+                            y: 0,
+                            width: viewportSize.width,
+                            height: cropHeight,
+                        },
+                    });
+                }
+            }
+            /************************************************************
+             * Capture the area *below* the current viewport ("just below the fold")
+             ************************************************************/
+            if (originalScrollY + viewportHeight < scrollHeight) {
+                const targetY = Math.min(scrollHeight - viewportHeight, originalScrollY + halfViewport);
+                await page.evaluate((y) => window.scrollTo(0, y), targetY);
+                await page.waitForTimeout(100);
+                // Calculate the non-overlapping portion to capture
+                const overlapPixels = Math.max(0, originalScrollY + viewportHeight - targetY);
+                const cropY = overlapPixels;
+                const cropHeight = viewportHeight - overlapPixels;
+                if (cropHeight > 0) {
+                    // Use Playwright's clip parameter to capture only the non-overlapping portion
+                    belowBuffer = await page.screenshot({
+                        style: screenshotStyleOverride,
+                        type: 'jpeg',
+                        clip: {
+                            x: 0,
+                            y: cropY,
+                            width: viewportSize.width,
+                            height: cropHeight,
+                        },
+                    });
+                }
+            }
+        }
+        finally {
+            // Always attempt to restore the page to its initial scroll position so
+            // that callers see *no* side‑effects.
+            try {
+                if ((await page.evaluate(() => window.scrollY)) !== originalScrollY) {
+                    await page.evaluate((y) => window.scrollTo(0, y), originalScrollY);
+                    await page.waitForTimeout(50);
+                }
+            }
+            catch (restoreError) {
+                Logger_1.appLogger.error(`Failed to restore scroll position for page ${page.url()}`, restoreError);
+            }
+        }
+        return {
+            aboveViewport: aboveBuffer,
+            viewport: viewportBuffer,
+            belowViewport: belowBuffer,
+        };
+    }
     /**
      * Generate valid selectors for the given element. The generated selectors are
      * in a priority order based on their ability to identify the given element.
@@ -156,127 +265,6 @@ class PlaywrightUtils {
             }
         }
     }
-    /**
-     * Takes a screenshot of the webpage as if it were scrolled down by one viewport.
-     * If the page cannot be scrolled as a whole, tries to find and scroll individual
-     * scrollable elements on the page. After taking the screenshot, it reverts to
-     * the original scroll position.
-     *
-     * @param page The Playwright Page to take a screenshot of
-     * @returns An image buffer of the scrolled down view, or undefined if scrolling isn't possible
-     */
-    static async getScrolledDownScreenShot(page) {
-        try {
-            // Get the current scroll position and viewport height
-            const { scrollX, scrollY, viewportHeight } = await page.evaluate(() => {
-                return {
-                    scrollX: window.scrollX,
-                    scrollY: window.scrollY,
-                    viewportHeight: window.innerHeight,
-                };
-            });
-            // Step 1: Try to scroll the window down by one viewport
-            await page.evaluate((viewportHeight) => {
-                window.scrollBy(0, viewportHeight);
-            }, viewportHeight);
-            // Check if the page actually scrolled
-            const newScrollY = await page.evaluate(() => window.scrollY);
-            // If the window scrolled successfully, take the screenshot and return
-            if (newScrollY > scrollY) {
-                // Take the screenshot
-                const screenshot = await PlaywrightUtils.takeScreenshot(page);
-                // Scroll back to the original position
-                await page.evaluate(([x, y]) => {
-                    window.scrollTo(x, y);
-                }, [scrollX, scrollY]);
-                return screenshot;
-            }
-            // Step 2: If window didn't scroll, try to find scrollable elements
-            const didScrollElement = await page.evaluate(() => {
-                // Find all potentially scrollable elements
-                function findScrollableElements() {
-                    const allElements = document.querySelectorAll('*');
-                    const scrollableElements = [];
-                    allElements.forEach((el) => {
-                        const style = window.getComputedStyle(el);
-                        const overflowY = style.getPropertyValue('overflow-y');
-                        const overflowX = style.getPropertyValue('overflow-x');
-                        const overflow = style.getPropertyValue('overflow');
-                        // Check if the element has scrollable properties
-                        if (overflowY === 'auto' ||
-                            overflowY === 'scroll' ||
-                            overflowX === 'auto' ||
-                            overflowX === 'scroll' ||
-                            overflow === 'auto' ||
-                            overflow === 'scroll') {
-                            // Additional check to see if the element actually has content to scroll
-                            const scrollHeight = el.scrollHeight;
-                            const clientHeight = el.clientHeight;
-                            if (scrollHeight > clientHeight) {
-                                scrollableElements.push({
-                                    element: el,
-                                    area: el.clientWidth * el.clientHeight, // Calculate area for sorting
-                                    scrollTop: el.scrollTop, // Save original scroll position
-                                });
-                            }
-                        }
-                    });
-                    return scrollableElements;
-                }
-                // Find and sort scrollable elements by size (largest first)
-                const scrollableElements = findScrollableElements().sort((a, b) => b.area - a.area);
-                let didScroll = false;
-                // Try to scroll each element until one successfully scrolls
-                for (const { element } of scrollableElements) {
-                    const originalScrollTop = element.scrollTop;
-                    // Try to scroll down by the element's client height
-                    element.scrollTop += element.clientHeight;
-                    // Check if scrolling was successful
-                    if (element.scrollTop > originalScrollTop) {
-                        didScroll = true;
-                        // Save the element in the window object so we can access it later
-                        // @ts-ignore
-                        window.__lastScrolledElement = element;
-                        // @ts-ignore
-                        window.__lastScrolledElementOriginalPosition = originalScrollTop;
-                        break;
-                    }
-                }
-                return didScroll;
-            });
-            // If no element could be scrolled, return undefined
-            if (!didScrollElement) {
-                return undefined;
-            }
-            // Take a screenshot after scrolling the element
-            const screenshot = await PlaywrightUtils.takeScreenshot(page);
-            // Restore the original scroll position of the element
-            await page.evaluate(() => {
-                if (
-                // @ts-ignore
-                window.__lastScrolledElement &&
-                    // @ts-ignore
-                    window.__lastScrolledElementOriginalPosition !== undefined) {
-                    // @ts-ignore
-                    window.__lastScrolledElement.scrollTop = window.__lastScrolledElementOriginalPosition;
-                    // Clean up
-                    // @ts-ignore
-                    delete window.__lastScrolledElement;
-                    // @ts-ignore
-                    delete window.__lastScrolledElementOriginalPosition;
-                }
-            });
-            return screenshot;
-        }
-        catch (error) {
-            if (PlaywrightUtils.isPageClosedError(error)) {
-                throw new PageClosedException_1.PageClosedException();
-            }
-            else {
-                throw error;
-            }
-        }
-    }
 }
 exports.PlaywrightUtils = PlaywrightUtils;
 /**