@hyperbrowser/sdk 0.18.0 → 0.19.0

package/dist/client.d.ts

@@ -0,0 +1,18 @@
+import { HyperbrowserConfig } from "./types/config";
+import { SessionsService } from "./services/sessions";
+import { ScrapeService } from "./services/scrape";
+import { CrawlService } from "./services/crawl";
+import { ProfilesService } from "./services/profiles";
+import { ExtensionService } from "./services/extensions";
+export declare class HyperbrowserError extends Error {
+    statusCode?: number | undefined;
+    constructor(message: string, statusCode?: number | undefined);
+}
+export declare class HyperbrowserClient {
+    readonly sessions: SessionsService;
+    readonly scrape: ScrapeService;
+    readonly crawl: CrawlService;
+    readonly profiles: ProfilesService;
+    readonly extensions: ExtensionService;
+    constructor(config: HyperbrowserConfig);
+}

package/dist/client.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HyperbrowserClient = exports.HyperbrowserError = void 0;
+const sessions_1 = require("./services/sessions");
+const scrape_1 = require("./services/scrape");
+const crawl_1 = require("./services/crawl");
+const profiles_1 = require("./services/profiles");
+const extensions_1 = require("./services/extensions");
+class HyperbrowserError extends Error {
+    constructor(message, statusCode) {
+        super(`[Hyperbrowser]: ${message}`);
+        this.statusCode = statusCode;
+        this.name = "HyperbrowserError";
+    }
+}
+exports.HyperbrowserError = HyperbrowserError;
+class HyperbrowserClient {
+    constructor(config) {
+        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 - 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);
+        this.crawl = new crawl_1.CrawlService(apiKey, baseUrl, timeout);
+        this.profiles = new profiles_1.ProfilesService(apiKey, baseUrl, timeout);
+        this.extensions = new extensions_1.ExtensionService(apiKey, baseUrl, timeout);
+    }
+}
+exports.HyperbrowserClient = HyperbrowserClient;

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hyperbrowser = exports.HyperbrowserError = void 0;
+const client_1 = require("./client");
+var client_2 = require("./client");
+Object.defineProperty(exports, "HyperbrowserError", { enumerable: true, get: function () { return client_2.HyperbrowserError; } });
+// Export HyperbrowserClient as Hyperbrowser for named imports
+exports.Hyperbrowser = client_1.HyperbrowserClient;
+exports.default = client_1.HyperbrowserClient;
+// For CommonJS compatibility
+if (typeof module !== "undefined" && module.exports) {
+    module.exports = client_1.HyperbrowserClient;
+    module.exports.Hyperbrowser = client_1.HyperbrowserClient;
+    module.exports.HyperbrowserClient = client_1.HyperbrowserClient;
+    module.exports.default = client_1.HyperbrowserClient;
+}

package/dist/services/base.d.ts

@@ -0,0 +1,8 @@
+import { RequestInit } from "node-fetch";
+export declare class BaseService {
+    protected readonly apiKey: string;
+    protected readonly baseUrl: string;
+    protected readonly timeout: number;
+    constructor(apiKey: string, baseUrl: string, timeout?: number);
+    protected request<T>(path: string, init?: RequestInit, params?: Record<string, string | number | undefined>): Promise<T>;
+}

package/dist/services/base.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseService = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const client_1 = require("../client");
+class BaseService {
+    constructor(apiKey, baseUrl, timeout = 30000) {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+        this.timeout = timeout;
+    }
+    async request(path, init, params) {
+        try {
+            const url = new URL(`${this.baseUrl}/api${path}`);
+            if (params) {
+                Object.entries(params).forEach(([key, value]) => {
+                    if (value !== undefined) {
+                        url.searchParams.append(key, value.toString());
+                    }
+                });
+            }
+            const headerKeys = Object.keys(init?.headers || {});
+            const contentTypeKey = headerKeys.find((key) => key.toLowerCase() === "content-type");
+            const response = await (0, node_fetch_1.default)(url.toString(), {
+                ...init,
+                timeout: this.timeout,
+                headers: {
+                    "x-api-key": this.apiKey,
+                    ...(contentTypeKey && init?.headers
+                        ? { "content-type": init.headers[contentTypeKey] }
+                        : { "content-type": "application/json" }),
+                    ...init?.headers,
+                },
+            });
+            if (!response.ok) {
+                let errorMessage;
+                try {
+                    const errorData = await response.json();
+                    errorMessage =
+                        errorData.message || errorData.error || `HTTP error! status: ${response.status}`;
+                }
+                catch {
+                    errorMessage = `HTTP error! status: ${response.status}`;
+                }
+                throw new client_1.HyperbrowserError(errorMessage, response.status);
+            }
+            if (response.headers.get("content-length") === "0") {
+                return {};
+            }
+            try {
+                return (await response.json());
+            }
+            catch {
+                throw new client_1.HyperbrowserError("Failed to parse JSON response", response.status);
+            }
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(error instanceof Error ? error.message : "Unknown error occurred", undefined);
+        }
+    }
+}
+exports.BaseService = BaseService;

