@applitools/eyes-images 4.20.0 → 4.22.0

package/lib/fluent/ImagesCheckSettings.js

@@ -1,217 +0,0 @@
-'use strict'
-
-const {CheckSettings, Location, RectangleSize} = require('@applitools/eyes-sdk-core')
-
-class ImagesCheckSettings extends CheckSettings {
-  /**
-   * @param {MutableImage} [image]
-   * @param {Buffer} [buffer]
-   * @param {string} [base64]
-   * @param {string} [path]
-   * @param {string} [url]
-   */
-  constructor(image, buffer, base64, path, url) {
-    super()
-
-    this._image = image
-    this._imageBuffer = buffer
-    this._imageBase64 = base64
-    this._imagePath = path
-    this._imageUrl = url
-    this._imageProvider = null
-
-    /** @type {RectangleSize} */
-    this._imageSize = undefined
-    /** @type {string} */
-    this._domString = undefined
-    /** @type {Location} */
-    this._imageLocation = undefined
-    /** @type {boolean} */
-    this._ignoreMismatch = false
-    /** @type {string} */
-    this._variantId = undefined
-  }
-
-  /**
-   * @package
-   * @return {MutableImage}
-   */
-  getMutableImage() {
-    return this._image
-  }
-
-  /**
-   * @package
-   * @return {Buffer}
-   */
-  getImageBuffer() {
-    return this._imageBuffer
-  }
-
-  /**
-   * @package
-   * @param {Buffer} imageBuffer
-   */
-  setImageBuffer(imageBuffer) {
-    this._imageBuffer = imageBuffer
-  }
-
-  /**
-   * @package
-   * @return {string}
-   */
-  getImageString() {
-    return this._imageBase64
-  }
-
-  /**
-   * @package
-   * @param {string} base64String
-   */
-  setImageString(base64String) {
-    this._imageBase64 = base64String
-  }
-
-  /**
-   * @package
-   * @return {string}
-   */
-  getImagePath() {
-    return this._imagePath
-  }
-
-  /**
-   * @package
-   * @param {string} imagePath
-   */
-  setImagePath(imagePath) {
-    this._imagePath = imagePath
-  }
-
-  /**
-   * @package
-   * @return {string}
-   */
-  getImageUrl() {
-    return this._imageUrl
-  }
-
-  /**
-   * @package
-   * @param {string} imageUrl
-   * @param {RectangleSize|RectangleSizeObject} [imageSize]
-   */
-  setImageUrl(imageUrl, imageSize) {
-    this._imageUrl = imageUrl
-
-    if (imageSize) {
-      this.imageSize(imageSize)
-    }
-  }
-
-  /**
-   * @package
-   * @return {ImageProvider}
-   */
-  getImageProvider() {
-    return this._imageProvider
-  }
-
-  /**
-   * @package
-   * @param {ImageProvider} imageProvider
-   */
-  setImageProvider(imageProvider) {
-    this._imageProvider = imageProvider
-  }
-
-  /**
-   * @param {RectangleSize} imageSize
-   * @return {this} - This instance of the settings object.
-   */
-  imageSize(imageSize) {
-    this._imageSize = new RectangleSize(imageSize)
-    return this
-  }
-
-  /**
-   * @package
-   * @return {RectangleSize}
-   */
-  getImageSize() {
-    return this._imageSize
-  }
-
-  /**
-   * @param {string} domString
-   * @return {this} - This instance of the settings object.
-   */
-  withDom(domString) {
-    this._sendDom = true
-    this._domString = domString
-    return this
-  }
-
-  /**
-   * @package
-   * @return {string}
-   */
-  getDomString() {
-    return this._domString
-  }
-
-  /**
-   * @param {Location|LocationObject} location
-   * @return {this} - This instance of the settings object.
-   */
-  withLocation(location) {
-    this._imageLocation = new Location(location)
-    return this
-  }
-
-  /**
-   * @package
-   * @return {Location}
-   */
-  getImageLocation() {
-    return this._imageLocation
-  }
-
-  /**
-   * @param {boolean} [ignoreMismatch=true] - True if the server should ignore a negative result for the visual validation.
-   *  Default value is `false`, but if you call to .ignoreMismatch() without arguments it will set value to `true`.
-   * @return {this}
-   */
-  ignoreMismatch(ignoreMismatch = true) {
-    this._ignoreMismatch = ignoreMismatch
-    return this
-  }
-
-  /**
-   * @package
-   * @return {boolean}
-   */
-  getIgnoreMismatch() {
-    return this._ignoreMismatch
-  }
-
-  /**
-   * @param {Region|RegionObject} region - The region to validate.
-   * @return {this}
-   */
-  region(region) {
-    super.updateTargetRegion(region)
-    return this
-  }
-
-  variantId(variantId) {
-    this._variantId = variantId
-    return this
-  }
-
-  getVariantId() {
-    return this._variantId
-  }
-}
-
-exports.ImagesCheckSettings = ImagesCheckSettings

package/lib/fluent/Target.js

