comparadise-utils 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { MatchScreenshotArgs } from './src/match-screenshot';
+export { setupVisualTests } from './src/setup-visual-tests';
+export {};
+declare global {
+    namespace Cypress {
+        interface Chainable {
+            matchScreenshot(args?: MatchScreenshotArgs): Chainable;
+        }
+    }
+}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupVisualTests = void 0;
+const match_screenshot_1 = require("./src/match-screenshot");
+var setup_visual_tests_1 = require("./src/setup-visual-tests");
+Object.defineProperty(exports, "setupVisualTests", { enumerable: true, get: function () { return setup_visual_tests_1.setupVisualTests; } });
+Cypress.Commands.add('matchScreenshot', { prevSubject: ['optional', 'element', 'window', 'document'] }, match_screenshot_1.matchScreenshot);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,6DAA8E;AAC9E,+DAA4D;AAAnD,sHAAA,gBAAgB,OAAA;AAWzB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,WAAW,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,kCAAe,CAAC,CAAC"}

package/dist/src/files.d.ts

@@ -0,0 +1 @@
+export declare function createImageFileName(path: string, type: string): string;

package/dist/src/files.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createImageFileName = void 0;
+function createImageFileName(path, type) {
+    let newPath = path;
+    if (path.startsWith('/')) {
+        newPath = `.${path}`;
+    }
+    return `${newPath}/${type}.png`;
+}
+exports.createImageFileName = createImageFileName;
+//# sourceMappingURL=files.js.map

package/dist/src/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/files.ts"],"names":[],"mappings":";;;AAAA,SAAgB,mBAAmB,CAAC,IAAY,EAAE,IAAY;IAC5D,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;KACtB;IACD,OAAO,GAAG,OAAO,IAAI,IAAI,MAAM,CAAC;AAClC,CAAC;AAND,kDAMC"}

package/dist/src/images.d.ts

@@ -0,0 +1,5 @@
+import { PNG } from 'pngjs';
+export declare function getDiffPixels(basePath: string, actualPath: string): {
+    diffPixels: number;
+    diff: PNG;
+};

package/dist/src/images.js

@@ -0,0 +1,83 @@
+"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
+};
+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;
+};
+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;
+};
+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)
+    ];
+}
+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;
+//# sourceMappingURL=images.js.map

package/dist/src/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../../src/images.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,iCAA4B;AAC5B,4DAAoC;AAEpC,MAAM,kBAAkB,GAAG;IACzB,SAAS,EAAE,GAAG;CACf,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,MAAc,EAAE,EAAE,CAAC,CAAC,MAAW,EAAE,EAAE;IAC5E,MAAM,OAAO,GAAG,IAAI,WAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,WAAG,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrE,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,MAAc,EAAE,EAAE,CAAC,CAAC,KAAU,EAAE,EAAE;IAC3E,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC;IACjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACpC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;gBAChB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;gBACvC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpB,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;gBACxB,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;aAC1B;SACF;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,SAAS,qBAAqB,CAAC,UAAe,EAAE,WAAgB;IAC9D,kDAAkD;IAClD,MAAM,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC;IACzC,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC;IAC3C,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC;IAC3C,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAAC;IAC7C,kCAAkC;IAClC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,gBAAgB,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACxI,qBAAqB;IACrB,MAAM,YAAY,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACpD,kDAAkD;IAClD,OAAO;QACL,kBAAkB,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC,YAAY,CAAC;QACnE,kBAAkB,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,aAAa,CAAC;KACvE,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAAC,QAAgB,EAAE,UAAkB;IAChE,MAAM,OAAO,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;IAE7D,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,CAAC;IAEjG,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE1G,MAAM,IAAI,GAAG,IAAI,WAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjE,MAAM,UAAU,GAAG,IAAA,oBAAU,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAE9G,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;AAC9B,CAAC;AAbD,sCAaC"}

