eyes.selenium - npm Package Compare versions

Comparing version 0.0.79 to 0.0.80

package.json

 {
   "name": "eyes.selenium",
-  "version": "0.0.79",
+  "version": "0.0.80",
   "description": "Applitools Eyes SDK For Selenium JavaScript WebDriver",
@@ -48,5 +48,5 @@ "keywords": [
   "dependencies": {
-    "@types/node": "^9.6.6",
-    "eyes.utils": "0.0.27",
-    "eyes.sdk": "0.0.69",
+    "@types/node": "*",
+    "eyes.utils": "0.0.28",
+    "eyes.sdk": "0.0.70",
     "q": "^1.4.1"
@@ -53,0 +53,0 @@ },

src/Eyes.js

@@ -76,3 +76,3 @@ (function () {
     Eyes.prototype._getBaseAgentId = function () {
-        return 'selenium-js/0.0.78';
+        return 'eyes.selenium/0.0.78';
     };
@@ -99,3 +99,3 @@
      * @param {string} testName - The test name.
-     * @param {{width: number, height: number}} viewportSize - The required browser's
+     * @param {{width: number, height: number}} [viewportSize] - The required browser's
      * viewport size (i.e., the visible part of the document's body) or to use the current window's viewport.
@@ -188,4 +188,4 @@ * @return {Promise<WebDriver>} A wrapped WebDriver which enables Eyes trigger recording and
      * Ends the test.
-     * @param throwEx - If true, an exception will be thrown for failed/new tests.
-     * @return {*} The test results.
+     * @param [throwEx=true] - If true, an exception will be thrown for failed/new tests.
+     * @return {Promise<TestResults|undefined>} The test results.
      */
@@ -514,4 +514,4 @@ Eyes.prototype.close = function (throwEx) {
      * the expected output.
-     * @param {string} tag - An optional tag to be associated with the snapshot.
-     * @param {number} matchTimeout - The amount of time to retry matching (Milliseconds).
+     * @param {string} [tag=] - An optional tag to be associated with the snapshot.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching (Milliseconds).
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -527,6 +527,6 @@ */
      * using stitching to get an image of the frame.
-     * @param {EyesRemoteWebElement} - element The element which is the frame to switch to. (as
+     * @param {EyesRemoteWebElement} element - The element which is the frame to switch to. (as
      * would be used in a call to driver.switchTo().frame() ).
      * @param {number} matchTimeout - The amount of time to retry matching (milliseconds).
-     * @param {string} tag - An optional tag to be associated with the match.
+     * @param {string} [tag=] - An optional tag to be associated with the match.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -543,4 +543,4 @@ */
      * @param {webdriver.WebElement|EyesRemoteWebElement} element - The element to check.
-     * @param {int|null} matchTimeout - The amount of time to retry matching (milliseconds).
-     * @param {string} tag - An optional tag to be associated with the match.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching (milliseconds).
+     * @param {string} [tag=] - An optional tag to be associated with the match.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -557,4 +557,4 @@ */
      * @param {webdriver.By} locator - The element to check.
-     * @param {int|null} matchTimeout - The amount of time to retry matching (milliseconds).
-     * @param {string} tag - An optional tag to be associated with the match.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching (milliseconds).
+     * @param {string} [tag=] - An optional tag to be associated with the match.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -571,4 +571,4 @@ */
      * validate (in screenshot coordinates).
-     * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @param {string} [tag=] - An optional tag to be associated with the screenshot.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -584,4 +584,4 @@ */
      * @param {webdriver.WebElement|EyesRemoteWebElement} element - The element defining the region to validate.
-     * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @param {string} [tag=] - An optional tag to be associated with the screenshot.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -597,4 +597,4 @@ */
      * @param {webdriver.By} by - The WebDriver selector used for finding the region to validate.
-     * @param {string} tag - An optional tag to be associated with the screenshot.
-     * @param {number} matchTimeout - The amount of time to retry matching.
+     * @param {string} [tag=] - An optional tag to be associated with the screenshot.
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching.
      * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.
@@ -612,5 +612,5 @@ */
      * @param {webdriver.By} locator - A Selector specifying the region to check.
-     * @param {int|null} matchTimeout - The amount of time to retry matching. (Milliseconds)
-     * @param {string} tag - An optional tag to be associated with the snapshot.
-     * @param {boolean} stitchContent - If {@code true}, stitch the internal content of the region (i.e., perform
+     * @param {number} [matchTimeout=-1] - The amount of time to retry matching. (Milliseconds)
+     * @param {string} [tag=] - An optional tag to be associated with the snapshot.
+     * @param {boolean} [stitchContent=true] - If {@code true}, stitch the internal content of the region (i.e., perform
      *                  {@link #checkElement(By, int, string)} on the region.
@@ -617,0 +617,0 @@ * @return {Promise<{asExpected: boolean}>} A promise which is resolved when the validation is finished.

typings/index.d.ts

@@ -13,13 +13,17 @@ /* Type definitions for eyes.selenium 0.0.1 */
 import { PromiseFactory, Location, Region, RectangleSize } from 'eyes.utils';
-import { PositionProvider, RegionProvider, Logger, CutProvider, ScaleProviderFactory, MatchSettings, CoordinatesType, EyesScreenshot, EyesBase, MutableImage } from 'eyes.sdk';
+import { PositionProvider, RegionProvider, Logger, CutProvider, ScaleProviderFactory, MatchSettings, CoordinatesType,
+    EyesScreenshot, EyesBase, MutableImage, TestResults } from 'eyes.sdk';
 
-export { ArgumentGuard, GeneralUtils, GeometryUtils, ImageDeltaCompressor, ImageUtils, PromiseFactory,
-    PropertyHandler, SimplePropertyHandler, ReadOnlyPropertyHandler, StreamUtils } from 'eyes.utils';
 
+export { ArgumentGuard, GeneralUtils, GeometryUtils, ImageDeltaCompressor, ImageUtils, PromiseFactory, StreamUtils,
+    PropertyHandler, SimplePropertyHandler, ReadOnlyPropertyHandler, Location, Region, RectangleSize } from 'eyes.utils';
+
 export { ConsoleLogHandler, ContextBasedScaleProvider, ContextBasedScaleProviderFactory, CoordinatesType, CutProvider,
     EyesScreenshot, FileLogHandler, FixedCutProvider, FixedScaleProvider, FixedScaleProviderFactory, Logger, LogHandler,
     MatchSettings, MutableImage, NullCutProvider, NullLogHandler, NullScaleProvider, PositionProvider, RegionProvider,
-    ScaleProvider, ScaleProviderFactory, ScaleProviderIdentityFactory, ServerConnector, TestResultsFormatter, Triggers } from 'eyes.sdk';
+    ScaleProvider, ScaleProviderFactory, ScaleProviderIdentityFactory, ServerConnector, TestResultsFormatter, Triggers,
+    Trigger, RunningSession, BatchInfo, AppEnvironment, SessionStartInfo, TestResults} from 'eyes.sdk';
 
-interface FloatingRegion {
+
+export interface FloatingRegion {
     left: number;
@@ -35,3 +39,4 @@ top: number;
 
-interface FloatingElement {
+
+export interface FloatingElement {
     element: WebElement|EyesRemoteWebElement|By;
@@ -108,9 +113,9 @@ maxLeftOffset: number;
      */
-    open(driver: WebDriver, appName: string, testName: string, viewportSize: RectangleSize): Promise<WebDriver>;
+    open(driver: WebDriver, appName: string, testName: string, viewportSize?: RectangleSize): Promise<WebDriver>;
     /**
      * Ends the test.
-     * @param [throwEx] If true, an exception will be thrown for failed/new tests.
+     * @param [throwEx=true] If true, an exception will be thrown for failed/new tests.
      * @return The test results.
      */
-    close(throwEx?: boolean): any;
+    close(throwEx?: boolean): Promise<TestResults|undefined>;
     /**
@@ -125,55 +130,55 @@ * Preform visual validation
      * Takes a snapshot of the application under test and matches it with the expected output.
-     * @param tag An optional tag to be associated with the snapshot.
-     * @param matchTimeout The amount of time to retry matching (Milliseconds).
+     * @param [tag=] An optional tag to be associated with the snapshot.
+     * @param [matchTimeout=-1] The amount of time to retry matching (Milliseconds).
      * @return A promise which is resolved when the validation is finished.
      */
-    checkWindow(tag: string, matchTimeout: number): Promise<void>;
+    checkWindow(tag?: string, matchTimeout?: number): Promise<void>;
     /**
      * Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
      * @param element The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
-     * @param matchTimeout The amount of time to retry matching (milliseconds).
-     * @param tag An optional tag to be associated with the match.
+     * @param [matchTimeout=-1] The amount of time to retry matching (milliseconds).
+     * @param [tag=] An optional tag to be associated with the match.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkFrame(element: EyesRemoteWebElement, matchTimeout: number, tag: string): Promise<void>;
+    checkFrame(element: EyesRemoteWebElement, matchTimeout?: number, tag?: string): Promise<void>;
     /**
      * Takes a snapshot of the application under test and matches a specific element with the expected region output.
      * @param element The element to check.
-     * @param matchTimeout The amount of time to retry matching (milliseconds).
-     * @param tag An optional tag to be associated with the match.
+     * @param [matchTimeout=-1] The amount of time to retry matching (milliseconds).
+     * @param [tag=] An optional tag to be associated with the match.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkElement(element: WebElement|EyesRemoteWebElement, matchTimeout: number|null, tag: string): Promise<void>;
+    checkElement(element: WebElement|EyesRemoteWebElement, matchTimeout?: number, tag?: string): Promise<void>;
     /**
      * Takes a snapshot of the application under test and matches a specific element with the expected region output.
      * @param locator The element to check.
-     * @param matchTimeout The amount of time to retry matching (milliseconds).
-     * @param tag An optional tag to be associated with the match.
+     * @param [matchTimeout=-1] The amount of time to retry matching (milliseconds).
+     * @param [tag=] An optional tag to be associated with the match.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkElementBy(locator: By, matchTimeout: number|null, tag: string): Promise<void>;
+    checkElementBy(locator: By, matchTimeout?: number, tag?: string): Promise<void>;
     /**
      * Visually validates a region in the screenshot.
      * @param region The region to validate (in screenshot coordinates).
-     * @param tag An optional tag to be associated with the screenshot.
-     * @param matchTimeout - The amount of time to retry matching.
+     * @param [tag=] An optional tag to be associated with the screenshot.
+     * @param [matchTimeout=-1] The amount of time to retry matching.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkRegion(region: Region, matchTimeout: number|null, tag: string): Promise<void>;
+    checkRegion(region: Region, matchTimeout?: number, tag?: string): Promise<void>;
     /**
      * Visually validates a region in the screenshot.
      * @param element The element defining the region to validate.
-     * @param tag An optional tag to be associated with the screenshot.
-     * @param matchTimeout The amount of time to retry matching.
+     * @param [tag=] An optional tag to be associated with the screenshot.
+     * @param [matchTimeout=-1] The amount of time to retry matching.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkRegionByElement(element: WebElement|EyesRemoteWebElement, tag: string, matchTimeout: number|null): Promise<void>;
+    checkRegionByElement(element: WebElement|EyesRemoteWebElement, tag?: string, matchTimeout?: number): Promise<void>;
     /**
      * Visually validates a region in the screenshot.
      * @param by The WebDriver selector used for finding the region to validate.
-     * @param tag An optional tag to be associated with the screenshot.
-     * @param matchTimeout The amount of time to retry matching.
+     * @param [tag=] An optional tag to be associated with the screenshot.
+     * @param [matchTimeout=-1] The amount of time to retry matching.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkRegionBy(by: By, tag: string, matchTimeout: number|null): Promise<void>;
+    checkRegionBy(by: By, tag?: string, matchTimeout?: number): Promise<void>;
     /**
@@ -183,8 +188,8 @@ * Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
      * @param locator A Selector specifying the region to check.
-     * @param matchTimeout The amount of time to retry matching (Milliseconds).
-     * @param tag An optional tag to be associated with the snapshot.
-     * @param stitchContent If {@code true}, stitch the internal content of the region (i.e., perform {@link #checkElement(By, number, String)} on the region.
+     * @param [matchTimeout=-1] The amount of time to retry matching (Milliseconds).
+     * @param [tag=] An optional tag to be associated with the snapshot.
+     * @param [stitchContent=true] If {@code true}, stitch the internal content of the region (i.e., perform {@link #checkElement(By, number, String)} on the region.
      * @return A promise which is resolved when the validation is finished.
      */
-    checkRegionInFrame(frameNameOrId: string, locator: By, matchTimeout: number|null, tag: string, stitchContent: boolean): Promise<void>;
+    checkRegionInFrame(frameNameOrId: string, locator: By, matchTimeout?: number, tag?: string, stitchContent?: boolean): Promise<void>;
     /**
@@ -201,3 +206,3 @@ * Get an updated screenshot.
      */
-    setFailureReport(mode: any): void;
+    setFailureReport(mode: EyesBase.FailureReport): void;
     /**
@@ -306,3 +311,3 @@ * Get the viewport size.
 export declare class EyesRegionProvider extends RegionProvider {
-    constructor(logger: Logger, driver: any, region: Region, coordinatesType: CoordinatesType);
+    constructor(logger: Logger, driver: EyesWebDriver, region: Region, coordinatesType: CoordinatesType);
     /**
@@ -325,8 +330,8 @@ * @return A region with "as is" viewport coordinates.
     constructor(remoteWebElement: WebElement, eyesDriver: EyesWebDriver, logger: Logger);
-    static registerSendKeys(element: any, eyesDriver: any, logger: any, args: any): Promise<void>;
-    static registerClick(element: any, eyesDriver: any, logger: any): Promise<void>;
+    static registerSendKeys(element: EyesRemoteWebElement, eyesDriver: EyesWebDriver, logger: Logger, args: any[]): Promise<void>;
+    static registerClick(element: EyesRemoteWebElement, eyesDriver: EyesWebDriver, logger: Logger): Promise<void>;
     sendKeys(...var_args: any[]): promise.Promise<void>;
     click(): promise.Promise<void>;
-    findElement(locator: any): EyesRemoteWebElement;
-    findElements(locator: any): promise.Promise<EyesRemoteWebElement[]>;
+    findElement(locator: By|ProtractorBy): EyesRemoteWebElement;
+    findElements(locator: By|ProtractorBy): promise.Promise<EyesRemoteWebElement[]>;
     /**
@@ -490,3 +495,3 @@ * Returns the computed value of the style property for the current element.
      */
-    constructor(logger: Logger, driver: EyesWebDriver, image: any, promiseFactory: PromiseFactory);
+    constructor(logger: Logger, driver: EyesWebDriver, image: MutableImage, promiseFactory: PromiseFactory);
     /**
@@ -630,3 +635,3 @@ * @param screenshotType The screenshot's type (e.g., viewport/full page).
 export declare class Target {
-    constructor(region: any, frame: any);
+    constructor(region: Region|WebElement|EyesRemoteWebElement|By, frame: WebElement|EyesRemoteWebElement|String);
     /**
@@ -633,0 +638,0 @@ * @param ms Milliseconds to wait

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

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

Improved metrics

Total package byte prevSize

247832

increased by0.22%

Lines of code

5061

increased by0.04%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

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

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

• + Addedeyes.sdk@0.0.70(transitive)

• + Addedeyes.utils@0.0.28(transitive)

• + Addedundici-types@6.19.8(transitive)

• - Removed@types/node@9.6.61(transitive)

• - Removed@types/png-async@0.0.28(transitive)

• - Removedeyes.sdk@0.0.69(transitive)

• - Removedeyes.utils@0.0.27(transitive)

• Updated@types/node@*

• Updatedeyes.sdk@0.0.70

• Updatedeyes.utils@0.0.28