@appium/images-plugin 2.0.10 → 2.1.0

package/build/lib/image-element.d.ts

@@ -8,6 +8,17 @@
  * @property {number} x - x coordinate
  * @property {number} y - y coordinate
  */
+/**
+ * @typedef ImageElementOpts
+ * @property {Buffer} template - the image which was used to find this ImageElement
+ * @property {Rect} rect - bounds of matched image element
+ * @property {number} score The similarity score as a float number in range [0.0, 1.0].
+ * 1.0 is the highest score (means both images are totally equal).
+ * @property {Buffer?} match - the image which has matched marks. Defaults to null.
+ * @property {import('./finder').default?} finder - the finder we can use to re-check stale elements
+ * @property {import('@appium/types').Rect?} containerRect - The bounding
+ * rectangle to limit the search in
+ */
 /**
  * Representation of an "image element", which is simply a set of coordinates
  * and methods that can be used on that set of coordinates via the driver
@@ -23,24 +34,18 @@ export default class ImageElement {
      *
      * @returns {object} - the result of running a command
      */
-    static execute(driver: import("appium/driver").BaseDriver<any, import("@appium/types").StringRecord<any>, import("@appium/types").StringRecord<any>>, imgEl: any, cmd: string, ...args: string[]): object;
+    static execute(driver: import("appium/driver").BaseDriver<any, import("@appium/types").StringRecord<any>, import("@appium/types").StringRecord<any>, import("@appium/types").StringRecord<any>>, imgEl: any, cmd: string, ...args: string[]): object;
     /**
-     * @param {string} b64Template - the base64-encoded image which was used to
-     *                               find this ImageElement
-     * @param {Rect} rect - bounds of matched image element
-     * @param {number} score The similarity score as a float number in range [0.0, 1.0].
-     * 1.0 is the highest score (means both images are totally equal).
-     * @param {string?} b64Result - the base64-encoded image which has matched marks.
-     *                              Defaults to null.
-     * @param {import('./finder').default?} finder - the finder we can use to re-check stale elements
+     * @param {ImageElementOpts}
      */
-    constructor(b64Template: string, rect: Rect, score: number, b64Result?: string | null, finder?: import('./finder').default | null);
-    template: string;
+    constructor({ template, rect, score, match, finder, containerRect, }: ImageElementOpts);
+    template: Buffer;
     rect: import("@appium/types").Rect;
     id: string;
-    b64MatchedImage: string | null;
+    match: Buffer | null;
     score: number;
     finder: import("./finder").default | null;
+    containerRect: import("@appium/types").Rect | null;
     /**
      * @returns {Dimension} - dimension of element
      */
@@ -54,16 +59,18 @@ export default class ImageElement {
      */
     get center(): Position;
     /**
-     * @returns {?string} - the base64-encoded image which has matched marks
+     * @returns {string} - the base64-encoded original image used for matching
+     */
+    get originalImage(): string;
+    /**
+     * @returns {string|null} - the base64-encoded image which has matched marks
      */
     get matchedImage(): string | null;
     /**
-     * @param {string} protocolKey - the protocol-specific JSON key for
-     * a WebElement
      *
      * @returns {Element} - this image element as a WebElement
      */
-    asElement(protocolKey: string): Element;
+    asElement(): Element;
     /**
      * @param {ImageElement} other - an ImageElement to compare with this one
      *
@@ -78,6 +85,15 @@ export default class ImageElement {
      * @param {BaseDriver} driver - driver for calling actions with
      */
     click(driver: BaseDriver): Promise<any>;
+    /**
+     * Perform lookup of image element(s) inside of the current element
+     *
+     * @param {boolean} multiple - Whether to lookup multiple elements
+     * @param {import('appium/driver').BaseDriver} driver - The driver to use for commands
+     * @param  {string[]} args = Rest of arguments for executeScripts
+     * @returns {Promise<Element|Element[]|ImageElement>} - WebDriver element with a special id prefix
+     */
+    find(multiple: boolean, driver: import("appium/driver").BaseDriver<any, import("@appium/types").StringRecord<any>, import("@appium/types").StringRecord<any>, import("@appium/types").StringRecord<any>>, ...args: string[]): Promise<Element | Element[] | ImageElement>;
 }
 export type Dimension = {
     /**
@@ -99,10 +115,34 @@ export type Position = {
      */
     y: number;
 };
+export type ImageElementOpts = {
+    /**
+     * - the image which was used to find this ImageElement
+     */
+    template: Buffer;
+    /**
+     * - bounds of matched image element
+     */
+    rect: Rect;
+    /**
+     * The similarity score as a float number in range [0.0, 1.0].
+     * 1.0 is the highest score (means both images are totally equal).
+     */
+    score: number;
+    /**
+     * - the image which has matched marks. Defaults to null.
+     */
+    match: Buffer | null;
+    /**
+     * - the finder we can use to re-check stale elements
+     */
+    finder: import('./finder').default | null;
+    /**
+     * - The bounding
+     * rectangle to limit the search in
+     */
+    containerRect: import('@appium/types').Rect | null;
+};
 export type Rect = import('@appium/types').Rect;
 export type Element = import('@appium/types').Element;
