testdriverai 7.2.54 → 7.2.56

package/docs/v7/screenshot.mdx

@@ -12,21 +12,13 @@ Capture a screenshot of the current screen and automatically save it to a local
 ## Syntax
 
 ```javascript
-const filePath = await testdriver.screenshot(scale, silent, mouse)
+const filePath = await testdriver.screenshot(filename)
 ```
 
 ## Parameters
 
-<ParamField path="scale" type="number" default="1">
-  Scale factor for the screenshot (1 = original size, 0.5 = half size, 2 = double size)
-</ParamField>
-
-<ParamField path="silent" type="boolean" default="false">
-  Whether to suppress the log message showing where the screenshot was saved
-</ParamField>
-
-<ParamField path="mouse" type="boolean" default="false">
-  Whether to include the mouse cursor in the screenshot
+<ParamField path="filename" type="string" optional>
+  Custom filename for the screenshot (without .png extension). If not provided, a timestamp-based filename is generated automatically.
 </ParamField>
 
 ## Returns
@@ -42,7 +34,7 @@ Screenshots are automatically saved to `.testdriver/screenshots/<test-file-name>
   screenshots/
     login.test/
       screenshot-1737633600000.png
-      screenshot-1737633605000.png
+      login-page.png
     checkout.test/
       screenshot-1737633700000.png
 ```
@@ -56,23 +48,20 @@ Screenshots are automatically saved to `.testdriver/screenshots/<test-file-name>
 ### Basic Screenshot
 
 ```javascript
-// Capture a screenshot with default settings
+// Capture a screenshot with auto-generated filename
 const screenshotPath = await testdriver.screenshot();
 console.log('Screenshot saved to:', screenshotPath);
 ```
 
-### Screenshot with Mouse Cursor
+### Custom Filename
 
 ```javascript
