@skyvern/client 1.0.2 → 1.0.3

package/dist/esm/library/SkyvernBrowserPageAgent.mjs

@@ -0,0 +1,252 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { SkyvernEnvironment } from "../environments.mjs";
+import { DEFAULT_AGENT_HEARTBEAT_INTERVAL, DEFAULT_AGENT_TIMEOUT } from "./constants.mjs";
+import { LOG } from "./logger.mjs";
+function getAppUrlForRun(runId) {
+    return `https://app.skyvern.com/runs/${runId}`;
+}
+/**
+ * Provides methods to run Skyvern tasks and workflows in the context of a browser page.
+ *
+ * This class enables executing AI-powered browser automation tasks while sharing the
+ * context of an existing browser page. It supports running custom tasks, login workflows,
+ * and pre-defined workflows with automatic waiting for completion.
+ */
+export class SkyvernBrowserPageAgent {
+    constructor(browser, page) {
+        this._browser = browser;
+        this._page = page;
+    }
+    /**
+     * Run a task in the context of this page and wait for it to finish.
+     *
+     * @param prompt - Natural language description of the task to perform.
+     * @param options - Optional configuration
+     * @param options.engine - The execution engine to use. Defaults to skyvern_v2.
+     * @param options.model - LLM model configuration options.
+     * @param options.url - URL to navigate to. If not provided, uses the current page URL.
+     * @param options.webhookUrl - URL to receive webhook notifications about task progress.
+     * @param options.totpIdentifier - Identifier for TOTP (Time-based One-Time Password) authentication.
+     * @param options.totpUrl - URL to fetch TOTP codes from.
+     * @param options.title - Human-readable title for this task run.
+     * @param options.errorCodeMapping - Mapping of error codes to custom error messages.
+     * @param options.dataExtractionSchema - Schema defining what data to extract from the page.
+     * @param options.maxSteps - Maximum number of steps the agent can take.
+     * @param options.timeout - Maximum time in seconds to wait for task completion.
+     *
+     * @returns TaskRunResponse containing the task execution results.
+     */
+    runTask(prompt, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            LOG.info("AI run task", { prompt });
+            const taskRun = yield this._browser.skyvern.runTask({
+                "x-user-agent": "skyvern-sdk",
+                body: {
+                    prompt: prompt,
+                    engine: options === null || options === void 0 ? void 0 : options.engine,
+                    model: options === null || options === void 0 ? void 0 : options.model,
+                    url: (_a = options === null || options === void 0 ? void 0 : options.url) !== null && _a !== void 0 ? _a : this._getPageUrl(),
+                    webhook_url: options === null || options === void 0 ? void 0 : options.webhookUrl,
+                    totp_identifier: options === null || options === void 0 ? void 0 : options.totpIdentifier,
+                    totp_url: options === null || options === void 0 ? void 0 : options.totpUrl,
+                    title: options === null || options === void 0 ? void 0 : options.title,
+                    error_code_mapping: options === null || options === void 0 ? void 0 : options.errorCodeMapping,
+                    data_extraction_schema: options === null || options === void 0 ? void 0 : options.dataExtractionSchema,
+                    max_steps: options === null || options === void 0 ? void 0 : options.maxSteps,
+                    browser_session_id: this._browser.browserSessionId,
+                    browser_address: this._browser.browserAddress,
+                },
+            });
+            if (this._browser.skyvern.environment === SkyvernEnvironment.Cloud) {
+                LOG.info("AI task is running, this may take a while", { url: getAppUrlForRun(taskRun.run_id), run_id: taskRun.run_id });
+            }
+            else {
+                LOG.info("AI task is running, this may take a while", { run_id: taskRun.run_id });
+            }
+            const completedRun = yield this._waitForRunCompletion(taskRun.run_id, (_b = options === null || options === void 0 ? void 0 : options.timeout) !== null && _b !== void 0 ? _b : DEFAULT_AGENT_TIMEOUT);
+            LOG.info("AI task finished", { run_id: completedRun.run_id, status: completedRun.status });
+            return completedRun;
+        });
+    }
+    /**
+     * Run a login task in the context of this page and wait for it to finish.
+     *
+     * @param credentialType - Type of credential store to use (e.g., skyvern, bitwarden, onepassword).
+     * @param options - Optional configuration
+     * @param options.url - URL to navigate to for login. If not provided, uses the current page URL.
+     * @param options.credentialId - ID of the credential to use.
+     * @param options.bitwardenCollectionId - Bitwarden collection ID containing the credentials.
+     * @param options.bitwardenItemId - Bitwarden item ID for the credentials.
+     * @param options.onepasswordVaultId - 1Password vault ID containing the credentials.
+     * @param options.onepasswordItemId - 1Password item ID for the credentials.
+     * @param options.prompt - Additional instructions for the login process.
+     * @param options.webhookUrl - URL to receive webhook notifications about login progress.
+     * @param options.totpIdentifier - Identifier for TOTP authentication.
+     * @param options.totpUrl - URL to fetch TOTP codes from.
+     * @param options.extraHttpHeaders - Additional HTTP headers to include in requests.
+     * @param options.timeout - Maximum time in seconds to wait for login completion.
+     *
+     * @returns WorkflowRunResponse containing the login workflow execution results.
+     */
+    login(credentialType, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            LOG.info("Starting AI login workflow", { credential_type: credentialType });
+            const workflowRun = yield this._browser.skyvern.login({
+                credential_type: credentialType,
+                url: (_a = options === null || options === void 0 ? void 0 : options.url) !== null && _a !== void 0 ? _a : this._getPageUrl(),
+                credential_id: options === null || options === void 0 ? void 0 : options.credentialId,
+                bitwarden_collection_id: options === null || options === void 0 ? void 0 : options.bitwardenCollectionId,
+                bitwarden_item_id: options === null || options === void 0 ? void 0 : options.bitwardenItemId,
+                onepassword_vault_id: options === null || options === void 0 ? void 0 : options.onepasswordVaultId,
+                onepassword_item_id: options === null || options === void 0 ? void 0 : options.onepasswordItemId,
+                prompt: options === null || options === void 0 ? void 0 : options.prompt,
+                webhook_url: options === null || options === void 0 ? void 0 : options.webhookUrl,
+                totp_identifier: options === null || options === void 0 ? void 0 : options.totpIdentifier,
+                totp_url: options === null || options === void 0 ? void 0 : options.totpUrl,
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                extra_http_headers: options === null || options === void 0 ? void 0 : options.extraHttpHeaders,
+            }, {
+                headers: { "x-user-agent": "skyvern-sdk" },
+            });
+            if (this._browser.skyvern.environment === SkyvernEnvironment.Cloud) {
+                LOG.info("AI login workflow is running, this may take a while", { url: getAppUrlForRun(workflowRun.run_id), run_id: workflowRun.run_id });
+            }
+            else {
+                LOG.info("AI login workflow is running, this may take a while", { run_id: workflowRun.run_id });
+            }
+            const completedRun = yield this._waitForRunCompletion(workflowRun.run_id, (_b = options === null || options === void 0 ? void 0 : options.timeout) !== null && _b !== void 0 ? _b : DEFAULT_AGENT_TIMEOUT);
+            LOG.info("AI login workflow finished", { run_id: completedRun.run_id, status: completedRun.status });
+            return completedRun;
+        });
+    }
+    /**
+     * Run a file download task in the context of this page and wait for it to finish.
+     *
+     * @param prompt - Instructions for navigating to and downloading the file.
+     * @param options - Optional configuration
+     * @param options.url - URL to navigate to for file download. If not provided, uses the current page URL.
+     * @param options.downloadSuffix - Suffix or complete filename for the downloaded file.
+     * @param options.downloadTimeout - Timeout in seconds for the download operation.
+     * @param options.maxStepsPerRun - Maximum number of steps to execute.
+     * @param options.webhookUrl - URL to receive webhook notifications about download progress.
+     * @param options.totpIdentifier - Identifier for TOTP authentication.
+     * @param options.totpUrl - URL to fetch TOTP codes from.
+     * @param options.extraHttpHeaders - Additional HTTP headers to include in requests.
+     * @param options.timeout - Maximum time in seconds to wait for download completion.
+     *
+     * @returns WorkflowRunResponse containing the file download workflow execution results.
+     */
+    downloadFiles(prompt, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            LOG.info("Starting AI file download workflow", { navigation_goal: prompt });
+            const workflowRun = yield this._browser.skyvern.downloadFiles({
+                navigation_goal: prompt,
+                url: (_a = options === null || options === void 0 ? void 0 : options.url) !== null && _a !== void 0 ? _a : this._getPageUrl(),
+                download_suffix: options === null || options === void 0 ? void 0 : options.downloadSuffix,
+                download_timeout: options === null || options === void 0 ? void 0 : options.downloadTimeout,
+                max_steps_per_run: options === null || options === void 0 ? void 0 : options.maxStepsPerRun,
+                webhook_url: options === null || options === void 0 ? void 0 : options.webhookUrl,
+                totp_identifier: options === null || options === void 0 ? void 0 : options.totpIdentifier,
+                totp_url: options === null || options === void 0 ? void 0 : options.totpUrl,
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                extra_http_headers: options === null || options === void 0 ? void 0 : options.extraHttpHeaders,
+            }, {
+                headers: { "x-user-agent": "skyvern-sdk" },
+            });
+            LOG.info("AI file download workflow is running, this may take a while", { run_id: workflowRun.run_id });
+            const completedRun = yield this._waitForRunCompletion(workflowRun.run_id, (_b = options === null || options === void 0 ? void 0 : options.timeout) !== null && _b !== void 0 ? _b : DEFAULT_AGENT_TIMEOUT);
+            LOG.info("AI file download workflow finished", { run_id: completedRun.run_id, status: completedRun.status });
+            return completedRun;
+        });
+    }
+    /**
+     * Run a workflow in the context of this page and wait for it to finish.
+     *
+     * @param workflowId - ID of the workflow to execute.
+     * @param options - Optional configuration
+     * @param options.parameters - Dictionary of parameters to pass to the workflow.
+     * @param options.template - Whether this is a workflow template.
+     * @param options.title - Human-readable title for this workflow run.
+     * @param options.webhookUrl - URL to receive webhook notifications about workflow progress.
+     * @param options.totpUrl - URL to fetch TOTP codes from.
+     * @param options.totpIdentifier - Identifier for TOTP authentication.
+     * @param options.timeout - Maximum time in seconds to wait for workflow completion.
+     *
+     * @returns WorkflowRunResponse containing the workflow execution results.
+     */
+    runWorkflow(workflowId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            LOG.info("Starting AI workflow", { workflow_id: workflowId });
+            const workflowRun = yield this._browser.skyvern.runWorkflow({
+                "x-user-agent": "skyvern-sdk",
+                template: options === null || options === void 0 ? void 0 : options.template,
+                body: {
+                    workflow_id: workflowId,
+                    parameters: options === null || options === void 0 ? void 0 : options.parameters,
+                    title: options === null || options === void 0 ? void 0 : options.title,
+                    webhook_url: options === null || options === void 0 ? void 0 : options.webhookUrl,
+                    totp_url: options === null || options === void 0 ? void 0 : options.totpUrl,
+                    totp_identifier: options === null || options === void 0 ? void 0 : options.totpIdentifier,
+                    browser_session_id: this._browser.browserSessionId,
+                    browser_address: this._browser.browserAddress,
+                },
+            }, {
+                headers: { "x-user-agent": "skyvern-sdk" },
+            });
+            if (this._browser.skyvern.environment === SkyvernEnvironment.Cloud) {
+                LOG.info("AI workflow is running, this may take a while", { url: getAppUrlForRun(workflowRun.run_id), run_id: workflowRun.run_id });
+            }
+            else {
+                LOG.info("AI workflow is running, this may take a while", { run_id: workflowRun.run_id });
+            }
+            const completedRun = yield this._waitForRunCompletion(workflowRun.run_id, (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : DEFAULT_AGENT_TIMEOUT);
+            LOG.info("AI workflow finished", { run_id: completedRun.run_id, status: completedRun.status });
+            return completedRun;
+        });
+    }
+    _waitForRunCompletion(runId, timeoutSeconds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const startTime = Date.now();
+            const timeoutMs = timeoutSeconds * 1000;
+            while (true) {
+                const run = yield this._browser.skyvern.getRun(runId);
+                // Check if the run is in a final state
+                const status = run.status;
+                if (status === "completed" ||
+                    status === "failed" ||
+                    status === "terminated" ||
+                    status === "timed_out" ||
+                    status === "canceled") {
+                    return run;
+                }
+                // Check timeout
+                if (Date.now() - startTime >= timeoutMs) {
+                    throw new Error(`Timeout waiting for run ${runId} to complete after ${timeoutSeconds} seconds`);
+                }
+                // Wait before polling again
+                yield new Promise((resolve) => setTimeout(resolve, DEFAULT_AGENT_HEARTBEAT_INTERVAL * 1000));
+            }
+        });
+    }
+    _getPageUrl() {
+        const url = this._page.url();
+        if (url === "about:blank") {
+            return undefined;
+        }
+        return url;
+    }
+}

package/dist/esm/library/SkyvernBrowserPageAi.d.mts

@@ -0,0 +1,85 @@
+import type { Page } from "playwright";
+import type { SkyvernBrowser } from "./SkyvernBrowser.mjs";
+export declare class SkyvernBrowserPageAi {
+    private readonly _browser;
+    private readonly _page;
+    constructor(browser: SkyvernBrowser, page: Page);
+    /**
+     * Click an element using AI via API call.
+     */
+    aiClick(options: {
+        selector?: string;
+        intention: string;
+        data?: string | Record<string, unknown>;
+        timeout?: number;
+    }): Promise<string | null>;
+    /**
+     * Input text into an element using AI via API call.
+     */
+    aiInputText(options: {
+        selector?: string;
+        value?: string;
+        intention: string;
+        data?: string | Record<string, unknown>;
+        totpIdentifier?: string;
+        totpUrl?: string;
+        timeout?: number;
+    }): Promise<string>;
+    /**
+     * Select an option from a dropdown using AI via API call.
+     */
+    aiSelectOption(options: {
+        selector?: string;
+        value?: string;
+        intention: string;
+        data?: string | Record<string, unknown>;
+        timeout?: number;
+    }): Promise<string>;
+    /**
+     * Upload a file using AI via API call.
+     */
+    aiUploadFile(options: {
+        selector?: string;
+        fileUrl?: string;
+        intention: string;
+        data?: string | Record<string, unknown>;
+        timeout?: number;
+    }): Promise<string>;
+    /**
+     * Extract information from the page using AI via API call.
+     */
+    aiExtract(options: {
+        prompt: string;
+        extractSchema?: Record<string, unknown> | unknown[] | string;
+        errorCodeMapping?: Record<string, string>;
+        intention?: string;
+        data?: string | Record<string, unknown>;
+    }): Promise<Record<string, unknown> | unknown[] | string | null>;
+    /**
+     * Validate the current page state using AI via API call.
+     */
+    aiValidate(options: {
+        prompt: string;
+        model?: Record<string, unknown>;
+    }): Promise<boolean>;
+    /**
+     * Perform an action on the page using AI via API call.
+     */
+    aiAct(prompt: string): Promise<void>;
+    /**
+     * Locate an element on the page using AI and return its XPath selector via API call.
+     *
+     * @param prompt - Natural language description of the element to locate (e.g., 'find "download invoices" button')
+     *
+     * @returns XPath selector string (e.g., 'xpath=//button[@id="download"]') or null if not found
+     */
+    aiLocateElement(prompt: string): Promise<string | null>;
+    /**
+     * Send a prompt to the LLM and get a response based on the provided schema via API call.
+     */
+    aiPrompt(options: {
+        prompt: string;
+        schema?: Record<string, unknown>;
+        model?: Record<string, unknown>;
+    }): Promise<Record<string, unknown> | unknown[] | string | null>;
+}