package/dist/services/crawl.d.ts

@@ -0,0 +1,21 @@
+import { CrawlJobResponse, GetCrawlJobParams, StartCrawlJobParams, StartCrawlJobResponse } from "../types/crawl";
+import { BaseService } from "./base";
+export declare class CrawlService extends BaseService {
+    /**
+     * Start a new crawl job
+     * @param params The parameters for the crawl job
+     */
+    start(params: StartCrawlJobParams): Promise<StartCrawlJobResponse>;
+    /**
+     * Get the status of a crawl job
+     * @param id The ID of the crawl job to get
+     * @param params Optional parameters to filter the crawl job
+     */
+    get(id: string, params?: GetCrawlJobParams): Promise<CrawlJobResponse>;
+    /**
+     * Start a crawl job and wait for it to complete
+     * @param params The parameters for the crawl job
+     * @param returnAllPages Whether to return all pages in the crawl job response
+     */
+    startAndWait(params: StartCrawlJobParams, returnAllPages?: boolean): Promise<CrawlJobResponse>;
+}

package/dist/services/crawl.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrawlService = void 0;
+const base_1 = require("./base");
+const utils_1 = require("../utils");
+const client_1 = require("../client");
+class CrawlService extends base_1.BaseService {
+    /**
+     * Start a new crawl job
+     * @param params The parameters for the crawl job
+     */
+    async start(params) {
+        try {
+            return await this.request("/crawl", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to start crawl job", undefined);
+        }
+    }
+    /**
+     * Get the status of a crawl job
+     * @param id The ID of the crawl job to get
+     * @param params Optional parameters to filter the crawl job
+     */
+    async get(id, params) {
+        try {
+            return await this.request(`/crawl/${id}`, undefined, {
+                page: params?.page,
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get crawl job ${id}`, undefined);
+        }
+    }
+    /**
+     * Start a crawl job and wait for it to complete
+     * @param params The parameters for the crawl job
+     * @param returnAllPages Whether to return all pages in the crawl job response
+     */
+    async startAndWait(params, returnAllPages = true) {
+        const job = await this.start(params);
+        const jobId = job.jobId;
+        if (!jobId) {
+            throw new client_1.HyperbrowserError("Failed to start crawl job, could not get job ID");
+        }
+        let jobResponse;
+        while (true) {
+            jobResponse = await this.get(jobId);
+            if (jobResponse.status === "completed" || jobResponse.status === "failed") {
+                break;
+            }
+            await (0, utils_1.sleep)(2000);
+        }
+        if (!returnAllPages) {
+            return jobResponse;
+        }
+        while (jobResponse.currentPageBatch < jobResponse.totalPageBatches) {
+            const tmpJobResponse = await this.get(jobId, {
+                page: jobResponse.currentPageBatch + 1,
+            });
+            if (tmpJobResponse.data) {
+                jobResponse.data?.push(...tmpJobResponse.data);
+            }
+            jobResponse.currentPageBatch = tmpJobResponse.currentPageBatch;
+            jobResponse.totalCrawledPages = tmpJobResponse.totalCrawledPages;
+            jobResponse.totalPageBatches = tmpJobResponse.totalPageBatches;
+            jobResponse.batchSize = tmpJobResponse.batchSize;
+            await (0, utils_1.sleep)(500);
+        }
+        return jobResponse;
+    }
+}
+exports.CrawlService = CrawlService;

package/dist/services/extensions.d.ts

@@ -0,0 +1,13 @@
+import { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse } from "../types/extension";
+import { BaseService } from "./base";
+export declare class ExtensionService extends BaseService {
+    /**
+     * Upload an extension to hyperbrowser
+     * @param params Configuration parameters for the new extension
+     */
+    create(params: CreateExtensionParams): Promise<CreateExtensionResponse>;
+    /**
+     * List all uploaded extensions for the account
+     */
+    list(): Promise<ListExtensionsResponse>;
+}

package/dist/services/extensions.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionService = void 0;
+const client_1 = require("../client");
+const base_1 = require("./base");
+const form_data_1 = __importDefault(require("form-data"));
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+async function checkFileExists(filePath) {
+    try {
+        await promises_1.default.access(filePath, promises_1.default.constants.R_OK);
+        const extension = node_path_1.default.extname(filePath);
+        if (extension !== ".zip") {
+            throw new client_1.HyperbrowserError("Extension file provided is not zipped", undefined);
+        }
+    }
+    catch (err) {
+        if (err instanceof client_1.HyperbrowserError) {
+            throw err;
+        }
+        throw new client_1.HyperbrowserError("Could not find extension file", undefined);
+    }
+}
+class ExtensionService extends base_1.BaseService {
+    /**
+     * Upload an extension to hyperbrowser
+     * @param params Configuration parameters for the new extension
+     */
+    async create(params) {
+        try {
+            await checkFileExists(params.filePath);
+            const form = new form_data_1.default();
+            form.append("file", await promises_1.default.readFile(params.filePath), {
+                filename: node_path_1.default.basename(params.filePath),
+                contentType: "application/zip",
+            });
+            if (params.name) {
+                form.append("name", params.name);
+            }
+            const response = await this.request("/extensions/add", {
+                method: "POST",
+                body: form,
+                headers: form.getHeaders(),
+            });
+            return response;
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to upload extension", undefined);
+        }
+    }
+    /**
+     * List all uploaded extensions for the account
+     */
+    async list() {
+        try {
+            return await this.request("/extensions/list", { method: "GET" });
+        }
+        catch (err) {
+            if (err instanceof client_1.HyperbrowserError) {
+                throw err;
+            }
+            else {
+                throw new client_1.HyperbrowserError("Could not list extensions", undefined);
+            }
+        }
+    }
+}
+exports.ExtensionService = ExtensionService;

package/dist/services/profiles.d.ts

@@ -0,0 +1,19 @@
+import { BaseService } from "./base";
+import { ProfileResponse, CreateProfileResponse } from "../types/profile";
+import { BasicResponse } from "../types";
+export declare class ProfilesService extends BaseService {
+    /**
+     * Create a new profile
+     */
+    create(): Promise<CreateProfileResponse>;
+    /**
+     * Get details of an existing profile
+     * @param id The ID of the profile to get
+     */
+    get(id: string): Promise<ProfileResponse>;
+    /**
+     * Delete an existing profile
+     * @param id The ID of the profile to delete
+     */
+    delete(id: string): Promise<BasicResponse>;
+}

package/dist/services/profiles.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfilesService = void 0;
+const base_1 = require("./base");
+const client_1 = require("../client");
+class ProfilesService extends base_1.BaseService {
+    /**
+     * Create a new profile
+     */
+    async create() {
+        try {
+            return await this.request("/profile", {
+                method: "POST",
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to create profile", undefined);
+        }
+    }
+    /**
+     * Get details of an existing profile
+     * @param id The ID of the profile to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/profile/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get profile ${id}`, undefined);
+        }
+    }
+    /**
+     * Delete an existing profile
+     * @param id The ID of the profile to delete
+     */
+    async delete(id) {
+        try {
+            return await this.request(`/profile/${id}`, {
+                method: "DELETE",
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to delete profile ${id}`, undefined);
+        }
+    }
+}
+exports.ProfilesService = ProfilesService;

package/dist/services/scrape.d.ts

@@ -0,0 +1,19 @@
+import { ScrapeJobResponse, StartScrapeJobParams, StartScrapeJobResponse } from "../types/scrape";
+import { BaseService } from "./base";
+export declare class ScrapeService extends BaseService {
+    /**
+     * Start a new scrape job
+     * @param params The parameters for the scrape job
+     */
+    start(params: StartScrapeJobParams): Promise<StartScrapeJobResponse>;
+    /**
+     * Get the status of a scrape job
+     * @param id The ID of the scrape job to get
+     */
+    get(id: string): Promise<ScrapeJobResponse>;
+    /**
+     * Start a scrape job and wait for it to complete
+     * @param params The parameters for the scrape job
+     */
+    startAndWait(params: StartScrapeJobParams): Promise<ScrapeJobResponse>;
+}

package/dist/services/scrape.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScrapeService = void 0;
+const base_1 = require("./base");
+const utils_1 = require("../utils");
+const client_1 = require("../client");
+class ScrapeService extends base_1.BaseService {
+    /**
+     * Start a new scrape job
+     * @param params The parameters for the scrape job
+     */
+    async start(params) {
+        try {
+            return await this.request("/scrape", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to start scrape job", undefined);
+        }
+    }
+    /**
+     * Get the status of a scrape job
+     * @param id The ID of the scrape job to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/scrape/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get scrape job ${id}`, undefined);
+        }
+    }
+    /**
+     * Start a scrape job and wait for it to complete
+     * @param params The parameters for the scrape job
+     */
+    async startAndWait(params) {
+        const job = await this.start(params);
+        const jobId = job.jobId;
+        if (!jobId) {
+            throw new client_1.HyperbrowserError("Failed to start scrape job, could not get job ID");
+        }
+        let jobResponse;
+        while (true) {
+            jobResponse = await this.get(jobId);
+            if (jobResponse.status === "completed" || jobResponse.status === "failed") {
+                break;
+            }
+            await (0, utils_1.sleep)(2000);
+        }
+        return jobResponse;
+    }
+}
+exports.ScrapeService = ScrapeService;

package/dist/services/sessions.d.ts

@@ -0,0 +1,29 @@
+import { BasicResponse, CreateSessionParams, SessionDetail, SessionListParams, SessionListResponse, SessionRecording } from "../types/session";
+import { BaseService } from "./base";
+export declare class SessionsService extends BaseService {
+    /**
+     * Create a new browser session
+     * @param params Configuration parameters for the new session
+     */
+    create(params?: CreateSessionParams): Promise<SessionDetail>;
+    /**
+     * Get details of an existing session
+     * @param id The ID of the session to get
+     */
+    get(id: string): Promise<SessionDetail>;
+    /**
+     * Stop a running session
+     * @param id The ID of the session to stop
+     */
+    stop(id: string): Promise<BasicResponse>;
+    /**
+     * List all sessions with optional filtering
+     * @param params Optional parameters to filter the sessions
+     */
+    list(params?: SessionListParams): Promise<SessionListResponse>;
+    /**
+     * Get the recording of a session
+     * @param id The ID of the session to get the recording from
+     */
+    getRecording(id: string): Promise<SessionRecording[]>;
+}

package/dist/services/sessions.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionsService = void 0;
+const base_1 = require("./base");
+const client_1 = require("../client");
+class SessionsService extends base_1.BaseService {
+    /**
+     * Create a new browser session
+     * @param params Configuration parameters for the new session
+     */
+    async create(params) {
+        try {
+            return await this.request("/session", {
+                method: "POST",
+                body: params ? JSON.stringify(params) : undefined,
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to create session", undefined);
+        }
+    }
+    /**
+     * Get details of an existing session
+     * @param id The ID of the session to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/session/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get session ${id}`, undefined);
+        }
+    }
+    /**
+     * Stop a running session
+     * @param id The ID of the session to stop
+     */
+    async stop(id) {
+        try {
+            return await this.request(`/session/${id}/stop`, {
+                method: "PUT",
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to stop session ${id}`, undefined);
+        }
+    }
+    /**
+     * List all sessions with optional filtering
+     * @param params Optional parameters to filter the sessions
+     */
+    async list(params = {}) {
+        try {
+            return await this.request("/sessions", undefined, {
+                status: params.status,
+                page: params.page,
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to list sessions", undefined);
+        }
+    }
+    /**
+     * Get the recording of a session
+     * @param id The ID of the session to get the recording from
+     */
+    async getRecording(id) {
+        try {
+            return await this.request(`/session/${id}/recording`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get recording for session ${id}`, undefined);
+        }
+    }
+}
+exports.SessionsService = SessionsService;

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,12 @@
+import { HyperbrowserClient } from "../client";
+import { StartScrapeJobParams, StartCrawlJobParams } from "../types";
+export declare class WebsiteScrapeTool {
+    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;
+    static runnable(hb: HyperbrowserClient, params: StartCrawlJobParams): Promise<string>;
+}

package/dist/tools/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsiteCrawlTool = exports.WebsiteScrapeTool = void 0;
+const openai_1 = require("./openai");
+const anthropic_1 = require("./anthropic");
+class WebsiteScrapeTool {
+    static async runnable(hb, params) {
+        const resp = await hb.scrape.startAndWait(params);
+        return resp.data?.markdown || "";
+    }
+}
+exports.WebsiteScrapeTool = WebsiteScrapeTool;
+WebsiteScrapeTool.openaiToolDefinition = openai_1.SCRAPE_TOOL_OPENAI;
+WebsiteScrapeTool.anthropicToolDefinition = anthropic_1.SCRAPE_TOOL_ANTHROPIC;
+class WebsiteCrawlTool {
+    static async runnable(hb, params) {
+        const resp = await hb.crawl.startAndWait(params);
+        let markdown = "";
+        if (resp.data) {
+            for (const page of resp.data) {
+                if (page.markdown) {
+                    markdown += `\n${"-".repeat(50)}\nUrl: ${page.url}\nMarkdown:\n${page.markdown}\n`;
+                }
+            }
+        }
+        return markdown;
+    }
+}
+exports.WebsiteCrawlTool = WebsiteCrawlTool;
+WebsiteCrawlTool.openaiToolDefinition = openai_1.CRAWL_TOOL_OPENAI;
+WebsiteCrawlTool.anthropicToolDefinition = 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,22 @@
+"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,
+        strict: true,
+    },
+};
+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,
+        strict: true,
+    },
+};

package/dist/tools/schema.d.ts

@@ -0,0 +1,126 @@
+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;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+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[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+export declare const CRAWL_SCHEMA: {
+    type: "object";
+    properties: {
+        url: {
+            type: string;
+            description: string;
+        };
+        max_pages: {
+            type: string;
+            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[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/dist/tools/schema.js

@@ -0,0 +1,87 @@
+"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.",
+        },
+    },
+    required: ["include_tags", "exclude_tags", "only_main_content"],
+    additionalProperties: false,
+};
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
+        },
+        scrape_options: exports.SCRAPE_OPTIONS,
+    },
+    required: ["url", "scrape_options"],
+    additionalProperties: false,
+};
+exports.CRAWL_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to crawl",
+        },
+        max_pages: {
+            type: "number",
+            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",
+        "max_pages",
+        "follow_links",
+        "ignore_sitemap",
+        "exclude_patterns",
+        "include_patterns",
+        "scrape_options",
+    ],
+    additionalProperties: false,
+};