@@ -1,158 +0,0 @@
-'use strict'
-
-const {ImageProvider, MutableImage, TypeUtils, ArgumentGuard} = require('@applitools/eyes-sdk-core')
-
-const {ImagesCheckSettings} = require('./ImagesCheckSettings')
-
-class Target {
-  /**
-   * @signature `image(base64String)`
-   * @sigparam {string} base64String - A base64 encoded image to use as the checkpoint image
-   *
-   * @signature `image(url)`
-   * @sigparam {string} url - A URL of the PNG image to download and use as the checkpoint image
-   *
-   * @signature `image(filePath)`
-   * @sigparam {string} filePath - Path to a local PNG file to use as the checkpoint image
-   *
-   * @signature `image(imageBuffer)`
-   * @sigparam {Buffer} imageBuffer - A Buffer object that contains an image to use as checkpoint image
-   *
-   * @signature `image(mutableImage)`
-   * @sigparam {MutableImage} mutableImage - An in memory image to use as the checkpoint image
-   *
-   * @signature `image(imageProvider)`
-   * @sigparam {ImageProvider} imageProvider - An instance of class (object) which implements {@link ImageProvider}
-   *  (has a method called {@code getImage} which returns {@code Promise<MutableImage>})
-   *
-   * @param {string|Buffer|ImageProvider|MutableImage} varArg
-   * @return {ImagesCheckSettings}
-   */
-  static image(varArg) {
-    if (varArg instanceof MutableImage) {
-      return new ImagesCheckSettings(varArg)
-    }
-
-    if (varArg instanceof ImageProvider) {
-      return Target.imageProvider(varArg)
-    }
-
-    if (TypeUtils.isBuffer(varArg)) {
-      return Target.buffer(varArg)
-    }
-
-    if (TypeUtils.isBase64(varArg)) {
-      return Target.base64(varArg)
-    }
-
-    if (TypeUtils.isUrl(varArg)) {
-      return Target.url(varArg)
-    }
-
-    if (TypeUtils.isString(varArg)) {
-      return Target.path(varArg)
-    }
-
-    throw new TypeError('IllegalType: unsupported type of image!')
-  }
-
-  /**
-   * @param {Buffer} imageBuffer
-   * @return {ImagesCheckSettings}
-   */
-  static buffer(imageBuffer) {
-    ArgumentGuard.isBuffer(imageBuffer, 'buffer')
-
-    const checkSettings = new ImagesCheckSettings()
-    checkSettings.setImageBuffer(imageBuffer)
-    return checkSettings
-  }
-
-  /**
-   * @param {string} imageBase64
-   * @return {ImagesCheckSettings}
-   */
-  static base64(imageBase64) {
-    ArgumentGuard.isBase64(imageBase64)
-
-    const checkSettings = new ImagesCheckSettings()
-    checkSettings.setImageString(imageBase64)
-    return checkSettings
-  }
-
-  /**
-   * @param {string} imagePath
-   * @return {ImagesCheckSettings}
-   */
-  static path(imagePath) {
-    ArgumentGuard.isString(imagePath, 'path')
-
-    const checkSettings = new ImagesCheckSettings()
-    checkSettings.setImagePath(imagePath)
-    return checkSettings
-  }
-
-  /**
-   * @param {string} imageUrl
-   * @param {RectangleSize} [imageSize]
-   * @return {ImagesCheckSettings}
-   */
-  static url(imageUrl, imageSize) {
-    ArgumentGuard.isString(imageUrl, 'url')
-
-    const checkSettings = new ImagesCheckSettings()
-    checkSettings.setImageUrl(imageUrl, imageSize)
-    return checkSettings
-  }
-
-  /**
-   * @param {ImageProvider} imageProvider
-   * @return {ImagesCheckSettings}
-   */
-  static imageProvider(imageProvider) {
-    ArgumentGuard.isValidType(imageProvider, ImageProvider)
-
-    const checkSettings = new ImagesCheckSettings()
-    checkSettings.setImageProvider(imageProvider)
-    return checkSettings
-  }
-
-  /**
-   * @signature `region(base64String, rect)`
-   * @sigparam {string} base64String - A base64 encoded image to use as the checkpoint image
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @signature `region(url, rect)`
-   * @sigparam {string} url - A URL of the PNG image to download and use as the checkpoint image
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @signature `region(filePath, rect)`
-   * @sigparam {string} filePath - Path to a local PNG file to use as the checkpoint image
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @signature `region(imageBuffer, rect)`
-   * @sigparam {Buffer} imageBuffer - A Buffer object that contains an image to use as checkpoint image
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @signature `region(mutableImage, rect)`
-   * @sigparam {MutableImage} mutableImage - An in memory image to use as the checkpoint image
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @signature `region(imageProvider, rect)`
-   * @sigparam {ImageProvider} imageProvider - An instance of class (object) which implements {@link ImageProvider}
-   *  (has a method called {@code getImage} which returns {@code Promise<MutableImage>})
-   * @sigparam {Region|RegionObject} rect - A region within the image to be checked
-   *
-   * @param {string|Buffer|MutableImage} image
-   * @param {Region|RegionObject} rect
-   * @return {ImagesCheckSettings}
-   */
-  static region(image, rect) {
-    const checkSettings = Target.image(image)
-
-    checkSettings.region(rect)
-    return checkSettings
-  }
-}
-
-exports.Target = Target