@appium/images-plugin 1.1.4 → 1.1.9

package/LICENSE

@@ -178,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright JS Foundation and other contributors, https://js.foundation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -30,7 +30,7 @@ No special action is needed to make the features available in the various Appium
 The plugin will not be active unless turned on when invoking the Appium server:
 
 ```
-appium --plugins=images
+appium --use-plugins=images
 ```
 
 ## Usage

package/build/lib/compare.d.ts

@@ -0,0 +1,28 @@
+export type OccurrenceResult = import('@appium/opencv').OccurrenceResult;
+/**
+ * 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} firstImage - Base64-encoded image file.
+ * All image formats, that OpenCV library itself accepts, are supported.
+ * @param {string} secondImage - Base64-encoded image file.
+ * All image formats, that OpenCV library itself accepts, are supported.
+ * @param {?Object} options [{}] - The content of this dictionary depends
+ * on the actual `mode` value. See the documentation on `@appium/support`
+ * module for more details.
+ * @returns {Object} 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.
+ */
+export function compareImages(mode: string, firstImage: string, secondImage: string, options?: any | null): any;
+export const DEFAULT_MATCH_THRESHOLD: 0.4;
+export const MATCH_TEMPLATE_MODE: "matchTemplate";
+export const MATCH_FEATURES_MODE: "matchFeatures";
+export const GET_SIMILARITY_MODE: "getSimilarity";
+//# sourceMappingURL=compare.d.ts.map

package/build/lib/compare.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":"+BAgFa,OAAO,gBAAgB,EAAE,gBAAgB;AAtEtD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oCAhBW,MAAM,cAEN,MAAM,eAEN,MAAM,6BAwChB;AAnDD,0CAAoC;AAFpC,kDAA4C;AAF5C,kDAA4C;AAC5C,kDAA4C"}

package/build/lib/compare.js

@@ -1,21 +1,21 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GET_SIMILARITY_MODE = exports.MATCH_FEATURES_MODE = exports.MATCH_TEMPLATE_MODE = exports.DEFAULT_MATCH_THRESHOLD = exports.compareImages = void 0;
-const lodash_1 = __importDefault(require("lodash"));
-const appium_base_driver_1 = require("appium-base-driver");
-const appium_support_1 = require("appium-support");
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.MATCH_TEMPLATE_MODE = exports.MATCH_FEATURES_MODE = exports.GET_SIMILARITY_MODE = exports.DEFAULT_MATCH_THRESHOLD = void 0;
+exports.compareImages = compareImages;
+
+require("source-map-support/register");
+
+var _lodash = _interopRequireDefault(require("lodash"));
+
+var _baseDriver = require("@appium/base-driver");
+
+var _opencv = require("@appium/opencv");
+
 const MATCH_FEATURES_MODE = 'matchFeatures';
 exports.MATCH_FEATURES_MODE = MATCH_FEATURES_MODE;
 const GET_SIMILARITY_MODE = 'getSimilarity';
@@ -24,52 +24,49 @@ const MATCH_TEMPLATE_MODE = 'matchTemplate';
 exports.MATCH_TEMPLATE_MODE = MATCH_TEMPLATE_MODE;
 const DEFAULT_MATCH_THRESHOLD = 0.4;
 exports.DEFAULT_MATCH_THRESHOLD = DEFAULT_MATCH_THRESHOLD;
