@aria-cli/tools 1.0.19 → 1.0.31

package/dist-cjs/definitions/browser/browser.js

@@ -0,0 +1,422 @@
+"use strict";
+// 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
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.browserTool = void 0;
+const pw_session_js_1 = require("./pw-session.js");
+const pw_snapshot_js_1 = require("./pw-snapshot.js");
+const pw_interactions_js_1 = require("./pw-interactions.js");
+const pw_state_js_1 = require("./pw-state.js");
+const pw_responses_js_1 = require("./pw-responses.js");
+// ── JSON Schema for the action parameter ──────────────────────────────
+const browserParameterSchema = {
+    type: "object",
+    properties: {
+        action: {
+            type: "string",
+            enum: [
+                "launch",
+                "close",
+                "navigate",
+                "snapshot",
+                "click",
+                "type",
+                "hover",
+                "drag",
+                "select_option",
+                "press_key",
+                "scroll",
+                "evaluate",
+                "screenshot",
+                "get_console",
+                "get_network",
+                "wait",
+                "tab_list",
+                "tab_new",
+                "tab_select",
+                "tab_close",
+                "cookies_get",
+                "cookies_set",
+                "cookies_clear",
+                "upload",
+            ],
+            description: "The browser action to perform. 'launch' is optional; actions auto-start a session when needed. Use 'snapshot' to read page content, refs like [e1] with 'click'/'type'.",
+        },
+        // launch
+        url: { type: "string", description: "URL to navigate to (for launch/navigate/tab_new)" },
+        headless: {
+            type: "boolean",
+            description: "Run browser without visible window (default: true)",
+        },
+        // snapshot
+        interactive: {
+            type: "boolean",
+            description: "Only show interactive elements in snapshot (buttons, links, inputs)",
+        },
+        // click/type/hover/drag/select_option/upload
+        ref: {
+            type: "string",
+            description: "Element ref from snapshot (e.g. 'e1', 'e5')",
+        },
+        text: { type: "string", description: "Text to type (for 'type' action)" },
+        submit: {
+            type: "boolean",
+            description: "Press Enter after typing (for 'type' action)",
+        },
+        slowly: {
+            type: "boolean",
+            description: "Type character by character instead of filling (for 'type' action)",
+        },
+        button: {
+            type: "string",
+            enum: ["left", "right", "middle"],
+            description: "Mouse button (for 'click' action)",
+        },
+        modifiers: {
+            type: "array",
+            items: { type: "string" },
+            description: "Keyboard modifiers (for 'click': Alt, Control, Meta, Shift)",
+        },
+        doubleClick: {
+            type: "boolean",
+            description: "Double-click instead of single click",
+        },
+        startRef: {
+            type: "string",
+            description: "Source element ref (for 'drag' action)",
+        },
+        endRef: {
+            type: "string",
+            description: "Target element ref (for 'drag' action)",
+        },
+        values: {
+            type: "array",
+            items: { type: "string" },
+            description: "Values to select (for 'select_option' action)",
+        },
+        // press_key
+        key: {
+            type: "string",
+            description: "Key to press (for 'press_key': Enter, Tab, Escape, ArrowDown, etc.)",
+        },
+        // scroll
+        direction: {
+            type: "string",
+            enum: ["up", "down"],
+            description: "Scroll direction",
+        },
+        amount: {
+            type: "number",
+            description: "Scroll amount in pixels (default: 500)",
+        },
+        // evaluate
+        script: {
+            type: "string",
+            description: "JavaScript to evaluate in browser context (for 'evaluate' action)",
+        },
+        // get_console
+        level: {
+            type: "string",
+            description: "Minimum console level filter (debug/info/warning/error)",
+        },
+        // get_network
+        filter: {
+            type: "string",
+            description: "URL substring filter for network requests",
+        },
+        // wait
+        selector: {
+            type: "string",
+            description: "CSS selector to wait for (for 'wait' action)",
+        },
+        timeout: {
+            type: "number",
+            description: "Timeout in milliseconds (for 'wait' action)",
+        },
+        // tab_select
+        index: {
+            type: "number",
+            description: "Tab index (for 'tab_select'/'tab_close')",
+        },
+        // cookies_set
+        cookies: {
+            type: "array",
+            items: {
+                type: "object",
+                properties: {
+                    name: { type: "string" },
+                    value: { type: "string" },
+                    domain: { type: "string" },
+                    path: { type: "string" },
+                },
+                required: ["name", "value", "domain"],
+            },
+            description: "Cookies to set (for 'cookies_set' action)",
+        },
+        // upload
+        paths: {
+            type: "array",
+            items: { type: "string" },
+            description: "File paths to upload (for 'upload' action)",
+        },
+    },
+    required: ["action"],
+};
+// ── Helpers ───────────────────────────────────────────────────────────
+function ok(message, data) {
+    return { success: true, message, data };
+}
+function fail(message) {
+    return { success: false, message };
+}
+async function requireSession() {
+    const session = (0, pw_session_js_1.getSession)();
+    if (session) {
+        return session;
+    }
+    return (0, pw_session_js_1.launchBrowser)();
+}
+// ── Action dispatcher ─────────────────────────────────────────────────
+async function executeBrowserAction(input) {
+    const action = input;
+    try {
+        switch (action.action) {
+            // ── Lifecycle ─────────────────────────────────────────────────
+            case "launch": {
+                const session = await (0, pw_session_js_1.launchBrowser)({
+                    headless: action.headless,
+                    url: action.url,
+                });
+                const url = session.page.url();
+                return ok(`Browser launched.${action.url ? ` Navigated to ${url}` : ""}\nUse 'snapshot' to see page content.`, { url });
+            }
+            case "close": {
+                await (0, pw_session_js_1.closeBrowser)();
+                return ok("Browser closed.");
+            }
+            // ── Navigation ────────────────────────────────────────────────
+            case "navigate": {
+                const session = await requireSession();
+                const result = await (0, pw_snapshot_js_1.navigatePage)(session.page, action.url);
+                (0, pw_session_js_1.setRefs)({}); // Refs are stale after navigation
+                return ok(`Navigated to ${result.url}. Use 'snapshot' to see page content.`, result);
+            }
+            // ── Snapshot ──────────────────────────────────────────────────
+            case "snapshot": {
+                const session = await requireSession();
+                const result = await (0, pw_snapshot_js_1.snapshotPage)(session.page, {
+                    interactive: action.interactive,
+                });
+                (0, pw_session_js_1.setRefs)(result.refs);
+                const header = `Page: ${result.title}\nURL: ${result.url}\n` +
+                    `Elements: ${result.stats.refs} total, ${result.stats.interactive} interactive\n\n`;
+                return ok(header + result.snapshot, {
+                    url: result.url,
+                    title: result.title,
+                    stats: result.stats,
+                });
+            }
+            // ── Click ─────────────────────────────────────────────────────
+            case "click": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.clickViaPlaywright)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    ref: action.ref,
+                    doubleClick: action.doubleClick,
+                    button: action.button,
+                    modifiers: action.modifiers,
+                });
+                return ok(`Clicked ${action.ref}. Use 'snapshot' to see updated page.`);
+            }
+            // ── Type ──────────────────────────────────────────────────────
+            case "type": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.typeViaPlaywright)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    ref: action.ref,
+                    text: action.text,
+                    submit: action.submit,
+                    slowly: action.slowly,
+                });
+                return ok(`Typed "${action.text.length > 50 ? action.text.slice(0, 50) + "..." : action.text}" into ${action.ref}.${action.submit ? " Submitted with Enter." : ""}`);
+            }
+            // ── Hover ─────────────────────────────────────────────────────
+            case "hover": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.hoverViaPlaywright)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    ref: action.ref,
+                });
+                return ok(`Hovered over ${action.ref}.`);
+            }
+            // ── Drag ──────────────────────────────────────────────────────
+            case "drag": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.dragViaPlaywright)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    startRef: action.startRef,
+                    endRef: action.endRef,
+                });
+                return ok(`Dragged ${action.startRef} to ${action.endRef}.`);
+            }
+            // ── Select option ─────────────────────────────────────────────
+            case "select_option": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.selectOptionViaPlaywright)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    ref: action.ref,
+                    values: action.values,
+                });
+                return ok(`Selected [${action.values.join(", ")}] in ${action.ref}.`);
+            }
+            // ── Key press ─────────────────────────────────────────────────
+            case "press_key": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.pressKeyViaPlaywright)({
+                    page: session.page,
+                    key: action.key,
+                });
+                return ok(`Pressed key: ${action.key}`);
+            }
+            // ── Scroll ────────────────────────────────────────────────────
+            case "scroll": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.scrollPage)({
+                    page: session.page,
+                    direction: action.direction,
+                    amount: action.amount,
+                });
+                return ok(`Scrolled ${action.direction} ${action.amount ?? 500}px. Use 'snapshot' to see updated content.`);
+            }
+            // ── Evaluate ──────────────────────────────────────────────────
+            case "evaluate": {
+                const session = await requireSession();
+                const result = await (0, pw_interactions_js_1.evaluateViaPlaywright)({
+                    page: session.page,
+                    script: action.script,
+                });
+                const output = result === undefined
+                    ? "undefined"
+                    : typeof result === "string"
+                        ? result
+                        : JSON.stringify(result, null, 2);
+                return ok(output, { result });
+            }
+            // ── Screenshot ────────────────────────────────────────────────
+            case "screenshot": {
+                const session = await requireSession();
+                const buffer = await (0, pw_interactions_js_1.takeScreenshot)({ page: session.page });
+                const base64 = buffer.toString("base64");
+                return ok(`Screenshot taken (${buffer.length} bytes, base64-encoded).`, {
+                    base64,
+                    mimeType: "image/png",
+                });
+            }
+            // ── Console ───────────────────────────────────────────────────
+            case "get_console": {
+                await requireSession();
+                const messages = (0, pw_responses_js_1.filterConsoleMessages)((0, pw_session_js_1.getConsoleMessages)(), action.level);
+                return ok((0, pw_responses_js_1.formatConsoleMessages)(messages), { count: messages.length });
+            }
+            // ── Network ───────────────────────────────────────────────────
+            case "get_network": {
+                await requireSession();
+                const requests = (0, pw_responses_js_1.filterNetworkRequests)((0, pw_session_js_1.getNetworkRequests)(), action.filter);
+                return ok((0, pw_responses_js_1.formatNetworkRequests)(requests), { count: requests.length });
+            }
+            // ── Wait ──────────────────────────────────────────────────────
+            case "wait": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.waitForCondition)({
+                    page: session.page,
+                    selector: action.selector,
+                    text: action.text,
+                    timeout: action.timeout,
+                });
+                return ok("Wait condition satisfied. Use 'snapshot' to see current page.");
+            }
+            // ── Tab management ────────────────────────────────────────────
+            case "tab_list": {
+                const tabs = (0, pw_session_js_1.listTabs)();
+                const desc = tabs
+                    .map((t) => `[${t.index}]${t.active ? " (active)" : ""} ${t.url}`)
+                    .join("\n");
+                return ok(desc || "No tabs open.", { tabs });
+            }
+            case "tab_new": {
+                const result = await (0, pw_session_js_1.newTab)(action.url);
+                return ok(`Opened new tab [${result.index}]: ${result.url}`, result);
+            }
+            case "tab_select": {
+                await requireSession();
+                const result = await (0, pw_session_js_1.selectTab)(action.index);
+                return ok(`Switched to tab ${action.index}: ${result.url}`, result);
+            }
+            case "tab_close": {
+                await (0, pw_session_js_1.closeTab)(action.index);
+                return ok(`Tab closed.${action.index !== undefined ? ` (index ${action.index})` : ""}`);
+            }
+            // ── Cookies ───────────────────────────────────────────────────
+            case "cookies_get": {
+                const session = await requireSession();
+                const result = await (0, pw_state_js_1.cookiesGet)(session.context);
+                const desc = result.cookies.length
+                    ? result.cookies.map((c) => `${c.name}=${c.value} (${c.domain})`).join("\n")
+                    : "No cookies.";
+                return ok(desc, result);
+            }
+            case "cookies_set": {
+                const session = await requireSession();
+                await (0, pw_state_js_1.cookiesSet)(session.context, action.cookies);
+                return ok(`Set ${action.cookies.length} cookie(s).`);
+            }
+            case "cookies_clear": {
+                const session = await requireSession();
+                await (0, pw_state_js_1.cookiesClear)(session.context);
+                return ok("All cookies cleared.");
+            }
+            // ── Upload ────────────────────────────────────────────────────
+            case "upload": {
+                const session = await requireSession();
+                await (0, pw_interactions_js_1.uploadFiles)({
+                    page: session.page,
+                    refs: (0, pw_session_js_1.getRefs)(),
+                    ref: action.ref,
+                    paths: action.paths,
+                });
+                return ok(`Uploaded ${action.paths.length} file(s) to ${action.ref}.`);
+            }
+            default: {
+                const exhaustive = action;
+                return fail(`Unknown browser action: ${exhaustive.action}`);
+            }
+        }
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        return fail(message);
+    }
+}
+// ── Tool definition ───────────────────────────────────────────────────
+exports.browserTool = {
+    name: "browser",
+    description: "Control a web browser via Playwright. Supports navigation, clicking, typing, taking snapshots of page content, and more. " +
+        "Actions auto-start a browser session; use 'launch' only when you want explicit startup control. Use 'snapshot' to see the current page state as an accessibility tree with element refs like [e1], [e2]. " +
+        "Use those refs with 'click', 'type', 'hover', etc. to interact with elements. " +
+        "Use 'evaluate' to run JavaScript in the page context. Use 'screenshot' to capture the page visually.",
+    category: "web",
+    parameters: browserParameterSchema,
+    riskLevel: "moderate",
+    isReadOnly: false,
+    loadingTier: "always",
+    async execute(input, _context) {
+        return executeBrowserAction(input);
+    },
+};
+//# sourceMappingURL=browser.js.map

