@wdio/image-comparison-core 1.0.0

package/dist/clientSideScripts/scrollElementIntoView.test.js

@@ -0,0 +1,79 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import scrollElementIntoView from './scrollElementIntoView.js';
+describe('scrollElementIntoView', () => {
+    let mockElement;
+    let mockHtmlNode;
+    let mockBodyNode;
+    let mockStyleTag;
+    let mockHead;
+    beforeEach(() => {
+        mockElement = {
+            getBoundingClientRect: vi.fn().mockReturnValue({ top: 100 }),
+        };
+        mockHtmlNode = {
+            scrollTop: 0,
+            get scrollHeight() { return 1000; },
+            get clientHeight() { return 500; },
+        };
+        mockBodyNode = {
+            scrollTop: 0,
+            get scrollHeight() { return 1000; },
+            get clientHeight() { return 500; },
+        };
+        mockStyleTag = {
+            innerHTML: '',
+        };
+        mockHead = {
+            appendChild: vi.fn(),
+            removeChild: vi.fn(),
+        };
+        global.document = {
+            documentElement: mockHtmlNode,
+            body: mockBodyNode,
+            createElement: vi.fn().mockReturnValue(mockStyleTag),
+            head: mockHead,
+        };
+    });
+    it('should scroll element into view when html node is scrollable', () => {
+        const addressBarShadowPadding = 10;
+        const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
+        expect(result).toBe(0);
+        expect(mockHtmlNode.scrollTop).toBe(90);
+        expect(mockHead.appendChild).toHaveBeenCalledWith(mockStyleTag);
+        expect(mockHead.removeChild).toHaveBeenCalledWith(mockStyleTag);
+    });
+    it('should scroll element into view when body node is scrollable', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        const addressBarShadowPadding = 10;
+        const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
+        expect(result).toBe(0);
+        expect(mockBodyNode.scrollTop).toBe(90);
+        expect(mockHead.appendChild).toHaveBeenCalledWith(mockStyleTag);
+        expect(mockHead.removeChild).toHaveBeenCalledWith(mockStyleTag);
+    });
+    it('should return current scroll position when html node has scroll', () => {
+        mockHtmlNode.scrollTop = 50;
+        const addressBarShadowPadding = 10;
+        const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
+        expect(result).toBe(50);
+        expect(mockHtmlNode.scrollTop).toBe(90);
+    });
+    it('should return current scroll position when body node has scroll', () => {
+        mockHtmlNode.scrollTop = 0;
+        mockBodyNode.scrollTop = 50;
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        const addressBarShadowPadding = 10;
+        const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
+        expect(result).toBe(50);
+        expect(mockBodyNode.scrollTop).toBe(90);
+    });
+    it('should not scroll when neither html nor body is scrollable', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        Object.defineProperty(mockBodyNode, 'scrollHeight', { value: 500 });
+        const addressBarShadowPadding = 10;
+        const result = scrollElementIntoView(mockElement, addressBarShadowPadding);
+        expect(result).toBe(0);
+        expect(mockHtmlNode.scrollTop).toBe(0);
+        expect(mockBodyNode.scrollTop).toBe(0);
+    });
+});

package/dist/clientSideScripts/scrollToPosition.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Scroll to y = variable position in the screen
+ */
+export default function scrollToPosition(yPosition: number): void;
+//# sourceMappingURL=scrollToPosition.d.ts.map

package/dist/clientSideScripts/scrollToPosition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrollToPosition.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/scrollToPosition.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAuBhE"}

package/dist/clientSideScripts/scrollToPosition.js

