@aspiresys/visor 1.1.9 → 1.1.10

package/dist/app.d.ts

@@ -43,3 +43,5 @@ export declare function openApp(target: string): Promise<void>;
  * await closeApp("ms-teams.exe");
  */
 export declare function closeApp(processName: string): Promise<void>;
+export declare function execCommand(command: string): Promise<string>;
+export declare function execDetached(command: string): Promise<void>;

package/dist/app.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.openApp = openApp;
 exports.closeApp = closeApp;
+exports.execCommand = execCommand;
+exports.execDetached = execDetached;
 const child_process_1 = require("child_process");
 const logger_1 = require("./logger");
 function execAsync(command) {
@@ -98,3 +100,23 @@ async function closeApp(processName) {
         });
     });
 }
+async function execCommand(command) {
+    (0, logger_1.log)(`[CMD] Executing: ${command}`);
+    return new Promise((resolve, reject) => {
+        (0, child_process_1.exec)(command, (error, stdout, stderr) => {
+            if (error) {
+                reject(new Error(stderr || error.message));
+                return;
+            }
+            resolve(stdout.trim());
+        });
+    });
+}
+async function execDetached(command) {
+    (0, logger_1.log)(`[CMD] Starting detached: ${command}`);
+    (0, child_process_1.spawn)(command, [], {
+        detached: true,
+        shell: true,
+        stdio: "ignore",
+    }).unref();
+}

package/dist/config.d.ts

