anchorbrowser
Version:
The official TypeScript library for the Anchorbrowser API
679 lines • 23.6 kB
text/typescript
import { APIResource } from "../../core/resource.mjs";
import * as Shared from "../shared.mjs";
import * as AllAPI from "./all.mjs";
import { All, AllStatusResponse } from "./all.mjs";
import * as ClipboardAPI from "./clipboard.mjs";
import { Clipboard, ClipboardGetResponse, ClipboardSetParams, ClipboardSetResponse } from "./clipboard.mjs";
import * as KeyboardAPI from "./keyboard.mjs";
import { Keyboard, KeyboardShortcutParams, KeyboardShortcutResponse, KeyboardTypeParams, KeyboardTypeResponse } from "./keyboard.mjs";
import * as MouseAPI from "./mouse.mjs";
import { Mouse, MouseClickParams, MouseClickResponse, MouseDoubleClickParams, MouseDoubleClickResponse, MouseDownParams, MouseDownResponse, MouseMoveParams, MouseMoveResponse, MouseUpParams, MouseUpResponse } from "./mouse.mjs";
import * as AgentAPI from "./agent/agent.mjs";
import { Agent } from "./agent/agent.mjs";
import * as RecordingsAPI from "./recordings/recordings.mjs";
import { RecordingListResponse, RecordingPauseResponse, RecordingResumeResponse, Recordings } from "./recordings/recordings.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { type Uploadable } from "../../core/uploads.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class Sessions extends APIResource {
all: AllAPI.All;
recordings: RecordingsAPI.Recordings;
mouse: MouseAPI.Mouse;
keyboard: KeyboardAPI.Keyboard;
clipboard: ClipboardAPI.Clipboard;
agent: AgentAPI.Agent;
/**
* Allocates a new browser session for the user, with optional configurations for
* ad-blocking, captcha solving, proxy usage, and idle timeout.
*
* @example
* ```ts
* const session = await client.sessions.create();
* ```
*/
create(body?: SessionCreateParams | null | undefined, options?: RequestOptions): APIPromise<SessionCreateResponse>;
/**
* Retrieves detailed information about a specific browser session.
*
* @example
* ```ts
* const session = await client.sessions.retrieve(
* 'session_id',
* );
* ```
*/
retrieve(sessionID: string, options?: RequestOptions): APIPromise<SessionRetrieveResponse>;
/**
* Deletes the browser session associated with the provided browser session ID.
* Requires a valid API key for authentication.
*
* @example
* ```ts
* const successResponse = await client.sessions.delete(
* 'session_id',
* );
* ```
*/
delete(sessionID: string, options?: RequestOptions): APIPromise<Shared.SuccessResponse>;
/**
* Copies the currently selected text to the clipboard
*
* @example
* ```ts
* const response = await client.sessions.copy(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* );
* ```
*/
copy(sessionID: string, options?: RequestOptions): APIPromise<SessionCopyResponse>;
/**
* Performs a drag and drop operation from start coordinates to end coordinates
*
* @example
* ```ts
* const response = await client.sessions.dragAndDrop(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* { endX: 500, endY: 300, startX: 400, startY: 200 },
* );
* ```
*/
dragAndDrop(sessionID: string, body: SessionDragAndDropParams, options?: RequestOptions): APIPromise<SessionDragAndDropResponse>;
/**
* Navigates the browser session to the specified URL
*
* @example
* ```ts
* const response = await client.sessions.goto(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* { url: 'https://www.google.com' },
* );
* ```
*/
goto(sessionID: string, body: SessionGotoParams, options?: RequestOptions): APIPromise<SessionGotoResponse>;
/**
* Retrieves a list of pages associated with a specific browser session.
*
* @example
* ```ts
* const response = await client.sessions.listPages(
* 'session_id',
* );
* ```
*/
listPages(sessionID: string, options?: RequestOptions): APIPromise<SessionListPagesResponse>;
/**
* Pastes text at the current cursor position
*
* @example
* ```ts
* const response = await client.sessions.paste(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* { text: 'Text pasted via API' },
* );
* ```
*/
paste(sessionID: string, body: SessionPasteParams, options?: RequestOptions): APIPromise<SessionPasteResponse>;
/**
* Retrieves metadata of files downloaded during a browser session. Requires a
* valid API key for authentication.
*
* @example
* ```ts
* const response = await client.sessions.retrieveDownloads(
* 'session_id',
* );
* ```
*/
retrieveDownloads(sessionID: string, options?: RequestOptions): APIPromise<SessionRetrieveDownloadsResponse>;
/**
* Takes a screenshot of the current browser session and returns it as an image.
*
* @example
* ```ts
* const response = await client.sessions.retrieveScreenshot(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* );
*
* const content = await response.blob();
* console.log(content);
* ```
*/
retrieveScreenshot(sessionID: string, options?: RequestOptions): APIPromise<Response>;
/**
* Performs a scroll action at the specified coordinates
*
* @example
* ```ts
* const response = await client.sessions.scroll(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* { deltaY: 100, x: 0, y: 0 },
* );
* ```
*/
scroll(sessionID: string, body: SessionScrollParams, options?: RequestOptions): APIPromise<SessionScrollResponse>;
/**
* Upload files directly to a browser session for use with web forms and file
* inputs.
*
* Files are saved to the session's uploads directory and can be referenced in CDP
* commands.
*
* @example
* ```ts
* const response = await client.sessions.uploadFile(
* '550e8400-e29b-41d4-a716-446655440000',
* { file: fs.createReadStream('path/to/file') },
* );
* ```
*/
uploadFile(sessionID: string, body: SessionUploadFileParams, options?: RequestOptions): APIPromise<SessionUploadFileResponse>;
}
export interface SessionCreateResponse {
data?: SessionCreateResponse.Data;
}
export declare namespace SessionCreateResponse {
interface Data {
/**
* Unique identifier for the browser session
*/
id?: string;
/**
* The CDP websocket connection string
*/
cdp_url?: string;
/**
* The browser session live view url
*/
live_view_url?: string;
}
}
export interface SessionRetrieveResponse {
/**
* The configuration settings for the session.
*/
configuration?: unknown;
/**
* The timestamp when the session was created.
*/
created_at?: string;
/**
* The number of credits consumed by the session.
*/
credits_used?: number;
/**
* The duration of the session in seconds.
*/
duration?: number;
/**
* Whether this is a playground session.
*/
playground?: boolean;
/**
* The number of bytes transferred through the proxy.
*/
proxy_bytes?: number;
/**
* The unique identifier of the session.
*/
session_id?: string;
/**
* The current status of the session.
*/
status?: string;
/**
* Array of steps executed in the session.
*/
steps?: Array<unknown>;
/**
* Tags associated with the session.
*/
tags?: unknown;
/**
* The team ID associated with the session.
*/
team_id?: string;
/**
* Token usage information.
*/
tokens?: unknown;
}
export interface SessionCopyResponse {
/**
* The text that was copied
*/
text?: string;
}
export interface SessionDragAndDropResponse {
status?: string;
}
export interface SessionGotoResponse {
status?: string;
}
export type SessionListPagesResponse = Array<SessionListPagesResponse.SessionListPagesResponseItem>;
export declare namespace SessionListPagesResponse {
interface SessionListPagesResponseItem {
/**
* The unique identifier of the page.
*/
id: string;
/**
* The frontend URL for accessing the page.
*/
frontend_url: string;
/**
* The title of the page.
*/
title: string;
/**
* The URL of the page.
*/
url: string;
}
}
export interface SessionPasteResponse {
status?: string;
}
export interface SessionRetrieveDownloadsResponse {
data?: SessionRetrieveDownloadsResponse.Data;
}
export declare namespace SessionRetrieveDownloadsResponse {
interface Data {
/**
* Total number of downloads
*/
count?: number;
items?: Array<Data.Item>;
}
namespace Data {
interface Item {
/**
* The unique ID of the download record.
*/
id?: string;
/**
* The timestamp when the file record was created.
*/
created_at?: string;
/**
* The time it took to process or download the file, in milliseconds.
*/
duration?: number;
/**
* The URL to download the file from anchorbrowser servers. Requires api key
* authentication.
*/
file_link?: string;
/**
* The original URL where the file was found.
*/
origin_url?: string;
/**
* The URL used to download the file.
*/
original_download_url?: string;
/**
* The original file name before any modification.
*/
original_file_name?: string;
/**
* The size of the file in bytes.
*/
size?: number;
/**
* The suggested file name for saving the file.
*/
suggested_file_name?: string;
}
}
}
export interface SessionScrollResponse {
status?: string;
}
export interface SessionUploadFileResponse {
data?: SessionUploadFileResponse.Data;
}
export declare namespace SessionUploadFileResponse {
interface Data {
message?: string;
status?: string;
}
}
export interface SessionCreateParams {
/**
* Browser-specific configurations.
*/
browser?: SessionCreateParams.Browser;
/**
* Session-related configurations.
*/
session?: SessionCreateParams.Session;
}
export declare namespace SessionCreateParams {
/**
* Browser-specific configurations.
*/
interface Browser {
/**
* Configuration for ad-blocking.
*/
adblock?: Browser.Adblock;
/**
* Configuration for captcha-solving.
*/
captcha_solver?: Browser.CaptchaSolver;
/**
* Configuration for disabling web security features.
*/
disable_web_security?: Browser.DisableWebSecurity;
/**
* Array of extension IDs to load in the browser session. Extensions must be
* previously uploaded using the Extensions API.
*/
extensions?: Array<string>;
/**
* Configuration for fullscreen mode.
*/
fullscreen?: Browser.Fullscreen;
/**
* Configuration for headless mode.
*/
headless?: Browser.Headless;
/**
* Configuration for peer-to-peer download capture functionality.
*/
p2p_download?: Browser.P2pDownload;
/**
* Configuration for popup blocking.
*/
popup_blocker?: Browser.PopupBlocker;
/**
* Options for managing and persisting browser session profiles.
*/
profile?: Browser.Profile;
/**
* Configuration for the browser's viewport size.
*/
viewport?: Browser.Viewport;
}
namespace Browser {
/**
* Configuration for ad-blocking.
*/
interface Adblock {
/**
* Enable or disable ad-blocking. Defaults to `true`.
*/
active?: boolean;
}
/**
* Configuration for captcha-solving.
*/
interface CaptchaSolver {
/**
* Enable or disable captcha-solving. Requires proxy to be active. Defaults to
* `false`.
*/
active?: boolean;
}
/**
* Configuration for disabling web security features.
*/
interface DisableWebSecurity {
/**
* Whether to disable web security features (CORS, same-origin policy, etc.).
* Allows accessing iframes and resources from different origins. Defaults to
* `false`.
*/
active?: boolean;
}
/**
* Configuration for fullscreen mode.
*/
interface Fullscreen {
/**
* Enable or disable fullscreen mode. When enabled, the browser will start in
* fullscreen mode. Defaults to `false`.
*/
active?: boolean;
}
/**
* Configuration for headless mode.
*/
interface Headless {
/**
* Whether browser should be headless or headful. Defaults to `false`.
*/
active?: boolean;
}
/**
* Configuration for peer-to-peer download capture functionality.
*/
interface P2pDownload {
/**
* Enable or disable P2P downloads. When enabled, the browser will capture
* downloads for direct data extraction, instead of uploading them on Anchor's
* storage. Defaults to `false`.
*/
active?: boolean;
}
/**
* Configuration for popup blocking.
*/
interface PopupBlocker {
/**
* Blocks popups, including ads and CAPTCHA consent banners. Requires adblock to be
* active. Defaults to `true`.
*/
active?: boolean;
}
/**
* Options for managing and persisting browser session profiles.
*/
interface Profile {
/**
* The name of the profile to be used during the browser session.
*/
name?: string;
/**
* Indicates whether the browser session profile data should be saved when the
* browser session ends. Defaults to `false`.
*/
persist?: boolean;
/**
* When enabled, resets the profile's preferences on session creation. Defaults to
* `false`.
*/
reset_preferences?: boolean;
}
/**
* Configuration for the browser's viewport size.
*/
interface Viewport {
/**
* Height of the viewport in pixels. Defaults to `900`.
*/
height?: number;
/**
* Width of the viewport in pixels. Defaults to `1440`.
*/
width?: number;
}
}
/**
* Session-related configurations.
*/
interface Session {
/**
* The URL to navigate to when the browser session starts. If not provided, the
* browser will load an empty page.
*/
initial_url?: string;
/**
* Configuration for live viewing the browser session.
*/
live_view?: Session.LiveView;
/**
* Proxy Documentation available at [Proxy Documentation](/advanced/proxy)
*/
proxy?: Session.AnchorProxy | Session.CustomProxy;
/**
* Configuration for session recording.
*/
recording?: Session.Recording;
/**
* Timeout configurations for the browser session.
*/
timeout?: Session.Timeout;
}
namespace Session {
/**
* Configuration for live viewing the browser session.
*/
interface LiveView {
/**
* Enable or disable read-only mode for live viewing. Defaults to `false`.
*/
read_only?: boolean;
}
interface AnchorProxy {
active: boolean;
/**
* City name for precise geographic targeting. Supported for anchor_proxy only. Can
* only be used when region is also provided. Example: "San Francisco",
* "los-angeles", "london"
*/
city?: string;
/**
* Supported country codes ISO 2 lowercase
*
* **On change make sure to update the Proxy type.**
*/
country_code?: 'af' | 'al' | 'dz' | 'ad' | 'ao' | 'as' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bo' | 'ba' | 'br' | 'bg' | 'bf' | 'cm' | 'ca' | 'cv' | 'td' | 'cl' | 'co' | 'cg' | 'cr' | 'ci' | 'hr' | 'cu' | 'cy' | 'cz' | 'dk' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'ee' | 'et' | 'fo' | 'fi' | 'fr' | 'gf' | 'pf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gd' | 'gp' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hn' | 'hu' | 'is' | 'in' | 'ir' | 'iq' | 'ie' | 'il' | 'it' | 'jm' | 'jp' | 'jo' | 'kz' | 'kw' | 'kg' | 'lv' | 'lb' | 'ly' | 'li' | 'lt' | 'lu' | 'mk' | 'ml' | 'mt' | 'mq' | 'mr' | 'mx' | 'md' | 'mc' | 'me' | 'ma' | 'nl' | 'nz' | 'ni' | 'ng' | 'no' | 'pk' | 'pa' | 'py' | 'pe' | 'ph' | 'pl' | 'pt' | 'pr' | 'qa' | 'ro' | 'lc' | 'sm' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sk' | 'si' | 'so' | 'za' | 'kr' | 'es' | 'sr' | 'se' | 'ch' | 'sy' | 'st' | 'tw' | 'tj' | 'tg' | 'tt' | 'tn' | 'tr' | 'tc' | 'ua' | 'ae' | 'us' | 'uy' | 'uz' | 've' | 'ye' | 'bd' | 'bw' | 'bn' | 'bi' | 'kh' | 'cn' | 'dj' | 'gq' | 'sz' | 'fj' | 'hk' | 'id' | 'ke' | 'la' | 'ls' | 'lr' | 'mg' | 'mw' | 'my' | 'mv' | 'mn' | 'mz' | 'mm' | 'na' | 'np' | 'nc' | 'ne' | 'om' | 'pg' | 'ru' | 'rw' | 'ws' | 'sg' | 'ss' | 'lk' | 'sd' | 'tz' | 'th' | 'tl' | 'tm' | 'ug' | 'gb' | 'vu' | 'vn' | 'zm' | 'zw' | 'bt' | 'mu';
/**
* Region code for more specific geographic targeting. The city parameter can only
* be used when region is also provided. Example: "ca" for California
*/
region?: string;
/**
* **On change make sure to update the country_code.**
*/
type?: 'anchor_proxy' | 'anchor_residential' | 'anchor_mobile' | 'anchor_gov';
}
interface CustomProxy {
active: boolean;
/**
* Proxy password
*/
password: string;
/**
* Proxy server address
*/
server: string;
type: 'custom';
/**
* Proxy username
*/
username: string;
}
/**
* Configuration for session recording.
*/
interface Recording {
/**
* Enable or disable video recording of the browser session. Defaults to `true`.
*/
active?: boolean;
}
/**
* Timeout configurations for the browser session.
*/
interface Timeout {
/**
* The amount of time (in minutes) the browser session waits for new connections
* after all others are closed before stopping. Defaults to `5`.
*/
idle_timeout?: number;
/**
* Maximum amount of time (in minutes) for the browser to run before terminating.
* Defaults to `20`.
*/
max_duration?: number;
}
}
}
export interface SessionDragAndDropParams {
/**
* Ending X coordinate
*/
endX: number;
/**
* Ending Y coordinate
*/
endY: number;
/**
* Starting X coordinate
*/
startX: number;
/**
* Starting Y coordinate
*/
startY: number;
/**
* Mouse button to use
*/
button?: 'left' | 'middle' | 'right';
}
export interface SessionGotoParams {
/**
* The URL to navigate to
*/
url: string;
}
export interface SessionPasteParams {
/**
* Text to paste
*/
text: string;
}
export interface SessionScrollParams {
/**
* Vertical scroll amount (positive is down, negative is up)
*/
deltaY: number;
/**
* X coordinate
*/
x: number;
/**
* Y coordinate
*/
y: number;
/**
* Horizontal scroll amount (positive is right, negative is left)
*/
deltaX?: number;
/**
* Number of steps to break the scroll into for smoother scrolling
*/
steps?: number;
/**
* Whether to use the OS scroll or the Playwright scroll
*/
useOs?: boolean;
}
export interface SessionUploadFileParams {
/**
* File to upload to the browser session
*/
file: Uploadable;
}
export declare namespace Sessions {
export { type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionCopyResponse as SessionCopyResponse, type SessionDragAndDropResponse as SessionDragAndDropResponse, type SessionGotoResponse as SessionGotoResponse, type SessionListPagesResponse as SessionListPagesResponse, type SessionPasteResponse as SessionPasteResponse, type SessionRetrieveDownloadsResponse as SessionRetrieveDownloadsResponse, type SessionScrollResponse as SessionScrollResponse, type SessionUploadFileResponse as SessionUploadFileResponse, type SessionCreateParams as SessionCreateParams, type SessionDragAndDropParams as SessionDragAndDropParams, type SessionGotoParams as SessionGotoParams, type SessionPasteParams as SessionPasteParams, type SessionScrollParams as SessionScrollParams, type SessionUploadFileParams as SessionUploadFileParams, };
export { All as All, type AllStatusResponse as AllStatusResponse };
export { Recordings as Recordings, type RecordingListResponse as RecordingListResponse, type RecordingPauseResponse as RecordingPauseResponse, type RecordingResumeResponse as RecordingResumeResponse, };
export { Mouse as Mouse, type MouseClickResponse as MouseClickResponse, type MouseDoubleClickResponse as MouseDoubleClickResponse, type MouseDownResponse as MouseDownResponse, type MouseMoveResponse as MouseMoveResponse, type MouseUpResponse as MouseUpResponse, type MouseClickParams as MouseClickParams, type MouseDoubleClickParams as MouseDoubleClickParams, type MouseDownParams as MouseDownParams, type MouseMoveParams as MouseMoveParams, type MouseUpParams as MouseUpParams, };
export { Keyboard as Keyboard, type KeyboardShortcutResponse as KeyboardShortcutResponse, type KeyboardTypeResponse as KeyboardTypeResponse, type KeyboardShortcutParams as KeyboardShortcutParams, type KeyboardTypeParams as KeyboardTypeParams, };
export { Clipboard as Clipboard, type ClipboardGetResponse as ClipboardGetResponse, type ClipboardSetResponse as ClipboardSetResponse, type ClipboardSetParams as ClipboardSetParams, };
export { Agent as Agent };
}
//# sourceMappingURL=sessions.d.mts.map