@@ -0,0 +1,25 @@
+/**
+ * Scroll to y = variable position in the screen
+ */
+/* istanbul ignore next */
+export default function scrollToPosition(yPosition) {
+    const htmlNode = document.querySelector('html');
+    const bodyNode = document.querySelector('body');
+    if (htmlNode.scrollHeight > htmlNode.clientHeight) {
+        htmlNode.scrollTop = yPosition;
+        // Did we scroll to the right position?
+        if (htmlNode.scrollTop === yPosition) {
+            return;
+        }
+    }
+    // If not then try the body
+    if (bodyNode.scrollHeight > bodyNode.clientHeight) {
+        bodyNode.scrollTop = yPosition;
+        // Did we scroll to the right position?
+        if (bodyNode.scrollTop === yPosition) {
+            return;
+        }
+    }
+    // If not then try the document
+    (document.scrollingElement || document.documentElement).scrollTop = yPosition;
+}

package/dist/clientSideScripts/scrollToPosition.test.d.ts

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

package/dist/clientSideScripts/scrollToPosition.test.d.ts.map

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

package/dist/clientSideScripts/scrollToPosition.test.js

@@ -0,0 +1,72 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import scrollToPosition from './scrollToPosition.js';
+describe('scrollToPosition', () => {
+    let mockHtmlNode;
+    let mockBodyNode;
+    let mockScrollingElement;
+    beforeEach(() => {
+        mockHtmlNode = {
+            scrollTop: 0,
+            get scrollHeight() { return 1000; },
+            get clientHeight() { return 500; },
+        };
+        mockBodyNode = {
+            scrollTop: 0,
+            get scrollHeight() { return 1000; },
+            get clientHeight() { return 500; },
+        };
+        mockScrollingElement = {
+            scrollTop: 0,
+        };
+        global.document = {
+            querySelector: vi.fn((selector) => {
+                if (selector === 'html') {
+                    return mockHtmlNode;
+                }
+                if (selector === 'body') {
+                    return mockBodyNode;
+                }
+                return null;
+            }),
+            scrollingElement: mockScrollingElement,
+            documentElement: mockHtmlNode,
+        };
+    });
+    it('should scroll html node when it is scrollable', () => {
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockHtmlNode.scrollTop).toBe(yPosition);
+    });
+    it('should scroll body node when html is not scrollable', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockBodyNode.scrollTop).toBe(yPosition);
+    });
+    it('should scroll document.scrollingElement when neither html nor body is scrollable', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        Object.defineProperty(mockBodyNode, 'scrollHeight', { value: 500 });
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockScrollingElement.scrollTop).toBe(yPosition);
+    });
+    it('should fallback to documentElement when scrollingElement is not available', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        Object.defineProperty(mockBodyNode, 'scrollHeight', { value: 500 });
+        Object.defineProperty(global.document, 'scrollingElement', { value: null });
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockHtmlNode.scrollTop).toBe(yPosition);
+    });
+    it('should verify scroll position after scrolling html node', () => {
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockHtmlNode.scrollTop).toBe(yPosition);
+    });
+    it('should verify scroll position after scrolling body node', () => {
+        Object.defineProperty(mockHtmlNode, 'scrollHeight', { value: 500 });
+        const yPosition = 100;
+        scrollToPosition(yPosition);
+        expect(mockBodyNode.scrollTop).toBe(yPosition);
+    });
+});

package/dist/clientSideScripts/setCustomCss.d.ts

@@ -0,0 +1,6 @@
+import type { CssOptions } from './customCss.interfaces.js';
+/**
+ * Set some default css
+ */
+export default function setCustomCss(cssOptions: CssOptions): void;
+//# sourceMappingURL=setCustomCss.d.ts.map

package/dist/clientSideScripts/setCustomCss.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setCustomCss.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/setCustomCss.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAE3D;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAiCjE"}

package/dist/clientSideScripts/setCustomCss.js