@@ -1,4 +1,5 @@
 export declare const visorConfig: {
+    initialized: boolean;
     scaleFactor: number;
     debug: boolean;
     imagePath: string;

package/dist/config.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.visorConfig = void 0;
 exports.visorConfig = {
+    initialized: false,
     scaleFactor: 1,
     debug: true,
     imagePath: "",

package/dist/index.d.ts

@@ -4,6 +4,8 @@ export declare class Visor {
     keyboard: import("@nut-tree-fork/nut-js").KeyboardClass;
     Key: typeof Key;
     Button: typeof Button;
+    private configWarningShown;
+    private checkConfig;
     /**
      * Finds an image on screen using OpenCV
      * and performs a left mouse click
@@ -903,5 +905,23 @@ export declare class Visor {
      * await visor.terminateOCR();
      */
     terminateOCR(): Promise<void>;
+    /**
+   * Executes a command and returns output.
+   *
+   * @example
+   * const output =
+   *   await visor.exec("ipconfig");
+   */
+    exec(command: string): Promise<string>;
+    /**
+   * Starts a command without waiting
+   * for completion.
+   *
+   * @example
+   * await visor.execDetached(
+   *   "notepad"
+   * );
+   */
+    execDetached(command: string): Promise<void>;
 }
 export declare const visor: Visor;

package/dist/index.js

@@ -12,12 +12,40 @@ const nut_js_1 = require("@nut-tree-fork/nut-js");
 const path_1 = require("./path");
 const display_1 = require("./display");
 const logger_1 = require("./logger");
+const console_1 = require("console");
 class Visor {
     constructor() {
         this.mouse = nut_js_1.mouse;
         this.keyboard = nut_js_1.keyboard;
         this.Key = nut_js_1.Key;
         this.Button = nut_js_1.Button;
+        this.configWarningShown = false;
+    }
+    checkConfig() {
+        if (this.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) {
+            this.configWarningShown = true;
+        }
     }
     /**
      * Finds an image on screen using OpenCV
@@ -50,6 +78,7 @@ class Visor {
      * await visor.click("./images/save.png", 0.9);
      */
     async click(image, confidence = 0.8) {
+        this.checkConfig();
         if (!image) {
             await this.mouse.click(this.Button.LEFT);
             (0, logger_1.log)("[MOUSE] Left click completed");
@@ -87,6 +116,7 @@ class Visor {
      * await visor.rightClick();
      */
     async rightClick(image, confidence = 0.8) {
+        this.checkConfig();
         if (image) {
             const region = await this.find(image, confidence);
             if (!region) {
@@ -123,6 +153,7 @@ class Visor {
      * await visor.doubleClick();
      */
     async doubleClick(image, confidence = 0.8) {
+        this.checkConfig();
         if (image) {
             const region = await this.find(image, confidence);
             if (!region) {
@@ -163,6 +194,7 @@ class Visor {
      *   await visor.find("save.png");
      */
     async find(image, confidence = 0.8) {
+        this.checkConfig();
         const start = Date.now();
         const screen = await (0, screen_1.captureScreen)();
         const template = await (0, matcher_1.loadTemplate)((0, path_1.resolveImagePath)(image));
@@ -196,6 +228,7 @@ class Visor {
      *   await visor.exists("login.png");
      */
     async exists(image, confidence = 0.8) {
+        this.checkConfig();
         return (await this.find(image, confidence)) !== null;
     }
     /**
@@ -221,6 +254,7 @@ class Visor {
      *   await visor.findAll("icon.png");
      */
     async findAll(image, confidence = 0.8) {
+        this.checkConfig();
         const screen = await (0, screen_1.captureScreen)();
         const template = await (0, matcher_1.loadTemplate)((0, path_1.resolveImagePath)(image));
         try {
@@ -254,6 +288,7 @@ class Visor {
      * await visor.previewMatches("button.png");
      */
     async previewMatches(image, confidence = 0.8) {
+        this.checkConfig();
         const matches = await this.findAll(image, confidence);
         (0, logger_1.log)("\n=== MATCH PREVIEW ===\n");
         matches.forEach((m, i) => {
@@ -301,6 +336,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.wait("loading-done.png");
      */
     async wait(image, { confidence = 0.8, timeout = 5000 } = {}) {
+        this.checkConfig();
         const interval = 300;
         const attempts = Math.ceil(timeout / interval);
         for (let i = 0; i < attempts; i++) {
@@ -337,6 +373,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.waitToVanish("spinner.png");
      */
     async waitToVanish(image, { confidence = 0.8, timeout = 5000 } = {}) {
+        this.checkConfig();
         const start = Date.now();
         while (Date.now() - start < timeout) {
             if (!(await this.exists(image, confidence))) {
@@ -372,6 +409,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.waitText("Success");
      */
     async waitText(text, timeout = 5000) {
+        this.checkConfig();
         const start = Date.now();
         while (Date.now() - start < timeout) {
             if (await this.existsText(text)) {
@@ -405,6 +443,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.waitTextToVanish("Loading");
      */
     async waitTextToVanish(text, timeout = 5000) {
+        this.checkConfig();
         const start = Date.now();
         while (Date.now() - start < timeout) {
             if (!(await this.existsText(text))) {
@@ -428,6 +467,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.clickText("Login");
      */
     async clickText(text, index = 0) {
+        this.checkConfig();
         const region = await (0, text_1.findText)(text, index);
         if (!region) {
             throw new Error(`Text not found: ${text}`);
@@ -449,6 +489,7 @@ CONF:${m.confidence.toFixed(3)}
      *   await visor.findText("Submit");
      */
     async findText(text, index = 0, region) {
+        this.checkConfig();
         return await (0, text_1.findText)(text, index, region);
     }
     /**
@@ -465,6 +506,7 @@ CONF:${m.confidence.toFixed(3)}
      *   await visor.existsText("Teams");
      */
     async existsText(text, region) {
+        this.checkConfig();
         return await (0, text_1.existsText)(text, region);
     }
     /**
@@ -485,6 +527,7 @@ CONF:${m.confidence.toFixed(3)}
      *   });
      */
     async readRegion(region) {
+        this.checkConfig();
         return await (0, ocr_1.extractTextFromRegion)(region);
     }
     /**
@@ -519,6 +562,7 @@ CONF:${m.confidence.toFixed(3)}
      * log(result.text);
      */
     async readScreen() {
+        this.checkConfig();
         return await (0, ocr_1.extractTextFromRegion)();
     }
     /**
@@ -537,6 +581,7 @@ CONF:${m.confidence.toFixed(3)}
      * );
      */
     async captureScreenshot(path) {
+        this.checkConfig();
         path = config_1.visorConfig.outputPath + "/" + path;
         (0, logger_1.log)(`[VISOR] Saving screenshot: ${path}`);
         await (0, screen_1.saveScreenshot)(path);
@@ -597,6 +642,7 @@ CONF:${m.confidence.toFixed(3)}
      * );
      */
     async dragDrop(source, target, confidence = 0.8) {
+        this.checkConfig();
         const src = await this.find(source, confidence);
         const dst = await this.find(target, confidence);
         if (!src || !dst) {
@@ -628,6 +674,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.hover("menu.png");
      */
     async hover(image, confidence = 0.8) {
+        this.checkConfig();
         const region = await this.find(image, confidence);
         if (!region) {
             throw new Error(`Image not found: ${image}`);
@@ -650,6 +697,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.scrollDown(1000);
      */
     async scrollDown(amount = 500) {
+        this.checkConfig();
         await this.mouse.scrollDown(amount);
     }
     /**
@@ -667,6 +715,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.scrollUp(1000);
      */
     async scrollUp(amount = 500) {
+        this.checkConfig();
         await this.mouse.scrollUp(amount);
     }
     /**
@@ -744,6 +793,7 @@ CONF:${m.confidence.toFixed(3)}
      * await visor.moveMouse(500, 300);
      */
     async moveMouse(x, y) {
+        this.checkConfig();
         await this.mouse.move((0, nut_js_1.straightTo)(new nut_js_1.Point(x, y)));
     }
     /**
@@ -757,6 +807,7 @@ CONF:${m.confidence.toFixed(3)}
      *   await visor.getMousePosition();
      */
     async getMousePosition() {
+        this.checkConfig();
         return await this.mouse.getPosition();
     }
     /**
@@ -923,6 +974,7 @@ CONF:${m.confidence.toFixed(3)}
         if (config.debug !== undefined) {
             this.setDebug(config.debug);
         }
+        config_1.visorConfig.initialized = true;
         (0, logger_1.log)("[VISOR] Config loaded");
     }
     /**
@@ -954,6 +1006,7 @@ CONF:${m.confidence.toFixed(3)}
      *   ]);
      */
     async findAny(images, confidence = 0.8) {
+        this.checkConfig();
         const screen = await (0, screen_1.captureScreen)();
         try {
             for (const image of images) {
@@ -1005,6 +1058,7 @@ CONF:${m.confidence.toFixed(3)}
      *   ]);
      */
     async existsAny(images, confidence = 0.8) {
+        this.checkConfig();
         return (await this.findAny(images, confidence)) !== null;
     }
     /**
@@ -1047,6 +1101,7 @@ CONF:${m.confidence.toFixed(3)}
      * ]);
      */
     async clickAny(images, confidence = 0.8) {
+        this.checkConfig();
         const result = await this.findAny(images, confidence);
         if (!result) {
             throw new Error(`None of the images were found`);
@@ -1101,6 +1156,7 @@ CONF:${m.confidence.toFixed(3)}
      * ]);
      */
     async waitAny(images, { confidence = 0.8, timeout = 5000 } = {}) {
+        this.checkConfig();
         const interval = 300;
         const attempts = Math.ceil(timeout / interval);
         for (let i = 0; i < attempts; i++) {
@@ -1133,6 +1189,28 @@ CONF:${m.confidence.toFixed(3)}
     async terminateOCR() {
         await (0, ocr_1.terminateOCR)();
     }
+    /**
+   * 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"
+   * );
+   */
+    async execDetached(command) {
+        await (0, app_1.execDetached)(command);
+    }
 }
 exports.Visor = Visor;
 exports.visor = new Visor();

package/package.json

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