package/dist/src/match-screenshot.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="cypress" />
+export type MatchScreenshotArgs = {
+    rawName?: string;
+    options?: Partial<Cypress.ScreenshotOptions>;
+};
+export declare function matchScreenshot(subject: Cypress.JQueryWithSelector | Window | Document | void, args?: MatchScreenshotArgs): void;

package/dist/src/match-screenshot.js

@@ -0,0 +1,73 @@
+"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';
+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 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');
+                });
+            }
+        });
+    }
+}
+function forceFont() {
+    const iframe = window.parent.document.querySelector('iframe');
+    const contentDocument = 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);
+    }
+}
+function matchScreenshot(subject, args) {
+    const { rawName, options = {} } = args ?? {};
+    forceFont();
+    verifyImages();
+    const { name, screenshotsFolder } = getTestFolderPathFromScripts(rawName);
+    cy.task('baseExists', screenshotsFolder).then(hasBase => {
+        const type = 'new';
+        const target = subject ? cy.wrap(subject) : cy;
+        // For easy slicing of path ignoring the root screenshot folder
+        target.screenshot(`${PREFIX_DIFFERENTIATOR}${screenshotsFolder}/${type}`, options);
+        if (!hasBase) {
+            cy.task('createNewScreenshot', screenshotsFolder).then(() => {
+                cy.task('log', `❌A new base image was created for ${name}. Create this as a new base image via Comparadise!`);
+            });
+        }
+        cy.task('compareScreenshots', screenshotsFolder).then(diffPixels => {
+            if (diffPixels === 0) {
+                cy.log(`✅Actual image of ${name} was the same as base`);
+                return null;
+            }
+            const screenshotUrl = Cypress.env('BUILD_URL') ? `${Cypress.env('BUILD_URL')}artifact/${screenshotsFolder}` : screenshotsFolder;
+            throw new Error(`❌Actual image of ${name} differed by ${diffPixels} pixels.
+             See the diff image for more details >>  ${screenshotUrl}/diff.png`);
+        });
+        return null;
+    });
+}
+exports.matchScreenshot = matchScreenshot;
+//# sourceMappingURL=match-screenshot.js.map

package/dist/src/match-screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"match-screenshot.js","sourceRoot":"","sources":["../../src/match-screenshot.ts"],"names":[],"mappings":";;;AAAA,MAAM,qBAAqB,GAAG,KAAK,CAAC;AACpC,MAAM,sBAAsB,GAAG,UAAU,CAAC;AAC1C,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAE9C,SAAS,4BAA4B,CAAC,OAAgB;IACpD,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;IAE/C,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;KACtG;IAED,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACzI,MAAM,IAAI,GAAG,OAAO,IAAI,QAAQ,CAAC;IAEjC,MAAM,iBAAiB,GAAG,GAAG,uBAAuB,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;IAEvI,OAAO;QACL,IAAI;QACJ,iBAAiB;KAClB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY;IACnB,IAAI,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,EAAE,CAAC,QAAQ,EAAE;aACV,GAAG,CAAC,MAAM,CAAC;aACX,IAAI,CAAC,KAAK,CAAC;aACX,MAAM,CAAC,UAAU,CAAC;aAClB,IAAI,CAAC,MAAM,CAAC,EAAE;YACb,IAAI,MAAM,EAAE;gBACV,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBAC1B,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;gBACjE,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;KACN;AACH,CAAC;AAED,SAAS,SAAS;IAChB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAG,MAAM,EAAE,eAAe,CAAC;IAEhD,IAAI,eAAe,EAAE;QACnB,MAAM,KAAK,GAAG,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACrD,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;QACxB,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC,cAAc,CAAC,sCAAsC,CAAC,CAAC,CAAC;QAC1F,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;KACzC;AACH,CAAC;AAOD,SAAgB,eAAe,CAAC,OAA8D,EAAE,IAA0B;IACxH,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7C,SAAS,EAAE,CAAC;IACZ,YAAY,EAAE,CAAC;IAEf,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;IAE1E,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QACtD,MAAM,IAAI,GAAG,KAAK,CAAC;QACnB,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,+DAA+D;QAC/D,MAAM,CAAC,UAAU,CAAC,GAAG,qBAAqB,GAAG,iBAAiB,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAEnF,IAAI,CAAC,OAAO,EAAE;YACZ,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC1D,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,qCAAqC,IAAI,oDAAoD,CAAC,CAAC;YAChH,CAAC,CAAC,CAAC;SACJ;QAED,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACjE,IAAI,UAAU,KAAK,CAAC,EAAE;gBACpB,EAAE,CAAC,GAAG,CAAC,oBAAoB,IAAI,uBAAuB,CAAC,CAAC;gBAExD,OAAO,IAAI,CAAC;aACb;YAED,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,iBAAiB,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC;YAEhI,MAAM,IAAI,KAAK,CACb,oBAAoB,IAAI,gBAAgB,UAAU;uDACH,aAAa,WAAW,CACxE,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AApCD,0CAoCC"}

