lighthouse-reporting 1.2.0 → 1.3.0

package/dist/lighthouse-reporting.umd.cjs

@@ -202,12 +202,15 @@
       const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
       return stories;
     },
-    captureScreenshot: async (story, context, screenshotOptions) => {
+    captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {
       const page = context.pages()[0];
       await page.goto(`/iframe.html?id=${story.id}`);
       await test.expect(page.locator(".sb-show-main")).toBeVisible();
       await test.expect(page.locator(".sb-show-errordisplay")).not.toBeVisible();
       await page.waitForLoadState("networkidle");
+      if (actionBeforeScreenshot) {
+        await actionBeforeScreenshot(page);
+      }
       await test.expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
     }
   };

package/dist/storybookPlaywright.cjs

@@ -12,12 +12,15 @@ const storybookPlaywright = {
     const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
     return stories;
   },
-  captureScreenshot: async (story, context, screenshotOptions) => {
+  captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {
     const page = context.pages()[0];
     await page.goto(`/iframe.html?id=${story.id}`);
     await test.expect(page.locator(".sb-show-main")).toBeVisible();
     await test.expect(page.locator(".sb-show-errordisplay")).not.toBeVisible();
     await page.waitForLoadState("networkidle");
+    if (actionBeforeScreenshot) {
+      await actionBeforeScreenshot(page);
+    }
     await test.expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
   }
 };

package/dist/storybookPlaywright.d.ts

@@ -1,4 +1,4 @@
-import { BrowserContext } from '@playwright/test';
+import { BrowserContext, Locator, Page } from '@playwright/test';
 export interface StorybookIndexStory {
     id: string;
     title: string;
@@ -46,6 +46,49 @@ export declare const storybookPlaywright: {
              */
             height: number;
         };
-    }) => Promise<void>;
+        /**
+         * When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to
+         * `false`.
+         */
+        fullPage?: boolean;
+        /**
+         * Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
+         * box `#FF00FF` that completely covers its bounding box.
+         */
+        mask?: Array<Locator>;
+        /**
+         * An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`. Default is
+         * configurable with `TestConfig.expect`. Unset by default.
+         */
+        maxDiffPixelRatio?: number;
+        /**
+         * An acceptable amount of pixels that could be different. Default is configurable with `TestConfig.expect`. Unset by
+         * default.
+         */
+        maxDiffPixels?: number;
+        /**
+         * Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images.
+         * Defaults to `false`.
+         */
+        omitBackground?: boolean;
+        /**
+         * When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
+         * will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so
+         * screenshots of high-dpi devices will be twice as large or even larger.
+         *
+         * Defaults to `"css"`.
+         */
+        scale?: 'css' | 'device';
+        /**
+         * An acceptable perceived color difference in the [YIQ color space](https://en.wikipedia.org/wiki/YIQ) between the
+         * same pixel in compared images, between zero (strict) and one (lax), default is configurable with
+         * `TestConfig.expect`. Defaults to `0.2`.
+         */
+        threshold?: number;
+        /**
+         * Time to retry the assertion for. Defaults to `timeout` in `TestConfig.expect`.
+         */
+        timeout?: number;
+    }, actionBeforeScreenshot?: ((page: Page) => Promise<void>) | undefined) => Promise<void>;
 };
 export {};

package/dist/storybookPlaywright.js

@@ -10,12 +10,15 @@ const storybookPlaywright = {
     const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
     return stories;
   },
-  captureScreenshot: async (story, context, screenshotOptions) => {
+  captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {
     const page = context.pages()[0];
     await page.goto(`/iframe.html?id=${story.id}`);
     await expect(page.locator(".sb-show-main")).toBeVisible();
     await expect(page.locator(".sb-show-errordisplay")).not.toBeVisible();
     await page.waitForLoadState("networkidle");
+    if (actionBeforeScreenshot) {
+      await actionBeforeScreenshot(page);
+    }
     await expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse-reporting",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "scripts": {
     "build": "vite build && vite build -c vite.umd.config.ts && tsc -p ./tsconfig.build.json",
@@ -29,7 +29,7 @@
   "devDependencies": {
     "@playwright/test": "^1.34.3",
     "@types/fs-extra": "^11.0.1",
-    "@types/node": "^20.2.3",
+    "@types/node": "^20.2.4",
     "@typescript-eslint/eslint-plugin": "^5.59.7",
     "@typescript-eslint/parser": "^5.59.7",
     "eslint": "^8.41.0",