@hyperbrowser/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 hyperbrowserai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client.d.ts

@@ -0,0 +1,31 @@
+import { Response } from "node-fetch";
+import { HyperbrowserConfig } from "./types/config";
+import { SessionDetail, SessionListParams, SessionListResponse } from "./types/session";
+export declare class HyperbrowserError extends Error {
+    statusCode?: number | undefined;
+    response?: Response | undefined;
+    constructor(message: string, statusCode?: number | undefined, response?: Response | undefined);
+}
+export declare class HyperbrowserClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    constructor(config: HyperbrowserConfig);
+    private request;
+    /**
+     * Create a new browser session
+     */
+    createSession(): Promise<SessionDetail>;
+    /**
+     * Get details of an existing session
+     */
+    getSession(id: string): Promise<SessionDetail>;
+    /**
+     * Stop a running session
+     * @returns true if the session was successfully stopped
+     */
+    stopSession(id: string): Promise<boolean>;
+    /**
+     * List all sessions with optional filtering
+     */
+    listSessions(params?: SessionListParams): Promise<SessionListResponse>;
+}

package/dist/client.js

@@ -0,0 +1,94 @@
+"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"));
+class HyperbrowserError extends Error {
+    constructor(message, statusCode, response) {
+        super(message);
+        this.statusCode = statusCode;
+        this.response = response;
+        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) {
+            throw new Error("API key is required");
+        }
+    }
+    async request(path, init, params) {
+        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) {
+            throw new HyperbrowserError(`HTTP error! status: ${response.status}`, response.status, response);
+        }
+        // Handle empty responses (like for stop session)
+        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);
+        }
+    }
+    /**
+     * Create a new browser session
+     */
+    async createSession() {
+        return this.request("/session", { method: "POST" });
+    }
+    /**
+     * Get details of an existing session
+     */
+    async getSession(id) {
+        return this.request(`/session/${id}`);
+    }
+    /**
+     * Stop a running session
+     * @returns true if the session was successfully stopped
+     */
+    async stopSession(id) {
+        try {
+            await this.request(`/session/${id}/stop`, { method: "PUT" });
+            return true;
+        }
+        catch (error) {
+            if (error instanceof HyperbrowserError && error.statusCode && error.statusCode > 300) {
+                return false;
+            }
+            throw error;
+        }
+    }
+    /**
+     * List all sessions with optional filtering
+     */
+    async listSessions(params = {}) {
+        return this.request("/sessions", undefined, {
+            status: params.status,
+            page: params.page,
+        });
+    }
+}
+exports.HyperbrowserClient = HyperbrowserClient;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { HyperbrowserClient as default } from "./client";
+export * from "./types";
+export { HyperbrowserError } from "./client";

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HyperbrowserError = exports.default = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return client_1.HyperbrowserClient; } });
+__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;

package/dist/types/config.d.ts

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

package/dist/types/config.js

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

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from ".";

package/dist/types/index.js

@@ -0,0 +1,17 @@
+"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/session.d.ts

@@ -0,0 +1,24 @@
+export type SessionStatus = "active" | "closed" | "error";
+export interface Session {
+    id: string;
+    teamId: string;
+    status: SessionStatus;
+    startTime?: number;
+    endTime?: number;
+    createdAt: string;
+    updatedAt: string;
+    sessionUrl: 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;
+}

package/dist/types/session.js

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

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@hyperbrowser/sdk",
+  "version": "0.1.0",
+  "description": "Javascript SDK for Hyperbrowser API",
+  "author": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint src/**/*.ts",
+    "prepare": "yarn build",
+    "test": "jest",
+    "format": "prettier --write 'src/**/*.ts'"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "hyperbrowser",
+    "browser",
+    "automation"
+  ],
+  "dependencies": {
+    "node-fetch": "^2.6.7"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.1",
+    "@types/node-fetch": "^2.6.4",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.3.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3"
+  }
+}