@hyperbrowser/sdk 0.7.0 → 0.9.0

package/README.md

@@ -14,7 +14,7 @@ npm install @hyperbrowser/sdk
 
 ```typescript
 import { connect } from "puppeteer-core";
-import Hyperbrowser from "hyperbrowser";
+import { Hyperbrowser } from "@hyperbrowser/sdk";
 import dotenv from "dotenv";
 
 dotenv.config();
@@ -24,7 +24,7 @@ const client = new Hyperbrowser({
 });
 
 (async () => {
-  const session = await client.createSession();
+  const session = await client.sessions.create();
 
   const browser = await connect({
     browserWSEndpoint: session.wsEndpoint,
@@ -43,6 +43,6 @@ const client = new Hyperbrowser({
   await page.close();
   await browser.close();
   console.log("Session completed!");
-  await client.stopSession(session.id);
+  await client.sessions.stop(session.id);
 })().catch((error) => console.error(error.message));
 ```

package/dist/client.d.ts

@@ -1,38 +1,14 @@
-import { Response } from "node-fetch";
 import { HyperbrowserConfig } from "./types/config";
-import { BasicResponse, CreateSessionParams, SessionDetail, SessionListParams, SessionListResponse } from "./types/session";
-import { ScrapeJobResponse, StartScrapeJobParams, StartScrapeJobResponse } from "./types/scrape";
-import { CrawlJobResponse, GetCrawlJobParams, StartCrawlJobParams, StartCrawlJobResponse } from "./types/crawl";
+import { SessionsService } from "./services/sessions";
+import { ScrapeService } from "./services/scrape";
+import { CrawlService } from "./services/crawl";
 export declare class HyperbrowserError extends Error {
     statusCode?: number | undefined;
-    response?: Response | undefined;
-    originalError?: Error | undefined;
-    constructor(message: string, statusCode?: number | undefined, response?: Response | undefined, originalError?: Error | undefined);
+    constructor(message: string, statusCode?: number | undefined);
 }
 export declare class HyperbrowserClient {
-    private readonly apiKey;
-    private readonly baseUrl;
+    readonly sessions: SessionsService;
+    readonly scrape: ScrapeService;
+    readonly crawl: CrawlService;
     constructor(config: HyperbrowserConfig);
-    private request;
-    /**
-     * Create a new browser session
-     * @param params Configuration parameters for the new session
-     */
-    createSession(params?: CreateSessionParams): Promise<SessionDetail>;
-    /**
-     * Get details of an existing session
-     */
-    getSession(id: string): Promise<SessionDetail>;
-    /**
-     * Stop a running session
-     */
-    stopSession(id: string): Promise<BasicResponse>;
-    /**
-     * List all sessions with optional filtering
-     */
-    listSessions(params?: SessionListParams): Promise<SessionListResponse>;
-    startScrapeJob(params: StartScrapeJobParams): Promise<StartScrapeJobResponse>;
-    getScrapeJob(id: string): Promise<ScrapeJobResponse>;
-    startCrawlJob(params: StartCrawlJobParams): Promise<StartCrawlJobResponse>;
-    getCrawlJob(id: string, params?: GetCrawlJobParams): Promise<CrawlJobResponse>;
 }

package/dist/client.js