package/dist-cjs/definitions/browser/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// 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
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.browserTool = void 0;
+var browser_js_1 = require("./browser.js");
+Object.defineProperty(exports, "browserTool", { enumerable: true, get: function () { return browser_js_1.browserTool; } });
+//# sourceMappingURL=index.js.map

package/dist-cjs/definitions/browser/pw-downloads.js

@@ -0,0 +1,118 @@
+"use strict";
+// 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
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForDownload = waitForDownload;
+/**
+ * File upload and download handling.
+ * Ported from OpenClaw's pw-tools-core.downloads.ts.
+ *
+ * Note: Upload is handled in pw-interactions.ts via setInputFiles.
+ * This module provides download capture via page "download" event.
+ */
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+const promises_1 = require("node:fs/promises");
+const node_crypto_1 = require("node:crypto");
+const pw_shared_js_1 = require("./pw-shared.js");
+// ── Filename sanitization ─────────────────────────────────────────────
+function sanitizeDownloadFileName(fileName) {
+    const trimmed = String(fileName ?? "").trim();
+    if (!trimmed) {
+        return "download.bin";
+    }
+    // Force a basename so path separators/traversal can't escape the downloads dir.
+    let base = (0, node_path_1.basename)(trimmed);
+    let cleaned = "";
+    for (let i = 0; i < base.length; i++) {
+        const code = base.charCodeAt(i);
+        if (code < 0x20 || code === 0x7f) {
+            continue;
+        }
+        cleaned += base[i];
+    }
+    base = cleaned.trim();
+    if (!base || base === "." || base === "..") {
+        return "download.bin";
+    }
+    if (base.length > 200) {
+        base = base.slice(0, 200);
+    }
+    return base;
+}
+function buildTempDownloadPath(fileName) {
+    const id = (0, node_crypto_1.randomUUID)();
+    const safeName = sanitizeDownloadFileName(fileName);
+    return (0, node_path_1.join)((0, node_os_1.tmpdir)(), "aria-downloads", `${id}-${safeName}`);
+}
+// ── Download waiter ───────────────────────────────────────────────────
+function createPageDownloadWaiter(page, timeoutMs) {
+    let done = false;
+    let timer;
+    let handler;
+    const cleanup = () => {
+        if (timer) {
+            clearTimeout(timer);
+        }
+        timer = undefined;
+        if (handler) {
+            page.off("download", handler);
+            handler = undefined;
+        }
+    };
+    const promise = new Promise((resolveP, reject) => {
+        handler = (download) => {
+            if (done) {
+                return;
+            }
+            done = true;
+            cleanup();
+            resolveP(download);
+        };
+        page.on("download", handler);
+        timer = setTimeout(() => {
+            if (done) {
+                return;
+            }
+            done = true;
+            cleanup();
+            reject(new Error("Timeout waiting for download"));
+        }, timeoutMs);
+    });
+    return {
+        promise,
+        cancel: () => {
+            if (done) {
+                return;
+            }
+            done = true;
+            cleanup();
+        },
+    };
+}
+// ── Public API ────────────────────────────────────────────────────────
+/**
+ * Wait for the next download event on the page and save the file.
+ */
+async function waitForDownload(opts) {
+    const timeout = (0, pw_shared_js_1.normalizeTimeoutMs)(opts.timeoutMs, 120_000);
+    const waiter = createPageDownloadWaiter(opts.page, timeout);
+    try {
+        const download = (await waiter.promise);
+        const suggested = download.suggestedFilename?.() || "download.bin";
+        const outPath = opts.path?.trim() || buildTempDownloadPath(suggested);
+        await (0, promises_1.mkdir)((0, node_path_1.dirname)(outPath), { recursive: true });
+        await download.saveAs?.(outPath);
+        return {
+            url: download.url?.() || "",
+            suggestedFilename: suggested,
+            path: (0, node_path_1.resolve)(outPath),
+        };
+    }
+    catch (err) {
+        waiter.cancel();
+        throw err;
+    }
+}
+//# sourceMappingURL=pw-downloads.js.map