@probolabs/playwright 0.4.20 → 1.0.1

package/README.md

@@ -1,136 +1,136 @@
-# Probolib: drive your playwright scripts with AI superpowers
-
-Probolib is a powerful AI-driven automation library that enhances Playwright testing and automation by making your scripts more robust and maintainable. Instead of relying on brittle CSS selectors or complex XPath expressions, Probolib uses natural language to interact with web elements.
-
-## Why Probolib?
-
-- **Natural Language Automation**: Write human-readable instructions instead of complex selectors
-- **More Resilient Tests**: AI-powered element detection that adapts to UI changes
-- **Simpler Maintenance**: Reduce the need to update selectors when the UI changes
-- **Faster Development**: Write automation scripts in plain English
-
-## Example
-
-Instead of writing:
-
-```
-page.click('some > super > complex > css > and non robust selector')
-```
-
-You can simply write:
-
-```
-probo.runStep(page, 'click on the save button')
-```
-
-## Quickstart
-
-```
-npm install @probolabs/playwright
-```
-
-## Accessing our backend
-
-the heavy lifting of the AI reasoning is done at the moment on our backend server. in order to access it you would need to tell the library how to access it.
-
-## easyiest - set ENV var
-
-probolib expects the existance of 2 env vars:
-
-```
-export PROBO_API_ENDPOINT=api.probolabs.ai
-export PROBO_API_KEY=<api key we will give you>
-
-```
-
-Or use dotenv
-
-```
-// npm install dotenv
-// in your script add this line
-import 'dotenv/config' // ES6
-
-// .env file located in the root of your project (the same level as your package.json)
-PROBO_API_ENDPOINT=https://api.probolabs.ai
-PROBO_API_KEY=<api key we will give you>
-
-```
-
-## A complete example for Playwright integration. step by step
-
-**step 1:** init a playwright project
-
-```
-# from your work directory
-mkdir probo-example
-cd probo-example
-npm init playwright@latest
-# follow the instructions and wait till the installation is finished
-# verify that playwright is installed properly
-npx playwright test --project chromium
-```
-
-**step 2**: integrate probolabs
-
-```
-npm install @probolabs/playwright dotenv
-```
-
-**step 3:** configure the env with our endpoint and api key
-
-```
-touch .env
-```
-
-edit the .env file
-
-```
-#.env
-PROBO_API_ENDPOINT=https://api.probolabs.ai
-PROBO_API_KEY=<api key we will give you>
-
-```
-
-**step 4:** create a file under the tests folder named `probo-example-todo-mvc.spec.mjs`
-
-```
-// tests/probo-example-todo-mvc.spec.mjs
-import 'dotenv/config';
-import { test} from '@playwright/test';
-import { Probo } from '@probolabs/playwright';
-
-//
-// Important: Before running this script set PROBO_API_KEY and PROBO_API_ENDPOINT
-//
-
-test.describe('Todo MVC', () => {
-  test('basic example', async ({ page }) => {
-    try {
-      // Initialize Probo
-      const probo = new Probo({
-        scenarioName: 'probo-example-todo-mvc' // important for caching the AI reasoning
-      });
-
-      //Goto page
-      await page.goto('https://demo.playwright.dev/todomvc');
-
-      // Run test steps
-      console.log('Running test steps...');
-      await probo.runStep(page, 'enter a new todo item: "Buy groceries"');
-      await probo.runStep(page, 'press the Enter key');
-
-      console.log('✨ Test completed successfully!');
-    } catch (error) {
-      console.error('❌ Test failed:', error);
-      throw error; // Re-throw to mark the test as failed
-    }
-  });
-});
-
-```
-
-**run the example**
-
-```
-npx playwright test tests/probo-example-todo-mvc.spec.mjs --headed --project chromium
-```
+# Probolib: drive your playwright scripts with AI superpowers
+
+Probolib is a powerful AI-driven automation library that enhances Playwright testing and automation by making your scripts more robust and maintainable. Instead of relying on brittle CSS selectors or complex XPath expressions, Probolib uses natural language to interact with web elements.
+
+## Why Probolib?
+
+- **Natural Language Automation**: Write human-readable instructions instead of complex selectors
+- **More Resilient Tests**: AI-powered element detection that adapts to UI changes
+- **Simpler Maintenance**: Reduce the need to update selectors when the UI changes
+- **Faster Development**: Write automation scripts in plain English
+
+## Example
+
+Instead of writing:
+
+```
+page.click('some > super > complex > css > and non robust selector')
+```
+
+You can simply write:
+
+```
+probo.runStep(page, 'click on the save button')
+```
+
+## Quickstart
+
+```
+npm install @probolabs/playwright
+```
+
+## Accessing our backend
+
+the heavy lifting of the AI reasoning is done at the moment on our backend server. in order to access it you would need to tell the library how to access it.
+
+## easyiest - set ENV var
+
+probolib expects the existance of 2 env vars:
+
+```
+export PROBO_API_ENDPOINT=api.probolabs.ai
+export PROBO_API_KEY=<api key we will give you>
+
+```
+
+Or use dotenv
+
+```
+// npm install dotenv
+// in your script add this line
+import 'dotenv/config' // ES6
+
+// .env file located in the root of your project (the same level as your package.json)
+PROBO_API_ENDPOINT=https://api.probolabs.ai
+PROBO_API_KEY=<api key we will give you>
+
+```
+
+## A complete example for Playwright integration. step by step
+
+**step 1:** init a playwright project
+
+```
+# from your work directory
+mkdir probo-example
+cd probo-example
+npm init playwright@latest
+# follow the instructions and wait till the installation is finished
+# verify that playwright is installed properly
+npx playwright test --project chromium
+```
+
+**step 2**: integrate probolabs
+
+```
+npm install @probolabs/playwright dotenv
+```
+
+**step 3:** configure the env with our endpoint and api key
+
+```
+touch .env
+```
+
+edit the .env file
+
+```
+#.env
+PROBO_API_ENDPOINT=https://api.probolabs.ai
+PROBO_API_KEY=<api key we will give you>
+
+```
+
+**step 4:** create a file under the tests folder named `probo-example-todo-mvc.spec.mjs`
+
+```
+// tests/probo-example-todo-mvc.spec.mjs
+import 'dotenv/config';
+import { test} from '@playwright/test';
+import { Probo } from '@probolabs/playwright';
+
+//
+// Important: Before running this script set PROBO_API_KEY and PROBO_API_ENDPOINT
+//
+
+test.describe('Todo MVC', () => {
+  test('basic example', async ({ page }) => {
+    try {
+      // Initialize Probo
+      const probo = new Probo({
+        scenarioName: 'probo-example-todo-mvc' // important for caching the AI reasoning
+      });
+
+      //Goto page
+      await page.goto('https://demo.playwright.dev/todomvc');
+
+      // Run test steps
+      console.log('Running test steps...');
+      await probo.runStep(page, 'enter a new todo item: "Buy groceries"');
+      await probo.runStep(page, 'press the Enter key');
+
+      console.log('✨ Test completed successfully!');
+    } catch (error) {
+      console.error('❌ Test failed:', error);
+      throw error; // Re-throw to mark the test as failed
+    }
+  });
+});
+
+```
+
+**run the example**
+
+```
+npx playwright test tests/probo-example-todo-mvc.spec.mjs --headed --project chromium
+```

