@argos-ci/cypress 6.2.12 → 6.3.1

package/dist/support.d.mts

@@ -0,0 +1,53 @@
+import { StabilizationPluginOptions, ViewportOption } from "@argos-ci/browser";
+
+//#region src/support.d.ts
+type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> & {
+  /**
+   * Viewports to take screenshots of.
+   */
+  viewports?: ViewportOption[];
+  /**
+   * Custom CSS evaluated during the screenshot process.
+   */
+  argosCSS?: string;
+  /**
+   * Sensitivity threshold between 0 and 1.
+   * The higher the threshold, the less sensitive the diff will be.
+   * @default 0.5
+   */
+  threshold?: number;
+  /**
+   * Wait for the UI to stabilize before taking the screenshot.
+   * Set to `false` to disable stabilization.
+   * Pass an object to customize the stabilization.
+   * @default true
+   */
+  stabilize?: boolean | StabilizationPluginOptions;
+  /**
+   * Tag or array of tags to attach to the screenshot.
+   */
+  tag?: string | string[];
+};
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Stabilize the UI and takes a screenshot of the application under test.
+       *
+       * @see https://argos-ci.com/docs/cypress#api-overview
+       * @example
+       *    cy.argosScreenshot("my-screenshot")
+       *    cy.get(".post").argosScreenshot()
+       */
+      argosScreenshot: (
+      /**
+       * Name of the screenshot. Must be unique.
+       */
+      name: string,
+      /**
+       * Options for the screenshot.
+       */
+      options?: ArgosScreenshotOptions) => Chainable<null>;
+    }
+  }
+}

package/dist/support.mjs

