@hyperbrowser/sdk 0.18.0 → 0.20.0

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

@@ -0,0 +1,35 @@
+export interface CacheControlEphemeral {
+    type: "ephemeral";
+}
+export interface InputSchema {
+    type: "object";
+    properties?: unknown | null;
+    [k: string]: unknown;
+}
+export interface Tool {
+    /**
+     * [JSON schema](https://json-schema.org/) for this tool's input.
+     *
+     * This defines the shape of the `input` that your tool accepts and that the model
+     * will produce.
+     */
+    input_schema: InputSchema;
+    /**
+     * Name of the tool.
+     *
+     * This is how the tool will be called by the model and in tool_use blocks.
+     */
+    name: string;
+    cache_control?: CacheControlEphemeral | null;
+    /**
+     * Description of what this tool does.
+     *
+     * Tool descriptions should be as detailed as possible. The more information that
+     * the model has about what the tool is and how to use it, the better it will
+     * perform. You can use natural language descriptions to reinforce important
+     * aspects of the tool input JSON schema.
+     */
+    description?: string;
+}
+export declare const SCRAPE_TOOL_ANTHROPIC: Tool;
+export declare const CRAWL_TOOL_ANTHROPIC: Tool;

package/dist/tools/anthropic.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
+const schema_1 = require("./schema");
+exports.SCRAPE_TOOL_ANTHROPIC = {
+    input_schema: schema_1.SCRAPE_SCHEMA,
+    name: "scrape_webpage",
+    description: "Scrape content from a webpage and return the content in markdown format",
+};
+exports.CRAWL_TOOL_ANTHROPIC = {
+    input_schema: schema_1.CRAWL_SCHEMA,
+    name: "crawl_website",
+    description: "Crawl a website and return the content in markdown format",
+};

package/dist/tools/index.d.ts

@@ -0,0 +1,12 @@
+import { HyperbrowserClient } from "../client";
+import { StartScrapeJobParams, StartCrawlJobParams } from "../types";
+export declare class WebsiteScrapeTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
+}
+export declare class WebsiteCrawlTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartCrawlJobParams): Promise<string>;
+}

package/dist/tools/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsiteCrawlTool = exports.WebsiteScrapeTool = void 0;
+const openai_1 = require("./openai");
+const anthropic_1 = require("./anthropic");
+class WebsiteScrapeTool {
+    static async runnable(hb, params) {
+        const resp = await hb.scrape.startAndWait(params);
+        return resp.data?.markdown || "";
+    }
+}
+exports.WebsiteScrapeTool = WebsiteScrapeTool;
+WebsiteScrapeTool.openaiToolDefinition = openai_1.SCRAPE_TOOL_OPENAI;
+WebsiteScrapeTool.anthropicToolDefinition = anthropic_1.SCRAPE_TOOL_ANTHROPIC;
+class WebsiteCrawlTool {
+    static async runnable(hb, params) {
+        const resp = await hb.crawl.startAndWait(params);
+        let markdown = "";
+        if (resp.data) {
+            for (const page of resp.data) {
+                if (page.markdown) {
+                    markdown += `\n${"-".repeat(50)}\nUrl: ${page.url}\nMarkdown:\n${page.markdown}\n`;
+                }
+            }
+        }
+        return markdown;
+    }
+}
+exports.WebsiteCrawlTool = WebsiteCrawlTool;
+WebsiteCrawlTool.openaiToolDefinition = openai_1.CRAWL_TOOL_OPENAI;
+WebsiteCrawlTool.anthropicToolDefinition = anthropic_1.CRAWL_TOOL_ANTHROPIC;

package/dist/tools/openai.d.ts

