eyes.selenium - npm Package Compare versions

Comparing version 0.0.78 to 0.0.79

index.js

@@ -1,14 +0,18 @@
-exports.CssTranslatePositionProvider = require('./src/CssTranslatePositionProvider');
-exports.ElementPositionProvider = require('./src/ElementPositionProvider');
-exports.Eyes = require('./src/Eyes');
+'use strict';
+
+exports.CssTranslatePositionProvider = require('./src/CssTranslatePositionProvider').CssTranslatePositionProvider;
+exports.ElementPositionProvider = require('./src/ElementPositionProvider').ElementPositionProvider;
+exports.Eyes = require('./src/Eyes').Eyes;
 exports.StitchMode = exports.Eyes.StitchMode;
-exports.EyesRegionProvider = require('./src/EyesRegionProvider');
-exports.EyesRemoteWebElement = require('./src/EyesRemoteWebElement');
-exports.EyesTargetLocator = require('./src/EyesTargetLocator');
-exports.EyesWebDriver = require('./src/EyesWebDriver');
-exports.EyesWebDriverScreenshot = require('./src/EyesWebDriverScreenshot');
-exports.Frame = require('./src/Frame');
-exports.FrameChain = require('./src/FrameChain');
-exports.ScrollPositionProvider = require('./src/ScrollPositionProvider');
-exports.Target = require('./src/Target');
+exports.EyesRegionProvider = require('./src/EyesRegionProvider').EyesRegionProvider;
+exports.EyesRemoteWebElement = require('./src/EyesRemoteWebElement').EyesRemoteWebElement;
+exports.EyesSeleniumUtils = require('./src/EyesSeleniumUtils').EyesSeleniumUtils;
+exports.EyesTargetLocator = require('./src/EyesTargetLocator').EyesTargetLocator;
+exports.EyesWebDriver = require('./src/EyesWebDriver').EyesWebDriver;
+exports.EyesWebDriverScreenshot = require('./src/EyesWebDriverScreenshot').EyesWebDriverScreenshot;
+exports.Frame = require('./src/Frame').Frame;
+exports.FrameChain = require('./src/FrameChain').FrameChain;
+exports.ScrollPositionProvider = require('./src/ScrollPositionProvider').ScrollPositionProvider;
+exports.Target = require('./src/Target').Target;
+
 var EyesSDK = require('eyes.sdk');
@@ -20,2 +24,5 @@ exports.ConsoleLogHandler = EyesSDK.ConsoleLogHandler;
 exports.CutProvider = EyesSDK.CutProvider;
+// exports.EyesBase = EyesSDK.EyesBase;
+exports.FailureReport = EyesSDK.EyesBase.FailureReport;
+exports.TestResultsStatus = EyesSDK.EyesBase.TestResultsStatus;
 exports.EyesScreenshot = EyesSDK.EyesScreenshot;
@@ -27,5 +34,7 @@ exports.FileLogHandler = EyesSDK.FileLogHandler;
 exports.Logger = EyesSDK.Logger;
-exports.MatchLevel = EyesSDK.MatchLevel;
-exports.ExactMatchSettings = EyesSDK.ExactMatchSettings;
-exports.ImageMatchSettings = EyesSDK.ImageMatchSettings;
+exports.LogHandler = EyesSDK.LogHandler;
+exports.MatchSettings = EyesSDK.MatchSettings;
+exports.MatchLevel = EyesSDK.MatchSettings.MatchLevel;
+exports.ImageMatchSettings = EyesSDK.MatchSettings.ImageMatchSettings;
+exports.ExactMatchSettings = EyesSDK.MatchSettings.ExactMatchSettings;
 exports.MutableImage = EyesSDK.MutableImage;
@@ -41,6 +50,7 @@ exports.NullCutProvider = EyesSDK.NullCutProvider;
 exports.ScaleProviderIdentityFactory = EyesSDK.ScaleProviderIdentityFactory;
+exports.ServerConnector = EyesSDK.ServerConnector;
 exports.SessionEventHandler = EyesSDK.SessionEventHandler;
 exports.TestResultsFormatter = EyesSDK.TestResultsFormatter;
-exports.FailureReport = EyesSDK.EyesBase.FailureReport;
 exports.Triggers = EyesSDK.Triggers;
+
 var EyesUtils = require('eyes.utils');
@@ -47,0 +57,0 @@ exports.ArgumentGuard = EyesUtils.ArgumentGuard;

package.json

 {
-    "name": "eyes.selenium",
-    "version": "0.0.78",
-    "description": "Applitools Eyes SDK For Selenium JavaScript WebDriver",
-    "author": "Applitools Team <[e-mail]> (http://www.applitools.com/)",
-    "keywords": [
-        "eyes.selenium",
-        "Test Automation",
-        "Visual Regression",
-        "tests",
-        "SDK",
-        "Applitools",
-        "Eyes",
-        "automation",
-        "selenium",
-        "testing",
-        "webdriver",
-        "webdriverjs",
-        "protractor"
-    ],
-    "homepage": "http://www.applitools.com/",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/applitools/Eyes.Selenium.JavaScript.git"
-    },
-    "license": "SEE LICENSE IN LICENSE",
-    "main": "index",
-    "dependencies": {
-        "eyes.utils": "0.0.26",
-        "eyes.sdk": "0.0.68",
-        "q": "^1.4.1"
-    },
-    "devDependencies": {
-        "selenium-webdriver": "^3.0.0",
-        "protractor": "^5.1.2",
-        "ava": "^0.25.0"
-    },
-    "scripts": {
-        "test": "ava",
-        "test-protractor": "npm run test-protractor-default && npm run test-protractor-scaling",
-        "test-protractor-default": "protractor protractor.conf.js --suite=simple,checkInterface",
-        "test-protractor-scaling": "protractor protractor.conf.js --suite=scalingMethods --capabilities.chromeOptions.args='--force-device-scale-factor=1.25'"
-    },
-    "ava": {
-        "concurrency": 1,
-        "failWithoutAssertions": false,
-        "files": [
-            "test/*.js",
-            "!**/simple-appium-test.js",
-            "!**/simple-sause-test.js"
-        ]
-    },
-    "engines": {
-        "node": ">=6.9.0"
-    }
+  "name": "eyes.selenium",
+  "version": "0.0.79",
+  "description": "Applitools Eyes SDK For Selenium JavaScript WebDriver",
+  "keywords": [
+    "eyes.selenium",
+    "applitools",
+    "eyes",
+    "test automation",
+    "visual regression",
+    "automation",
+    "selenium",
+    "tests",
+    "testing",
+    "webdriver",
+    "webdriverjs",
+    "protractor"
+  ],
+  "homepage": "https://applitools.com",
+  "author": {
+    "name": "Applitools Team",
+    "email": "[e-mail]",
+    "url": "https://www.applitools.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/applitools/Eyes.Selenium.JavaScript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/applitools/Eyes.Selenium.JavaScript/issues"
+  },
+  "directories": {
+    "example": "./example",
+    "lib": "./src",
+    "test": "./test"
+  },
+  "files": [
+    "README.md",
+    "LICENSE",
+    "index.js",
+    "src/",
+    "test/",
+    "typings/"
+  ],
+  "main": "./index.js",
+  "types": "./typings/index.d.ts",
+  "dependencies": {
+    "@types/node": "^9.6.6",
+    "eyes.utils": "0.0.27",
+    "eyes.sdk": "0.0.69",
+    "q": "^1.4.1"
+  },
+  "devDependencies": {
+    "mocha": "^5.0.1",
+    "selenium-webdriver": "^3.0.0",
+    "chromedriver": "^2.35.0",
+    "protractor": "^5.1.2"
+  },
+  "scripts": {
+    "test": "npm run test-selenium && npm run test-protractor",
+    "test-appium": "mocha ./test/appium/**/*.js",
+    "test-selenium": "mocha ./test/selenium/**/*.js",
+    "test-protractor": "protractor protractor.conf.js"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "engines": {
+    "node": ">= 4.2.0"
+  }
 }