@@ -0,0 +1,148 @@
+import "cypress-wait-until";
+import { getGlobalScript, resolveViewport } from "@argos-ci/browser";
+import { getMetadataPath, getScreenshotName, validateThreshold } from "@argos-ci/util/browser";
+//#region package.json
+var version = "6.3.0";
+//#endregion
+//#region src/shared.ts
+/**
+* Prefix to identify Argos screenshots.
+*/
+const NAME_PREFIX = "argos/";
+//#endregion
+//#region src/support.ts
+function injectArgos() {
+	cy.window({ log: false }).then((window) => {
+		if (typeof window.__ARGOS__ !== "undefined") return;
+		window.eval(getGlobalScript());
+	});
+}
+/**
+* Get the stabilization context from the options.
+*/
+function getStabilizationContext(options) {
+	const { argosCSS, viewports } = options;
+	return {
+		fullPage: !options.capture || options.capture === "fullPage",
+		argosCSS,
+		viewports,
+		options: options.stabilize
+	};
+}
+/**
+* Run before taking all screenshots.
+*/
+function beforeAll(options) {
+	const context = getStabilizationContext(options);
+	cy.window({ log: false }).then((window) => window.__ARGOS__.beforeAll(context));
+	return () => {
+		cy.window({ log: false }).then((window) => window.__ARGOS__.afterAll());
+	};
+}
+/**
+* Run before taking each screenshot.
+*/
+function beforeEach(options) {
+	const context = getStabilizationContext(options);
+	cy.window({ log: false }).then((window) => window.__ARGOS__.beforeEach(context));
+	return () => {
+		cy.window({ log: false }).then((window) => window.__ARGOS__.afterEach());
+	};
+}
+function getRetries(value) {
+	if (typeof value !== "number" || !Number.isFinite(value)) return 0;
+	const retries = Math.floor(value);
+	return retries < 0 ? 0 : retries;
+}
+/**
+* Wait for the UI to be ready before taking the screenshot.
+*/
+function waitForReadiness(options) {
+	const context = getStabilizationContext(options);
+	cy.waitUntil(() => cy.window({ log: false }).then((window) => {
+		if (window.__ARGOS__.waitFor(context)) return true;
+		window.__ARGOS__.getWaitFailureExplanations(context).forEach((reason) => {
+			cy.log(`[argos] stability: ${reason}`);
+		});
+		return false;
+	}));
+}
+Cypress.Commands.add("argosScreenshot", { prevSubject: [
+	"optional",
+	"element",
+	"window",
+	"document"
+] }, (subject, name, options = {}) => {
+	const { viewports, argosCSS: _argosCSS, tag, ...cypressOptions } = options;
+	if (!name) throw new Error("The `name` argument is required.");
+	Cypress.log({
+		name: "argosScreenshot",
+		displayName: `Argos Screenshot`,
+		message: name
+	});
+	injectArgos();
+	const afterAll = beforeAll(options);
+	function stabilizeAndScreenshot(name) {
+		waitForReadiness(options);
+		const afterEach = beforeEach(options);
+		waitForReadiness(options);
+		const ref = {};
+		cy.wrap(subject).screenshot(`${NAME_PREFIX}${name}`, {
+			blackout: ["[data-visual-test=\"blackout\"]"].concat(options.blackout || []),
+			onAfterScreenshot: (_$el, props) => {
+				ref.props = props;
+			},
+			...cypressOptions
+		});
+		cy.window({ log: false }).then((window) => {
+			const mediaType = window.__ARGOS__.getMediaType();
+			const colorScheme = window.__ARGOS__.getColorScheme();
+			const metadata = {
+				url: window.location.href,
+				viewport: {
+					width: window.innerWidth,
+					height: window.innerHeight
+				},
+				colorScheme,
+				mediaType,
+				test: {
+					title: Cypress.currentTest.title,
+					titlePath: Cypress.currentTest.titlePath,
+					retry: Cypress.currentRetry,
+					retries: getRetries(cy.state("runnable")._retries)
+				},
+				browser: {
+					name: Cypress.browser.name,
+					version: Cypress.browser.version
+				},
+				automationLibrary: {
+					name: "cypress",
+					version: Cypress.version
+				},
+				sdk: {
+					name: "@argos-ci/cypress",
+					version
+				}
+			};
+			metadata.transient = {};
+			if (tag) metadata.tags = Array.isArray(tag) ? tag : [tag];
+			if (options.threshold !== void 0) {
+				validateThreshold(options.threshold);
+				metadata.transient.threshold = options.threshold;
+			}
+			cy.writeFile(getMetadataPath(ref.props.path), JSON.stringify(metadata));
+		});
+		afterEach();
+	}
+	if (viewports) {
+		for (const viewport of viewports) {
+			const viewportSize = resolveViewport(viewport);
+			cy.viewport(viewportSize.width, viewportSize.height);
+			stabilizeAndScreenshot(getScreenshotName(name, { viewportWidth: viewportSize.width }));
+		}
+		cy.viewport(Cypress.config("viewportWidth"), Cypress.config("viewportHeight"));
+	} else stabilizeAndScreenshot(name);
+	afterAll();
+});
+//#endregion
+export {};

package/dist/task.cjs

@@ -1,135 +1,88 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/task.ts
-var task_exports = {};
-__export(task_exports, {
-  argosAfterRun: () => argosAfterRun,
-  argosAfterScreenshot: () => argosAfterScreenshot,
-  registerArgosTask: () => registerArgosTask
-});
-module.exports = __toCommonJS(task_exports);
-var import_core = require("@argos-ci/core");
-var import_node_path = require("path");
-
-// src/shared.ts
-var NAME_PREFIX = "argos/";
-
-// src/task.ts
-var import_promises = require("fs/promises");
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _argos_ci_core = require("@argos-ci/core");
+let node_path = require("node:path");
+let node_fs_promises = require("node:fs/promises");
+//#endregion
+//#region src/task.ts
 function checkIsCypressFailedResult(results) {
-  return "status" in results && results.status === "failed";
+	return "status" in results && results.status === "failed";
 }
