testdriverai 5.5.5 → 5.5.7

package/docs/apps/mobile-apps.mdx

@@ -0,0 +1,22 @@
+---
+title: "Mobile Apps"
+sidebarTitle: "Mobile Apps"
+description: "Test mobile apps with TestDriver"
+icon: "mobile"
+---
+# Testing Mobile Apps with TestDriver
+
+## How Do I Test Mobile Apps?
+TestDriver provides a powerful solution for testing mobile apps. With our platform, you can easily create and run tests to ensure your mobile app functions as expected across different devices and operating systems.
+
+
+
+<Tip>You will need to install a mobile emulator for your deployed tests or use a device farm to test your mobile app.</Tip>
+
+## 
+To get started with testing mobile apps using TestDriver, follow these steps:
+1. **Follow our [quick start guide](/overview/quickstart) to set up your TestDriver account.**
+2. **Create a new test project** in your TestDriver dashboard.
+3. **Add your mobile emulator to the test settings.**
+4. **Add your mobile app URL** to the test settings.
+

package/docs/apps/static-websites.mdx

@@ -0,0 +1,54 @@
+---
+title: "Testing Static Websites with TestDriver"
+sidebarTitle: "Static Websites"
+description: "Test static websites with TestDriver"
+icon: "browser"
+---
+TestDriver provides a powerful solution for testing static websites. With our platform, you can easily create and run tests to ensure your static website functions as expected across different browsers and devices.
+
+## TestDriver in Action
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/CqdRN_5_3I0"
+  title="Form Filling with TestDriver"
+  frameborder="0"
+  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
+
+## Getting Started
+To get started with testing static websites using TestDriver, follow these steps:
+1. **Follow our [quick start guide](/getting-started/setup) to set up your TestDriver account.**
+2. **Create a new test project** in your TestDriver dashboard.
+3. **Add your static website URL** to the test settings.
+It looks like this in the `prerun.yaml` file:
+
+```yaml
+version: 5.1.1
+session: 67f00511acbd9ccac373edf7
+steps:
+  - prompt: launch chrome
+    commands:
+      - command: exec
+        lang: shell
+        linux: |
+          jumpapp google-chrome --disable-fre --no-default-browser-check --no-first-run "${TD_WEBSITE}" &
+          exit
+        mac: |
+          open -na "Google Chrome" --args --disable-fre --no-default-browser-check --no-first-run --disable-features=PasswordManagerEnabled "${TD_WEBSITE}" &
+          exit
+        windows:
+          Start-Process "C:/Program Files/Google/Chrome/Application/chrome.exe" -ArgumentList "--start-maximized", "${TD_WEBSITE}"
+          exit
+      - command: wait-for-text
+        text: "Google Chrome"
+        timeout: 30000
+```
+Set the `TD_WEBSITE` environment variable to the URL of your static website. This will allow TestDriver to launch the browser and navigate to your website. You can do this by adding this `prerun.yaml` file to your project or by simply using:
+```bash
+testdriverai init
+```
+Running init will create the `prerun.yaml` file for you and ask you which website to load with your test.
+
+

package/docs/bugs/jira.mdx

@@ -1,26 +1,28 @@
 ---
 title: "Reporting Failed Tests to Jira"
 sidebarTitle: "Jira"
-description: "Step-by-step instructions to integrate TestDriver.ai with Jira for automated test failure tracking in CI/CD workflows."
+description: "Step-by-step instructions to integrate TestDriver with Jira for automated test failure tracking in CI/CD workflows."
+icon: "jira"
 ---
 
-# Automating Jira Ticket Creation for Test Failures Using TestDriver.ai and Jira GitHub Actions
+# Automating Jira Ticket Creation for Test Failures Using TestDriver and Jira GitHub Actions
 
-This guide explains how to integrate the **TestDriver.ai GitHub Action** with the **Jira GitHub Action** to automatically create a Jira ticket whenever a TestDriver.ai test fails. This workflow ensures that test failures are tracked in Jira, enabling teams to address issues promptly.
+This guide explains how to integrate the **TestDriver GitHub Action** with the **Jira GitHub Action** to automatically create a Jira ticket whenever a TestDriver test fails. This workflow ensures that test failures are tracked in Jira, enabling teams to address issues promptly.
 
 ---
 
 ## Workflow Overview
 
