@appium/images-plugin 4.0.4 → 4.1.1

package/build/lib/compare.d.ts

@@ -1,39 +1,25 @@
-export type Visualized = {
-    visualization: string | null | undefined;
-};
-export type MatchingResult = import("@appium/opencv").MatchingResult & Visualized;
-export type OccurrenceResult = import("@appium/opencv").OccurrenceResult & Visualized;
-export type SimilarityResult = import("@appium/opencv").SimilarityResult & Visualized;
-export type ComparisonResult = MatchingResult | OccurrenceResult | SimilarityResult | SimilarityResult[];
-/**
- * @typedef {{visualization: string|null|undefined}} Visualized
- * @typedef {import('@appium/opencv').MatchingResult & Visualized} MatchingResult
- * @typedef {import('@appium/opencv').OccurrenceResult & Visualized} OccurrenceResult
- * @typedef {import('@appium/opencv').SimilarityResult & Visualized} SimilarityResult
- * @typedef {MatchingResult|OccurrenceResult|SimilarityResult|SimilarityResult[]} ComparisonResult
- */
+import { type MatchingOptions, type SimilarityOptions, type OccurrenceOptions } from '@appium/opencv';
+import type { ComparisonResult } from './types';
 /**
  * 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:
+ * @param mode - One of possible comparison modes:
  * matchFeatures, getSimilarity, matchTemplate
- * @param {string|Buffer} firstImage - Base64-encoded image file.
+ * @param firstImage - Base64-encoded image file.
  * All image formats, that OpenCV library itself accepts, are supported.
- * @param {string|Buffer} secondImage - Base64-encoded image file.
+ * @param secondImage - Base64-encoded image file.
  * All image formats, that OpenCV library itself accepts, are supported.
- * @param {import('@appium/opencv').MatchingOptions
- * |import('@appium/opencv').SimilarityOptions
- * |import('@appium/opencv').OccurrenceOptions} [options={}] - The content of this dictionary depends
+ * @param options - The content of this dictionary depends
  * on the actual `mode` value. See the documentation on `@appium/support`
  * module for more details.
- * @returns {Promise<ComparisonResult>} The content of the resulting dictionary depends
+ * @returns 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 | Buffer, secondImage: string | Buffer, options?: import("@appium/opencv").MatchingOptions | import("@appium/opencv").SimilarityOptions | import("@appium/opencv").OccurrenceOptions): Promise<ComparisonResult>;
+export declare function compareImages(mode: string, firstImage: string | Buffer, secondImage: string | Buffer, options?: MatchingOptions | SimilarityOptions | OccurrenceOptions): Promise<ComparisonResult>;
 //# 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":"yBAMa;IAAC,aAAa,EAAE,MAAM,GAAC,IAAI,GAAC,SAAS,CAAA;CAAC;6BACtC,OAAO,gBAAgB,EAAE,cAAc,GAAG,UAAU;+BACpD,OAAO,gBAAgB,EAAE,gBAAgB,GAAG,UAAU;+BACtD,OAAO,gBAAgB,EAAE,gBAAgB,GAAG,UAAU;+BACtD,cAAc,GAAC,gBAAgB,GAAC,gBAAgB,GAAC,gBAAgB,EAAE;AALhF;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,oCAlBW,MAAM,cAEN,MAAM,GAAC,MAAM,eAEb,MAAM,GAAC,MAAM,YAEb,OAAO,gBAAgB,EAAE,eAAe,GAC/C,OAAO,gBAAgB,EAAE,iBAAiB,GAC1C,OAAO,gBAAgB,EAAE,iBAAiB,GAGjC,OAAO,CAAC,gBAAgB,CAAC,CAgDrC"}
+{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../lib/compare.ts"],"names":[],"mappings":"AAEA,OAAO,EAOL,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,WAAW,EAAE,MAAM,GAAG,MAAM,EAC5B,OAAO,GAAE,eAAe,GAAG,iBAAiB,GAAG,iBAAsB,GACpE,OAAO,CAAC,gBAAgB,CAAC,CAuC3B"}

package/build/lib/compare.js

@@ -8,30 +8,21 @@ const lodash_1 = __importDefault(require("lodash"));
 const driver_1 = require("appium/driver");
 const opencv_1 = require("@appium/opencv");
 const constants_1 = require("./constants");
-/**
- * @typedef {{visualization: string|null|undefined}} Visualized
- * @typedef {import('@appium/opencv').MatchingResult & Visualized} MatchingResult
- * @typedef {import('@appium/opencv').OccurrenceResult & Visualized} OccurrenceResult
- * @typedef {import('@appium/opencv').SimilarityResult & Visualized} SimilarityResult
- * @typedef {MatchingResult|OccurrenceResult|SimilarityResult|SimilarityResult[]} ComparisonResult
- */
 /**
  * Performs images comparison using OpenCV framework features.
  * It is expected that both OpenCV framework and opencv4nodejs
  * module are installed on the machine where Appium server is running.
  *
- * @param {string} mode - One of possible comparison modes:
+ * @param mode - One of possible comparison modes:
  * matchFeatures, getSimilarity, matchTemplate
- * @param {string|Buffer} firstImage - Base64-encoded image file.
+ * @param firstImage - Base64-encoded image file.
  * All image formats, that OpenCV library itself accepts, are supported.
- * @param {string|Buffer} secondImage - Base64-encoded image file.
+ * @param secondImage - Base64-encoded image file.
  * All image formats, that OpenCV library itself accepts, are supported.
- * @param {import('@appium/opencv').MatchingOptions
- * |import('@appium/opencv').SimilarityOptions
- * |import('@appium/opencv').OccurrenceOptions} [options={}] - The content of this dictionary depends
+ * @param options - The content of this dictionary depends
  * on the actual `mode` value. See the documentation on `@appium/support`
  * module for more details.
- * @returns {Promise<ComparisonResult>} The content of the resulting dictionary depends
+ * @returns 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
@@ -45,22 +36,25 @@ async function compareImages(mode, firstImage, secondImage, options = {}) {
     switch (lodash_1.default.toLower(mode)) {
         case constants_1.MATCH_FEATURES_MODE.toLowerCase():
             try {
-                result = await (0, opencv_1.getImagesMatches)(img1, img2, /** @type {import('@appium/opencv').MatchingOptions} */ (options));
+                result = await (0, opencv_1.getImagesMatches)(img1, img2, options);
             }
             catch {
                 // might throw if no matches
-                result = /** @type {import('@appium/opencv').MatchingResult} */ ({ count: 0 });
+                result = { count: 0 };
             }
             break;
         case constants_1.GET_SIMILARITY_MODE.toLowerCase():
