@appium/images-plugin 4.0.4 → 4.1.1

package/lib/compare.js

@@ -1,96 +0,0 @@
-import _ from 'lodash';
-import {errors} from 'appium/driver';
-import {getImagesMatches, getImagesSimilarity, getImageOccurrence} from '@appium/opencv';
-import {MATCH_FEATURES_MODE, GET_SIMILARITY_MODE, MATCH_TEMPLATE_MODE} from './constants';
-
-/**
- * @typedef {{visualization: string|null|undefined}} Visualized
- * @typedef {import('@appium/opencv').MatchingResult & Visualized} MatchingResult
- * @typedef {import('@appium/opencv').OccurrenceResult & Visualized} OccurrenceResult
- * @typedef {import('@appium/opencv').SimilarityResult & Visualized} SimilarityResult
- * @typedef {MatchingResult|OccurrenceResult|SimilarityResult|SimilarityResult[]} ComparisonResult
- */
-
-/**
- * Performs images comparison using OpenCV framework features.
- * It is expected that both OpenCV framework and opencv4nodejs
- * module are installed on the machine where Appium server is running.
- *
- * @param {string} mode - One of possible comparison modes:
- * matchFeatures, getSimilarity, matchTemplate
- * @param {string|Buffer} firstImage - Base64-encoded image file.
- * All image formats, that OpenCV library itself accepts, are supported.
- * @param {string|Buffer} secondImage - Base64-encoded image file.
- * All image formats, that OpenCV library itself accepts, are supported.
- * @param {import('@appium/opencv').MatchingOptions
- * |import('@appium/opencv').SimilarityOptions
- * |import('@appium/opencv').OccurrenceOptions} [options={}] - The content of this dictionary depends
- * on the actual `mode` value. See the documentation on `@appium/support`
- * module for more details.
- * @returns {Promise<ComparisonResult>} The content of the resulting dictionary depends
- * on the actual `mode` and `options` values. See the documentation on
- * `@appium/support` module for more details.
- * @throws {Error} If required OpenCV modules are not installed or
- * if `mode` value is incorrect or if there was an unexpected issue while
- * matching the images.
- */
-async function compareImages(mode, firstImage, secondImage, options = {}) {
-  const img1 = Buffer.isBuffer(firstImage) ? firstImage : Buffer.from(firstImage, 'base64');
-  const img2 = Buffer.isBuffer(secondImage) ? secondImage : Buffer.from(secondImage, 'base64');
-  let result;
-  switch (_.toLower(mode)) {
-    case MATCH_FEATURES_MODE.toLowerCase():
-      try {
-        result = await getImagesMatches(
-          img1, img2, /** @type {import('@appium/opencv').MatchingOptions} */(options)
-        );
-      } catch {
-        // might throw if no matches
-        result = /** @type {import('@appium/opencv').MatchingResult} */({count: 0});
-      }
-      break;
-    case GET_SIMILARITY_MODE.toLowerCase():
-      result = await getImagesSimilarity(
-        img1, img2, /** @type {import('@appium/opencv').SimilarityOptions} */(options));
-      break;
-    case MATCH_TEMPLATE_MODE.toLowerCase(): {
-      const opts = /** @type {import('@appium/opencv').OccurrenceOptions} */(options);
-      // firstImage/img1 is the full image and secondImage/img2 is the partial one
-      result = await getImageOccurrence(
-        img1, img2, opts
-      );
-      if (opts.multiple && result.multiple) {
-        return result.multiple.map(convertVisualizationToBase64);
-      }
-      break;
-    }
-    default:
-      throw new errors.InvalidArgumentError(
-        `'${mode}' images comparison mode is unknown. ` +
-          `Only ${JSON.stringify([
-            MATCH_FEATURES_MODE,
-            GET_SIMILARITY_MODE,
-            MATCH_TEMPLATE_MODE,
-          ])} modes are supported.`
-      );
-  }
-  return convertVisualizationToBase64(result);
-}
-
-/**
- * base64 encodes the visualization part of the result
- * (if necessary)
- *
- * @param {Partial<{visualization: Buffer|null}>} element - occurrence result
- * @returns {any} I know this looks ugly from the typing perspective
- **/
-function convertVisualizationToBase64(element) {
-  return Buffer.isBuffer(element.visualization)
-    ? {
-      ...(element),
-      visualization: element.visualization.toString('base64')
-    }
-    : element;
-}
-
-export {compareImages};