package/dist/index.d.ts

@@ -1,16 +1,8 @@
-import { Page, Locator } from 'playwright';
-import { PlaywrightAction, ElementTag, PlaywrightTimeoutConfig, AIModel, ServerResponse, ProboLogLevel } from '@probolabs/probo-shared';
+import { Locator, Page } from 'playwright';
+import { ElementTag, PlaywrightTimeoutConfig, PlaywrightAction, AIModel, InitialPageState, FindCandidateInput, ServerResponse, ProboLogLevel } from '@probolabs/probo-shared';
 export { ElementInfo, ElementTag, PlaywrightAction, ProboLogLevel } from '@probolabs/probo-shared';
 import { Page as Page$1 } from '@playwright/test';
 
-/**
- * Execute a given Playwright action, mirroring Python's _perform_action
- */
-declare function executePlaywrightAction(page: Page, action: PlaywrightAction, value: string | boolean, iframe_selector: string, element_css_selector: string): Promise<boolean | string>;
-/**
- * Execute a given Playwright action using native Playwright functions where possible
- */
-declare function executeCachedPlaywrightAction(page: Page, action: PlaywrightAction, value: string | boolean, iframe_selector: string, element_css_selector: string): Promise<boolean | string>;
 /**
    * Traverses up the DOM from the given locator to find the closest visible ancestor.
    * Returns a Locator for the first visible element found, or null if none is visible up to <html>.
@@ -97,19 +89,18 @@ declare class Highlighter {
 }
 
 interface RunStepParams extends Partial<PlaywrightTimeoutConfig> {
-    iframeSelector: string;
-    elementSelector: string;
-    action: PlaywrightAction | PlaywrightAction[] | string | string[];
+    iframeSelector?: string;
+    elementSelector?: string;
+    action: PlaywrightAction;
     argument?: string | string[];
     annotation?: string;
-}
-interface RunStepResult {
-    key: string;
-    value: any;
+    pollingInterval?: number;
+    timeout?: number;
 }
 declare class ProboPlaywright {
     private readonly config;
     private page;
+    private lastNavigationTime;
     constructor(config?: PlaywrightTimeoutConfig, page?: Page$1 | null);
     /**
      * Sets the Playwright page instance for this ProboPlaywright instance.
@@ -118,6 +109,7 @@ declare class ProboPlaywright {
      * @param page - The Playwright Page instance to use, or null to unset.
      */
     setPage(page: Page$1 | null): void;
