(#455) New interfaces to search for text or windows

Author: s1hofmann

lib/provider/text-finder.interface.ts

@@ -0,0 +1,34 @@
+import { MatchRequest } from "../match-request.class";
+import { MatchResult } from "../match-result.class";
+import { TextQuery } from "../query.class";
+
+/**
+ * A TextFinder should provide an abstraction layer to perform text searches
+ *
+ * @interface TextFinderInterface
+ */
+export interface TextFinderInterface {
+  /**
+   * findMatch should provide an abstraction to search for an image needle
+   * in another image haystack
+   *
+   * @param {MatchRequest} matchRequest A {@link MatchRequest} containing needed matching data
+   * @returns {Promise<MatchResult>} A {@link MatchResult} holding the match probability and location
+   * @memberof TextFinderInterface
+   */
+  findMatch<PROVIDER_DATA_TYPE>(
+    matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
+  ): Promise<MatchResult>;
+
+  /**
+   * findMatches should provide an abstraction to search for an image needle
+   * in another image haystack
+   *
+   * @param {MatchRequest} matchRequest A {@link MatchRequest} containing needed matching data
+   * @returns {Promise<MatchResult[]>} A list of {@link MatchResult}s holding the match probability and location
+   * @memberof TextFinderInterface
+   */
+  findMatches<PROVIDER_DATA_TYPE>(
+    matchRequest: MatchRequest<TextQuery, PROVIDER_DATA_TYPE>
+  ): Promise<MatchResult[]>;
+}

lib/provider/window-finder.interface.ts

@@ -0,0 +1,26 @@
+import { WindowQuery } from "../query.class";
+
+/**
+ * A WindowFinder should provide an abstraction layer to perform window searches
+ *
+ * @interface WindowFinderInterface
+ */
+export interface WindowFinderInterface {
+  /**
+   * findMatch should provide an abstraction to search for a window on screen
+   *
+   * @param {WindowQuery} query A {@link WindowQuery} containing needed data
+   * @returns {Promise<number>} A single window handle
+   * @memberof WindowFinderInterface
+   */
+  findMatch(query: WindowQuery): Promise<number>;
+
+  /**
+   * findMatches should provide an abstraction to search for a window on screen
+   *
+   * @param {WindowQuery} query A {@link WindowQuery} containing needed data
+   * @returns {Promise<number[]>} A list of window handles
+   * @memberof WindowFinderInterface
+   */
+  findMatches(query: WindowQuery): Promise<number[]>;
+}