@@ -0,0 +1,36 @@
+/**
+ * Set some default css
+ */
+export default function setCustomCss(cssOptions) {
+    if (!document.head) {
+        return;
+    }
+    // disabling CSS animations for everything including pseudo elements
+    const disableTransformationsTransitionsAnimations = `
+*, *::before, *::after {
+    -o-transition-property: none !important;
+    -moz-transition-property: none !important;
+    -ms-transition-property: none !important;
+    -webkit-transition-property: none !important;
+    transition-property: none !important;
+    -webkit-animation: none !important;
+    -moz-animation: none !important;
+    -o-animation: none !important;
+    -ms-animation: none !important;
+    animation: none !important;
+    caret-color: transparent !important;
+}`;
+    const { addressBarPadding, disableBlinkingCursor, disableCSSAnimation, id, toolBarPadding } = cssOptions;
+    const bodyTopPadding = addressBarPadding === 0 ? '' : `body{padding-top:${addressBarPadding}px !important}`;
+    const bodyBottomPadding = toolBarPadding === 0 ? '' : `body{padding-bottom:${toolBarPadding}px !important}`;
+    const disableBlinkingCursorCss = disableBlinkingCursor ? ' input, textarea, [contenteditable]{caret-color: transparent !important;}' : '';
+    const css = (disableCSSAnimation ? disableTransformationsTransitionsAnimations : '') +
+        bodyTopPadding +
+        bodyBottomPadding +
+        disableBlinkingCursorCss;
+    const head = document.head;
+    const style = document.createElement('style');
+    style.id = id;
+    style.appendChild(document.createTextNode(css));
+    head.appendChild(style);
+}

package/dist/clientSideScripts/setCustomCss.test.d.ts

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

package/dist/clientSideScripts/setCustomCss.test.d.ts.map

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

package/dist/clientSideScripts/setCustomCss.test.js

@@ -0,0 +1,68 @@
+// @vitest-environment jsdom
+import { beforeEach, describe, it, expect } from 'vitest';
+import setCustomCss from './setCustomCss.js';
+describe('setCustomCss', () => {
+    beforeEach(() => {
+        document.head.innerHTML = '';
+    });
+    it('should be able to set the custom css with the default options', () => {
+        const cssOptions = {
+            addressBarPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            id: 'id',
+            toolBarPadding: 6,
+        };
+        expect(document.head.textContent).toMatchSnapshot();
+        setCustomCss(cssOptions);
+        expect(document.head.textContent).toMatchSnapshot();
+    });
+    it('should be able to set the custom css with the animations disabled', () => {
+        const cssOptions = {
+            addressBarPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: true,
+            id: 'id',
+            toolBarPadding: 6,
+        };
+        expect(document.head.textContent).toMatchSnapshot();
+        setCustomCss(cssOptions);
+        expect(document.head.textContent).toMatchSnapshot();
+    });
+    it('should be able to set the custom css with the with padding set to 0', () => {
+        const cssOptions = {
+            addressBarPadding: 0,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: true,
+            id: 'id',
+            toolBarPadding: 0,
+        };
+        expect(document.head.textContent).toMatchSnapshot();
+        setCustomCss(cssOptions);
+        expect(document.head.textContent).toMatchSnapshot();
+    });
+    it('should be able to set the custom css with the with disableBlinkingCursor set to true', () => {
+        const cssOptions = {
+            addressBarPadding: 0,
+            disableBlinkingCursor: true,
+            disableCSSAnimation: false,
+            id: 'id',
+            toolBarPadding: 0,
+        };
+        expect(document.head.textContent).toMatchSnapshot();
+        setCustomCss(cssOptions);
+        expect(document.head.textContent).toMatchSnapshot();
+    });
+    it('should do nothing if document.head is null', () => {
+        const cssOptions = {
+            addressBarPadding: 6,
+            disableBlinkingCursor: false,
+            disableCSSAnimation: false,
+            id: 'id',
+            toolBarPadding: 6,
+        };
+        Object.defineProperty(document, 'head', { value: null });
+        setCustomCss(cssOptions);
+        expect(document.head).toBe(null);
+    });
+});

package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.d.ts