-1. **Run Tests with TestDriver.ai**: Use the TestDriver.ai GitHub Action to execute your test suite.
-2. **Check for Test Failures**: Capture the test results and determine if any tests failed.
-3. **Create a Jira Ticket**: Use the Jira GitHub Action to create a new ticket for each test failure, including relevant details such as the test name, failure reason, and logs.
-
+<Steps>
+<Step title="Run Tests with TestDriver">Use the TestDriver GitHub Action to execute your test suite.</Step>
+<Step title="Check for Test Failures">Capture the test results and determine if any tests failed.</Step>
+<Step title="Create a Jira Ticket">Use the Jira GitHub Action to create a new ticket for each test failure, including relevant details such as the test name, failure reason, and logs.</Step>
+</Steps>
 ---
 
 ## Prerequisites
 
-1. **TestDriver.ai API Key**: Store your API key as a GitHub secret (e.g., `TESTDRIVER_API_KEY`).
+1. **TestDriver API Key**: Store your API key as a GitHub secret (e.g., `TD_API_KEY`).
 2. **Jira API Token**: Generate an API token from your Jira account and store it as a GitHub secret (e.g., `JIRA_API_TOKEN`).
 3. **Jira Base URL**: Your Jira instance URL (e.g., `https://yourcompany.atlassian.net`).
 4. **Jira Project Key**: The key of the Jira project where tickets will be created (e.g., `TEST`).
@@ -29,10 +31,11 @@ This guide explains how to integrate the **TestDriver.ai GitHub Action** with th
 
 ## GitHub Actions Workflow
 
-Here’s a complete workflow that integrates TestDriver.ai and Jira:
+Here's a complete workflow that integrates TestDriver and Jira:
 
-### Workflow File: `.github/workflows/testdriver-jira.yml````yaml
-name: TestDriver.ai with Jira Integration
+### Workflow File: `.github/workflows/testdriver-jira.yml`
+```yaml
+name: TestDriver with Jira Integration
 
 on:
   push:
@@ -43,17 +46,17 @@ on:
 
 jobs:
   run-tests:
-    name: Run Tests with TestDriver.ai
+    name: Run Tests with TestDriver
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository
         uses: actions/checkout@v2
 
-      - name: Run TestDriver.ai
+      - name: Run TestDriver
         id: testdriver
         uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
           prompt: |
             1. Run all tests in the testdriver directory
         env:
@@ -64,7 +67,7 @@ jobs:
         id: check-failures
         run: |
           if [[ "${{ steps.testdriver.outputs.success }}" == "false" ]]; then
-            echo "TestDriver.ai tests failed."
+            echo "TestDriver tests failed."
             echo "failure=true" >> $GITHUB_ENV
           else
             echo "All tests passed."
@@ -86,7 +89,7 @@ jobs:
           project: TEST # Replace with your Jira project key
           summary: "Test Failure: ${{ steps.testdriver.outputs.summary }}"
           description: |
-            A test failure occurred during the TestDriver.ai workflow.
+            A test failure occurred during the TestDriver workflow.
 
             **Test Summary**:
             ${{ steps.testdriver.outputs.summary }}
@@ -103,13 +106,14 @@ jobs:
 
 ## Workflow Steps Explained
 
-### 1. **Run Tests with TestDriver.ai**
-The `testdriverai/action@main` step runs your TestDriver.ai tests and captures the results. The `outputs.success` variable indicates whether the tests passed or failed.```yaml
-- name: Run TestDriver.ai
+### 1. **Run Tests with TestDriver**
+The `testdriverai/action@main` step runs your TestDriver tests and captures the results. The `outputs.success` variable indicates whether the tests passed or failed.
+```yaml
+- name: Run TestDriver
   id: testdriver
   uses: testdriverai/action@main
   with:
-    key: ${{ secrets.TESTDRIVER_API_KEY }}
+    key: ${{ secrets.TD_API_KEY }}
     prompt: |
       1. Run all tests in the testdriver directory
   env:
@@ -121,12 +125,13 @@ The `testdriverai/action@main` step runs your TestDriver.ai tests and captures t
 ---
 
 ### 2. **Check for Test Failures**
-This step checks the `outputs.success` variable from the TestDriver.ai action. If the tests failed, it sets an environment variable (`failure=true`) to trigger the Jira ticket creation step.```yaml
+This step checks the `outputs.success` variable from the TestDriver action. If the tests failed, it sets an environment variable (`failure=true`) to trigger the Jira ticket creation step.
+```yaml
 - name: Check for Test Failures
   id: check-failures
   run: |
     if [[ "${{ steps.testdriver.outputs.success }}" == "false" ]]; then
-      echo "TestDriver.ai tests failed."
+      echo "TestDriver tests failed."
       echo "failure=true" >> $GITHUB_ENV
     else
       echo "All tests passed."
@@ -140,7 +145,8 @@ This step checks the `outputs.success` variable from the TestDriver.ai action. I
 ### 3. **Create a Jira Ticket**
 If any tests failed, the `create-jira-ticket` job uses the `atlassian/gajira-create` action to create a new Jira ticket. The ticket includes:
 - **Summary**: A brief description of the failure.
-- **Description**: Detailed information about the failure, including the test summary and markdown output from TestDriver.ai.```yaml
+- **Description**: Detailed information about the failure, including the test summary and markdown output from TestDriver.
+```yaml
 - name: Create Jira Ticket
   uses: atlassian/gajira-create@v3
   with:
@@ -150,7 +156,7 @@ If any tests failed, the `create-jira-ticket` job uses the `atlassian/gajira-cre
     project: TEST # Replace with your Jira project key
     summary: "Test Failure: ${{ steps.testdriver.outputs.summary }}"
     description: |
