@aria-cli/tools 1.0.9 → 1.0.11

package/src/definitions/browser/pw-session.ts

@@ -1,405 +0,0 @@
-// Originally from OpenClaw (MIT License, Copyright 2025 Peter Steinberger)
-// https://github.com/openclaw/openclaw
-// Modified for ARIA — stripped OpenClaw runtime, rewired to ARIA Tool interface
-
-/**
- * Browser session lifecycle management.
- * Unlike OpenClaw (which connects to an external Chrome via CDP), ARIA
- * launches its own Playwright browser instance directly.
- */
-
-import type {
-  BrowserConsoleMessage,
-  BrowserNetworkRequest,
-  BrowserPageError,
-  BrowserSession,
-  PwBrowser,
-  PwBrowserContext,
-  PwPage,
-  RoleRefMap,
-} from "./types.js";
-import { MAX_CONSOLE_MESSAGES, MAX_NETWORK_REQUESTS, MAX_PAGE_ERRORS } from "./pw-responses.js";
-
-// ── Module-level state (singleton per Node process) ───────────────────
-
-let currentSession: BrowserSession | null = null;
-let currentRefs: RoleRefMap = {};
-const consoleMessages: BrowserConsoleMessage[] = [];
-const networkRequests: BrowserNetworkRequest[] = [];
-const pageErrors: BrowserPageError[] = [];
-let nextRequestId = 0;
-
-const DEFAULT_NAVIGATION_OPTIONS = {
-  timeout: 20_000,
-  waitUntil: "domcontentloaded" as const,
-};
-
-// ── Accessors ─────────────────────────────────────────────────────────
-
-export function getSession(): BrowserSession | null {
-  return currentSession;
-}
-
-export function getRefs(): RoleRefMap {
-  return currentRefs;
-}
-
-export function setRefs(refs: RoleRefMap): void {
-  currentRefs = refs;
-}
-
-export function getConsoleMessages(): BrowserConsoleMessage[] {
-  return consoleMessages;
-}
-
-export function getNetworkRequests(): BrowserNetworkRequest[] {
-  return networkRequests;
-}
-
-export function getPageErrors(): BrowserPageError[] {
-  return pageErrors;
-}
-
-const defaultPlaywrightLoader = (): Promise<unknown> =>
-  Function('return import("playwright")')() as Promise<unknown>;
-
-let playwrightLoader = defaultPlaywrightLoader;
-
-/**
- * Test seam for injecting a mocked playwright loader.
- * Passing null restores the production loader.
- */
-export function setPlaywrightLoaderForTest(loader: (() => Promise<unknown>) | null): void {
-  playwrightLoader = loader ?? defaultPlaywrightLoader;
-}
-
-// ── Page listener wiring ──────────────────────────────────────────────
-
-const observedPages = new WeakSet<object>();
-
-function wirePageListeners(page: PwPage): void {
-  if (observedPages.has(page as unknown as object)) {
-    return;
-  }
-  observedPages.add(page as unknown as object);
-
-  page.on("console", (...args: unknown[]) => {
-    const msg = args[0] as { type?: () => string; text?: () => string } | undefined;
-    if (!msg) return;
-    const entry: BrowserConsoleMessage = {
-      type: typeof msg.type === "function" ? msg.type() : "log",
-      text: typeof msg.text === "function" ? msg.text() : String(msg),
-      timestamp: new Date().toISOString(),
-    };
-    consoleMessages.push(entry);
-    if (consoleMessages.length > MAX_CONSOLE_MESSAGES) {
-      consoleMessages.shift();
-    }
-  });
-
-  page.on("pageerror", (...args: unknown[]) => {
-    const err = args[0] as Error | undefined;
-    pageErrors.push({
-      message: err?.message ? String(err.message) : String(err),
-      name: err?.name ? String(err.name) : undefined,
-      timestamp: new Date().toISOString(),
-    });
-    if (pageErrors.length > MAX_PAGE_ERRORS) {
-      pageErrors.shift();
-    }
-  });
-
-  page.on("request", (...args: unknown[]) => {
-    const req = args[0] as
-      | {
-          method?: () => string;
-          url?: () => string;
-          resourceType?: () => string;
-        }
-      | undefined;
-    if (!req) return;
-    nextRequestId += 1;
-    const entry: BrowserNetworkRequest = {
-      id: `r${nextRequestId}`,
-      timestamp: new Date().toISOString(),
-      method: typeof req.method === "function" ? req.method() : "GET",
-      url: typeof req.url === "function" ? req.url() : "",
-      resourceType: typeof req.resourceType === "function" ? req.resourceType() : undefined,
-    };
-    networkRequests.push(entry);
-    if (networkRequests.length > MAX_NETWORK_REQUESTS) {
-      networkRequests.shift();
-    }
-  });
-
-  page.on("response", (...args: unknown[]) => {
-    const resp = args[0] as
-      | {
-          url?: () => string;
-          status?: () => number;
-          ok?: () => boolean;
-          request?: () => { url?: () => string };
-        }
-      | undefined;
-    if (!resp) return;
-    const respUrl = typeof resp.url === "function" ? resp.url() : "";
-    // Match by URL (find most recent matching request)
-    for (let i = networkRequests.length - 1; i >= 0; i -= 1) {
-      const rec = networkRequests[i];
-      if (rec && rec.url === respUrl && rec.status === undefined) {
-        rec.status = typeof resp.status === "function" ? resp.status() : undefined;
-        rec.ok = typeof resp.ok === "function" ? resp.ok() : undefined;
-        break;
-      }
-    }
-  });
-
-  page.on("requestfailed", (...args: unknown[]) => {
-    const req = args[0] as
-      | {
-          url?: () => string;
-          failure?: () => { errorText?: string } | null;
-        }
-      | undefined;
-    if (!req) return;
-    const failUrl = typeof req.url === "function" ? req.url() : "";
-    for (let i = networkRequests.length - 1; i >= 0; i -= 1) {
-      const rec = networkRequests[i];
-      if (rec && rec.url === failUrl && rec.ok === undefined) {
-        rec.ok = false;
-        rec.failureText = typeof req.failure === "function" ? req.failure()?.errorText : undefined;
-        break;
-      }
-    }
-  });
-}
-
-// ── Launch / Close ────────────────────────────────────────────────────
-
-type ChromiumLike = {
-  launch: (options?: { headless?: boolean }) => Promise<PwBrowser>;
-};
-
-function isChromiumLike(value: unknown): value is ChromiumLike {
-  return (
-    typeof value === "object" &&
-    value !== null &&
-    typeof (value as { launch?: unknown }).launch === "function"
-  );
-}
-
-/**
- * Resolve Playwright's chromium launcher across module interop shapes.
- * Some runtimes expose `{ chromium }`, others only `{ default: { chromium } }`.
- */
-export function resolveChromiumLauncher(moduleValue: unknown): ChromiumLike {
-  const pw = moduleValue as { chromium?: unknown; default?: { chromium?: unknown } } | null;
-  const chromium = pw?.chromium ?? pw?.default?.chromium;
-  if (isChromiumLike(chromium)) {
-    return chromium;
-  }
-  const keys =
-    pw && typeof pw === "object"
-      ? Object.keys(pw as Record<string, unknown>)
-          .sort()
-          .join(", ")
-      : String(pw);
-  throw new Error(
-    `Invalid playwright module shape: missing chromium.launch (module keys: ${keys || "(none)"}).`,
-  );
-}
-
-/**
- * Launch a new Playwright browser session.
- * Uses dynamic import so the tool module loads even without playwright installed.
- */
-export async function launchBrowser(options?: {
-  headless?: boolean;
-  url?: string;
-}): Promise<BrowserSession> {
-  if (currentSession) {
-    // Already have a session — navigate if URL given, otherwise return existing
-    if (options?.url) {
-      try {
-        await currentSession.page.goto(options.url, DEFAULT_NAVIGATION_OPTIONS);
-      } catch (error) {
-        const message = error instanceof Error ? error.message : String(error);
-        throw new Error(
-          `Navigation to ${options.url} failed: ${message}. Session remains active; use 'snapshot' or retry 'navigate'.`,
-        );
-      }
-    }
-    return currentSession;
-  }
-
-  // Dynamic import: playwright is an optional peer dependency.
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  let pw: any;
-  try {
-    pw = await playwrightLoader();
-  } catch {
-    throw new Error(
-      "playwright is not installed. Run: npx playwright install chromium\n" +
-        "Or: npm install playwright && npx playwright install chromium",
-    );
-  }
-
-  const chromium = resolveChromiumLauncher(pw);
-  const browser = await chromium.launch({
-    headless: options?.headless !== false, // default headless
-  });
-
-  const context = (
-    browser as unknown as { newContext: (opts: unknown) => Promise<PwBrowserContext> }
-  ).newContext
-    ? await (
-        browser as unknown as { newContext: (opts: unknown) => Promise<PwBrowserContext> }
-      ).newContext({
-        viewport: { width: 1280, height: 720 },
-        userAgent:
-          "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
-      })
-    : (browser.contexts()[0] ??
-      (() => {
-        throw new Error("No browser context available");
-      })());
-
-  const page = (context as unknown as { pages: () => PwPage[] }).pages?.().length
-    ? (context as unknown as { pages: () => PwPage[] }).pages()[0]!
-    : await context.newPage();
-
-  wirePageListeners(page);
-
-  // Persist session state before first navigation so launch+goto timeout
-  // cannot leave the tool in a "no session" state.
-  currentSession = { browser, context, page };
-  currentRefs = {};
-  consoleMessages.length = 0;
-  networkRequests.length = 0;
-  pageErrors.length = 0;
-  nextRequestId = 0;
-
-  if (options?.url) {
-    try {
-      await page.goto(options.url, DEFAULT_NAVIGATION_OPTIONS);
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      throw new Error(
-        `Browser launched, but initial navigation to ${options.url} failed: ${message}. Session remains active; use 'snapshot' or retry 'navigate'.`,
-      );
-    }
-  }
-
-  return currentSession;
-}
-
-/**
- * Close the current browser session and clean up all state.
- */
-export async function closeBrowser(): Promise<void> {
-  const session = currentSession;
-  currentSession = null;
-  currentRefs = {};
-  consoleMessages.length = 0;
-  networkRequests.length = 0;
-  pageErrors.length = 0;
-  nextRequestId = 0;
-
-  if (session) {
-    try {
-      await session.browser.close();
-    } catch {
-      // Best-effort close.
-    }
-  }
-}
-
-// ── Tab management ────────────────────────────────────────────────────
-
-/**
- * List all open tabs (pages) in the current context.
- */
-export function listTabs(): Array<{ index: number; url: string; active: boolean }> {
-  if (!currentSession) {
-    return [];
-  }
-  const pages = currentSession.context.pages();
-  return pages.map((p, i) => ({
-    index: i,
-    url: (p as PwPage).url(),
-    active: p === currentSession!.page,
-  }));
-}
-
-/**
- * Open a new tab, optionally navigating to a URL.
- */
-export async function newTab(url?: string): Promise<{ index: number; url: string }> {
-  if (!currentSession) {
-    const launched = await launchBrowser({ url });
-    return { index: 0, url: launched.page.url() };
-  }
-  const page = await currentSession.context.newPage();
-  wirePageListeners(page as PwPage);
-  currentSession.page = page as PwPage;
-  currentRefs = {};
-
-  if (url) {
-    await (page as PwPage).goto(url, DEFAULT_NAVIGATION_OPTIONS);
-  }
-
-  const pages = currentSession.context.pages();
-  return { index: pages.length - 1, url: (page as PwPage).url() };
-}
-
-/**
- * Switch to a tab by index.
- */
-export async function selectTab(index: number): Promise<{ url: string }> {
-  if (!currentSession) {
-    await launchBrowser();
-  }
-  if (!currentSession) {
-    throw new Error("No tabs open.");
-  }
-  const pages = currentSession.context.pages();
-  if (index < 0 || index >= pages.length) {
-    throw new Error(`Tab index ${index} out of range (0..${pages.length - 1})`);
-  }
-  const page = pages[index] as PwPage;
-  currentSession.page = page;
-  wirePageListeners(page);
-  currentRefs = {};
-  return { url: page.url() };
-}
-
-/**
- * Close a tab by index (defaults to current tab).
- */
-export async function closeTab(index?: number): Promise<void> {
-  if (!currentSession) {
-    throw new Error("No tabs open.");
-  }
-  const pages = currentSession.context.pages();
-  const targetIndex = index ?? pages.indexOf(currentSession.page as never);
-  if (targetIndex < 0 || targetIndex >= pages.length) {
-    throw new Error(`Tab index ${targetIndex} out of range`);
-  }
-
-  const targetPage = pages[targetIndex] as PwPage;
-  await targetPage.close();
-
-  // Update current page if we closed the active one
-  const remaining = currentSession.context.pages();
-  if (!remaining.length) {
-    // All tabs closed — create a fresh one
-    const page = await currentSession.context.newPage();
-    currentSession.page = page as PwPage;
-    wirePageListeners(page as PwPage);
-  } else if (targetPage === currentSession.page) {
-    const newIndex = Math.min(targetIndex, remaining.length - 1);
-    currentSession.page = remaining[newIndex] as PwPage;
-    wirePageListeners(currentSession.page);
-  }
-  currentRefs = {};
-}