-export const IMAGE_EL_TAP_STRATEGY_MJSONWP: "touchActions";
-export const IMAGE_EL_TAP_STRATEGY_W3C: "w3cActions";
-export const DEFAULT_TEMPLATE_IMAGE_SCALE: 1;
-export const IMAGE_ELEMENT_PREFIX: "appium-image-element-";
 //# sourceMappingURL=image-element.d.ts.map

package/build/lib/image-element.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image-element.d.ts","sourceRoot":"","sources":["../../lib/image-element.js"],"names":[],"mappings":"AAaA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH;IAsLE;;;;;;;;;OASG;IACH,uKANW,MAAM,WAEN,MAAM,EAAE,GAEN,MAAM,CA8BlB;IA3ND;;;;;;;;;OASG;IACH,yBATW,MAAM,QAEN,IAAI,SACJ,MAAM,cAEN,MAAM,kBAEN,OAAO,UAAU,EAAE,OAAO,SASpC;IANC,iBAA2B;IAC3B,mCAAgB;IAChB,WAAmD;IACnD,+BAAgC;IAChC,cAAkB;IAClB,0CAAoB;IAGtB;;OAEG;IACH,sBAEC;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,uBAKC;IAED;;OAEG;IACH,kCAEC;IAED;;;;;OAKG;IACH,uBALW,MAAM,GAGJ,OAAO,CAInB;IAED;;;;;OAKG;IACH,cALW,YAAY,GAEV,OAAO,CAUnB;IAED;;;;;OAKG;IACH,wCAkGC;CAyCF;;;;;WA3Oa,MAAM;;;;YACN,MAAM;;;;;;OAKN,MAAM;;;;OACN,MAAM;;mBA+OP,OAAO,eAAe,EAAE,IAAI;sBAC5B,OAAO,eAAe,EAAE,OAAO;AA7P5C,2DAAqD;AADrD,qDAA+C;AAG/C,6CAAyC;AALzC,2DAAqD"}
+{"version":3,"file":"image-element.d.ts","sourceRoot":"","sources":["../../lib/image-element.js"],"names":[],"mappings":"AAWA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AAEH;;;GAGG;AACH;IA6ME;;;;;;;;;OASG;IACH,kNANW,MAAM,WAEN,MAAM,EAAE,GAEN,MAAM,CAoClB;IAxPD;;OAEG;IACH,sEAFW,gBAAgB,EAiB1B;IAPC,iBAAwB;IACxB,mCAAgB;IAChB,WAAmD;IACnD,qBAAkB;IAClB,cAAkB;IAClB,0CAAoB;IACpB,mDAAkC;IAGpC;;OAEG;IACH,sBAEC;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,uBAKC;IAED;;OAEG;IACH,4BAEC;IAED;;OAEG;IACH,kCAEC;IAED;;;OAGG;IACH,aAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,cALW,YAAY,GAEV,OAAO,CAUnB;IAED;;;;;OAKG;IACH,wCAmGC;IAED;;;;;;;OAOG;IACH,eALW,OAAO,6LAEN,MAAM,EAAE,GACP,QAAQ,OAAO,GAAC,OAAO,EAAE,GAAC,YAAY,CAAC,CAQnD;CA+CF;;;;;WApRa,MAAM;;;;YACN,MAAM;;;;;;OAKN,MAAM;;;;OACN,MAAM;;;;;;cAKN,MAAM;;;;UACN,IAAI;;;;;WACJ,MAAM;;;;WAEN,MAAM;;;;YACN,OAAO,UAAU,EAAE,OAAO;;;;;mBAC1B,OAAO,eAAe,EAAE,IAAI;;mBAuQ7B,OAAO,eAAe,EAAE,IAAI;sBAC5B,OAAO,eAAe,EAAE,OAAO"}

package/build/lib/image-element.js

@@ -3,22 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMAGE_ELEMENT_PREFIX = exports.DEFAULT_TEMPLATE_IMAGE_SCALE = exports.IMAGE_EL_TAP_STRATEGY_W3C = exports.IMAGE_EL_TAP_STRATEGY_MJSONWP = exports.ImageElement = void 0;
+exports.ImageElement = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const driver_1 = require("appium/driver");
 const support_1 = require("appium/support");
 const logger_1 = __importDefault(require("./logger"));
-const finder_1 = require("./finder");
-const IMAGE_ELEMENT_PREFIX = 'appium-image-element-';
-exports.IMAGE_ELEMENT_PREFIX = IMAGE_ELEMENT_PREFIX;
+const constants_1 = require("./constants");
 const TAP_DURATION_MS = 125;
