forcing deprecation of useAccessibilityTree on observe (#445)

* forcing deprecation of useAccessibilityTree on observe * added changeset
browserbase · Jan 30, 2025 · 5bc514f · 5bc514f
1 parent 1032d7d
commit 5bc514f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/.changeset/rude-moles-yawn.md b/.changeset/rude-moles-yawn.md
@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand": patch
+---
+
+Adding back useAccessibilityTree param to observe with a deprecation warning/error indicating to use onlyVisible instead
diff --git a/lib/StagehandPage.ts b/lib/StagehandPage.ts
@@ -504,8 +504,24 @@ export class StagehandPage {
       domSettleTimeoutMs,
       returnAction = false,
       onlyVisible = false,
+      useAccessibilityTree,
     } = options;
 
+    if (useAccessibilityTree !== undefined) {
+      this.stagehand.log({
+        category: "deprecation",
+        message:
+          "useAccessibilityTree is deprecated.\n" +
+          "  To use accessibility tree as context:\n" +
+          "    1. Set onlyVisible to false (default)\n" +
+          "    2. Don't declare useAccessibilityTree",
+        level: 1,
+      });
+      throw new Error(
+        "useAccessibilityTree is deprecated. Use onlyVisible instead.",
+      );
+    }
+
     if (typeof useVision !== "undefined") {
       this.stagehand.log({
         category: "deprecation",

diff --git a/types/stagehand.ts b/types/stagehand.ts
@@ -91,13 +91,14 @@ export interface ObserveOptions {
   domSettleTimeoutMs?: number;
   returnAction?: boolean;
   onlyVisible?: boolean;
+  /** @deprecated `useAccessibilityTree` is now deprecated. Use `onlyVisible` instead. */
+  useAccessibilityTree?: boolean;
 }
 
 export interface ObserveResult {
   selector: string;
   description: string;
   backendNodeId?: number;
-  //TODO: review name
   method?: string;
   arguments?: string[];
 }