@hyperbrowser/sdk 0.35.0 → 0.36.0

package/dist/tools/anthropic.d.ts

@@ -32,6 +32,7 @@ export interface Tool {
     description?: string;
 }
 export declare const SCRAPE_TOOL_ANTHROPIC: Tool;
+export declare const SCREENSHOT_TOOL_ANTHROPIC: Tool;
 export declare const CRAWL_TOOL_ANTHROPIC: Tool;
 export declare const EXTRACT_TOOL_ANTHROPIC: Tool;
 export declare const BROWSER_USE_TOOL_ANTHROPIC: Tool;

package/dist/tools/anthropic.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_TOOL_ANTHROPIC = exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
+exports.BROWSER_USE_TOOL_ANTHROPIC = exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCREENSHOT_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_ANTHROPIC = {
     input_schema: schema_1.SCRAPE_SCHEMA,
     name: "scrape_webpage",
     description: "Scrape content from a webpage and return the content in markdown format",
 };
+exports.SCREENSHOT_TOOL_ANTHROPIC = {
+    name: "screenshot_webpage",
+    description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+    input_schema: schema_1.SCREENSHOT_SCHEMA,
+};
 exports.CRAWL_TOOL_ANTHROPIC = {
     input_schema: schema_1.CRAWL_SCHEMA,
     name: "crawl_website",

package/dist/tools/index.d.ts

@@ -6,6 +6,11 @@ export declare class WebsiteScrapeTool {
     static anthropicToolDefinition: import("./anthropic").Tool;
     static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
 }
+export declare class WebsiteScreenshotTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
+}
 export declare class WebsiteCrawlTool {
     static openaiToolDefinition: import("./openai").ChatCompletionTool;
     static anthropicToolDefinition: import("./anthropic").Tool;

package/dist/tools/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BrowserUseTool = exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScrapeTool = void 0;
+exports.BrowserUseTool = exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScreenshotTool = exports.WebsiteScrapeTool = void 0;
 const openai_1 = require("./openai");
 const anthropic_1 = require("./anthropic");
 class WebsiteScrapeTool {
@@ -12,6 +12,15 @@ class WebsiteScrapeTool {
 exports.WebsiteScrapeTool = WebsiteScrapeTool;
 WebsiteScrapeTool.openaiToolDefinition = openai_1.SCRAPE_TOOL_OPENAI;
 WebsiteScrapeTool.anthropicToolDefinition = anthropic_1.SCRAPE_TOOL_ANTHROPIC;
+class WebsiteScreenshotTool {
+    static async runnable(hb, params) {
+        const resp = await hb.scrape.startAndWait(params);
+        return resp.data?.screenshot || "";
+    }
+}
+exports.WebsiteScreenshotTool = WebsiteScreenshotTool;
+WebsiteScreenshotTool.openaiToolDefinition = openai_1.SCREENSHOT_TOOL_OPENAI;
+WebsiteScreenshotTool.anthropicToolDefinition = anthropic_1.SCREENSHOT_TOOL_ANTHROPIC;
 class WebsiteCrawlTool {
     static async runnable(hb, params) {
         const resp = await hb.crawl.startAndWait(params);

package/dist/tools/openai.d.ts

@@ -37,6 +37,7 @@ export interface ChatCompletionTool {
     type: "function";
 }
 export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
+export declare const SCREENSHOT_TOOL_OPENAI: ChatCompletionTool;
 export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;
 export declare const EXTRACT_TOOL_OPENAI: ChatCompletionTool;
 export declare const BROWSER_USE_TOOL_OPENAI: ChatCompletionTool;

package/dist/tools/openai.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_TOOL_OPENAI = exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+exports.BROWSER_USE_TOOL_OPENAI = exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCREENSHOT_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_OPENAI = {
     type: "function",
@@ -11,6 +11,15 @@ exports.SCRAPE_TOOL_OPENAI = {
         strict: true,
     },
 };
+exports.SCREENSHOT_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "screenshot_webpage",
+        description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+        parameters: schema_1.SCREENSHOT_SCHEMA,
+        strict: true,
+    },
+};
 exports.CRAWL_TOOL_OPENAI = {
     type: "function",
     function: {

package/dist/tools/schema.d.ts

@@ -1,30 +1,49 @@
-export declare const SCRAPE_OPTIONS: {
-    type: string;
-    description: string;
+export declare const SCRAPE_SCHEMA: {
+    type: "object";
     properties: {
-        includeTags: {
-            type: string;
-            items: {
-                type: string;
-            };
-            description: string;
-        };
-        excludeTags: {
+        url: {
             type: string;
-            items: {
-                type: string;
-            };
             description: string;
         };
-        onlyMainContent: {
+        scrapeOptions: {
             type: string;
             description: string;
+            properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
+                includeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                excludeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                onlyMainContent: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
         };
     };
     required: string[];
     additionalProperties: boolean;
 };
-export declare const SCRAPE_SCHEMA: {
+export declare const SCREENSHOT_SCHEMA: {
     type: "object";
     properties: {
         url: {
@@ -35,6 +54,14 @@ export declare const SCRAPE_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {
@@ -98,6 +125,14 @@ export declare const CRAWL_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {

package/dist/tools/schema.js

@@ -1,40 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_SCHEMA = exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCRAPE_SCHEMA = exports.SCRAPE_OPTIONS = void 0;
-exports.SCRAPE_OPTIONS = {
-    type: "object",
-    description: "The options for the scrape",
-    properties: {
-        includeTags: {
-            type: "array",
-            items: {
-                type: "string",
+exports.BROWSER_USE_SCHEMA = exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCREENSHOT_SCHEMA = exports.SCRAPE_SCHEMA = void 0;
+function getScrapeOptions(formats = ["markdown"]) {
+    return {
+        type: "object",
+        description: "The options for the scrape",
+        properties: {
+            formats: {
+                type: "array",
+                description: "The format of the content to scrape",
+                items: {
+                    type: "string",
+                    enum: formats,
+                },
             },
-            description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
-        },
-        excludeTags: {
-            type: "array",
-            items: {
-                type: "string",
+            includeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
+            },
+            excludeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
+            },
+            onlyMainContent: {
+                type: "boolean",
+                description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
             },
-            description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
         },
-        onlyMainContent: {
-            type: "boolean",
-            description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
+        required: ["includeTags", "excludeTags", "onlyMainContent", "formats"],
+        additionalProperties: false,
+    };
+}
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
         },
+        scrapeOptions: getScrapeOptions(),
     },
-    required: ["includeTags", "excludeTags", "onlyMainContent"],
+    required: ["url", "scrapeOptions"],
     additionalProperties: false,
 };
-exports.SCRAPE_SCHEMA = {
+exports.SCREENSHOT_SCHEMA = {
     type: "object",
     properties: {
         url: {
             type: "string",
             description: "The URL of the website to scrape",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(["screenshot"]),
     },
     required: ["url", "scrapeOptions"],
     additionalProperties: false,
@@ -72,7 +94,7 @@ exports.CRAWL_SCHEMA = {
             },
             description: "An array of regular expressions or wildcard patterns specifying which URLs should be included in the crawl. Only pages whose URLs' path match one of these path patterns will be visited. Example: ['/admin', '/careers/*']",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(),
     },
     required: [
         "url",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",