@browserless.io/mcp 1.6.0

package/build/src/tools/schemas.d.ts

@@ -0,0 +1,466 @@
+import { z } from 'zod';
+export declare function profileField(whenLoaded: string, extra?: string): z.ZodOptional<z.ZodString>;
+export declare const AgentCommandSchema: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<readonly [z.ZodObject<{
+    method: z.ZodLiteral<"goto">;
+    params: z.ZodObject<{
+        url: z.ZodString;
+        waitUntil: z.ZodOptional<z.ZodEnum<{
+            load: "load";
+            domcontentloaded: "domcontentloaded";
+            networkidle0: "networkidle0";
+            networkidle2: "networkidle2";
+        }>>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"back">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        waitUntil: z.ZodOptional<z.ZodEnum<{
+            load: "load";
+            domcontentloaded: "domcontentloaded";
+            networkidle0: "networkidle0";
+            networkidle2: "networkidle2";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"forward">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        waitUntil: z.ZodOptional<z.ZodEnum<{
+            load: "load";
+            domcontentloaded: "domcontentloaded";
+            networkidle0: "networkidle0";
+            networkidle2: "networkidle2";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"reload">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        waitUntil: z.ZodOptional<z.ZodEnum<{
+            load: "load";
+            domcontentloaded: "domcontentloaded";
+            networkidle0: "networkidle0";
+            networkidle2: "networkidle2";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"snapshot">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        maxElements: z.ZodOptional<z.ZodNumber>;
+        targetId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"getTabs">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"switchTab">;
+    params: z.ZodObject<{
+        targetId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"createTab">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        activate: z.ZodOptional<z.ZodBoolean>;
+        waitUntil: z.ZodOptional<z.ZodEnum<{
+            load: "load";
+            domcontentloaded: "domcontentloaded";
+            networkidle0: "networkidle0";
+            networkidle2: "networkidle2";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"closeTab">;
+    params: z.ZodObject<{
+        targetId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"click">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"type">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"select">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"checkbox">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+        checked: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"hover">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"scroll">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        selector: z.ZodOptional<z.ZodString>;
+        direction: z.ZodOptional<z.ZodEnum<{
+            up: "up";
+            down: "down";
+            left: "left";
+            right: "right";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"evaluate">;
+    params: z.ZodObject<{
+        content: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"text">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        selector: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"html">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        selector: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"waitForSelector">;
+    params: z.ZodObject<{
+        selector: z.ZodString;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"waitForNavigation">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"waitForTimeout">;
+    params: z.ZodObject<{
+        time: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"waitForRequest">;
+    params: z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        method: z.ZodOptional<z.ZodString>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"waitForResponse">;
+    params: z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        statuses: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"liveURL">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        timeout: z.ZodOptional<z.ZodNumber>;
+        interactable: z.ZodOptional<z.ZodBoolean>;
+        quality: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodOptional<z.ZodEnum<{
+            jpeg: "jpeg";
+            png: "png";
+        }>>;
+        resizable: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"solve">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodEnum<{
+            cloudflare: "cloudflare";
+            hcaptcha: "hcaptcha";
+            recaptcha: "recaptcha";
+            recaptchaV3: "recaptchaV3";
+            geetest: "geetest";
+            normal: "normal";
+            friendlyCaptcha: "friendlyCaptcha";
+            capy: "capy";
+            textCaptcha: "textCaptcha";
+            amazonWaf: "amazonWaf";
+            dataDome: "dataDome";
+            akamai: "akamai";
+            lemin: "lemin";
+            mtcaptcha: "mtcaptcha";
+            slider: "slider";
+        }>>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+        wait: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"screenshot">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodEnum<{
+            jpeg: "jpeg";
+            png: "png";
+            webp: "webp";
+        }>>;
+        fullPage: z.ZodOptional<z.ZodBoolean>;
+        selector: z.ZodOptional<z.ZodString>;
+        quality: z.ZodOptional<z.ZodNumber>;
+        omitBackground: z.ZodOptional<z.ZodBoolean>;
+        clip: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            scale: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        waitForImages: z.ZodOptional<z.ZodBoolean>;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>, z.ZodObject<{
+    method: z.ZodLiteral<"close">;
+    params: z.ZodDefault<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+}, z.core.$strip>], "method">, z.ZodObject<{
+    method: z.ZodString;
+    params: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strip>]>;
+export declare const AgentParamsSchema: z.ZodObject<{
+    method: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    params: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    commands: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodDiscriminatedUnion<readonly [z.ZodObject<{
+        method: z.ZodLiteral<"goto">;
+        params: z.ZodObject<{
+            url: z.ZodString;
+            waitUntil: z.ZodOptional<z.ZodEnum<{
+                load: "load";
+                domcontentloaded: "domcontentloaded";
+                networkidle0: "networkidle0";
+                networkidle2: "networkidle2";
+            }>>;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"back">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            waitUntil: z.ZodOptional<z.ZodEnum<{
+                load: "load";
+                domcontentloaded: "domcontentloaded";
+                networkidle0: "networkidle0";
+                networkidle2: "networkidle2";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"forward">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            waitUntil: z.ZodOptional<z.ZodEnum<{
+                load: "load";
+                domcontentloaded: "domcontentloaded";
+                networkidle0: "networkidle0";
+                networkidle2: "networkidle2";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"reload">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            waitUntil: z.ZodOptional<z.ZodEnum<{
+                load: "load";
+                domcontentloaded: "domcontentloaded";
+                networkidle0: "networkidle0";
+                networkidle2: "networkidle2";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"snapshot">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            maxElements: z.ZodOptional<z.ZodNumber>;
+            targetId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"getTabs">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"switchTab">;
+        params: z.ZodObject<{
+            targetId: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"createTab">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            url: z.ZodOptional<z.ZodString>;
+            activate: z.ZodOptional<z.ZodBoolean>;
+            waitUntil: z.ZodOptional<z.ZodEnum<{
+                load: "load";
+                domcontentloaded: "domcontentloaded";
+                networkidle0: "networkidle0";
+                networkidle2: "networkidle2";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"closeTab">;
+        params: z.ZodObject<{
+            targetId: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"click">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"type">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+            text: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"select">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"checkbox">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+            checked: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"hover">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"scroll">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            selector: z.ZodOptional<z.ZodString>;
+            direction: z.ZodOptional<z.ZodEnum<{
+                up: "up";
+                down: "down";
+                left: "left";
+                right: "right";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"evaluate">;
+        params: z.ZodObject<{
+            content: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"text">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            selector: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"html">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            selector: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"waitForSelector">;
+        params: z.ZodObject<{
+            selector: z.ZodString;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"waitForNavigation">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"waitForTimeout">;
+        params: z.ZodObject<{
+            time: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"waitForRequest">;
+        params: z.ZodObject<{
+            url: z.ZodOptional<z.ZodString>;
+            method: z.ZodOptional<z.ZodString>;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"waitForResponse">;
+        params: z.ZodObject<{
+            url: z.ZodOptional<z.ZodString>;
+            statuses: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"liveURL">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            timeout: z.ZodOptional<z.ZodNumber>;
+            interactable: z.ZodOptional<z.ZodBoolean>;
+            quality: z.ZodOptional<z.ZodNumber>;
+            type: z.ZodOptional<z.ZodEnum<{
+                jpeg: "jpeg";
+                png: "png";
+            }>>;
+            resizable: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"solve">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodEnum<{
+                cloudflare: "cloudflare";
+                hcaptcha: "hcaptcha";
+                recaptcha: "recaptcha";
+                recaptchaV3: "recaptchaV3";
+                geetest: "geetest";
+                normal: "normal";
+                friendlyCaptcha: "friendlyCaptcha";
+                capy: "capy";
+                textCaptcha: "textCaptcha";
+                amazonWaf: "amazonWaf";
+                dataDome: "dataDome";
+                akamai: "akamai";
+                lemin: "lemin";
+                mtcaptcha: "mtcaptcha";
+                slider: "slider";
+            }>>;
+            timeout: z.ZodOptional<z.ZodNumber>;
+            wait: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"screenshot">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodEnum<{
+                jpeg: "jpeg";
+                png: "png";
+                webp: "webp";
+            }>>;
+            fullPage: z.ZodOptional<z.ZodBoolean>;
+            selector: z.ZodOptional<z.ZodString>;
+            quality: z.ZodOptional<z.ZodNumber>;
+            omitBackground: z.ZodOptional<z.ZodBoolean>;
+            clip: z.ZodOptional<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+                scale: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strip>>;
+            waitForImages: z.ZodOptional<z.ZodBoolean>;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
+        method: z.ZodLiteral<"close">;
+        params: z.ZodDefault<z.ZodOptional<z.ZodObject<{}, z.core.$strip>>>;
+    }, z.core.$strip>], "method">, z.ZodObject<{
+        method: z.ZodString;
+        params: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    }, z.core.$strip>]>>>;
+    proxy: z.ZodOptional<z.ZodObject<{
+        proxy: z.ZodOptional<z.ZodEnum<{
+            residential: "residential";
+        }>>;
+        proxyCountry: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+        proxyState: z.ZodOptional<z.ZodString>;
+        proxyCity: z.ZodOptional<z.ZodString>;
+        proxySticky: z.ZodOptional<z.ZodBoolean>;
+        proxyLocaleMatch: z.ZodOptional<z.ZodBoolean>;
+        proxyPreset: z.ZodOptional<z.ZodString>;
+        externalProxyServer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    profile: z.ZodOptional<z.ZodString>;
+    rationale: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** A single validated agent command. */
+export type AgentCommand = z.infer<typeof AgentCommandSchema>;
+/** The full `browserless_agent` tool params (single command, batch, proxy, profile). */
+export type AgentParams = z.infer<typeof AgentParamsSchema>;