-      A test failure occurred during the TestDriver.ai workflow.
+      A test failure occurred during the TestDriver workflow.
 
       **Test Summary**:
       ${{ steps.testdriver.outputs.summary }}
@@ -168,7 +174,7 @@ If any tests failed, the `create-jira-ticket` job uses the `atlassian/gajira-cre
 ## Secrets Configuration
 
 Add the following secrets to your GitHub repository:
-1. **`TESTDRIVER_API_KEY`**: Your TestDriver.ai API key.
+1. **`TD_API_KEY`**: Your TestDriver API key.
 2. **`JIRA_API_TOKEN`**: Your Jira API token.
 3. **`JIRA_BASE_URL`**: Your Jira instance URL (e.g., `https://yourcompany.atlassian.net`).
 4. **`JIRA_USERNAME`**: Your Jira account email.
@@ -184,7 +190,7 @@ Add the following secrets to your GitHub repository:
 
 
 ```
-A test failure occurred during the TestDriver.ai workflow.
+A test failure occurred during the TestDriver workflow.
 
 **Test Summary**:
 Login Test Failed
@@ -195,7 +201,8 @@ Login Test Failed
 
 Please investigate the issue and resolve it promptly.
 
-```---
+```
+---
 
 ## Benefits of This Workflow
 
@@ -205,4 +212,4 @@ Please investigate the issue and resolve it promptly.
 
 ---
 
-By combining TestDriver.ai and Jira GitHub Actions, you can automate the process of tracking test failures, improving collaboration and ensuring faster resolution of issues.
+By combining TestDriver and Jira GitHub Actions, you can automate the process of tracking test failures, improving collaboration and ensuring faster resolution of issues.

package/docs/cli/overview.mdx

@@ -1,8 +1,11 @@
-```mdx
-# Command: `testdriverai`
+---
+title: Overview of the TestDriver CLI
+sidebarTitle: "CLI Overview"
+description: "Learn about the TestDriver CLI, its commands, and how to use it effectively."
+icon: "terminal"
+---
 
