(#451) Adjusted usages of Image class to provide required new data, added type predicate to highlight and grabRegion

Author: s1hofmann

lib/imageResources.function.ts

@@ -38,6 +38,8 @@ export async function fetchFromUrl(url: string | URL): Promise<Image> {
         image.bitmap.data,
         4,
         imageUrl.href,
+        image.bitmap.data.length / (image.bitmap.width * image.bitmap.height),
+        image.bitmap.data.length / image.bitmap.height,
         ColorMode.RGB
       );
     })

lib/provider/io/jimp-image-reader.class.ts

@@ -27,6 +27,9 @@ export default class implements ImageReader {
               jimpImage.bitmap.data,
               jimpImage.hasAlpha() ? 4 : 3,
               parameters,
+              jimpImage.bitmap.data.length /
+                (jimpImage.bitmap.width * jimpImage.bitmap.height),
+              jimpImage.bitmap.data.length / jimpImage.bitmap.height,
               ColorMode.BGR
             )
           );

lib/provider/native/libnut-screen.class.ts

@@ -33,6 +33,8 @@ export default class ScreenAction implements ScreenProviderInterface {
             screenShot.image,
             4,
             "grabScreenResult",
+            screenShot.bitsPerPixel,
+            screenShot.byteWidth,
             ColorMode.BGR,
             pixelScaling
           )
@@ -63,6 +65,8 @@ export default class ScreenAction implements ScreenProviderInterface {
             screenShot.image,
             4,
             "grabScreenRegionResult",
+            4,
+            screenShot.width * 4,
             ColorMode.BGR,
             pixelScaling
           )

lib/screen.class.ts

@@ -74,6 +74,8 @@ export interface ScreenConfig {
   resourceDirectory: string;
 }
 
+export type FindInput = Image;
+
 /**
  * {@link ScreenClass} class provides methods to access screen content of a systems main display
  */
@@ -119,11 +121,11 @@ export class ScreenClass {
 
   /**
    * {@link find} will search for a single occurrence of a template image on a systems main screen
-   * @param template Template {@link Image} instance
+   * @param searchInput Template {@link Image} instance
    * @param params {@link LocationParameters} which are used to fine tune search region and / or match confidence
    */
   public async find(
-    template: Image | Promise<Image>,
+    searchInput: FindInput | Promise<FindInput>,
     params?: OptionalSearchParameters
   ): Promise<Region> {
     const {
@@ -134,7 +136,7 @@ export class ScreenClass {
       searchMultipleScales,
     } = await this.getFindParameters(params);
 
-    const needle = await ScreenClass.getNeedle(template);
+    const needle = await ScreenClass.getNeedle(searchInput);
 
     const matchRequest = new MatchRequest(
       screenImage,
@@ -236,6 +238,13 @@ export class ScreenClass {
     regionToHighlight: Region | Promise<Region>
   ): Promise<Region> {
     const highlightRegion = await regionToHighlight;
+    if (!isRegion(highlightRegion)) {
+      throw Error(
+        `highlight requires an Region, but received ${JSON.stringify(
+          highlightRegion
+        )}`
+      );
+    }
     await this.providerRegistry
       .getScreen()
       .highlightScreenRegion(
@@ -380,9 +389,15 @@ export class ScreenClass {
   public async grabRegion(
     regionToGrab: Region | Promise<Region>
   ): Promise<Image> {
-    return this.providerRegistry
-      .getScreen()
-      .grabScreenRegion(await regionToGrab);
+    const targetRegion = await regionToGrab;
+    if (!isRegion(targetRegion)) {
+      throw Error(
+        `grabRegion requires an Region, but received ${JSON.stringify(
+          targetRegion
+        )}`
+      );
+    }
+    return this.providerRegistry.getScreen().grabScreenRegion(targetRegion);
   }
 
   /**