@@ -0,0 +1,40 @@
+export type FunctionParameters = Record<string, unknown>;
+export interface FunctionDefinition {
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+     * underscores and dashes, with a maximum length of 64.
+     */
+    name: string;
+    /**
+     * A description of what the function does, used by the model to choose when and
+     * how to call the function.
+     */
+    description?: string;
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object. See the
+     * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
+     * and the
+     * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+     * documentation about the format.
+     *
+     * Omitting `parameters` defines a function with an empty parameter list.
+     */
+    parameters?: FunctionParameters;
+    /**
+     * Whether to enable strict schema adherence when generating the function call. If
+     * set to true, the model will follow the exact schema defined in the `parameters`
+     * field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
+     * more about Structured Outputs in the
+     * [function calling guide](docs/guides/function-calling).
+     */
+    strict?: boolean | null;
+}
+export interface ChatCompletionTool {
+    function: FunctionDefinition;
+    /**
+     * The type of the tool. Currently, only `function` is supported.
+     */
+    type: "function";
+}
+export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
+export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;

package/dist/tools/openai.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+const schema_1 = require("./schema");
+exports.SCRAPE_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "scrape_webpage",
+        description: "Scrape content from a webpage and return the content in markdown format",
+        parameters: schema_1.SCRAPE_SCHEMA,
+        strict: true,
+    },
+};
+exports.CRAWL_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "crawl_website",
+        description: "Crawl a website and return the content in markdown format",
+        parameters: schema_1.CRAWL_SCHEMA,
+        strict: true,
+    },
+};

package/dist/tools/schema.d.ts

@@ -0,0 +1,126 @@
+export declare const SCRAPE_OPTIONS: {
+    type: string;
+    description: string;
+    properties: {
+        include_tags: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        exclude_tags: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        only_main_content: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+export declare const SCRAPE_SCHEMA: {
+    type: "object";
+    properties: {
+        url: {
+            type: string;
+            description: string;
+        };
+        scrape_options: {
+            type: string;
+            description: string;
+            properties: {
+                include_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                exclude_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                only_main_content: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+export declare const CRAWL_SCHEMA: {
+    type: "object";
+    properties: {
+        url: {
+            type: string;
+            description: string;
+        };
+        max_pages: {
+            type: string;
+            description: string;
+        };
+        follow_links: {
+            type: string;
+            description: string;
+        };
+        ignore_sitemap: {
+            type: string;
+            description: string;
+        };
+        exclude_patterns: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        include_patterns: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        scrape_options: {
+            type: string;
+            description: string;
+            properties: {
+                include_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                exclude_tags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                only_main_content: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};

package/dist/tools/schema.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRAWL_SCHEMA = exports.SCRAPE_SCHEMA = exports.SCRAPE_OPTIONS = void 0;
+exports.SCRAPE_OPTIONS = {
+    type: "object",
+    description: "The options for the scrape",
+    properties: {
+        include_tags: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
+        },
+        exclude_tags: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
+        },
+        only_main_content: {
+            type: "boolean",
+            description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
+        },
+    },
+    required: ["include_tags", "exclude_tags", "only_main_content"],
+    additionalProperties: false,
+};
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
+        },
+        scrape_options: exports.SCRAPE_OPTIONS,
+    },
+    required: ["url", "scrape_options"],
+    additionalProperties: false,
+};
+exports.CRAWL_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to crawl",
+        },
+        max_pages: {
+            type: "number",
+            description: "The maximum number of pages to crawl",
+        },
+        follow_links: {
+            type: "boolean",
+            description: "Whether to follow links on the page",
+        },
+        ignore_sitemap: {
+            type: "boolean",
+            description: "Whether to ignore the sitemap",
+        },
+        exclude_patterns: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            description: "An array of regular expressions or wildcard patterns specifying which URLs should be excluded from the crawl. Any pages whose URLs' path match one of these patterns will be skipped. Example: ['/admin', '/careers/*']",
+        },
+        include_patterns: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+            description: "An array of regular expressions or wildcard patterns specifying which URLs should be included in the crawl. Only pages whose URLs' path match one of these path patterns will be visited. Example: ['/admin', '/careers/*']",
+        },
+        scrape_options: exports.SCRAPE_OPTIONS,
+    },
+    required: [
+        "url",
+        "max_pages",
+        "follow_links",
+        "ignore_sitemap",
+        "exclude_patterns",
+        "include_patterns",
+        "scrape_options",
+    ],
+    additionalProperties: false,
+};