package/dist/types/config.d.ts

@@ -0,0 +1,5 @@
+export interface HyperbrowserConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}

package/dist/types/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/constants.d.ts

@@ -0,0 +1,8 @@
+export type ScrapeFormat = "markdown" | "html" | "links" | "screenshot";
+export type ScrapeJobStatus = "pending" | "running" | "completed" | "failed";
+export type CrawlJobStatus = "pending" | "running" | "completed" | "failed";
+export type CrawlPageStatus = "completed" | "failed";
+export type Country = "AD" | "AE" | "AF" | "AL" | "AM" | "AO" | "AR" | "AT" | "AU" | "AW" | "AZ" | "BA" | "BD" | "BE" | "BG" | "BH" | "BJ" | "BO" | "BR" | "BS" | "BT" | "BY" | "BZ" | "CA" | "CF" | "CH" | "CI" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "EC" | "EE" | "EG" | "ES" | "ET" | "EU" | "FI" | "FJ" | "FR" | "GB" | "GE" | "GH" | "GM" | "GR" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IN" | "IQ" | "IR" | "IS" | "IT" | "JM" | "JO" | "JP" | "KE" | "KH" | "KR" | "KW" | "KZ" | "LB" | "LI" | "LR" | "LT" | "LU" | "LV" | "MA" | "MC" | "MD" | "ME" | "MG" | "MK" | "ML" | "MM" | "MN" | "MR" | "MT" | "MU" | "MV" | "MX" | "MY" | "MZ" | "NG" | "NL" | "NO" | "NZ" | "OM" | "PA" | "PE" | "PH" | "PK" | "PL" | "PR" | "PT" | "PY" | "QA" | "RANDOM_COUNTRY" | "RO" | "RS" | "RU" | "SA" | "SC" | "SD" | "SE" | "SG" | "SI" | "SK" | "SN" | "SS" | "TD" | "TG" | "TH" | "TM" | "TN" | "TR" | "TT" | "TW" | "UA" | "UG" | "US" | "UY" | "UZ" | "VE" | "VG" | "VN" | "YE" | "ZA" | "ZM" | "ZW" | "ad" | "ae" | "af" | "al" | "am" | "ao" | "ar" | "at" | "au" | "aw" | "az" | "ba" | "bd" | "be" | "bg" | "bh" | "bj" | "bo" | "br" | "bs" | "bt" | "by" | "bz" | "ca" | "cf" | "ch" | "ci" | "cl" | "cm" | "cn" | "co" | "cr" | "cu" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "ec" | "ee" | "eg" | "es" | "et" | "eu" | "fi" | "fj" | "fr" | "gb" | "ge" | "gh" | "gm" | "gr" | "hk" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "in" | "iq" | "ir" | "is" | "it" | "jm" | "jo" | "jp" | "ke" | "kh" | "kr" | "kw" | "kz" | "lb" | "li" | "lr" | "lt" | "lu" | "lv" | "ma" | "mc" | "md" | "me" | "mg" | "mk" | "ml" | "mm" | "mn" | "mr" | "mt" | "mu" | "mv" | "mx" | "my" | "mz" | "ng" | "nl" | "no" | "nz" | "om" | "pa" | "pe" | "ph" | "pk" | "pl" | "pr" | "pt" | "py" | "qa" | "ro" | "rs" | "ru" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sn" | "ss" | "td" | "tg" | "th" | "tm" | "tn" | "tr" | "tt" | "tw" | "ua" | "ug" | "us" | "uy" | "uz" | "ve" | "vg" | "vn" | "ye" | "za" | "zm" | "zw";
+export type OperatingSystem = "windows" | "android" | "macos" | "linux" | "ios";
+export type Platform = "chrome" | "firefox" | "safari" | "edge";
+export type ISO639_1 = "aa" | "ab" | "ae" | "af" | "ak" | "am" | "an" | "ar" | "as" | "av" | "ay" | "az" | "ba" | "be" | "bg" | "bh" | "bi" | "bm" | "bn" | "bo" | "br" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | "cu" | "cv" | "cy" | "da" | "de" | "dv" | "dz" | "ee" | "el" | "en" | "eo" | "es" | "et" | "eu" | "fa" | "ff" | "fi" | "fj" | "fo" | "fr" | "fy" | "ga" | "gd" | "gl" | "gn" | "gu" | "gv" | "ha" | "he" | "hi" | "ho" | "hr" | "ht" | "hu" | "hy" | "hz" | "ia" | "id" | "ie" | "ig" | "ii" | "ik" | "io" | "is" | "it" | "iu" | "ja" | "jv" | "ka" | "kg" | "ki" | "kj" | "kk" | "kl" | "km" | "kn" | "ko" | "kr" | "ks" | "ku" | "kv" | "kw" | "ky" | "la" | "lb" | "lg" | "li" | "ln" | "lo" | "lt" | "lu" | "lv" | "mg" | "mh" | "mi" | "mk" | "ml" | "mn" | "mo" | "mr" | "ms" | "mt" | "my" | "na" | "nb" | "nd" | "ne" | "ng" | "nl" | "nn" | "no" | "nr" | "nv" | "ny" | "oc" | "oj" | "om" | "or" | "os" | "pa" | "pi" | "pl" | "ps" | "pt" | "qu" | "rm" | "rn" | "ro" | "ru" | "rw" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sm" | "sn" | "so" | "sq" | "sr" | "ss" | "st" | "su" | "sv" | "sw" | "ta" | "te" | "tg" | "th" | "ti" | "tk" | "tl" | "tn" | "to" | "tr" | "ts" | "tt" | "tw" | "ty" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "wo" | "xh" | "yi" | "yo" | "za" | "zh" | "zu";