@@ -0,0 +1,11 @@
+import type { RectanglesOutput } from '../methods/rectangles.interfaces.js';
+export interface StatusAddressToolBarOffsets {
+    leftSidePadding: RectanglesOutput;
+    rightSidePadding: RectanglesOutput;
+    safeArea: number;
+    screenHeight: number;
+    screenWidth: number;
+    statusAddressBar: RectanglesOutput;
+    toolBar: RectanglesOutput;
+}
+//# sourceMappingURL=statusAddressToolBarOffsets.interfaces.d.ts.map

package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statusAddressToolBarOffsets.interfaces.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/statusAddressToolBarOffsets.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAE3E,MAAM,WAAW,2BAA2B;IACxC,eAAe,EAAE,gBAAgB,CAAC;IAClC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC;CAC7B"}

package/dist/clientSideScripts/statusAddressToolBarOffsets.interfaces.js

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

package/dist/clientSideScripts/toggleTextTransparency.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Add or remove the transparency from the text
+ */
+export default function toggleTextTransparency(enableTransparency: boolean): void;
+//# sourceMappingURL=toggleTextTransparency.d.ts.map

package/dist/clientSideScripts/toggleTextTransparency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toggleTextTransparency.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/toggleTextTransparency.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,kBAAkB,EAAE,OAAO,GAAG,IAAI,CAahF"}

package/dist/clientSideScripts/toggleTextTransparency.js

@@ -0,0 +1,16 @@
+/**
+ * Add or remove the transparency from the text
+ */
+export default function toggleTextTransparency(enableTransparency) {
+    if (enableTransparency) {
+        const elements = document.querySelectorAll('body *:not(script):not(style)');
+        elements.forEach(el => {
+            el.style.setProperty('color', 'transparent', 'important');
+        });
+        return;
+    }
+    const elements = document.querySelectorAll('body [color]:not(script):not(style)');
+    elements.forEach(el => {
+        el.style.removeProperty('color');
+    });
+}

package/dist/clientSideScripts/toggleTextTransparency.test.d.ts

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

package/dist/clientSideScripts/toggleTextTransparency.test.d.ts.map

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

package/dist/clientSideScripts/toggleTextTransparency.test.js

@@ -0,0 +1,35 @@
+// @vitest-environment jsdom
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import toggleTextTransparency from './toggleTextTransparency.js';
+describe('toggleTextTransparency', () => {
+    beforeEach(() => {
+        document.body.innerHTML = `
+            <div id="testDiv">
+                <p>Paragraph</p>
+                <span>Span</span>
+                <script>console.log('script')</script>
+                <style>body { background-color: blue; }</style>
+            </div>
+        `;
+        const styleElement = document.createElement('style');
+        styleElement.innerHTML = '/* head style */';
+        document.head.appendChild(styleElement);
+    });
+    afterEach(() => {
+        document.body.innerHTML = '';
+        document.head.innerHTML = '';
+    });
+    it('should make text transparent when enabled', () => {
+        toggleTextTransparency(true);
+        const testDiv = document.getElementById('testDiv');
+        expect(testDiv).toMatchSnapshot();
+    });
+    it('should remove transparent style when disabled', () => {
+        toggleTextTransparency(true);
+        const transparentDiv = document.getElementById('testDiv');
+        expect(transparentDiv).toMatchSnapshot();
+        toggleTextTransparency(false);
+        const testDiv = document.getElementById('testDiv');
+        expect(testDiv).toMatchSnapshot();
+    });
+});

package/dist/clientSideScripts/waitForFonts.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wait for the fonts to be loaded, do this for a max of 11 seconds
+ *
+ * NOTE: writing this with promises instead of async/await because it fails with
+ * `javascript error: __awaiter is not defined` when running in the browser
+ */
+export default function waitForFonts(): Promise<void | string>;
+//# sourceMappingURL=waitForFonts.d.ts.map

