testdriverai 6.2.2 → 7.1.0

package/docs/v7/api/assert.mdx

@@ -0,0 +1,285 @@
+---
+title: "assert()"
+sidebarTitle: "assert"
+description: "Make AI-powered assertions about screen state"
+icon: "check-circle"
+---
+
+## Overview
+
+Make AI-powered assertions about the current screen state using natural language. The AI analyzes the screen and verifies that your assertion is true.
+
+## Syntax
+
+```javascript
+await testdriver.assert(assertion)
+```
+
+## Parameters
+
+<ParamField path="assertion" type="string" required>
+  Natural language description of what should be true
+</ParamField>
+
+## Returns
+
+`Promise<boolean>` - `true` if assertion passes, throws error if assertion fails
+
+## Examples
+
+### Basic Assertions
+
+```javascript
+// Verify page elements
+await testdriver.assert('the login page is displayed');
+await testdriver.assert('submit button is visible');
+await testdriver.assert('error message is shown');
+
+// Verify text content
+await testdriver.assert('the page title is "Welcome"');
+await testdriver.assert('username field contains "john.doe"');
+await testdriver.assert('success message says "Account created"');
+
+// Verify states
+await testdriver.assert('the form is empty');
+await testdriver.assert('the checkbox is checked');
+await testdriver.assert('the dropdown shows "United States"');
+
+// Verify visual appearance
+await testdriver.assert('the button is blue');
+await testdriver.assert('the loading spinner is displayed');
+await testdriver.assert('the modal dialog is open');
+```
+
+## Best Practices
+
+<Check>
+  **Be specific in assertions**
+  
+  More specific assertions are more reliable:
+  
+  ```javascript
+  // ❌ Too vague
+  await testdriver.assert('button is visible');
+  
+  // ✅ Specific
+  await testdriver.assert('blue submit button is visible below the form');
+  ```
+</Check>
+
+<Check>
+  **Assert state changes**
+  
+  Verify state before and after actions:
+  
+  ```javascript
+  // Before
+  await testdriver.assert('cart is empty');
+  
+  // Action
+  const addBtn = await testdriver.find('add to cart');
+  await addBtn.click();
+  
+  // After
+  await testdriver.assert('cart contains 1 item');
+  ```
+</Check>
+
+<Check>
+  **Use with test framework assertions**
+  
+  Combine AI assertions with traditional test assertions:
+  
+  ```javascript
+  // AI assertion
+  const result = await testdriver.assert('success message is displayed');
+  
+  // Framework assertion
+  expect(result).toBeTruthy();
+  
+  // Extract for detailed comparison
+  const message = await testdriver.remember('the success message text');
+  expect(message).toContain('successfully');
+  ```
+</Check>
+
+## Polling Assertions
+
+For conditions that may take time to become true:
+
+```javascript
+async function waitForAssertion(testdriver, assertion, timeout = 30000) {
+  const startTime = Date.now();
+  
+  while (Date.now() - startTime < timeout) {
+    try {
+      await testdriver.assert(assertion);
+      return true; // Assertion passed
+    } catch (error) {
+      // Assertion failed, wait and retry
+      await new Promise(r => setTimeout(r, 1000));
+    }
+  }
+  
+  throw new Error(`Assertion timeout: "${assertion}"`);
+}
+
+// Usage
+await waitForAssertion(testdriver, 'page has finished loading', 30000);
+await waitForAssertion(testdriver, 'results are displayed', 10000);
+```
+
+## Use Cases
+
+<AccordionGroup>
+  <Accordion title="Form Validation">
+    ```javascript
+    // Try to submit empty form
+    const submitBtn = await testdriver.find('submit button');
+    await submitBtn.click();
+    
+    // Verify validation errors
+    await testdriver.assert('email field shows "required" error');
+    await testdriver.assert('password field shows "required" error');
+    
+    // Verify form not submitted
+    await testdriver.assert('still on the form page');
+    ```
+  </Accordion>
+  
+  <Accordion title="Page Navigation">
+    ```javascript
+    const loginBtn = await testdriver.find('login button');
+    await loginBtn.click();
+    
+    // Verify navigation
+    await testdriver.assert('user dashboard is displayed');
+    await testdriver.assert('welcome message shows user name');
+    await testdriver.assert('logout button is visible');
+    ```
+  </Accordion>
+  
+  <Accordion title="Dynamic Content">
+    ```javascript
+    const loadBtn = await testdriver.find('load more button');
+    await loadBtn.click();
+    
+    // Poll for content using helper
+    await waitForAssertion(testdriver, 'more than 10 items are shown', 10000);
+    await testdriver.assert('load more button is still visible');
+    ```
+  </Accordion>
+  
+  <Accordion title="Visual States">
+    ```javascript
+    // Verify hover effect
+    const button = await testdriver.find('primary button');
+    await button.hover();
+    
+    await testdriver.assert('button background is darker');
+    
+    // Verify button is enabled
+    await testdriver.assert('submit button is enabled');
+    ```
+  </Accordion>
+  
+  <Accordion title="Multi-Step Workflows">
+    ```javascript
+    // Step 1
+    await testdriver.assert('step 1 is active');
+    const nextBtn = await testdriver.find('next button');
+    await nextBtn.click();
+    
+    // Step 2
+    await testdriver.assert('step 2 is active');
+    await testdriver.assert('step 1 is completed');
+    await nextBtn.click();
+    
+    // Step 3
+    await testdriver.assert('step 3 is active');
+    await testdriver.assert('step 2 is completed');
+    ```
+  </Accordion>
+</AccordionGroup>
+
+## Complete Example
+
+```javascript
+import { beforeAll, afterAll, describe, it, expect } from 'vitest';
+import TestDriver from 'testdriverai';
+
+describe('Assertions', () => {
+  let testdriver;
+
+  beforeAll(async () => {
+    client = new TestDriver(process.env.TD_API_KEY);
+    await testdriver.auth();
+    await testdriver.connect({ newSandbox: true });
+  });
+
+  afterAll(async () => {
+    await testdriver.disconnect();
+  });
+
+  it('should validate login flow', async () => {
+    await testdriver.focusApplication('Google Chrome');
+    
+    // Verify initial state
+    await testdriver.assert('the login page is displayed');
+    await testdriver.assert('username field is empty');
+    await testdriver.assert('password field is empty');
+    
+    // Fill form
+    const usernameField = await testdriver.find('username input');
+    await usernameField.click();
+    await testdriver.type('testuser');
+    
+    await testdriver.pressKeys(['tab']);
+    await testdriver.type('password123');
+    
+    // Verify fields filled
+    await testdriver.assert('username field contains "testuser"');
+    await testdriver.assert('password field is not empty');
+    
+    // Submit
+    await testdriver.pressKeys(['enter']);
+    
+    // Poll for success
+    await waitForAssertion(testdriver, 'user dashboard is displayed', 10000);
+    
+    // Verify logged in state
+    await testdriver.assert('welcome message is shown');
+    await testdriver.assert('logout button is visible');
+    
+    // Verify login page is gone
+    await testdriver.assert('login form is displayed', false, true);
+  });
+
+  it('should show validation errors', async () => {
+    // Try empty submission
+    const submitBtn = await testdriver.find('submit button');
+    await submitBtn.click();
+    
+    // Verify multiple errors
+    const errors = [
+      'email field shows error',
+      'name field shows error',
+      'password field shows error'
+    ];
+    
+    for (const error of errors) {
+      const result = await testdriver.assert(error);
+      expect(result).toBeTruthy();
+    }
+    
+    // Verify not submitted
+    await testdriver.assert('confirmation page is shown', false, true);
+  });
+});
+```
+
+## Related Methods
+
+- [`remember()`](/v7/api/remember) - Extract information for detailed assertions
+- [`find()`](/v7/api/find) - Locate elements to verify
+- [`ai()`](/v7/api/ai) - Complex AI-driven tasks