package/dist/types/config.d.ts

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

package/dist/types/config.js

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

package/dist/types/constants.d.ts

@@ -0,0 +1,9 @@
+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";
+export type OperatingSystem = "windows" | "android" | "macos" | "linux" | "ios";
+export type Platform = "chrome" | "firefox" | "safari" | "edge";
+export type ISO639_1 = "aa" | "ab" | "ae" | "af" | "ak" | "am" | "an" | "ar" | "as" | "av" | "ay" | "az" | "ba" | "be" | "bg" | "bh" | "bi" | "bm" | "bn" | "bo" | "br" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | "cu" | "cv" | "cy" | "da" | "de" | "dv" | "dz" | "ee" | "el" | "en" | "eo" | "es" | "et" | "eu" | "fa" | "ff" | "fi" | "fj" | "fo" | "fr" | "fy" | "ga" | "gd" | "gl" | "gn" | "gu" | "gv" | "ha" | "he" | "hi" | "ho" | "hr" | "ht" | "hu" | "hy" | "hz" | "ia" | "id" | "ie" | "ig" | "ii" | "ik" | "io" | "is" | "it" | "iu" | "ja" | "jv" | "ka" | "kg" | "ki" | "kj" | "kk" | "kl" | "km" | "kn" | "ko" | "kr" | "ks" | "ku" | "kv" | "kw" | "ky" | "la" | "lb" | "lg" | "li" | "ln" | "lo" | "lt" | "lu" | "lv" | "mg" | "mh" | "mi" | "mk" | "ml" | "mn" | "mo" | "mr" | "ms" | "mt" | "my" | "na" | "nb" | "nd" | "ne" | "ng" | "nl" | "nn" | "no" | "nr" | "nv" | "ny" | "oc" | "oj" | "om" | "or" | "os" | "pa" | "pi" | "pl" | "ps" | "pt" | "qu" | "rm" | "rn" | "ro" | "ru" | "rw" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sm" | "sn" | "so" | "sq" | "sr" | "ss" | "st" | "su" | "sv" | "sw" | "ta" | "te" | "tg" | "th" | "ti" | "tk" | "tl" | "tn" | "to" | "tr" | "ts" | "tt" | "tw" | "ty" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "wo" | "xh" | "yi" | "yo" | "za" | "zh" | "zu";

package/dist/types/constants.js

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

package/dist/types/crawl.d.ts

@@ -0,0 +1,40 @@
+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[];
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
+}
+export interface StartCrawlJobResponse {
+    jobId: string;
+}
+export interface GetCrawlJobParams {
+    page?: number;
+    batchSize?: number;
+}
+export interface CrawledPage {
+    url: string;
+    status: CrawlPageStatus;
+    error?: string | null;
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
+    screenshot?: string;
+}
+export interface CrawlJobResponse {
+    jobId: string;
+    status: CrawlJobStatus;
+    data?: CrawledPage[];
+    error?: string;
+    totalCrawledPages: number;
+    totalPageBatches: number;
+    currentPageBatch: number;
+    batchSize: number;
+}

package/dist/types/crawl.js

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

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

@@ -0,0 +1,7 @@
+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 { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
+export { ScrapeJobStatus, CrawlJobStatus, Country, ISO639_1, OperatingSystem, Platform, } from "./constants";

package/dist/types/index.js

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

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

@@ -0,0 +1,31 @@
+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;
+    sessionOptions?: CreateSessionParams;
+    scrapeOptions?: ScrapeOptions;
+}
+export interface StartScrapeJobResponse {
+    jobId: string;
+}
+export interface ScrapeJobData {
+    metadata?: Record<string, string | string[]>;
+    markdown?: string;
+    html?: string;
+    links?: string[];
+    screenshot?: string;
+}
+export interface ScrapeJobResponse {
+    jobId: string;
+    status: ScrapeJobStatus;
+    data?: ScrapeJobData;
+    error?: string;
+}

package/dist/types/scrape.js

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