@cloudscape-design/browser-test-tools 3.0.123 → 3.0.125

package/browser-scripts/index.d.ts

@@ -1,3 +1,4 @@
 export * from './scroll';
 export * from './sizes';
 export * from './events-spy';
+export * from './permutations';

package/browser-scripts/index.js

@@ -19,3 +19,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./scroll"), exports);
 __exportStar(require("./sizes"), exports);
 __exportStar(require("./events-spy"), exports);
+__exportStar(require("./permutations"), exports);

package/browser-scripts/permutations.d.ts

@@ -0,0 +1,11 @@
+import { ElementOffset, ElementSize } from '../page-objects/types';
+export interface PermutationInfo extends ElementSize {
+    id: string;
+    offset: ElementOffset;
+}
+export interface PageDimensions {
+    pageHeight: number;
+    viewportHeight: number;
+}
+export declare function getPermutationSizes(): PermutationInfo[];
+export declare function getPageDimensions(): PageDimensions;

package/browser-scripts/permutations.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPermutationSizes = getPermutationSizes;
+exports.getPageDimensions = getPageDimensions;
+function getPermutationSizes() {
+    var pixelRatio = window.devicePixelRatio || 1;
+    return Array.prototype.slice
+        .call(document.querySelectorAll('[data-permutation]'))
+        .map(function (element) {
+        var rect = element.getBoundingClientRect();
+        return {
+            id: element.getAttribute('data-permutation') || '',
+            width: rect.width * pixelRatio,
+            height: rect.height * pixelRatio,
+            offset: {
+                top: rect.top * pixelRatio,
+                left: rect.left * pixelRatio,
+            },
+        };
+    });
+}
+function getPageDimensions() {
+    return {
+        pageHeight: document.documentElement.scrollHeight,
+        viewportHeight: window.innerHeight,
+    };
+}

package/internal/manifest.json

@@ -1,3 +1,3 @@
 {
-  "commit": "44d205298af82a90cb4737b681528c0d06c88533"
+  "commit": "1c6161c5514fc29761f33a857b1b5a2e74cf3d82"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudscape-design/browser-test-tools",
-  "version": "3.0.123",
+  "version": "3.0.125",
   "repository": {
     "type": "git",
     "url": "https://github.com/cloudscape-design/browser-test-tools.git"

package/page-objects/index.d.ts

@@ -1,4 +1,4 @@
 export { default as BasePageObject } from './base';
-export { default as ScreenshotPageObject } from './screenshot';
+export { default as ScreenshotPageObject, PermutationScreenshot } from './screenshot';
 export { default as EventsSpy } from './events-spy';
 export { ScreenshotWithOffset, ElementSize, ElementRect, ElementOffset } from './types';

package/page-objects/screenshot.d.ts

@@ -1,5 +1,8 @@
 import BasePageObject from './base';
 import { ScreenshotCapturingOptions, ScreenshotWithOffset } from './types';
+export interface PermutationScreenshot extends ScreenshotWithOffset {
+    id: string;
+}
 export default class ScreenshotPageObject extends BasePageObject {
     readonly forceScrollAndMerge: boolean;
     constructor(browser: WebdriverIO.Browser, forceScrollAndMerge?: boolean);
@@ -9,4 +12,7 @@ export default class ScreenshotPageObject extends BasePageObject {
     fullPageScreenshot(): Promise<string>;
     captureBySelector(selector: string, options?: ScreenshotCapturingOptions): Promise<ScreenshotWithOffset>;
     captureViewport(): Promise<ScreenshotWithOffset>;
+    capturePermutations(): Promise<PermutationScreenshot[]>;
+    private fitWindowHeightToContent;
+    private safeSetWindowSize;
 }

package/page-objects/screenshot.js

@@ -59,5 +59,40 @@ class ScreenshotPageObject extends base_1.default {
         const image = await (0, image_utils_1.parsePng)(screenshot);
         return { image, offset, height, width };
     }
+    async capturePermutations() {
+        await this.windowScrollTo({ top: 0, left: 0 });
+        // Adapt viewport height to fit all elements before taking a screenshot
+        const originalWindowSize = await this.fitWindowHeightToContent();
+        const permutations = await this.browser.execute(browser_scripts_1.getPermutationSizes);
+        // Restore window size after taking the screenshot
+        await this.safeSetWindowSize(originalWindowSize.width, originalWindowSize.height);
+        if (permutations.length === 0) {
+            throw new Error('No permutations found on current page.');
+        }
+        const screenshot = await this.fullPageScreenshot();
+        const image = await (0, image_utils_1.parsePng)(screenshot);
+        return permutations.map((permutation) => ({ ...permutation, image }));
+    }
+    async fitWindowHeightToContent() {
+        const originalWindowSize = await this.browser.getWindowSize();
+        const { viewportHeight, pageHeight } = await this.browser.execute(browser_scripts_1.getPageDimensions);
+        const windowUIHeight = originalWindowSize.height - viewportHeight;
+        await this.safeSetWindowSize(originalWindowSize.width, pageHeight + windowUIHeight);
+        return originalWindowSize;
+    }
+    /* istanbul ignore next -- setWindowSize is unsupported on some mobile browsers, not testable in CI */
+    async safeSetWindowSize(width, height) {
+        try {
+            await this.browser.setWindowSize(width, height);
+        }
+        catch (error) {
+            if (error instanceof Error && error.message.includes('Method has not yet been implemented')) {
+                console.log('setWindowSize is not supported on this device');
+            }
+            else {
+                throw error;
+            }
+        }
+    }
 }
 exports.default = ScreenshotPageObject;