@aspiresys/visor 1.1.3 → 1.1.5

package/dist/config.d.ts

@@ -2,4 +2,5 @@ export declare const visorConfig: {
     scaleFactor: number;
     debug: boolean;
     imagePath: string;
+    outputPath: string;
 };

package/dist/config.js

@@ -4,5 +4,6 @@ exports.visorConfig = void 0;
 exports.visorConfig = {
     scaleFactor: 1,
     debug: true,
-    imagePath: ""
+    imagePath: "",
+    outputPath: ""
 };

package/dist/index.d.ts

@@ -215,7 +215,10 @@ export declare class Visor {
    * @example
    * await visor.wait("loading-done.png");
    */
-    wait(image: string, confidence?: number, timeout?: number): Promise<boolean>;
+    wait(image: string, { confidence, timeout }?: {
+        confidence?: number;
+        timeout?: number;
+    }): Promise<boolean>;
     /**
    * Waits until an image disappears
    * from the screen.
@@ -241,7 +244,10 @@ export declare class Visor {
    * @example
    * await visor.waitToVanish("spinner.png");
    */
-    waitToVanish(image: string, confidence?: number, timeout?: number): Promise<boolean>;
+    waitToVanish(image: string, { confidence, timeout }?: {
+        confidence?: number;
+        timeout?: number;
+    }): Promise<boolean>;
     /**
    * Waits until specific text appears
    * on screen using OCR.
@@ -671,6 +677,27 @@ export declare class Visor {
    */
     getImagePath(): string;
     /**
+ * Sets the default output path
+ * used for visual automation APIs.
+ *
+ * @param path Output directory path.
+ *
+ * @example
+ * visor.setOutputPath("./images");
+ */
+    setOutputPath(path: string): void;
+    /**
+ * Returns the current default
+ * Output path.
+ *
+ * @returns Output path.
+ *
+ * @example
+ * const path =
+ *   visor.getOutputPath();
+ */
+    getOutputPath(): string;
+    /**
    * Closes a desktop application
    * using Windows taskkill.
    *
@@ -707,6 +734,7 @@ export declare class Visor {
     loadConfig(config: {
         scaleFactor?: number;
         imagePath?: string;
+        ssOutputPath?: string;
         debug?: boolean;
     }): void;
     /**
@@ -855,7 +883,10 @@ export declare class Visor {
    *   "home-dark.png"
    * ]);
    */
-    waitAny(images: string[], confidence?: number, timeout?: number): Promise<boolean>;
+    waitAny(images: string[], { confidence, timeout }?: {
+        confidence?: number;
+        timeout?: number;
+    }): Promise<boolean>;
     /**
    * Terminates shared OCR worker.
    *

package/dist/index.js

@@ -295,9 +295,9 @@ CONF:${m.confidence.toFixed(3)}
    * @example
    * await visor.wait("loading-done.png");
    */
-    async wait(image, confidence = 0.8, timeout = 5000) {
+    async wait(image, { confidence = 0.8, timeout = 5000 } = {}) {
         const interval = 1000;
-        const attempts = timeout / interval;
+        const attempts = Math.ceil(timeout / interval);
         for (let i = 0; i < attempts; i++) {
             if (await this.exists(image, confidence)) {
                 return true;
@@ -331,7 +331,7 @@ CONF:${m.confidence.toFixed(3)}
    * @example
    * await visor.waitToVanish("spinner.png");
    */
-    async waitToVanish(image, confidence = 0.8, timeout = 5000) {
+    async waitToVanish(image, { confidence = 0.8, timeout = 5000 } = {}) {
         const start = Date.now();
         while (Date.now() - start < timeout) {
             if (!(await this.exists(image, confidence))) {
@@ -532,6 +532,7 @@ CONF:${m.confidence.toFixed(3)}
    * );
    */
     async captureScreenshot(path) {
+        path = config_1.visorConfig.outputPath + "/" + path;
         console.log(`[VISOR] Saving screenshot: ${path}`);
         await (0, screen_1.saveScreenshot)(path);
         console.log("[VISOR] Screenshot saved");
@@ -837,6 +838,31 @@ CONF:${m.confidence.toFixed(3)}
         return config_1.visorConfig.imagePath;
     }
     /**
+ * Sets the default output path
+ * used for visual automation APIs.
+ *
+ * @param path Output directory path.
+ *
+ * @example
+ * visor.setOutputPath("./images");
+ */
+    setOutputPath(path) {
+        config_1.visorConfig.outputPath = path;
+    }
+    /**
+ * Returns the current default
+ * Output path.
+ *
+ * @returns Output path.
+ *
+ * @example
+ * const path =
+ *   visor.getOutputPath();
+ */
+    getOutputPath() {
+        return config_1.visorConfig.outputPath;
+    }
+    /**
    * Closes a desktop application
    * using Windows taskkill.
    *
@@ -879,6 +905,9 @@ CONF:${m.confidence.toFixed(3)}
         if (config.imagePath) {
             this.setImagePath(config.imagePath);
         }
+        if (config.ssOutputPath) {
+            this.setOutputPath(config.ssOutputPath);
+        }
         if (config.debug !== undefined) {
             this.setDebug(config.debug);
         }
@@ -1059,9 +1088,9 @@ CONF:${m.confidence.toFixed(3)}
    *   "home-dark.png"
    * ]);
    */
-    async waitAny(images, confidence = 0.8, timeout = 5000) {
+    async waitAny(images, { confidence = 0.8, timeout = 5000 } = {}) {
         const interval = 1000;
-        const attempts = timeout / interval;
+        const attempts = Math.ceil(timeout / interval);
         for (let i = 0; i < attempts; i++) {
             console.log(`[WAITANY] Attempt ${i + 1}`);
             for (const image of images) {

package/package.json

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