@hyperbrowser/sdk 0.15.0 → 0.16.0

package/dist/client.js

@@ -16,11 +16,11 @@ class HyperbrowserError extends Error {
 exports.HyperbrowserError = HyperbrowserError;
 class HyperbrowserClient {
     constructor(config) {
-        const apiKey = config.apiKey;
+        const apiKey = config.apiKey || process.env["HYPERBROWSER_API_KEY"];
         const baseUrl = config.baseUrl || "https://app.hyperbrowser.ai";
         const timeout = config.timeout || 30000;
         if (!apiKey) {
-            throw new HyperbrowserError("API key is required");
+            throw new HyperbrowserError("API key is required - either pass it in config or set HYPERBROWSER_API_KEY environment variable");
         }
         this.sessions = new sessions_1.SessionsService(apiKey, baseUrl, timeout);
         this.scrape = new scrape_1.ScrapeService(apiKey, baseUrl, timeout);

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { HyperbrowserClient } from "./client";
-export * from "./types";
 export { HyperbrowserError } from "./client";
 export declare const Hyperbrowser: typeof HyperbrowserClient;
 export default HyperbrowserClient;

package/dist/index.js

@@ -1,22 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Hyperbrowser = exports.HyperbrowserError = void 0;
 const client_1 = require("./client");
-__exportStar(require("./types"), exports);
 var client_2 = require("./client");
 Object.defineProperty(exports, "HyperbrowserError", { enumerable: true, get: function () { return client_2.HyperbrowserError; } });
 // Export HyperbrowserClient as Hyperbrowser for named imports

package/dist/tools/anthropic.d.ts

@@ -0,0 +1,35 @@
+export interface CacheControlEphemeral {
+    type: "ephemeral";
+}
+export interface InputSchema {
+    type: "object";
+    properties?: unknown | null;
+    [k: string]: unknown;
+}
+export interface Tool {
+    /**
+     * [JSON schema](https://json-schema.org/) for this tool's input.
+     *
+     * This defines the shape of the `input` that your tool accepts and that the model
+     * will produce.
+     */
+    input_schema: InputSchema;
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in tool_use blocks.
+     */
+    name: string;
+    cache_control?: CacheControlEphemeral | null;
+    /**
+     * Description of what this tool does.
+     *
+     * Tool descriptions should be as detailed as possible. The more information that
+     * the model has about what the tool is and how to use it, the better it will
+     * perform. You can use natural language descriptions to reinforce important
+     * aspects of the tool input JSON schema.
+     */
+    description?: string;
+}
+export declare const SCRAPE_TOOL_ANTHROPIC: Tool;
+export declare const CRAWL_TOOL_ANTHROPIC: Tool;

package/dist/tools/anthropic.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_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.CRAWL_TOOL_ANTHROPIC = {
+    input_schema: schema_1.CRAWL_SCHEMA,
+    name: "crawl_website",
+    description: "Crawl a website and return the content in markdown format",
+};

package/dist/tools/index.d.ts

@@ -0,0 +1,2 @@
+export { SCRAPE_TOOL_OPENAI, CRAWL_TOOL_OPENAI } from "./openai";
+export { SCRAPE_TOOL_ANTHROPIC, CRAWL_TOOL_ANTHROPIC } from "./anthropic";

package/dist/tools/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+var openai_1 = require("./openai");
+Object.defineProperty(exports, "SCRAPE_TOOL_OPENAI", { enumerable: true, get: function () { return openai_1.SCRAPE_TOOL_OPENAI; } });
+Object.defineProperty(exports, "CRAWL_TOOL_OPENAI", { enumerable: true, get: function () { return openai_1.CRAWL_TOOL_OPENAI; } });
+var anthropic_1 = require("./anthropic");
+Object.defineProperty(exports, "SCRAPE_TOOL_ANTHROPIC", { enumerable: true, get: function () { return anthropic_1.SCRAPE_TOOL_ANTHROPIC; } });
+Object.defineProperty(exports, "CRAWL_TOOL_ANTHROPIC", { enumerable: true, get: function () { return anthropic_1.CRAWL_TOOL_ANTHROPIC; } });

package/dist/tools/openai.d.ts

@@ -0,0 +1,40 @@
+export type FunctionParameters = Record<string, unknown>;
+export interface FunctionDefinition {
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+     * underscores and dashes, with a maximum length of 64.
+     */
+    name: string;
+    /**
+     * A description of what the function does, used by the model to choose when and
+     * how to call the function.
+     */
+    description?: string;
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object. See the
+     * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
+     * and the
+     * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+     * documentation about the format.
+     *
+     * Omitting `parameters` defines a function with an empty parameter list.
+     */
+    parameters?: FunctionParameters;
+    /**
+     * Whether to enable strict schema adherence when generating the function call. If
+     * set to true, the model will follow the exact schema defined in the `parameters`
+     * field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
+     * more about Structured Outputs in the
+     * [function calling guide](docs/guides/function-calling).
+     */
+    strict?: boolean | null;
+}
+export interface ChatCompletionTool {
+    function: FunctionDefinition;
+    /**
+     * The type of the tool. Currently, only `function` is supported.
+     */
+    type: "function";
+}
+export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
+export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;

package/dist/tools/openai.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+const schema_1 = require("./schema");
+exports.SCRAPE_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "scrape_webpage",
+        description: "Scrape content from a webpage and return the content in markdown format",
+        parameters: schema_1.SCRAPE_SCHEMA,
+    },
+};
+exports.CRAWL_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "crawl_website",
+        description: "Crawl a website and return the content in markdown format",
+        parameters: schema_1.CRAWL_SCHEMA,
+    },
+};