package/dist/types/constants.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/crawl.d.ts

@@ -0,0 +1,40 @@
+import { CrawlJobStatus, CrawlPageStatus } from "./constants";
+import { ScrapeOptions } from "./scrape";
+import { CreateSessionParams } from "./session";
+export interface StartCrawlJobParams {
+    url: string;
+    maxPages?: number;
+    followLinks?: boolean;
+    ignoreSitemap?: boolean;
+    excludePatterns?: string[];
+    includePatterns?: string[];
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
+}
+export interface StartCrawlJobResponse {
+    jobId: string;
+}
+export interface GetCrawlJobParams {
+    page?: number;
+    batchSize?: number;
+}
+export interface CrawledPage {
+    url: string;
+    status: CrawlPageStatus;
+    error?: string | null;
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
+    screenshot?: string;
+}
+export interface CrawlJobResponse {
+    jobId: string;
+    status: CrawlJobStatus;
+    data?: CrawledPage[];
+    error?: string;
+    totalCrawledPages: number;
+    totalPageBatches: number;
+    currentPageBatch: number;
+    batchSize: number;
+}

package/dist/types/crawl.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/extension.d.ts

@@ -0,0 +1,13 @@
+export interface CreateExtensionParams {
+    filePath: string;
+    name?: string;
+}
+interface ExtensionResponse {
+    name: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export type CreateExtensionResponse = ExtensionResponse;
+export type ListExtensionsResponse = Array<ExtensionResponse>;
+export {};

package/dist/types/extension.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export { HyperbrowserConfig } from "./config";
+export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobResponse, GetCrawlJobParams, } from "./crawl";
+export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, } from "./scrape";
+export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, } from "./session";
+export { ProfileResponse, CreateProfileResponse } from "./profile";
+export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
+export { ScrapeJobStatus, CrawlJobStatus, Country, ISO639_1, OperatingSystem, Platform, } from "./constants";

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/profile.d.ts

