comparadise-utils 1.15.1 → 1.16.0

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { MatchScreenshotArgs } from './match-screenshot.js';
+
+declare function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions): Cypress.PluginConfigOptions;
+declare global {
+    namespace Cypress {
+        interface Chainable {
+            matchScreenshot(args?: MatchScreenshotArgs): Chainable;
+        }
+    }
+}
+
+export { setupVisualTests };

package/dist/index.js

@@ -1,17 +1,203 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupVisualTests = void 0;
-const screenshots_1 = require("./screenshots");
-function setupVisualTests(on, config) {
-    on('after:screenshot', screenshots_1.onAfterScreenshot);
-    on('task', {
-        baseExists: screenshots_1.baseExists,
-        compareScreenshots: screenshots_1.compareScreenshots,
-        log: (message) => {
-            console.log(message);
-            return null;
+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);
+
+// index.ts
+var comparadise_utils_exports = {};
+__export(comparadise_utils_exports, {
+  setupVisualTests: () => setupVisualTests
+});
+module.exports = __toCommonJS(comparadise_utils_exports);
+
+// screenshots.ts
+var fs2 = __toESM(require("fs"));
+var import_pngjs2 = require("pngjs");
+
+// images.ts
+var fs = __toESM(require("fs"));
+var import_pngjs = require("pngjs");
+var import_pixelmatch = __toESM(require("pixelmatch"));
+var PIXELMATCH_OPTIONS = {
+  threshold: 0.3
+};
+var createImageResizer = (width, height) => (source) => {
+  const resized = new import_pngjs.PNG({ width, height, fill: true });
+  import_pngjs.PNG.bitblt(source, resized, 0, 0, source.width, source.height, 0, 0);
+  return resized;
+};
+var fillSizeDifference = (width, height) => (image) => {
+  const inArea = (x, y) => y > height || x > width;
+  for (let y = 0; y < image.height; y++) {
+    for (let x = 0; x < image.width; x++) {
+      if (inArea(x, y)) {
+        const idx = image.width * y + x << 2;
+        image.data[idx] = 0;
+        image.data[idx + 1] = 0;
+        image.data[idx + 2] = 0;
+        image.data[idx + 3] = 64;
+      }
+    }
+  }
+  return image;
+};
+function alignImagesToSameSize(firstImage, secondImage) {
+  const firstImageWidth = firstImage.width;
+  const firstImageHeight = firstImage.height;
+  const secondImageWidth = secondImage.width;
+  const secondImageHeight = secondImage.height;
+  const resizeToSameSize = createImageResizer(
+    Math.max(firstImageWidth, secondImageWidth),
+    Math.max(firstImageHeight, secondImageHeight)
+  );
+  const resizedFirst = resizeToSameSize(firstImage);
+  const resizedSecond = resizeToSameSize(secondImage);
+  return [
+    fillSizeDifference(firstImageWidth, firstImageHeight)(resizedFirst),
+    fillSizeDifference(secondImageWidth, secondImageHeight)(resizedSecond)
+  ];
+}
+function getDiffPixels(basePath, actualPath) {
+  const rawBase = import_pngjs.PNG.sync.read(fs.readFileSync(basePath));
+  const rawActual = import_pngjs.PNG.sync.read(fs.readFileSync(actualPath));
+  const hasSizeMismatch = rawBase.height !== rawActual.height || rawBase.width !== rawActual.width;
+  const [base, actual] = hasSizeMismatch ? alignImagesToSameSize(rawBase, rawActual) : [rawBase, rawActual];
+  const diff = new import_pngjs.PNG({ width: base.width, height: base.height });
+  const diffPixels = (0, import_pixelmatch.default)(
+    actual.data,
+    base.data,
+    diff.data,
+    diff.width,
+    diff.height,
+    PIXELMATCH_OPTIONS
+  );
+  return { diffPixels, diff };
+}
+
+// files.ts
+function createImageFileName(path, type) {
+  let newPath = path;
+  if (path.startsWith("/")) {
+    newPath = `.${path}`;
+  }
+  return `${newPath}/${type}.png`;
+}
+
+// screenshots.ts
+function baseExists(path) {
+  const fileName = createImageFileName(path, "base");
+  const exists = fs2.existsSync(fileName);
+  if (!exists) {
+    console.log(
+      "Base image does not exist. This means a new one will be created. If your base should exist, something went wrong."
+    );
+  }
+  return exists;
+}
+function compareScreenshots(screenshotFolder) {
+  const basePath = createImageFileName(screenshotFolder, "base");
+  const actualPath = createImageFileName(screenshotFolder, "new");
+  const { diffPixels, diff } = getDiffPixels(basePath, actualPath);
+  if (diffPixels) {
+    fs2.writeFile(
+      createImageFileName(screenshotFolder, "diff"),
+      import_pngjs2.PNG.sync.write(diff),
+      (err) => {
+        if (err) {
+          console.error("\u274C Diff exists but unable to create diff.png", err);
         }
+      }
+    );
+  } else {
+    fs2.unlink(actualPath, (err) => {
+      if (err) {
+        console.error("\u274C No diff but unable to delete actualPath}", err);
+      }
     });
-    return config;
+  }
+  return diffPixels;
+}
+var trimPostfix = (path) => {
+  const imgExt = ".png";
+  const attemptPostfixRegex = new RegExp(`\\s\\(attempt \\d+\\)${imgExt}$`);
+  if (attemptPostfixRegex.test(path)) {
+    return path.replace(attemptPostfixRegex, imgExt);
+  }
+  return path;
+};
+var getNewPath = (path) => {
+  let newPath;
+  if (path.includes("___")) {
+    newPath = path.slice(path.lastIndexOf("___") + 3);
+    if (newPath.startsWith("/")) {
+      newPath = `.${newPath}`;
+    }
+    console.log(newPath);
+  } else {
+    newPath = path;
+  }
+  return trimPostfix(newPath);
+};
+function onAfterScreenshot(details) {
+  console.log("\u{1F9F8} Screenshot was saved to:", details.path);
+  if (!details.path.match("cypress")) {
+    return Promise.resolve({});
+  }
+  const newPath = getNewPath(details.path);
+  const newPathDir = newPath.substring(0, newPath.lastIndexOf("/"));
+  try {
+    fs2.mkdirSync(newPathDir, { recursive: true });
+  } catch (err) {
+    console.error("\u274C Error creating new screenshot folder:", newPathDir, err);
+  }
+  return new Promise((resolve, reject) => {
+    fs2.rename(details.path, newPath, (err) => {
+      if (err) {
+        reject(err);
+      }
+      resolve({ path: newPath });
+    });
+  });
+}
+
+// index.ts
+function setupVisualTests(on, config) {
+  on("after:screenshot", onAfterScreenshot);
+  on("task", {
+    baseExists,
+    compareScreenshots,
+    log: (message) => {
+      console.log(message);
+      return null;
+    }
+  });
+  return config;
 }
-exports.setupVisualTests = setupVisualTests;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setupVisualTests
+});

package/{types → dist}/match-screenshot.d.ts

@@ -1,10 +1,8 @@
-/// <reference types="cypress" />
-/// <reference types="cypress" />
-export type MatchScreenshotArgs = {
+type MatchScreenshotArgs = {
     rawName?: string;
     options?: Partial<Cypress.ScreenshotOptions>;
 };
-export declare function matchScreenshot(subject: Cypress.JQueryWithSelector | Window | Document | void, args?: MatchScreenshotArgs): void;
+declare function matchScreenshot(subject: Cypress.JQueryWithSelector | Window | Document | void, args?: MatchScreenshotArgs): void;
 interface ExtendedCurrentRunnable extends Mocha.Runnable {
     currentRunnable?: {
         order?: unknown;
@@ -19,4 +17,5 @@ declare global {
         }
     }
 }
-export {};
+
+export { type MatchScreenshotArgs, matchScreenshot };

package/dist/match-screenshot.js

@@ -1,81 +1,120 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchScreenshot = void 0;
-const PREFIX_DIFFERENTIATOR = '___';
-const SUFFIX_TEST_IDENTIFIER = '.spec.ts';
-const SCREENSHOTS_FOLDER_NAME = 'screenshots';
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// match-screenshot.ts
+var match_screenshot_exports = {};
+__export(match_screenshot_exports, {
+  matchScreenshot: () => matchScreenshot
+});
+module.exports = __toCommonJS(match_screenshot_exports);
+var PREFIX_DIFFERENTIATOR = "___";
+var SUFFIX_TEST_IDENTIFIER = ".spec.ts";
+var SCREENSHOTS_FOLDER_NAME = "screenshots";
 function forceFont() {
-    const iframe = window.parent.document.querySelector('iframe');
-    const contentDocument = iframe && iframe.contentDocument;
-    if (contentDocument) {
-        const style = contentDocument.createElement('style');
-        style.type = 'text/css';
-        style.appendChild(contentDocument.createTextNode('* { font-family: Arial !important; }'));
-        contentDocument.head.appendChild(style);
-        return style;
-    }
-    return false;
+  const iframe = window.parent.document.querySelector("iframe");
+  const contentDocument = iframe && iframe.contentDocument;
+  if (contentDocument) {
+    const style = contentDocument.createElement("style");
+    style.type = "text/css";
+    style.appendChild(
+      contentDocument.createTextNode("* { font-family: Arial !important; }")
+    );
+    contentDocument.head.appendChild(style);
+    return style;
+  }
+  return false;
 }
 function getTestFolderPathFromScripts(rawName) {
-    const relativeTestPath = Cypress.spec.relative;
-    if (!relativeTestPath) {
-        throw new Error('❌ Could not find matching script in the Cypress DOM to infer the test folder path');
-    }
-    const currentTestNumber = Cypress.mocha.getRunner().currentRunnable?.order;
-    if (!rawName &&
-        typeof currentTestNumber === 'number' &&
-        currentTestNumber > 1) {
-        throw new Error('❌ The rawName argument was not provided to matchScreenshot and is required for test files containing multiple tests!');
-    }
-    const testName = relativeTestPath.substring(relativeTestPath.lastIndexOf('/') + 1, relativeTestPath.lastIndexOf(SUFFIX_TEST_IDENTIFIER));
-    const name = rawName || testName;
-    const screenshotsFolder = `${SCREENSHOTS_FOLDER_NAME}/${relativeTestPath.substring(0, relativeTestPath.lastIndexOf(testName))}${name}`;
-    return {
-        name,
-        screenshotsFolder
-    };
+  const relativeTestPath = Cypress.spec.relative;
+  if (!relativeTestPath) {
+    throw new Error(
+      "\u274C Could not find matching script in the Cypress DOM to infer the test folder path"
+    );
+  }
+  const currentTestNumber = Cypress.mocha.getRunner().currentRunnable?.order;
+  if (!rawName && typeof currentTestNumber === "number" && currentTestNumber > 1) {
+    throw new Error(
+      "\u274C The rawName argument was not provided to matchScreenshot and is required for test files containing multiple tests!"
+    );
+  }
+  const testName = relativeTestPath.substring(
+    relativeTestPath.lastIndexOf("/") + 1,
+    relativeTestPath.lastIndexOf(SUFFIX_TEST_IDENTIFIER)
+  );
+  const name = rawName || testName;
+  const screenshotsFolder = `${SCREENSHOTS_FOLDER_NAME}/${relativeTestPath.substring(
+    0,
+    relativeTestPath.lastIndexOf(testName)
+  )}${name}`;
+  return {
+    name,
+    screenshotsFolder
+  };
 }
 function verifyImages() {
-    if (Cypress.$('img:visible').length > 0) {
-        cy.document()
-            .its('body')
-            .find('img')
-            .filter(':visible')
-            .then(images => {
-            if (images) {
-                cy.wrap(images).each($img => {
-                    cy.wrap($img).should('exist').and('have.prop', 'naturalWidth');
-                });
-            }
+  if (Cypress.$("img:visible").length > 0) {
+    cy.document().its("body").find("img").filter(":visible").then((images) => {
+      if (images) {
+        cy.wrap(images).each(($img) => {
+          cy.wrap($img).should("exist").and("have.prop", "naturalWidth");
         });
-    }
+      }
+    });
+  }
 }
 function matchScreenshot(subject, args) {
-    const { rawName, options = {} } = args || {};
-    // Set up screen
-    forceFont();
-    // Making sure each image is visible before taking screenshots
-    verifyImages();
-    const { name, screenshotsFolder } = getTestFolderPathFromScripts(rawName);
-    cy.task('baseExists', screenshotsFolder).then(hasBase => {
-        const target = subject ? cy.wrap(subject) : cy;
-        // For easy slicing of path ignoring the root screenshot folder
-        target.screenshot(`${PREFIX_DIFFERENTIATOR}${screenshotsFolder}/new`, options);
-        if (!hasBase) {
-            cy.task('log', `✅ A new base image was created for ${name}. Create this as a new base image via Comparadise!`);
-            return null;
-        }
-        cy.task('compareScreenshots', screenshotsFolder).then(diffPixels => {
-            if (diffPixels === 0) {
-                cy.log(`✅ Actual image of ${name} was the same as base`);
-            }
-            else {
-                cy.task('log', `❌ Actual image of ${name} differed by ${diffPixels} pixels.`);
-            }
-            return null;
-        });
-        return null;
+  const { rawName, options = {} } = args || {};
+  forceFont();
+  verifyImages();
+  const { name, screenshotsFolder } = getTestFolderPathFromScripts(rawName);
+  cy.task("baseExists", screenshotsFolder).then((hasBase) => {
+    const target = subject ? cy.wrap(subject) : cy;
+    target.screenshot(
+      `${PREFIX_DIFFERENTIATOR}${screenshotsFolder}/new`,
+      options
+    );
+    if (!hasBase) {
+      cy.task(
+        "log",
+        `\u2705 A new base image was created for ${name}. Create this as a new base image via Comparadise!`
+      );
+      return null;
+    }
+    cy.task("compareScreenshots", screenshotsFolder).then((diffPixels) => {
+      if (diffPixels === 0) {
+        cy.log(`\u2705 Actual image of ${name} was the same as base`);
+      } else {
+        throw new Error(
+          `\u274C Actual image of ${name} differed by ${diffPixels} pixels.`
+        );
+      }
+      return null;
     });
+    return null;
+  });
 }
-exports.matchScreenshot = matchScreenshot;
-Cypress.Commands.add('matchScreenshot', { prevSubject: ['optional', 'element', 'window', 'document'] }, matchScreenshot);
+Cypress.Commands.add(
+  "matchScreenshot",
+  { prevSubject: ["optional", "element", "window", "document"] },
+  matchScreenshot
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  matchScreenshot
+});

package/package.json

@@ -22,8 +22,9 @@
   },
   "devDependencies": {
     "@types/pixelmatch": "5.2.6",
-    "@types/pngjs": "6.0.4",
-    "cypress": "13.8.0"
+    "@types/pngjs": "6.0.5",
+    "cypress": "13.8.1",
+    "tsup": "8.0.2"
   },
   "peerDependencies": {
     "cypress": ">=12"
@@ -32,13 +33,12 @@
     "dist",
     "types"
   ],
-  "version": "1.15.1",
+  "version": "1.16.0",
   "scripts": {
-    "build": "tsc && tsc --project tsconfig.types.json",
+    "build": "tsup",
     "bump-version": "pnpm version $NEW_VERSION",
     "lint": "eslint . --max-warnings=0",
-    "postbuild": "echo \"require('./dist/match-screenshot');\" > commands.js && echo \"export {};\" > types/index.js",
-    "prebuild": "rm -rf dist types",
+    "postbuild": "echo \"require('./dist/match-screenshot');\" > commands.js",
     "test": "exit 0"
   }
 }

package/dist/files.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createImageFileName = void 0;
-/**
- * Creates a file path that is relative to the root
- * @param {string} type - Value to append to fileName
- * @param {string} path - (optional) FileName which corresponds to a module Id
- * returns a string of just the prefix or the fileName prepended by the prefix
- */
-function createImageFileName(path, type) {
-    let newPath = path;
-    if (path.startsWith('/')) {
-        newPath = `.${path}`;
-    }
-    return `${newPath}/${type}.png`;
-}
-exports.createImageFileName = createImageFileName;

package/dist/images.js

@@ -1,102 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDiffPixels = void 0;
-const fs = __importStar(require("fs"));
-const pngjs_1 = require("pngjs");
-const pixelmatch_1 = __importDefault(require("pixelmatch"));
-const PIXELMATCH_OPTIONS = {
-    threshold: 0.3
-};
-/**
- * Helper function to create reusable image resizer
- */
-const createImageResizer = (width, height) => (source) => {
-    const resized = new pngjs_1.PNG({ width, height, fill: true });
-    pngjs_1.PNG.bitblt(source, resized, 0, 0, source.width, source.height, 0, 0);
-    return resized;
-};
-/**
- * Fills new area added after resize with transparent black color.
- * I like idea of checker board pattern, but it seems to be too complicated
- * to implement considering how low-level pngjs API is.
- */
-const fillSizeDifference = (width, height) => (image) => {
-    const inArea = (x, y) => y > height || x > width;
-    for (let y = 0; y < image.height; y++) {
-        for (let x = 0; x < image.width; x++) {
-            if (inArea(x, y)) {
-                const idx = (image.width * y + x) << 2;
-                image.data[idx] = 0;
-                image.data[idx + 1] = 0;
-                image.data[idx + 2] = 0;
-                image.data[idx + 3] = 64;
-            }
-        }
-    }
-    return image;
-};
-/**
- * Aligns images sizes to biggest common value
- * and fills new pixels with transparent pixels
- */
-function alignImagesToSameSize(firstImage, secondImage) {
-    // Keep original sizes to fill extended area later
-    const firstImageWidth = firstImage.width;
-    const firstImageHeight = firstImage.height;
-    const secondImageWidth = secondImage.width;
-    const secondImageHeight = secondImage.height;
-    // Calculate biggest common values
-    const resizeToSameSize = createImageResizer(Math.max(firstImageWidth, secondImageWidth), Math.max(firstImageHeight, secondImageHeight));
-    // Resize both images
-    const resizedFirst = resizeToSameSize(firstImage);
-    const resizedSecond = resizeToSameSize(secondImage);
-    // Fill resized area with black transparent pixels
-    return [
-        fillSizeDifference(firstImageWidth, firstImageHeight)(resizedFirst),
-        fillSizeDifference(secondImageWidth, secondImageHeight)(resizedSecond)
-    ];
-}
-/**
- * Compares a base and new image and returns the pixel difference
- * and diff PNG for writing the diff image to.
- * @param {string} basePath - Full file path to base image
- * @param {string} actualPath - Full file path to new image
- */
-function getDiffPixels(basePath, actualPath) {
-    const rawBase = pngjs_1.PNG.sync.read(fs.readFileSync(basePath));
-    const rawActual = pngjs_1.PNG.sync.read(fs.readFileSync(actualPath));
-    const hasSizeMismatch = rawBase.height !== rawActual.height || rawBase.width !== rawActual.width;
-    const [base, actual] = hasSizeMismatch
-        ? alignImagesToSameSize(rawBase, rawActual)
-        : [rawBase, rawActual];
-    const diff = new pngjs_1.PNG({ width: base.width, height: base.height });
-    const diffPixels = (0, pixelmatch_1.default)(actual.data, base.data, diff.data, diff.width, diff.height, PIXELMATCH_OPTIONS);
-    return { diffPixels, diff };
-}
-exports.getDiffPixels = getDiffPixels;

package/dist/screenshots.js

@@ -1,118 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.onAfterScreenshot = exports.compareScreenshots = exports.baseExists = void 0;
-const fs = __importStar(require("fs"));
-const pngjs_1 = require("pngjs");
-const images_1 = require("./images");
-const files_1 = require("./files");
-/**
- * Checks if a base image exists
- * @param path - Folder path where you can find the base.png image
- * @returns true if path/base.png exists, false if not.
- */
-function baseExists(path) {
-    const fileName = (0, files_1.createImageFileName)(path, 'base');
-    const exists = fs.existsSync(fileName);
-    if (!exists) {
-        console.log('Base image does not exist. This means a new one will be created. If your base should exist, something went wrong.');
-    }
-    return exists;
-}
-exports.baseExists = baseExists;
-/**
- * Runs a visual regression test.
- * @param screenshotFolder - Full screenshots folder where the base/new/diff
- *                           images will be compared and written to.
- */
-function compareScreenshots(screenshotFolder) {
-    const basePath = (0, files_1.createImageFileName)(screenshotFolder, 'base');
-    const actualPath = (0, files_1.createImageFileName)(screenshotFolder, 'new');
-    const { diffPixels, diff } = (0, images_1.getDiffPixels)(basePath, actualPath);
-    if (diffPixels) {
-        // Create diff.png next to base and new for review
-        fs.writeFile((0, files_1.createImageFileName)(screenshotFolder, 'diff'), pngjs_1.PNG.sync.write(diff), err => {
-            if (err) {
-                console.error('❌ Diff exists but unable to create diff.png', err);
-            }
-        });
-    }
-    else {
-        // Delete created new.png. Not needed if there's no diff
-        fs.unlink(actualPath, err => {
-            if (err) {
-                console.error('❌ No diff but unable to delete actualPath}', err);
-            }
-        });
-    }
-    return diffPixels;
-}
-exports.compareScreenshots = compareScreenshots;
-const trimPostfix = (path) => {
-    const imgExt = '.png';
-    const attemptPostfixRegex = new RegExp(`\\s\\(attempt \\d+\\)${imgExt}$`);
-    if (attemptPostfixRegex.test(path)) {
-        return path.replace(attemptPostfixRegex, imgExt);
-    }
-    return path;
-};
-const getNewPath = (path) => {
-    let newPath = path.slice(path.lastIndexOf('___') + 3);
-    console.log(newPath);
-    if (newPath.startsWith('/')) {
-        newPath = `.${newPath}`;
-    }
-    return trimPostfix(newPath);
-};
-/**
- * Renames all root cypress screenshots to where the test was actually run.
- * Should NOT be used standalone. Works with the matchScreenshot task.
- * @param {Cypress.ScreenshotDetails} details
- */
-function onAfterScreenshot(details) {
-    console.log('🧸 Screenshot was saved to:', details.path);
-    if (!details.path.match('cypress')) {
-        return Promise.resolve({});
-    }
-    const newPath = getNewPath(details.path);
-    const newPathDir = newPath.substring(0, newPath.lastIndexOf('/'));
-    try {
-        fs.mkdirSync(newPathDir, { recursive: true });
-    }
-    catch (err) {
-        console.error('❌ Error creating new screenshot folder:', newPathDir, err);
-    }
-    return new Promise((resolve, reject) => {
-        fs.rename(details.path, newPath, err => {
-            if (err) {
-                reject(err);
-            }
-            // because we renamed/moved the image, resolve with the new path
-            // so it is accurate in the test results
-            resolve({ path: newPath });
-        });
-    });
-}
-exports.onAfterScreenshot = onAfterScreenshot;

package/types/files.d.ts

@@ -1,7 +0,0 @@
-/**
- * Creates a file path that is relative to the root
- * @param {string} type - Value to append to fileName
- * @param {string} path - (optional) FileName which corresponds to a module Id
- * returns a string of just the prefix or the fileName prepended by the prefix
- */
-export declare function createImageFileName(path: string, type: string): string;

package/types/images.d.ts

@@ -1,11 +0,0 @@
-import { PNG } from 'pngjs';
-/**
- * Compares a base and new image and returns the pixel difference
- * and diff PNG for writing the diff image to.
- * @param {string} basePath - Full file path to base image
- * @param {string} actualPath - Full file path to new image
- */
-export declare function getDiffPixels(basePath: string, actualPath: string): {
-    diffPixels: number;
-    diff: PNG;
-};

package/types/index.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="cypress" />
-import { MatchScreenshotArgs } from './match-screenshot';
-export declare function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions): Cypress.PluginConfigOptions;
-declare global {
-    namespace Cypress {
-        interface Chainable {
-            matchScreenshot(args?: MatchScreenshotArgs): Chainable;
-        }
-    }
-}

package/types/index.js

@@ -1 +0,0 @@
-export {};

package/types/screenshots.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="cypress" />
-/**
- * Checks if a base image exists
- * @param path - Folder path where you can find the base.png image
- * @returns true if path/base.png exists, false if not.
- */
-export declare function baseExists(path: string): boolean;
-/**
- * Runs a visual regression test.
- * @param screenshotFolder - Full screenshots folder where the base/new/diff
- *                           images will be compared and written to.
- */
-export declare function compareScreenshots(screenshotFolder: string): number;
-/**
- * Renames all root cypress screenshots to where the test was actually run.
- * Should NOT be used standalone. Works with the matchScreenshot task.
- * @param {Cypress.ScreenshotDetails} details
- */
-export declare function onAfterScreenshot(details: Cypress.ScreenshotDetails): Promise<Cypress.AfterScreenshotReturnObject>;