Feature/320/find accept promise (#322)

* (#320) Make find, and the functions re-using it, accept Promise<Image>

* (#320) Update toShow matcher accordingly

* (#320) Update tests

Author: s1hofmann

lib/expect/jest.matcher.function.ts

@@ -1,22 +1,23 @@
-import { Point } from "../point.class";
-import { Region } from "../region.class";
-import { toBeAt } from "./matchers/toBeAt.function";
-import { toBeIn } from "./matchers/toBeIn.function";
-import { toShow } from "./matchers/toShow.function";
-import {Image} from "../image.class";
+import {Point} from "../point.class";
+import {Region} from "../region.class";
+import {toBeAt} from "./matchers/toBeAt.function";
+import {toBeIn} from "./matchers/toBeIn.function";
+import {toShow} from "./matchers/toShow.function";
+import {FirstArgumentType} from "../typings";
+import {ScreenClass} from "../screen.class";
 
 declare global {
-  namespace jest {
-    interface Matchers<R> {
-      toBeAt: (position: Point) => {};
-      toBeIn: (region: Region) => {};
-      toShow: (needle: string | Image, confidence?: number) => {};
+    namespace jest {
+        interface Matchers<R> {
+            toBeAt: (position: Point) => {};
+            toBeIn: (region: Region) => {};
+            toShow: (needle: FirstArgumentType<typeof ScreenClass.prototype.find>, confidence?: number) => {};
+        }
     }
-  }
 }
 
 export const jestMatchers = {
-  toBeAt,
-  toBeIn,
-  toShow,
+    toBeAt,
+    toBeIn,
+    toShow,
 };

lib/expect/matchers/toShow.function.ts

@@ -1,10 +1,10 @@
 import {LocationParameters} from "../../locationparameters.class";
 import {ScreenClass} from "../../screen.class";
-import {Image} from "../../image.class";
+import {FirstArgumentType} from "../../typings";
 
 export const toShow = async (
     received: ScreenClass,
-    needle: string | Image,
+    needle: FirstArgumentType<typeof ScreenClass.prototype.find>,
     confidence?: number,
 ) => {
     let locationParams;

lib/screen.class.spec.ts

@@ -39,14 +39,15 @@ describe("Screen.", () => {
             const matchResult = new MatchResult(0.99, searchRegion);
             const SUT = new ScreenClass(providerRegistryMock);
             const needle = new Image(100, 100, Buffer.from([]), 3, "needle_image");
+            const needlePromise = Promise.resolve(needle);
 
             const findMatchMock = jest.fn(() => Promise.resolve(matchResult));
             providerRegistryMock.getImageFinder = jest.fn(() => mockPartial<ImageFinderInterface>({
                 findMatch: findMatchMock
             }));
 
             // WHEN
-            const resultRegion = SUT.find(needle);
+            const resultRegion = SUT.find(needlePromise);
 
             // THEN
             await expect(resultRegion).resolves.toEqual(matchResult.location);

lib/screen.class.ts

@@ -9,6 +9,7 @@ import {timeout} from "./util/timeout.function";
 import {Image} from "./image.class";
 import {ProviderRegistry} from "./provider/provider-registry.class";
 import {loadImageResource} from "./imageResources.function";
+import {FirstArgumentType} from "./typings";
 
 export type FindHookCallback = (target: MatchResult) => Promise<void>;
 
@@ -80,7 +81,7 @@ export class ScreenClass {
      * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
      */
     public async find(
-        templateImage: string | Image,
+        templateImage: string | Image | Promise<Image>,
         params?: LocationParameters,
     ): Promise<Region> {
         const minMatch = (params && params.confidence) || this.config.confidence;
@@ -92,7 +93,7 @@ export class ScreenClass {
         if (typeof templateImage === "string") {
             needle = await loadImageResource(this.providerRegistry, this.config.resourceDirectory, templateImage);
         } else {
-            needle = templateImage;
+            needle = await templateImage;
         }
 
         const screenImage = await this.providerRegistry.getScreen().grabScreenRegion(searchRegion);
@@ -171,7 +172,7 @@ export class ScreenClass {
      * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
      */
     public async waitFor(
-        templateImage: string | Image,
+        templateImage: FirstArgumentType<typeof ScreenClass.prototype.find>,
         timeoutMs: number = 5000,
         params?: LocationParameters,
     ): Promise<Region> {

lib/typings.ts

@@ -0,0 +1 @@
+export type FirstArgumentType<T> = T extends (first: infer ArgType, ...args: any[]) => any ? ArgType : never;