-            result = await (0, opencv_1.getImagesSimilarity)(img1, img2, /** @type {import('@appium/opencv').SimilarityOptions} */ (options));
+            result = await (0, opencv_1.getImagesSimilarity)(img1, img2, options);
             break;
         case constants_1.MATCH_TEMPLATE_MODE.toLowerCase(): {
-            const opts = /** @type {import('@appium/opencv').OccurrenceOptions} */ (options);
+            const opts = options;
             // firstImage/img1 is the full image and secondImage/img2 is the partial one
             result = await (0, opencv_1.getImageOccurrence)(img1, img2, opts);
             if (opts.multiple && result.multiple) {
-                return result.multiple.map(convertVisualizationToBase64);
+                const multipleResults = result.multiple;
+                if (multipleResults) {
+                    return multipleResults.map(convertVisualizationToBase64);
+                }
             }
             break;
         }
@@ -78,14 +72,14 @@ async function compareImages(mode, firstImage, secondImage, options = {}) {
  * base64 encodes the visualization part of the result
  * (if necessary)
  *
- * @param {Partial<{visualization: Buffer|null}>} element - occurrence result
- * @returns {any} I know this looks ugly from the typing perspective
+ * @param element - occurrence result
+ * @returns result with base64-encoded visualization
  **/
 function convertVisualizationToBase64(element) {
     return Buffer.isBuffer(element.visualization)
         ? {
-            ...(element),
-            visualization: element.visualization.toString('base64')
+            ...element,
+            visualization: element.visualization.toString('base64'),
         }
         : element;
 }

package/build/lib/compare.js.map

@@ -1 +1 @@
-{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../lib/compare.js"],"names":[],"mappings":";;;;;AA+FQ,sCAAa;AA/FrB,oDAAuB;AACvB,0CAAqC;AACrC,2CAAyF;AACzF,2CAA0F;AAE1F;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;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,CAAC;IACX,QAAQ,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAA,yBAAgB,EAC7B,IAAI,EAAE,IAAI,EAAE,uDAAuD,CAAA,CAAC,OAAO,CAAC,CAC7E,CAAC;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,4BAA4B;gBAC5B,MAAM,GAAG,sDAAsD,CAAA,CAAC,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,MAAM,GAAG,MAAM,IAAA,4BAAmB,EAChC,IAAI,EAAE,IAAI,EAAE,yDAAyD,CAAA,CAAC,OAAO,CAAC,CAAC,CAAC;YAClF,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,yDAAyD,CAAA,CAAC,OAAO,CAAC,CAAC;YAChF,4EAA4E;YAC5E,MAAM,GAAG,MAAM,IAAA,2BAAkB,EAC/B,IAAI,EAAE,IAAI,EAAE,IAAI,CACjB,CAAC;YACF,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrC,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM;QACR,CAAC;QACD;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;IACN,CAAC;IACD,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;IAMI;AACJ,SAAS,4BAA4B,CAAC,OAAO;IAC3C,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC;QAC3C,CAAC,CAAC;YACA,GAAG,CAAC,OAAO,CAAC;YACZ,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACxD;QACD,CAAC,CAAC,OAAO,CAAC;AACd,CAAC"}
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../lib/compare.ts"],"names":[],"mappings":";;;;;AAqCA,sCA4CC;AAjFD,oDAAuB;AACvB,0CAAqC;AACrC,2CAUwB;AACxB,2CAA0F;AAG1F;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,KAAK,UAAU,aAAa,CACjC,IAAY,EACZ,UAA2B,EAC3B,WAA4B,EAC5B,UAAmE,EAAE;IAErE,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,MAA4D,CAAC;IACjE,QAAQ,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAA,yBAAgB,EAAC,IAAI,EAAE,IAAI,EAAE,OAA0B,CAAC,CAAC;YAC1E,CAAC;YAAC,MAAM,CAAC;gBACP,4BAA4B;gBAC5B,MAAM,GAAG,EAAC,KAAK,EAAE,CAAC,EAAmB,CAAC;YACxC,CAAC;YACD,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE;YACpC,MAAM,GAAG,MAAM,IAAA,4BAAmB,EAAC,IAAI,EAAE,IAAI,EAAE,OAA4B,CAAC,CAAC;YAC7E,MAAM;QACR,KAAK,+BAAmB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,OAA4B,CAAC;YAC1C,4EAA4E;YAC5E,MAAM,GAAG,MAAM,IAAA,2BAAkB,EAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,IAAI,CAAC,QAAQ,IAAK,MAA2B,CAAC,QAAQ,EAAE,CAAC;gBAC3D,MAAM,eAAe,GAAI,MAA2B,CAAC,QAAQ,CAAC;gBAC9D,IAAI,eAAe,EAAE,CAAC;oBACpB,OAAO,eAAe,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;YACD,MAAM;QACR,CAAC;QACD;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;IACN,CAAC;IACD,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;IAMI;AACJ,SAAS,4BAA4B,CACnC,OAAgD;IAEhD,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC;QAC3C,CAAC,CAAC;YACE,GAAG,OAAO;YACV,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACxD;QACH,CAAC,CAAC,OAAO,CAAC;AACd,CAAC"}

package/build/lib/constants.d.ts

@@ -1,13 +1,14 @@
-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;
+import type { ImageSettings } from './types';
+export declare const IMAGE_STRATEGY = "-image";
+export declare const IMAGE_ELEMENT_PREFIX = "appium-image-element-";
+export declare const IMAGE_EL_TAP_STRATEGY_W3C = "w3cActions";
+export declare const IMAGE_EL_TAP_STRATEGY_MJSONWP = "touchActions";
+export declare const IMAGE_TAP_STRATEGIES: readonly ["touchActions", "w3cActions"];
+export declare const DEFAULT_TEMPLATE_IMAGE_SCALE = 1;
+export declare const MATCH_FEATURES_MODE = "matchFeatures";
+export declare const GET_SIMILARITY_MODE = "getSimilarity";
+export declare const MATCH_TEMPLATE_MODE = "matchTemplate";
+export declare const DEFAULT_MATCH_THRESHOLD = 0.4;
+export declare const DEFAULT_FIX_IMAGE_TEMPLATE_SCALE = 1;
+export declare const DEFAULT_SETTINGS: ImageSettings;
 //# sourceMappingURL=constants.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAEA,6BAA8B,QAAQ,CAAC;AAEvC,mCAAoC,uBAAuB,CAAC;AAC5D,wCAAyC,YAAY,CAAC;AACtD,4CAA6C,cAAc,CAAC;AAC5D,4CAA+F;AAC/F,2CAA4C,CAAG,CAAC;AAEhD,kCAAmC,eAAe,CAAC;AACnD,kCAAmC,eAAe,CAAC;AACnD,kCAAmC,eAAe,CAAC;AAEnD,sCAAuC,GAAG,CAAC;AAE3C,+CAAgD,CAAC,CAAC;AAElD,mCAmDG"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAE3C,eAAO,MAAM,cAAc,WAAW,CAAC;AAEvC,eAAO,MAAM,oBAAoB,0BAA0B,CAAC;AAC5D,eAAO,MAAM,yBAAyB,eAAe,CAAC;AACtD,eAAO,MAAM,6BAA6B,iBAAiB,CAAC;AAC5D,eAAO,MAAM,oBAAoB,yCAAsE,CAAC;AACxG,eAAO,MAAM,4BAA4B,IAAM,CAAC;AAEhD,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AACnD,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AACnD,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C,eAAO,MAAM,gCAAgC,IAAI,CAAC;AAElD,eAAO,MAAM,gBAAgB,EAWvB,aAAa,CAAC"}

package/build/lib/constants.js

@@ -14,46 +14,15 @@ 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

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":";;;AAAA,4CAAoC;AAEvB,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"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;AAAA,4CAAoC;AAGvB,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,CAAU,CAAC;AAC3F,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,mBAAmB,EAAE,+BAAuB;IAC5C,gBAAgB,EAAE,EAAE;IACpB,0BAA0B,EAAE,IAAI;IAChC,oBAAoB,EAAE,KAAK;IAC3B,qBAAqB,EAAE,KAAK;IAC5B,yBAAyB,EAAE,oCAA4B;IACvD,6BAA6B,EAAE,IAAI;IACnC,8BAA8B,EAAE,KAAK;IACrC,uBAAuB,EAAE,iCAAyB;IAClD,qBAAqB,EAAE,KAAK;CAC7B,CAAkB,CAAC"}

package/build/lib/finder.d.ts

@@ -1,152 +1,53 @@
-export default class ImageElementFinder {
-    /**
-     * @param {number} max
-     */
+import { ImageElement } from './image-element';
+import type { ExternalDriver, Element, Size } from '@appium/types';
+import type { FindByImageOptions, Screenshot, ScreenshotScale, ImageTemplateSettings } from './types';
+export declare class ImageElementFinder {
+    private _imgElCache;
     constructor(max?: number);
-    /** @type {LRUCache<string,ImageElement>} */
-    _imgElCache: LRUCache<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
-     * 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 template with defaultImageTemplateScale setting.
-     * @property {import('@appium/types').Rect?} [containerRect=null] - 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 {Buffer} template - image used as a template to be
-     * matched in the screenshot
-     * @param {ExternalDriver} driver
-     * @param {FindByImageOptions} opts - additional options
+     * @param template - image used as a template to be matched in the screenshot
+     * @param driver
+     * @param opts - additional options
      *
-     * @returns {Promise<Element|Element[]|ImageElement>} - WebDriver element with a special id prefix
+     * @returns WebDriver element with a special id prefix
      */
-    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
-         */
-        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 template with defaultImageTemplateScale setting.
-         */
-        ignoreDefaultImageTemplateScale?: boolean | undefined;
-        /**
-         * - The bounding
-         * rectangle to limit the search in
-         */
-        containerRect?: import("@appium/types").Rect | null | undefined;
-    }): Promise<Element | Element[] | ImageElement>;
+    findByImage(template: Buffer, driver: ExternalDriver, { shouldCheckStaleness, multiple, ignoreDefaultImageTemplateScale, containerRect, }?: FindByImageOptions): Promise<Element | Element[] | ImageElement>;
     /**
      * Ensure that the image template sent in for a find is of a suitable size
      *
-     * @param {Buffer} template - template image
-     * @param {import('@appium/types').Size} maxSize - size of the bounding rectangle
+     * @param template - template image
+     * @param maxSize - size of the bounding rectangle
      *
-     * @returns {Promise<Buffer>} image, potentially resized
+     * @returns image, potentially resized
      */
-    ensureTemplateSize(template: Buffer, maxSize: import("@appium/types").Size): Promise<Buffer>;
+    ensureTemplateSize(template: Buffer, maxSize: 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 {ExternalDriver} driver
-     * @param {import('@appium/types').Size} screenSize - The original size of the screen
+     * @param driver
+     * @param screenSize - The original size of the screen
      *
-     * @returns {Promise<Screenshot & {scale?: ScreenshotScale}>} PNG screenshot and ScreenshotScale
+     * @returns PNG screenshot and ScreenshotScale
      */
-    getScreenshotForImageFind(driver: ExternalDriver, screenSize: import("@appium/types").Size): Promise<Screenshot & {
+    getScreenshotForImageFind(driver: ExternalDriver, screenSize: Size): Promise<Screenshot & {
         scale?: ScreenshotScale;
     }>;
-    /**
-     * @typedef ImageTemplateSettings
-     * @property {boolean} [fixImageTemplateScale=false] - fixImageTemplateScale in device-settings
-     * @property {number} [defaultImageTemplateScale=DEFAULT_TEMPLATE_IMAGE_SCALE] - defaultImageTemplateScale in device-settings
-     * @property {boolean} [ignoreDefaultImageTemplateScale=false] - Ignore defaultImageTemplateScale if it has true.
-     * 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=DEFAULT_FIX_IMAGE_TEMPLATE_SCALE] - Scale ratio for width
-     * @property {number} [yScale=DEFAULT_FIX_IMAGE_TEMPLATE_SCALE] - Scale ratio for height
-  
-     */
     /**
      * Get a image that will be used for template matching.
      * Returns scaled image if scale ratio is provided.
      *
-     * @param {Buffer} template - image used as a template to be
-     * matched in the screenshot
-     * @param {ImageTemplateSettings} opts - Image template scale related options
+     * @param template - image used as a template to be matched in the screenshot
+     * @param opts - Image template scale related options
      *
-     * @returns {Promise<Buffer>} scaled template screenshot
+     * @returns scaled template screenshot
      */
-    fixImageTemplateScale(template: Buffer, opts: {
-        /**
-         * - fixImageTemplateScale in device-settings
-         */
-        fixImageTemplateScale?: boolean | undefined;
-        /**
-         * - defaultImageTemplateScale in device-settings
-         */
-        defaultImageTemplateScale?: number | undefined;
-        /**
-         * - Ignore defaultImageTemplateScale if it has true.
-         * 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 | undefined;
-        /**
-         * - Scale ratio for width
-         */
-        xScale?: number | undefined;
-        /**
-         * - Scale ratio for height
-         */
-        yScale?: number | undefined;
-    }): Promise<Buffer>;
+    fixImageTemplateScale(template: Buffer, opts?: ImageTemplateSettings): Promise<Buffer>;
 }
-export type ExternalDriver = import("@appium/types").ExternalDriver;
-export type Element = import("@appium/types").Element;
-export type Screenshot = {
-    /**
-     * - screenshot image as PNG
-     */
-    screenshot: Buffer;
-};
-export type ScreenshotScale = {
-    /**
-     * - Scale ratio for width
-     */
-    xScale: number;
-    /**
-     * - Scale ratio for height
-     */
-    yScale: number;
-};
-import { LRUCache } from 'lru-cache';
-import { ImageElement } 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":"AAmCA;IAIE;;OAEG;IACH,kBAFW,MAAM,EAQhB;IAZD,4CAA4C;IAC5C,aADW,QAAQ,CAAC,MAAM,EAAC,YAAY,CAAC,CAC5B;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;;;;;;;;;;;;;;;;;;;;;;QAGZ,OAAO,CAAC,OAAO,GAAC,OAAO,EAAE,GAAC,YAAY,CAAC,CA+InD;IAED;;;;;;;OAOG;IACH,6BALW,MAAM,WACN,OAAO,eAAe,EAAE,IAAI,GAE1B,OAAO,CAAC,MAAM,CAAC,CA6B3B;IAED;;;;;;;;OAQG;IACH,kCALW,cAAc,cACd,OAAO,eAAe,EAAE,IAAI,GAE1B,OAAO,CAAC,UAAU,GAAG;QAAC,KAAK,CAAC,EAAE,eAAe,CAAA;KAAC,CAAC,CA+H3D;IAED;;;;;;;;;;OAUG;IACH;;;;;;;;;OASG;IACH,gCANW,MAAM;;;;;;;;;;;;;;;;;;;;;;;QAIJ,OAAO,CAAC,MAAM,CAAC,CAqE3B;CACF;6BAGY,OAAO,eAAe,EAAE,cAAc;sBACtC,OAAO,eAAe,EAAE,OAAO;;;;;gBAK9B,MAAM;;;;;;YAKN,MAAM;;;;YACN,MAAM;;yBAlgBG,WAAW;6BAEP,iBAAiB"}
+{"version":3,"file":"finder.d.ts","sourceRoot":"","sources":["../../lib/finder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAU7C,OAAO,KAAK,EAAC,cAAc,EAAE,OAAO,EAAQ,IAAI,EAAC,MAAM,eAAe,CAAC;AACvE,OAAO,KAAK,EAEV,kBAAkB,EAClB,UAAU,EACV,eAAe,EACf,qBAAqB,EAEtB,MAAM,SAAS,CAAC;AA2BjB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,WAAW,CAAiC;gBAExC,GAAG,GAAE,MAAwB;IAQzC,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAKlD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI1D,kBAAkB,IAAI,IAAI;IAI1B;;;;;;;;;OASG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,cAAc,EACtB,EACE,oBAA4B,EAC5B,QAAgB,EAChB,+BAAuC,EACvC,aAAoB,GACrB,GAAE,kBAAuB,GACzB,OAAO,CAAC,OAAO,GAAG,OAAO,EAAE,GAAG,YAAY,CAAC;IA8I9C;;;;;;;OAOG;IACG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IA8B1E;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,IAAI,GACf,OAAO,CAAC,UAAU,GAAG;QAAC,KAAK,CAAC,EAAE,eAAe,CAAA;KAAC,CAAC;IA+HlD;;;;;;;;OAQG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;CAsE7F"}