package/dist/src/on-after-screenshot.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="cypress" />
+export declare function onAfterScreenshot(details: Cypress.ScreenshotDetails): Promise<Cypress.AfterScreenshotReturnObject>;

package/dist/src/on-after-screenshot.js

@@ -0,0 +1,62 @@
+"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 = void 0;
+const fs = __importStar(require("fs"));
+function onAfterScreenshot(details) {
+    console.log('🧸 Screenshot was saved to:', details.path);
+    if (!details.specName.includes('visual')) {
+        return Promise.resolve({});
+    }
+    const getNewPath = (path) => {
+        let newPath = path.slice(path.lastIndexOf('___') + 3);
+        console.log(newPath);
+        if (newPath.startsWith('/')) {
+            newPath = `.${newPath}`;
+        }
+        return newPath;
+    };
+    const newPath = getNewPath(details.path);
+    const newPathDir = newPath.substring(0, newPath.lastIndexOf('/'));
+    try {
+        fs.mkdirSync(newPathDir, { recursive: true });
+        console.log('🧸 No screenshot folder found in the package. Created new screenshot folder:', newPathDir);
+    }
+    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;
+//# sourceMappingURL=on-after-screenshot.js.map

package/dist/src/on-after-screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-after-screenshot.js","sourceRoot":"","sources":["../../src/on-after-screenshot.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AAEzB,SAAgB,iBAAiB,CAAC,OAAkC;IAClE,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACxC,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;KAC5B;IAED,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE;QAClC,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAErB,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC3B,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;SACzB;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAElE,IAAI;QACF,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,CAAC,8EAA8E,EAAE,UAAU,CAAC,CAAC;KACzG;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;KAC3E;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE;YACrC,IAAI,GAAG,EAAE;gBACP,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;YAED,gEAAgE;YAChE,wCAAwC;YACxC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAtCD,8CAsCC"}

package/dist/src/screenshots.d.ts

@@ -0,0 +1,3 @@
+export declare function baseExists(path: string): boolean;
+export declare function createNewScreenshot(screenshotFolder: string): null;
+export declare function compareScreenshots(screenshotFolder: string): number;

package/dist/src/screenshots.js

@@ -0,0 +1,73 @@
+"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.compareScreenshots = exports.createNewScreenshot = exports.baseExists = void 0;
+const fs = __importStar(require("fs"));
+const pngjs_1 = require("pngjs");
+const images_1 = require("./images");
+const files_1 = require("./files");
+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;
+function createNewScreenshot(screenshotFolder) {
+    const newImage = pngjs_1.PNG.sync.read(fs.readFileSync((0, files_1.createImageFileName)(screenshotFolder, 'new')));
+    fs.writeFile((0, files_1.createImageFileName)(screenshotFolder, 'new'), pngjs_1.PNG.sync.write(newImage), err => {
+        if (err) {
+            console.error('❌Unable to create new.png', err);
+        }
+    });
+    return null;
+}
+exports.createNewScreenshot = createNewScreenshot;
+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 deleteactualPath}', err);
+            }
+        });
+    }
+    return diffPixels;
+}
+exports.compareScreenshots = compareScreenshots;
+//# sourceMappingURL=screenshots.js.map

