(#40) Adapter implementation and tests for highlightScreenRegion

Author: s1hofmann

lib/adapter/vision.adapter.class.spec.ts

@@ -37,6 +37,23 @@ describe("VisionAdapter class", () => {
     expect(screenMock.grabScreenRegion).toBeCalledWith(screenRegion);
   });
 
+  it("should delegate calls to highlightScreenRegion", async () => {
+    // GIVEN
+    const finderMock = new TemplateMatchingFinder();
+    const screenMock = new ScreenAction();
+    const SUT = new VisionAdapter(finderMock, screenMock);
+    const screenRegion = new Region(0, 0, 100, 100);
+    const opacity = 0.25;
+    const duration = 1;
+
+    // WHEN
+    await SUT.highlightScreenRegion(screenRegion, duration, opacity);
+
+    // THEN
+    expect(screenMock.highlightScreenRegion).toBeCalledTimes(1);
+    expect(screenMock.highlightScreenRegion).toBeCalledWith(screenRegion, duration, opacity);
+  });
+
   it("should delegate calls to screenWidth", async () => {
     // GIVEN
     const finderMock = new TemplateMatchingFinder();

lib/adapter/vision.adapter.class.ts

@@ -49,6 +49,17 @@ export class VisionAdapter {
     return this.screen.grabScreenRegion(region);
   }
 
+  /**
+   * {@link highlightScreenRegion} highlights a screen {@link Region} for a given duration by overlaying it with an opaque window
+   *
+   * @param region The {@link Region} to highlight
+   * @param duration The highlight duration
+   * @param opacity Overlay opacity
+   */
+  public highlightScreenRegion(region: Region, duration: number, opacity: number): Promise<void> {
+    return this.screen.highlightScreenRegion(region, duration, opacity);
+  }
+
   /**
    * {@link findOnScreenRegion} will search for a given pattern inside a {@link Region} of the main screen
    * If multiple possible occurrences are found, the one with the highest probability is returned.