@appium/images-plugin 2.0.10 → 2.1.0

package/build/lib/compare.d.ts

@@ -1,7 +1,3 @@
 export type OccurrenceResult = import('@appium/opencv').OccurrenceResult;
 export function compareImages(next: import("@appium/types").NextPluginCallback<unknown>, driver: [string, string, string, any], ...args: Promise<import("@appium/opencv").OccurrenceResult>): Promise<unknown>;
-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

@@ -1 +1 @@
-{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":"+BA+Fa,OAAO,gBAAgB,EAAE,gBAAgB;AAEghC,+MAAsF;AAzF5pC,0CAAoC;AAFpC,kDAA4C;AAF5C,kDAA4C;AAC5C,kDAA4C"}
+{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":"+BAoFa,OAAO,gBAAgB,EAAE,gBAAgB;AAEkmC,+MAAsF"}

package/build/lib/compare.js

@@ -3,18 +3,11 @@ 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;
+exports.compareImages = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const driver_1 = require("appium/driver");
 const opencv_1 = require("@appium/opencv");
-const MATCH_FEATURES_MODE = 'matchFeatures';
-exports.MATCH_FEATURES_MODE = MATCH_FEATURES_MODE;
-const GET_SIMILARITY_MODE = 'getSimilarity';
-exports.GET_SIMILARITY_MODE = GET_SIMILARITY_MODE;
-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;
+const constants_1 = require("./constants");
 /**
  * Performs images comparison using OpenCV framework features.
  * It is expected that both OpenCV framework and opencv4nodejs
@@ -22,9 +15,9 @@ exports.DEFAULT_MATCH_THRESHOLD = DEFAULT_MATCH_THRESHOLD;
  *
  * @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`
@@ -40,11 +33,11 @@ exports.DEFAULT_MATCH_THRESHOLD = DEFAULT_MATCH_THRESHOLD;
  * @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 (lodash_1.default.toLower(mode)) {
-        case MATCH_FEATURES_MODE.toLowerCase():
+        case constants_1.MATCH_FEATURES_MODE.toLowerCase():
             try {
                 result = await (0, opencv_1.getImagesMatches)(img1, img2, options);
             }
@@ -53,10 +46,10 @@ async function compareImages(mode, firstImage, secondImage, options = {}) {
                 result = { count: 0 };
             }
             break;
-        case GET_SIMILARITY_MODE.toLowerCase():
+        case constants_1.GET_SIMILARITY_MODE.toLowerCase():
             result = await (0, opencv_1.getImagesSimilarity)(img1, img2, options);
             break;
-        case MATCH_TEMPLATE_MODE.toLowerCase():
+        case constants_1.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) {
@@ -66,9 +59,9 @@ async function compareImages(mode, firstImage, secondImage, options = {}) {
         default:
             throw new driver_1.errors.InvalidArgumentError(`'${mode}' images comparison mode is unknown. ` +
                 `Only ${JSON.stringify([
-                    MATCH_FEATURES_MODE,
-                    GET_SIMILARITY_MODE,
-                    MATCH_TEMPLATE_MODE,
+                    constants_1.MATCH_FEATURES_MODE,
+                    constants_1.GET_SIMILARITY_MODE,
+                    constants_1.MATCH_TEMPLATE_MODE,
                 ])} modes are supported.`);
     }
     return convertVisualizationToBase64(result);

package/build/lib/compare.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAqC;AACrC,2CAAyF;AAEzF,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAsF1C,kDAAmB;AArFrB,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAsF1C,kDAAmB;AArFrB,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAmF1C,kDAAmB;AAjFrB,MAAM,uBAAuB,GAAG,GAAG,CAAC;AAgFlC,0DAAuB;AA9EzB;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,GAAG,EAAE;IACtE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAChD,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,KAAK,mBAAmB,CAAC,WAAW,EAAE;YACpC,IAAI;gBACF,MAAM,GAAG,MAAM,IAAA,yBAAgB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,4BAA4B;gBAC5B,MAAM,GAAG,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC;aACrB;YACD,MAAM;QACR,KAAK,mBAAmB,CAAC,WAAW,EAAE;YACpC,MAAM,GAAG,MAAM,IAAA,4BAAmB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM;QACR,KAAK,mBAAmB,CAAC,WAAW,EAAE;YACpC,4EAA4E;YAC5E,MAAM,GAAG,MAAM,IAAA,2BAAkB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACvD,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;aAC1D;YACD,MAAM;QACR;YACE,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,IAAI,IAAI,uCAAuC;gBAC7C,QAAQ,IAAI,CAAC,SAAS,CAAC;oBACrB,mBAAmB;oBACnB,mBAAmB;oBACnB,mBAAmB;iBACpB,CAAC,uBAAuB,CAC5B,CAAC;KACL;IACD,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAkBC,sCAAa;AAhBf;;;;;;IAMI;AACJ,SAAS,4BAA4B,CAAC,OAAO;IAC3C,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACrC,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAClE;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAUD;;GAEG"}
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,0CAAqC;AACrC,2CAAyF;AACzF,2CAA0F;AAE1F;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,GAAG,EAAE;IACtE,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC1F,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC7F,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,IAAI;gBACF,MAAM,GAAG,MAAM,IAAA,yBAAgB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,4BAA4B;gBAC5B,MAAM,GAAG,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC;aACrB;YACD,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,MAAM,GAAG,MAAM,IAAA,4BAAmB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,4EAA4E;YAC5E,MAAM,GAAG,MAAM,IAAA,2BAAkB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACvD,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;aAC1D;YACD,MAAM;QACR;YACE,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,IAAI,IAAI,uCAAuC;gBAC7C,QAAQ,IAAI,CAAC,SAAS,CAAC;oBACrB,+BAAmB;oBACnB,+BAAmB;oBACnB,+BAAmB;iBACpB,CAAC,uBAAuB,CAC5B,CAAC;KACL;IACD,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAiBO,sCAAa;AAfrB;;;;;;IAMI;AACJ,SAAS,4BAA4B,CAAC,OAAO;IAC3C,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACrC,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAClE;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAID;;GAEG"}

package/build/lib/constants.d.ts

@@ -0,0 +1,13 @@
+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: string[];
+export const DEFAULT_TEMPLATE_IMAGE_SCALE: 1;
+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: any;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAEA,sCAAuC;AAEvC,2DAA4D;AAC5D,qDAAsD;AACtD,2DAA4D;AAC5D,4CAA+F;AAC/F,6CAAgD;AAEhD,kDAAmD;AACnD,kDAAmD;AACnD,kDAAmD;AAEnD,0CAA2C;AAE3C,iDAAkD;AAElD,mCAmDG"}

package/build/lib/constants.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SETTINGS = exports.DEFAULT_FIX_IMAGE_TEMPLATE_SCALE = exports.DEFAULT_MATCH_THRESHOLD = exports.MATCH_TEMPLATE_MODE = exports.GET_SIMILARITY_MODE = exports.MATCH_FEATURES_MODE = exports.DEFAULT_TEMPLATE_IMAGE_SCALE = exports.IMAGE_TAP_STRATEGIES = exports.IMAGE_EL_TAP_STRATEGY_MJSONWP = exports.IMAGE_EL_TAP_STRATEGY_W3C = exports.IMAGE_ELEMENT_PREFIX = exports.IMAGE_STRATEGY = void 0;
+const support_1 = require("@appium/support");
+exports.IMAGE_STRATEGY = '-image';
+exports.IMAGE_ELEMENT_PREFIX = 'appium-image-element-';
+exports.IMAGE_EL_TAP_STRATEGY_W3C = 'w3cActions';
+exports.IMAGE_EL_TAP_STRATEGY_MJSONWP = 'touchActions';
+exports.IMAGE_TAP_STRATEGIES = [exports.IMAGE_EL_TAP_STRATEGY_MJSONWP, exports.IMAGE_EL_TAP_STRATEGY_W3C];
+exports.DEFAULT_TEMPLATE_IMAGE_SCALE = 1.0;
+exports.MATCH_FEATURES_MODE = 'matchFeatures';
+exports.GET_SIMILARITY_MODE = 'getSimilarity';
+exports.MATCH_TEMPLATE_MODE = 'matchTemplate';
+exports.DEFAULT_MATCH_THRESHOLD = 0.4;
+exports.DEFAULT_FIX_IMAGE_TEMPLATE_SCALE = 1;
+exports.DEFAULT_SETTINGS = support_1.node.deepFreeze({
+    // value between 0 and 1 representing match strength, below which an image
+    // element will not be found
+    imageMatchThreshold: exports.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: exports.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: exports.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,
+});
+//# sourceMappingURL=constants.js.map

package/build/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":";;;AAAA,6CAAqC;AAExB,QAAA,cAAc,GAAG,QAAQ,CAAC;AAE1B,QAAA,oBAAoB,GAAG,uBAAuB,CAAC;AAC/C,QAAA,yBAAyB,GAAG,YAAY,CAAC;AACzC,QAAA,6BAA6B,GAAG,cAAc,CAAC;AAC/C,QAAA,oBAAoB,GAAG,CAAC,qCAA6B,EAAE,iCAAyB,CAAC,CAAC;AAClF,QAAA,4BAA4B,GAAG,GAAG,CAAC;AAEnC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AACtC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AACtC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEtC,QAAA,uBAAuB,GAAG,GAAG,CAAC;AAE9B,QAAA,gCAAgC,GAAG,CAAC,CAAC;AAErC,QAAA,gBAAgB,GAAG,cAAI,CAAC,UAAU,CAAC;IAC9C,0EAA0E;IAC1E,4BAA4B;IAC5B,mBAAmB,EAAE,+BAAuB;IAE5C,0CAA0C;IAC1C,mHAAmH;IACnH,oBAAoB;IACpB,8BAA8B;IAC9B,gBAAgB,EAAE,EAAE;IAEpB,yEAAyE;IACzE,mDAAmD;IACnD,0BAA0B,EAAE,IAAI;IAEhC,2EAA2E;IAC3E,6EAA6E;IAC7E,WAAW;IACX,oBAAoB,EAAE,KAAK;IAE3B,2EAA2E;IAC3E,2EAA2E;IAC3E,+BAA+B;IAC/B,0EAA0E;IAC1E,+EAA+E;IAC/E,6EAA6E;IAC7E,qBAAqB,EAAE,KAAK;IAE5B,uEAAuE;IACvE,iFAAiF;IACjF,4EAA4E;IAC5E,yFAAyF;IACzF,kFAAkF;IAClF,8EAA8E;IAC9E,yBAAyB,EAAE,oCAA4B;IAEvD,sEAAsE;IACtE,oDAAoD;IACpD,6BAA6B,EAAE,IAAI;IAEnC,6EAA6E;IAC7E,oCAAoC;IACpC,8BAA8B,EAAE,KAAK;IAErC,wEAAwE;IACxE,iCAAiC;IACjC,uBAAuB,EAAE,iCAAyB;IAElD,4EAA4E;IAC5E,oCAAoC;IACpC,qBAAqB,EAAE,KAAK;CAC7B,CAAC,CAAC"}

package/build/lib/finder.d.ts

@@ -1,20 +1,21 @@
 export default class ImageElementFinder {
     /**
-     *
-     * @param {ExternalDriver} driver
-     * @param {number} [maxSize]
+     * @param {number} max
      */
-    constructor(driver: ExternalDriver, maxSize?: number | undefined);
-    /** @type {ExternalDriver} */
-    driver: ExternalDriver;
+    constructor(max?: number);
     /** @type {LRU<string,ImageElement>} */
-    imgElCache: LRU<string, ImageElement>;
-    setDriver(driver: any): void;
+    _imgElCache: LRU<string, ImageElement>;
     /**
      * @param {ImageElement} imgEl
      * @returns {Element}
      */
     registerImageElement(imgEl: ImageElement): Element;
+    /**
+     * @param {string} imgElId
+     * @returns {ImageElement|undefined}
+     */
+    getImageElement(imgElId: string): ImageElement | undefined;
+    clearImageElements(): void;
     /**
      * @typedef FindByImageOptions
      * @property {boolean} [shouldCheckStaleness=false] - whether this call to find an
@@ -23,19 +24,22 @@ export default class ImageElementFinder {
      * multiple
      * @property {boolean} [ignoreDefaultImageTemplateScale=false] - Whether we
      * ignore defaultImageTemplateScale. It can be used when you would like to
-     * scale b64Template with defaultImageTemplateScale setting.
+     * scale template with defaultImageTemplateScale setting.
+     * @property {import('@appium/types').Rect?} containerRect - The bounding
+     * rectangle to limit the search in
      */
     /**
      * 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
+     * @param {Buffer} template - image used as a template to be
      * matched in the screenshot
+     * @param {ExternalDriver} driver
      * @param {FindByImageOptions} opts - additional options
      *
      * @returns {Promise<Element|Element[]|ImageElement>} - WebDriver element with a special id prefix
      */
-    findByImage(b64Template: string, { shouldCheckStaleness, multiple, ignoreDefaultImageTemplateScale }: {
+    findByImage(template: Buffer, driver: ExternalDriver, { shouldCheckStaleness, multiple, ignoreDefaultImageTemplateScale, containerRect }: {
         /**
          * - whether this call to find an
          * image is merely to check staleness. If so we can bypass a lot of logic
@@ -49,30 +53,34 @@ export default class ImageElementFinder {
         /**
          * - Whether we
          * ignore defaultImageTemplateScale. It can be used when you would like to
-         * scale b64Template with defaultImageTemplateScale setting.
+         * scale template with defaultImageTemplateScale setting.
          */
         ignoreDefaultImageTemplateScale?: boolean | undefined;
+        /**
+         * - The bounding
+         * rectangle to limit the search in
+         */
+        containerRect: import('@appium/types').Rect | null;
     }): Promise<Element | Element[] | ImageElement>;
     /**
      * Ensure that the image template sent in for a find is of a suitable size
      *
-     * @param {string} b64Template - base64-encoded image
-     * @param {number} screenWidth - width of screen
-     * @param {number} screenHeight - height of screen
+     * @param {Buffer} template - template image
+     * @param {import('@appium/types').Size} maxSize - size of the bounding rectangle
      *
-     * @returns {Promise<string>} base64-encoded image, potentially resized
+     * @returns {Promise<Buffer>} image, potentially resized
      */
-    ensureTemplateSize(b64Template: string, screenWidth: number, screenHeight: number): Promise<string>;
+    ensureTemplateSize(template: Buffer, maxSize: import('@appium/types').Size): Promise<Buffer>;
     /**
      * Get the screenshot image that will be used for find by element, potentially
      * altering it in various ways based on user-requested settings
      *
-     * @param {number} screenWidth - width of screen
-     * @param {number} screenHeight - height of screen
+     * @param {ExternalDriver} driver
+     * @param {import('@appium/types').Size} screenSize - The original size of the screen
      *
-     * @returns {Promise<Screenshot & {scale?: ScreenshotScale}>} base64-encoded screenshot and ScreenshotScale
+     * @returns {Promise<Screenshot & {scale?: ScreenshotScale}>} PNG screenshot and ScreenshotScale
      */
-    getScreenshotForImageFind(screenWidth: number, screenHeight: number): Promise<Screenshot & {
+    getScreenshotForImageFind(driver: ExternalDriver, screenSize: import('@appium/types').Size): Promise<Screenshot & {
         scale?: ScreenshotScale | undefined;
     }>;
     /**
@@ -80,7 +88,7 @@ export default class ImageElementFinder {
      * @property {boolean} fixImageTemplateScale - fixImageTemplateScale in device-settings
      * @property {number} 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,
+     * If the template has been scaled to defaultImageTemplateScale or should ignore the scale,
      * this parameter should be true. e.g. click in image-element module
      * @property {number} xScale - Scale ratio for width
      * @property {number} yScale - Scale ratio for height
@@ -90,14 +98,13 @@ export default class ImageElementFinder {
      * 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
+     * @param {Buffer} template - image used as a template to be
      * matched in the screenshot
      * @param {ImageTemplateSettings} opts - Image template scale related options
      *
-     * @returns {Promise<string>} base64-encoded scaled template screenshot
+     * @returns {Promise<Buffer>} scaled template screenshot
      */
-    fixImageTemplateScale(b64Template: string, opts: {
+    fixImageTemplateScale(template: Buffer, opts: {
         /**
          * - fixImageTemplateScale in device-settings
          */
@@ -108,7 +115,7 @@ export default class ImageElementFinder {
         defaultImageTemplateScale: number;
         /**
          * - Ignore defaultImageTemplateScale if it has true.
-         * If b64Template has been scaled to defaultImageTemplateScale or should ignore the scale,
+         * If the template has been scaled to defaultImageTemplateScale or should ignore the scale,
          * this parameter should be true. e.g. click in image-element module
          */
         ignoreDefaultImageTemplateScale: boolean;
@@ -120,15 +127,15 @@ export default class ImageElementFinder {
          * - Scale ratio for height
          */
         yScale: number;
-    }): Promise<string>;
+    }): Promise<Buffer>;
 }
 export type ExternalDriver = import('@appium/types').ExternalDriver;
 export type Element = import('@appium/types').Element;
 export type Screenshot = {
     /**
-     * - base64 based screenshot string
+     * - screenshot image as PNG
      */
-    b64Screenshot: string;
+    screenshot: Buffer;
 };
 export type ScreenshotScale = {
     /**
@@ -142,22 +149,4 @@ export type ScreenshotScale = {
 };
 import LRU from "lru-cache";
 import { ImageElement } from "./image-element";
-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

@@ -1 +1 @@
-{"version":3,"file":"finder.d.ts","sourceRoot":"","sources":["../../lib/finder.js"],"names":[],"mappings":"AA6EA;IAOE;;;;OAIG;IACH,oBAHW,cAAc,gCAUxB;IAlBD,6BAA6B;IAC7B,QADW,cAAc,CAClB;IAEP,uCAAuC;IACvC,YADW,IAAI,MAAM,EAAC,YAAY,CAAC,CACxB;IAgBX,6BAEC;IAED;;;OAGG;IACH,4BAHW,YAAY,GACV,OAAO,CAMnB;IAED;;;;;;;;;OASG;IAEH;;;;;;;;;OASG;IACH,yBANW,MAAM;;;;;;;;;;;;;;;;;QAIJ,QAAQ,OAAO,GAAC,OAAO,EAAE,GAAC,YAAY,CAAC,CAuHnD;IAED;;;;;;;;OAQG;IACH,gCANW,MAAM,eACN,MAAM,gBACN,MAAM,GAEJ,QAAQ,MAAM,CAAC,CAqB3B;IAED;;;;;;;;OAQG;IACH,uCALW,MAAM,gBACN,MAAM;;OAuHhB;IAED;;;;;;;;;;OAUG;IACH;;;;;;;;;;OAUG;IACH,mCANW,MAAM;;;;+BAdH,OAAO;;;;mCACP,MAAM;;;;;;yCACN,OAAO;;;;gBAGP,MAAM;;;;gBACN,MAAM;QAYP,QAAQ,MAAM,CAAC,CA+D3B;CACF;6BAKY,OAAO,eAAe,EAAE,cAAc;sBACtC,OAAO,eAAe,EAAE,OAAO;;;;;mBAK9B,MAAM;;;;;;YAKN,MAAM;;;;YACN,MAAM;;;;AAhfpB,oEAAwD;AADxD,4CAAsC;;;;;;;;;;;;;AAEtC,iDAA2C"}
+{"version":3,"file":"finder.d.ts","sourceRoot":"","sources":["../../lib/finder.js"],"names":[],"mappings":"AAmCA;IAIE;;OAEG;IACH,kBAFW,MAAM,EAQhB;IAZD,uCAAuC;IACvC,aADW,IAAI,MAAM,EAAC,YAAY,CAAC,CACvB;IAaZ;;;OAGG;IACH,4BAHW,YAAY,GACV,OAAO,CAKnB;IAED;;;OAGG;IACH,yBAHW,MAAM,GACJ,YAAY,GAAC,SAAS,CAIlC;IAED,2BAEC;IAED;;;;;;;;;;;OAWG;IAEH;;;;;;;;;;OAUG;IACH,sBAPW,MAAM,UAEN,cAAc;;;;;;;;;;;;;;;;;;;;;uBAVX,OAAO,eAAe,EAAE,IAAI;QAa7B,QAAQ,OAAO,GAAC,OAAO,EAAE,GAAC,YAAY,CAAC,CAsInD;IAED;;;;;;;OAOG;IACH,6BALW,MAAM,WACN,OAAO,eAAe,EAAE,IAAI,GAE1B,QAAQ,MAAM,CAAC,CA0B3B;IAED;;;;;;;;OAQG;IACH,kCALW,cAAc,cACd,OAAO,eAAe,EAAE,IAAI;;OAiItC;IAED;;;;;;;;;;OAUG;IACH;;;;;;;;;OASG;IACH,gCANW,MAAM;;;;+BAbH,OAAO;;;;mCACP,MAAM;;;;;;yCACN,OAAO;;;;gBAGP,MAAM;;;;gBACN,MAAM;QAWP,QAAQ,MAAM,CAAC,CAkE3B;CACF;6BAGY,OAAO,eAAe,EAAE,cAAc;sBACtC,OAAO,eAAe,EAAE,OAAO;;;;;gBAK9B,MAAM;;;;;;YAKN,MAAM;;;;YACN,MAAM"}