@argos-ci/cypress 7.0.22 → 7.1.0

package/README.md

@@ -17,7 +17,7 @@
 
 Capture stable Argos screenshots from your [Cypress](https://www.cypress.io/) tests.
 
-Visit the [Cypress SDK documentation](https://argos-ci.com/docs/sdks-reference/cypress) for guides, the API reference, and more.
+Visit the [Cypress SDK documentation](https://argos-ci.com/docs/reference/cypress) for guides, the API reference, and more.
 
 ## Installation
 
@@ -69,6 +69,6 @@ describe("Homepage", () => {
 
 ## Links
 
-- [Official SDK Docs](https://argos-ci.com/docs/sdks-reference/cypress)
+- [Official SDK Docs](https://argos-ci.com/docs/reference/cypress)
 - [Quickstart](https://argos-ci.com/docs/quickstart/cypress-quickstart)
 - [Discord](https://argos-ci.com/discord)

package/dist/support.d.mts

@@ -16,6 +16,22 @@ type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & C
    * @default 0.5
    */
   threshold?: number;
+  /**
+   * Name, or list of names, to compare this screenshot against instead of its
+   * own name. A list is tried in order and the first name found in the baseline
+   * build wins, which lets a brand new screenshot fall back to an existing one
+   * rather than showing up as added.
+   *
+   * The screenshot's own name is not implicitly included: list it first to keep
+   * comparing against itself when it exists.
+   *
+   * @example
+   *    // Compare "home-variant-b" against itself, or against "home" if it is new.
+   *    cy.argosScreenshot("home-variant-b", {
+   *      baseName: ["home-variant-b", "home"],
+   *    })
+   */
+  baseName?: string | string[];
   /**
    * Wait for the UI to stabilize before taking the screenshot.
    * Set to `false` to disable stabilization.
@@ -34,7 +50,7 @@ declare global {
       /**
        * Stabilize the UI and takes a screenshot of the application under test.
        *
-       * @see https://argos-ci.com/docs/sdks-reference/cypress
+       * @see https://argos-ci.com/docs/reference/cypress
        * @example
        *    cy.argosScreenshot("my-screenshot")
        *    cy.get(".post").argosScreenshot()

package/dist/support.mjs

@@ -1,8 +1,8 @@
 import "cypress-wait-until";
 import { getGlobalScript, resolveViewport } from "@argos-ci/browser";
-import { getMetadataPath, getScreenshotName, validateThreshold } from "@argos-ci/util/browser";
+import { getMetadataPath, getScreenshotName, normalizeBaseNames, validateThreshold } from "@argos-ci/util/browser";
 //#region package.json
-var version = "7.0.21";
+var version = "7.0.22";
 //#endregion
 //#region src/shared.ts
 /**
@@ -73,7 +73,8 @@ Cypress.Commands.add("argosScreenshot", { prevSubject: [
 	"window",
 	"document"
 ] }, (subject, name, options = {}) => {
-	const { viewports, argosCSS: _argosCSS, tag, ...cypressOptions } = options;
+	const { viewports, argosCSS: _argosCSS, tag, baseName, ...cypressOptions } = options;
+	const baseNames = normalizeBaseNames(baseName);
 	if (!name) throw new Error("The `name` argument is required.");
 	Cypress.log({
 		name: "argosScreenshot",
@@ -82,7 +83,7 @@ Cypress.Commands.add("argosScreenshot", { prevSubject: [
 	});
 	injectArgos();
 	const afterAll = beforeAll(options);
-	function stabilizeAndScreenshot(name) {
+	function stabilizeAndScreenshot(name, baseNames) {
 		waitForReadiness(options);
 		const afterEach = beforeEach(options);
 		waitForReadiness(options);
@@ -125,6 +126,7 @@ Cypress.Commands.add("argosScreenshot", { prevSubject: [
 				}
 			};
 			metadata.transient = {};
+			if (baseNames) metadata.transient.baseName = baseNames;
 			if (tag) metadata.tags = Array.isArray(tag) ? tag : [tag];
 			if (options.threshold !== void 0) {
 				validateThreshold(options.threshold);
@@ -138,10 +140,10 @@ Cypress.Commands.add("argosScreenshot", { prevSubject: [
 		for (const viewport of viewports) {
 			const viewportSize = resolveViewport(viewport);
 			cy.viewport(viewportSize.width, viewportSize.height);
-			stabilizeAndScreenshot(getScreenshotName(name, { viewportWidth: viewportSize.width }));
+			stabilizeAndScreenshot(getScreenshotName(name, { viewportWidth: viewportSize.width }), baseNames?.map((baseName) => getScreenshotName(baseName, { viewportWidth: viewportSize.width })) ?? null);
 		}
 		cy.viewport(Cypress.config("viewportWidth"), Cypress.config("viewportHeight"));
-	} else stabilizeAndScreenshot(name);
+	} else stabilizeAndScreenshot(name, baseNames);
 	afterAll();
 });
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Cypress SDK for visual testing with Argos.",
-  "version": "7.0.22",
+  "version": "7.1.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -9,7 +9,7 @@
     "url": "https://github.com/argos-ci/argos-javascript.git",
     "directory": "packages/cypress"
   },
-  "homepage": "https://argos-ci.com/docs/sdks-reference/cypress",
+  "homepage": "https://argos-ci.com/docs/reference/cypress",
   "bugs": {
     "url": "https://github.com/argos-ci/argos-javascript/issues"
   },
@@ -45,8 +45,8 @@
   },
   "dependencies": {
     "@argos-ci/browser": "6.4.4",
-    "@argos-ci/core": "6.6.2",
-    "@argos-ci/util": "4.0.4",
+    "@argos-ci/core": "6.7.0",
+    "@argos-ci/util": "4.1.0",
     "cypress-wait-until": "^3.0.2"
   },
   "peerDependencies": {
@@ -66,5 +66,5 @@
     "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "a86f2dc1a243591e064a2d5c4e03d712c8f03b86"
+  "gitHead": "a3083087b11004e0b315e2d14f1e9179cbd56da2"
 }