@argos-ci/puppeteer 2.1.4 → 2.2.1

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 import { ElementHandle, Page, ScreenshotOptions } from "puppeteer";
 import { ViewportOption } from "@argos-ci/browser";
+/**
+ * Accepts all Puppeteer screenshot options and adds Argos-specific options.
+ */
 type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omitBackground" | "path"> & {
     /**
      * ElementHandle or string selector of the element to take a screenshot of.
@@ -18,14 +21,31 @@ type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omi
      * @default true
      */
     disableHover?: boolean;
+    /**
+     * Sensitivity threshold between 0 and 1.
+     * The higher the threshold, the less sensitive the diff will be.
+     * @default 0.5
+     */
+    threshold?: number;
 };
 /**
- * @param page Puppeteer `page` object.
- * @param name The name of the screenshot or the full path to the screenshot.
- * @param options In addition to Puppeteer's `ScreenshotOptions`, you can pass:
- * @param options.element ElementHandle or string selector of the element to take a screenshot of.
- * @param options.viewports Viewports to take screenshots of.
- * @param options.argosCSS Custom CSS evaluated during the screenshot process.
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/puppeteer#api-overview
+ */
+declare function argosScreenshot(
+/**
+ * Puppeteer `page` object.
+ */
+page: Page, 
+/**
+ * Name of the screenshot. Must be unique.
+ */
+name: string, 
+/**
+ * Options for the screenshot.
  */
-declare function argosScreenshot(page: Page, name: string, options?: ArgosScreenshotOptions): Promise<void>;
+options?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -2,7 +2,7 @@ import { resolve } from 'node:path';
 import { mkdir } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
-import { getScreenshotName, writeMetadata, readVersionFromPackage } from '@argos-ci/util';
+import { getScreenshotName, writeMetadata, validateThreshold, readVersionFromPackage } from '@argos-ci/util';
 
 const require = createRequire(import.meta.url);
 /**
@@ -75,13 +75,18 @@ function checkIsFullPage(options) {
     };
 }
 /**
- * @param page Puppeteer `page` object.
- * @param name The name of the screenshot or the full path to the screenshot.
- * @param options In addition to Puppeteer's `ScreenshotOptions`, you can pass:
- * @param options.element ElementHandle or string selector of the element to take a screenshot of.
- * @param options.viewports Viewports to take screenshots of.
- * @param options.argosCSS Custom CSS evaluated during the screenshot process.
- */ async function argosScreenshot(page, name, options = {}) {
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/puppeteer#api-overview
+ */ async function argosScreenshot(/**
+   * Puppeteer `page` object.
+   */ page, /**
+   * Name of the screenshot. Must be unique.
+   */ name, /**
+   * Options for the screenshot.
+   */ options = {}) {
     const { element, viewports, argosCSS, ...puppeteerOptions } = options;
     if (!page) {
         throw new Error("A Puppeteer `page` object is required.");
@@ -127,6 +132,11 @@ function checkIsFullPage(options) {
                 version: argosPuppeteerVersion
             }
         };
+        metadata.transient = {};
+        if (options?.threshold !== undefined) {
+            validateThreshold(options.threshold);
+            metadata.transient.threshold = options.threshold;
+        }
         return metadata;
     }
     async function stabilizeAndScreenshot(name) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/puppeteer",
   "description": "Visual testing solution to avoid visual regression. Puppeteer commands and utilities for Argos visual testing.",
-  "version": "2.1.4",
+  "version": "2.2.1",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -41,10 +41,10 @@
   },
   "dependencies": {
     "@argos-ci/browser": "2.1.2",
-    "@argos-ci/util": "2.0.0"
+    "@argos-ci/util": "2.1.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.2.0",
+    "@argos-ci/cli": "2.3.1",
     "@types/jest": "^29.5.12",
     "@types/node": "^18.0.0",
     "eslint": "^8.57.0",
@@ -63,5 +63,5 @@
     "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-puppeteer-e2e-node-$NODE_VERSION-$OS\"",
     "e2e": "pnpm run test && pnpm run argos-upload"
   },
-  "gitHead": "0c328bfcd6475ad625c0335cab11e912e856173c"
+  "gitHead": "8fbd0bb85ba9df1e8ca39d46acfe9903264d0b51"
 }