@appium/images-plugin 1.2.0 → 1.2.4

package/README.md

@@ -9,8 +9,6 @@ This is an official Appium plugin designed to facilitate image comparison, visua
 
 ## Prerequisites
 
-* [OpenCV](https://opencv.org) 3.x native libraries
-* [opencv4nodejs](https://github.com/justadudewhohacks/opencv4nodejs) NPM module: install with `npm i -g opencv4nodejs`. By default the preinstall script of this module also downloads and makes all the required OpenCV libs from source, but this requires developer tools to be available on the host system.
 * Appium Server 2.0+
 
 ## Installation - Server
@@ -30,7 +28,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.js

@@ -1,21 +1,12 @@
 "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");
+const base_driver_1 = require("@appium/base-driver");
+const opencv_1 = require("@appium/opencv");
 const MATCH_FEATURES_MODE = 'matchFeatures';
 exports.MATCH_FEATURES_MODE = MATCH_FEATURES_MODE;
 const GET_SIMILARITY_MODE = 'getSimilarity';
@@ -36,40 +27,44 @@ exports.DEFAULT_MATCH_THRESHOLD = DEFAULT_MATCH_THRESHOLD;
  * @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`
+ * 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.
+ * `@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 = null;
-        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);
-                if (options.multiple) {
-                    return result.multiple.map(convertVisualizationToBase64);
-                }
-                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.`);
-        }
-        return convertVisualizationToBase64(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_1.default.toLower(mode)) {
+        case MATCH_FEATURES_MODE.toLowerCase():
+            try {
+                result = await (0, opencv_1.getImagesMatches)(img1, img2, options);
+            }
+            catch (err) {
+                // might throw if no matches
+                result = { count: 0 };
+            }
+            break;
+        case GET_SIMILARITY_MODE.toLowerCase():
+            result = await (0, opencv_1.getImagesSimilarity)(img1, img2, options);
+            break;
+        case MATCH_TEMPLATE_MODE.toLowerCase():
+            // firstImage/img1 is the full image and secondImage/img2 is the partial one
+            result = await (0, opencv_1.getImageOccurrence)(img1, img2, options);
+            if (options.multiple) {
+                return result.multiple.map(convertVisualizationToBase64);
+            }
+            break;
+        default:
+            throw new 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.`);
+    }
+    return convertVisualizationToBase64(result);
 }
 exports.compareImages = compareImages;
 /**
@@ -85,4 +80,4 @@ function convertVisualizationToBase64(element) {
     }
     return element;
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGFyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi9jb21wYXJlLmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUF1QjtBQUN2QiwyREFBNEM7QUFDNUMsbURBQTJDO0FBRTNDLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBbUUwQixrREFBbUI7QUFsRXpGLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBbUUxQyxrREFBbUI7QUFsRXJCLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBaUVLLGtEQUFtQjtBQS9EcEUsTUFBTSx1QkFBdUIsR0FBRyxHQUFHLENBQUM7QUErRFosMERBQXVCO0FBN0QvQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7QUFDSCxTQUFlLGFBQWEsQ0FBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLFdBQVcsRUFBRSxPQUFPLEdBQUcsRUFBRTs7UUFDdkUsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDL0MsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDaEQsSUFBSSxNQUFNLEdBQUcsSUFBSSxDQUFDO1FBQ2xCLFFBQVEsZ0JBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDdkIsS0FBSyxtQkFBbUIsQ0FBQyxXQUFXLEVBQUU7Z0JBQ3BDLE1BQU0sR0FBRyxNQUFNLDBCQUFTLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxPQUFPLENBQUMsQ0FBQztnQkFDL0QsTUFBTTtZQUNSLEtBQUssbUJBQW1CLENBQUMsV0FBVyxFQUFFO2dCQUNwQyxNQUFNLEdBQUcsTUFBTSwwQkFBUyxDQUFDLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2xFLE1BQU07WUFDUixLQUFLLG1CQUFtQixDQUFDLFdBQVcsRUFBRTtnQkFDcEMsNEVBQTRFO2dCQUM1RSxNQUFNLEdBQUcsTUFBTSwwQkFBUyxDQUFDLGtCQUFrQixDQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2pFLElBQUksT0FBTyxDQUFDLFFBQVEsRUFBRTtvQkFDcEIsT0FBTyxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO2lCQUMxRDtnQkFDRCxNQUFNO1lBQ1I7Z0JBQ0UsTUFBTSxJQUFJLDJCQUFNLENBQUMsb0JBQW9CLENBQUMsSUFBSSxJQUFJLHVDQUF1QztvQkFDbkYsUUFBUSxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsbUJBQW1CLEVBQUUsbUJBQW1CLEVBQUUsbUJBQW1CLENBQUMsQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO1NBQ3JIO1FBQ0QsT0FBTyw0QkFBNEIsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUM5QyxDQUFDO0NBQUE7QUFpQlEsc0NBQWE7QUFmdEI7Ozs7OztHQU1HO0FBQ0gsU0FBUyw0QkFBNEIsQ0FBRSxPQUFPO0lBQzVDLElBQUksQ0FBQyxnQkFBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDLEVBQUU7UUFDckMsT0FBTyxDQUFDLGFBQWEsR0FBRyxPQUFPLENBQUMsYUFBYSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBQztLQUNsRTtJQUVELE9BQU8sT0FBTyxDQUFDO0FBQ2pCLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGFyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi9jb21wYXJlLmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLG9EQUF1QjtBQUN2QixxREFBNkM7QUFDN0MsMkNBQTJGO0FBRTNGLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBd0UwQixrREFBbUI7QUF2RXpGLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBd0UxQyxrREFBbUI7QUF2RXJCLE1BQU0sbUJBQW1CLEdBQUcsZUFBZSxDQUFDO0FBc0VLLGtEQUFtQjtBQXBFcEUsTUFBTSx1QkFBdUIsR0FBRyxHQUFHLENBQUM7QUFvRVosMERBQXVCO0FBbEUvQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7QUFDSCxLQUFLLFVBQVUsYUFBYSxDQUFFLElBQUksRUFBRSxVQUFVLEVBQUUsV0FBVyxFQUFFLE9BQU8sR0FBRyxFQUFFO0lBQ3ZFLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQy9DLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQ2hELElBQUksTUFBTSxHQUFHLElBQUksQ0FBQztJQUNsQixRQUFRLGdCQUFDLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ3ZCLEtBQUssbUJBQW1CLENBQUMsV0FBVyxFQUFFO1lBQ3BDLElBQUk7Z0JBQ0YsTUFBTSxHQUFHLE1BQU0sSUFBQSx5QkFBZ0IsRUFBQyxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDO2FBQ3REO1lBQUMsT0FBTyxHQUFHLEVBQUU7Z0JBQ1osNEJBQTRCO2dCQUM1QixNQUFNLEdBQUcsRUFBQyxLQUFLLEVBQUUsQ0FBQyxFQUFDLENBQUM7YUFDckI7WUFDRCxNQUFNO1FBQ1IsS0FBSyxtQkFBbUIsQ0FBQyxXQUFXLEVBQUU7WUFDcEMsTUFBTSxHQUFHLE1BQU0sSUFBQSw0QkFBbUIsRUFBQyxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQ3hELE1BQU07UUFDUixLQUFLLG1CQUFtQixDQUFDLFdBQVcsRUFBRTtZQUNwQyw0RUFBNEU7WUFDNUUsTUFBTSxHQUFHLE1BQU0sSUFBQSwyQkFBa0IsRUFBQyxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQ3ZELElBQUksT0FBTyxDQUFDLFFBQVEsRUFBRTtnQkFDcEIsT0FBTyxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO2FBQzFEO1lBQ0QsTUFBTTtRQUNSO1lBQ0UsTUFBTSxJQUFJLG9CQUFNLENBQUMsb0JBQW9CLENBQUMsSUFBSSxJQUFJLHVDQUF1QztnQkFDbkYsUUFBUSxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsbUJBQW1CLEVBQUUsbUJBQW1CLEVBQUUsbUJBQW1CLENBQUMsQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO0tBQ3JIO0lBQ0QsT0FBTyw0QkFBNEIsQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUM5QyxDQUFDO0FBaUJRLHNDQUFhO0FBZnRCOzs7Ozs7R0FNRztBQUNILFNBQVMsNEJBQTRCLENBQUUsT0FBTztJQUM1QyxJQUFJLENBQUMsZ0JBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxFQUFFO1FBQ3JDLE9BQU8sQ0FBQyxhQUFhLEdBQUcsT0FBTyxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7S0FDbEU7SUFFRCxPQUFPLE9BQU8sQ0FBQztBQUNqQixDQUFDIn0=