-/**
- * 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} firstImage - Base64-encoded image file.
- * All image formats, that OpenCV library itself accepts, are supported.
- * @param {string} secondImage - Base64-encoded image file.
- * All image formats, that OpenCV library itself accepts, are supported.
- * @param {?Object} options [{}] - The content of this dictionary depends
- * on the actual `mode` value. See the documentation on `appium-support`
- * module for more details.
- * @returns {Object} 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.
- */
-function compareImages(mode, firstImage, secondImage, options = {}) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const img1 = Buffer.from(firstImage, 'base64');
-        const img2 = Buffer.from(secondImage, 'base64');
-        let result = {};
-        switch (lodash_1.default.toLower(mode)) {
-            case MATCH_FEATURES_MODE.toLowerCase():
-                result = yield appium_support_1.imageUtil.getImagesMatches(img1, img2, options);
-                break;
-            case GET_SIMILARITY_MODE.toLowerCase():
-                result = yield appium_support_1.imageUtil.getImagesSimilarity(img1, img2, options);
-                break;
-            case MATCH_TEMPLATE_MODE.toLowerCase():
-                // firstImage/img1 is the full image and secondImage/img2 is the partial one
-                result = yield appium_support_1.imageUtil.getImageOccurrence(img1, img2, options);
-                break;
-            default:
-                throw new appium_base_driver_1.errors.InvalidArgumentError(`'${mode}' images comparison mode is unknown. ` +
-                    `Only ${JSON.stringify([MATCH_FEATURES_MODE, GET_SIMILARITY_MODE, MATCH_TEMPLATE_MODE])} modes are supported.`);
-        }
-        if (!lodash_1.default.isEmpty(result.visualization)) {
-            result.visualization = result.visualization.toString('base64');
-        }
-        return result;
-    });
+
+async function compareImages(mode, firstImage, secondImage, options = {}) {
+  const img1 = Buffer.from(firstImage, 'base64');
+  const img2 = Buffer.from(secondImage, 'base64');
+  let result = null;
+
+  switch (_lodash.default.toLower(mode)) {
+    case MATCH_FEATURES_MODE.toLowerCase():
+      try {
+        result = await (0, _opencv.getImagesMatches)(img1, img2, options);
+      } catch (err) {
+        result = {
+          count: 0
+        };
+      }
+
+      break;
+
+    case GET_SIMILARITY_MODE.toLowerCase():
+      result = await (0, _opencv.getImagesSimilarity)(img1, img2, options);
+      break;
+
+    case MATCH_TEMPLATE_MODE.toLowerCase():
+      result = await (0, _opencv.getImageOccurrence)(img1, img2, options);
+
+      if (options.multiple) {
+        return result.multiple.map(convertVisualizationToBase64);
+      }
+
+      break;
+
+    default:
+      throw new _baseDriver.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);
 }
