@hyperbrowser/sdk 0.9.0 → 0.11.0

package/README.md

@@ -1,6 +1,6 @@
-# Hyperbrowser SDK
+# Hyperbrowser Node SDK
 
-A TypeScript/JavaScript SDK for interacting with the Hyperbrowser API.
+Checkout the full documentation [here](https://docs.hyperbrowser.ai/)
 
 ## Installation
 

package/dist/client.d.ts

@@ -2,6 +2,8 @@ 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);
@@ -10,5 +12,7 @@ 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

@@ -4,6 +4,8 @@ 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}`);
@@ -16,12 +18,15 @@ class HyperbrowserClient {
     constructor(config) {
         const apiKey = config.apiKey;
         const baseUrl = config.baseUrl || "https://app.hyperbrowser.ai";
+        const timeout = config.timeout || 30000;
         if (!apiKey) {
             throw new HyperbrowserError("API key is required");
         }
-        this.sessions = new sessions_1.SessionsService(apiKey, baseUrl);
-        this.scrape = new scrape_1.ScrapeService(apiKey, baseUrl);
-        this.crawl = new crawl_1.CrawlService(apiKey, baseUrl);
+        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/services/base.d.ts

@@ -2,6 +2,7 @@ import { RequestInit } from "node-fetch";
 export declare class BaseService {
     protected readonly apiKey: string;
     protected readonly baseUrl: string;
-    constructor(apiKey: string, 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

@@ -7,9 +7,10 @@ exports.BaseService = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const client_1 = require("../client");
 class BaseService {
-    constructor(apiKey, baseUrl) {
+    constructor(apiKey, baseUrl, timeout = 30000) {
         this.apiKey = apiKey;
         this.baseUrl = baseUrl;
+        this.timeout = timeout;
     }
     async request(path, init, params) {
         try {
@@ -21,11 +22,16 @@ class BaseService {
                     }
                 });
             }
+            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,
-                    "Content-Type": "application/json",
+                    ...(contentTypeKey && init?.headers
+                        ? { "content-type": init.headers[contentTypeKey] }
+                        : { "content-type": "application/json" }),
                     ...init?.headers,
                 },
             });

package/dist/services/extensions.d.ts

@@ -0,0 +1,14 @@
+import { CreateExtensionResponse, ListExtensionsResponse } from "../types/extension";
+import { BaseService } from "./base";
+export declare class ExtensionService extends BaseService {
+    /**
+     * Upload an extension to hyperbrowser
+     * @param {string} filePath Path to a zipped extension. Extension must be Manifest V3 compliant.
+     * @param {string} [fileName] Name to give to the extension.
+     */
+    create(filePath: string, fileName?: string | undefined): Promise<CreateExtensionResponse>;
+    /**
+     * List all uploaded extensions for the account
+     */
+    list(): Promise<ListExtensionsResponse>;
+}

package/dist/services/extensions.js

@@ -0,0 +1,75 @@
+"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 {string} filePath Path to a zipped extension. Extension must be Manifest V3 compliant.
+     * @param {string} [fileName] Name to give to the extension.
+     */
+    async create(filePath, fileName) {
+        try {
+            await checkFileExists(filePath);
+            const form = new form_data_1.default();
+            form.append("file", await promises_1.default.readFile(filePath), {
+                filename: node_path_1.default.basename(filePath),
+                contentType: "application/zip",
+            });
+            if (fileName) {
+                form.append("name", fileName);
+            }
+            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/types/config.d.ts

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

package/dist/types/constants.d.ts

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

package/dist/types/extension.d.ts

@@ -0,0 +1,9 @@
+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

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

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/session.d.ts

@@ -31,6 +31,10 @@ export interface ScreenConfig {
     width: number;
     height: number;
 }
+export interface CreateSessionProfile {
+    id?: string;
+    persistChanges?: boolean;
+}
 export interface CreateSessionParams {
     useStealth?: boolean;
     useProxy?: boolean;
@@ -48,6 +52,8 @@ export interface CreateSessionParams {
     trackers?: boolean;
     annoyances?: boolean;
     enableWebRecording?: boolean;
+    profile?: CreateSessionProfile;
+    extensionIds: Array<string>;
 }
 export interface SessionRecording {
     type: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",
@@ -25,7 +25,8 @@
     "automation"
   ],
   "dependencies": {
-    "node-fetch": "^2.6.7"
+    "form-data": "^4.0.1",
+    "node-fetch": "2.7.0"
   },
   "devDependencies": {
     "@types/node": "^22.9.1",