@hyperbrowser/sdk 0.10.0 → 0.12.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

@@ -3,6 +3,7 @@ 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);
@@ -12,5 +13,6 @@ export declare class HyperbrowserClient {
     readonly scrape: ScrapeService;
     readonly crawl: CrawlService;
     readonly profiles: ProfilesService;
+    readonly extensions: ExtensionService;
     constructor(config: HyperbrowserConfig);
 }

package/dist/client.js

@@ -5,6 +5,7 @@ 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}`);
@@ -25,6 +26,7 @@ class HyperbrowserClient {
         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.js

@@ -22,12 +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,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/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,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

@@ -3,4 +3,5 @@ export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobRespon
 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/session.d.ts

@@ -53,6 +53,7 @@ export interface CreateSessionParams {
     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.10.0",
+  "version": "0.12.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",