package/dist/src/screenshots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshots.js","sourceRoot":"","sources":["../../src/screenshots.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,iCAA4B;AAC5B,qCAAyC;AACzC,mCAA8C;AAE9C,SAAgB,UAAU,CAAC,IAAY;IACrC,MAAM,QAAQ,GAAG,IAAA,2BAAmB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,mHAAmH,CAAC,CAAC;KAClI;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,gCAQC;AAED,SAAgB,mBAAmB,CAAC,gBAAwB;IAC1D,MAAM,QAAQ,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAA,2BAAmB,EAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9F,EAAE,CAAC,SAAS,CAAC,IAAA,2BAAmB,EAAC,gBAAgB,EAAE,KAAK,CAAC,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE;QACzF,IAAI,GAAG,EAAE;YACP,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;SACjD;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED,SAAgB,kBAAkB,CAAC,gBAAwB;IACzD,MAAM,QAAQ,GAAG,IAAA,2BAAmB,EAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC/D,MAAM,UAAU,GAAG,IAAA,2BAAmB,EAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IAChE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAA,sBAAa,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAEjE,IAAI,UAAU,EAAE;QACd,kDAAkD;QAClD,EAAE,CAAC,SAAS,CAAC,IAAA,2BAAmB,EAAC,gBAAgB,EAAE,MAAM,CAAC,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE;YACtF,IAAI,GAAG,EAAE;gBACP,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,GAAG,CAAC,CAAC;aAClE;QACH,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,wDAAwD;QACxD,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE;YAC1B,IAAI,GAAG,EAAE;gBACP,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,GAAG,CAAC,CAAC;aAChE;QACH,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAtBD,gDAsBC"}

package/dist/src/setup-visual-tests.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="cypress" />
+export declare function setupVisualTests(on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions): Cypress.PluginConfigOptions;

package/dist/src/setup-visual-tests.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupVisualTests = void 0;
+const on_after_screenshot_1 = require("./on-after-screenshot");
+const screenshots_1 = require("./screenshots");
+function setupVisualTests(on, config) {
+    on('after:screenshot', on_after_screenshot_1.onAfterScreenshot);
+    on('task', {
+        baseExists: screenshots_1.baseExists,
+        compareScreenshots: screenshots_1.compareScreenshots,
+        createNewScreenshot: screenshots_1.createNewScreenshot,
+        log: (message) => {
+            console.log(message);
+            return null;
+        }
+    });
+    return config;
+}
+exports.setupVisualTests = setupVisualTests;
+//# sourceMappingURL=setup-visual-tests.js.map

package/dist/src/setup-visual-tests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-visual-tests.js","sourceRoot":"","sources":["../../src/setup-visual-tests.ts"],"names":[],"mappings":";;;AAAA,+DAA0D;AAC1D,+CAAoF;AAEpF,SAAgB,gBAAgB,CAAC,EAAwB,EAAE,MAAmC;IAC5F,EAAE,CAAC,kBAAkB,EAAE,uCAAiB,CAAC,CAAC;IAC1C,EAAE,CAAC,MAAM,EAAE;QACT,UAAU,EAAV,wBAAU;QACV,kBAAkB,EAAlB,gCAAkB;QAClB,mBAAmB,EAAnB,iCAAmB;QACnB,GAAG,EAAE,CAAC,OAAe,EAAE,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,4CAaC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "comparadise-utils",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ExpediaGroup/comparadise.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ExpediaGroup/comparadise/issues"
+  },
+  "dependencies": {
+    "pixelmatch": "5.3.0",
+    "pngjs": "7.0.0"
+  },
+  "peerDependencies": {
+    "cypress": ">=12"
+  },
+  "devDependencies": {
+    "@types/pixelmatch": "5.2.4",
+    "@types/pngjs": "6.0.1"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "version": "0.0.1"
+}