Merge pull request #178 from SentienceAPI/rebrand3

rebrand 3 with Predicate*

Author: rcholic

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to `@predicatelabs/sdk` will be documented in this file.
+
+## Unreleased
+
+### Deprecated
+
+- Soft-deprecated legacy `Sentience*` class names in favor of `Predicate*` names:
+  - `SentienceBrowser` -> `PredicateBrowser`
+  - `SentienceAgent` -> `PredicateAgent`
+  - `SentienceVisualAgent` -> `PredicateVisualAgent`
+  - `SentienceDebugger` -> `PredicateDebugger`
+  - `backends.SentienceContext` -> `backends.PredicateContext`
+- Legacy names remain supported as runtime aliases for compatibility during a transition window of **1-2 releases**.
+
+### Added
+
+- Runtime alias exports for `Predicate*` counterparts to preserve backwards compatibility while enabling rebrand migration.
+
+### Fixed
+
+- Hardened `search()` in `src/actions.ts` for CI reliability by making `page.waitForLoadState('networkidle')` best-effort with a bounded timeout, preventing flaky timeouts on pages with long-lived background requests.

README.md

@@ -32,6 +32,26 @@ npm install @predicatelabs/sdk
 npx playwright install chromium
 ```
 
+## Naming migration (Predicate rebrand)
+
+Use the new `Predicate*` class names for all new code:
+
+- `PredicateBrowser`
+- `PredicateAgent`
+- `PredicateVisualAgent`
+- `PredicateDebugger`
+- `backends.PredicateContext`
+
+The legacy `Sentience*` names are still available as runtime aliases for compatibility, but are now soft-deprecated and planned for removal after **1-2 releases**.
+
+Mapping:
+
+- `SentienceBrowser` -> `PredicateBrowser`
+- `SentienceAgent` -> `PredicateAgent`
+- `SentienceVisualAgent` -> `PredicateVisualAgent`
+- `SentienceDebugger` -> `PredicateDebugger`
+- `backends.SentienceContext` -> `backends.PredicateContext`
+
 ## Conceptual example (why this exists)
 
 - Steps are **gated by verifiable UI assertions**

src/actions.ts

@@ -1134,7 +1134,13 @@ export async function search(
   const urlBefore = page.url();
   const url = buildSearchUrl(query, engine);
   await browser.goto(url);
-  await page.waitForLoadState('networkidle');
+  // Some search engines keep long-lived background requests open in CI,
+  // so treat networkidle as a best-effort signal instead of a hard requirement.
+  try {
+    await page.waitForLoadState('networkidle', { timeout: 5000 });
+  } catch {
+    // no-op: page is already loaded enough for URL/result assertions
+  }
 
   const durationMs = Date.now() - startTime;
   const urlAfter = page.url();

tests/README.md

@@ -1,5 +1,10 @@
 # Running Tests - TypeScript SDK
 
+## Naming for new tests
+
+Use `Predicate*` names in new test code (for example `PredicateBrowser`, `PredicateAgent`, `PredicateDebugger`).
+Legacy `Sentience*` names still work as compatibility aliases, but new tests should prefer the rebranded names.
+
 ## Prerequisites
 
 ```bash
@@ -82,30 +87,30 @@ Create test files in `tests/` directory:
 ### Example: `tests/inspector.test.ts`
 
 ```typescript
-import { SentienceBrowser, inspect } from '../src';
+import { PredicateBrowser, inspect } from '../src';
 
 describe('Inspector', () => {
   it('should start and stop', async () => {
-    const browser = new SentienceBrowser(undefined, undefined, false);
+    const browser = new PredicateBrowser(undefined, undefined, false);
     await browser.start();
-    
+
     try {
       await browser.getPage().goto('https://example.com');
       await browser.getPage().waitForLoadState('networkidle');
-      
+
       const inspector = inspect(browser);
       await inspector.start();
-      
-      const active = await browser.getPage().evaluate(
-        () => (window as any).__sentience_inspector_active === true
-      );
+
+      const active = await browser
+        .getPage()
+        .evaluate(() => (window as any).__sentience_inspector_active === true);
       expect(active).toBe(true);
-      
+
       await inspector.stop();
-      
-      const inactive = await browser.getPage().evaluate(
-        () => (window as any).__sentience_inspector_active === true
-      );
+
+      const inactive = await browser
+        .getPage()
+        .evaluate(() => (window as any).__sentience_inspector_active === true);
       expect(inactive).toBe(false);
     } finally {
       await browser.close();
@@ -117,27 +122,27 @@ describe('Inspector', () => {
 ### Example: `tests/recorder.test.ts`
 
 ```typescript
-import { SentienceBrowser, record } from '../src';
+import { PredicateBrowser, record } from '../src';
 
 describe('Recorder', () => {
   it('should record click events', async () => {
-    const browser = new SentienceBrowser(undefined, undefined, false);
+    const browser = new PredicateBrowser(undefined, undefined, false);
     await browser.start();
-    
+
     try {
       await browser.getPage().goto('https://example.com');
       await browser.getPage().waitForLoadState('networkidle');
-      
+
       const rec = record(browser);
       rec.start();
-      
+
       rec.recordClick(1, 'role=button');
-      
+
       const trace = rec.getTrace();
       expect(trace.steps.length).toBe(1);
       expect(trace.steps[0].type).toBe('click');
       expect(trace.steps[0].element_id).toBe(1);
-      
+
       rec.stop();
     } finally {
       await browser.close();
@@ -202,25 +207,29 @@ npm test -- tests/inspector.test.ts -t "should start"
 ## Troubleshooting
 
 ### TypeScript compilation errors
+
 ```bash
 npm run build
 ```
 
 ### Browser not found
+
 ```bash
 npx playwright install chromium
 ```
 
 ### Extension not found
+
 Make sure the extension is built:
+
 ```bash
 cd ../sentience-chrome
 ./build.sh
 ```
 
 ### Module not found errors
+
 ```bash
 npm install
 npm run build
 ```
-