@applitools/eyes-testcafe 2.0.0-beta.9 → 3.0.0

package/lib/fluent/FrameLocator.js

@@ -1,110 +0,0 @@
-'use strict'
-
-/**
- * @ignore
- */
-class FrameLocator {
-  constructor() {
-    /** @type {WebElement} */
-    this._frameElement = null
-    /** @type {By} */
-    this._frameSelector = null
-    /** @type {string} */
-    this._frameNameOrId = undefined
-    /** @type {number} */
-    this._frameIndex = undefined
-    /** @type {By} */
-    this._scrollRootSelector = undefined
-    /** @type {WebElement} */
-    this._scrollRootElement = undefined
-  }
-
-  /**
-   * @return {number}
-   */
-  getFrameIndex() {
-    return this._frameIndex
-  }
-
-  /**
-   * @param {number} frameIndex
-   */
-  setFrameIndex(frameIndex) {
-    this._frameIndex = frameIndex
-  }
-
-  /**
-   * @return {string}
-   */
-  getFrameNameOrId() {
-    return this._frameNameOrId
-  }
-
-  /**
-   * @param {string} frameNameOrId
-   */
-  setFrameNameOrId(frameNameOrId) {
-    this._frameNameOrId = frameNameOrId
-  }
-
-  /**
-   * @return {By}
-   */
-  getFrameSelector() {
-    return this._frameSelector
-  }
-
-  /**
-   * @param {By} frameSelector
-   */
-  setFrameSelector(frameSelector) {
-    this._frameSelector = frameSelector
-  }
-
-  // noinspection JSUnusedGlobalSymbols
-  /**
-   * @return {WebElement}
-   */
-  getFrameElement() {
-    return this._frameElement
-  }
-
-  /**
-   * @param {WebElement} frameElement
-   */
-  setFrameElement(frameElement) {
-    this._frameElement = frameElement
-  }
-
-  // noinspection JSUnusedGlobalSymbols
-  /**
-   * @return {WebElement}
-   */
-  getScrollRootElement() {
-    return this._scrollRootElement
-  }
-
-  /**
-   * @param {WebElement} scrollRootElement
-   */
-  setScrollRootElement(scrollRootElement) {
-    this._scrollRootElement = scrollRootElement
-  }
-
-  // noinspection JSUnusedGlobalSymbols
-  /**
-   * @return {By}
-   */
-  getScrollRootSelector() {
-    return this._scrollRootSelector
-  }
-
-  /**
-   * @param {By} scrollRootSelector
-   */
-  setScrollRootSelector(scrollRootSelector) {
-    this._scrollRootSelector = scrollRootSelector
-  }
-}
-
-exports.FrameLocator = FrameLocator