-var screenshotsDirectoryPromise = void 0;
+let screenshotsDirectoryPromise = void 0;
+/**
+* Get the path to the directory where screenshots will be stored.
+*/
 async function getScreenshotsDirectory() {
-  const { createTemporaryDirectory } = await import("@argos-ci/util");
-  if (!screenshotsDirectoryPromise) {
-    screenshotsDirectoryPromise = createTemporaryDirectory();
-  }
-  return screenshotsDirectoryPromise;
+	const { createTemporaryDirectory } = await import("@argos-ci/util");
+	if (!screenshotsDirectoryPromise) screenshotsDirectoryPromise = createTemporaryDirectory();
+	return screenshotsDirectoryPromise;
 }
+/**
+* Create a directory if it does not exist.
+*/
 async function createDirectory(directory) {
-  const { createDirectory: createDirectory2 } = await import("@argos-ci/util");
-  await createDirectory2(directory);
+	const { createDirectory } = await import("@argos-ci/util");
+	await createDirectory(directory);
 }
 function getArgosConfigFromOptions(options) {
-  return {
-    uploadToArgos: options?.uploadToArgos ?? true
-  };
+	return { uploadToArgos: options?.uploadToArgos ?? true };
 }
+/**
+* Cypress "after:screenshot" event handler.
+* - Move screenshots to Argos directory
+*/
 async function argosAfterScreenshot(config, details, options) {
-  const { uploadToArgos } = getArgosConfigFromOptions(options);
-  if (!uploadToArgos) {
-    return { path: details.path };
-  }
-  const argosScreenshotsDir = await getScreenshotsDirectory();
-  if (details.name?.startsWith(NAME_PREFIX)) {
-    const newPath2 = (0, import_node_path.join)(
-      argosScreenshotsDir,
-      details.name.slice(NAME_PREFIX.length) + (0, import_node_path.extname)(details.path)
-    );
-    await createDirectory((0, import_node_path.dirname)(newPath2));
-    await (0, import_promises.copyFile)(details.path, newPath2);
-    return { path: newPath2 };
-  }
-  const { screenshotsFolder } = config;
-  if (!screenshotsFolder) {
-    throw new Error(
-      "Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js"
-    );
-  }
-  if (!details.path.startsWith(screenshotsFolder)) {
-    throw new Error(
-      `Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`
-    );
-  }
-  const relativePath = details.path.slice(
-    screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1)
-  );
-  const newPath = (0, import_node_path.join)(argosScreenshotsDir, relativePath);
-  await createDirectory((0, import_node_path.dirname)(newPath));
-  await (0, import_promises.copyFile)(details.path, newPath);
-  return { path: (0, import_node_path.join)(argosScreenshotsDir, relativePath) };
+	const { uploadToArgos } = getArgosConfigFromOptions(options);
+	if (!uploadToArgos) return { path: details.path };
+	const argosScreenshotsDir = await getScreenshotsDirectory();
+	if (details.name?.startsWith("argos/")) {
+		const newPath = (0, node_path.join)(argosScreenshotsDir, details.name.slice(6) + (0, node_path.extname)(details.path));
+		await createDirectory((0, node_path.dirname)(newPath));
+		await (0, node_fs_promises.copyFile)(details.path, newPath);
+		return { path: newPath };
+	}
+	const { screenshotsFolder } = config;
+	if (!screenshotsFolder) throw new Error("Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js");
+	if (!details.path.startsWith(screenshotsFolder)) throw new Error(`Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`);
+	const relativePath = details.path.slice(screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1));
+	const newPath = (0, node_path.join)(argosScreenshotsDir, relativePath);
+	await createDirectory((0, node_path.dirname)(newPath));
+	await (0, node_fs_promises.copyFile)(details.path, newPath);
+	return { path: (0, node_path.join)(argosScreenshotsDir, relativePath) };
 }
