@applitools/eyes-cypress 3.24.0-beta.5 → 3.25.0

package/bin/eyes-setup.js

@@ -1,21 +1,21 @@
-#!/usr/bin/env node
-'use strict';
-
-const chalk = require('chalk');
-const handlePlugin = require('../src/setup/handlePlugin');
-const handleCommands = require('../src/setup/handleCommands');
-const handleTypeScript = require('../src/setup/handleTypeScript');
-const {version} = require('../package');
-const cwd = process.cwd();
-
-console.log(chalk.cyan('Setup eyes-cypress', version));
-
-try {
-  handlePlugin(cwd);
-  handleCommands(cwd);
-  handleTypeScript(cwd);
-} catch (e) {
-  console.log(chalk.red('Setup error:\n', e));
-}
-
-console.log(chalk.cyan('Setup done!'));
+#!/usr/bin/env node
+'use strict';
+
+const chalk = require('chalk');
+const handlePlugin = require('../src/setup/handlePlugin');
+const handleCommands = require('../src/setup/handleCommands');
+const handleTypeScript = require('../src/setup/handleTypeScript');
+const {version} = require('../package');
+const cwd = process.cwd();
+
+console.log(chalk.cyan('Setup eyes-cypress', version));
+
+try {
+  handlePlugin(cwd);
+  handleCommands(cwd);
+  handleTypeScript(cwd);
+} catch (e) {
+  console.log(chalk.red('Setup error:\n', e));
+}
+
+console.log(chalk.cyan('Setup done!'));

package/commands.js

@@ -1,2 +1,2 @@
-'use strict';
-require('./src/browser/commands');
+'use strict';
+require('./src/browser/commands');

package/dist/browser/spec-driver.js