package/lib/fluent/IgnoreRegionByElement.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const {Location, Region, CoordinatesType} = require('@applitools/eyes-common')
-const {GetRegion} = require('@applitools/eyes-sdk-core')
-
-const {SelectorByElement} = require('./SelectorByElement')
-
-/**
- * @ignore
- */
-class IgnoreRegionByElement extends GetRegion {
-  /**
-   * @param {WebElement} webElement
-   */
-  constructor(webElement) {
-    super()
-    this._element = webElement
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @override
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<Region[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    // eslint-disable-line no-unused-vars
-    const rect = await this._element.getRect()
-    const lTag = screenshot.convertLocation(
-      new Location(rect),
-      CoordinatesType.CONTEXT_RELATIVE,
-      CoordinatesType.SCREENSHOT_AS_IS,
-    )
-
-    return [new Region(lTag.getX(), lTag.getY(), rect.width, rect.height)]
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @return {Promise<string>}
-   */
-  async getSelector(eyes) {
-    // eslint-disable-line no-unused-vars
-    return new SelectorByElement(this._element).getSelector(eyes)
-  }
-}
-
-exports.IgnoreRegionByElement = IgnoreRegionByElement

package/lib/fluent/IgnoreRegionBySelector.js

@@ -1,57 +0,0 @@
-'use strict'
-
-const {GetRegion, CoordinatesType, Location, Region} = require('@applitools/eyes-sdk-core')
-
-const {SelectorByLocator} = require('./SelectorByLocator')
-
-/**
- * @ignore
- */
-class IgnoreRegionBySelector extends GetRegion {
-  /**
-   * @param {By} regionSelector
-   */
-  constructor(regionSelector) {
-    super()
-    this._selector = regionSelector
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @param {EyesScreenshot} screenshot
-   * @return {Promise<Region[]>}
-   */
-  async getRegion(eyes, screenshot) {
-    const elements = await eyes.getDriver().findElements(this._selector)
-
-    const values = []
-    if (elements && elements.length > 0) {
-      for (let i = 0; i < elements.length; i += 1) {
-        const rect = await elements[i].getRect()
-        const lTag = screenshot.convertLocation(
-          new Location(rect),
-          CoordinatesType.CONTEXT_RELATIVE,
-          CoordinatesType.SCREENSHOT_AS_IS,
-        )
-        values.push(new Region(lTag.getX(), lTag.getY(), rect.width, rect.height))
-      }
-    }
-
-    return values
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @return {Promise<string>}
-   */
-  async getSelector(eyes) {
-    // eslint-disable-line no-unused-vars
-    return new SelectorByLocator(this._selector).getSelector(eyes)
-  }
-}
-
-exports.IgnoreRegionBySelector = IgnoreRegionBySelector

package/lib/fluent/SelectorByElement.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const {GeneralUtils} = require('@applitools/eyes-common')
-const {GetSelector} = require('@applitools/eyes-sdk-core')
-
-const EYES_SELECTOR_TAG = 'data-eyes-selector'
-
-/**
- * @ignore
- */
-class SelectorByElement extends GetSelector {
-  /**
-   * @param {WebElement} webElement
-   */
-  constructor(webElement) {
-    super()
-    this._element = webElement
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @return {Promise<string>}
-   */
-  async getSelector(eyes) {
-    // eslint-disable-line no-unused-vars
-    const randId = GeneralUtils.randomAlphanumeric()
-    await eyes._driver.executeScript(
-      `arguments[0].setAttribute('${EYES_SELECTOR_TAG}', '${randId}');`,
-      this._element,
-    )
-    return `[${EYES_SELECTOR_TAG}="${randId}"]`
-  }
-}
-
-exports.SelectorByElement = SelectorByElement

package/lib/fluent/SelectorByLocator.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const {GeneralUtils} = require('@applitools/eyes-common')
-const {GetSelector} = require('@applitools/eyes-sdk-core')
-
-const EYES_SELECTOR_TAG = 'data-eyes-selector'
-
-/**
- * @ignore
- */
-class SelectorByLocator extends GetSelector {
-  /**
-   * @param {By} regionLocator
-   */
-  constructor(regionLocator) {
-    super()
-    this._selector = regionLocator
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {Eyes} eyes
-   * @return {Promise<string>}
-   */
-  async getSelector(eyes) {
-    // eslint-disable-line no-unused-vars
-    if (this._selector.using === 'css selector') {
-      return this._selector.value
-    }
-
-    const randId = GeneralUtils.randomAlphanumeric()
-    const elements = await eyes._driver.findElements(this._selector)
-    if (elements && elements.length > 0) {
-      for (let i = 0; i < elements.length; i += 1) {
-        await eyes._driver.executeScript(
-          `arguments[0].setAttribute('${EYES_SELECTOR_TAG}', '${randId}');`,
-          elements[i],
-        )
-      }
-    }
-
-    return `[${EYES_SELECTOR_TAG}="${randId}"]`
-  }
-}
-
-exports.SelectorByLocator = SelectorByLocator

package/lib/fluent/Target.js

@@ -1,17 +0,0 @@
-'use strict'
-
-const {TestcafeCheckSettings} = require('./TestcafeCheckSettings')
-
-class Target {
-  /**
-   * Validate current window
-   *
-   * @return {TestcafeCheckSettings}
-   * @constructor
-   */
-  static window() {
-    return new TestcafeCheckSettings()
-  }
-}
-
-exports.Target = Target

package/lib/fluent/TestcafeCheckSettings.js

@@ -1,352 +0,0 @@
-'use strict'
-
-const {TypeUtils, Region} = require('@applitools/eyes-common')
-const {CheckSettings} = require('@applitools/eyes-sdk-core')
-
-const {IgnoreRegionBySelector} = require('./IgnoreRegionBySelector')
-// const {IgnoreRegionByElement} = require('./IgnoreRegionByElement')
-const {FloatingRegionBySelector} = require('./FloatingRegionBySelector')
-// const {FloatingRegionByElement} = require('./FloatingRegionByElement')
-const {AccessibilityRegionBySelector} = require('./AccessibilityRegionBySelector')
-// const {AccessibilityRegionByElement} = require('./AccessibilityRegionByElement')
-const {SelectorByElement} = require('./SelectorByElement')
-const {SelectorByLocator} = require('./SelectorByLocator')
-const {FrameLocator} = require('./FrameLocator')
-const {EyesWebElement} = require('../wrappers/EyesWebElement')
-
-const BEFORE_CAPTURE_SCREENSHOT = 'beforeCaptureScreenshot'
-
-class TestcafeCheckSettings extends CheckSettings {
-  /**
-   * @param {Region|RegionObject|By|WebElement|EyesWebElement|string} [region]
-   * @param {number|string|By|WebElement|EyesWebElement} [frame]
-   */
-  constructor(region, frame) {
-    super()
-
-    this._targetSelector = null
-    this._targetElement = null
-    this._frameChain = []
-
-    /** @type {By} */
-    this._scrollRootSelector = undefined
-    /** @type {WebElement} */
-    this._scrollRootElement = undefined
-
-    if (region) {
-      this.region(region)
-    }
-
-    if (frame) {
-      this.frame(frame)
-    }
-
-    /** @type {Object<string, string>} */ this._scriptHooks = {}
-  }
-
-  /**
-   * @package
-   * @ignore
-   * @return {?GetSelector}
-   */
-  getTargetProvider() {
-    if (this._targetSelector) {
-      return new SelectorByLocator(this._targetSelector)
-    }
-
-    if (this._targetElement) {
-      return new SelectorByElement(this._targetElement)
-    }
-
-    return undefined
-  }
-
-  /**
-   * @package
-   * @ignore
-   * @return {By}
-   */
-  getTargetSelector() {
-    return this._targetSelector
-  }
-
-  /**
-   * @package
-   * @ignore
-   * @return {WebElement}
-   */
-  getTargetElement() {
-    return this._targetElement
-  }
-
-  /**
-   * @package
-   * @ignore
-   * @return {FrameLocator[]}
-   */
-  getFrameChain() {
-    return this._frameChain
-  }
-
-  /**
-   * @param {number|string|By|WebElement|EyesWebElement} frame - The frame to switch to.
-   * @return {this}
-   */
-  frame(frame) {
-    const fl = new FrameLocator()
-    // noinspection IfStatementWithTooManyBranchesJS
-    if (TypeUtils.isInteger(frame)) {
-      fl.setFrameIndex(frame)
-    } else if (TypeUtils.isString(frame)) {
-      fl.setFrameNameOrId(frame)
-    } else if (EyesWebElement.isLocator(frame)) {
-      fl.setFrameSelector(frame)
-    } /*  else if (frame instanceof WebElement) {
-      fl.setFrameElement(frame)
-    } */ else {
-      throw new TypeError('frame method called with argument of unknown type!')
-    }
-    this._frameChain.push(fl)
-    return this
-  }
-
-  /**
-   * @param {Region|RegionObject|By|WebElement|EyesWebElement|string} region - The region to validate.
-   * @return {this}
-   */
-  region(region) {
-    // noinspection IfStatementWithTooManyBranchesJS
-    if (Region.isRegionCompatible(region)) {
-      super.updateTargetRegion(region)
-    } else if (TypeUtils.isString(region)) {
-      // this._targetSelector = By.css(region) // TODO: avoid converting to element for VisualGrid
-    } else if (EyesWebElement.isLocator(region)) {
-      this._targetSelector = region
-    } /* else if (region instanceof WebElement) {
-      this._targetElement = region
-    } */ else {
-      throw new TypeError('region method called with argument of unknown type!')
-    }
-    return this
-  }
-
-  // noinspection JSMethodCanBeStatic
-  /**
-   * @inheritDoc
-   * @protected
-   * @param {By|WebElement|EyesWebElement|GetRegion|Region} region
-   */
-  _regionToRegionProvider(region) {
-    if (EyesWebElement.isLocator(region)) {
-      return new IgnoreRegionBySelector(region)
-    }
-
-    // if (region instanceof WebElement) {
-    //   return new IgnoreRegionByElement(region)
-    // }
-
-    return super._regionToRegionProvider(region)
-  }
-
-  /**
-   * @inheritDoc
-   * @param {...(By|WebElement|EyesWebElement|GetRegion|Region)} regions - A region to ignore when validating.
-   * @return {this}
-   */
-  ignoreRegions(...regions) {
-    // noinspection JSValidateTypes
-    return super.ignoreRegions(...regions)
-  }
-
-  /**
-   * @inheritDoc
-   * @param {...(By|WebElement|EyesWebElement|GetRegion|Region)} regions - A region to match using the Layout method.
-   * @return {this}
-   */
-  layoutRegions(...regions) {
-    // noinspection JSValidateTypes
-    return super.layoutRegions(...regions)
-  }
-
-  /**
-   * @inheritDoc
-   * @param {...(By|WebElement|EyesWebElement|GetRegion|Region)} regions - A region to match using the Strict method.
-   * @return {this}
-   */
-  strictRegions(...regions) {
-    // noinspection JSValidateTypes
-    return super.strictRegions(...regions)
-  }
-
-  /**
-   * @inheritDoc
-   * @param {...(By|WebElement|EyesWebElement|GetRegion|Region)} regions - A region to match using the Content method.
-   * @return {this}
-   */
-  contentRegions(...regions) {
-    // noinspection JSValidateTypes
-    return super.contentRegions(...regions)
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {GetFloatingRegion|Region|FloatingMatchSettings|By|WebElement|EyesWebElement} regionOrContainer - The content
-   *   rectangle or region container
-   * @param {number} [maxUpOffset] - How much the content can move up.
-   * @param {number} [maxDownOffset] - How much the content can move down.
-   * @param {number} [maxLeftOffset] - How much the content can move to the left.
-   * @param {number} [maxRightOffset] - How much the content can move to the right.
-   * @return {this}
-   */
-  floatingRegion(regionOrContainer, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
-    if (EyesWebElement.isLocator(regionOrContainer)) {
-      const floatingRegion = new FloatingRegionBySelector(
-        regionOrContainer,
-        maxUpOffset,
-        maxDownOffset,
-        maxLeftOffset,
-        maxRightOffset,
-      )
-      this._floatingRegions.push(floatingRegion)
-    } /*  else if (regionOrContainer instanceof WebElement) {
-      const floatingRegion = new FloatingRegionByElement(
-        regionOrContainer,
-        maxUpOffset,
-        maxDownOffset,
-        maxLeftOffset,
-        maxRightOffset,
-      )
-      this._floatingRegions.push(floatingRegion)
-    }  */ else {
-      super.floatingRegion(
-        regionOrContainer,
-        maxUpOffset,
-        maxDownOffset,
-        maxLeftOffset,
-        maxRightOffset,
-      )
-    }
-    return this
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {number} maxOffset - How much each of the content rectangles can move in any direction.
-   * @param {...(GetFloatingRegion|Region|By|WebElement|EyesWebElement)} regionsOrContainers - One or more content
-   *   rectangles or region containers
-   * @return {this}
-   */
-  floatingRegions(maxOffset, ...regionsOrContainers) {
-    return super.floatingRegions(maxOffset, ...regionsOrContainers)
-  }
-
-  // noinspection JSCheckFunctionSignatures
-  /**
-   * @inheritDoc
-   * @param {GetAccessibilityRegion|Region|AccessibilityMatchSettings|By|WebElement|EyesWebElement} regionOrContainer - The
-   *   content rectangle or region container
-   * @param {AccessibilityRegionType} [regionType] - Type of accessibility.
-   * @return {this}
-   */
-  accessibilityRegion(regionOrContainer, regionType) {
-    if (EyesWebElement.isLocator(regionOrContainer)) {
-      const accessibilityRegion = new AccessibilityRegionBySelector(regionOrContainer, regionType)
-      this._accessibilityRegions.push(accessibilityRegion)
-    } /* else if (regionOrContainer instanceof WebElement) {
-      const floatingRegion = new AccessibilityRegionByElement(regionOrContainer, regionType)
-      this._accessibilityRegions.push(floatingRegion)
-    }  */ else {
-      super.accessibilityRegion(regionOrContainer, regionType)
-    }
-    return this
-  }
-
-  /**
-   * @ignore
-   * @return {string}
-   */
-  getSizeMode() {
-    if (!this._targetRegion && !this._targetElement && !this._targetSelector) {
-      if (this.getStitchContent()) {
-        return 'full-page'
-      }
-      return 'viewport'
-    }
-    if (this._targetRegion) {
-      if (this.getStitchContent()) {
-        return 'region'
-      }
-      return 'region'
-    }
-    if (this.getStitchContent()) {
-      return 'selector'
-    }
-    return 'selector'
-  }
-
-  /**
-   * @param {By|WebElement|EyesWebElement} element
-   * @return {this}
-   */
-  scrollRootElement(element) {
-    if (EyesWebElement.isLocator(element)) {
-      if (this._frameChain.length === 0) {
-        this._scrollRootSelector = element
-      } else {
-        this._frameChain[this._frameChain.length - 1].setScrollRootSelector(element)
-      }
-    } else if (this._frameChain.length === 0) {
-      this._scrollRootElement = element
-    } else {
-      this._frameChain[this._frameChain.length - 1].setScrollRootElement(element)
-    }
-
-    return this
-  }
-
-  /**
-   * @ignore
-   * @return {Promise<WebElement>}
-   */
-  getScrollRootElement() {
-    return this._scrollRootElement
-  }
-
-  /**
-   * @ignore
-   * @return {By}
-   */
-  getScrollRootSelector() {
-    return this._scrollRootSelector
-  }
-
-  /**
-   * @deprecated
-   * @param {String} hook
-   * @return {this}
-   */
-  webHook(hook) {
-    return this.beforeRenderScreenshotHook(hook)
-  }
-
-  /**
-   * @param {String} hook
-   * @return {this}
-   */
-  beforeRenderScreenshotHook(hook) {
-    this._scriptHooks[BEFORE_CAPTURE_SCREENSHOT] = hook
-    return this
-  }
-
-  /**
-   * @ignore
-   * @return {Object<string, string>}
-   */
-  getScriptHooks() {
-    return this._scriptHooks
-  }
-}
-
-exports.TestcafeCheckSettings = TestcafeCheckSettings