package/dist/tools/schema.d.ts

@@ -0,0 +1,119 @@
+export declare const SCRAPE_OPTIONS: {
+    type: string;
+    description: string;
+    properties: {
+        include_tags: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        exclude_tags: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        only_main_content: {
+            type: string;
+            description: string;
+        };
+    };
+};
+export declare const SCRAPE_SCHEMA: {
+    type: "object";
+    properties: {
+        url: {
+            type: string;
+            description: string;
+        };
+        scrape_options: {
+            type: string;
+            description: string;
+            properties: {
+                include_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                exclude_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                only_main_content: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export declare const CRAWL_SCHEMA: {
+    type: "object";
+    properties: {
+        url: {
+            type: string;
+            description: string;
+        };
+        max_pages: {
+            type: string;
+            default: number;
+            description: string;
+        };
+        follow_links: {
+            type: string;
+            description: string;
+        };
+        ignore_sitemap: {
+            type: string;
+            description: string;
+        };
+        exclude_patterns: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        include_patterns: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        scrape_options: {
+            type: string;
+            description: string;
+            properties: {
+                include_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                exclude_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                only_main_content: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+    };
+    required: string[];
+};

package/dist/tools/schema.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_SCHEMA = exports.SCRAPE_SCHEMA = exports.SCRAPE_OPTIONS = void 0;
+exports.SCRAPE_OPTIONS = {
+    type: "object",
+    description: "The options for the scrape",
+    properties: {
+        include_tags: {
+            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.",
+        },
+        exclude_tags: {
+            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.",
+        },
+        only_main_content: {
+            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.",
+        },
+    },
+};
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
+        },
+        scrape_options: exports.SCRAPE_OPTIONS,
+    },
+    required: ["url"],
+};
+exports.CRAWL_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to crawl",
+        },
+        max_pages: {
+            type: "number",
+            default: 10,
+            description: "The maximum number of pages to crawl",
+        },
+        follow_links: {
+            type: "boolean",
+            description: "Whether to follow links on the page",
+        },
+        ignore_sitemap: {
+            type: "boolean",
+            description: "Whether to ignore the sitemap",
+        },
+        exclude_patterns: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            description: "An array of regular expressions or wildcard patterns specifying which URLs should be excluded from the crawl. Any pages whose URLs' path match one of these patterns will be skipped. Example: ['/admin', '/careers/*']",
+        },
+        include_patterns: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            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/*']",
+        },
+        scrape_options: exports.SCRAPE_OPTIONS,
+    },
+    required: ["url"],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",
@@ -38,5 +38,25 @@
     "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/types/index.js"
+    },
+    "./tools": {
+      "types": "./dist/tools/index.d.ts",
+      "default": "./dist/tools/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "types": ["./dist/types/index.d.ts"],
+      "tools": ["./dist/tools/index.d.ts"]
+    }
   }
 }