@@ -0,0 +1,9 @@
+export interface CreateProfileResponse {
+    id: string;
+}
+export interface ProfileResponse {
+    id: string;
+    teamId: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/types/profile.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/scrape.d.ts

@@ -0,0 +1,31 @@
+import { ScrapeFormat, ScrapeJobStatus } from "./constants";
+import { CreateSessionParams } from "./session";
+export interface ScrapeOptions {
+    formats?: ScrapeFormat[];
+    includeTags?: string[];
+    excludeTags?: string[];
+    onlyMainContent?: boolean;
+    waitFor?: number;
+    timeout?: number;
+}
+export interface StartScrapeJobParams {
+    url: string;
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
+}
+export interface StartScrapeJobResponse {
+    jobId: string;
+}
+export interface ScrapeJobData {
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
+    screenshot?: string;
+}
+export interface ScrapeJobResponse {
+    jobId: string;
+    status: ScrapeJobStatus;
+    data?: ScrapeJobData;
+    error?: string;
+}

package/dist/types/scrape.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/session.d.ts

@@ -0,0 +1,64 @@
+import { Country, ISO639_1, OperatingSystem, Platform } from "./constants";
+export type SessionStatus = "active" | "closed" | "error";
+export interface BasicResponse {
+    success: boolean;
+}
+export interface Session {
+    id: string;
+    teamId: string;
+    status: SessionStatus;
+    startTime?: number;
+    endTime?: number;
+    createdAt: string;
+    updatedAt: string;
+    sessionUrl: string;
+    liveUrl?: string;
+    token: string;
+}
+export interface SessionDetail extends Session {
+    wsEndpoint?: string;
+}
+export interface SessionListParams {
+    status?: SessionStatus;
+    page?: number;
+}
+export interface SessionListResponse {
+    sessions: Session[];
+    totalCount: number;
+    page: number;
+    perPage: number;
+}
+export interface ScreenConfig {
+    width: number;
+    height: number;
+}
+export interface CreateSessionProfile {
+    id?: string;
+    persistChanges?: boolean;
+}
+export interface CreateSessionParams {
+    useStealth?: boolean;
+    useProxy?: boolean;
+    proxyServer?: string;
+    proxyServerPassword?: string;
+    proxyServerUsername?: string;
+    proxyCountry?: Country;
+    operatingSystems?: OperatingSystem[];
+    device?: ("desktop" | "mobile")[];
+    platform?: Platform[];
+    locales?: ISO639_1[];
+    screen?: ScreenConfig;
+    solveCaptchas?: boolean;
+    adblock?: boolean;
+    trackers?: boolean;
+    annoyances?: boolean;
+    enableWebRecording?: boolean;
+    profile?: CreateSessionProfile;
+    extensionIds?: Array<string>;
+}
+export interface SessionRecording {
+    type: number;
+    data: unknown;
+    timestamp: number;
+    delay?: number;
+}

package/dist/types/session.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (ms: number) => Promise<unknown>;

package/dist/utils.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+exports.sleep = sleep;

package/package.json

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