(#500) Add new query kind ColorQuery + test

Author: s1hofmann

lib/query.class.spec.ts

@@ -1,10 +1,13 @@
 import {
+  ColorQuery,
+  isColorQuery,
   isTextQuery,
   isWindowQuery,
   TextQuery,
   WindowQuery,
 } from "./query.class";
 import { Image, isImage } from "./image.class";
+import { RGBA } from "./rgba.class";
 
 const dummyImage = new Image(0, 0, Buffer.of(0), 3, "foo", 0, 0);
 
@@ -53,6 +56,40 @@ describe("query types", () => {
     }
   );
 
+  it.each<[ColorQuery, boolean]>([
+    [
+      {
+        id: "dummy",
+        type: "color",
+        by: {
+          color: new RGBA(0, 0, 0, 0),
+        },
+      },
+      true,
+    ],
+    [
+      {
+        id: "dummy",
+        type: "foo",
+        by: {
+          line: "dummy-query",
+        },
+      } as unknown as ColorQuery,
+      false,
+    ],
+  ])(
+    "should correctly identify text queries",
+    (query: ColorQuery, expected: boolean) => {
+      // GIVEN
+
+      // WHEN
+      const result = isColorQuery(query);
+
+      // THEN
+      expect(result).toBe(expected);
+    }
+  );
+
   it.each<[WindowQuery, boolean]>([
     [
       {

lib/query.class.ts

@@ -1,3 +1,5 @@
+import { RGBA } from "./rgba.class";
+
 type Query =
   | {
       id: string;
@@ -19,6 +21,13 @@ type Query =
       by: {
         title: string | RegExp;
       };
+    }
+  | {
+      id: string;
+      type: "color";
+      by: {
+        color: RGBA;
+      };
     };
 
 export type TextQuery = Extract<Query, { type: "text" }>;
@@ -41,6 +50,22 @@ export type LineQuery = Extract<TextQuery, { by: { line: string } }>;
  */
 export type WindowQuery = Extract<Query, { type: "window" }>;
 
+/**
+ * A color query is a query that searches for a certain RGBA color on screen.
+ * It will be processed by an {@link ColorFinderInterface} instance.
+ */
+export type ColorQuery = Extract<Query, { type: "color" }>;
+
+/**
+ * Type guard for {@link ColorQuery}
+ * @param possibleQuery A possible color query
+ */
+export const isColorQuery = (
+  possibleQuery: any
+): possibleQuery is ColorQuery => {
+  return possibleQuery?.type === "color" && possibleQuery?.by?.color != null;
+};
+
 /**
  * Type guard for {@link WordQuery}
  * @param possibleQuery A possible word query