+/**
+* Cypress "after:run" event handler.
+* - Upload screenshots to Argos
+*/
 async function argosAfterRun(_config, results, options) {
-  const { uploadToArgos } = getArgosConfigFromOptions(options);
-  if (!uploadToArgos) {
-    return;
-  }
-  const argosScreenshotsDir = await getScreenshotsDirectory();
-  const res = await (0, import_core.upload)({
-    ...options,
-    files: ["**/*.png"],
-    root: argosScreenshotsDir,
-    metadata: {
-      testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
-        status: "passed",
-        stats: {
-          startTime: results.startedTestsAt,
-          duration: results.totalDuration
-        }
-      }
-    }
-  });
-  console.log(`\u2705 Argos build created: ${res.build.url}`);
+	const { uploadToArgos } = getArgosConfigFromOptions(options);
+	if (!uploadToArgos) return;
+	const argosScreenshotsDir = await getScreenshotsDirectory();
+	const res = await (0, _argos_ci_core.upload)({
+		...options,
+		files: ["**/*.png"],
+		root: argosScreenshotsDir,
+		metadata: { testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
+			status: "passed",
+			stats: {
+				startTime: results.startedTestsAt,
+				duration: results.totalDuration
+			}
+		} }
+	});
+	console.log(`✅ Argos build created: ${res.build.url}`);
 }
+/**
+* Register the Argos tasks for Cypress.
+*/
 function registerArgosTask(on, config, options) {
-  on("after:screenshot", (details) => {
-    return argosAfterScreenshot(config, details, options);
-  });
-  on("after:run", async (results) => {
-    return argosAfterRun(config, results, options);
-  });
+	on("after:screenshot", (details) => {
+		return argosAfterScreenshot(config, details, options);
+	});
+	on("after:run", async (results) => {
+		return argosAfterRun(config, results, options);
+	});
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  argosAfterRun,
-  argosAfterScreenshot,
-  registerArgosTask
-});
+//#endregion
+exports.argosAfterRun = argosAfterRun;
+exports.argosAfterScreenshot = argosAfterScreenshot;
+exports.registerArgosTask = registerArgosTask;

package/dist/task.d.cts

@@ -1,18 +1,19 @@
-import { UploadParameters } from '@argos-ci/core';
+import { UploadParameters } from "@argos-ci/core";
 
+//#region src/task.d.ts
 type RegisterArgosTaskOptions = Omit<UploadParameters, "files" | "root" | "metadata"> & {
-    /**
-     * Upload the report to Argos.
-     * @default true
-     */
-    uploadToArgos?: boolean;
+  /**
+   * Upload the report to Argos.
+   * @default true
+   */
+  uploadToArgos?: boolean;
 };
 /**
  * Cypress "after:screenshot" event handler.
  * - Move screenshots to Argos directory
  */
 declare function argosAfterScreenshot(config: Cypress.PluginConfigOptions, details: Cypress.ScreenshotDetails, options?: RegisterArgosTaskOptions): Promise<{
-    path: string;
+  path: any;
 }>;
 /**
  * Cypress "after:run" event handler.
@@ -23,5 +24,5 @@ declare function argosAfterRun(_config: Cypress.PluginConfigOptions, results: Cy
  * Register the Argos tasks for Cypress.
  */
 declare function registerArgosTask(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions, options?: RegisterArgosTaskOptions): void;
-
-export { type RegisterArgosTaskOptions, argosAfterRun, argosAfterScreenshot, registerArgosTask };
+//#endregion
+export { RegisterArgosTaskOptions, argosAfterRun, argosAfterScreenshot, registerArgosTask };

package/dist/{task.d.ts → task.d.mts}

@@ -1,18 +1,19 @@
-import { UploadParameters } from '@argos-ci/core';
+import { UploadParameters } from "@argos-ci/core";
 