package/src/definitions/browser/pw-shared.ts

@@ -1,85 +0,0 @@
-// Originally from OpenClaw (MIT License, Copyright 2025 Peter Steinberger)
-// https://github.com/openclaw/openclaw
-// Modified for ARIA — stripped OpenClaw runtime, rewired to ARIA Tool interface
-
-/**
- * Shared utilities for Playwright-based browser tool functions.
- * Ported from OpenClaw's pw-tools-core.shared.ts.
- */
-
-/**
- * Parse a raw ref string into its canonical "eN" form.
- * Accepts: "e1", "@e1", "ref=e1" -> "e1". Returns null if invalid.
- */
-export function parseRoleRef(raw: string): string | null {
-  const trimmed = raw.trim();
-  if (!trimmed) {
-    return null;
-  }
-  const normalized = trimmed.startsWith("@")
-    ? trimmed.slice(1)
-    : trimmed.startsWith("ref=")
-      ? trimmed.slice(4)
-      : trimmed;
-  return /^e\d+$/.test(normalized) ? normalized : null;
-}
-
-/**
- * Validate and normalize a ref string. Throws if the ref is empty/invalid.
- */
-export function requireRef(value: unknown): string {
-  const raw = typeof value === "string" ? value.trim() : "";
-  const roleRef = raw ? parseRoleRef(raw) : null;
-  const ref = roleRef ?? (raw.startsWith("@") ? raw.slice(1) : raw);
-  if (!ref) {
-    throw new Error("ref is required");
-  }
-  return ref;
-}
-
-/**
- * Clamp a timeout value to a safe range (500ms .. 120s).
- */
-export function normalizeTimeoutMs(timeoutMs: number | undefined, fallback: number): number {
-  return Math.max(500, Math.min(120_000, timeoutMs ?? fallback));
-}
-
-/**
- * Rewrite Playwright errors into messages that guide the LLM to take
- * corrective action (re-snapshot, scroll, etc.).
- */
-export function toAIFriendlyError(error: unknown, selector: string): Error {
-  const message = error instanceof Error ? error.message : String(error);
-
-  if (message.includes("strict mode violation")) {
-    const countMatch = message.match(/resolved to (\d+) elements/);
-    const count = countMatch ? countMatch[1] : "multiple";
-    return new Error(
-      `Selector "${selector}" matched ${count} elements. ` +
-        `Run a new snapshot to get updated refs, or use a different ref.`,
-    );
-  }
-
-  if (
-    (message.includes("Timeout") || message.includes("waiting for")) &&
-    (message.includes("to be visible") || message.includes("not visible"))
-  ) {
-    return new Error(
-      `Element "${selector}" not found or not visible. ` +
-        `Run a new snapshot to see current page elements.`,
-    );
-  }
-
-  if (
-    message.includes("intercepts pointer events") ||
-    message.includes("not visible") ||
-    message.includes("not receive pointer events")
-  ) {
-    return new Error(
-      `Element "${selector}" is not interactable (hidden or covered). ` +
-        `Try scrolling it into view, closing overlays, or re-snapshotting.`,
-    );
-  }
-
-  return error instanceof Error ? error : new Error(message);
-}