@aspiresys/visor 1.2.9 → 1.2.10

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Key, Button, Point } from "@nut-tree-fork/nut-js";
+import { Region } from "./types";
 export declare class Visor {
     mouse: import("@nut-tree-fork/nut-js").MouseClass;
     keyboard: import("@nut-tree-fork/nut-js").KeyboardClass;
@@ -6,6 +7,123 @@ export declare class Visor {
     Button: typeof Button;
     private configWarningShown;
     private checkConfig;
+    /**
+   * Moves the mouse cursor to the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.moveToRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    moveToRegion(region: Region, offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+   * Performs a left mouse click at the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.clickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    clickRegion(region: Region, offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+   * Performs a double left mouse click
+   * at the center of a specific
+   * screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.doubleClickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    doubleClickRegion(region: Region, offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
+    /**
+   * Performs a right mouse click at the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.rightClickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    rightClickRegion(region: Region, offset?: {
+        x: number;
+        y: number;
+    }): Promise<void>;
     /**
      * Finds an image on screen using OpenCV
      * and performs a left mouse click
@@ -126,7 +244,7 @@ export declare class Visor {
      * const region =
      *   await visor.find("save.png");
      */
-    find(image: string, confidence?: number): Promise<import("./types").Region>;
+    find(image: string, confidence?: number): Promise<Region>;
     /**
      * Checks whether an image exists
      * on the current screen.
@@ -169,7 +287,7 @@ export declare class Visor {
      * const matches =
      *   await visor.findAll("icon.png");
      */
-    findAll(image: string, confidence?: number): Promise<import("./types").Region[]>;
+    findAll(image: string, confidence?: number): Promise<Region[]>;
     /**
      * Finds all image matches and prints
      * a formatted match preview including
@@ -192,7 +310,7 @@ export declare class Visor {
      * @example
      * await visor.previewMatches("button.png");
      */
-    previewMatches(image: string, confidence?: number): Promise<import("./types").Region[]>;
+    previewMatches(image: string, confidence?: number): Promise<Region[]>;
     /**
      * Waits until an image appears
      * on the screen.
@@ -342,7 +460,7 @@ export declare class Visor {
         y: number;
         width: number;
         height: number;
-    }): Promise<import("./types").Region>;
+    }): Promise<Region>;
     /**
      * Checks whether specific text exists
      * on screen using OCR.
@@ -783,7 +901,7 @@ export declare class Visor {
      */
     findAny(images: string[], confidence?: number): Promise<{
         image: string;
-        region: import("./types").Region;
+        region: Region;
     }>;
     /**
      * Checks whether any image from

package/dist/index.js

@@ -48,6 +48,134 @@ class Visor {
             this.configWarningShown = true;
         }
     }
+    /**
+   * Moves the mouse cursor to the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.moveToRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    async moveToRegion(region, offset = {
+        x: 0,
+        y: 0
+    }) {
+        await (0, mouse_1.moveToRegion)(region, offset);
+    }
+    /**
+   * Performs a left mouse click at the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.clickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    async clickRegion(region, offset = {
+        x: 0,
+        y: 0
+    }) {
+        await (0, mouse_1.moveToRegion)(region, offset);
+        await this.mouse.click(this.Button.LEFT);
+    }
+    /**
+   * Performs a double left mouse click
+   * at the center of a specific
+   * screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.doubleClickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    async doubleClickRegion(region, offset = {
+        x: 0,
+        y: 0
+    }) {
+        await (0, mouse_1.moveToRegion)(region, offset);
+        await this.mouse.doubleClick(this.Button.LEFT);
+    }
+    /**
+   * Performs a right mouse click at the
+   * center of a specific screen region.
+   *
+   * Region coordinates typically come from:
+   * - visor.find()
+   * - visor.findAll()
+   * - OCR text matching
+   * - Visor Inspector
+   *
+   * Display scaling is automatically
+   * applied using the configured
+   * scale factor.
+   *
+   * @param region Screen region coordinates.
+   * @param offset Offset coords.
+   *
+   * @example
+   * await visor.rightClickRegion({
+   *   x: 100,
+   *   y: 200,
+   *   width: 150,
+   *   height: 50
+   * });
+   */
+    async rightClickRegion(region, offset = {
+        x: 0,
+        y: 0
+    }) {
+        await (0, mouse_1.moveToRegion)(region, offset);
+        await this.mouse.click(this.Button.RIGHT);
+    }
     /**
      * Finds an image on screen using OpenCV
      * and performs a left mouse click

package/inspector/index.html

@@ -32,7 +32,7 @@
       </section>
       <div class="capture-layout">
         <div class="capture-panel">
-          <h3 class="section-title"> Current Capture </h3>
+          <h3 class="section-title"> Current Capture (X:<span id="mousex"></span>, Y:<span id="mousey"></span>)</h3>
           <canvas id="screenCanvas" class="canvas"></canvas>
         </div>
         <div class="result-panel">

package/inspector/src/renderer.js

@@ -58,6 +58,8 @@ canvas.addEventListener("mousedown",
 canvas.addEventListener("mousemove",
 	(e) => {
 		if (!selecting) {
+			document.getElementById("mousex").innerHTML = Math.round(e.offsetX * imageScaleX);
+			document.getElementById("mousey").innerHTML = Math.round(e.offsetY * imageScaleY);
 			return;
 		}
 		displayEndX = e.offsetX;
@@ -95,6 +97,7 @@ canvas.addEventListener("mouseup",
 	}
 );
 
+
 saveBtn.addEventListener("click",
 	async () => {
 		if (

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspiresys/visor",
-  "version": "1.2.9",
+  "version": "1.2.10",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {