anchorbrowser/client.d.ts

The official TypeScript library for the Anchorbrowser API

import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
export type { Logger, LogLevel } from "./internal/utils/log.js";
import * as Opts from "./internal/request-options.js";
import * as Errors from "./core/error.js";
import * as Uploads from "./core/uploads.js";
import * as API from "./resources/index.js";
import { APIPromise } from "./core/api-promise.js";
import { EventSignalParams, EventWaitForParams, EventWaitForResponse, Events } from "./resources/events.js";
import { ExtensionDeleteResponse, ExtensionListResponse, ExtensionManifest, ExtensionRetrieveResponse, ExtensionUploadParams, ExtensionUploadResponse, Extensions } from "./resources/extensions.js";
import { ProfileCreateParams, ProfileListResponse, ProfileRetrieveResponse, ProfileUpdateParams, Profiles } from "./resources/profiles.js";
import { ToolFetchWebpageParams, ToolFetchWebpageResponse, ToolPerformWebTaskParams, ToolPerformWebTaskResponse, ToolScreenshotWebpageParams, Tools } from "./resources/tools.js";
import { SessionCopyResponse, SessionCreateParams, SessionCreateResponse, SessionDragAndDropParams, SessionDragAndDropResponse, SessionGotoParams, SessionGotoResponse, SessionListPagesResponse, SessionPasteParams, SessionPasteResponse, SessionRetrieveDownloadsResponse, SessionRetrieveResponse, SessionScrollParams, SessionScrollResponse, SessionUploadFileParams, SessionUploadFileResponse, Sessions } from "./resources/sessions/sessions.js";
import { type Fetch } from "./internal/builtin-types.js";
import { HeadersLike, NullableHeaders } from "./internal/headers.js";
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
import { type LogLevel, type Logger } from "./internal/utils/log.js";
export interface ClientOptions {
    /**
     * API key passed in the header
     */
    apiKey?: string | undefined;
    /**
     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
     *
     * Defaults to process.env['ANCHORBROWSER_BASE_URL'].
     */
    baseURL?: string | null | undefined;
    /**
     * The maximum amount of time (in milliseconds) that the client should wait for a response
     * from the server before timing out a single request.
     *
     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
     * much longer than this timeout before the promise succeeds or fails.
     *
     * @unit milliseconds
     */
    timeout?: number | undefined;
    /**
     * Additional `RequestInit` options to be passed to `fetch` calls.
     * Properties will be overridden by per-request `fetchOptions`.
     */
    fetchOptions?: MergedRequestInit | undefined;
    /**
     * Specify a custom `fetch` function implementation.
     *
     * If not provided, we expect that `fetch` is defined globally.
     */
    fetch?: Fetch | undefined;
    /**
     * The maximum number of times that the client will retry a request in case of a
     * temporary failure, like a network error or a 5XX error from the server.
     *
     * @default 2
     */
    maxRetries?: number | undefined;
    /**
     * Default headers to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * header to `null` in request options.
     */
    defaultHeaders?: HeadersLike | undefined;
    /**
     * Default query parameters to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * param to `undefined` in request options.
     */
    defaultQuery?: Record<string, string | undefined> | undefined;
    /**
     * Set the log level.
     *
     * Defaults to process.env['ANCHORBROWSER_LOG'] or 'warn' if it isn't set.
     */
    logLevel?: LogLevel | undefined;
    /**
     * Set the logger.
     *
     * Defaults to globalThis.console.
     */
    logger?: Logger | undefined;
}
/**
 * API Client for interfacing with the Anchorbrowser API.
 */
export declare class Anchorbrowser {
    #private;
    apiKey: string;
    baseURL: string;
    maxRetries: number;
    timeout: number;
    logger: Logger | undefined;
    logLevel: LogLevel | undefined;
    fetchOptions: MergedRequestInit | undefined;
    private fetch;
    protected idempotencyHeader?: string;
    private _options;
    /**
     * API Client for interfacing with the Anchorbrowser API.
     *
     * @param {string | undefined} [opts.apiKey=process.env['ANCHORBROWSER_API_KEY'] ?? undefined]
     * @param {string} [opts.baseURL=process.env['ANCHORBROWSER_BASE_URL'] ?? https://api.anchorbrowser.io] - Override the default base URL for the API.
     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
     */
    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
    /**
     * Create a new client instance re-using the same options given to the current client with optional overriding.
     */
    withOptions(options: Partial<ClientOptions>): this;
    protected defaultQuery(): Record<string, string | undefined> | undefined;
    protected validateHeaders({ values, nulls }: NullableHeaders): void;
    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
    /**
     * Basic re-implementation of `qs.stringify` for primitive types.
     */
    protected stringifyQuery(query: Record<string, unknown>): string;
    private getUserAgent;
    protected defaultIdempotencyKey(): string;
    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
    /**
     * Used as a callback for mutating the given `FinalRequestOptions` object.
     */
    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
    /**
     * Used as a callback for mutating the given `RequestInit` object.
     *
     * This is useful for cases where you want to add certain headers based off of
     * the request properties, e.g. `method` or `url`.
     */
    protected prepareRequest(request: RequestInit, { url, options }: {
        url: string;
        options: FinalRequestOptions;
    }): Promise<void>;
    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    private methodRequest;
    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
    private makeRequest;
    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
    private shouldRetry;
    private retryRequest;
    private calculateDefaultRetryTimeoutMillis;
    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
        retryCount?: number;
    }): Promise<{
        req: FinalizedRequestInit;
        url: string;
        timeout: number;
    }>;
    private buildHeaders;
    private buildBody;
    static Anchorbrowser: typeof Anchorbrowser;
    static DEFAULT_TIMEOUT: number;
    static AnchorbrowserError: typeof Errors.AnchorbrowserError;
    static APIError: typeof Errors.APIError;
    static APIConnectionError: typeof Errors.APIConnectionError;
    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
    static APIUserAbortError: typeof Errors.APIUserAbortError;
    static NotFoundError: typeof Errors.NotFoundError;
    static ConflictError: typeof Errors.ConflictError;
    static RateLimitError: typeof Errors.RateLimitError;
    static BadRequestError: typeof Errors.BadRequestError;
    static AuthenticationError: typeof Errors.AuthenticationError;
    static InternalServerError: typeof Errors.InternalServerError;
    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
    static toFile: typeof Uploads.toFile;
    profiles: API.Profiles;
    sessions: API.Sessions;
    tools: API.Tools;
    extensions: API.Extensions;
    browser: API.Browser;
    agent: API.Agent;
    events: API.Events;
}
export declare namespace Anchorbrowser {
    export type RequestOptions = Opts.RequestOptions;
    export { Profiles as Profiles, type ProfileRetrieveResponse as ProfileRetrieveResponse, type ProfileListResponse as ProfileListResponse, type ProfileCreateParams as ProfileCreateParams, type ProfileUpdateParams as ProfileUpdateParams, };
    export { Sessions as Sessions, 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 { Tools as Tools, type ToolFetchWebpageResponse as ToolFetchWebpageResponse, type ToolPerformWebTaskResponse as ToolPerformWebTaskResponse, type ToolFetchWebpageParams as ToolFetchWebpageParams, type ToolPerformWebTaskParams as ToolPerformWebTaskParams, type ToolScreenshotWebpageParams as ToolScreenshotWebpageParams, };
    export { Extensions as Extensions, type ExtensionManifest as ExtensionManifest, type ExtensionRetrieveResponse as ExtensionRetrieveResponse, type ExtensionListResponse as ExtensionListResponse, type ExtensionDeleteResponse as ExtensionDeleteResponse, type ExtensionUploadResponse as ExtensionUploadResponse, type ExtensionUploadParams as ExtensionUploadParams, };
    export { Events as Events, type EventWaitForResponse as EventWaitForResponse, type EventSignalParams as EventSignalParams, type EventWaitForParams as EventWaitForParams, };
    export type SuccessResponse = API.SuccessResponse;
}
//# sourceMappingURL=client.d.ts.map