+    private onFrameNav;
     /**
      * Executes a single step in the test scenario with the specified action on the target element.
      * Handles iframe navigation, element highlighting, and various Playwright actions like click, fill, validate, etc.
@@ -126,7 +118,7 @@ declare class ProboPlaywright {
      * @returns Promise that resolves to a result object for extract actions, or void for other actions
      * @throws Error if element is not found or validation fails
      */
-    runStep(params: RunStepParams): Promise<RunStepResult | void>;
+    runStep(params: RunStepParams): Promise<string | void>;
     /**
      * Creates a visual highlight overlay on the target element with optional annotation text.
      * The highlight appears as a red border around the element and can include descriptive text.
@@ -169,6 +161,55 @@ declare class ProboPlaywright {
     private getTextValue;
 }
 
+interface NavTrackerOptions {
+    stabilizationTimeout?: number;
+}
+/**
+ * Global navigation tracker that monitors page navigation events
+ * and provides methods to check if navigation has stabilized
+ *
+ * This is a singleton class - only one instance can exist at a time
+ */
+declare class NavTracker {
+    private static instance;
+    private page;
+    private navigationCount;
+    private lastNavTime;
+    private stabilizationTimeout;
+    private isListening;
+    private onFrameNavHandler;
+    private instanceId;
+    /**
+     * Private constructor - use getInstance() to get the singleton instance
+     */
+    private constructor();
+    /**
+     * Start listening for navigation events (private method)
+     */
+    private start;
+    /**
+     * Stop listening for navigation events (private method)
+     */
+    private stop;
+    /**
+     * Check if navigation has stabilized (no navigation for stabilizationTimeout ms) (private method)
+     */
+    private hasNavigationStabilized;
+    /**
+     * Wait for navigation to stabilize
+     * Waits a short time to catch any missed navigation events, then ensures
+     * the latest navigation happened at least stabilizationTimeout ms ago
+     */
+    waitForNavigationToStabilize(): Promise<void>;
+    /**
+     * Get the singleton instance of NavTracker
+     * @param page The page to track (required for first creation)
+     * @param options Optional configuration
+     * @returns The singleton NavTracker instance
+     */
+    static getInstance(page?: Page, options?: NavTrackerOptions): NavTracker;
+}
+
 /**
  * Configuration options for Probo client
  */
@@ -181,11 +222,13 @@ interface ProboConfig {
     logToFile?: boolean;
     debugLevel?: ProboLogLevel;
     aiModel?: AIModel;
+    timeoutConfig?: PlaywrightTimeoutConfig;
 }
 interface RunStepOptions {
     useCache: boolean;
     stepIdFromServer?: number | null;
     aiModel?: AIModel;
+    timeoutConfig?: PlaywrightTimeoutConfig;
 }
 declare class Probo {
     private highlighter;
@@ -193,12 +236,15 @@ declare class Probo {
     private readonly enableConsoleLogs;
     private readonly scenarioName;
     private readonly aiModel;
-    constructor({ scenarioName, token, apiUrl, enableConsoleLogs, logToConsole, logToFile, debugLevel, aiModel }: ProboConfig);
+    private readonly timeoutConfig;
+    constructor({ scenarioName, token, apiUrl, enableConsoleLogs, logToConsole, logToFile, debugLevel, aiModel, timeoutConfig }: ProboConfig);
     askAI(page: Page, question: string): Promise<any>;
-    runStep(page: Page, stepPrompt: string, argument?: string | boolean | null, options?: RunStepOptions): Promise<boolean | string>;
+    runStep(page: Page, stepPrompt: string, argument?: string | boolean | null, options?: RunStepOptions): Promise<boolean | string | null>;
     private _handleCachedStep;
     private _handleStepCreation;
     private setupConsoleLogs;
+    getInitialPageState(page: Page): Promise<InitialPageState>;
+    findAndHighlightCandidateElements(page: Page, elementTags: string[]): Promise<FindCandidateInput>;
     highlightElements(page: Page, elementTags: [ElementTagType]): Promise<any>;
     unhighlightElements(page: Page): Promise<void>;
     highlightElement(page: Page, element_css_selector: string, iframe_selector: string, element_index: string): Promise<void>;
@@ -208,5 +254,5 @@ declare class Probo {
     askAIHelper(page: Page, question: string): Promise<ServerResponse>;
 }
 
-export { Highlighter, Probo, ProboPlaywright, executeCachedPlaywrightAction, executePlaywrightAction, findClosestVisibleElement };
+export { Highlighter, NavTracker, Probo, ProboPlaywright, findClosestVisibleElement };
 export type { ElementTagType, RunStepOptions };