package/dist/clientSideScripts/waitForFonts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitForFonts.d.ts","sourceRoot":"","sources":["../../src/clientSideScripts/waitForFonts.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,IAAI,OAAO,CAAC,IAAI,GAAC,MAAM,CAAC,CAc3D"}

package/dist/clientSideScripts/waitForFonts.js

@@ -0,0 +1,20 @@
+/**
+ * Wait for the fonts to be loaded, do this for a max of 11 seconds
+ *
+ * NOTE: writing this with promises instead of async/await because it fails with
+ * `javascript error: __awaiter is not defined` when running in the browser
+ */
+export default function waitForFonts() {
+    return new Promise((resolve, reject) => {
+        const timeoutPromise = new Promise((_, reject) => {
+            setTimeout(() => {
+                reject(new Error('Font loading timed out'));
+            }, 11000);
+        });
+        Promise.race([document.fonts.ready, timeoutPromise])
+            .then(() => {
+            resolve('All fonts have loaded');
+        })
+            .catch(reject);
+    });
+}

package/dist/clientSideScripts/waitForFonts.test.d.ts

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

package/dist/clientSideScripts/waitForFonts.test.d.ts.map

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

package/dist/clientSideScripts/waitForFonts.test.js

@@ -0,0 +1,37 @@
+// @vitest-environment jsdom
+import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
+import waitForFonts from './waitForFonts.js';
+describe('waitForFontsLoaded', () => {
+    let originalDocument;
+    beforeEach(() => {
+        originalDocument = { ...document };
+    });
+    afterEach(() => {
+        document = originalDocument;
+        vi.restoreAllMocks();
+    });
+    it('should resolve if fonts load within 11 seconds', async () => {
+        const mockReady = new Promise((resolve) => {
+            setTimeout(resolve, 1000);
+        });
+        global.document = {
+            ...originalDocument,
+            fonts: { ready: mockReady },
+        };
+        await expect(waitForFonts()).resolves.toBe('All fonts have loaded');
+    });
+    it('should reject if fonts do not load within 11 seconds', async () => {
+        const mockReady = new Promise((_, reject) => {
+            setTimeout(reject, 12000);
+        });
+        global.document = {
+            ...originalDocument,
+            fonts: { ready: mockReady },
+        };
+        vi.useFakeTimers();
+        const promise = waitForFonts();
+        vi.advanceTimersByTime(11000);
+        await expect(promise).rejects.toThrow('Font loading timed out');
+        vi.useRealTimers();
+    });
+});

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

@@ -0,0 +1,35 @@
+import type { InternalSaveMethodOptions } from './save.interfaces.js';
+import type { RectanglesOutput } from '../methods/rectangles.interfaces.js';
+import type { CheckElementOptions, ElementIgnore, WicElement } from './element.interfaces.js';
+import type { CheckFullPageOptions } from './fullPage.interfaces.js';
+import type { CheckScreenOptions } from './screen.interfaces.js';
+import type { CheckTabbableOptions } from './tabbable.interfaces.js';
+import type { BaseImageCompareOptions, BaseMobileBlockOutOptions } from '../base.interfaces.js';
+import type { TestContext } from '../methods/compareReport.interfaces.js';
+export interface CheckMethodOptions extends BaseImageCompareOptions, BaseMobileBlockOutOptions {
+    /**
+     * Block out array with x, y, width and height values
+     */
+    blockOut?: RectanglesOutput[];
+    /**
+     * Ignore elements and or areas
+     */
+    ignore?: ElementIgnore[];
+}
+export interface InternalCheckMethodOptions extends InternalSaveMethodOptions {
+    testContext: TestContext;
+}
+export interface InternalCheckScreenMethodOptions extends InternalCheckMethodOptions {
+    checkScreenOptions: CheckScreenOptions;
+}
+export interface InternalCheckElementMethodOptions extends InternalCheckMethodOptions {
+    element: WicElement | HTMLElement;
+    checkElementOptions: CheckElementOptions;
+}
+export interface InternalCheckFullPageMethodOptions extends InternalCheckMethodOptions {
+    checkFullPageOptions: CheckFullPageOptions;
+}
+export interface InternalCheckTabbablePageMethodOptions extends InternalCheckMethodOptions {
+    checkTabbableOptions: CheckTabbableOptions;
+}
+//# sourceMappingURL=check.interfaces.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check.interfaces.d.ts","sourceRoot":"","sources":["../../src/commands/check.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAC7F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAEzE,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB,EAAE,yBAAyB;IAC1F;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,0BAA0B;IAChF,kBAAkB,EAAE,kBAAkB,CAAC;CAC1C;AAED,MAAM,WAAW,iCAAkC,SAAQ,0BAA0B;IACjF,OAAO,EAAE,UAAU,GAAG,WAAW,CAAC;IAClC,mBAAmB,EAAE,mBAAmB,CAAC;CAC5C;AAED,MAAM,WAAW,kCAAmC,SAAQ,0BAA0B;IAClF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C;AAED,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACtF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C"}