@@ -1,106 +1,110 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
-function executeScript(context, script, arg) {
-    context = refreshContext(context);
-    let scriptToExecute;
-    if (script.includes('dom-snapshot') ||
-        script.includes('dom-capture') ||
-        script.includes('dom-shared')) {
-        scriptToExecute = script;
-    }
-    else {
-        const prepScirpt = script.replace('function(arg)', 'function func(arg)');
-        scriptToExecute = prepScirpt.concat(' return func(arg)');
-    }
-    const executor = new context.defaultView.Function('arg', scriptToExecute);
-    return executor(arg);
-}
-exports.executeScript = executeScript;
-function mainContext() {
-    //@ts-ignore
-    return cy.state('window').document;
-}
-exports.mainContext = mainContext;
-function parentContext(context) {
-    if (!context)
-        return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
-    return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
-}
-exports.parentContext = parentContext;
-function childContext(_context, element) {
-    return element.contentDocument; // null in case of cross origin iframe
-}
-exports.childContext = childContext;
-function getViewportSize() {
-    //@ts-ignore
-    const currWindow = cy.state('window');
-    const viewportSize = {
-        width: Math.max(currWindow.document.documentElement.clientWidth || 0, currWindow.innerWidth || 0),
-        height: Math.max(currWindow.document.documentElement.clientHeight || 0, currWindow.innerHeight || 0)
-    };
-    return viewportSize;
-}
-exports.getViewportSize = getViewportSize;
-function setViewportSize(vs) {
-    //@ts-ignore
-    Cypress.action('cy:viewport:changed', { viewportWidth: vs.size.width, viewportHeight: vs.size.height });
-}
-exports.setViewportSize = setViewportSize;
-function transformSelector(selector) {
-    if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || selector.type === 'css')) {
-        return selector.selector;
-    }
-    return selector;
-}
-exports.transformSelector = transformSelector;
-function findElement(context, selector, parent) {
-    context = refreshContext(context);
-    const eyesSelector = selector;
-    const root = parent !== null && parent !== void 0 ? parent : context;
-    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
-    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
-        return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
-    }
-    else {
-        return root.querySelector(sel);
-    }
-}
-exports.findElement = findElement;
-function findElements(context, selector, parent) {
-    context = refreshContext(context);
-    const eyesSelector = selector;
-    const root = parent !== null && parent !== void 0 ? parent : context;
-    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
-    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
-        // TODO return multiple
-        return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
-    }
-    else {
-        return root.querySelectorAll(sel);
-    }
-}
-exports.findElements = findElements;
-function getTitle(context) {
-    context = refreshContext(context);
-    return context.title;
-}
-exports.getTitle = getTitle;
-function getUrl(context) {
-    context = refreshContext(context);
-    return context.location.href;
-}
-exports.getUrl = getUrl;
-function getCookies() {
-    //@ts-ignore
-    return Cypress.automation('get:cookies', {});
-}
-exports.getCookies = getCookies;
-// we need to method to reset the context in case the user called open before visit
-function refreshContext(context) {
-    //@ts-ignore
-    return (context && context.defaultView) ? context : cy.state('window').document;
-}
-// export function takeScreenshot(page: Driver): Promise<Buffer>;
-// export function visit(page: Driver, url: string): Promise<void>; (??)
-// export function isStaleElementError(err: any): boolean;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCookies = exports.getUrl = exports.getTitle = exports.findElements = exports.findElement = exports.transformSelector = exports.setViewportSize = exports.getViewportSize = exports.childContext = exports.parentContext = exports.mainContext = exports.executeScript = void 0;
+function executeScript(context, script, arg) {
+    context = refreshContext(context);
+    let scriptToExecute;
+    if (script.includes('dom-snapshot') ||
+        script.includes('dom-capture') ||
+        script.includes('dom-shared')) {
+        scriptToExecute = script;
+    }
+    else {
+        const prepScirpt = script.replace('function(arg)', 'function func(arg)');
+        scriptToExecute = prepScirpt.concat(' return func(arg)');
+    }
+    const executor = new context.defaultView.Function('arg', scriptToExecute);
+    return executor(arg);
+}
+exports.executeScript = executeScript;
+function mainContext() {
+    //@ts-ignore
+    return cy.state('window').document;
+}
+exports.mainContext = mainContext;
+function parentContext(context) {
+    if (!context)
+        return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+    return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument;
+}
+exports.parentContext = parentContext;
+function childContext(_context, element) {
+    return element.contentDocument; // null in case of cross origin iframe
+}
+exports.childContext = childContext;
+function getViewportSize() {
+    //@ts-ignore
+    const currWindow = cy.state('window');
+    const viewportSize = {
+        width: Math.max(currWindow.document.documentElement.clientWidth || 0, currWindow.innerWidth || 0),
+        height: Math.max(currWindow.document.documentElement.clientHeight || 0, currWindow.innerHeight || 0)
+    };
+    return viewportSize;
+}
+exports.getViewportSize = getViewportSize;
+function setViewportSize(vs) {
+    //@ts-ignore
+    Cypress.action('cy:viewport:changed', { viewportWidth: vs.size.width, viewportHeight: vs.size.height });
+}
+exports.setViewportSize = setViewportSize;
+function transformSelector(selector) {
+    if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || selector.type === 'css')) {
+        return selector.selector;
+    }
+    return selector;
+}
+exports.transformSelector = transformSelector;
+function findElement(context, selector, parent) {
+    context = refreshContext(context);
+    const eyesSelector = selector;
+    const root = parent !== null && parent !== void 0 ? parent : context;
+    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
+    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
+        return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+    }
+    else {
+        return root.querySelector(sel);
+    }
+}
+exports.findElement = findElement;
+function findElements(context, selector, parent) {
+    context = refreshContext(context);
+    const eyesSelector = selector;
+    const root = parent !== null && parent !== void 0 ? parent : context;
+    const sel = typeof selector === 'string' ? selector : eyesSelector.selector;
+    if (typeof selector !== 'string' && eyesSelector.type === 'xpath') {
+        const results = [];
+        const queryResult = document.evaluate(sel, context, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+        for (let i = 0; i < queryResult.snapshotLength; i++) {
+            results.push(queryResult.snapshotItem(i));
+        }
+        return results;
+    }
+    else {
+        return root.querySelectorAll(sel);
+    }
+}
+exports.findElements = findElements;
+function getTitle(context) {
+    context = refreshContext(context);
+    return context.title;
+}
+exports.getTitle = getTitle;
+function getUrl(context) {
+    context = refreshContext(context);
+    return context.location.href;
+}
+exports.getUrl = getUrl;
+function getCookies() {
+    //@ts-ignore
+    return Cypress.automation('get:cookies', {});
+}
+exports.getCookies = getCookies;
+// we need to method to reset the context in case the user called open before visit
+function refreshContext(context) {
+    //@ts-ignore
+    return (context && context.defaultView) ? context : cy.state('window').document;
+}
+// export function takeScreenshot(page: Driver): Promise<Buffer>;
+// export function visit(page: Driver, url: string): Promise<void>; (??)
+// export function isStaleElementError(err: any): boolean;

package/dist/plugin/handler.js

@@ -1,55 +1,55 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeHandler = void 0;
-const http_1 = require("http");
-const ws_1 = require("ws");
-const { name, version } = require('../../package.json'); // TODO is the handshake needed at all?
-const TOKEN_HEADER = 'x-eyes-universal-token';
-const TOKEN = `${name}@${version}`;
-// TODO make default port 0 and return actual port
-async function makeHandler({ port = 31077, singleton = true, lazy = false } = {}) {
-    const http = new http_1.Server();
-    http.on('request', (request, response) => {
-        if (request.url === '/handshake') {
-            if (request.headers[TOKEN_HEADER] === TOKEN) {
-                response.writeHead(200, { [TOKEN_HEADER]: TOKEN });
-            }
-            else {
-                response.writeHead(400);
-            }
-            response.end();
-        }
-    });
-    http.listen(port, 'localhost');
-    return new Promise((resolve, reject) => {
-        http.on('listening', () => {
-            const ws = new ws_1.Server({ server: http, path: '/eyes' });
-            ws.on('close', () => http.close());
-            resolve({ server: ws, port });
-        });
-        http.on('error', async (err) => {
-            if (!lazy && err.code === 'EADDRINUSE') {
-                if (singleton && (await isHandshakable(port))) {
-                    return resolve({ port });
-                }
-                else {
-                    return resolve(await makeHandler({ port: port + 1, singleton }));
-                }
-            }
-            reject(err);
-        });
-    });
-}
-exports.makeHandler = makeHandler;
-async function isHandshakable(port) {
-    return new Promise(resolve => {
-        const handshake = http_1.request(`http://localhost:${port}/handshake`, {
-            headers: { [TOKEN_HEADER]: TOKEN },
-        });
-        handshake.on('response', ({ statusCode, headers }) => {
-            resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN);
-        });
-        handshake.on('error', () => resolve(false));
-        handshake.end();
-    });
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeHandler = void 0;
+const http_1 = require("http");
+const ws_1 = require("ws");
+const { name, version } = require('../../package.json'); // TODO is the handshake needed at all?
+const TOKEN_HEADER = 'x-eyes-universal-token';
+const TOKEN = `${name}@${version}`;
+// TODO make default port 0 and return actual port
+async function makeHandler({ port = 31077, singleton = true, lazy = false } = {}) {
+    const http = new http_1.Server();
+    http.on('request', (request, response) => {
+        if (request.url === '/handshake') {
+            if (request.headers[TOKEN_HEADER] === TOKEN) {
+                response.writeHead(200, { [TOKEN_HEADER]: TOKEN });
+            }
+            else {
+                response.writeHead(400);
+            }
+            response.end();
+        }
+    });
+    http.listen(port, 'localhost');
+    return new Promise((resolve, reject) => {
+        http.on('listening', () => {
+            const ws = new ws_1.Server({ server: http, path: '/eyes' });
+            ws.on('close', () => http.close());
+            resolve({ server: ws, port });
+        });
+        http.on('error', async (err) => {
+            if (!lazy && err.code === 'EADDRINUSE') {
+                if (singleton && (await isHandshakable(port))) {
+                    return resolve({ port });
+                }
+                else {
+                    return resolve(await makeHandler({ port: port + 1, singleton }));
+                }
+            }
+            reject(err);
+        });
+    });
+}
+exports.makeHandler = makeHandler;
+async function isHandshakable(port) {
+    return new Promise(resolve => {
+        const handshake = http_1.request(`http://localhost:${port}/handshake`, {
+            headers: { [TOKEN_HEADER]: TOKEN },
+        });
+        handshake.on('response', ({ statusCode, headers }) => {
+            resolve(statusCode === 200 && headers[TOKEN_HEADER] === TOKEN);
+        });
+        handshake.on('error', () => resolve(false));
+        handshake.end();
+    });
+}

package/eyes-index.d.ts

@@ -1,34 +1,34 @@
-/// <reference types="Cypress" />
-/// <reference types="@applitools/visual-grid-client" />
-
-declare namespace Cypress {
-    interface Chainable {
-      /**
-       * Create an Applitools test.
-       * This will start a session with the Applitools server.
-       * @example
-       * cy.eyesOpen({ appName: 'My App' })
-      */
-      eyesOpen(options?: Eyes.Open.Options): null // add isDisabled
-
-      /**
-       * Generate a screenshot of the current page and add it to the Applitools Test.
-       * @example
-       * cy.eyesCheckWindow()
-       *
-       * OR
-       *
-       * cy.eyesCheckWindow({
-       *  target: 'region',
-       *  selector: '.my-element'
-       * });
-      */
-      eyesCheckWindow(config?: Eyes.Check.Options|String): null
-
-      /**
-       * Close the applitools test and check that all screenshots are valid.
-       * @example cy.eyesClose()
-      */
-      eyesClose(): null
-    }
-  }
+/// <reference types="Cypress" />
+/// <reference types="@applitools/visual-grid-client" />
+
+declare namespace Cypress {
+    interface Chainable {
+      /**
+       * Create an Applitools test.
+       * This will start a session with the Applitools server.
+       * @example
+       * cy.eyesOpen({ appName: 'My App' })
+      */
+      eyesOpen(options?: Eyes.Open.Options): null // add isDisabled
+
+      /**
+       * Generate a screenshot of the current page and add it to the Applitools Test.
+       * @example
+       * cy.eyesCheckWindow()
+       *
+       * OR
+       *
+       * cy.eyesCheckWindow({
+       *  target: 'region',
+       *  selector: '.my-element'
+       * });
+      */
+      eyesCheckWindow(config?: Eyes.Check.Options|String): null
+
+      /**
+       * Close the applitools test and check that all screenshots are valid.
+       * @example cy.eyesClose()
+      */
+      eyesClose(): null
+    }
+  }

package/index.js

@@ -1,2 +1,2 @@
-'use strict';
-module.exports = require('./src/plugin/startPlugin');
+'use strict';
+module.exports = require('./src/plugin/startPlugin');