+//#region src/task.d.ts
 type RegisterArgosTaskOptions = Omit<UploadParameters, "files" | "root" | "metadata"> & {
-    /**
-     * Upload the report to Argos.
-     * @default true
-     */
-    uploadToArgos?: boolean;
+  /**
+   * Upload the report to Argos.
+   * @default true
+   */
+  uploadToArgos?: boolean;
 };
 /**
  * Cypress "after:screenshot" event handler.
  * - Move screenshots to Argos directory
  */
 declare function argosAfterScreenshot(config: Cypress.PluginConfigOptions, details: Cypress.ScreenshotDetails, options?: RegisterArgosTaskOptions): Promise<{
-    path: string;
+  path: any;
 }>;
 /**
  * Cypress "after:run" event handler.
@@ -23,5 +24,5 @@ declare function argosAfterRun(_config: Cypress.PluginConfigOptions, results: Cy
  * Register the Argos tasks for Cypress.
  */
 declare function registerArgosTask(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions, options?: RegisterArgosTaskOptions): void;
-
-export { type RegisterArgosTaskOptions, argosAfterRun, argosAfterScreenshot, registerArgosTask };
+//#endregion
+export { RegisterArgosTaskOptions, argosAfterRun, argosAfterScreenshot, registerArgosTask };

package/dist/task.mjs

@@ -0,0 +1,85 @@
+import { upload } from "@argos-ci/core";
+import { dirname, extname, join } from "node:path";
+import { copyFile } from "node:fs/promises";
+//#endregion
+//#region src/task.ts
+function checkIsCypressFailedResult(results) {
+	return "status" in results && results.status === "failed";
+}
+let screenshotsDirectoryPromise = void 0;
+/**
+* Get the path to the directory where screenshots will be stored.
+*/
+async function getScreenshotsDirectory() {
+	const { createTemporaryDirectory } = await import("@argos-ci/util");
+	if (!screenshotsDirectoryPromise) screenshotsDirectoryPromise = createTemporaryDirectory();
+	return screenshotsDirectoryPromise;
+}
+/**
+* Create a directory if it does not exist.
+*/
+async function createDirectory(directory) {
+	const { createDirectory } = await import("@argos-ci/util");
+	await createDirectory(directory);
+}
+function getArgosConfigFromOptions(options) {
+	return { uploadToArgos: options?.uploadToArgos ?? true };
+}
+/**
+* Cypress "after:screenshot" event handler.
+* - Move screenshots to Argos directory
+*/
+async function argosAfterScreenshot(config, details, options) {
+	const { uploadToArgos } = getArgosConfigFromOptions(options);
+	if (!uploadToArgos) return { path: details.path };
+	const argosScreenshotsDir = await getScreenshotsDirectory();
+	if (details.name?.startsWith("argos/")) {
+		const newPath = join(argosScreenshotsDir, details.name.slice(6) + extname(details.path));
+		await createDirectory(dirname(newPath));
+		await copyFile(details.path, newPath);
+		return { path: newPath };
+	}
+	const { screenshotsFolder } = config;
+	if (!screenshotsFolder) throw new Error("Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js");
+	if (!details.path.startsWith(screenshotsFolder)) throw new Error(`Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`);
+	const relativePath = details.path.slice(screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1));
+	const newPath = join(argosScreenshotsDir, relativePath);
+	await createDirectory(dirname(newPath));
+	await copyFile(details.path, newPath);
+	return { path: join(argosScreenshotsDir, relativePath) };
+}
+/**
+* Cypress "after:run" event handler.
+* - Upload screenshots to Argos
+*/
+async function argosAfterRun(_config, results, options) {
+	const { uploadToArgos } = getArgosConfigFromOptions(options);
+	if (!uploadToArgos) return;
+	const argosScreenshotsDir = await getScreenshotsDirectory();
+	const res = await upload({
+		...options,
+		files: ["**/*.png"],
+		root: argosScreenshotsDir,
+		metadata: { testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
+			status: "passed",
+			stats: {
+				startTime: results.startedTestsAt,
+				duration: results.totalDuration
+			}
+		} }
+	});
+	console.log(`✅ Argos build created: ${res.build.url}`);
+}
+/**
+* Register the Argos tasks for Cypress.
+*/
+function registerArgosTask(on, config, options) {
+	on("after:screenshot", (details) => {
+		return argosAfterScreenshot(config, details, options);
+	});
+	on("after:run", async (results) => {
+		return argosAfterRun(config, results, options);
+	});
+}
+//#endregion
+export { argosAfterRun, argosAfterScreenshot, registerArgosTask };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Cypress SDK for visual testing with Argos.",
-  "version": "6.2.12",
+  "version": "6.3.1",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -26,15 +26,14 @@
     "access": "public"
   },
   "type": "module",