-const IMAGE_EL_TAP_STRATEGY_W3C = 'w3cActions';
-exports.IMAGE_EL_TAP_STRATEGY_W3C = IMAGE_EL_TAP_STRATEGY_W3C;
-const IMAGE_EL_TAP_STRATEGY_MJSONWP = 'touchActions';
-exports.IMAGE_EL_TAP_STRATEGY_MJSONWP = IMAGE_EL_TAP_STRATEGY_MJSONWP;
-const IMAGE_TAP_STRATEGIES = [IMAGE_EL_TAP_STRATEGY_MJSONWP, IMAGE_EL_TAP_STRATEGY_W3C];
-const DEFAULT_TEMPLATE_IMAGE_SCALE = 1.0;
-exports.DEFAULT_TEMPLATE_IMAGE_SCALE = DEFAULT_TEMPLATE_IMAGE_SCALE;
 /**
  * @typedef Dimension
  * @property {number} width - width of rect
@@ -29,28 +20,33 @@ exports.DEFAULT_TEMPLATE_IMAGE_SCALE = DEFAULT_TEMPLATE_IMAGE_SCALE;
  * @property {number} x - x coordinate
  * @property {number} y - y coordinate
  */
+/**
+ * @typedef ImageElementOpts
+ * @property {Buffer} template - the image which was used to find this ImageElement
+ * @property {Rect} rect - bounds of matched image element
+ * @property {number} score The similarity score as a float number in range [0.0, 1.0].
+ * 1.0 is the highest score (means both images are totally equal).
+ * @property {Buffer?} match - the image which has matched marks. Defaults to null.
+ * @property {import('./finder').default?} finder - the finder we can use to re-check stale elements
+ * @property {import('@appium/types').Rect?} containerRect - The bounding
+ * rectangle to limit the search in
+ */
 /**
  * Representation of an "image element", which is simply a set of coordinates
  * and methods that can be used on that set of coordinates via the driver
  */
 class ImageElement {
     /**
-     * @param {string} b64Template - the base64-encoded image which was used to
-     *                               find this ImageElement
-     * @param {Rect} rect - bounds of matched image element
-     * @param {number} score The similarity score as a float number in range [0.0, 1.0].
-     * 1.0 is the highest score (means both images are totally equal).
-     * @param {string?} b64Result - the base64-encoded image which has matched marks.
-     *                              Defaults to null.
-     * @param {import('./finder').default?} finder - the finder we can use to re-check stale elements
+     * @param {ImageElementOpts}
      */
-    constructor(b64Template, rect, score, b64Result = null, finder = null) {
-        this.template = b64Template;
+    constructor({ template, rect, score, match = null, finder = null, containerRect = null, }) {
+        this.template = template;
         this.rect = rect;
-        this.id = `${IMAGE_ELEMENT_PREFIX}${support_1.util.uuidV4()}`;
-        this.b64MatchedImage = b64Result;
+        this.id = `${constants_1.IMAGE_ELEMENT_PREFIX}${support_1.util.uuidV4()}`;
+        this.match = match;
         this.score = score;
         this.finder = finder;
+        this.containerRect = containerRect;
     }
     /**
      * @returns {Dimension} - dimension of element
@@ -74,19 +70,23 @@ class ImageElement {
         };
     }
     /**
-     * @returns {?string} - the base64-encoded image which has matched marks
+     * @returns {string} - the base64-encoded original image used for matching
+     */
+    get originalImage() {
+        return this.template.toString('base64');
+    }
+    /**
+     * @returns {string|null} - the base64-encoded image which has matched marks
      */
     get matchedImage() {
-        return this.b64MatchedImage;
+        return this.match?.toString('base64') ?? null;
     }
     /**
-     * @param {string} protocolKey - the protocol-specific JSON key for
-     * a WebElement
      *
      * @returns {Element} - this image element as a WebElement
      */
-    asElement(protocolKey) {
-        return { [protocolKey]: this.id };
+    asElement() {
+        return support_1.util.wrapElement(this.id);
     }
     /**
      * @param {ImageElement} other - an ImageElement to compare with this one
@@ -110,22 +110,23 @@ class ImageElement {
         // before we click we need to make sure the element is actually still there
         // where we expect it to be
         let newImgEl;
-        const settings = Object.assign({}, finder_1.DEFAULT_SETTINGS, driver.settings.getSettings());
+        const settings = Object.assign({}, constants_1.DEFAULT_SETTINGS, driver.settings.getSettings());
         const { autoUpdateImageElementPosition: updatePos, checkForImageElementStaleness, imageElementTapStrategy, } = settings;
         // validate tap strategy
-        if (!IMAGE_TAP_STRATEGIES.includes(imageElementTapStrategy)) {
+        if (!constants_1.IMAGE_TAP_STRATEGIES.includes(imageElementTapStrategy)) {
             throw new Error(`Incorrect imageElementTapStrategy setting ` +
                 `'${imageElementTapStrategy}'. Must be one of ` +
-                JSON.stringify(IMAGE_TAP_STRATEGIES));
+                JSON.stringify(constants_1.IMAGE_TAP_STRATEGIES));
         }
         if (checkForImageElementStaleness || updatePos) {
             logger_1.default.info('Checking image element for staleness before clicking');
             try {
-                newImgEl = await this.finder.findByImage(this.template, {
+                newImgEl = await this.finder.findByImage(this.template, driver, {
                     shouldCheckStaleness: true,
                     // Set ignoreDefaultImageTemplateScale because this.template is device screenshot based image
                     // managed inside Appium after finidng image by template which managed by a user
                     ignoreDefaultImageTemplateScale: true,
+                    containerRect: this.containerRect,
                 });
             }
             catch (err) {
@@ -150,7 +151,7 @@ class ImageElement {
         }
         const { x, y } = this.center;
         logger_1.default.info(`Will tap on image element at coordinate [${x}, ${y}]`);
-        if (imageElementTapStrategy === IMAGE_EL_TAP_STRATEGY_W3C) {
+        if (imageElementTapStrategy === constants_1.IMAGE_EL_TAP_STRATEGY_W3C) {
             // set up a W3C action to click on the image by position
             logger_1.default.info('Will tap using W3C actions');
             const action = {
@@ -185,6 +186,21 @@ class ImageElement {
             'For drivers to support finding image elements, they ' +
             "should support 'performTouch' and 'performActions'");
     }
+    /**
+     * Perform lookup of image element(s) inside of the current element
+     *
+     * @param {boolean} multiple - Whether to lookup multiple elements
+     * @param {import('appium/driver').BaseDriver} driver - The driver to use for commands
+     * @param  {string[]} args = Rest of arguments for executeScripts
+     * @returns {Promise<Element|Element[]|ImageElement>} - WebDriver element with a special id prefix
+     */
+    async find(multiple, driver, ...args) {
+        const [strategy, selector] = args;
+        if (strategy !== constants_1.IMAGE_STRATEGY) {
+            throw new driver_1.errors.InvalidSelectorError(`Lookup strategies other than '${constants_1.IMAGE_STRATEGY}' are not supported`);
+        }
+        return await this.finder.findByImage(selector, driver, { multiple, containerRect: this.rect });
+    }
     /**
      * Handle various Appium commands that involve an image element
      *
@@ -199,6 +215,10 @@ class ImageElement {
         switch (cmd) {
             case 'click':
                 return await imgEl.click(driver);
+            case 'findElementFromElement':
+                return await imgEl.find(false, driver, ...args);
+            case 'findElementsFromElement':
+                return await imgEl.find(true, driver, ...args);
             case 'elementDisplayed':
                 return true;
             case 'getSize':
@@ -208,6 +228,8 @@ class ImageElement {
                 return imgEl.location;
             case 'getElementRect':
                 return imgEl.rect;
+            case 'getElementScreenshot':
+                return imgEl.originalImage;
             case 'getAttribute':
                 // /session/:sessionId/element/:elementId/attribute/:name
                 // /session/:sessionId/element/:elementId/attribute/visual should retun the visual data

package/build/lib/image-element.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-element.js","sourceRoot":"","sources":["../../lib/image-element.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAqC;AACrC,4CAAoC;AACpC,sDAA2B;AAC3B,qCAA0C;AAE1C,MAAM,oBAAoB,GAAG,uBAAuB,CAAC;AA2PnD,oDAAoB;AA1PtB,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,yBAAyB,GAAG,YAAY,CAAC;AAuP7C,8DAAyB;AAtP3B,MAAM,6BAA6B,GAAG,cAAc,CAAC;AAqPnD,sEAA6B;AApP/B,MAAM,oBAAoB,GAAG,CAAC,6BAA6B,EAAE,yBAAyB,CAAC,CAAC;AACxF,MAAM,4BAA4B,GAAG,GAAG,CAAC;AAqPvC,oEAA4B;AAnP9B;;;;GAIG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH,MAAqB,YAAY;IAC/B;;;;;;;;;OASG;IACH,YAAY,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI;QACnE,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,GAAG,oBAAoB,GAAG,cAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,EAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO;YACL,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC;YACpC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;SACtC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,WAAW;QACnB,OAAO,EAAC,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,EAAE,EAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK;YACpC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,CACvC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,MAAM;QAChB,2EAA2E;QAC3E,2BAA2B;QAC3B,IAAI,QAAQ,CAAC;QACb,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,yBAAgB,EAAE,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QACpF,MAAM,EACJ,8BAA8B,EAAE,SAAS,EACzC,6BAA6B,EAC7B,uBAAuB,GACxB,GAAG,QAAQ,CAAC;QAEb,wBAAwB;QACxB,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACb,4CAA4C;gBAC1C,IAAI,uBAAuB,oBAAoB;gBAC/C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CACvC,CAAC;SACH;QAED,IAAI,6BAA6B,IAAI,SAAS,EAAE;YAC9C,gBAAG,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;YACjE,IAAI;gBACF,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE;oBACtD,oBAAoB,EAAE,IAAI;oBAC1B,6FAA6F;oBAC7F,gFAAgF;oBAChF,+BAA+B,EAAE,IAAI;iBACtC,CAAC,CAAC;aACJ;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,IAAI,eAAM,CAAC,0BAA0B,EAAE,CAAC;aAC/C;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBAC1B,gBAAG,CAAC,IAAI,CACN,8DAA8D;oBAC5D,4DAA4D;oBAC5D,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,yBAAyB;oBACzD,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,CAAC;gBACF,IAAI,SAAS,EAAE;oBACb,gBAAG,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;oBAClD,IAAI,CAAC,IAAI,GAAG,gBAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBACpC;qBAAM;oBACL,gBAAG,CAAC,IAAI,CACN,wDAAwD;wBACtD,mDAAmD;wBACnD,wDAAwD;wBACxD,iBAAiB,CACpB,CAAC;iBACH;aACF;SACF;QAED,MAAM,EAAC,CAAC,EAAE,CAAC,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,gBAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjE,IAAI,uBAAuB,KAAK,yBAAyB,EAAE;YACzD,wDAAwD;YACxD,gBAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YACvC,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,SAAS;gBACf,EAAE,EAAE,OAAO;gBACX,UAAU,EAAE,EAAC,WAAW,EAAE,OAAO,EAAC;gBAClC,OAAO,EAAE;oBACP,EAAC,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAC;oBACxC,EAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAC;oBAChC,EAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAC;oBAC1C,EAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAC;iBAC/B;aACF,CAAC;YAEF,gEAAgE;YAChE,IAAI,MAAM,CAAC,cAAc,EAAE;gBACzB,OAAO,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC9C;YAED,iDAAiD;YACjD,gBAAG,CAAC,IAAI,CAAC,8DAA8D,GAAG,iBAAiB,CAAC,CAAC;SAC9F;QAED,2EAA2E;QAC3E,iBAAiB;QACjB,gBAAG,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAC,CAAC,EAAE,CAAC,EAAC;SAChB,CAAC;QAEF,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,OAAO,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;SAC5C;QAED,MAAM,IAAI,KAAK,CACb,uDAAuD;YACrD,sDAAsD;YACtD,oDAAoD,CACvD,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI;QAC9C,QAAQ,GAAG,EAAE;YACX,KAAK,OAAO;gBACV,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACnC,KAAK,kBAAkB;gBACrB,OAAO,IAAI,CAAC;YACd,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC;YACpB,KAAK,aAAa,CAAC;YACnB,KAAK,mBAAmB;gBACtB,OAAO,KAAK,CAAC,QAAQ,CAAC;YACxB,KAAK,gBAAgB;gBACnB,OAAO,KAAK,CAAC,IAAI,CAAC;YACpB,KAAK,cAAc;gBACjB,yDAAyD;gBACzD,uFAAuF;gBACvF,8GAA8G;gBAC9G,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE;oBACf,KAAK,QAAQ;wBACX,OAAO,KAAK,CAAC,YAAY,CAAC;oBAC5B,KAAK,OAAO;wBACV,OAAO,KAAK,CAAC,KAAK,CAAC;oBACrB;wBACE,MAAM,IAAI,eAAM,CAAC,sBAAsB,EAAE,CAAC;iBAC7C;YACH;gBACE,MAAM,IAAI,eAAM,CAAC,sBAAsB,EAAE,CAAC;SAC7C;IACH,CAAC;CACF;AA7ND,+BA6NC;AAGC,oCAAY;AAOd;;;GAGG"}
+{"version":3,"file":"image-element.js","sourceRoot":"","sources":["../../lib/image-element.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAqC;AACrC,4CAAoC;AACpC,sDAA2B;AAC3B,2CAGqB;AAErB,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AAEH;;;GAGG;AACH,MAAqB,YAAY;IAC/B;;OAEG;IACH,YAAY,EACV,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,EACb,aAAa,GAAG,IAAI,GACrB;QACC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,GAAG,gCAAoB,GAAG,cAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,EAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,EAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO;YACL,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC;YACpC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;SACtC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,cAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK;YACpC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,CACvC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,MAAM;QAChB,2EAA2E;QAC3E,2BAA2B;QAC3B,IAAI,QAAQ,CAAC;QACb,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,4BAAgB,EAAE,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QACpF,MAAM,EACJ,8BAA8B,EAAE,SAAS,EACzC,6BAA6B,EAC7B,uBAAuB,GACxB,GAAG,QAAQ,CAAC;QAEb,wBAAwB;QACxB,IAAI,CAAC,gCAAoB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAC3D,MAAM,IAAI,KAAK,CACb,4CAA4C;gBAC1C,IAAI,uBAAuB,oBAAoB;gBAC/C,IAAI,CAAC,SAAS,CAAC,gCAAoB,CAAC,CACvC,CAAC;SACH;QAED,IAAI,6BAA6B,IAAI,SAAS,EAAE;YAC9C,gBAAG,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;YACjE,IAAI;gBACF,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE;oBAC9D,oBAAoB,EAAE,IAAI;oBAC1B,6FAA6F;oBAC7F,gFAAgF;oBAChF,+BAA+B,EAAE,IAAI;oBACrC,aAAa,EAAE,IAAI,CAAC,aAAa;iBAClC,CAAC,CAAC;aACJ;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,IAAI,eAAM,CAAC,0BAA0B,EAAE,CAAC;aAC/C;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBAC1B,gBAAG,CAAC,IAAI,CACN,8DAA8D;oBAC5D,4DAA4D;oBAC5D,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,yBAAyB;oBACzD,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,CAAC;gBACF,IAAI,SAAS,EAAE;oBACb,gBAAG,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;oBAClD,IAAI,CAAC,IAAI,GAAG,gBAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBACpC;qBAAM;oBACL,gBAAG,CAAC,IAAI,CACN,wDAAwD;wBACtD,mDAAmD;wBACnD,wDAAwD;wBACxD,iBAAiB,CACpB,CAAC;iBACH;aACF;SACF;QAED,MAAM,EAAC,CAAC,EAAE,CAAC,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,gBAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjE,IAAI,uBAAuB,KAAK,qCAAyB,EAAE;YACzD,wDAAwD;YACxD,gBAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YACvC,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,SAAS;gBACf,EAAE,EAAE,OAAO;gBACX,UAAU,EAAE,EAAC,WAAW,EAAE,OAAO,EAAC;gBAClC,OAAO,EAAE;oBACP,EAAC,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAC;oBACxC,EAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAC;oBAChC,EAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAC;oBAC1C,EAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAC;iBAC/B;aACF,CAAC;YAEF,gEAAgE;YAChE,IAAI,MAAM,CAAC,cAAc,EAAE;gBACzB,OAAO,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aAC9C;YAED,iDAAiD;YACjD,gBAAG,CAAC,IAAI,CAAC,8DAA8D,GAAG,iBAAiB,CAAC,CAAC;SAC9F;QAED,2EAA2E;QAC3E,iBAAiB;QACjB,gBAAG,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAC,CAAC,EAAE,CAAC,EAAC;SAChB,CAAC;QAEF,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,OAAO,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;SAC5C;QAED,MAAM,IAAI,KAAK,CACb,uDAAuD;YACrD,sDAAsD;YACtD,oDAAoD,CACvD,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;QAClC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAClC,IAAI,QAAQ,KAAK,0BAAc,EAAE;YAC/B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,iCAAiC,0BAAc,qBAAqB,CAAC,CAAC;SAC7G;QACD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,IAAI,EAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI;QAC9C,QAAQ,GAAG,EAAE;YACX,KAAK,OAAO;gBACV,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACnC,KAAK,wBAAwB;gBAC3B,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;YAClD,KAAK,yBAAyB;gBAC5B,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;YACjD,KAAK,kBAAkB;gBACrB,OAAO,IAAI,CAAC;YACd,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC;YACpB,KAAK,aAAa,CAAC;YACnB,KAAK,mBAAmB;gBACtB,OAAO,KAAK,CAAC,QAAQ,CAAC;YACxB,KAAK,gBAAgB;gBACnB,OAAO,KAAK,CAAC,IAAI,CAAC;YACpB,KAAK,sBAAsB;gBACzB,OAAO,KAAK,CAAC,aAAa,CAAC;YAC7B,KAAK,cAAc;gBACjB,yDAAyD;gBACzD,uFAAuF;gBACvF,8GAA8G;gBAC9G,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE;oBACf,KAAK,QAAQ;wBACX,OAAO,KAAK,CAAC,YAAY,CAAC;oBAC5B,KAAK,OAAO;wBACV,OAAO,KAAK,CAAC,KAAK,CAAC;oBACrB;wBACE,MAAM,IAAI,eAAM,CAAC,sBAAsB,EAAE,CAAC;iBAC7C;YACH;gBACE,MAAM,IAAI,eAAM,CAAC,sBAAsB,EAAE,CAAC;SAC7C;IACH,CAAC;CACF;AA1PD,+BA0PC;AAEO,oCAAY;AAEpB;;;GAGG"}

package/build/lib/plugin.d.ts

@@ -20,6 +20,7 @@ export default class ImageElementPlugin {
     handle(next: any, driver: any, cmdName: any, ...args: any[]): Promise<any>;
 }
 import ImageElementFinder from "./finder";
-export function getImgElFromArgs(args: any): string | undefined;
-export const IMAGE_STRATEGY: "-image";
+export function getImgElFromArgs(args: any): any;
+import { IMAGE_STRATEGY } from "./constants";
+export { IMAGE_STRATEGY };
 //# sourceMappingURL=plugin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":"AAmBA;IAOE;;;;;;;;;;;MAWG;IAjBH,6BAGC;IADC,2BAAsC;IAiBxC,wEAEC;IAED,kEAEC;IAED,mEAEC;IAED,2EAUC;IAED,2EAcC;CACF;;AAnED,gEAMC;AARD,sCAAgC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":"AAcA;IAOE;;;;;;;;;;;MAWG;IAjBH,6BAGC;IADC,2BAAsC;IAiBxC,wEAEC;IAED,kEAEC;IAED,mEAEC;IAED,2EASC;IAED,2EAkBC;CACF;;AAlED,iDAEC"}

package/build/lib/plugin.js

@@ -11,14 +11,10 @@ const plugin_1 = __importDefault(require("appium/plugin"));
 const compare_1 = require("./compare");
 const finder_1 = __importDefault(require("./finder"));
 const image_element_1 = require("./image-element");
-const IMAGE_STRATEGY = '-image';
-exports.IMAGE_STRATEGY = IMAGE_STRATEGY;
+const constants_1 = require("./constants");
+Object.defineProperty(exports, "IMAGE_STRATEGY", { enumerable: true, get: function () { return constants_1.IMAGE_STRATEGY; } });
 function getImgElFromArgs(args) {
-    for (let arg of args) {
-        if (lodash_1.default.isString(arg) && arg.startsWith(image_element_1.IMAGE_ELEMENT_PREFIX)) {
-            return arg;
-        }
-    }
+    return args.find((arg) => lodash_1.default.isString(arg) && arg.startsWith(constants_1.IMAGE_ELEMENT_PREFIX));
 }
 exports.getImgElFromArgs = getImgElFromArgs;
 class ImageElementPlugin extends plugin_1.default {
@@ -38,23 +34,25 @@ class ImageElementPlugin extends plugin_1.default {
     async _find(multiple, next, driver, ...args) {
         const [strategy, selector] = args;
         // if we're not actually finding by image, just do the normal thing
-        if (strategy !== IMAGE_STRATEGY) {
+        if (strategy !== constants_1.IMAGE_STRATEGY) {
             return await next();
         }
-        this.finder.setDriver(driver);
-        return await this.finder.findByImage(selector, { multiple });
+        return await this.finder.findByImage(selector, driver, { multiple });
     }
     async handle(next, driver, cmdName, ...args) {
         // if we have a command that involves an image element id, attempt to find the image element
         // and execute the command on it
         const imgElId = getImgElFromArgs(args);
         if (imgElId) {
-            if (!this.finder.imgElCache.has(imgElId)) {
+            const imgEl = this.finder.getImageElement(imgElId);
+            if (!imgEl) {
                 throw new driver_1.errors.NoSuchElementError();
             }
-            const imgEl = this.finder.imgElCache.get(imgElId);
             return await image_element_1.ImageElement.execute(driver, imgEl, cmdName, ...args);
         }
+        if (cmdName === 'deleteSession') {
+            this.finder.clearImageElements();
+        }
         // otherwise just do the normal thing
         return await next();
     }

package/build/lib/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";AAAA,yCAAyC;;;;;;AAEzC,oDAAuB;AACvB,0CAAqC;AACrC,2DAAuC;AACvC,uCAAwC;AACxC,sDAA0C;AAC1C,mDAAmE;AAEnE,MAAM,cAAc,GAAG,QAAQ,CAAC;AAuEc,wCAAc;AArE5D,SAAS,gBAAgB,CAAC,IAAI;IAC5B,KAAK,IAAI,GAAG,IAAI,IAAI,EAAE;QACpB,IAAI,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,oCAAoB,CAAC,EAAE;YAC3D,OAAO,GAAG,CAAC;SACZ;KACF;AACH,CAAC;AA+D2B,4CAAgB;AA7D5C,MAAqB,kBAAmB,SAAQ,gBAAU;IACxD,YAAY,UAAU;QACpB,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAkB,EAAE,CAAC;IACzC,CAAC;IAgBD,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACvC,OAAO,MAAM,IAAA,uBAAa,EAAC,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACrC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACtC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACzC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAElC,mEAAmE;QACnE,IAAI,QAAQ,KAAK,cAAc,EAAE;YAC/B,OAAO,MAAM,IAAI,EAAE,CAAC;SACrB;QAED,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9B,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;QACzC,4FAA4F;QAC5F,gCAAgC;QAChC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACxC,MAAM,IAAI,eAAM,CAAC,kBAAkB,EAAE,CAAC;aACvC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,MAAM,4BAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;SACpE;QAED,qCAAqC;QACrC,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;;AA1DH,qCA2DC;AAEO,gDAAkB;AAvDxB,+DAA+D;AACxD,+BAAY,GAAwB,CAAC;IAC1C,2CAA2C,EAAE;QAC3C,IAAI,EAAE;YACJ,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE;gBACb,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC;gBAC/C,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,UAAU,EAAE,IAAI;SACjB;KACF;CACF,CAAC,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";AAAA,yCAAyC;;;;;;AAEzC,oDAAuB;AACvB,0CAAqC;AACrC,2DAAuC;AACvC,uCAAwC;AACxC,sDAA0C;AAC1C,mDAA6C;AAC7C,2CAAiE;AAsEnB,+FAtEtC,0BAAc,OAsEsC;AApE5D,SAAS,gBAAgB,CAAC,IAAI;IAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,gCAAoB,CAAC,CAAC,CAAC;AACrF,CAAC;AAkE2B,4CAAgB;AAhE5C,MAAqB,kBAAmB,SAAQ,gBAAU;IACxD,YAAY,UAAU;QACpB,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAkB,EAAE,CAAC;IACzC,CAAC;IAgBD,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACvC,OAAO,MAAM,IAAA,uBAAa,EAAC,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACrC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACtC,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACzC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAElC,mEAAmE;QACnE,IAAI,QAAQ,KAAK,0BAAc,EAAE;YAC/B,OAAO,MAAM,IAAI,EAAE,CAAC;SACrB;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;QACzC,4FAA4F;QAC5F,gCAAgC;QAChC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,eAAM,CAAC,kBAAkB,EAAE,CAAC;aACvC;YACD,OAAO,MAAM,4BAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;SACpE;QAED,IAAI,OAAO,KAAK,eAAe,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;SAClC;QAED,qCAAqC;QACrC,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;;AA7DH,qCA8DC;AAEO,gDAAkB;AA1DxB,+DAA+D;AACxD,+BAAY,GAAwB,CAAC;IAC1C,2CAA2C,EAAE;QAC3C,IAAI,EAAE;YACJ,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE;gBACb,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC;gBAC/C,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,UAAU,EAAE,IAAI;SACjB;KACF;CACF,CAAC,CAAC"}

package/lib/compare.js

@@ -1,12 +1,7 @@
 import _ from 'lodash';
 import {errors} from 'appium/driver';
 import {getImagesMatches, getImagesSimilarity, getImageOccurrence} from '@appium/opencv';
-
-const MATCH_FEATURES_MODE = 'matchFeatures';
-const GET_SIMILARITY_MODE = 'getSimilarity';
-const MATCH_TEMPLATE_MODE = 'matchTemplate';
-
-const DEFAULT_MATCH_THRESHOLD = 0.4;
+import {MATCH_FEATURES_MODE, GET_SIMILARITY_MODE, MATCH_TEMPLATE_MODE} from './constants';
 
 /**
  * Performs images comparison using OpenCV framework features.
@@ -15,9 +10,9 @@ const DEFAULT_MATCH_THRESHOLD = 0.4;
  *
  * @param {string} mode - One of possible comparison modes:
  * matchFeatures, getSimilarity, matchTemplate
- * @param {string} firstImage - Base64-encoded image file.
+ * @param {string|Buffer} firstImage - Base64-encoded image file.
  * All image formats, that OpenCV library itself accepts, are supported.
- * @param {string} secondImage - Base64-encoded image file.
+ * @param {string|Buffer} 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`
@@ -34,8 +29,8 @@ const DEFAULT_MATCH_THRESHOLD = 0.4;
  * @type {import('@appium/types').PluginCommand<[string, string, string, object|undefined], Promise<OccurrenceResult>>}
  */
 async function compareImages(mode, firstImage, secondImage, options = {}) {
-  const img1 = Buffer.from(firstImage, 'base64');
-  const img2 = Buffer.from(secondImage, 'base64');
+  const img1 = Buffer.isBuffer(firstImage) ? firstImage : Buffer.from(firstImage, 'base64');
+  const img2 = Buffer.isBuffer(secondImage) ? secondImage : Buffer.from(secondImage, 'base64');
   let result = null;
   switch (_.toLower(mode)) {
     case MATCH_FEATURES_MODE.toLowerCase():
@@ -84,13 +79,7 @@ function convertVisualizationToBase64(element) {
   return element;
 }
 
-export {
-  compareImages,
-  DEFAULT_MATCH_THRESHOLD,
-  MATCH_TEMPLATE_MODE,
-  MATCH_FEATURES_MODE,
-  GET_SIMILARITY_MODE,
-};
+export {compareImages};
 
 /**
  * @typedef {import('@appium/opencv').OccurrenceResult} OccurrenceResult

package/lib/constants.js

@@ -0,0 +1,70 @@
+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,
+});