lighthouse-reporting 1.1.0 → 1.3.0

package/dist/lighthouse-reporting.umd.cjs

@@ -202,13 +202,16 @@
       const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
       return stories;
     },
-    captureScreenshot: async (story, context) => {
+    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");
-      await test.expect(page).toHaveScreenshot(`${story.id}.png`);
+      if (actionBeforeScreenshot) {
+        await actionBeforeScreenshot(page);
+      }
+      await test.expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
     }
   };
   exports2.getScores = getScores;

package/dist/playwrightLighthouseTest.d.ts

@@ -1,4 +1,4 @@
-import type { BrowserContext } from '@playwright/test';
+import { BrowserContext } from '@playwright/test';
 export declare const playwrightLighthouseTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
     context: BrowserContext;
 }, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & {

package/dist/storybookPlaywright.cjs

@@ -12,13 +12,16 @@ const storybookPlaywright = {
     const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
     return stories;
   },
-  captureScreenshot: async (story, context) => {
+  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");
-    await test.expect(page).toHaveScreenshot(`${story.id}.png`);
+    if (actionBeforeScreenshot) {
+      await actionBeforeScreenshot(page);
+    }
+    await test.expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
   }
 };
 exports.storybookPlaywright = storybookPlaywright;

package/dist/storybookPlaywright.d.ts

@@ -1,4 +1,4 @@
-import type { BrowserContext } from '@playwright/test';
+import { BrowserContext, Locator, Page } from '@playwright/test';
 export interface StorybookIndexStory {
     id: string;
     title: string;
@@ -10,6 +10,85 @@ export interface StorybookIndexStory {
 type StoriesFilterFn = (story: StorybookIndexStory) => boolean;
 export declare const storybookPlaywright: {
     getStories: (pathToStorybookIndexJson: string, storyFilterFn: StoriesFilterFn) => StorybookIndexStory[];
-    captureScreenshot: (story: StorybookIndexStory, context: BrowserContext) => Promise<void>;
+    captureScreenshot: (story: StorybookIndexStory, context: BrowserContext, screenshotOptions?: {
+        /**
+         * When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
+         * treatment depending on their duration:
+         * - finite animations are fast-forwarded to completion, so they'll fire `transitionend` event.
+         * - infinite animations are canceled to initial state, and then played over after the screenshot.
+         *
+         * Defaults to `"disabled"` that disables animations.
+         */
+        animations?: 'disabled' | 'allow';
+        /**
+         * When set to `"hide"`, screenshot will hide text caret. When set to `"initial"`, text caret behavior will not be
+         * changed.  Defaults to `"hide"`.
+         */
+        caret?: 'hide' | 'initial';
+        /**
+         * An object which specifies clipping of the resulting image.
+         */
+        clip?: {
+            /**
+             * x-coordinate of top-left corner of clip area
+             */
+            x: number;
+            /**
+             * y-coordinate of top-left corner of clip area
+             */
+            y: number;
+            /**
+             * width of clipping area
+             */
+            width: number;
+            /**
+             * height of clipping area
+             */
+            height: number;
+        };
+        /**
+         * 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,13 +10,16 @@ const storybookPlaywright = {
     const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
     return stories;
   },
-  captureScreenshot: async (story, context) => {
+  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");
-    await expect(page).toHaveScreenshot(`${story.id}.png`);
+    if (actionBeforeScreenshot) {
+      await actionBeforeScreenshot(page);
+    }
+    await expect(page).toHaveScreenshot(`${story.id}.png`, screenshotOptions);
   }
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse-reporting",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "type": "module",
   "scripts": {
     "build": "vite build && vite build -c vite.umd.config.ts && tsc -p ./tsconfig.build.json",
@@ -27,14 +27,15 @@
     "get-port": "^6"
   },
   "devDependencies": {
-    "@playwright/test": "^1.34.2",
+    "@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",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "get-port": "^6.1.2",
     "husky": "^8.0.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.8",