@wdio/image-comparison-core 1.0.0

package/dist/commands/saveWebElement.test.js

@@ -0,0 +1,253 @@
+import { describe, it, expect, vi, afterEach } from 'vitest';
+import saveWebElement from './saveWebElement.js';
+import { takeElementScreenshot } from '../methods/takeElementScreenshots.js';
+import afterScreenshot from '../helpers/afterScreenshot.js';
+import { canUseBidiScreenshot } from '../helpers/utils.js';
+import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
+import { createBaseOptions, createMethodOptions, createBeforeScreenshotMock } from '../mocks/mocks.js';
+vi.mock('../methods/takeElementScreenshots.js', () => ({
+    takeElementScreenshot: vi.fn().mockResolvedValue({
+        base64Image: 'element-screenshot-data',
+        isWebDriverElementScreenshot: false
+    })
+}));
+vi.mock('../helpers/beforeScreenshot.js', () => ({
+    default: vi.fn().mockResolvedValue({
+        browserName: 'chrome',
+        browserVersion: '120.0.0',
+        deviceName: 'desktop',
+        dimensions: {
+            window: {
+                devicePixelRatio: 2,
+                innerHeight: 900,
+                isEmulated: false,
+                isLandscape: false,
+                outerHeight: 1000,
+                outerWidth: 1200,
+                screenHeight: 1080,
+                screenWidth: 1920,
+            },
+        },
+        initialDevicePixelRatio: 2,
+        isAndroid: false,
+        isAndroidChromeDriverScreenshot: false,
+        isAndroidNativeWebScreenshot: false,
+        isIOS: false,
+        isMobile: false,
+        isTestInBrowser: true,
+        isTestInMobileBrowser: false,
+        addressBarShadowPadding: 0,
+        toolBarShadowPadding: 0,
+        appName: '',
+        logName: 'chrome',
+        name: 'chrome',
+        platformName: 'desktop',
+        platformVersion: '120.0.0',
+    })
+}));
+vi.mock('../helpers/afterScreenshot.js', () => ({
+    default: vi.fn().mockResolvedValue({
+        devicePixelRatio: 2,
+        fileName: 'test-element.png'
+    })
+}));
+vi.mock('../helpers/utils.js', () => ({
+    canUseBidiScreenshot: vi.fn().mockReturnValue(false),
+    getMethodOrWicOption: vi.fn().mockImplementation((method, wic, option) => method[option] ?? wic[option])
+}));
+vi.mock('../helpers/options.js', async (importOriginal) => {
+    const actual = await importOriginal();
+    return {
+        ...actual,
+        createBeforeScreenshotOptions: vi.fn().mockReturnValue({
+            instanceData: { test: 'data' },
+            addressBarShadowPadding: 6,
+            toolBarShadowPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            enableLayoutTesting: false,
+            hideElements: [],
+            noScrollBars: true,
+            removeElements: [],
+            waitForFontsLoaded: false,
+        }),
+        buildAfterScreenshotOptions: vi.fn().mockReturnValue({
+            actualFolder: '/test/actual',
+            base64Image: 'element-screenshot-data',
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            enableLayoutTesting: false,
+            filePath: {
+                browserName: 'chrome',
+                deviceName: 'desktop',
+                isMobile: false,
+                savePerInstance: false,
+            },
+            fileName: {
+                browserName: 'chrome',
+                browserVersion: '120.0.0',
+                deviceName: 'desktop',
+                devicePixelRatio: 2,
+                formatImageName: '{tag}-{browserName}-{width}x{height}',
+                isMobile: false,
+                isTestInBrowser: true,
+                logName: 'chrome',
+                name: 'chrome',
+                outerHeight: 1000,
+                outerWidth: 1200,
+                platformName: 'desktop',
+                platformVersion: '120.0.0',
+                screenHeight: 1080,
+                screenWidth: 1920,
+                tag: 'test-element'
+            },
+            hideElements: [],
+            hideScrollBars: true,
+            isLandscape: false,
+            isNativeContext: false,
+            platformName: 'desktop',
+            removeElements: [],
+        })
+    };
+});
+describe('saveWebElement', () => {
+    const takeElementScreenshotSpy = vi.mocked(takeElementScreenshot);
+    const afterScreenshotSpy = vi.mocked(afterScreenshot);
+    const canUseBidiScreenshotSpy = vi.mocked(canUseBidiScreenshot);
+    const createBeforeScreenshotOptionsSpy = vi.mocked(createBeforeScreenshotOptions);
+    const buildAfterScreenshotOptionsSpy = vi.mocked(buildAfterScreenshotOptions);
+    const baseOptions = {
+        ...createBaseOptions('element'),
+        element: { elementId: 'test-element' },
+        browserInstance: {
+            isAndroid: false,
+            isMobile: false
+        }
+    };
+    const createTestOptions = (methodOptions = {}) => ({
+        ...baseOptions,
+        saveElementOptions: {
+            ...baseOptions.saveElementOptions,
+            method: createMethodOptions(methodOptions)
+        }
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should call takeElementScreenshot with correct options when BiDi is available', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const result = await saveWebElement(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(createBeforeScreenshotOptionsSpy.mock.calls[0]).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot();
+    });
+    it('should call takeElementScreenshot with BiDi disabled when not available', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(false);
+        const result = await saveWebElement(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot();
+    });
+    it('should call takeElementScreenshot with BiDi disabled when mobile device', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const beforeScreenshotMock = createBeforeScreenshotMock({ isMobile: true });
+        vi.mocked((await import('../helpers/beforeScreenshot.js')).default).mockResolvedValueOnce(beforeScreenshotMock);
+        const result = await saveWebElement(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
+    });
+    it('should call takeElementScreenshot with BiDi disabled when legacy method enabled', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const options = createTestOptions({
+            enableLegacyScreenshotMethod: true
+        });
+        const result = await saveWebElement(options);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should pass autoElementScroll option correctly', async () => {
+        const options = createTestOptions({
+            wic: {
+                ...baseOptions.saveElementOptions.wic,
+                autoElementScroll: true
+            }
+        });
+        const result = await saveWebElement(options);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should pass resizeDimensions option correctly', async () => {
+        const customResizeDimensions = { top: 10, right: 15, bottom: 20, left: 25 };
+        const options = createTestOptions({
+            resizeDimensions: customResizeDimensions
+        });
+        const result = await saveWebElement(options);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should handle NaN dimension values correctly', async () => {
+        const nanDimensions = createBeforeScreenshotMock({
+            dimensions: {
+                window: {
+                    devicePixelRatio: NaN,
+                    innerHeight: NaN,
+                    isEmulated: false,
+                    isLandscape: false,
+                    outerHeight: NaN,
+                    outerWidth: NaN,
+                    screenHeight: NaN,
+                    screenWidth: NaN,
+                },
+            },
+            devicePixelRatio: NaN,
+            initialDevicePixelRatio: NaN
+        });
+        vi.mocked((await import('../helpers/beforeScreenshot.js')).default).mockResolvedValueOnce(nanDimensions);
+        buildAfterScreenshotOptionsSpy.mockReturnValueOnce({
+            actualFolder: '/test/actual',
+            base64Image: 'element-screenshot-data',
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            enableLayoutTesting: false,
+            filePath: {
+                browserName: 'chrome',
+                deviceName: 'desktop',
+                isMobile: false,
+                savePerInstance: false,
+            },
+            fileName: {
+                browserName: 'chrome',
+                browserVersion: '120.0.0',
+                deviceName: 'desktop',
+                devicePixelRatio: NaN,
+                formatImageName: '{tag}-{browserName}-{width}x{height}',
+                isMobile: false,
+                isTestInBrowser: true,
+                logName: 'chrome',
+                name: 'chrome',
+                outerHeight: NaN,
+                outerWidth: NaN,
+                platformName: 'desktop',
+                platformVersion: '120.0.0',
+                screenHeight: NaN,
+                screenWidth: NaN,
+                tag: 'test-element'
+            },
+            hideElements: [],
+            hideScrollBars: true,
+            isLandscape: false,
+            isNativeContext: false,
+            platformName: 'desktop',
+            removeElements: [],
+        });
+        const result = await saveWebElement(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeElementScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(buildAfterScreenshotOptionsSpy.mock.calls[0][0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0][1]).toMatchSnapshot();
+    });
+});