-exports.compareImages = compareImages;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGFyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi9jb21wYXJlLmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUF1QjtBQUN2QiwyREFBNEM7QUFDNUMsbURBQTJDO0FBRTNDLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBb0QwQixrREFBbUI7QUFuRHpGLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBb0QxQyxrREFBbUI7QUFuRHJCLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBa0RLLGtEQUFtQjtBQWhEcEUsTUFBTSx1QkFBdUIsR0FBRyxHQUFHLENBQUM7QUFnRFosMERBQXVCO0FBOUMvQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7QUFDSCxTQUFlLGFBQWEsQ0FBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLFdBQVcsRUFBRSxPQUFPLEdBQUcsRUFBRTs7UUFDdkUsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDL0MsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDaEQsSUFBSSxNQUFNLEdBQUcsRUFBRSxDQUFDO1FBQ2hCLFFBQVEsZ0JBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDdkIsS0FBSyxtQkFBbUIsQ0FBQyxXQUFXLEVBQUU7Z0JBQ3BDLE1BQU0sR0FBRyxNQUFNLDBCQUFTLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxPQUFPLENBQUMsQ0FBQztnQkFDL0QsTUFBTTtZQUNSLEtBQUssbUJBQW1CLENBQUMsV0FBVyxFQUFFO2dCQUNwQyxNQUFNLEdBQUcsTUFBTSwwQkFBUyxDQUFDLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2xFLE1BQU07WUFDUixLQUFLLG1CQUFtQixDQUFDLFdBQVcsRUFBRTtnQkFDcEMsNEVBQTRFO2dCQUM1RSxNQUFNLEdBQUcsTUFBTSwwQkFBUyxDQUFDLGtCQUFrQixDQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2pFLE1BQU07WUFDUjtnQkFDRSxNQUFNLElBQUksMkJBQU0sQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLElBQUksdUNBQXVDO29CQUNuRixRQUFRLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQyxtQkFBbUIsRUFBRSxtQkFBbUIsRUFBRSxtQkFBbUIsQ0FBQyxDQUFDLHVCQUF1QixDQUFDLENBQUM7U0FDckg7UUFDRCxJQUFJLENBQUMsZ0JBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxFQUFFO1lBQ3BDLE1BQU0sQ0FBQyxhQUFhLEdBQUcsTUFBTSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7U0FDaEU7UUFDRCxPQUFPLE1BQU0sQ0FBQztJQUNoQixDQUFDO0NBQUE7QUFFUSxzQ0FBYSJ9
+
+function convertVisualizationToBase64(element) {
+  if (!_lodash.default.isEmpty(element.visualization)) {
+    element.visualization = element.visualization.toString('base64');
+  }
+
+  return element;
+}
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi9jb21wYXJlLmpzIl0sIm5hbWVzIjpbIk1BVENIX0ZFQVRVUkVTX01PREUiLCJHRVRfU0lNSUxBUklUWV9NT0RFIiwiTUFUQ0hfVEVNUExBVEVfTU9ERSIsIkRFRkFVTFRfTUFUQ0hfVEhSRVNIT0xEIiwiY29tcGFyZUltYWdlcyIsIm1vZGUiLCJmaXJzdEltYWdlIiwic2Vjb25kSW1hZ2UiLCJvcHRpb25zIiwiaW1nMSIsIkJ1ZmZlciIsImZyb20iLCJpbWcyIiwicmVzdWx0IiwiXyIsInRvTG93ZXIiLCJ0b0xvd2VyQ2FzZSIsImVyciIsImNvdW50IiwibXVsdGlwbGUiLCJtYXAiLCJjb252ZXJ0VmlzdWFsaXphdGlvblRvQmFzZTY0IiwiZXJyb3JzIiwiSW52YWxpZEFyZ3VtZW50RXJyb3IiLCJKU09OIiwic3RyaW5naWZ5IiwiZWxlbWVudCIsImlzRW1wdHkiLCJ2aXN1YWxpemF0aW9uIiwidG9TdHJpbmciXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBOztBQUNBOztBQUNBOztBQUVBLE1BQU1BLG1CQUFtQixHQUFHLGVBQTVCOztBQUNBLE1BQU1DLG1CQUFtQixHQUFHLGVBQTVCOztBQUNBLE1BQU1DLG1CQUFtQixHQUFHLGVBQTVCOztBQUVBLE1BQU1DLHVCQUF1QixHQUFHLEdBQWhDOzs7QUF1QkEsZUFBZUMsYUFBZixDQUE4QkMsSUFBOUIsRUFBb0NDLFVBQXBDLEVBQWdEQyxXQUFoRCxFQUE2REMsT0FBTyxHQUFHLEVBQXZFLEVBQTJFO0FBQ3pFLFFBQU1DLElBQUksR0FBR0MsTUFBTSxDQUFDQyxJQUFQLENBQVlMLFVBQVosRUFBd0IsUUFBeEIsQ0FBYjtBQUNBLFFBQU1NLElBQUksR0FBR0YsTUFBTSxDQUFDQyxJQUFQLENBQVlKLFdBQVosRUFBeUIsUUFBekIsQ0FBYjtBQUNBLE1BQUlNLE1BQU0sR0FBRyxJQUFiOztBQUNBLFVBQVFDLGdCQUFFQyxPQUFGLENBQVVWLElBQVYsQ0FBUjtBQUNFLFNBQUtMLG1CQUFtQixDQUFDZ0IsV0FBcEIsRUFBTDtBQUNFLFVBQUk7QUFDRkgsUUFBQUEsTUFBTSxHQUFHLE1BQU0sOEJBQWlCSixJQUFqQixFQUF1QkcsSUFBdkIsRUFBNkJKLE9BQTdCLENBQWY7QUFDRCxPQUZELENBRUUsT0FBT1MsR0FBUCxFQUFZO0FBRVpKLFFBQUFBLE1BQU0sR0FBRztBQUFDSyxVQUFBQSxLQUFLLEVBQUU7QUFBUixTQUFUO0FBQ0Q7O0FBQ0Q7O0FBQ0YsU0FBS2pCLG1CQUFtQixDQUFDZSxXQUFwQixFQUFMO0FBQ0VILE1BQUFBLE1BQU0sR0FBRyxNQUFNLGlDQUFvQkosSUFBcEIsRUFBMEJHLElBQTFCLEVBQWdDSixPQUFoQyxDQUFmO0FBQ0E7O0FBQ0YsU0FBS04sbUJBQW1CLENBQUNjLFdBQXBCLEVBQUw7QUFFRUgsTUFBQUEsTUFBTSxHQUFHLE1BQU0sZ0NBQW1CSixJQUFuQixFQUF5QkcsSUFBekIsRUFBK0JKLE9BQS9CLENBQWY7O0FBQ0EsVUFBSUEsT0FBTyxDQUFDVyxRQUFaLEVBQXNCO0FBQ3BCLGVBQU9OLE1BQU0sQ0FBQ00sUUFBUCxDQUFnQkMsR0FBaEIsQ0FBb0JDLDRCQUFwQixDQUFQO0FBQ0Q7O0FBQ0Q7O0FBQ0Y7QUFDRSxZQUFNLElBQUlDLG1CQUFPQyxvQkFBWCxDQUFpQyxJQUFHbEIsSUFBSyx1Q0FBVCxHQUNuQyxRQUFPbUIsSUFBSSxDQUFDQyxTQUFMLENBQWUsQ0FBQ3pCLG1CQUFELEVBQXNCQyxtQkFBdEIsRUFBMkNDLG1CQUEzQyxDQUFmLENBQWdGLHVCQURwRixDQUFOO0FBcEJKOztBQXVCQSxTQUFPbUIsNEJBQTRCLENBQUNSLE1BQUQsQ0FBbkM7QUFDRDs7QUFTRCxTQUFTUSw0QkFBVCxDQUF1Q0ssT0FBdkMsRUFBZ0Q7QUFDOUMsTUFBSSxDQUFDWixnQkFBRWEsT0FBRixDQUFVRCxPQUFPLENBQUNFLGFBQWxCLENBQUwsRUFBdUM7QUFDckNGLElBQUFBLE9BQU8sQ0FBQ0UsYUFBUixHQUF3QkYsT0FBTyxDQUFDRSxhQUFSLENBQXNCQyxRQUF0QixDQUErQixRQUEvQixDQUF4QjtBQUNEOztBQUVELFNBQU9ILE9BQVA7QUFDRCIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBfIGZyb20gJ2xvZGFzaCc7XG5pbXBvcnQgeyBlcnJvcnMgfSBmcm9tICdAYXBwaXVtL2Jhc2UtZHJpdmVyJztcbmltcG9ydCB7IGdldEltYWdlc01hdGNoZXMsIGdldEltYWdlc1NpbWlsYXJpdHksIGdldEltYWdlT2NjdXJyZW5jZSB9IGZyb20gJ0BhcHBpdW0vb3BlbmN2JztcblxuY29uc3QgTUFUQ0hfRkVBVFVSRVNfTU9ERSA9ICdtYXRjaEZlYXR1cmVzJztcbmNvbnN0IEdFVF9TSU1JTEFSSVRZX01PREUgPSAnZ2V0U2ltaWxhcml0eSc7XG5jb25zdCBNQVRDSF9URU1QTEFURV9NT0RFID0gJ21hdGNoVGVtcGxhdGUnO1xuXG5jb25zdCBERUZBVUxUX01BVENIX1RIUkVTSE9MRCA9IDAuNDtcblxuLyoqXG4gKiBQZXJmb3JtcyBpbWFnZXMgY29tcGFyaXNvbiB1c2luZyBPcGVuQ1YgZnJhbWV3b3JrIGZlYXR1cmVzLlxuICogSXQgaXMgZXhwZWN0ZWQgdGhhdCBib3RoIE9wZW5DViBmcmFtZXdvcmsgYW5kIG9wZW5jdjRub2RlanNcbiAqIG1vZHVsZSBhcmUgaW5zdGFsbGVkIG9uIHRoZSBtYWNoaW5lIHdoZXJlIEFwcGl1bSBzZXJ2ZXIgaXMgcnVubmluZy5cbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gbW9kZSAtIE9uZSBvZiBwb3NzaWJsZSBjb21wYXJpc29uIG1vZGVzOlxuICogbWF0Y2hGZWF0dXJlcywgZ2V0U2ltaWxhcml0eSwgbWF0Y2hUZW1wbGF0ZVxuICogQHBhcmFtIHtzdHJpbmd9IGZpcnN0SW1hZ2UgLSBCYXNlNjQtZW5jb2RlZCBpbWFnZSBmaWxlLlxuICogQWxsIGltYWdlIGZvcm1hdHMsIHRoYXQgT3BlbkNWIGxpYnJhcnkgaXRzZWxmIGFjY2VwdHMsIGFyZSBzdXBwb3J0ZWQuXG4gKiBAcGFyYW0ge3N0cmluZ30gc2Vjb25kSW1hZ2UgLSBCYXNlNjQtZW5jb2RlZCBpbWFnZSBmaWxlLlxuICogQWxsIGltYWdlIGZvcm1hdHMsIHRoYXQgT3BlbkNWIGxpYnJhcnkgaXRzZWxmIGFjY2VwdHMsIGFyZSBzdXBwb3J0ZWQuXG4gKiBAcGFyYW0gez9PYmplY3R9IG9wdGlvbnMgW3t9XSAtIFRoZSBjb250ZW50IG9mIHRoaXMgZGljdGlvbmFyeSBkZXBlbmRzXG4gKiBvbiB0aGUgYWN0dWFsIGBtb2RlYCB2YWx1ZS4gU2VlIHRoZSBkb2N1bWVudGF0aW9uIG9uIGBAYXBwaXVtL3N1cHBvcnRgXG4gKiBtb2R1bGUgZm9yIG1vcmUgZGV0YWlscy5cbiAqIEByZXR1cm5zIHtPYmplY3R9IFRoZSBjb250ZW50IG9mIHRoZSByZXN1bHRpbmcgZGljdGlvbmFyeSBkZXBlbmRzXG4gKiBvbiB0aGUgYWN0dWFsIGBtb2RlYCBhbmQgYG9wdGlvbnNgIHZhbHVlcy4gU2VlIHRoZSBkb2N1bWVudGF0aW9uIG9uXG4gKiBgQGFwcGl1bS9zdXBwb3J0YCBtb2R1bGUgZm9yIG1vcmUgZGV0YWlscy5cbiAqIEB0aHJvd3Mge0Vycm9yfSBJZiByZXF1aXJlZCBPcGVuQ1YgbW9kdWxlcyBhcmUgbm90IGluc3RhbGxlZCBvclxuICogaWYgYG1vZGVgIHZhbHVlIGlzIGluY29ycmVjdCBvciBpZiB0aGVyZSB3YXMgYW4gdW5leHBlY3RlZCBpc3N1ZSB3aGlsZVxuICogbWF0Y2hpbmcgdGhlIGltYWdlcy5cbiAqL1xuYXN5bmMgZnVuY3Rpb24gY29tcGFyZUltYWdlcyAobW9kZSwgZmlyc3RJbWFnZSwgc2Vjb25kSW1hZ2UsIG9wdGlvbnMgPSB7fSkge1xuICBjb25zdCBpbWcxID0gQnVmZmVyLmZyb20oZmlyc3RJbWFnZSwgJ2Jhc2U2NCcpO1xuICBjb25zdCBpbWcyID0gQnVmZmVyLmZyb20oc2Vjb25kSW1hZ2UsICdiYXNlNjQnKTtcbiAgbGV0IHJlc3VsdCA9IG51bGw7XG4gIHN3aXRjaCAoXy50b0xvd2VyKG1vZGUpKSB7XG4gICAgY2FzZSBNQVRDSF9GRUFUVVJFU19NT0RFLnRvTG93ZXJDYXNlKCk6XG4gICAgICB0cnkge1xuICAgICAgICByZXN1bHQgPSBhd2FpdCBnZXRJbWFnZXNNYXRjaGVzKGltZzEsIGltZzIsIG9wdGlvbnMpO1xuICAgICAgfSBjYXRjaCAoZXJyKSB7XG4gICAgICAgIC8vIG1pZ2h0IHRocm93IGlmIG5vIG1hdGNoZXNcbiAgICAgICAgcmVzdWx0ID0ge2NvdW50OiAwfTtcbiAgICAgIH1cbiAgICAgIGJyZWFrO1xuICAgIGNhc2UgR0VUX1NJTUlMQVJJVFlfTU9ERS50b0xvd2VyQ2FzZSgpOlxuICAgICAgcmVzdWx0ID0gYXdhaXQgZ2V0SW1hZ2VzU2ltaWxhcml0eShpbWcxLCBpbWcyLCBvcHRpb25zKTtcbiAgICAgIGJyZWFrO1xuICAgIGNhc2UgTUFUQ0hfVEVNUExBVEVfTU9ERS50b0xvd2VyQ2FzZSgpOlxuICAgICAgLy8gZmlyc3RJbWFnZS9pbWcxIGlzIHRoZSBmdWxsIGltYWdlIGFuZCBzZWNvbmRJbWFnZS9pbWcyIGlzIHRoZSBwYXJ0aWFsIG9uZVxuICAgICAgcmVzdWx0ID0gYXdhaXQgZ2V0SW1hZ2VPY2N1cnJlbmNlKGltZzEsIGltZzIsIG9wdGlvbnMpO1xuICAgICAgaWYgKG9wdGlvbnMubXVsdGlwbGUpIHtcbiAgICAgICAgcmV0dXJuIHJlc3VsdC5tdWx0aXBsZS5tYXAoY29udmVydFZpc3VhbGl6YXRpb25Ub0Jhc2U2NCk7XG4gICAgICB9XG4gICAgICBicmVhaztcbiAgICBkZWZhdWx0OlxuICAgICAgdGhyb3cgbmV3IGVycm9ycy5JbnZhbGlkQXJndW1lbnRFcnJvcihgJyR7bW9kZX0nIGltYWdlcyBjb21wYXJpc29uIG1vZGUgaXMgdW5rbm93bi4gYCArXG4gICAgICAgIGBPbmx5ICR7SlNPTi5zdHJpbmdpZnkoW01BVENIX0ZFQVRVUkVTX01PREUsIEdFVF9TSU1JTEFSSVRZX01PREUsIE1BVENIX1RFTVBMQVRFX01PREVdKX0gbW9kZXMgYXJlIHN1cHBvcnRlZC5gKTtcbiAgfVxuICByZXR1cm4gY29udmVydFZpc3VhbGl6YXRpb25Ub0Jhc2U2NChyZXN1bHQpO1xufVxuXG4vKipcbiAqIGJhc2U2NCBlbmNvZGVzIHRoZSB2aXN1YWxpemF0aW9uIHBhcnQgb2YgdGhlIHJlc3VsdFxuICogKGlmIG5lY2Vzc2FyeSlcbiAqXG4gKiBAcGFyYW0ge09jY3VycmVuY2VSZXN1bHR9IGVsZW1lbnQgLSBvY2N1cnJlbmNlIHJlc3VsdFxuICpcbioqL1xuZnVuY3Rpb24gY29udmVydFZpc3VhbGl6YXRpb25Ub0Jhc2U2NCAoZWxlbWVudCkge1xuICBpZiAoIV8uaXNFbXB0eShlbGVtZW50LnZpc3VhbGl6YXRpb24pKSB7XG4gICAgZWxlbWVudC52aXN1YWxpemF0aW9uID0gZWxlbWVudC52aXN1YWxpemF0aW9uLnRvU3RyaW5nKCdiYXNlNjQnKTtcbiAgfVxuXG4gIHJldHVybiBlbGVtZW50O1xufVxuXG5leHBvcnQgeyBjb21wYXJlSW1hZ2VzLCBERUZBVUxUX01BVENIX1RIUkVTSE9MRCwgTUFUQ0hfVEVNUExBVEVfTU9ERSwgTUFUQ0hfRkVBVFVSRVNfTU9ERSxcbiAgR0VUX1NJTUlMQVJJVFlfTU9ERSB9O1xuXG4vKipcbiAqIEB0eXBlZGVmIHtpbXBvcnQoJ0BhcHBpdW0vb3BlbmN2JykuT2NjdXJyZW5jZVJlc3VsdH0gT2NjdXJyZW5jZVJlc3VsdFxuICovXG4iXX0=

