browse/dist/lib/driver/commands/mouse.js

Unified Browserbase CLI for browser automation and cloud APIs.

import { z } from "zod";
const ButtonSchema = z.enum(["left", "right", "middle"]).optional();
export const mouseHandlers = {
    async "mouse.click"(manager, params) {
        const { button, clickCount, returnXPath, x, y } = z
            .object({
            button: ButtonSchema,
            clickCount: z.number().int().positive().optional(),
            returnXPath: z.boolean().optional(),
            x: z.number(),
            y: z.number(),
        })
            .parse(params);
        const page = await manager.activePage();
        const xpath = await page.click(x, y, {
            button,
            clickCount,
            returnXpath: returnXPath,
        });
        return returnXPath ? { clicked: true, xpath } : { clicked: true };
    },
    async "mouse.hover"(manager, params) {
        const { returnXPath, x, y } = z
            .object({
            returnXPath: z.boolean().optional(),
            x: z.number(),
            y: z.number(),
        })
            .parse(params);
        const page = await manager.activePage();
        const xpath = await page.hover(x, y, { returnXpath: returnXPath });
        return returnXPath ? { hovered: true, xpath } : { hovered: true };
    },
    async "mouse.scroll"(manager, params) {
        const { deltaX, deltaY, returnXPath, x, y } = z
            .object({
            deltaX: z.number(),
            deltaY: z.number(),
            returnXPath: z.boolean().optional(),
            x: z.number(),
            y: z.number(),
        })
            .parse(params);
        const page = await manager.activePage();
        const xpath = await page.scroll(x, y, deltaX, deltaY, {
            returnXpath: returnXPath,
        });
        return returnXPath ? { scrolled: true, xpath } : { scrolled: true };
    },
    async "mouse.drag"(manager, params) {
        const { button, delay, fromX, fromY, returnXPath, steps, toX, toY } = z
            .object({
            button: ButtonSchema,
            delay: z.number().int().nonnegative().optional(),
            fromX: z.number(),
            fromY: z.number(),
            returnXPath: z.boolean().optional(),
            steps: z.number().int().positive().optional(),
            toX: z.number(),
            toY: z.number(),
        })
            .parse(params);
        const page = await manager.activePage();
        const [fromXpath, toXpath] = await page.dragAndDrop(fromX, fromY, toX, toY, {
            button,
            delay,
            returnXpath: returnXPath,
            steps,
        });
        return returnXPath
            ? { dragged: true, fromXpath, toXpath, xpath: fromXpath }
            : { dragged: true };
    },
};