README.md

 eyes.selenium
 =============
 
+[![npm](https://img.shields.io/npm/v/eyes.selenium.svg?style=for-the-badge)](https://www.npmjs.com/package/eyes.selenium)
+
 Applitools Eyes SDK For Selenium JavaScript WebDriver
-[![Build Status](https://travis-ci.org/applitools/Eyes.Selenium.JavaScript.svg?branch=master)](https://travis-ci.org/applitools/Eyes.Selenium.JavaScript)
 
@@ -7,0 +8,0 @@ ## Installation

src/CssTranslatePositionProvider.js

@@ -6,3 +6,3 @@ (function() {
         EyesUtils = require('eyes.utils'),
-        EyesSeleniumUtils = require('./EyesSeleniumUtils');
+        EyesSeleniumUtils = require('./EyesSeleniumUtils').EyesSeleniumUtils;
     var PositionProvider = EyesSDK.PositionProvider,
@@ -32,3 +32,3 @@ ArgumentGuard = EyesUtils.ArgumentGuard;
     /**
-     * @returns {Promise<{x: number, y: number}>} The scroll position of the current frame.
+     * @return {Promise<{x: number, y: number}>} The scroll position of the current frame.
      */
@@ -47,3 +47,3 @@ CssTranslatePositionProvider.prototype.getCurrentPosition = function () {
      * @param {{x: number, y: number}} location The position to scroll to.
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -60,3 +60,3 @@ CssTranslatePositionProvider.prototype.setPosition = function (location) {
     /**
-     * @returns {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
+     * @return {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
      */
@@ -72,3 +72,3 @@ CssTranslatePositionProvider.prototype.getEntireSize = function () {
     /**
-     * @returns {Promise<object.<string, string>>}
+     * @return {Promise<object.<string, string>>}
      */
@@ -85,3 +85,3 @@ CssTranslatePositionProvider.prototype.getState = function () {
      * @param {object.<string, string>} state The initial state of position
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -95,3 +95,3 @@ CssTranslatePositionProvider.prototype.restoreState = function (state) {
 
-    module.exports = CssTranslatePositionProvider;
-}());
+    exports.CssTranslatePositionProvider = CssTranslatePositionProvider;
+}());

src/ElementFinderWrappers.js

@@ -1,16 +0,6 @@
-/*
- ---
-
- name: ElementFinderWrapper
-
- description: Wraps Protractor's ElementFinder to make sure we return our own Web Element.
-
- ---
- */
-
 (function () {
-    "use strict";
+    'use strict';
 
     var EyesUtils = require('eyes.utils'),
-        EyesRemoteWebElement = require('./EyesRemoteWebElement');
+        EyesRemoteWebElement = require('./EyesRemoteWebElement').EyesRemoteWebElement;
     var GeneralUtils = EyesUtils.GeneralUtils;
@@ -26,3 +16,3 @@
     /**
-     * Wrapper for ElementFinder object from Protractor
+     * Wraps Protractor's ElementFinder to make sure we return our own Web Element.
      *
@@ -58,3 +48,3 @@ * @param {ElementFinder} finder
      *
-     * @returns {EyesRemoteWebElement}
+     * @return {EyesRemoteWebElement}
      */
@@ -69,3 +59,3 @@ ElementFinderWrapper.prototype.getWebElement = function () {
      *
-     * @returns {Promise.<EyesRemoteWebElement>}
+     * @return {Promise<EyesRemoteWebElement>}
      */
@@ -81,3 +71,3 @@ ElementFinderWrapper.prototype.click = function () {
      *
-     * @returns {Promise.<EyesRemoteWebElement>}
+     * @return {Promise<EyesRemoteWebElement>}
      */
@@ -129,3 +119,3 @@ ElementFinderWrapper.prototype.sendKeys = function () {
      *
-     * @returns {Promise.<EyesRemoteWebElement[]>}
+     * @return {Promise<EyesRemoteWebElement[]>}
      */
@@ -144,4 +134,4 @@ ElementArrayFinderWrapper.prototype.getWebElements = function () {
 
-    module.exports.ElementFinderWrapper = ElementFinderWrapper;
-    module.exports.ElementArrayFinderWrapper = ElementArrayFinderWrapper;
+    exports.ElementFinderWrapper = ElementFinderWrapper;
+    exports.ElementArrayFinderWrapper = ElementArrayFinderWrapper;
 }());

src/ElementPositionProvider.js

@@ -32,3 +32,3 @@ (function() {
     /**
-     * @returns {Promise<{x: number, y: number}>} The scroll position of the current frame.
+     * @return {Promise<{x: number, y: number}>} The scroll position of the current frame.
      */
@@ -52,3 +52,3 @@ ElementPositionProvider.prototype.getCurrentPosition = function () {
      * @param {{x: number, y: number}} location The position to scroll to.
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -64,3 +64,3 @@ ElementPositionProvider.prototype.setPosition = function (location) {
     /**
-     * @returns {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
+     * @return {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
      */
@@ -86,3 +86,3 @@ ElementPositionProvider.prototype.getEntireSize = function () {
     /**
-     * @returns {Promise<{x: number, y: number}>}
+     * @return {Promise<{x: number, y: number}>}
      */
@@ -95,3 +95,3 @@ ElementPositionProvider.prototype.getState = function () {
      * @param {{x: number, y: number}} state The initial state of position
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -105,3 +105,3 @@ ElementPositionProvider.prototype.restoreState = function (state) {
 
-    module.exports = ElementPositionProvider;
-}());
+    exports.ElementPositionProvider = ElementPositionProvider;
+}());

src/Eyes.js

@@ -1,14 +0,1 @@
-/*
- ---
-
- name: Eyes
-
- description: The main type - to be used by the users of the library to access all functionality.
-
- provides: [Eyes]
- requires: [eyes.sdk, EyesWebDriver, ViewportSize, selenium-webdriver]
-
- ---
- */
-
 (function () {
@@ -21,15 +8,14 @@ 'use strict';
         EyesUtils = require('eyes.utils'),
-        EyesWebDriver = require('./EyesWebDriver'),
-        EyesSeleniumUtils = require('./EyesSeleniumUtils'),
-        EyesRemoteWebElement = require('./EyesRemoteWebElement'),
-        EyesWebDriverScreenshot = require('./EyesWebDriverScreenshot'),
+        EyesWebDriver = require('./EyesWebDriver').EyesWebDriver,
+        EyesSeleniumUtils = require('./EyesSeleniumUtils').EyesSeleniumUtils,
+        EyesRemoteWebElement = require('./EyesRemoteWebElement').EyesRemoteWebElement,
+        EyesWebDriverScreenshot = require('./EyesWebDriverScreenshot').EyesWebDriverScreenshot,
         ElementFinderWrapper = require('./ElementFinderWrappers').ElementFinderWrapper,
         ElementArrayFinderWrapper = require('./ElementFinderWrappers').ElementArrayFinderWrapper,
-        ScrollPositionProvider = require('./ScrollPositionProvider'),
-        CssTranslatePositionProvider = require('./CssTranslatePositionProvider'),
-        ElementPositionProvider = require('./ElementPositionProvider'),
-        EyesRegionProvider = require('./EyesRegionProvider'),
-        Target = require('./Target');
+        ScrollPositionProvider = require('./ScrollPositionProvider').ScrollPositionProvider,
+        CssTranslatePositionProvider = require('./CssTranslatePositionProvider').CssTranslatePositionProvider,
+        ElementPositionProvider = require('./ElementPositionProvider').ElementPositionProvider,
+        EyesRegionProvider = require('./EyesRegionProvider').EyesRegionProvider,
+        Target = require('./Target').Target;
     var EyesBase = EyesSDK.EyesBase,
-        FixedScaleProvider = EyesSDK.FixedScaleProvider,
         ContextBasedScaleProviderFactory = EyesSDK.ContextBasedScaleProviderFactory,
@@ -62,7 +48,9 @@ FixedScaleProviderFactory = EyesSDK.FixedScaleProviderFactory,
     };
+    Object.freeze(StitchMode);
 
     /**
-     * Initializes an Eyes instance.
-     * @param {String} [serverUrl] - The Eyes server URL.
-     * @param {Boolean} [isDisabled] - set to true to disable Applitools Eyes and use the webdriver directly.
+     * The main type - to be used by the users of the library to access all functionality.
+     *
+     * @param {string} [serverUrl] - The Eyes server URL.
+     * @param {boolean} [isDisabled] - set to true to disable Applitools Eyes and use the webdriver directly.
      * @augments EyesBase
@@ -201,3 +189,3 @@ * @constructor
      * @param throwEx - If true, an exception will be thrown for failed/new tests.
-     * @returns {*} The test results.
+     * @return {*} The test results.
      */
@@ -230,3 +218,3 @@ Eyes.prototype.close = function (throwEx) {
      * @param {Target} target - Target instance which describes whether we want a window/region/frame
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -528,4 +516,4 @@ Eyes.prototype.check = function (name, target) {
      * @param {string} tag - An optional tag to be associated with the snapshot.
-     * @param {int} matchTimeout - The amount of time to retry matching (Milliseconds).
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @param {number} matchTimeout - The amount of time to retry matching (Milliseconds).
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -542,5 +530,5 @@ Eyes.prototype.checkWindow = function (tag, matchTimeout) {
      * would be used in a call to driver.switchTo().frame() ).
-     * @param {int} matchTimeout - The amount of time to retry matching (milliseconds).
+     * @param {number} matchTimeout - The amount of time to retry matching (milliseconds).
      * @param {string} tag - An optional tag to be associated with the match.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -558,3 +546,3 @@ Eyes.prototype.checkFrame = function (element, matchTimeout, tag) {
      * @param {string} tag - An optional tag to be associated with the match.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -572,3 +560,3 @@ Eyes.prototype.checkElement = function (element, matchTimeout, tag) {
      * @param {string} tag - An optional tag to be associated with the match.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -585,4 +573,4 @@ Eyes.prototype.checkElementBy = function (locator, matchTimeout, tag) {
      * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {int} matchTimeout - The amount of time to retry matching.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -598,4 +586,4 @@ Eyes.prototype.checkRegion = function (region, tag, matchTimeout) {
      * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {int} matchTimeout - The amount of time to retry matching.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -611,4 +599,4 @@ Eyes.prototype.checkRegionByElement = function (element, tag, matchTimeout) {
      * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {int} matchTimeout - The amount of time to retry matching.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -628,4 +616,4 @@ Eyes.prototype.checkRegionBy = function (by, tag, matchTimeout) {
      * @param {boolean} stitchContent - If {@code true}, stitch the internal content of the region (i.e., perform
-     *                  {@link #checkElement(By, int, String)} on the region.
-     * @return {ManagedPromise} A promise which is resolved when the validation is finished.
+     *                  {@link #checkElement(By, int, string)} on the region.
+     * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
      */
@@ -638,3 +626,3 @@ Eyes.prototype.checkRegionInFrame = function (frameNameOrId, locator, matchTimeout, tag, stitchContent) {
      * @protected
-     * @returns {ScaleProviderFactory}
+     * @return {ScaleProviderFactory}
      */
@@ -682,3 +670,3 @@ Eyes.prototype.updateScalingParams = function () {
      * Get an updated screenshot.
-     * @returns {Promise.<MutableImage>} - The image of the new screenshot.
+     * @return {Promise<MutableImage>} - The image of the new screenshot.
      */
@@ -749,3 +737,3 @@ Eyes.prototype.getScreenShot = function () {
      * Get the viewport size.
-     * @returns {*} The viewport size.
+     * @return {*} The viewport size.
      */
@@ -764,3 +752,3 @@ Eyes.prototype.getViewportSize = function () {
      * Set the viewport size using the driver. Call this method if for some reason
-     * you don't want to call {@link #open(WebDriver, String, String)} (or one of its variants) yet.
+     * you don't want to call {@link #open(WebDriver, string, string)} (or one of its variants) yet.
      * @param {WebDriver} driver - The driver to use for setting the viewport.
@@ -818,3 +806,3 @@ * @param {{width: number, height: number}} size - The required viewport size.
      * Get the rotation degrees.
-     * @returns {*|number} - The rotation degrees.
+     * @return {*|number} - The rotation degrees.
      */
@@ -887,3 +875,3 @@ Eyes.prototype.getForcedImageRotation = function () {
      * Get the wait time before each screenshot.
-     * @returns {number|*} the wait time between before each screen capture, in milliseconds.
+     * @return {number|*} the wait time between before each screen capture, in milliseconds.
      */
@@ -897,3 +885,3 @@ Eyes.prototype.getWaitBeforeScreenshots = function () {
      * Get the session id.
-     * @returns {Promise} A promise which resolves to the webdriver's session ID.
+     * @return {Promise<string>} A promise which resolves to the webdriver's session ID.
      */
@@ -913,8 +901,4 @@ Eyes.prototype.getAUTSessionId = function () {
 
-    /**
-     * @readonly
-     * @enum {string}
-     */
-    Eyes.StitchMode = Object.freeze(StitchMode);
-    module.exports = Eyes;
+    Eyes.StitchMode = StitchMode;
+    exports.Eyes = Eyes;
 }());

src/EyesRegionProvider.js

 (function () {
-    "use strict";
+    'use strict';
 
     var EyesUtils = require('eyes.utils'),
         EyesSDK = require('eyes.sdk'),
-        EyesWebDriverScreenshot = require('./EyesWebDriverScreenshot');
+        EyesWebDriverScreenshot = require('./EyesWebDriverScreenshot').EyesWebDriverScreenshot;
     var RegionProvider = EyesSDK.RegionProvider,
@@ -64,4 +64,3 @@ GeometryUtils = EyesUtils.GeometryUtils;
 
-    module.exports = EyesRegionProvider;
-
-}());
+    exports.EyesRegionProvider = EyesRegionProvider;
+}());

src/EyesRemoteWebElement.js

@@ -1,13 +0,3 @@
-/*
- ---
-
- name: EyesRemoteWebElement
-
- description: Wraps a Remote Web Element.
-
- ---
- */
-
 (function () {
-    "use strict";
+    'use strict';
 
@@ -48,4 +38,4 @@ var EyesSDK = require('eyes.sdk'),
     /**
-     * @param {int} scrollLeft
-     * @param {int} scrollTop
+     * @param {number} scrollLeft
+     * @param {number} scrollTop
      * @return {string}
@@ -67,5 +57,4 @@ */
     /**
+     * Wraps a Remote Web Element.
      *
-     * C'tor = initializes the module settings
-     *
      * @constructor
@@ -178,3 +167,3 @@ * @param {WebElement} remoteWebElement
      * @param {string} propStyle The style property which value we would like to extract.
-     * @return {promise.Promise.<string>} The value of the style property of the element, or {@code null}.
+     * @return {promise.Promise<string>} The value of the style property of the element, or {@code null}.
      */
@@ -186,3 +175,3 @@ EyesRemoteWebElement.prototype.getComputedStyle = function (propStyle) {
     /**
-     * @return {promise.Promise.<int>} The integer value of a computed style.
+     * @return {promise.Promise<number>} The integer value of a computed style.
      */
@@ -196,3 +185,3 @@ EyesRemoteWebElement.prototype.getComputedStyleInteger = function (propStyle) {
     /**
-     * @return {promise.Promise.<int>} The value of the scrollLeft property of the element.
+     * @return {promise.Promise<number>} The value of the scrollLeft property of the element.
      */
@@ -206,3 +195,3 @@ EyesRemoteWebElement.prototype.getScrollLeft  = function () {
     /**
-     * @return {promise.Promise.<int>} The value of the scrollTop property of the element.
+     * @return {promise.Promise<number>} The value of the scrollTop property of the element.
      */
@@ -216,3 +205,3 @@ EyesRemoteWebElement.prototype.getScrollTop  = function () {
     /**
-     * @return {promise.Promise.<int>} The value of the scrollWidth property of the element.
+     * @return {promise.Promise<number>} The value of the scrollWidth property of the element.
      */
@@ -226,3 +215,3 @@ EyesRemoteWebElement.prototype.getScrollWidth  = function () {
     /**
-     * @return {promise.Promise.<int>} The value of the scrollHeight property of the element.
+     * @return {promise.Promise<number>} The value of the scrollHeight property of the element.
      */
@@ -236,3 +225,3 @@ EyesRemoteWebElement.prototype.getScrollHeight  = function () {
     /**
-     * @return {promise.Promise.<int>} The width of the left border.
+     * @return {promise.Promise<number>} The width of the left border.
      */
@@ -244,3 +233,3 @@ EyesRemoteWebElement.prototype.getBorderLeftWidth = function () {
     /**
-     * @return {promise.Promise.<int>} The width of the right border.
+     * @return {promise.Promise<number>} The width of the right border.
      */
@@ -252,3 +241,3 @@ EyesRemoteWebElement.prototype.getBorderRightWidth = function () {
     /**
-     * @return {promise.Promise.<int>} The width of the top border.
+     * @return {promise.Promise<number>} The width of the top border.
      */
@@ -260,3 +249,3 @@ EyesRemoteWebElement.prototype.getBorderTopWidth = function () {
     /**
-     * @return {promise.Promise.<int>} The width of the bottom border.
+     * @return {promise.Promise<number>} The width of the bottom border.
      */
@@ -296,3 +285,3 @@ EyesRemoteWebElement.prototype.getBorderBottomWidth = function () {
      * @param {{x: number, y: number}} location The location to scroll to.
-     * @return {promise.Promise.<void>}
+     * @return {promise.Promise<void>}
      */
@@ -304,3 +293,3 @@ EyesRemoteWebElement.prototype.scrollTo = function (location) {
     /**
-     * @return {promise.Promise.<string>} The overflow of the element.
+     * @return {promise.Promise<string>} The overflow of the element.
      */
@@ -313,3 +302,3 @@ EyesRemoteWebElement.prototype.getOverflow = function () {
      * @param {string} overflow The overflow to set
-     * @return {promise.Promise.<void>} The overflow of the element.
+     * @return {promise.Promise<void>} The overflow of the element.
      */
@@ -331,3 +320,3 @@ EyesRemoteWebElement.prototype.setOverflow = function (overflow) {
 
-    module.exports = EyesRemoteWebElement;
+    exports.EyesRemoteWebElement = EyesRemoteWebElement;
 }());

src/EyesSeleniumUtils.js

@@ -1,13 +0,3 @@
-/*
- ---
-
- name: EyesSeleniumUtils
-
- description: Handles browser related functionality.
-
- ---
- */
-
 (function () {
-    "use strict";
+    'use strict';
 
@@ -22,2 +12,5 @@ var EyesSDK = require('eyes.sdk'),
 
+    /**
+     * Handles browser related functionality.
+     */
     var EyesSeleniumUtils = {};
@@ -258,3 +251,3 @@
      * @param {PromiseFactory} promiseFactory
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -531,3 +524,3 @@ EyesSeleniumUtils.setTransforms = function (browser, transforms, promiseFactory) {
      * @param {PromiseFactory} promiseFactory
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -702,3 +695,3 @@ EyesSeleniumUtils.setViewportSize = function (logger, browser, requiredSize, promiseFactory) {
      * @param {{left: number, top: number, width: number, height: number}} part
-     * @param {Array<{position: {x: number, y: number}, size: {width: number, height: number}, image: Buffer}>} parts
+     * @param {{position: {x: number, y: number}, size: {width: number, height: number}, image: Buffer}[]} parts
      * @param {{imageBuffer: Buffer, width: number, height: number}} imageObj
@@ -718,3 +711,3 @@ * @param {WebDriver} browser
      * @param {boolean} isLandscape
-     * @param {int} waitBeforeScreenshots
+     * @param {number} waitBeforeScreenshots
      * @param {{left: number, top: number, width: number, height: number}} regionInScreenshot
@@ -796,3 +789,3 @@ * @param {boolean} [saveDebugScreenshots=false]
      * @param {boolean} isLandscape
-     * @param {int} waitBeforeScreenshots
+     * @param {number} waitBeforeScreenshots
      * @param {{left: number, top: number, width: number, height: number}} [regionInScreenshot]
@@ -905,3 +898,3 @@ * @param {boolean} [saveDebugScreenshots=false]
      * @param {boolean} isLandscape
-     * @param {int} waitBeforeScreenshots
+     * @param {number} waitBeforeScreenshots
      * @param {boolean} checkFrameOrElement
@@ -911,3 +904,3 @@ * @param {RegionProvider} [regionProvider]
      * @param {string} [debugScreenshotsPath=null]
-     * @returns {Promise<MutableImage>}
+     * @return {Promise<MutableImage>}
      */
@@ -1075,3 +1068,3 @@ EyesSeleniumUtils.getScreenshot = function getScreenshot(
 
-    module.exports = EyesSeleniumUtils;
+    exports.EyesSeleniumUtils = EyesSeleniumUtils;
 }());

src/EyesTargetLocator.js

@@ -5,5 +5,5 @@ (function () {
     var EyesUtils = require('eyes.utils'),
-        FrameChain = require('./FrameChain'),
-        ScrollPositionProvider = require('./ScrollPositionProvider'),
-        EyesRemoteWebElement = require('./EyesRemoteWebElement');
+        FrameChain = require('./FrameChain').FrameChain,
+        ScrollPositionProvider = require('./ScrollPositionProvider').ScrollPositionProvider,
+        EyesRemoteWebElement = require('./EyesRemoteWebElement').EyesRemoteWebElement;
     var ArgumentGuard = EyesUtils.ArgumentGuard,
@@ -47,3 +47,3 @@ GeneralUtils = EyesUtils.GeneralUtils;
      * Initialized a new EyesTargetLocator object.
-     * @param {Object} logger A Logger instance.
+     * @param {Logger} logger A Logger instance.
      * @param {EyesWebDriver} driver The WebDriver from which the targetLocator was received.
@@ -72,3 +72,3 @@ * @param {TargetLocator} targetLocator The actual TargetLocator object.
      * @param {int|string|EyesRemoteWebElement} obj
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -151,3 +151,3 @@ EyesTargetLocator.prototype.frame = function (obj) {
     /**
-     * @returns {Promise.<void>}
+     * @return {Promise<void>}
      */
@@ -159,3 +159,3 @@
         return this._driver._promiseFactory.makePromise(function (resolve) {
-            if (that._driver.getFrameChain().size() != 0) {
+            if (that._driver.getFrameChain().size() !== 0) {
                 that._logger.verbose("Making preparations..");
@@ -259,3 +259,3 @@ return that._onWillSwitch.willSwitchToFrame(EyesTargetLocator.TargetType.PARENT_FRAME, null).then(function () {
      * @param {string} nameOrHandle
-     * @returns {Promise.<void>}
+     * @return {Promise<void>}
      */
@@ -278,3 +278,3 @@ EyesTargetLocator.prototype.window = function (nameOrHandle) {
     /**
-     * @returns {Promise.<void>}
+     * @return {Promise<void>}
      */
@@ -285,3 +285,3 @@ EyesTargetLocator.prototype.defaultContent = function () {
             that._logger.verbose("EyesTargetLocator.defaultContent()");
-            if (that._driver.getFrameChain().size() != 0) {
+            if (that._driver.getFrameChain().size() !== 0) {
                 that._logger.verbose("Making preparations..");
@@ -302,3 +302,3 @@ that._onWillSwitch.willSwitchToFrame(EyesTargetLocator.TargetType.DEFAULT_CONTENT, null).then(function () {
     /**
-     * @returns {Promise.<EyesRemoteWebElement>}
+     * @return {Promise<EyesRemoteWebElement>}
      */
@@ -319,3 +319,3 @@ EyesTargetLocator.prototype.activeElement = function () {
     /**
-     * @returns {Promise.<Alert>}
+     * @return {Promise<Alert>}
      */
@@ -334,3 +334,3 @@ EyesTargetLocator.prototype.alert = function () {
 
-    module.exports = EyesTargetLocator;
-}());
+    exports.EyesTargetLocator = EyesTargetLocator;
+}());

src/EyesWebDriver.js

@@ -1,31 +0,20 @@
-/*
- ---
+(function () {
+    'use strict';
 
- name: EyesWebDriver
-
- description: Wraps a Remote Web Driver.
-
- ---
- */
-
-(function () {
-    "use strict";
     var webdriver = require('selenium-webdriver'),
-        EyesUtils = require('eyes.utils'),
-        Frame = require('./Frame'),
-        FrameChain = require('./FrameChain'),
-        EyesSeleniumUtils = require('./EyesSeleniumUtils'),
-        EyesRemoteWebElement = require('./EyesRemoteWebElement'),
-        ScrollPositionProvider = require('./ScrollPositionProvider'),
-        EyesTargetLocator = require('./EyesTargetLocator');
-    var GeneralUtils = EyesUtils.GeneralUtils;
+        GeneralUtils = require('eyes.utils').GeneralUtils,
+        Frame = require('./Frame').Frame,
+        FrameChain = require('./FrameChain').FrameChain,
+        EyesSeleniumUtils = require('./EyesSeleniumUtils').EyesSeleniumUtils,
+        EyesRemoteWebElement = require('./EyesRemoteWebElement').EyesRemoteWebElement,
+        ScrollPositionProvider = require('./ScrollPositionProvider').ScrollPositionProvider,
+        EyesTargetLocator = require('./EyesTargetLocator').EyesTargetLocator;
 
     /**
+     * Wraps a Remote Web Driver.
      *
-     * C'tor = initializes the module settings
-     *
      * @constructor
-     * @param {Object} remoteWebDriver
+     * @param {WebDriver} remoteWebDriver
      * @param {Eyes} eyes An instance of Eyes
-     * @param {Object} logger
+     * @param {Logger} logger
      * @param {PromiseFactory} promiseFactory
@@ -87,3 +76,3 @@ * @augments WebDriver
      * @param {webdriver.By|ProtractorBy} locator
-     * @return {Promise.<EyesRemoteWebElement[]>}
+     * @return {Promise<EyesRemoteWebElement[]>}
      */
@@ -111,3 +100,3 @@ EyesWebDriver.prototype.findElements = function (locator) {
      * @param {string} cssSelector
-     * @return {Promise.<EyesRemoteWebElement[]>}
+     * @return {Promise<EyesRemoteWebElement[]>}
      */
@@ -130,3 +119,3 @@ EyesWebDriver.prototype.findElementsByCssSelector = function (cssSelector) {
      * @param {string} name
-     * @return {Promise.<EyesRemoteWebElement[]>}
+     * @return {Promise<EyesRemoteWebElement[]>}
      */
@@ -149,3 +138,3 @@ EyesWebDriver.prototype.findElementsById = function (name) {
      * @param {string} name
-     * @return {Promise.<EyesRemoteWebElement[]>}
+     * @return {Promise<EyesRemoteWebElement[]>}
      */
@@ -168,3 +157,3 @@ EyesWebDriver.prototype.findElementsByName = function (name) {
     /**
-     * @returns {EyesTargetLocator}
+     * @return {EyesTargetLocator}
      */
@@ -181,3 +170,3 @@ EyesWebDriver.prototype.switchTo = function () {
          * @param {EyesRemoteWebElement|WebElement} targetFrame
-         * @returns {Promise<void>}
+         * @return {Promise<void>}
          */
@@ -296,3 +285,3 @@ OnWillSwitch.willSwitchToFrame = function (targetType, targetFrame) {
 
-    module.exports = EyesWebDriver;
+    exports.EyesWebDriver = EyesWebDriver;
 }());

src/EyesWebDriverScreenshot.js

@@ -6,5 +6,4 @@ (function () {
         EyesUtils = require('eyes.utils'),
-        ScrollPositionProvider = require('./ScrollPositionProvider'),
-        FrameChain = require('./FrameChain'),
-        Frame = require('./Frame');
+        ScrollPositionProvider = require('./ScrollPositionProvider').ScrollPositionProvider,
+        FrameChain = require('./FrameChain').FrameChain;
     var EyesScreenshot = EyesSDK.EyesScreenshot,
@@ -27,6 +26,6 @@ CoordinatesType = EyesSDK.CoordinatesType,
      *
-     * @param {Object} logger
+     * @param {Logger} logger
      * @param {FrameChain} frameChain
      * @param {ScreenshotType} screenshotType
-     * @returns {{x: number, y: number}}
+     * @return {{x: number, y: number}}
      */
@@ -69,6 +68,6 @@ var calcFrameLocationInScreenshot = function (logger, frameChain, screenshotType) {
     /**
-     * @param {Object} logger A Logger instance.
+     * @param {Logger} logger A Logger instance.
      * @param {EyesWebDriver} driver The web driver used to get the screenshot.
-     * @param {Object} image The actual screenshot image.
-     * @param {Object} promiseFactory
+     * @param {MutableImage} image The actual screenshot image.
+     * @param {PromiseFactory} promiseFactory
      * @augments EyesScreenshot
@@ -99,3 +98,3 @@ * @constructor
      * @param {{width: number, height: number}} [frameSize] The full internal size of the frame.
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -194,3 +193,3 @@ EyesWebDriverScreenshot.prototype.buildScreenshot = function (screenshotType, frameLocationInScreenshot, frameSize) {
      */
-    EyesWebDriverScreenshot.prototype.convertLocationFromRegion = function (region, coordinatesType, throwIfClipped) {
+    EyesWebDriverScreenshot.prototype.getSubScreenshot = function (region, coordinatesType, throwIfClipped) {
         this._logger.verbose("getSubScreenshot(", region, ", ", coordinatesType, ", ", throwIfClipped, ")");
@@ -338,3 +337,3 @@
      * @param {CoordinatesType} coordinatesType
-     * @returns {{x: number, y: number}}
+     * @return {{x: number, y: number}}
      */
@@ -357,3 +356,3 @@ EyesWebDriverScreenshot.prototype.getLocationInScreenshot = function (location, coordinatesType) {
      * @param {CoordinatesType} resultCoordinatesType
-     * @returns {{left: number, top: number, width: number, height: number}}
+     * @return {{left: number, top: number, width: number, height: number}}
      */
@@ -401,3 +400,3 @@ EyesWebDriverScreenshot.prototype.getIntersectedRegion = function (region, originalCoordinatesType, resultCoordinatesType) {
      * @param {WebElement} element The element which region we want to intersect.
-     * @return {Promise.<{left: number, top: number, width: number, height: number}>} The intersected region, in {@code SCREENSHOT_AS_IS} coordinates
+     * @return {Promise<{left: number, top: number, width: number, height: number}>} The intersected region, in {@code SCREENSHOT_AS_IS} coordinates
      * type.
@@ -426,3 +425,3 @@ */
 
-    module.exports = EyesWebDriverScreenshot;
-}());
+    exports.EyesWebDriverScreenshot = EyesWebDriverScreenshot;
+}());

src/Frame.js

 (function() {
     'use strict';
 
-    var EyesUtils = require('eyes.utils');
-    var ArgumentGuard = EyesUtils.ArgumentGuard;
+    var ArgumentGuard = require('eyes.utils').ArgumentGuard;
 
     /**
      * @constructor
-     * @param {Object} logger A Logger instance.
+     * @param {Logger} logger A Logger instance.
      * @param {WebElement} reference The web element for the frame, used as a reference to switch into the frame.
@@ -35,3 +34,3 @@ * @param {string} frameId The id of the frame. Can be used later for comparing two frames.
     /**
-     * @returns {WebElement}
+     * @return {WebElement}
      */
@@ -43,3 +42,3 @@ Frame.prototype.getReference = function () {
     /**
-     * @returns {string}
+     * @return {string}
      */
@@ -51,3 +50,3 @@ Frame.prototype.getId = function () {
     /**
-     * @returns {{x: number, y: number}}
+     * @return {{x: number, y: number}}
      */
@@ -59,3 +58,3 @@ Frame.prototype.getLocation = function () {
     /**
-     * @returns {{width: number, height: number}}
+     * @return {{width: number, height: number}}
      */
@@ -67,3 +66,3 @@ Frame.prototype.getSize = function () {
     /**
-     * @returns {{x: number, y: number}}
+     * @return {{x: number, y: number}}
      */
@@ -74,3 +73,3 @@ Frame.prototype.getParentScrollPosition = function () {
 
-    module.exports = Frame;
-}());
+    exports.Frame = Frame;
+}());

src/FrameChain.js

@@ -5,3 +5,3 @@ (function () {
     var EyesUtils = require('eyes.utils'),
-        Frame = require('./Frame');
+        Frame = require('./Frame').Frame;
     var ArgumentGuard = EyesUtils.ArgumentGuard,
@@ -12,3 +12,3 @@ GeometryUtils = EyesUtils.GeometryUtils;
      * Creates a new frame chain.
-     * @param {Object} logger A Logger instance.
+     * @param {Logger} logger A Logger instance.
      * @param {FrameChain} other A frame chain from which the current frame chain will be created.
@@ -50,3 +50,3 @@ */
         // different chains size means different frames
-        if (lc1 != lc2) {
+        if (lc1 !== lc2) {
             return false;
@@ -56,3 +56,3 @@ }
         for (var i = 0; i < lc1; ++i) {
-            if (c1.getFrames()[i].getId() != c1.getFrames()[i].getId()) {
+            if (c1.getFrames()[i].getId() !== c1.getFrames()[i].getId()) {
                 return false;
@@ -66,3 +66,3 @@ }
     /**
-     * @return {Array.<Frame>} frames stored in chain
+     * @return {Frame[]} frames stored in chain
      */
@@ -74,3 +74,3 @@ FrameChain.prototype.getFrames = function () {
     /**
-     * @param {int} index Index of needed frame
+     * @param {number} index Index of needed frame
      * @return {Frame} frame by index in array
@@ -88,3 +88,3 @@ */
      *
-     * @return {int} The number of frames in the chain.
+     * @return {number} The number of frames in the chain.
      */
@@ -135,3 +135,3 @@ FrameChain.prototype.size = function () {
     FrameChain.prototype.getDefaultContentScrollPosition = function () {
-        if (this._frames.length == 0) {
+        if (this._frames.length === 0) {
             throw new Error("No frames in frame chain");
@@ -152,3 +152,3 @@ }
 
-    module.exports = FrameChain;
+    exports.FrameChain = FrameChain;
 }());

src/ScrollPositionProvider.js

 (function() {
     'use strict';
 
-    var EyesUtils = require('eyes.utils');
-    var EyesSDK = require('eyes.sdk');
-    var EyesSeleniumUtils = require('./EyesSeleniumUtils');
-    var PositionProvider = EyesSDK.PositionProvider,
-        ArgumentGuard = EyesUtils.ArgumentGuard;
+    var ArgumentGuard = require('eyes.utils').ArgumentGuard;
+    var PositionProvider = require('eyes.sdk').PositionProvider;
+    var EyesSeleniumUtils = require('./EyesSeleniumUtils').EyesSeleniumUtils;
 
@@ -30,3 +28,3 @@ /**
     /**
-     * @returns {Promise<{x: number, y: number}>} The scroll position of the current frame.
+     * @return {Promise<{x: number, y: number}>} The scroll position of the current frame.
      */
@@ -45,3 +43,3 @@ ScrollPositionProvider.prototype.getCurrentPosition = function () {
      * @param {{x: number, y: number}} location The position to scroll to.
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -57,3 +55,3 @@ ScrollPositionProvider.prototype.setPosition = function (location) {
     /**
-     * @returns {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
+     * @return {Promise<{width: number, height: number}>} The entire size of the container which the position is relative to.
      */
@@ -69,3 +67,3 @@ ScrollPositionProvider.prototype.getEntireSize = function () {
     /**
-     * @returns {Promise<{x: number, y: number}>}
+     * @return {Promise<{x: number, y: number}>}
      */
@@ -78,3 +76,3 @@ ScrollPositionProvider.prototype.getState = function () {
      * @param {{x: number, y: number}} state The initial state of position
-     * @returns {Promise<void>}
+     * @return {Promise<void>}
      */
@@ -88,3 +86,3 @@ ScrollPositionProvider.prototype.restoreState = function (state) {
 
-    module.exports = ScrollPositionProvider;
-}());
+    exports.ScrollPositionProvider = ScrollPositionProvider;
+}());

src/Target.js

 (function () {
     'use strict';
 
-    var EyesUtils = require('eyes.utils');
-    var GeometryUtils = EyesUtils.GeometryUtils;
+    var GeometryUtils = require('eyes.utils').GeometryUtils;
 
@@ -36,3 +35,3 @@ /**
     /**
-     * @param {int} ms Milliseconds to wait
+     * @param {number} ms Milliseconds to wait
      * @return {Target}
@@ -142,3 +141,3 @@ */
     /**
-     * @returns {Region|webdriver.WebElement|EyesRemoteWebElement|webdriver.By|null}
+     * @return {Region|webdriver.WebElement|EyesRemoteWebElement|webdriver.By|null}
      */
@@ -150,3 +149,3 @@ Target.prototype.getRegion = function () {
     /**
-     * @returns {boolean}
+     * @return {boolean}
      */
@@ -158,3 +157,3 @@ Target.prototype.isUsingRegion = function () {
     /**
-     * @returns {webdriver.WebElement|EyesRemoteWebElement|String|null}
+     * @return {webdriver.WebElement|EyesRemoteWebElement|string|null}
      */
@@ -166,3 +165,3 @@ Target.prototype.getFrame = function () {
     /**
-     * @returns {boolean}
+     * @return {boolean}
      */
@@ -174,3 +173,3 @@ Target.prototype.isUsingFrame = function () {
     /**
-     * @returns {int|null}
+     * @return {int|null}
      */
@@ -182,3 +181,3 @@ Target.prototype.getTimeout = function () {
     /**
-     * @returns {boolean}
+     * @return {boolean}
      */
@@ -190,3 +189,3 @@ Target.prototype.getStitchContent = function () {
     /**
-     * @returns {boolean}
+     * @return {boolean}
      */
@@ -198,3 +197,3 @@ Target.prototype.getIgnoreMismatch = function () {
     /**
-     * @returns {boolean}
+     * @return {boolean}
      */
@@ -206,3 +205,3 @@ Target.prototype.getMatchLevel = function () {
     /**
-     * @returns {boolean|null}
+     * @return {boolean|null}
      */
@@ -214,3 +213,3 @@ Target.prototype.getIgnoreCaret = function () {
     /**
-     * @returns {Region[]}
+     * @return {Region[]}
      */
@@ -222,3 +221,3 @@ Target.prototype.getIgnoreRegions = function () {
     /**
-     * @returns {{element: (webdriver.WebElement|EyesRemoteWebElement|webdriver.By)}[]}
+     * @return {{element: (webdriver.WebElement|EyesRemoteWebElement|webdriver.By)}[]}
      */
@@ -230,3 +229,3 @@ Target.prototype.getIgnoreObjects = function () {
     /**
-     * @returns {FloatingRegion[]}
+     * @return {FloatingRegion[]}
      */
@@ -238,3 +237,3 @@ Target.prototype.getFloatingRegions = function () {
     /**
-     * @returns {FloatingElement[]}
+     * @return {FloatingElement[]}
      */
@@ -259,3 +258,3 @@ Target.prototype.getFloatingObjects = function () {
      * @param {Region|webdriver.WebElement|EyesRemoteWebElement|webdriver.By} region The region to validate.
-     * @param {webdriver.WebElement|EyesRemoteWebElement|String} [frame] The element which is the frame to switch to.
+     * @param {webdriver.WebElement|EyesRemoteWebElement|string} [frame] The element which is the frame to switch to.
      * @return {Target}
@@ -271,3 +270,3 @@ * @constructor
      *
-     * @param {EyesRemoteWebElement|webdriver.WebElement|String} frame The element which is the frame to switch to.
+     * @param {EyesRemoteWebElement|webdriver.WebElement|string} frame The element which is the frame to switch to.
      * @return {Target}
@@ -280,3 +279,3 @@ * @constructor
 
-    module.exports = Target;
+    exports.Target = Target;
 }());

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Number of package files

29

increased by16%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

25

increased by4.17%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

247298

decreased by-57.97%

Dependency count

4

increased by33.33%

Dev dependency count

4

increased by33.33%

Lines of code

5059

decreased by-63.57%

Number of low supply chain risk alerts

9

increased by200%

Dependency changes

• + Added@types/node@^9.6.6

• + Added@types/node@9.6.61(transitive)

• + Added@types/png-async@0.0.28(transitive)

• + Addeddateformat@3.0.3(transitive)

• + Addedeyes.sdk@0.0.69(transitive)

• + Addedeyes.utils@0.0.27(transitive)

• - Removed@colors/colors@1.6.0(transitive)

• - Removed@dabh/diagnostics@2.0.3(transitive)

• - Removed@types/triple-beam@1.3.5(transitive)

• - Removedasync@3.2.6(transitive)

• - Removedcolor@3.2.1(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedcolor-string@1.9.1(transitive)

• - Removedcolorspace@1.1.4(transitive)

• - Removedenabled@2.0.0(transitive)

• - Removedeyes.sdk@0.0.68(transitive)

• - Removedeyes.utils@0.0.26(transitive)

• - Removedfecha@4.2.3(transitive)

• - Removedfn.name@1.1.0(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedis-arrayish@0.3.2(transitive)

• - Removedis-stream@2.0.1(transitive)

• - Removedkuler@2.0.0(transitive)

• - Removedlogform@2.7.0(transitive)

• - Removedms@2.1.3(transitive)

• - Removedone-time@1.0.0(transitive)

• - Removedreadable-stream@3.6.2(transitive)

• - Removedsafe-stable-stringify@2.5.0(transitive)

• - Removedsimple-swizzle@0.2.2(transitive)

• - Removedstack-trace@0.0.10(transitive)

• - Removedstring_decoder@1.3.0(transitive)

• - Removedtext-hex@1.0.0(transitive)

• - Removedtriple-beam@1.4.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedwinston@3.17.0(transitive)

• - Removedwinston-transport@4.9.0(transitive)

• Updatedeyes.sdk@0.0.69

• Updatedeyes.utils@0.0.27