@@ -1,193 +1,27 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HyperbrowserClient = exports.HyperbrowserError = void 0;
-const node_fetch_1 = __importDefault(require("node-fetch"));
+const sessions_1 = require("./services/sessions");
+const scrape_1 = require("./services/scrape");
+const crawl_1 = require("./services/crawl");
 class HyperbrowserError extends Error {
-    constructor(message, statusCode, response, originalError) {
+    constructor(message, statusCode) {
         super(`[Hyperbrowser]: ${message}`);
         this.statusCode = statusCode;
-        this.response = response;
-        this.originalError = originalError;
         this.name = "HyperbrowserError";
     }
 }
 exports.HyperbrowserError = HyperbrowserError;
 class HyperbrowserClient {
     constructor(config) {
-        this.apiKey = config.apiKey;
-        this.baseUrl = config.baseUrl || "https://app.hyperbrowser.ai";
-        if (!this.apiKey) {
+        const apiKey = config.apiKey;
+        const baseUrl = config.baseUrl || "https://app.hyperbrowser.ai";
+        if (!apiKey) {
             throw new HyperbrowserError("API key is required");
         }
-    }
-    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 response = await (0, node_fetch_1.default)(url.toString(), {
-                ...init,
-                headers: {
-                    "x-api-key": this.apiKey,
-                    "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 HyperbrowserError(errorMessage, response.status, response);
-            }
-            if (response.headers.get("content-length") === "0") {
-                return {};
-            }
-            try {
-                return (await response.json());
-            }
-            catch (error) {
-                throw new HyperbrowserError("Failed to parse JSON response", response.status, response, error instanceof Error ? error : undefined);
-            }
-        }
-        catch (error) {
-            // If it's already a HyperbrowserError, rethrow it
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            // Convert other errors to HyperbrowserError
-            throw new HyperbrowserError(error instanceof Error ? error.message : "Unknown error occurred", undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    /**
-     * Create a new browser session
-     * @param params Configuration parameters for the new session
-     */
-    async createSession(params) {
-        try {
-            return await this.request("/session", {
-                method: "POST",
-                body: params ? JSON.stringify(params) : undefined,
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError("Failed to create session", undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    /**
-     * Get details of an existing session
-     */
-    async getSession(id) {
-        try {
-            return await this.request(`/session/${id}`);
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError(`Failed to get session ${id}`, undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    /**
-     * Stop a running session
-     */
-    async stopSession(id) {
-        try {
-            return await this.request(`/session/${id}/stop`, {
-                method: "PUT",
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError(`Failed to stop session ${id}`, undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    /**
-     * List all sessions with optional filtering
-     */
-    async listSessions(params = {}) {
-        try {
-            return await this.request("/sessions", undefined, {
-                status: params.status,
-                page: params.page,
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError("Failed to list sessions", undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    async startScrapeJob(params) {
-        try {
-            return await this.request("/scrape", {
-                method: "POST",
-                body: JSON.stringify(params),
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError("Failed to start scrape job", undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    async getScrapeJob(id) {
-        try {
-            return await this.request(`/scrape/${id}`);
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError(`Failed to get scrape job ${id}`, undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    async startCrawlJob(params) {
-        try {
-            return await this.request("/crawl", {
-                method: "POST",
-                body: JSON.stringify(params),
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError("Failed to start crawl job", undefined, undefined, error instanceof Error ? error : undefined);
-        }
-    }
-    async getCrawlJob(id, params) {
-        try {
-            return await this.request(`/crawl/${id}`, undefined, {
-                page: params?.page,
-            });
-        }
-        catch (error) {
-            if (error instanceof HyperbrowserError) {
-                throw error;
-            }
-            throw new HyperbrowserError(`Failed to get crawl job ${id}`, undefined, undefined, error instanceof Error ? error : undefined);
-        }
+        this.sessions = new sessions_1.SessionsService(apiKey, baseUrl);
+        this.scrape = new scrape_1.ScrapeService(apiKey, baseUrl);
+        this.crawl = new crawl_1.CrawlService(apiKey, baseUrl);
     }
 }
 exports.HyperbrowserClient = HyperbrowserClient;

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,11 +14,18 @@ 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.HyperbrowserError = exports.default = void 0;
-var client_1 = require("./client");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return client_1.HyperbrowserClient; } });
+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; } });
-module.exports = require("./client").HyperbrowserClient;
-module.exports.default = module.exports;
+// 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,7 @@
+import { RequestInit } from "node-fetch";
+export declare class BaseService {
+    protected readonly apiKey: string;
+    protected readonly baseUrl: string;
+    constructor(apiKey: string, baseUrl: string);
+    protected request<T>(path: string, init?: RequestInit, params?: Record<string, string | number | undefined>): Promise<T>;
+}

package/dist/services/base.js

@@ -0,0 +1,62 @@
+"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) {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl;
+    }
+    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 response = await (0, node_fetch_1.default)(url.toString(), {
+                ...init,
+                headers: {
+                    "x-api-key": this.apiKey,
+                    "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/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/types/constants.d.ts

@@ -1,5 +1,7 @@
+export type ScrapeFormat = "markdown" | "html" | "links";
 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";

package/dist/types/crawl.d.ts

@@ -1,12 +1,15 @@
-import { CrawlJobStatus } from "./constants";
+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[];
-    useProxy?: boolean;
-    solveCaptchas?: boolean;
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
 }
 export interface StartCrawlJobResponse {
     jobId: string;
@@ -15,24 +18,17 @@ export interface GetCrawlJobParams {
     page?: number;
     batchSize?: number;
 }
-export interface CrawledPageMetadata {
-    title: string;
-    description: string;
-    robots: string;
-    ogTitle: string;
-    ogDescription: string;
-    ogUrl: string;
-    ogImage: string;
-    ogLocaleAlternate: string[];
-    ogSiteName: string;
-    sourceURL: string;
-}
 export interface CrawledPage {
     url: string;
-    metadata: CrawledPageMetadata;
-    markdown: string;
+    status: CrawlPageStatus;
+    error?: string | null;
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
 }
 export interface CrawlJobResponse {
+    jobId: string;
     status: CrawlJobStatus;
     data?: CrawledPage[];
     error?: string;

package/dist/types/index.d.ts

@@ -1 +1,5 @@
-export * from ".";
+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 { ScrapeJobStatus, CrawlJobStatus, Country, ISO639_1, OperatingSystem, Platform, } from "./constants";

package/dist/types/index.js

@@ -1,17 +1,2 @@
 "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 });
-__exportStar(require("."), exports);

package/dist/types/scrape.d.ts

@@ -1,29 +1,29 @@
-import { ScrapeJobStatus } from "./constants";
+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;
-    useProxy?: boolean;
-    solveCaptchas?: boolean;
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
 }
 export interface StartScrapeJobResponse {
     jobId: string;
 }
-export interface ScrapeJobMetadata {
-    title: string;
-    description: string;
-    robots: string;
-    ogTitle: string;
-    ogDescription: string;
-    ogUrl: string;
-    ogImage: string;
-    ogLocaleAlternate: string[];
-    ogSiteName: string;
-    sourceURL: string;
-}
 export interface ScrapeJobData {
-    metadata: ScrapeJobMetadata;
-    markdown: string;
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
 }
 export interface ScrapeJobResponse {
+    jobId: string;
     status: ScrapeJobStatus;
     data?: ScrapeJobData;
     error?: string;

package/dist/types/session.d.ts

@@ -12,6 +12,7 @@ export interface Session {
     createdAt: string;
     updatedAt: string;
     sessionUrl: string;
+    token: string;
 }
 export interface SessionDetail extends Session {
     wsEndpoint?: string;
@@ -46,4 +47,11 @@ export interface CreateSessionParams {
     adblock?: boolean;
     trackers?: boolean;
     annoyances?: boolean;
+    enableWebRecording?: boolean;
+}
+export interface SessionRecording {
+    type: number;
+    data: unknown;
+    timestamp: number;
+    delay?: number;
 }

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.7.0",
+  "version": "0.9.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",