package/dist/commands/check.interfaces.js

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

package/dist/commands/checkAppElement.d.ts

@@ -0,0 +1,7 @@
+import type { ImageCompareResult } from '../methods/images.interfaces.js';
+import type { InternalCheckElementMethodOptions } from './check.interfaces.js';
+/**
+ * Compare  an image of the element
+ */
+export default function checkAppElement({ checkElementOptions, browserInstance, element, folders, instanceData, isNativeContext, tag, testContext, }: InternalCheckElementMethodOptions): Promise<ImageCompareResult | number>;
+//# sourceMappingURL=checkAppElement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"checkAppElement.d.ts","sourceRoot":"","sources":["../../src/commands/checkAppElement.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAGzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAA;AAI9E;;GAEG;AACH,wBAA8B,eAAe,CACzC,EACI,mBAAmB,EACnB,eAAe,EACf,OAAO,EACP,OAAO,EACP,YAAY,EACZ,eAAsB,EACtB,GAAG,EACH,WAAW,GACd,EAAE,iCAAiC,GACrC,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAuCtC"}

package/dist/commands/checkAppElement.js

@@ -0,0 +1,44 @@
+import { methodCompareOptions } from '../helpers/options.js';
+import { executeImageCompare } from '../methods/images.js';
+import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../helpers/utils.js';
+import saveAppElement from './saveAppElement.js';
+/**
+ * Compare  an image of the element
+ */
+export default async function checkAppElement({ checkElementOptions, browserInstance, element, folders, instanceData, isNativeContext = true, tag, testContext, }) {
+    // 1. Extract common variables
+    const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic });
+    // 2. Save the element and return the data
+    const { devicePixelRatio, fileName } = await saveAppElement({
+        browserInstance,
+        element: element,
+        folders,
+        instanceData,
+        isNativeContext,
+        saveElementOptions: checkElementOptions,
+        tag,
+    });
+    // @TODO: This is something for the future, to allow ignore regions on the element itself.
+    // This will become a feature request
+    // 3. Determine the options
+    const compareOptions = methodCompareOptions(checkElementOptions.method);
+    const executeCompareOptions = buildBaseExecuteCompareOptions({
+        commonCheckVariables,
+        wicCompareOptions: checkElementOptions.wic.compareOptions,
+        methodCompareOptions: compareOptions,
+        devicePixelRatio,
+        fileName,
+        isElementScreenshot: true, // This will automatically set blockOut* options to false
+        additionalProperties: {
+            isHybridApp: checkElementOptions.wic.isHybridApp,
+            platformName: instanceData.platformName,
+        }
+    });
+    // 4. Now execute the compare and return the data
+    return executeImageCompare({
+        options: executeCompareOptions,
+        testContext,
+        isViewPortScreenshot: false,
+        isNativeContext,
+    });
+}

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

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

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

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