@browserbasehq/orca 3.0.0-preview.0 → 3.0.0-preview.3

package/dist/lib/v3/v3.d.ts

@@ -1,156 +0,0 @@
-import { V3Options, ActOptions, ObserveOptions, V3Metrics, V3FunctionName, ExtractOptions } from "@/lib/v3/types";
-import { V3Context } from "@/lib/v3/understudy/context";
-import { LLMClient } from "./llm/LLMClient";
-import { z } from "zod/v3";
-import type { ZodTypeAny } from "zod/v3";
-import { Action, ActResult, HistoryEntry, AgentConfig } from "./types/stagehand";
-import { AgentExecuteOptions, AgentResult } from "./types/agent";
-import { LogLine } from "./types/log";
-import { defaultExtractSchema, pageTextSchema } from "./types";
-import type { AgentReplayStep } from "./types/cache";
-/**
- * V3
- *
- * Purpose:
- * A high-level orchestrator for Stagehand V3. Abstracts away whether the browser
- * runs **locally via Chrome** or remotely on **Browserbase**, and exposes simple
- * entrypoints (`act`, `extract`, `observe`) that delegate to the corresponding
- * handler classes.
- *
- * Responsibilities:
- * - Bootstraps Chrome or Browserbase, ensures a working CDP WebSocket, and builds a `V3Context`.
- * - Manages lifecycle: init, context access, cleanup.
- * - Bridges external page objects (Playwright/Puppeteer) into internal frameIds for handlers.
- * - Provides a stable API surface for downstream code regardless of runtime environment.
- */
-export declare class V3 {
-    private readonly opts;
-    private state;
-    private actHandler;
-    private extractHandler;
-    private observeHandler;
-    private ctx;
-    llmClient: LLMClient;
-    private modelName;
-    private modelClientOptions;
-    private llmProvider;
-    private readonly domSettleTimeoutMs?;
-    private _isClosing;
-    private _onCdpClosed;
-    readonly experimental: boolean;
-    readonly logInferenceToFile: boolean;
-    private externalLogger?;
-    verbose: 0 | 1 | 2;
-    private _history;
-    private readonly instanceId;
-    private static _processGuardsInstalled;
-    private static _instances;
-    private cacheDir?;
-    private _agentReplayRecording;
-    v3Metrics: V3Metrics;
-    /**
-     * Async property for metrics so callers can `await v3.metrics`.
-     * Returning a Promise future-proofs async aggregation/storage.
-     */
-    get metrics(): Promise<V3Metrics>;
-    private cloneForCache;
-    private beginAgentReplayRecording;
-    private endAgentReplayRecording;
-    private discardAgentReplayRecording;
-    private isAgentReplayRecording;
-    isAgentReplayActive(): boolean;
-    recordAgentReplayStep(step: AgentReplayStep): void;
-    /**
-     * Async property for history so callers can `await v3.history`.
-     * Returns a frozen copy to avoid external mutation.
-     */
-    get history(): Promise<ReadonlyArray<HistoryEntry>>;
-    addToHistory(method: HistoryEntry["method"], parameters: unknown, result?: unknown): void;
-    updateMetrics(functionName: V3FunctionName, promptTokens: number, completionTokens: number, inferenceTimeMs: number): void;
-    private updateTotalMetrics;
-    constructor(opts: V3Options);
-    private _immediateShutdown;
-    private static _installProcessGuards;
-    /**
-     * Entrypoint: initializes handlers, launches Chrome or Browserbase,
-     * and sets up a CDP context.
-     */
-    init(): Promise<void>;
-    /** Apply post-connect local browser options that require CDP. */
-    private _applyPostConnectLocalOptions;
-    /**
-     * Run an "act" instruction through the ActHandler.
-     *
-     * New API:
-     * - act(instruction: string, options?: ActOptions)
-     * - act(action: Action, options?: ActOptions)
-     */
-    act(instruction: string, options?: ActOptions): Promise<ActResult>;
-    act(action: Action, options?: ActOptions): Promise<ActResult>;
-    /**
-     * Run an "extract" instruction through the ExtractHandler.
-     *
-     * Accepted forms:
-     * - extract() → pageText
-     * - extract(options) → pageText
-     * - extract(instruction) → defaultExtractSchema
-     * - extract(instruction, schema) → schema-inferred
-     * - extract(instruction, schema, options)
-     */
-    extract(): Promise<z.infer<typeof pageTextSchema>>;
-    extract(options: ExtractOptions): Promise<z.infer<typeof pageTextSchema>>;
-    extract(instruction: string, options?: ExtractOptions): Promise<z.infer<typeof defaultExtractSchema>>;
-    extract<T extends ZodTypeAny>(instruction: string, schema: T, options?: ExtractOptions): Promise<z.infer<T>>;
-    /**
-     * Run an "observe" instruction through the ObserveHandler.
-     */
-    observe(): Promise<Action[]>;
-    observe(options: ObserveOptions): Promise<Action[]>;
-    observe(instruction: string, options?: ObserveOptions): Promise<Action[]>;
-    /** Return the browser-level CDP WebSocket endpoint. */
-    connectURL(): string;
-    /** Expose the current CDP-backed context. */
-    get context(): V3Context;
-    /** Best-effort cleanup of context and launched resources. */
-    close(opts?: {
-        force?: boolean;
-    }): Promise<void>;
-    /** Guard: ensure Browserbase credentials exist in options. */
-    private requireBrowserbaseCreds;
-    get logger(): (logLine: LogLine) => void;
-    /**
-     * Normalize a Playwright/Puppeteer page object into its top frame id,
-     * so handlers can resolve it to a `Page` within our V3Context.
-     */
-    private resolveTopFrameId;
-    private isPlaywrightPage;
-    private isPatchrightPage;
-    private isPuppeteerPage;
-    private normalizeToV3Page;
-    private buildActCacheKey;
-    private safeGetPageUrl;
-    private readActCacheEntry;
-    private writeActCacheEntry;
-    private sanitizeAgentExecuteOptions;
-    private buildAgentCacheSignature;
-    private buildAgentCacheKey;
-    private readAgentCacheEntry;
-    private writeAgentCacheEntry;
-    private replayAgentCacheEntry;
-    private executeAgentReplayStep;
-    private replayAgentActStep;
-    private replayAgentFillFormStep;
-    private replayAgentGotoStep;
-    private replayAgentScrollStep;
-    private replayAgentWaitStep;
-    private replayAgentNavBackStep;
-    private replayCachedActions;
-    private runWithActTimeout;
-    /**
-     * Create a v3 agent instance (AISDK tool-based) with execute().
-     * Mirrors the v2 Stagehand.agent() tool mode (no CUA provider here).
-     */
-    agent(options?: AgentConfig): {
-        execute: (instructionOrOptions: string | AgentExecuteOptions) => Promise<AgentResult>;
-    };
-}

package/dist/lib/version.d.ts

@@ -1,5 +0,0 @@
-/**
- * AUTO-GENERATED — DO NOT EDIT BY HAND
- *  Run `pnpm run gen-version` to refresh.
- */
-export declare const STAGEHAND_VERSION: "3.0.0-preview.0";