package/dist/esm/library/SkyvernBrowserPageAi.mjs

@@ -0,0 +1,244 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LOG } from "./logger.mjs";
+export class SkyvernBrowserPageAi {
+    constructor(browser, page) {
+        this._browser = browser;
+        this._page = page;
+    }
+    /**
+     * Click an element using AI via API call.
+     */
+    aiClick(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI click", { intention: options.intention, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "ai_click",
+                    selector: options.selector,
+                    intention: options.intention,
+                    data: options.data,
+                    timeout: options.timeout,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result ? String(response.result) : options.selector || null;
+        });
+    }
+    /**
+     * Input text into an element using AI via API call.
+     */
+    aiInputText(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI input text", { intention: options.intention, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "ai_input_text",
+                    selector: options.selector,
+                    value: options.value,
+                    intention: options.intention,
+                    data: options.data,
+                    totp_identifier: options.totpIdentifier,
+                    totp_url: options.totpUrl,
+                    timeout: options.timeout,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result ? String(response.result) : options.value || "";
+        });
+    }
+    /**
+     * Select an option from a dropdown using AI via API call.
+     */
+    aiSelectOption(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI select option", { intention: options.intention, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "ai_select_option",
+                    selector: options.selector,
+                    value: options.value,
+                    intention: options.intention,
+                    data: options.data,
+                    timeout: options.timeout,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result ? String(response.result) : options.value || "";
+        });
+    }
+    /**
+     * Upload a file using AI via API call.
+     */
+    aiUploadFile(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI upload file", { intention: options.intention, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "ai_upload_file",
+                    selector: options.selector,
+                    file_url: options.fileUrl,
+                    intention: options.intention,
+                    data: options.data,
+                    timeout: options.timeout,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result ? String(response.result) : options.fileUrl || "";
+        });
+    }
+    /**
+     * Extract information from the page using AI via API call.
+     */
+    aiExtract(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI extract", { prompt: options.prompt, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "extract",
+                    prompt: options.prompt,
+                    extract_schema: options.extractSchema,
+                    error_code_mapping: options.errorCodeMapping,
+                    intention: options.intention,
+                    data: options.data,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result || null;
+        });
+    }
+    /**
+     * Validate the current page state using AI via API call.
+     */
+    aiValidate(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI validate", { prompt: options.prompt, model: options.model, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "validate",
+                    prompt: options.prompt,
+                    model: options.model,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result != null ? Boolean(response.result) : false;
+        });
+    }
+    /**
+     * Perform an action on the page using AI via API call.
+     */
+    aiAct(prompt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI act", { prompt, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "ai_act",
+                    intention: prompt,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+        });
+    }
+    /**
+     * Locate an element on the page using AI and return its XPath selector via API call.
+     *
+     * @param prompt - Natural language description of the element to locate (e.g., 'find "download invoices" button')
+     *
+     * @returns XPath selector string (e.g., 'xpath=//button[@id="download"]') or null if not found
+     */
+    aiLocateElement(prompt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI locate element", { prompt, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "locate_element",
+                    prompt,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            if (response.result && typeof response.result === "string") {
+                return response.result;
+            }
+            return null;
+        });
+    }
+    /**
+     * Send a prompt to the LLM and get a response based on the provided schema via API call.
+     */
+    aiPrompt(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LOG.info("AI prompt", { prompt: options.prompt, model: options.model, workflow_run_id: this._browser.workflowRunId });
+            const response = yield this._browser.skyvern.runSdkAction({
+                url: this._page.url(),
+                browser_session_id: this._browser.browserSessionId,
+                browser_address: this._browser.browserAddress,
+                workflow_run_id: this._browser.workflowRunId,
+                action: {
+                    type: "prompt",
+                    prompt: options.prompt,
+                    schema: options.schema,
+                    model: options.model,
+                },
+            });
+            if (response.workflow_run_id) {
+                this._browser.workflowRunId = response.workflow_run_id;
+            }
+            return response.result || null;
+        });
+    }
+}

