@hyperbrowser/sdk 0.19.0 → 0.21.0

package/dist/client.d.ts

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

package/dist/client.js

@@ -6,6 +6,7 @@ const scrape_1 = require("./services/scrape");
 const crawl_1 = require("./services/crawl");
 const profiles_1 = require("./services/profiles");
 const extensions_1 = require("./services/extensions");
+const extract_1 = require("./services/extract");
 class HyperbrowserError extends Error {
     constructor(message, statusCode) {
         super(`[Hyperbrowser]: ${message}`);
@@ -25,6 +26,7 @@ class HyperbrowserClient {
         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.extract = new extract_1.ExtractService(apiKey, baseUrl, timeout);
         this.profiles = new profiles_1.ProfilesService(apiKey, baseUrl, timeout);
         this.extensions = new extensions_1.ExtensionService(apiKey, baseUrl, timeout);
     }

package/dist/services/extract.d.ts

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

package/dist/services/extract.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractService = void 0;
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const base_1 = require("./base");
+const utils_1 = require("../utils");
+const client_1 = require("../client");
+const isZodSchema = (schema) => {
+    return (schema &&
+        typeof schema === "object" &&
+        "_def" in schema &&
+        "parse" in schema &&
+        typeof schema.parse === "function");
+};
+class ExtractService extends base_1.BaseService {
+    /**
+     * Start a new extract job
+     * @param params The parameters for the extract job
+     */
+    async start(params) {
+        try {
+            if (!params.schema && !params.prompt) {
+                throw new client_1.HyperbrowserError("Either schema or prompt must be provided");
+            }
+            if (params.schema) {
+                if (isZodSchema(params.schema)) {
+                    params.schema = (0, zod_to_json_schema_1.zodToJsonSchema)(params.schema);
+                }
+            }
+            return await this.request("/extract", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to start extract job", undefined);
+        }
+    }
+    /**
+     * Get the status of an extract job
+     * @param id The ID of the extract job to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/extract/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get extract job ${id}`, undefined);
+        }
+    }
+    /**
+     * Start an extract job and wait for it to complete
+     * @param params The parameters for the extract job
+     */
+    async startAndWait(params) {
+        const job = await this.start(params);
+        const jobId = job.jobId;
+        if (!jobId) {
+            throw new client_1.HyperbrowserError("Failed to start extract 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.ExtractService = ExtractService;

package/dist/types/constants.d.ts

@@ -1,5 +1,6 @@
 export type ScrapeFormat = "markdown" | "html" | "links" | "screenshot";
 export type ScrapeJobStatus = "pending" | "running" | "completed" | "failed";
+export type ExtractJobStatus = "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";

package/dist/types/extract.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+import { ExtractJobStatus } from "./constants";
+import { CreateSessionParams } from "./session";
+export interface StartExtractJobParams {
+    urls: string[];
+    prompt?: string;
+    schema?: z.ZodSchema | object;
+    sessionOptions?: CreateSessionParams;
+}
+export interface StartExtractJobResponse {
+    jobId: string;
+}
+export interface ExtractJobResponse {
+    jobId: string;
+    status: ExtractJobStatus;
+    data?: object;
+    error?: string;
+}

package/dist/types/extract.js

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

package/dist/types/session.d.ts

@@ -55,6 +55,7 @@ export interface CreateSessionParams {
     enableWebRecording?: boolean;
     profile?: CreateSessionProfile;
     extensionIds?: Array<string>;
+    staticIpId?: string;
 }
 export interface SessionRecording {
     type: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",
@@ -31,7 +31,9 @@
   ],
   "dependencies": {
     "form-data": "^4.0.1",
-    "node-fetch": "2.7.0"
+    "node-fetch": "2.7.0",
+    "zod": "^3.24.1",
+    "zod-to-json-schema": "^3.24.1"
   },
   "devDependencies": {
     "@types/node": "^22.9.1",
@@ -60,8 +62,12 @@
   },
   "typesVersions": {
     "*": {
-      "types": ["./dist/types/index.d.ts"],
-      "tools": ["./dist/tools/index.d.ts"]
+      "types": [
+        "./dist/types/index.d.ts"
+      ],
+      "tools": [
+        "./dist/tools/index.d.ts"
+      ]
     }
   }
 }