@aspiresys/visor 1.2.10 → 1.3.0

package/dist/types.d.ts

@@ -1,10 +1,174 @@
-export interface Region {
+/**
+ * Represents a rectangular screen region.
+ *
+ * A Region can be returned by:
+ * - image matching
+ * - OCR text search
+ * - region-based searches
+ *
+ * Provides helper methods for:
+ * - mouse interaction
+ * - OCR operations
+ * - image matching
+ * - geometry calculations
+ * Example:
+ *
+ * const dialog = await visor.find("dialog.png");
+ *
+ * const saveButton = await dialog.find("save.png");
+ *
+ * await saveButton.click();
+ *
+ * const text = await dialog.findText("Submit");
+ */
+export declare class Region {
     x: number;
     y: number;
     width: number;
     height: number;
     confidence: number;
+    private static configWarningShown;
+    constructor(x: number, y: number, width: number, height: number, confidence?: number);
+    private checkConfig;
+    /**
+   * Returns the center point of the region.
+   *
+   * Useful for:
+   * - mouse movement
+   * - coordinate calculations
+   * - custom interactions
+   */
+    center(): {
+        x: number;
+        y: number;
+    };
+    /**
+   * Moves the mouse to the center of the region.
+   *
+   * Mouse coordinates are automatically
+   * adjusted for display scaling.
+   */
+    move(): Promise<void>;
+    /**
+   * Performs a left click on the region.
+   *
+   * Clicks the center of the region by default.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    click(offset?: Offset): Promise<void>;
+    /**
+   * Performs a double left click on the region.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    doubleClick(offset?: Offset): Promise<void>;
+    /**
+   * Performs a right click on the region.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    rightClick(offset?: Offset): Promise<void>;
+    /**
+   * Checks whether the supplied coordinates
+   * are located inside this region.
+   *
+   * Returns:
+   * - true if inside
+   * - false otherwise
+   */
+    contains(x: number, y: number): boolean;
+    /**
+   * Creates a new Region shifted by the
+   * supplied x and y offsets.
+   *
+   * Original region remains unchanged.
+   */
+    offset(x: number, y: number): Region;
+    /**
+   * Checks whether this region overlaps
+   * with another region.
+   *
+   * Returns:
+   * - true if regions intersect
+   * - false otherwise
+   */
+    intersects(region: Region): boolean;
+    /**
+   * Returns the total area of the region
+   * in pixels.
+   */
+    area(): number;
+    /**
+   * Extracts OCR text from this region.
+   *
+   * Returns full OCR output including:
+   * - text
+   * - TSV data
+   * - HOCR data
+   * - block information
+   */
+    readText(): Promise<any>;
+    /**
+   * Searches for text within this region.
+   *
+   * Returns the matching text region
+   * if found, otherwise null.
+   *
+   * Supports selecting a specific match
+   * using the index parameter.
+   */
+    findText(text: string, index?: number): Promise<Region>;
+    /**
+   * Checks whether the supplied text
+   * exists within this region.
+   *
+   * Returns:
+   * - true if found
+   * - false otherwise
+   */
+    existsText(text: string): Promise<boolean>;
+    /**
+   * Searches for an image within this region.
+   *
+   * Matching is performed only inside
+   * the current region, improving speed
+   * and reducing false positives.
+   *
+   * Returns:
+   * - matching Region if found
+   * - null otherwise
+   */
+    find(image: string, confidence?: number): Promise<Region>;
+    /**
+   * Finds all image matches within this region.
+   *
+   * Matching is performed only inside
+   * the current region.
+   *
+   * Returns an array of matching regions.
+   */
+    findAll(image: string, confidence?: number): Promise<Region[]>;
+    /**
+   * Checks whether an image exists
+   * within this region.
+   *
+   * Returns:
+   * - true if found
+   * - false otherwise
+   */
+    exists(image: string, confidence?: number): Promise<boolean>;
 }
+/**
+ * Represents an offset relative to
+ * a region's center point.
+ *
+ * Useful for clicking specific locations
+ * within a matched region.
+ */
 export interface Offset {
     x: number;
     y: number;

package/dist/types.js

@@ -1,2 +1,270 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Region = void 0;
+const nut_js_1 = require("@nut-tree-fork/nut-js");
+const mouse_1 = require("./mouse");
+const ocr_1 = require("./ocr");
+const text_1 = require("./text");
+const matcher_1 = require("./matcher");
+const screen_1 = require("./screen");
+const path_1 = require("./path");
+const config_1 = require("./config");
+const console_1 = require("console");
+const display_1 = require("./display");
+/**
+ * Represents a rectangular screen region.
+ *
+ * A Region can be returned by:
+ * - image matching
+ * - OCR text search
+ * - region-based searches
+ *
+ * Provides helper methods for:
+ * - mouse interaction
+ * - OCR operations
+ * - image matching
+ * - geometry calculations
+ * Example:
+ *
+ * const dialog = await visor.find("dialog.png");
+ *
+ * const saveButton = await dialog.find("save.png");
+ *
+ * await saveButton.click();
+ *
+ * const text = await dialog.findText("Submit");
+ */
+class Region {
+    constructor(x, y, width, height, confidence = 1) {
+        this.x = x;
+        this.y = y;
+        this.width = width;
+        this.height = height;
+        this.confidence = confidence;
+    }
+    checkConfig() {
+        if (Region.configWarningShown) {
+            return;
+        }
+        const missing = [];
+        if (!config_1.visorConfig.imagePath) {
+            missing.push("imagePath");
+        }
+        if (!config_1.visorConfig.outputPath) {
+            missing.push("outputPath");
+        }
+        if (missing.length > 0) {
+            (0, console_1.warn)(`[VISOR] Configuration incomplete.\n` +
+                `Missing: ${missing.join(", ")}\n\n` +
+                `Relative paths may not work correctly.\n` +
+                `Use visor.loadConfig(...) or provide absolute paths directly to functions.`);
+        }
+        if (!config_1.visorConfig.initialized) {
+            config_1.visorConfig.scaleFactor = (0, display_1.getWindowsScaleFactor)();
+            (0, console_1.warn)(`[VISOR] Configuration not loaded.\n` +
+                `Auto-detected scaleFactor=${config_1.visorConfig.scaleFactor}.\n`);
+        }
+        if (missing.length > 0 || !config_1.visorConfig.initialized) {
+            Region.configWarningShown = true;
+        }
+    }
+    /**
+   * Returns the center point of the region.
+   *
+   * Useful for:
+   * - mouse movement
+   * - coordinate calculations
+   * - custom interactions
+   */
+    center() {
+        return {
+            x: this.x + Math.floor(this.width / 2),
+            y: this.y + Math.floor(this.height / 2)
+        };
+    }
+    /**
+   * Moves the mouse to the center of the region.
+   *
+   * Mouse coordinates are automatically
+   * adjusted for display scaling.
+   */
+    async move() {
+        await (0, mouse_1.moveToRegion)(this);
+    }
+    /**
+   * Performs a left click on the region.
+   *
+   * Clicks the center of the region by default.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    async click(offset) {
+        await (0, mouse_1.clickRegion)(this, offset);
+    }
+    /**
+   * Performs a double left click on the region.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    async doubleClick(offset) {
+        await (0, mouse_1.moveToRegion)(this, offset);
+        await nut_js_1.mouse.doubleClick(nut_js_1.Button.LEFT);
+    }
+    /**
+   * Performs a right click on the region.
+   *
+   * Optional offset can be supplied to click
+   * a specific position relative to the center.
+   */
+    async rightClick(offset) {
+        await (0, mouse_1.moveToRegion)(this, offset);
+        await nut_js_1.mouse.click(nut_js_1.Button.RIGHT);
+    }
+    /**
+   * Checks whether the supplied coordinates
+   * are located inside this region.
+   *
+   * Returns:
+   * - true if inside
+   * - false otherwise
+   */
+    contains(x, y) {
+        return (x >= this.x) && (x <= this.x + this.width) && (y >= this.y) && (y <= this.y + this.height);
+    }
+    /**
+   * Creates a new Region shifted by the
+   * supplied x and y offsets.
+   *
+   * Original region remains unchanged.
+   */
+    offset(x, y) {
+        return new Region(this.x + x, this.y + y, this.width, this.height, this.confidence);
+    }
+    /**
+   * Checks whether this region overlaps
+   * with another region.
+   *
+   * Returns:
+   * - true if regions intersect
+   * - false otherwise
+   */
+    intersects(region) {
+        return (this.x <= region.x + region.width) && (this.x + this.width >= region.x) && (this.y <= region.y + region.height) && (this.y + this.height >= region.y);
+    }
+    /**
+   * Returns the total area of the region
+   * in pixels.
+   */
+    area() {
+        return this.width * this.height;
+    }
+    /**
+   * Extracts OCR text from this region.
+   *
+   * Returns full OCR output including:
+   * - text
+   * - TSV data
+   * - HOCR data
+   * - block information
+   */
+    async readText() {
+        this.checkConfig();
+        return await (0, ocr_1.extractTextFromRegion)(this);
+    }
+    /**
+   * Searches for text within this region.
+   *
+   * Returns the matching text region
+   * if found, otherwise null.
+   *
+   * Supports selecting a specific match
+   * using the index parameter.
+   */
+    async findText(text, index = 0) {
+        this.checkConfig();
+        const match = await (0, text_1.findText)(text, index, this);
+        if (match == null) {
+            return null;
+        }
+        return match.offset(this.x, this.y);
+    }
+    /**
+   * Checks whether the supplied text
+   * exists within this region.
+   *
+   * Returns:
+   * - true if found
+   * - false otherwise
+   */
+    async existsText(text) {
+        this.checkConfig();
+        return await (0, text_1.existsText)(text, this);
+    }
+    /**
+   * Searches for an image within this region.
+   *
+   * Matching is performed only inside
+   * the current region, improving speed
+   * and reducing false positives.
+   *
+   * Returns:
+   * - matching Region if found
+   * - null otherwise
+   */
+    async find(image, confidence = 0.8) {
+        this.checkConfig();
+        const screenshot = await (0, screen_1.captureScreen)();
+        const croppedScreenshot = await (0, matcher_1.cropMat)(screenshot, this);
+        const template = await (0, matcher_1.loadTemplate)((0, path_1.resolveImagePath)(image));
+        try {
+            const match = (0, matcher_1.matchInspectorTemplate)(croppedScreenshot, template, confidence, false);
+            if (!match) {
+                return null;
+            }
+            return match.offset(this.x, this.y);
+        }
+        finally {
+            screenshot.delete();
+            croppedScreenshot.delete();
+            template.delete();
+        }
+    }
+    /**
+   * Finds all image matches within this region.
+   *
+   * Matching is performed only inside
+   * the current region.
+   *
+   * Returns an array of matching regions.
+   */
+    async findAll(image, confidence = 0.8) {
+        this.checkConfig();
+        const screenshot = await (0, screen_1.captureScreen)();
+        const croppedScreenshot = await (0, matcher_1.cropMat)(screenshot, this);
+        const template = await (0, matcher_1.loadTemplate)((0, path_1.resolveImagePath)(image));
+        try {
+            const matches = (0, matcher_1.findAllMatches)(croppedScreenshot, template, confidence);
+            return matches.map(match => match.offset(this.x, this.y));
+        }
+        finally {
+            screenshot.delete();
+            croppedScreenshot.delete();
+            template.delete();
+        }
+    }
+    /**
+   * Checks whether an image exists
+   * within this region.
+   *
+   * Returns:
+   * - true if found
+   * - false otherwise
+   */
+    async exists(image, confidence = 0.8) {
+        return await this.find(image, confidence) !== null;
+    }
+}
+exports.Region = Region;
+Region.configWarningShown = false;

package/inspector/index.html

@@ -5,6 +5,9 @@
     <link rel="stylesheet" href="styles.css" />
   </head>
   <body>
+    <div id="imageModal" class="image-modal">
+      <img id="modalImage"/>
+    </div>
     <div class="container">
       <header class="header">
         <h3>VISOR INSPECTOR</h3>
@@ -22,9 +25,13 @@
           <div class="controls-grid">
             <div class="control-group">
               <div class="input-wrapper">
-                <span class="input-hint">Confidence</span>
-                <input id="confidenceInput" type="number" min="0" max="1" step="0.01" value="0.8" />
-                <span class="input-hint">(0.0 - 1.0)</span>
+                <span class="input-hint" title="Range [0, 1]">Confidence</span>
+                  <input type="range" id="confRange" min="0" max="1" value="0.8" step="0.01" 
+                    oninput="document.getElementById('confidenceInput').value = this.value"/>
+                <input id="confidenceInput" type="number" min="0" max="1" step="0.01" value="0.8"
+                    onchange="document.getElementById('confRange').value = this.value"/>
+                <!--<span class="input-hint">Multi Sacle Match:</span><input id="multiScaleCheck" type="checkbox" value="false"/>-->
+                <span class="input-hint">Current Template:</span><span id="currentTemplate" class="template-status">None</span>
               </div>
             </div>
           </div>
@@ -36,22 +43,12 @@
           <canvas id="screenCanvas" class="canvas"></canvas>
         </div>
         <div class="result-panel">
+          <h3 class="section-title"> Template </h3>
+          <img id="templatePreview" class="template-preview" alt="No Template Loaded" src="data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs="/>
           <h3 class="section-title"> Match Result </h3>
           <div id="matchResult"> No Match Tested </div>
-        </div>
+         </div>
       </div>
-      <section class="template-section">
-        <h3 class="section-title">Template Management</h3>
-        <div class="template-grid">
-          <div class="template-info">
-            <p>
-              <strong>Current Template: </strong>
-              <span id="currentTemplate" class="template-status">None</span>
-            </p>
-          </div>
-          <img id="templatePreview" class="template-preview" />
-        </div>
-      </section>
     </div>
     <script src="./src/renderer.js"></script>
   </body>

package/inspector/main.js

@@ -135,12 +135,17 @@ ipcMain.handle("test-match",
 		const capturePath = path.join(__dirname, "assets", "capture.png");
 		const screen = await visorMatcher.loadScreen(capturePath);
 		const template = await visorMatcher.loadScreen(data.templatePath);
-		const result = visorMatcher
-			.matchTemplate(
-				screen,
-				template,
-				data.confidence
-			);
+		const result = visorMatcher.findAllInspectorMatches(
+			screen,
+			template,
+			data.confidence
+		);
+`		const result = visorMatcher.matchInspectorTemplate(
+			screen,
+			template,
+			data.confidence,
+			data.isMultiMatch
+		);`
 		console.log("match Result:", result);
 		screen.delete();
 		template.delete();