package/docs/v7/api/assertions.mdx

@@ -0,0 +1,403 @@
+---
+title: "Assertions & Testing"
+sidebarTitle: "Assertions"
+description: "AI-powered assertions and validation"
+icon: "check-circle"
+---
+
+## Overview
+
+TestDriver provides AI-powered assertions that can verify complex visual states and conditions on screen without requiring explicit element locators or coordinates.
+
+## AI Assertions
+
+### assert()
+
+Make an AI-powered assertion about the current screen state.
+
+```javascript
+await testdriver.assert(assertion)
+```
+
+**Parameters:**
+- `assertion` (string) - Natural language description of what should be true
+
+**Returns:** `Promise<boolean>` - `true` if assertion passes, throws error if fails
+
+### Basic Assertions
+
+```javascript
+// Verify page elements
+await testdriver.assert('the login page is displayed');
+await testdriver.assert('submit button is visible');
+await testdriver.assert('error message is shown');
+
+// Verify text content
+await testdriver.assert('the page title is "Welcome"');
+await testdriver.assert('username field contains "john.doe"');
+await testdriver.assert('success message says "Account created"');
+
+// Verify states
+await testdriver.assert('the form is empty');
+await testdriver.assert('the checkbox is checked');
+await testdriver.assert('the dropdown shows "United States"');
+
+// Verify visual appearance
+await testdriver.assert('the button is blue');
+await testdriver.assert('the loading spinner is displayed');
+await testdriver.assert('the modal dialog is open');
+```
+
+## Pattern: Polling Assertions
+
+For conditions that may take time to become true, use polling:
+
+```javascript
+// Poll until condition is true
+async function waitForAssertion(testdriver, assertion, timeout = 30000) {
+  const startTime = Date.now();
+  
+  while (Date.now() - startTime < timeout) {
+    try {
+      await testdriver.assert(assertion);
+      return true; // Assertion passed
+    } catch (error) {
+      // Assertion failed, wait and retry
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    }
+  }
+  
+  throw new Error(`Assertion timeout: "${assertion}"`);
+}
+
+// Usage
+await waitForAssertion(testdriver, 'the page has finished loading', 30000);
+await waitForAssertion(testdriver, 'results are displayed', 10000);
+```
+
+## Extracting Information
+
+### remember()
+
+Extract and remember information from the screen using AI.
+
+```javascript
+await testdriver.remember(description)
+```
+
+**Parameters:**
+- `description` (string) - What information to extract from the screen
+
+**Returns:** `Promise<string>` - Extracted information
+
+### Examples
+
+```javascript
+// Extract text from screen
+const password = await testdriver.remember('the password displayed on screen');
+const total = await testdriver.remember('the order total amount');
+const errorMessage = await testdriver.remember('the error message text');
+
+// Extract structured data
+const email = await testdriver.remember('the email address in the confirmation');
+const orderId = await testdriver.remember('the order ID number');
+const phoneNumber = await testdriver.remember('the phone number');
+
+// Use extracted data
+const password = await testdriver.remember('the password for standard_user');
+const passwordField = await testdriver.find('password input');
+await passwordField.click();
+await testdriver.type(password);
+```
+
+### Use Cases
+
+**Dynamic Content:**
+```javascript
+// Remember generated values
+const confirmationCode = await testdriver.remember('the 6-digit confirmation code');
+console.log('Code:', confirmationCode);
+
+// Use it later in the test
+await testdriver.type(confirmationCode);
+```
+
+**Verification:**
+```javascript
+// Extract and verify
+const displayedTotal = await testdriver.remember('the cart total');
+const expectedTotal = '$99.99';
+
+expect(displayedTotal).toBe(expectedTotal);
+```
+
+**Conditional Logic:**
+```javascript
+// Extract state and make decisions
+const status = await testdriver.remember('the order status');
+
+if (status.includes('Pending')) {
+  // Wait for processing
+  await new Promise(resolve => setTimeout(resolve, 5000));
+} else if (status.includes('Completed')) {
+  // Continue with test
+  const downloadButton = await testdriver.find('download receipt button');
+  await downloadButton.click();
+}
+```
+
+## Testing Patterns
+
+### Test-Driven Assertions
+
+Structure tests with clear arrange-act-assert pattern:
+
+```javascript
+it('should display validation error for empty email', async () => {
+  // Arrange
+  await testdriver.focusApplication('Google Chrome');
+  
+  // Act
+  const submitButton = await testdriver.find('submit button');
+  await submitButton.click();
+  
+  // Assert
+  const result = await testdriver.assert('validation error says "Email is required"');
+  expect(result).toBeTruthy();
+});
+```
+
+### Multi-Step Assertions
+
+Verify state at each step of a workflow:
+
+```javascript
+it('should complete checkout flow', async () => {
+  // Add item to cart
+  const addButton = await testdriver.find('add to cart button');
+  await addButton.click();
+  
+  // Verify item added
+  await testdriver.assert('cart shows 1 item');
+  
+  // Go to checkout
+  const cartIcon = await testdriver.find('cart icon');
+  await cartIcon.click();
+  
+  // Verify cart page
+  await testdriver.assert('shopping cart page is displayed');
+  await testdriver.assert('cart contains the selected item');
+  
+  // Proceed to checkout
+  const checkoutButton = await testdriver.find('proceed to checkout button');
+  await checkoutButton.click();
+  
+  // Verify checkout page
+  await testdriver.assert('checkout form is displayed');
+});
+```
+
+### Soft Assertions
+
+Collect multiple assertion failures without stopping:
+
+```javascript
+it('should validate all form fields', async () => {
+  const errors = [];
+  
+  // Try multiple assertions
+  try {
+    await testdriver.assert('username field has error border');
+  } catch (e) {
+    errors.push('Username validation failed');
+  }
+  
+  try {
+    await testdriver.assert('email field has error border');
+  } catch (e) {
+    errors.push('Email validation failed');
+  }
+  
+  try {
+    await testdriver.assert('password field has error border');
+  } catch (e) {
+    errors.push('Password validation failed');
+  }
+  
+  // Report all errors
+  if (errors.length > 0) {
+    throw new Error(`Validation errors:\n${errors.join('\n')}`);
+  }
+});
+```
+
+## Complete Example
+
+```javascript
+import { beforeAll, afterAll, describe, it, expect } from 'vitest';
+import TestDriver from 'testdriverai';
+
+describe('E2E Shopping Flow', () => {
+  let testdriver;
+
+  beforeAll(async () => {
+    client = new TestDriver(process.env.TD_API_KEY);
+    await testdriver.auth();
+    await testdriver.connect({ newSandbox: true });
+  });
+
+  afterAll(async () => {
+    await testdriver.disconnect();
+  });
+
+  it('should complete a purchase', async () => {
+    await testdriver.focusApplication('Google Chrome');
+    
+    // Verify initial state
+    await testdriver.assert('the product listing page is displayed');
+    await testdriver.assert('cart is empty');
+    
+    // Add product to cart
+    const addButton = await testdriver.find('add to cart button for first product');
+    await addButton.click();
+    
+    // Verify cart updated
+    await testdriver.assert('cart badge shows 1 item');
+    
+    // Remember product details
+    const productName = await testdriver.remember('the name of the product just added');
+    const price = await testdriver.remember('the price of the product');
+    
+    console.log(`Added ${productName} at ${price}`);
+    
+    // Go to cart
+    const cartIcon = await testdriver.find('shopping cart icon');
+    await cartIcon.click();
+    
+    // Verify cart contents
+    await testdriver.assert(`cart contains ${productName}`);
+    await testdriver.assert(`cart total is ${price}`);
+    
+    // Proceed to checkout
+    const checkoutButton = await testdriver.find('checkout button');
+    await checkoutButton.click();
+    
+    // Fill shipping info
+    const emailField = await testdriver.find('email input');
+    await emailField.click();
+    await testdriver.type('test@example.com');
+    
+    await testdriver.pressKeys(['tab']);
+    await testdriver.type('John Doe');
+    
+    await testdriver.pressKeys(['tab']);
+    await testdriver.type('123 Main St');
+    
+    // Submit order
+    const submitButton = await testdriver.find('place order button');
+    await submitButton.click();
+    
+    // Verify success
+    await testdriver.assert('order confirmation page is displayed');
+    await testdriver.assert('success message is shown');
+    
+    // Extract order number
+    const orderNumber = await testdriver.remember('the order number');
+    console.log('Order placed:', orderNumber);
+    expect(orderNumber).toBeTruthy();
+  });
+
+  it('should show validation errors', async () => {
+    // Try to submit empty form
+    const submitButton = await testdriver.find('submit button');
+    await submitButton.click();
+    
+    // Verify multiple validation errors
+    await testdriver.assert('email field shows "required" error');
+    await testdriver.assert('name field shows "required" error');
+    await testdriver.assert('address field shows "required" error');
+    
+    // Verify form not submitted
+    await testdriver.assert('still on checkout page', false, false);
+    await testdriver.assert('order confirmation page is shown', false, true); // Inverted
+  });
+});
+```
+
+## Best Practices
+
+<AccordionGroup>
+  <Accordion title="Be specific in assertions">
+    More specific assertions are more reliable:
+    
+    ```javascript
+    // ❌ Too vague
+    await testdriver.assert('button is visible');
+    
+    // ✅ Specific
+    await testdriver.assert('blue submit button is visible below the form');
+    ```
+  </Accordion>
+  
+  <Accordion title="Assert state changes">
+    Verify state before and after actions:
+    
+    ```javascript
+    // Before
+    await testdriver.assert('cart is empty');
+    
+    // Action
+    const addButton = await testdriver.find('add to cart');
+    await addButton.click();
+    
+    // After
+    await testdriver.assert('cart contains 1 item');
+    ```
+  </Accordion>
+  
+  <Accordion title="Use polling for dynamic content">
+    Some assertions may need time to become true:
+    
+    ```javascript
+    async function waitFor(assertion, timeout = 10000) {
+      const start = Date.now();
+      while (Date.now() - start < timeout) {
+        try {
+          await testdriver.assert(assertion);
+          return;
+        } catch {
+          await new Promise(r => setTimeout(r, 1000));
+        }
+      }
+      throw new Error(`Timeout: ${assertion}`);
+    }
+    
+    await waitFor('loading complete');
+    ```
+  </Accordion>
+  
+  <Accordion title="Extract before comparing">
+    Use `remember()` to extract values for detailed comparisons:
+    
+    ```javascript
+    const actualTotal = await testdriver.remember('the cart total');
+    const expectedTotal = '$99.99';
+    
+    expect(actualTotal).toBe(expectedTotal);
+    ```
+  </Accordion>
+  
+  <Accordion title="Combine with traditional assertions">
+    Mix AI assertions with framework assertions for comprehensive testing:
+    
+    ```javascript
+    // AI assertion for UI state
+    await testdriver.assert('success message is displayed');
+    
+    // Extract and use traditional assertion for exact values
+    const message = await testdriver.remember('the success message text');
+    expect(message).toContain('successfully');
+    expect(message).toMatch(/order #\d+/i);
+    ```
+  </Accordion>
+</AccordionGroup>