-## Description
-The `testdriverai` CLI is the primary interface for running, managing, and debugging TestDriver.ai scripts. It provides commands to execute tests, validate configurations, and interact with the TestDriver.ai framework.
+The `testdriverai` CLI is the primary interface for running, managing, and debugging TestDriver scripts. It provides commands to execute tests, validate configurations, and interact with the TestDriver framework.
 
 ## Usage
 ```bash
@@ -12,10 +15,10 @@ testdriverai <command> [options]
 ## Available Commands
 | Command       | Description                                                                 |
 |---------------|-----------------------------------------------------------------------------|
-| `run`         | Executes a TestDriver.ai script.                                           |
-| `validate`    | Validates the syntax and structure of a TestDriver.ai script.              |
-| `init`        | Initializes a new TestDriver.ai project in the current directory.          |
-| `version`     | Displays the current version of the TestDriver.ai CLI.                     |
+| `run`         | Executes a TestDriver script.                                           |
+| `validate`    | Validates the syntax and structure of a TestDriver script.              |
+| `init`        | Initializes a new TestDriver project in the current directory.          |
+| `version`     | Displays the current version of the TestDriver CLI.                     |
 | `help`        | Displays help information for the CLI or a specific command.               |
 
 ## Example Usage
@@ -24,7 +27,7 @@ testdriverai <command> [options]
 ```bash
 testdriverai run path/to/testdriver.yaml
 ```
-This command runs the specified TestDriver.ai script, executing all steps defined in the file.
+This command runs the specified TestDriver script, executing all steps defined in the file.
 
 ### Validating a Script
 ```bash
@@ -36,13 +39,13 @@ This command checks the syntax and structure of the script to ensure it is valid
 ```bash
 testdriverai init
 ```
-This command sets up a new TestDriver.ai project in the current directory, creating the necessary folder structure and configuration files.
+This command sets up a new TestDriver project in the current directory, creating the necessary folder structure and configuration files.
 
 ### Checking the Version
 ```bash
 testdriverai version
 ```
-This command displays the installed version of the TestDriver.ai CLI.
+This command displays the installed version of the TestDriver CLI.
 
 ### Getting Help
 ```bash
@@ -58,8 +61,11 @@ testdriverai help <command>
 - Combine `testdriverai run` with CI/CD pipelines to automate test execution.
 - Use the `--debug` flag with `run` to enable detailed logging for troubleshooting.
 
+<Info>
+Running `testdriverai init` will create a blank `testdriver.yaml` file in the current directory. You can then edit this file to define your test steps. 
+</Info>
+
 ## Notes
 - The `testdriverai` CLI is cross-platform and works on macOS, Windows, and Linux.
 - Ensure you have the required dependencies installed and configured before running scripts.
-- For more advanced usage, refer to the official TestDriver.ai documentation.
-```
+- For more advanced usage, refer to the official TestDriver documentation.

package/docs/commands/assert.mdx

@@ -1,5 +1,7 @@
 ---
 title: "assert"
+sidebarTitle: "assert"
+description: "Validate conditions during a test using the assert command."
 icon: "check"
 ---
 

package/docs/commands/exec.mdx

@@ -1,5 +1,7 @@
 ---
 title: "exec"
+sidebarTitle: "exec"
+description: "Execute custom shell or NodeJS scripts within your tests."
 icon: "code"
 ---
 
