@aspiresys/visor 1.3.4 → 1.4.0

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Region = exports.visor = void 0;
+exports.initializeOCR = exports.Region = exports.visor = void 0;
 const screen_1 = require("./screen");
 const matcher_1 = require("./matcher");
 const mouse_1 = require("./mouse");
@@ -14,6 +14,8 @@ const path_1 = require("./path");
 const display_1 = require("./display");
 const logger_1 = require("./logger");
 const console_1 = require("console");
+const templateMetadata_1 = require("./templateMetadata");
+const version_1 = require("./version");
 class Visor {
     constructor() {
         this.mouse = nut_js_1.mouse;
@@ -28,138 +30,154 @@ class Visor {
         }
         const missing = [];
         if (!config_1.visorConfig.imagePath) {
-            missing.push("imagePath");
+            missing.push('imagePath');
         }
         if (!config_1.visorConfig.outputPath) {
-            missing.push("outputPath");
+            missing.push('outputPath');
         }
         if (missing.length > 0) {
             (0, console_1.warn)(`[VISOR] Configuration incomplete.\n` +
-                `Missing: ${missing.join(", ")}\n\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`);
+            (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) {
             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
-   * });
-   */
+     * Returns the currently installed
+     * Visor package version.
+     *
+     * Useful for:
+     * - debugging
+     * - support tickets
+     * - framework validation
+     *
+     * @returns Package version string.
+     *
+     * @example
+     * console.log(visor.version());
+     */
+    version() {
+        return (0, version_1.getVersion)();
+    }
+    /**
+     * 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) {
         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
-   * });
-   */
+     * 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) {
         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
-   * });
-   */
+     * 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) {
         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
-   * });
-   */
+     * 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) {
         await (0, mouse_1.moveToRegion)(region, offset);
         await this.mouse.click(this.Button.RIGHT);
@@ -198,14 +216,14 @@ class Visor {
         this.checkConfig();
         if (!image) {
             await this.mouse.click(this.Button.LEFT);
-            (0, logger_1.log)("[MOUSE] Left click completed");
+            (0, logger_1.log)('[MOUSE] Left click completed');
             return;
         }
         const region = await this.find(image, confidence);
         if (!region) {
             throw new Error(`Image not found: ${image}`);
         }
-        (0, logger_1.log)("[CV] Match found:", region);
+        (0, logger_1.log)('[CV] Match found:', region);
         await (0, mouse_1.clickRegion)(region, offset);
     }
     /**
@@ -242,7 +260,7 @@ class Visor {
             await (0, mouse_1.moveToRegion)(region, offset);
         }
         await this.mouse.click(this.Button.RIGHT);
-        (0, logger_1.log)("[MOUSE] Right click completed");
+        (0, logger_1.log)('[MOUSE] Right click completed');
     }
     /**
      * Performs a double left mouse click.
@@ -279,7 +297,7 @@ class Visor {
             await (0, mouse_1.moveToRegion)(region, offset);
         }
         await this.mouse.doubleClick(this.Button.LEFT);
-        (0, logger_1.log)("[MOUSE] Double click completed");
+        (0, logger_1.log)('[MOUSE] Double click completed');
     }
     /**
      * Finds the best matching image on screen
@@ -316,8 +334,9 @@ class Visor {
         const screen = await (0, screen_1.captureScreen)();
         const template = await (0, matcher_1.loadTemplate)((0, path_1.resolveImagePath)(image));
         const scaleFactor = config_1.visorConfig.scaleFactor;
+        const metadata = (0, templateMetadata_1.loadTemplateMetadata)((0, path_1.resolveImagePath)(image));
         try {
-            const result = (0, matcher_1.matchTemplate)(screen, template, confidence);
+            const result = (0, matcher_1.matchTemplate)(screen, template, confidence, metadata);
             if (result) {
                 (0, logger_1.log)(`[FIND] Actual coords: (${Math.floor(result.x * scaleFactor)}, ${Math.floor(result.y * scaleFactor)})`);
             }
@@ -411,14 +430,14 @@ class Visor {
     async previewMatches(image, confidence = 0.8) {
         this.checkConfig();
         const matches = await this.findAll(image, confidence);
-        (0, logger_1.log)("\n=== MATCH PREVIEW ===\n");
+        (0, logger_1.log)('\n=== MATCH PREVIEW ===\n');
         matches.forEach((m, i) => {
-            (0, logger_1.log)(`#${i + 1}
-X:${m.x}
-Y:${m.y}
-W:${m.width}
-H:${m.height}
-CONF:${m.confidence.toFixed(3)}
+            (0, logger_1.log)(`#${i + 1}
+X:${m.x}
+Y:${m.y}
+W:${m.width}
+H:${m.height}
+CONF:${m.confidence.toFixed(3)}
 `);
         });
         return matches;
@@ -707,10 +726,10 @@ CONF:${m.confidence.toFixed(3)}
      */
     async captureScreenshot(path) {
         this.checkConfig();
-        path = config_1.visorConfig.outputPath + "/" + path;
+        path = config_1.visorConfig.outputPath + '/' + path;
         (0, logger_1.log)(`[VISOR] Saving screenshot: ${path}`);
         await (0, screen_1.saveScreenshot)(path);
-        (0, logger_1.log)("[VISOR] Screenshot saved");
+        (0, logger_1.log)('[VISOR] Screenshot saved');
     }
     /**
      * Opens a desktop application,
@@ -771,13 +790,13 @@ CONF:${m.confidence.toFixed(3)}
         const src = await this.find(source, confidence);
         const dst = await this.find(target, confidence);
         if (!src || !dst) {
-            throw new Error("Source or target not found");
+            throw new Error('Source or target not found');
         }
         await (0, mouse_1.moveToRegion)(src);
         await this.mouse.pressButton(this.Button.LEFT);
         await (0, mouse_1.moveToRegion)(dst);
         await this.mouse.releaseButton(this.Button.LEFT);
-        (0, logger_1.log)("[MOUSE] Drag and drop completed");
+        (0, logger_1.log)('[MOUSE] Drag and drop completed');
     }
     /**
      * Moves the mouse cursor to the
@@ -805,7 +824,7 @@ CONF:${m.confidence.toFixed(3)}
             throw new Error(`Image not found: ${image}`);
         }
         await (0, mouse_1.moveToRegion)(region, offset);
-        (0, logger_1.log)("[MOUSE] Hover completed");
+        (0, logger_1.log)('[MOUSE] Hover completed');
     }
     /**
      * Scrolls the mouse wheel downward.
@@ -1024,6 +1043,19 @@ CONF:${m.confidence.toFixed(3)}
     getImagePath() {
         return config_1.visorConfig.imagePath;
     }
+    showConfig() {
+        console.log(`
+      === VISOR CONFIG ===
+
+      Scale Factor : ${config_1.visorConfig.scaleFactor}
+      Image Path   : ${config_1.visorConfig.imagePath}
+      Output Path  : ${config_1.visorConfig.outputPath}
+      Debug        : ${config_1.visorConfig.debug}
+      Initialized  : ${config_1.visorConfig.initialized}
+
+      ====================
+      `);
+    }
     /**
      * Sets the default output path
      * used for visual automation APIs.
@@ -1106,7 +1138,7 @@ CONF:${m.confidence.toFixed(3)}
             this.setDebug(config.debug);
         }
         config_1.visorConfig.initialized = true;
-        (0, logger_1.log)("[VISOR] Config loaded");
+        (0, logger_1.log)('[VISOR] Config loaded');
     }
     /**
      * Finds the first matching image
@@ -1302,7 +1334,7 @@ CONF:${m.confidence.toFixed(3)}
             }
             await this.sleep(interval);
         }
-        throw new Error("Timeout waiting for images");
+        throw new Error('Timeout waiting for images');
     }
     /**
      * Terminates shared OCR worker.
@@ -1321,24 +1353,24 @@ CONF:${m.confidence.toFixed(3)}
         await (0, ocr_1.terminateOCR)();
     }
     /**
-   * Executes a command and returns output.
-   *
-   * @example
-   * const output =
-   *   await visor.exec("ipconfig");
-   */
+     * Executes a command and returns output.
+     *
+     * @example
+     * const output =
+     *   await visor.exec("ipconfig");
+     */
     async exec(command) {
         return await (0, app_1.execCommand)(command);
     }
     /**
-   * Starts a command without waiting
-   * for completion.
-   *
-   * @example
-   * await visor.execDetached(
-   *   "notepad"
-   * );
-   */
+     * Starts a command without waiting
+     * for completion.
+     *
+     * @example
+     * await visor.execDetached(
+     *   "notepad"
+     * );
+     */
     async execDetached(command) {
         await (0, app_1.execDetached)(command);
     }
@@ -1356,42 +1388,44 @@ CONF:${m.confidence.toFixed(3)}
         await this.press(nut_js_1.Key.LeftControl, nut_js_1.Key.V);
     }
     /**
-   * Generates a alert box.
-   *
-   * @param message Text to display.
-   * @param title Title of the alert.
-   *
-   * @example
-   * await visor.alert("Execution Completed");
-   */
-    async alert(message, title = "Visor") {
+     * Generates a alert box.
+     *
+     * @param message Text to display.
+     * @param title Title of the alert.
+     *
+     * @example
+     * await visor.alert("Execution Completed");
+     */
+    async alert(message, title = 'Visor') {
         await (0, dialog_1.alert)(message, title);
     }
     /**
-   * Generates a conform box with Yes/No.
-   *
-   * @param message Text to display.
-   * @param title Title of the window.
-   *
-   * @example
-   * await visor.conform("Continue Execution?");
-   */
-    async confirm(message, title = "Visor") {
+     * Generates a conform box with Yes/No.
+     *
+     * @param message Text to display.
+     * @param title Title of the window.
+     *
+     * @example
+     * await visor.conform("Continue Execution?");
+     */
+    async confirm(message, title = 'Visor') {
         return await (0, dialog_1.confirm)(message, title);
     }
     /**
-    * Generates a input box.
-    *
-    * @param message Text to display.
-    * @param title Title of the window.
-    *
-    * @example
-    * await visor.input("Enter Email");
-    */
-    async input(message, title = "Visor") {
+     * Generates a input box.
+     *
+     * @param message Text to display.
+     * @param title Title of the window.
+     *
+     * @example
+     * await visor.input("Enter Email");
+     */
+    async input(message, title = 'Visor') {
         return await (0, dialog_1.prompt)(message, title);
     }
 }
 exports.visor = new Visor();
 var types_1 = require("./types");
 Object.defineProperty(exports, "Region", { enumerable: true, get: function () { return types_1.Region; } });
+var ocr_2 = require("./ocr");
+Object.defineProperty(exports, "initializeOCR", { enumerable: true, get: function () { return ocr_2.initializeOCR; } });

package/dist/inspector/index.js

@@ -1,11 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const path_1 = __importDefault(require("path"));
-const app_1 = require("../app");
+'use strict';
+var __importDefault =
+    (this && this.__importDefault) ||
+    function (mod) {
+        return mod && mod.__esModule ? mod : { default: mod };
+    };
+Object.defineProperty(exports, '__esModule', { value: true });
+const express_1 = __importDefault(require('express'));
+const path_1 = __importDefault(require('path'));
+const app_1 = require('../app');
 const app = (0, express_1.default)();
 const PORT = 3000;
 app.use(express_1.default.static(path_1.default.join(__dirname)));

package/dist/matcher.d.ts

@@ -1,7 +1,7 @@
-import { Region } from "./types";
+import { Region } from './types';
 export declare function loadTemplate(path: string): Promise<any>;
 export declare function loadScreen(path: string): Promise<any>;
-export declare function matchTemplate(screen: any, template: any, confidence?: number): Region | null;
+export declare function matchTemplate(screen: any, template: any, confidence?: number, metadata?: any): Region | null;
 export declare function findAllMatches(screen: any, template: any, confidence?: number): Region[];
 export declare function findAllInspectorMatches(screen: any, template: any, confidence?: number): Region[];
 export declare function matchInspectorTemplate(screen: any, template: any, confidence?: number, multiScale?: boolean): Region | null;