package/dist/commands/saveWebScreen.d.ts

@@ -0,0 +1,7 @@
+import type { ScreenshotOutput } from '../helpers/afterScreenshot.interfaces.js';
+import type { InternalSaveScreenMethodOptions } from './save.interfaces.js';
+/**
+ * Saves an image of the viewport of the screen
+ */
+export default function saveWebScreen({ browserInstance, instanceData, folders, tag, saveScreenOptions, isNativeContext, }: InternalSaveScreenMethodOptions): Promise<ScreenshotOutput>;
+//# sourceMappingURL=saveWebScreen.d.ts.map

package/dist/commands/saveWebScreen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"saveWebScreen.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebScreen.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sBAAsB,CAAA;AAK3E;;GAEG;AACH,wBAA8B,aAAa,CACvC,EACI,eAAe,EACf,YAAY,EACZ,OAAO,EACP,GAAG,EACH,iBAAiB,EACjB,eAAuB,GAC1B,EAAE,+BAA+B,GACnC,OAAO,CAAC,gBAAgB,CAAC,CA4D3B"}

package/dist/commands/saveWebScreen.js

@@ -0,0 +1,48 @@
+import { takeWebScreenshot } from '../methods/takeWebScreenshots.js';
+import beforeScreenshot from '../helpers/beforeScreenshot.js';
+import afterScreenshot from '../helpers/afterScreenshot.js';
+import { canUseBidiScreenshot, getMethodOrWicOption } from '../helpers/utils.js';
+import { createBeforeScreenshotOptions, buildAfterScreenshotOptions } from '../helpers/options.js';
+/**
+ * Saves an image of the viewport of the screen
+ */
+export default async function saveWebScreen({ browserInstance, instanceData, folders, tag, saveScreenOptions, isNativeContext = false, }) {
+    // 1. Set some variables
+    const { addIOSBezelCorners, formatImageName, savePerInstance } = saveScreenOptions.wic;
+    const enableLegacyScreenshotMethod = getMethodOrWicOption(saveScreenOptions.method, saveScreenOptions.wic, 'enableLegacyScreenshotMethod');
+    // 2.  Prepare the screenshot
+    const beforeOptions = createBeforeScreenshotOptions(instanceData, saveScreenOptions.method, saveScreenOptions.wic);
+    const enrichedInstanceData = await beforeScreenshot(browserInstance, beforeOptions);
+    const { deviceName, dimensions: { window: { devicePixelRatio, innerHeight, innerWidth, isEmulated, isLandscape, }, }, initialDevicePixelRatio, isAndroid, isAndroidChromeDriverScreenshot, isAndroidNativeWebScreenshot, isIOS, isMobile, } = enrichedInstanceData;
+    // 3. Take the screenshot
+    const shouldUseBidi = canUseBidiScreenshot(browserInstance) && !isMobile && !enableLegacyScreenshotMethod;
+    const webScreenshotOptions = {
+        addIOSBezelCorners,
+        deviceName,
+        devicePixelRatio: devicePixelRatio || 1,
+        enableLegacyScreenshotMethod,
+        innerHeight,
+        innerWidth,
+        initialDevicePixelRatio,
+        isAndroid,
+        isAndroidChromeDriverScreenshot,
+        isAndroidNativeWebScreenshot,
+        isEmulated,
+        isIOS,
+        isLandscape,
+        isMobile,
+    };
+    const { base64Image } = await takeWebScreenshot(browserInstance, webScreenshotOptions, shouldUseBidi);
+    // 4. Return the data
+    const afterOptions = buildAfterScreenshotOptions({
+        base64Image,
+        folders,
+        tag,
+        isNativeContext,
+        instanceData,
+        enrichedInstanceData,
+        beforeOptions,
+        wicOptions: { formatImageName, savePerInstance }
+    });
+    return afterScreenshot(browserInstance, afterOptions);
+}

