testdriverai 7.2.54 → 7.2.55

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/package.json

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

@@ -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;
   }