package/lib/constants.js

@@ -1,70 +0,0 @@
-import {node} from 'appium/support';
-
-export const IMAGE_STRATEGY = '-image';
-
-export const IMAGE_ELEMENT_PREFIX = 'appium-image-element-';
-export const IMAGE_EL_TAP_STRATEGY_W3C = 'w3cActions';
-export const IMAGE_EL_TAP_STRATEGY_MJSONWP = 'touchActions';
-export const IMAGE_TAP_STRATEGIES = [IMAGE_EL_TAP_STRATEGY_MJSONWP, IMAGE_EL_TAP_STRATEGY_W3C];
-export const DEFAULT_TEMPLATE_IMAGE_SCALE = 1.0;
-
-export const MATCH_FEATURES_MODE = 'matchFeatures';
-export const GET_SIMILARITY_MODE = 'getSimilarity';
-export const MATCH_TEMPLATE_MODE = 'matchTemplate';
-
-export const DEFAULT_MATCH_THRESHOLD = 0.4;
-
-export const DEFAULT_FIX_IMAGE_TEMPLATE_SCALE = 1;
-
-export const DEFAULT_SETTINGS = node.deepFreeze({
-  // value between 0 and 1 representing match strength, below which an image
-  // element will not be found
-  imageMatchThreshold: DEFAULT_MATCH_THRESHOLD,
-
-  // One of possible image matching methods.
-  // Read https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_imgproc/py_template_matching/py_template_matching.html
-  // for more details.
-  // TM_CCOEFF_NORMED by default
-  imageMatchMethod: '',
-
-  // if the image returned by getScreenshot differs in size or aspect ratio
-  // from the screen, attempt to fix it automatically
-  fixImageFindScreenshotDims: true,
-
-  // whether Appium should ensure that an image template sent in during image
-  // element find should have its size adjusted so the match algorithm will not
-  // complain
-  fixImageTemplateSize: false,
-
-  // whether Appium should ensure that an image template sent in during image
-  // element find should have its scale adjusted to display size so the match
-  // algorithm will not complain.
-  // e.g. iOS has `width=375, height=667` window rect, but its screenshot is
-  //      `width=750 × height=1334` pixels. This setting help to adjust the scale
-  //      if a user use `width=750 × height=1334` pixels's base template image.
-  fixImageTemplateScale: false,
-
-  // Users might have scaled template image to reduce their storage size.
-  // This setting allows users to scale a template image they send to Appium server
-  // so that the Appium server compares the actual scale users originally had.
-  // e.g. If a user has an image of 270 x 32 pixels which was originally 1080 x 126 pixels,
-  //      the user can set {defaultImageTemplateScale: 4.0} to scale the small image
-  //      to the original one so that Appium can compare it as the original one.
-  defaultImageTemplateScale: DEFAULT_TEMPLATE_IMAGE_SCALE,
-
-  // whether Appium should re-check that an image element can be matched
-  // against the current screenshot before clicking it
-  checkForImageElementStaleness: true,
-
-  // whether before clicking on an image element Appium should re-determine the
-  // position of the element on screen
-  autoUpdateImageElementPosition: false,
-
-  // which method to use for tapping by coordinate for image elements. the
-  // options are 'w3c' or 'mjsonwp'
-  imageElementTapStrategy: IMAGE_EL_TAP_STRATEGY_W3C,
-
-  // which method to use to save the matched image area in ImageElement class.
-  // It is used for debugging purpose.
-  getMatchedImageResult: false,
-});

package/lib/logger.js

@@ -1,5 +0,0 @@
-import {logger} from 'appium/support';
-
-const log = logger.getLogger('ImageElementPlugin');
-
-export default log;