testdriverai 7.2.53 → 7.2.55

package/agent/lib/system.js

@@ -13,12 +13,18 @@ const createSystem = (emitter, sandbox, config) => {
     });
 
     if (!base64) {
-      console.error("Failed to take screenshot");
-    } else {
-      let image = Buffer.from(base64, "base64");
-      fs.writeFileSync(options.filename, image);
-      return { filename: options.filename };
+      throw new Error("Failed to take screenshot: sandbox returned empty data");
     }
+    
+    let image = Buffer.from(base64, "base64");
+    
+    // Verify we got actual image data (PNG header starts with these bytes)
+    if (image.length < 100) {
+      throw new Error(`Failed to take screenshot: received only ${image.length} bytes`);
+    }
+    
+    fs.writeFileSync(options.filename, image);
+    return { filename: options.filename };
   };
 
   let primaryDisplay = null;
@@ -57,6 +63,11 @@ const createSystem = (emitter, sandbox, config) => {
 
       // Load the screenshot image with Jimp
       let image = await Jimp.read(step1);
+      
+      // Validate the image was loaded correctly (not a 1x1 or tiny placeholder)
+      if (image.getWidth() < 10 || image.getHeight() < 10) {
+        throw new Error(`Screenshot appears corrupted: got ${image.getWidth()}x${image.getHeight()} pixels`);
+      }
 
       // Resize the image
       image.resize(

package/agents.md

@@ -151,7 +151,7 @@ element.found();              // check if found (boolean)
 **Use `screenshot()` liberally during development** to see exactly what the sandbox screen looks like. Screenshots are saved locally and organized by test file.
 
 ```javascript
-// Capture a screenshot - saved to .testdriverai/screenshots/<test-file>/
+// Capture a screenshot - saved to .testdriver/screenshots/<test-file>/
 const screenshotPath = await testdriver.screenshot();
 console.log('Screenshot saved to:', screenshotPath);
 
@@ -168,7 +168,7 @@ await testdriver.screenshot(1, false, true);
 
 **Screenshot file organization:**
 ```
-.testdriverai/
+.testdriver/
   screenshots/
     login.test/           # Folder per test file
       screenshot-1737633600000.png
@@ -443,7 +443,7 @@ console.log('Screenshot with mouse saved to: screenshot-with-mouse.png');
 4. **Log element properties** to understand what the AI sees
 5. **Use `assert()` with specific, descriptive natural language**
 6. **Start simple** - get one step working before adding more
-7. **Take screenshots liberally** - use `await testdriver.screenshot()` after key steps to debug what the sandbox actually shows. Check `.testdriverai/screenshots/<test-file>/` to review them.
+7. **Take screenshots liberally** - use `await testdriver.screenshot()` after key steps to debug what the sandbox actually shows. Check `.testdriver/screenshots/<test-file>/` to review them.
 8. **Always `await` async methods** - TestDriver will warn if you forget, but for TypeScript projects, add `@typescript-eslint/no-floating-promises` to your ESLint config to catch missing `await` at compile time:
    ```json
    // eslint.config.js (for TypeScript projects)

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
@@ -35,14 +27,14 @@ const filePath = await testdriver.screenshot(scale, silent, mouse)
 
 ## File Organization
 
-Screenshots are automatically saved to `.testdriverai/screenshots/<test-file-name>/` in your project root:
+Screenshots are automatically saved to `.testdriver/screenshots/<test-file-name>/` in your project root:
 
 ```
-.testdriverai/
+.testdriver/
   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 `.testdriverai/screenshots/<test-file-nam
 ### 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
@@ -136,11 +125,11 @@ describe("Login Flow", () => {
   </Accordion>
 
   <Accordion title="Add to .gitignore">
-    Add `.testdriverai/screenshots/` to your `.gitignore` to avoid committing screenshots to version control:
+    Add `.testdriver/screenshots/` to your `.gitignore` to avoid committing screenshots to version control:
     
     ```
     # .gitignore
-    .testdriverai/screenshots/
+    .testdriver/screenshots/
     ```
   </Accordion>
 </AccordionGroup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "7.2.53",
+  "version": "7.2.55",
   "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

@@ -1136,26 +1136,20 @@ export default class TestDriverSDK {
   // Utility Methods
 
   /**
-   * Capture a screenshot of the current screen and save it to .testdriverai/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)
+   * Capture a screenshot of the current screen and save it to .testdriver/screenshots
+   * @param filename - Custom filename (without .png extension)
    * @returns 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
    */
-  screenshot(
-    scale?: number,
-    silent?: boolean,
-    mouse?: boolean,
-  ): Promise<string>;
+  screenshot(filename?: string): Promise<string>;
 
   /**
    * Wait for specified time

package/sdk.js

@@ -2118,7 +2118,7 @@ with zipfile.ZipFile(io.BytesIO(zip_data)) as zf:
     // Clean up screenshots folder for this test file before running
     if (this.testFile) {
       const testFileName = path.basename(this.testFile, path.extname(this.testFile));
-      const screenshotsDir = path.join(process.cwd(), ".testdriverai", "screenshots", testFileName);
+      const screenshotsDir = path.join(process.cwd(), ".testdriver", "screenshots", testFileName);
       if (fs.existsSync(screenshotsDir)) {
         fs.rmSync(screenshotsDir, { recursive: true, force: true });
       }
@@ -2772,27 +2772,30 @@ 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);
     
-    // Save to .testdriverai/screenshots/<test-file-name> directory
-    let screenshotsDir = path.join(process.cwd(), ".testdriverai", "screenshots");
+    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");
     if (this.testFile) {
       const testFileName = path.basename(this.testFile, path.extname(this.testFile));
       screenshotsDir = path.join(screenshotsDir, testFileName);
@@ -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;
   }