-// Capture a screenshot showing the mouse cursor position
-const screenshotPath = await testdriver.screenshot(1, false, true);
-```
-
-### Silent Screenshot
+// Save with a descriptive filename
+await testdriver.screenshot("login-page");
+// Saves to: .testdriver/screenshots/<test>/login-page.png
 
-```javascript
-// Capture without logging the save location
-await testdriver.screenshot(1, true);
+await testdriver.screenshot("after-click");
+// Saves to: .testdriver/screenshots/<test>/after-click.png
 ```
 
 ### Debugging with Screenshots

package/examples/hover-text-with-description.test.mjs

@@ -14,9 +14,7 @@ import { TestDriver } from "../lib/vitest/hooks.mjs";
 async function performLogin(client, username = "standard_user") {
   await client.focusApplication("Google Chrome");
   const password = await client.extract("the password");
-  const usernameField = await client.find(
-    "username input",
-  );
+  const usernameField = await client.find("username input");
   await usernameField.click();
   await client.type(username);
   await client.pressKeys(["tab"]);
@@ -27,8 +25,13 @@ async function performLogin(client, username = "standard_user") {
 
 describe("Hover Text With Description Test", () => {
   it("should add TestDriver Hat to cart and verify", async (context) => {
-    const testdriver = TestDriver(context, { ip: context.ip || process.env.TD_IP, headless: true });
-    await testdriver.provision.chrome({ url: 'http://testdriver-sandbox.vercel.app/login' });
+    const testdriver = TestDriver(context, {
+      ip: context.ip || process.env.TD_IP,
+      headless: true,
+    });
+    await testdriver.provision.chrome({
+      url: "http://testdriver-sandbox.vercel.app/login",
+    });
 
     //
     // Perform login first
@@ -47,7 +50,7 @@ describe("Hover Text With Description Test", () => {
     await cartButton.click();
 
     // Assert the TestDriver Hat is in the cart
-    const result = await testdriver.assert("TestDriver Hat is in the cart");
+    const result = await testdriver.assert("There is an item in the cart");
     expect(result).toBeTruthy();
   });
 });

package/interfaces/cli/commands/init.js

@@ -37,16 +37,22 @@ class InitCommand extends BaseCommand {
     if (fs.existsSync(envPath)) {
       const envContent = fs.readFileSync(envPath, "utf8");
       if (envContent.includes("TD_API_KEY=")) {
-        console.log(chalk.gray("\n  API key already configured in .env, skipping...\n"));
+        console.log(
+          chalk.gray("\n  API key already configured in .env, skipping...\n"),
+        );
         return;
       }
     }
 
     console.log(chalk.cyan("  Setting up your TestDriver API key...\n"));
-    console.log(chalk.gray("  Get your API key from: https://console.testdriver.ai/team"));
+    console.log(
+      chalk.gray("  Get your API key from: https://console.testdriver.ai/team"),
+    );
 
     // Ask if user wants to open the browser
-    const shouldOpen = await this.askYesNo("  Open API keys page in browser? (Y/n): ");
+    const shouldOpen = await this.askYesNo(
+      "  Open API keys page in browser? (Y/n): ",
+    );
     if (shouldOpen) {
       try {
         // Dynamic import for ES module
@@ -54,12 +60,16 @@ class InitCommand extends BaseCommand {
         await open("https://console.testdriver.ai/team");
         console.log(chalk.gray("  Opening browser...\n"));
       } catch (error) {
-        console.log(chalk.yellow("  ⚠️  Could not open browser automatically\n"));
+        console.log(
+          chalk.yellow("  ⚠️  Could not open browser automatically\n"),
+        );
       }
     }
 
     // Prompt for API key with hidden input
-    const apiKey = await this.promptHidden("  Enter your API key (input will be hidden): ");
+    const apiKey = await this.promptHidden(
+      "  Enter your API key (input will be hidden): ",
+    );
 
     if (apiKey && apiKey.trim()) {
       // Save to .env
@@ -70,7 +80,11 @@ class InitCommand extends BaseCommand {
       fs.writeFileSync(envPath, envContent + `TD_API_KEY=${apiKey.trim()}\n`);
       console.log(chalk.green("\n  ✓ API key saved to .env\n"));
     } else {
-      console.log(chalk.yellow("\n  ⚠️  No API key entered. You can add it later to .env:\n"));
+      console.log(
+        chalk.yellow(
+          "\n  ⚠️  No API key entered. You can add it later to .env:\n",
+        ),
+      );
       console.log(chalk.gray("     TD_API_KEY=your_api_key\n"));
     }
   }
@@ -81,7 +95,7 @@ class InitCommand extends BaseCommand {
   async promptHidden(question) {
     return new Promise((resolve) => {
       process.stdout.write(question);
-      
+
       const stdin = process.stdin;
       const wasRaw = stdin.isRaw;
       stdin.setRawMode(true);
@@ -131,7 +145,9 @@ class InitCommand extends BaseCommand {
       rl.question(question, (answer) => {
         rl.close();
         const normalized = answer.toLowerCase().trim();
-        resolve(normalized === "" || normalized === "y" || normalized === "yes");
+        resolve(
+          normalized === "" || normalized === "y" || normalized === "yes",
+        );
       });
     });
   }
@@ -153,17 +169,20 @@ class InitCommand extends BaseCommand {
         scripts: {
           test: "vitest run",
           "test:watch": "vitest",
-          "test:ui": "vitest --ui"
+          "test:ui": "vitest --ui",
         },
         keywords: ["testdriver", "testing", "e2e"],
         author: "",
         license: "ISC",
         engines: {
-          node: ">=20.19.0"
-        }
+          node: ">=20.19.0",
+        },
       };
 
-      fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + "\n");
+      fs.writeFileSync(
+        packageJsonPath,
+        JSON.stringify(packageJson, null, 2) + "\n",
+      );
       console.log(chalk.green(`  Created package.json`));
     } else {
       console.log(chalk.gray("  package.json already exists, skipping..."));
@@ -249,7 +268,7 @@ test('should login and add item to cart', async (context) => {
   await cartButton.click();
 
   // Verify item in cart
-  const result = await testdriver.assert('TestDriver Hat is in the cart');
+  const result = await testdriver.assert('There is an item in the cart');
   expect(result).toBeTruthy();
   
 });
@@ -283,7 +302,6 @@ export default defineConfig({
       fs.writeFileSync(configFile, configContent);
       console.log(chalk.green(`  Created config file: ${configFile}`));
     }
-
   }
 
   /**
@@ -387,10 +405,13 @@ jobs:
     console.log(chalk.cyan("\n  Installing dependencies...\n"));
 
     try {
-      execSync("npm install -D vitest testdriverai@beta && npm install dotenv", {
-        cwd: process.cwd(),
-        stdio: "inherit"
-      });
+      execSync(
+        "npm install -D vitest testdriverai@beta && npm install dotenv",
+        {
+          cwd: process.cwd(),
+          stdio: "inherit",
+        },
+      );
       console.log(chalk.green("\n  Dependencies installed successfully!"));
     } catch (error) {
       console.log(
@@ -410,10 +431,16 @@ jobs:
     console.log(chalk.cyan("Next steps:\n"));
     console.log("  1. Run your tests:");
     console.log(chalk.gray("     npx vitest run\n"));
-    console.log("  2. For CI/CD, add TD_API_KEY to your GitHub repository secrets");
-    console.log(chalk.gray("     Settings → Secrets → Actions → New repository secret\n"));
     console.log(
-      chalk.cyan("Learn more at https://docs.testdriver.ai/v7/getting-started/\n"),
+      "  2. For CI/CD, add TD_API_KEY to your GitHub repository secrets",
+    );
+    console.log(
+      chalk.gray("     Settings → Secrets → Actions → New repository secret\n"),
+    );
+    console.log(
+      chalk.cyan(
+        "Learn more at https://docs.testdriver.ai/v7/getting-started/\n",
+      ),
     );
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "7.2.54",
+  "version": "7.2.56",
   "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
   "main": "sdk.js",
   "types": "sdk.d.ts",

package/sdk.d.ts

@@ -1137,25 +1137,19 @@ export default class TestDriverSDK {
 
   /**
    * Capture a screenshot of the current screen and save it to .testdriver/screenshots
-   * @param scale - Scale factor for the screenshot (default: 1 = original size)
-   * @param silent - Whether to suppress logging (default: false)
-   * @param mouse - Whether to include mouse cursor (default: false)
+   * @param filename - Custom filename (without .png extension)
    * @returns The file path where the screenshot was saved
    *
    * @example
-   * // Capture a screenshot (saves to .testdriver/screenshots)
-   * const screenshotPath = await client.screenshot();
-   * console.log('Screenshot saved to:', screenshotPath);
+   * // Capture a screenshot with auto-generated filename
+   * const screenshotPath = await testdriver.screenshot();
    *
    * @example
-   * // Capture with mouse cursor visible
-   * const screenshotPath = await client.screenshot(1, false, true);
+   * // Capture with custom filename
+   * const screenshotPath = await testdriver.screenshot("login-page");
+   * // Saves to: .testdriver/screenshots/<test>/login-page.png
    */
-  screenshot(
-    scale?: number,
-    silent?: boolean,
-    mouse?: boolean,
-  ): Promise<string>;
+  screenshot(filename?: string): Promise<string>;
 
   /**
    * Wait for specified time

package/sdk.js

@@ -2772,24 +2772,27 @@ with zipfile.ZipFile(io.BytesIO(zip_data)) as zf:
   // ====================================
 
   /**
-   * Capture a screenshot of the current screen and save it to .testdriverai/screenshots
-   * @param {number} [scale=1] - Scale factor for the screenshot (1 = original size)
-   * @param {boolean} [silent=false] - Whether to suppress logging
-   * @param {boolean} [mouse=false] - Whether to include mouse cursor
+   * Capture a screenshot of the current screen and save it to .testdriver/screenshots
+   * @param {string} [filename] - Custom filename (without .png extension)
    * @returns {Promise<string>} The file path where the screenshot was saved
    *
    * @example
-   * // Capture a screenshot (saves to .testdriverai/screenshots)
-   * const screenshotPath = await client.screenshot();
-   * console.log('Screenshot saved to:', screenshotPath);
+   * // Capture a screenshot with auto-generated filename
+   * const screenshotPath = await testdriver.screenshot();
    *
    * @example
-   * // Capture with mouse cursor visible
-   * const screenshotPath = await client.screenshot(1, false, true);
+   * // Capture with custom filename
+   * const screenshotPath = await testdriver.screenshot("login-page");
+   * // Saves to: .testdriver/screenshots/<test>/login-page.png
    */
-  async screenshot(scale = 1, silent = false, mouse = false) {
+  async screenshot(filename) {
     this._ensureConnected();
-    const base64Data = await this.system.captureScreenBase64(scale, silent, mouse);
+    
+    const finalFilename = filename 
+      ? (filename.endsWith('.png') ? filename : `${filename}.png`)
+      : `screenshot-${Date.now()}.png`;
+    
+    const base64Data = await this.system.captureScreenBase64(1, false, false);
     
     // Save to .testdriver/screenshots/<test-file-name> directory
     let screenshotsDir = path.join(process.cwd(), ".testdriver", "screenshots");
@@ -2801,8 +2804,7 @@ with zipfile.ZipFile(io.BytesIO(zip_data)) as zf:
       fs.mkdirSync(screenshotsDir, { recursive: true });
     }
     
-    const filename = `screenshot-${Date.now()}.png`;
-    const filePath = path.join(screenshotsDir, filename);
+    const filePath = path.join(screenshotsDir, finalFilename);
     
     // Remove data:image/png;base64, prefix if present
     const cleanBase64 = base64Data.replace(/^data:image\/\w+;base64,/, "");
@@ -2810,9 +2812,7 @@ with zipfile.ZipFile(io.BytesIO(zip_data)) as zf:
     
     fs.writeFileSync(filePath, buffer);
     
-    if (!silent) {
-      this.emitter.emit("log:info", `📸 Screenshot saved to: ${filePath}`);
-    }
+    this.emitter.emit("log:info", `📸 Screenshot saved to: ${filePath}`);
     
     return filePath;
   }