package/build/lib/finder.d.ts

@@ -0,0 +1,156 @@
+export default class ImageElementFinder {
+    constructor(driver: any, max?: number);
+    driver: any;
+    imgElCache: any;
+    setDriver(driver: any): void;
+    registerImageElement(imgEl: any): any;
+    /**
+     * @typedef FindByImageOptions
+     * @property {boolean} [shouldCheckStaleness=false] - whether this call to find an
+     * image is merely to check staleness. If so we can bypass a lot of logic
+     * @property {boolean} [multiple=false] - Whether we are finding one element or
+     * multiple
+     * @property {boolean} [ignoreDefaultImageTemplateScale=false] - Whether we
+     * ignore defaultImageTemplateScale. It can be used when you would like to
+     * scale b64Template with defaultImageTemplateScale setting.
+     */
+    /**
+     * Find a screen rect represented by an ImageElement corresponding to an image
+     * template sent in by the client
+     *
+     * @param {string} b64Template - base64-encoded image used as a template to be
+     * matched in the screenshot
+     * @param {FindByImageOptions} - additional options
+     *
+     * @returns {WebElement} - WebDriver element with a special id prefix
+     */
+    findByImage(b64Template: string, { shouldCheckStaleness, multiple, ignoreDefaultImageTemplateScale, }: {
+        /**
+         * - whether this call to find an
+         * image is merely to check staleness. If so we can bypass a lot of logic
+         */
+        shouldCheckStaleness?: boolean | undefined;
+        /**
+         * - Whether we are finding one element or
+         * multiple
+         */
+        multiple?: boolean | undefined;
+        /**
+         * - Whether we
+         * ignore defaultImageTemplateScale. It can be used when you would like to
+         * scale b64Template with defaultImageTemplateScale setting.
+         */
+        ignoreDefaultImageTemplateScale?: boolean | undefined;
+    }): WebElement;
+    /**
+     * Ensure that the image template sent in for a find is of a suitable size
+     *
+     * @param {string} b64Template - base64-encoded image
+     * @param {int} screenWidth - width of screen
+     * @param {int} screenHeight - height of screen
+     *
+     * @returns {string} base64-encoded image, potentially resized
+     */
+    ensureTemplateSize(b64Template: string, screenWidth: int, screenHeight: int): string;
+    /**
+     * @typedef Screenshot
+     * @property {string} b64Screenshot - base64 based screenshot string
+     */
+    /**
+     * @typedef ScreenshotScale
+     * @property {float} xScale - Scale ratio for width
+     * @property {float} yScale - Scale ratio for height
+     */
+    /**
+     * Get the screenshot image that will be used for find by element, potentially
+     * altering it in various ways based on user-requested settings
+     *
+     * @param {int} screenWidth - width of screen
+     * @param {int} screenHeight - height of screen
+     *
+     * @returns { {b64Screenshot: Screenshot, scale: ScreenshotScale? } } base64-encoded screenshot and ScreenshotScale
+     */
+    getScreenshotForImageFind(screenWidth: int, screenHeight: int): {
+        b64Screenshot: {
+            /**
+             * - base64 based screenshot string
+             */
+            b64Screenshot: string;
+        };
+        scale: {
+            /**
+             * - Scale ratio for width
+             */
+            xScale: float;
+            /**
+             * - Scale ratio for height
+             */
+            yScale: float;
+        } | null;
+    };
+    /**
+     * @typedef ImageTemplateSettings
+     * @property {boolean} fixImageTemplateScale - fixImageTemplateScale in device-settings
+     * @property {float} defaultImageTemplateScale - defaultImageTemplateScale in device-settings
+     * @property {boolean} ignoreDefaultImageTemplateScale - Ignore defaultImageTemplateScale if it has true.
+     * If b64Template has been scaled to defaultImageTemplateScale or should ignore the scale,
+     * this parameter should be true. e.g. click in image-element module
+     * @property {float} xScale - Scale ratio for width
+     * @property {float} yScale - Scale ratio for height
+  
+     */
+    /**
+     * Get a image that will be used for template maching.
+     * Returns scaled image if scale ratio is provided.
+     *
+     *
+     * @param {string} b64Template - base64-encoded image used as a template to be
+     * matched in the screenshot
+     * @param {ImageTemplateSettings} opts - Image template scale related options
+     *
+     * @returns {string} base64-encoded scaled template screenshot
+     */
+    fixImageTemplateScale(b64Template: string, opts?: {
+        /**
+         * - fixImageTemplateScale in device-settings
+         */
+        fixImageTemplateScale: boolean;
+        /**
+         * - defaultImageTemplateScale in device-settings
+         */
+        defaultImageTemplateScale: float;
+        /**
+         * - Ignore defaultImageTemplateScale if it has true.
+         * If b64Template has been scaled to defaultImageTemplateScale or should ignore the scale,
+         * this parameter should be true. e.g. click in image-element module
+         */
+        ignoreDefaultImageTemplateScale: boolean;
+        /**
+         * - Scale ratio for width
+         */
+        xScale: float;
+        /**
+         * - Scale ratio for height
+         */
+        yScale: float;
+    }): string;
+}
+export const W3C_ELEMENT_KEY: "element-6066-11e4-a52e-4f735466cecf";
+export const MJSONWP_ELEMENT_KEY: "ELEMENT";
+export namespace DEFAULT_SETTINGS {
+    export { DEFAULT_MATCH_THRESHOLD as imageMatchThreshold };
+    export const imageMatchMethod: string;
+    export const fixImageFindScreenshotDims: boolean;
+    export const fixImageTemplateSize: boolean;
+    export const fixImageTemplateScale: boolean;
+    export { DEFAULT_TEMPLATE_IMAGE_SCALE as defaultImageTemplateScale };
+    export const checkForImageElementStaleness: boolean;
+    export const autoUpdateImageElementPosition: boolean;
+    export { IMAGE_EL_TAP_STRATEGY_W3C as imageElementTapStrategy };
+    export const getMatchedImageResult: boolean;
+}
+export const DEFAULT_FIX_IMAGE_TEMPLATE_SCALE: 1;
+import { DEFAULT_MATCH_THRESHOLD } from "./compare";
+import { DEFAULT_TEMPLATE_IMAGE_SCALE } from "./image-element";
+import { IMAGE_EL_TAP_STRATEGY_W3C } from "./image-element";
+//# sourceMappingURL=finder.d.ts.map

package/build/lib/finder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"finder.d.ts","sourceRoot":"","sources":["../../lib/finder.js"],"names":[],"mappings":"AAsEA;IACE,uCAMC;IALC,YAAoB;IACpB,gBAGE;IAGJ,6BAEC;IAED,sCAIC;IAED;;;;;;;;;OASG;IAEH;;;;;;;;;OASG;IACH,yBANW,MAAM;;;;;;;;;;;;;;;;;mBAsHhB;IAED;;;;;;;;OAQG;IACH,gCANW,MAAM,wCAIJ,MAAM,CAiBlB;IAED;;;OAGG;IACH;;;;OAIG;IACH;;;;;;;;OAQG;IACH;;;;;2BAhBc,MAAM;;;;;;;;;;;;MAuHnB;IAED;;;;;;;;;;OAUG;IACH;;;;;;;;;;OAUG;IACH,mCANW,MAAM;;;;+BAdH,OAAO;;;;;;;;;;yCAEP,OAAO;;;;;;;;;QAgBR,MAAM,CAqDlB;CACF;AArbD,oEAAwD;AADxD,4CAAsC;;;;;;;;;;;;;AAEtC,iDAA2C"}