package/dist/esm/library/constants.d.mts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_AGENT_TIMEOUT = 1800;
+export declare const DEFAULT_AGENT_HEARTBEAT_INTERVAL = 10;
+export declare const DEFAULT_CDP_PORT = 9222;

package/dist/esm/library/constants.mjs

@@ -0,0 +1,3 @@
+export const DEFAULT_AGENT_TIMEOUT = 1800; // 30 minutes in seconds
+export const DEFAULT_AGENT_HEARTBEAT_INTERVAL = 10; // 10 seconds
+export const DEFAULT_CDP_PORT = 9222;

package/dist/esm/library/index.d.mts

@@ -0,0 +1,10 @@
+export { Skyvern } from "./Skyvern.mjs";
+export type { SkyvernOptions, RunTaskOptions, RunWorkflowOptions, LoginOptions, DownloadFilesOptions } from "./Skyvern.mjs";
+export { SkyvernBrowser } from "./SkyvernBrowser.mjs";
+export { SkyvernBrowserPageCore as SkyvernBrowserPageIml } from "./SkyvernBrowserPage.mjs";
+export type { SkyvernBrowserPage } from "./SkyvernBrowserPage.mjs";
+export { SkyvernBrowserPageAgent } from "./SkyvernBrowserPageAgent.mjs";
+export { SkyvernBrowserPageAi } from "./SkyvernBrowserPageAi.mjs";
+export { DEFAULT_AGENT_TIMEOUT, DEFAULT_AGENT_HEARTBEAT_INTERVAL, DEFAULT_CDP_PORT } from "./constants.mjs";
+export type { Logger } from "./logger.mjs";
+export { setLogger, LOG } from "./logger.mjs";