@@ -52,3 +54,97 @@ steps:
 
 - Overwrite the `result` variable in your script, as it is used to store the output.
 - NodeJS code executes in the same context as the calling process on the host machine, using the [VM](https://nodejs.org/api/vm.html) module internally.
+
+
+```yaml
+version: 5.3.8
+steps:
+  - commands:
+      - command: exec
+        lang: shell
+        silent: false
+        mac: |
+          npm install @sendgrid/mail
+      - command: exec
+        lang: js
+        output: accountData
+        silent: false
+        mac: |
+          const Mailjs = require("@cemalgnlts/mailjs");
+          const mailjs = new Mailjs();
+          let account = await mailjs.createOneAccount()
+          console.log("Account created:", account);
+          result = JSON.stringify(account.data)
+      - command: exec
+        lang: js
+        output: emailAddress
+        silent: false
+        mac: |
+          const accountData = ${OUTPUT.accountData};
+          result = accountData.username
+  - prompt: Enter the generated email into the email field
+    commands:
+      - command: hover-text
+        text: standard_user
+        description: email input field label
+        action: click
+      - command: type
+        text: ${OUTPUT.emailAddress}
+  - prompt: Wait for an email, extract links, and open each link
+    commands:
+      - command: exec
+        lang: js
+        silent: false
+        mac: |
+          const Mailjs = require("@cemalgnlts/mailjs");
+          const { JSDOM } = require('jsdom'); // To parse HTML and extract links
+
+          const accountData = ${OUTPUT.accountData};
+
+          const getLatestEmailAndClickLinks = async () => {
+            try {
+              // Initialize the Mailjs client
+              const mailjs = new Mailjs();
+
+              // Login to your account
+              await mailjs.login(accountData.username, accountData.password);
+
+              // Fetch list of messages
+              const messages = await mailjs.getMessages();
+
+              if (messages.length === 0) {
+                console.log('No emails found.');
+                return;
+              }
+
+              // Assuming the latest email is the first one in the list
+              const latestMessage = messages[0];
+
+              // Fetch the full details of the latest email
+              const fullMessage = await mailjs.getMessage(latestMessage.id);
+
+              console.log('Latest Email Details:', fullMessage);
+
+              // Parse the HTML content to extract links
+              const dom = new JSDOM(fullMessage.html);
+              const links = Array.from(dom.window.document.querySelectorAll('a')).map(a => a.href);
+
+              console.log('Found Links:', links);
+
+              // Click (fetch) every link using native fetch
+              for (const link of links) {
+                try {
+                  const response = await fetch(link);
+                  console.log('Clicked ${link}: ${response.status}');
+                } catch (linkError) {
+                  console.error('Error clicking ${link}:', linkError);
+                }
+              }
+
+            } catch (error) {
+              console.error('Error fetching latest email or clicking links:', error);
+            }
+          };
+
+          getLatestEmailAndClickLinks();
+```

package/docs/commands/focus-application.mdx

@@ -1,5 +1,7 @@
 ---
 title: "focus-application"
+sidebarTitle: "focus-application"
+description: "Bring a specific application window to the foreground."
 icon: "window-restore"
 ---
 

package/docs/commands/hover-image.mdx

@@ -1,5 +1,7 @@
 ---
 title: "hover-image"
+sidebarTitle: "hover-image"
+description: "Locate an image on the screen and perform an action."
 icon: "image"
 ---
 

package/docs/commands/hover-text.mdx

@@ -1,5 +1,7 @@
 ---
 title: "hover-text"
+sidebarTitle: "hover-text"
+description: "Locate text on the screen and perform an action."
 icon: "text"
 ---
 

package/docs/commands/if.mdx

@@ -1,6 +1,8 @@
 ---
 title: "if"
-icon: "code-branch"
+sidebarTitle: "if"
+description: "Conditionally execute commands based on a specified condition."
+icon: "split"
 ---
 
 ## Description
@@ -41,5 +43,4 @@ else:
 ## Notes
 - The `if` command is useful for creating conditional logic in your tests, allowing for more dynamic and flexible workflows.
 - Both the `then` and `else` blocks are optional, but at least one must be provided.
-```
 

package/docs/commands/issues.mdx

@@ -0,0 +1,27 @@
+---
+title: "Known Issues"
+sidebarTitle: "Known Issues"
+description: "Known issues and limitations of TestDriver."
+icon: "bug"
+---
+
+## Reporting Issues
+If you encounter any issues while using TestDriver, please report them to us. You can do this by creating a new issue in our [GitHub repository](https://github.com/testdriverai/testdriverai/issues/new). We appreciate your feedback and will work to resolve any problems as quickly as possible.
+
+
+## Known Issues
+
+### Image Description Matches
+TestDriver may not accurately match image descriptions in certain cases. This can lead to unexpected behavior when using the `hover-image` command. For example, if you specify a description that is too generic or similar to other images on the screen, TestDriver may not be able to identify the correct image to interact with. To improve accuracy, use specific and unique descriptions for images.
+
+### Text Substrings
+TestDriver may not accurately match text substrings in certain cases. This can lead to unexpected behavior when using the `hover-text` command. 
+
+### Scrolling 
+TestDriver may not scroll the browser window to the correct position when using the `scroll` command. This can result in elements being out of view or not clickable. To work around this, you can use the `scroll` command with a specific `amount` or `direction` to ensure the element is in view before interacting with it.
+
+```yaml
+  - command: scroll
+        direction: down
+        amount: 500
+```

package/docs/commands/match-image.mdx

@@ -1,5 +1,7 @@
 ---
 title: "match-image"
+sidebarTitle: "match-image"
+description: "Locate an image on the screen and perform an action."
 icon: "images"
 ---
 

package/docs/commands/press-keys.mdx

@@ -1,6 +1,8 @@
 ---
 title: "press-keys"
-icon: "keyboard-brightness"
+sidebarTitle: "press-keys"
+description: "Simulate typing a keyboard combination."
+icon: "keyboard"
 ---
 
 ## Description
@@ -9,12 +11,14 @@ The `press-keys` command is used to simulate typing a keyboard combination. This
 ## Arguments
 | Argument | Type                | Description                                                                 |
 |----------|---------------------|-----------------------------------------------------------------------------|
-| `keys`   | `yml array of strings` | A list of keys to press together. Keys are automatically remapped for different operating systems. |
+| `keys`   | yml array of strings | A list of keys to press together. Keys are automatically remapped for different operating systems. |
 
 ## Example Usage
 ```yaml
 command: press-keys
-keys: [command, space]
+keys:
+    - command
+    - space
 ```
 
 ## Protips
@@ -27,5 +31,5 @@ keys: [command, space]
 
 ## Notes
 - The `press-keys` command is ideal for automating workflows that rely on keyboard shortcuts.
-- This command supports cross-platform key remapping to ensure compatibility across macOS, Windows, and Linux.
-```
+
+<Check>This command supports cross-platform key remapping to ensure compatibility across macOS, Windows, and Linux.</Check>

package/docs/commands/run.mdx

@@ -1,5 +1,7 @@
 ---
 title: "run"
+sidebarTitle: "run"
+description: "Embed and execute another file within the current script."
 icon: "play"
 ---
 
@@ -28,4 +30,3 @@ file: path/to/another-script.yaml
 ## Notes
 - The `run` command is ideal for creating modular and maintainable test scripts by reusing common workflows.
 - This command supports nesting, allowing you to call scripts that themselves use the `run` command.
-```

package/docs/commands/scroll-until-image.mdx

@@ -1,6 +1,8 @@
 ---
 title: "scroll-until-image"
-icon: "scroll"
+sidebarTitle: "scroll-until-image"
+description: "Scroll the screen until an image matching the description is found."
+icon: "film-simple"
 ---
 
 ## Description

package/docs/commands/scroll-until-text.mdx

@@ -1,5 +1,7 @@
 ---
 title: "scroll-until-text"
+sidebarTitle: "scroll-until-text"
+description: "Scroll the screen until the specified text is found."
 icon: "scroll"
 ---
 

package/docs/commands/scroll.mdx

@@ -1,6 +1,8 @@
 ---
 title: "scroll"
-icon: "scroll"
+sidebarTitle: "scroll"
+description: "Scroll the screen in a specified direction using the mouse wheel."
+icon: "computer-mouse"
 ---
 
 # Command: `scroll`

package/docs/commands/type.mdx

@@ -1,6 +1,8 @@
 ---
 title: "type"
-icon: "keyboard"
+sidebarTitle: "type"
+description: "Simulate typing a string using keyboard emulation."
+icon: "typewriter"
 ---
 
 ## Description

package/docs/commands/wait-for-image.mdx

@@ -1,6 +1,8 @@
 ---
 title: "wait-for-image"
-icon: "hourglass"
+sidebarTitle: "wait-for-image"
+description: "Wait until an image matching the description is detected on the screen."
+icon: "clock-three-thirty"
 ---
 
 ## Description

package/docs/commands/wait-for-text.mdx

@@ -1,6 +1,8 @@
 ---
 title: "wait-for-text"
-icon: "hourglass"
+sidebarTitle: "wait-for-text"
+description: "Wait until the specified text is detected on the screen."
+icon: "clock-nine"
 ---
 
 ## Description

package/docs/commands/wait.mdx

@@ -1,6 +1,8 @@
 ---
 title: "wait"
-icon: "hourglass"
+sidebarTitle: "wait"
+description: "Pause the execution of the script for a specified duration."
+icon: "clock"
 ---
 
 ## Description