-  "types": "./dist/index.d.ts",
   "exports": {
     "./support": {
-      "types": "./dist/support.d.ts",
-      "import": "./dist/support.js",
-      "default": "./dist/support.js"
+      "types": "./dist/support.d.mts",
+      "import": "./dist/support.mjs",
+      "default": "./dist/support.mjs"
     },
     "./task": {
-      "types": "./dist/task.d.ts",
+      "types": "./dist/task.d.mts",
       "import": "./dist/task.js",
       "require": "./dist/task.cjs",
       "default": "./dist/task.cjs"
@@ -45,9 +44,9 @@
     "node": ">=20.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "5.1.2",
-    "@argos-ci/core": "5.1.1",
-    "@argos-ci/util": "3.2.0",
+    "@argos-ci/browser": "5.1.3",
+    "@argos-ci/core": "5.1.3",
+    "@argos-ci/util": "3.4.0",
     "cypress-wait-until": "^3.0.2"
   },
   "peerDependencies": {
@@ -55,11 +54,11 @@
   },
   "devDependencies": {
     "@types/node": "catalog:",
-    "cypress": "^15.9.0",
-    "eslint-plugin-cypress": "^5.2.1"
+    "cypress": "^15.13.0",
+    "eslint-plugin-cypress": "^6.2.1"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "test-e2e": "pnpm exec cypress run",
     "build-e2e": "cypress install",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test-e2e",
@@ -67,5 +66,5 @@
     "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "52b2c59dc89e972ea9951dc7a94bf8f7d7922e4a"
+  "gitHead": "b49d186d5eb6e1338982a4cd5c3cb29e6cb0b7af"
 }

package/dist/support.d.ts

@@ -1,48 +0,0 @@
-import { ViewportOption, StabilizationPluginOptions } from '@argos-ci/browser';
-
-type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> & {
-    /**
-     * Viewports to take screenshots of.
-     */
-    viewports?: ViewportOption[];
-    /**
-     * Custom CSS evaluated during the screenshot process.
-     */
-    argosCSS?: string;
-    /**
-     * Sensitivity threshold between 0 and 1.
-     * The higher the threshold, the less sensitive the diff will be.
-     * @default 0.5
-     */
-    threshold?: number;
-    /**
-     * Wait for the UI to stabilize before taking the screenshot.
-     * Set to `false` to disable stabilization.
-     * Pass an object to customize the stabilization.
-     * @default true
-     */
-    stabilize?: boolean | StabilizationPluginOptions;
-};
-declare global {
-    namespace Cypress {
-        interface Chainable {
-            /**
-             * Stabilize the UI and takes a screenshot of the application under test.
-             *
-             * @see https://argos-ci.com/docs/cypress#api-overview
-             * @example
-             *    cy.argosScreenshot("my-screenshot")
-             *    cy.get(".post").argosScreenshot()
-             */
-            argosScreenshot: (
-            /**
-             * Name of the screenshot. Must be unique.
-             */
-            name: string, 
-            /**
-             * Options for the screenshot.
-             */
-            options?: ArgosScreenshotOptions) => Chainable<null>;
-        }
-    }
-}

package/dist/support.js

@@ -1,171 +0,0 @@
-// src/support.ts
-import "cypress-wait-until";
-import {
-  resolveViewport
-} from "@argos-ci/browser";
-import { getGlobalScript } from "@argos-ci/browser";
-import {
-  getMetadataPath,
-  getScreenshotName,
-  validateThreshold
-} from "@argos-ci/util/browser";
-
-// package.json
-var version = "6.2.11";
-
-// src/shared.ts
-var NAME_PREFIX = "argos/";
-
-// src/support.ts
-function injectArgos() {
-  cy.window({ log: false }).then((window) => {
-    if (typeof window.__ARGOS__ !== "undefined") {
-      return;
-    }
-    window.eval(getGlobalScript());
-  });
-}
-function getStabilizationContext(options) {
-  const { argosCSS, viewports } = options;
-  const fullPage = !options.capture || options.capture === "fullPage";
-  return {
-    fullPage,
-    argosCSS,
-    viewports,
-    options: options.stabilize
-  };
-}
-function beforeAll(options) {
-  const context = getStabilizationContext(options);
-  cy.window({ log: false }).then(
-    (window) => window.__ARGOS__.beforeAll(context)
-  );
-  return () => {
-    cy.window({ log: false }).then(
-      (window) => window.__ARGOS__.afterAll()
-    );
-  };
-}
-function beforeEach(options) {
-  const context = getStabilizationContext(options);
-  cy.window({ log: false }).then(
-    (window) => window.__ARGOS__.beforeEach(context)
-  );
-  return () => {
-    cy.window({ log: false }).then(
-      (window) => window.__ARGOS__.afterEach()
-    );
-  };
-}
-function getRetries(value) {
-  if (typeof value !== "number" || !Number.isFinite(value)) {
-    return 0;
-  }
-  const retries = Math.floor(value);
-  return retries < 0 ? 0 : retries;
-}
-function waitForReadiness(options) {
-  const context = getStabilizationContext(options);
-  cy.waitUntil(
-    () => cy.window({ log: false }).then((window) => {
-      const isStable = window.__ARGOS__.waitFor(
-        context
-      );
-      if (isStable) {
-        return true;
-      }
-      const failureReasons = window.__ARGOS__.getWaitFailureExplanations(context);
-      failureReasons.forEach((reason) => {
-        cy.log(`[argos] stability: ${reason}`);
-      });
-      return false;
-    })
-  );
-}
-Cypress.Commands.add(
-  "argosScreenshot",
-  { prevSubject: ["optional", "element", "window", "document"] },
-  (subject, name, options = {}) => {
-    const { viewports, argosCSS: _argosCSS, ...cypressOptions } = options;
-    if (!name) {
-      throw new Error("The `name` argument is required.");
-    }
-    Cypress.log({
-      name: "argosScreenshot",
-      displayName: `Argos Screenshot`,
-      message: name
-    });
-    injectArgos();
-    const afterAll = beforeAll(options);
-    function stabilizeAndScreenshot(name2) {
-      waitForReadiness(options);
-      const afterEach = beforeEach(options);
-      waitForReadiness(options);
-      const ref = {};
-      cy.wrap(subject).screenshot(`${NAME_PREFIX}${name2}`, {
-        blackout: ['[data-visual-test="blackout"]'].concat(
-          options.blackout || []
-        ),
-        onAfterScreenshot: (_$el, props) => {
-          ref.props = props;
-        },
-        ...cypressOptions
-      });
-      cy.window({ log: false }).then((window) => {
-        const mediaType = window.__ARGOS__.getMediaType();
-        const colorScheme = window.__ARGOS__.getColorScheme();
-        const metadata = {
-          url: window.location.href,
-          viewport: {
-            width: window.innerWidth,
-            height: window.innerHeight
-          },
-          colorScheme,
-          mediaType,
-          test: {
-            title: Cypress.currentTest.title,
-            titlePath: Cypress.currentTest.titlePath,
-            retry: Cypress.currentRetry,
-            // @ts-expect-error - private property
-            retries: getRetries(cy.state("runnable")._retries)
-          },
-          browser: {
-            name: Cypress.browser.name,
-            version: Cypress.browser.version
-          },
-          automationLibrary: {
-            name: "cypress",
-            version: Cypress.version
-          },
-          sdk: {
-            name: "@argos-ci/cypress",
-            version
-          }
-        };
-        metadata.transient = {};
-        if (options.threshold !== void 0) {
-          validateThreshold(options.threshold);
-          metadata.transient.threshold = options.threshold;
-        }
-        cy.writeFile(getMetadataPath(ref.props.path), JSON.stringify(metadata));
-      });
-      afterEach();
-    }
-    if (viewports) {
-      for (const viewport of viewports) {
-        const viewportSize = resolveViewport(viewport);
-        cy.viewport(viewportSize.width, viewportSize.height);
-        stabilizeAndScreenshot(
-          getScreenshotName(name, { viewportWidth: viewportSize.width })
-        );
-      }
-      cy.viewport(
-        Cypress.config("viewportWidth"),
-        Cypress.config("viewportHeight")
-      );
-    } else {
-      stabilizeAndScreenshot(name);
-    }
-    afterAll();
-  }
-);

package/dist/task.js

@@ -1,98 +0,0 @@
-// src/task.ts
-import { upload } from "@argos-ci/core";
-import { extname, join, dirname } from "path";
-
-// src/shared.ts
-var NAME_PREFIX = "argos/";
-
-// src/task.ts
-import { copyFile } from "fs/promises";
-function checkIsCypressFailedResult(results) {
-  return "status" in results && results.status === "failed";
-}
-var screenshotsDirectoryPromise = void 0;
-async function getScreenshotsDirectory() {
-  const { createTemporaryDirectory } = await import("@argos-ci/util");
-  if (!screenshotsDirectoryPromise) {
-    screenshotsDirectoryPromise = createTemporaryDirectory();
-  }
-  return screenshotsDirectoryPromise;
-}
-async function createDirectory(directory) {
-  const { createDirectory: createDirectory2 } = await import("@argos-ci/util");
-  await createDirectory2(directory);
-}
-function getArgosConfigFromOptions(options) {
-  return {
-    uploadToArgos: options?.uploadToArgos ?? true
-  };
-}
-async function argosAfterScreenshot(config, details, options) {
-  const { uploadToArgos } = getArgosConfigFromOptions(options);
-  if (!uploadToArgos) {
-    return { path: details.path };
-  }
-  const argosScreenshotsDir = await getScreenshotsDirectory();
-  if (details.name?.startsWith(NAME_PREFIX)) {
-    const newPath2 = join(
-      argosScreenshotsDir,
-      details.name.slice(NAME_PREFIX.length) + extname(details.path)
-    );
-    await createDirectory(dirname(newPath2));
-    await copyFile(details.path, newPath2);
-    return { path: newPath2 };
-  }
-  const { screenshotsFolder } = config;
-  if (!screenshotsFolder) {
-    throw new Error(
-      "Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js"
-    );
-  }
-  if (!details.path.startsWith(screenshotsFolder)) {
-    throw new Error(
-      `Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`
-    );
-  }
-  const relativePath = details.path.slice(
-    screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1)
-  );
-  const newPath = join(argosScreenshotsDir, relativePath);
-  await createDirectory(dirname(newPath));
-  await copyFile(details.path, newPath);
-  return { path: join(argosScreenshotsDir, relativePath) };
-}
-async function argosAfterRun(_config, results, options) {
-  const { uploadToArgos } = getArgosConfigFromOptions(options);
-  if (!uploadToArgos) {
-    return;
-  }
-  const argosScreenshotsDir = await getScreenshotsDirectory();
-  const res = await upload({
-    ...options,
-    files: ["**/*.png"],
-    root: argosScreenshotsDir,
-    metadata: {
-      testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
-        status: "passed",
-        stats: {
-          startTime: results.startedTestsAt,
-          duration: results.totalDuration
-        }
-      }
-    }
-  });
-  console.log(`\u2705 Argos build created: ${res.build.url}`);
-}
-function registerArgosTask(on, config, options) {
-  on("after:screenshot", (details) => {
-    return argosAfterScreenshot(config, details, options);
-  });
-  on("after:run", async (results) => {
-    return argosAfterRun(config, results, options);
-  });
-}
-export {
-  argosAfterRun,
-  argosAfterScreenshot,
-  registerArgosTask
-};