package/dist/esm/library/index.mjs

@@ -0,0 +1,7 @@
+export { Skyvern } from "./Skyvern.mjs";
+export { SkyvernBrowser } from "./SkyvernBrowser.mjs";
+export { SkyvernBrowserPageCore as SkyvernBrowserPageIml } from "./SkyvernBrowserPage.mjs";
+export { SkyvernBrowserPageAgent } from "./SkyvernBrowserPageAgent.mjs";
+export { SkyvernBrowserPageAi } from "./SkyvernBrowserPageAi.mjs";
+export { DEFAULT_AGENT_TIMEOUT, DEFAULT_AGENT_HEARTBEAT_INTERVAL, DEFAULT_CDP_PORT } from "./constants.mjs";
+export { setLogger, LOG } from "./logger.mjs";

package/dist/esm/library/logger.d.mts

@@ -0,0 +1,15 @@
+export interface Logger {
+    debug(message: string, context?: Record<string, unknown>): void;
+    info(message: string, context?: Record<string, unknown>): void;
+    warn(message: string, context?: Record<string, unknown>): void;
+    error(message: string, context?: Record<string, unknown>): void;
+}
+export declare function setLogger(logger: Logger): void;
+declare class StructuredLogger {
+    debug(message: string, context?: Record<string, unknown>): void;
+    info(message: string, context?: Record<string, unknown>): void;
+    warn(message: string, context?: Record<string, unknown>): void;
+    error(message: string, context?: Record<string, unknown>): void;
+}
+export declare const LOG: StructuredLogger;
+export {};