package/dist/commands/saveWebScreen.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=saveWebScreen.test.d.ts.map

package/dist/commands/saveWebScreen.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"saveWebScreen.test.d.ts","sourceRoot":"","sources":["../../src/commands/saveWebScreen.test.ts"],"names":[],"mappings":""}

package/dist/commands/saveWebScreen.test.js

@@ -0,0 +1,222 @@
+import { describe, it, expect, vi, afterEach } from 'vitest';
+import saveWebScreen from './saveWebScreen.js';
+import { takeWebScreenshot } from '../methods/takeWebScreenshots.js';
+import afterScreenshot from '../helpers/afterScreenshot.js';
+import { canUseBidiScreenshot } from '../helpers/utils.js';
+import { createBeforeScreenshotOptions } from '../helpers/options.js';
+import { BASE_CHECK_OPTIONS, BEFORE_SCREENSHOT_OPTIONS, createMethodOptions, createTestOptions, createBeforeScreenshotMock } from '../mocks/mocks.js';
+import { DEVICE_RECTANGLES } from '../helpers/constants.js';
+vi.mock('../methods/takeWebScreenshots.js', () => ({
+    takeWebScreenshot: vi.fn().mockResolvedValue({
+        base64Image: 'web-screenshot-data'
+    })
+}));
+vi.mock('../helpers/beforeScreenshot.js', () => ({
+    default: vi.fn().mockResolvedValue({
+        browserName: 'chrome',
+        browserVersion: '120.0.0',
+        deviceName: 'desktop',
+        dimensions: {
+            body: {
+                scrollHeight: 1000,
+                offsetHeight: 1000
+            },
+            html: {
+                clientWidth: 1200,
+                scrollWidth: 1200,
+                clientHeight: 900,
+                scrollHeight: 1000,
+                offsetHeight: 1000
+            },
+            window: {
+                devicePixelRatio: 2,
+                innerHeight: 900,
+                innerWidth: 1200,
+                isEmulated: false,
+                isLandscape: false,
+                outerHeight: 1000,
+                outerWidth: 1200,
+                screenHeight: 1080,
+                screenWidth: 1920,
+            },
+        },
+        isAndroid: false,
+        isAndroidChromeDriverScreenshot: false,
+        isAndroidNativeWebScreenshot: false,
+        isIOS: false,
+        isMobile: false,
+        isTestInBrowser: true,
+        isTestInMobileBrowser: false,
+        addressBarShadowPadding: 0,
+        toolBarShadowPadding: 0,
+        appName: '',
+        logName: 'chrome',
+        name: 'chrome',
+        platformName: 'desktop',
+        platformVersion: '120.0.0',
+        devicePixelRatio: 2,
+        deviceRectangles: {
+            bottomBar: { height: 0, width: 0, x: 0, y: 0 },
+            homeBar: { height: 0, width: 0, x: 0, y: 0 },
+            leftSidePadding: { height: 0, width: 0, x: 0, y: 0 },
+            rightSidePadding: { height: 0, width: 0, x: 0, y: 0 },
+            screenSize: { height: 0, width: 0 },
+            statusBar: { height: 0, width: 0, x: 0, y: 0 },
+            statusBarAndAddressBar: { height: 0, width: 0, x: 0, y: 0 },
+            viewport: { height: 0, width: 0, x: 0, y: 0 }
+        },
+        initialDevicePixelRatio: 2,
+        nativeWebScreenshot: false
+    })
+}));
+vi.mock('../helpers/afterScreenshot.js', () => ({
+    default: vi.fn().mockResolvedValue({
+        devicePixelRatio: 2,
+        fileName: 'test-screen.png'
+    })
+}));
+vi.mock('../helpers/utils.js', () => ({
+    canUseBidiScreenshot: vi.fn().mockReturnValue(false),
+    getMethodOrWicOption: vi.fn().mockImplementation((method, wic, option) => method[option] ?? wic[option])
+}));
+vi.mock('../helpers/options.js', async (importOriginal) => {
+    const actual = await importOriginal();
+    return {
+        ...actual,
+        createBeforeScreenshotOptions: vi.fn().mockReturnValue({
+            instanceData: { test: 'data' },
+            addressBarShadowPadding: 6,
+            toolBarShadowPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            enableLayoutTesting: false,
+            hideElements: [],
+            noScrollBars: true,
+            removeElements: [],
+            waitForFontsLoaded: false,
+        }),
+    };
+});
+describe('saveWebScreen', () => {
+    const takeWebScreenshotSpy = vi.mocked(takeWebScreenshot);
+    const afterScreenshotSpy = vi.mocked(afterScreenshot);
+    const canUseBidiScreenshotSpy = vi.mocked(canUseBidiScreenshot);
+    const createBeforeScreenshotOptionsSpy = vi.mocked(createBeforeScreenshotOptions);
+    const baseOptions = {
+        browserInstance: { isAndroid: false, isMobile: false },
+        folders: BASE_CHECK_OPTIONS.folders,
+        instanceData: {
+            ...BEFORE_SCREENSHOT_OPTIONS.instanceData,
+            deviceRectangles: {
+                ...DEVICE_RECTANGLES,
+                screenSize: {
+                    width: 1920,
+                    height: 1080
+                }
+            }
+        },
+        isNativeContext: false,
+        saveScreenOptions: {
+            wic: BASE_CHECK_OPTIONS.wic,
+            method: createMethodOptions({
+                disableBlinkingCursor: false,
+                disableCSSAnimation: false,
+                enableLayoutTesting: false,
+                enableLegacyScreenshotMethod: false,
+                hideScrollBars: true,
+                hideElements: [],
+                removeElements: [],
+                waitForFontsLoaded: true,
+            })
+        },
+        tag: 'test-screen'
+    };
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('should call takeWebScreenshot with correct options when BiDi is available', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const result = await saveWebScreen(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(createBeforeScreenshotOptionsSpy).toHaveBeenCalledWith(baseOptions.instanceData, baseOptions.saveScreenOptions.method, baseOptions.saveScreenOptions.wic);
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should call takeWebScreenshot with BiDi disabled when not available', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(false);
+        const result = await saveWebScreen(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should call takeWebScreenshot with BiDi disabled when mobile device', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const beforeScreenshotMock = createBeforeScreenshotMock({ isMobile: true });
+        vi.mocked((await import('../helpers/beforeScreenshot.js')).default).mockResolvedValueOnce(beforeScreenshotMock);
+        const result = await saveWebScreen(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should call takeWebScreenshot with BiDi disabled when legacy method enabled', async () => {
+        canUseBidiScreenshotSpy.mockReturnValueOnce(true);
+        const options = createTestOptions(baseOptions, {
+            saveScreenOptions: {
+                ...baseOptions.saveScreenOptions,
+                method: createMethodOptions({
+                    enableLegacyScreenshotMethod: true
+                })
+            }
+        });
+        const result = await saveWebScreen(options);
+        expect(result).toMatchSnapshot();
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should pass iOS configuration correctly', async () => {
+        const beforeScreenshotMock = createBeforeScreenshotMock({
+            isIOS: true,
+            deviceName: 'iPhone 14 Pro',
+            dimensions: {
+                window: {
+                    isLandscape: true
+                }
+            }
+        });
+        vi.mocked((await import('../helpers/beforeScreenshot.js')).default).mockResolvedValueOnce(beforeScreenshotMock);
+        const options = createTestOptions(baseOptions, {
+            saveScreenOptions: {
+                ...baseOptions.saveScreenOptions,
+                wic: {
+                    ...baseOptions.saveScreenOptions.wic,
+                    addIOSBezelCorners: true
+                }
+            }
+        });
+        const result = await saveWebScreen(options);
+        expect(result).toMatchSnapshot();
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should handle NaN dimension values correctly', async () => {
+        const nanDimensions = createBeforeScreenshotMock({
+            dimensions: {
+                window: {
+                    devicePixelRatio: NaN,
+                    innerHeight: NaN,
+                    innerWidth: NaN,
+                    isEmulated: false,
+                    isLandscape: false,
+                    outerHeight: NaN,
+                    outerWidth: NaN,
+                    screenHeight: NaN,
+                    screenWidth: NaN,
+                },
+            },
+            devicePixelRatio: NaN,
+            initialDevicePixelRatio: NaN
+        });
+        vi.mocked((await import('../helpers/beforeScreenshot.js')).default).mockResolvedValueOnce(nanDimensions);
+        const result = await saveWebScreen(baseOptions);
+        expect(result).toMatchSnapshot();
+        expect(takeWebScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+        expect(afterScreenshotSpy.mock.calls[0]).toMatchSnapshot();
+    });
+});

package/dist/commands/screen.interfaces.d.ts

@@ -0,0 +1,16 @@
+import type { BaseMobileWebScreenshotOptions, BaseWebScreenshotOptions, Folders } from '../base.interfaces.js';
+import type { DefaultOptions } from '../helpers/options.interfaces.js';
+import type { CheckMethodOptions } from './check.interfaces.js';
+export interface SaveScreenOptions {
+    wic: DefaultOptions;
+    method: SaveScreenMethodOptions;
+}
+export interface SaveScreenMethodOptions extends Partial<Folders>, BaseWebScreenshotOptions, BaseMobileWebScreenshotOptions {
+}
+export interface CheckScreenMethodOptions extends SaveScreenMethodOptions, CheckMethodOptions {
+}
+export interface CheckScreenOptions {
+    wic: DefaultOptions;
+    method: CheckScreenMethodOptions;
+}
+//# sourceMappingURL=screen.interfaces.d.ts.map

package/dist/commands/screen.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"screen.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/screen.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC9G,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AACtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE/D,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,uBAAuB,CAAC;CACnC;AAED,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,wBAAwB,EAAE,8BAA8B;CAC1H;AAED,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB,EAAE,kBAAkB;CAAI;AAEjG,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,wBAAwB,CAAC;CACpC"}

package/dist/commands/screen.interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/commands/tabbable.interfaces.d.ts

@@ -0,0 +1,29 @@
+import type { DefaultOptions } from '../helpers/options.interfaces.js';
+import type { CheckFullPageMethodOptions, SaveFullPageMethodOptions } from './fullPage.interfaces.js';
+export interface SaveTabbableOptions {
+    wic: DefaultOptions;
+    method: SaveFullPageMethodOptions;
+}
+export interface CheckTabbableOptions {
+    wic: DefaultOptions;
+    method: CheckFullPageMethodOptions;
+}
+export interface TabbableOptions {
+    circle?: CircleOptions;
+    line?: LineOptions;
+}
+export interface CircleOptions {
+    backgroundColor?: string;
+    borderColor?: string;
+    borderWidth?: number;
+    fontColor?: string;
+    fontFamily?: string;
+    fontSize?: number;
+    size?: number;
+    showNumber?: boolean;
+}
+export interface LineOptions {
+    color?: string;
+    width?: number;
+}
+//# sourceMappingURL=tabbable.interfaces.d.ts.map

package/dist/commands/tabbable.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabbable.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/tabbable.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAA;AAErG,MAAM,WAAW,mBAAmB;IAChC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,yBAAyB,CAAC;CACrC;AACD,MAAM,WAAW,oBAAoB;IACjC,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,0BAA0B,CAAC;CACtC;AAED,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACtB;AACD,MAAM,WAAW,aAAa;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AACD,MAAM,WAAW,WAAW;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/commands/tabbable.interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/helpers/afterScreenshot.d.ts

@@ -0,0 +1,7 @@
+import type { AfterScreenshotOptions, ScreenshotOutput } from './afterScreenshot.interfaces.js';
+/**
+ * Methods that need to be executed after a screenshot has been taken
+ * to set all back to the original state
+ */
+export default function afterScreenshot(browserInstance: WebdriverIO.Browser, options: AfterScreenshotOptions): Promise<ScreenshotOutput>;
+//# sourceMappingURL=afterScreenshot.d.ts.map

package/dist/helpers/afterScreenshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"afterScreenshot.d.ts","sourceRoot":"","sources":["../../src/helpers/afterScreenshot.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAM/F;;;GAGG;AACH,wBAA8B,eAAe,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA+D9I"}

package/dist/helpers/afterScreenshot.interfaces.d.ts

@@ -0,0 +1,46 @@
+export interface ScreenshotOutput {
+    devicePixelRatio: number;
+    fileName: string;
+    isLandscape: boolean;
+    path: string;
+}
+export interface AfterScreenshotOptions {
+    actualFolder: string;
+    base64Image: string;
+    disableBlinkingCursor?: boolean;
+    disableCSSAnimation?: boolean;
+    enableLayoutTesting?: boolean;
+    hideScrollBars?: boolean;
+    filePath: ScreenshotFilePathOptions;
+    fileName: ScreenshotFileNameOptions;
+    hideElements?: (HTMLElement | HTMLElement[])[];
+    isLandscape: boolean;
+    isNativeContext: boolean;
+    platformName: string;
+    removeElements?: (HTMLElement | HTMLElement[])[];
+}
+export interface ScreenshotFilePathOptions {
+    browserName: string;
+    deviceName: string;
+    isMobile: boolean;
+    savePerInstance: boolean;
+}
+export interface ScreenshotFileNameOptions {
+    browserName: string;
+    browserVersion: string;
+    deviceName: string;
+    devicePixelRatio: number;
+    formatImageName: string;
+    isMobile: boolean;
+    isTestInBrowser: boolean;
+    logName: string;
+    name: string;
+    outerHeight?: number;
+    outerWidth?: number;
+    platformName: string;
+    platformVersion: string;
+    screenHeight: number;
+    screenWidth: number;
+    tag: string;
+}
+//# sourceMappingURL=afterScreenshot.interfaces.d.ts.map

package/dist/helpers/afterScreenshot.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"afterScreenshot.interfaces.d.ts","sourceRoot":"","sources":["../../src/helpers/afterScreenshot.interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAE7B,gBAAgB,EAAE,MAAM,CAAC;IAEzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,WAAW,EAAE,OAAO,CAAC;IAErB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IAEnC,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IAEpB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,QAAQ,EAAE,yBAAyB,CAAC;IAEpC,QAAQ,EAAE,yBAAyB,CAAC;IAEpC,YAAY,CAAC,EAAE,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC,EAAE,CAAC;IAE/C,WAAW,EAAE,OAAO,CAAC;IAErB,eAAe,EAAE,OAAO,CAAC;IAEzB,YAAY,EAAE,MAAM,CAAC;IAErB,cAAc,CAAC,EAAE,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC,EAAE,CAAC;CACpD;AAED,MAAM,WAAW,yBAAyB;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,OAAO,CAAC;IAElB,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAC;IAExB,QAAQ,EAAE,OAAO,CAAC;IAElB,eAAe,EAAE,OAAO,CAAC;IAEzB,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY,EAAE,MAAM,CAAC;IAErB,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IAEpB,GAAG,EAAE,MAAM,CAAC;CACf"}

package/dist/helpers/afterScreenshot.interfaces.js

@@ -0,0 +1 @@
+export {};