@agentrun/sdk 0.0.3 → 0.0.4

package/dist/integration/builtin/index.d.cts

@@ -0,0 +1,692 @@
+import { C as CommonToolSet } from '../../tool-CG0LY-ov.cjs';
+export { a as CanonicalTool, T as Tool, b as ToolDefinition, c as ToolFunction, d as ToolParameter, e as ToolParametersSchema, n as normalizeToolName, t as tool } from '../../tool-CG0LY-ov.cjs';
+import { C as Config } from '../../config-07gMelJP.cjs';
+import { SandboxClient, Sandbox } from '../../sandbox/index.cjs';
+import { p as TemplateType, C as CodeLanguage } from '../../model-BV7A6Trb.cjs';
+import { T as ToolSet } from '../../toolset-BYDvhwRp.cjs';
+import { h as ModelService, d as ModelProxy, B as BackendType } from '../../model-service-VpzBb7rV.cjs';
+import '../../resource-CQovFUeh.cjs';
+import '../../model--I90nCqy.cjs';
+import 'ai';
+
+/**
+ * Sandbox ToolSet Module
+ *
+ * Provides sandbox toolsets for code interpreter and browser automation.
+ * 提供代码解释器和浏览器自动化的沙箱工具集。
+ */
+
+/**
+ * Base SandboxToolSet class
+ * 沙箱工具集基类
+ *
+ * Provides sandbox lifecycle management and tool execution infrastructure.
+ */
+declare abstract class SandboxToolSet extends CommonToolSet {
+    protected config?: Config;
+    protected client: SandboxClient;
+    protected templateName: string;
+    protected templateType: TemplateType;
+    protected sandboxIdleTimeoutSeconds: number;
+    protected sandbox: Sandbox | null;
+    protected sandboxId: string;
+    constructor(options: {
+        templateName: string;
+        templateType: TemplateType;
+        sandboxIdleTimeoutSeconds?: number;
+        config?: Config;
+    });
+    /**
+     * Close and release sandbox resources
+     */
+    close(): void;
+    /**
+     * Ensure sandbox instance exists
+     */
+    protected ensureSandbox: () => Promise<Sandbox>;
+    /**
+     * Run operation in sandbox with auto-retry
+     */
+    protected runInSandbox: <T>(callback: (sb: Sandbox) => Promise<T>) => Promise<T>;
+}
+/**
+ * Code Interpreter ToolSet
+ * 代码解释器沙箱工具集
+ *
+ * Provides code execution, file operations, and process management capabilities.
+ */
+declare class CodeInterpreterToolSet extends SandboxToolSet {
+    constructor(options: {
+        templateName: string;
+        config?: Config;
+        sandboxIdleTimeoutSeconds?: number;
+    });
+    private _createTools;
+    checkHealth: () => Promise<{
+        [key: string]: any;
+        status: string;
+    }>;
+    runCode: (code: string, language?: string, timeout?: number, contextId?: string) => Promise<{
+        stdout: any;
+        stderr: any;
+        exit_code: any;
+        result: any;
+    }>;
+    listContexts: () => Promise<{
+        contexts: any;
+    }>;
+    createContext: (language?: string, cwd?: string) => Promise<{
+        context_id: string | undefined;
+        language: CodeLanguage;
+        cwd: string;
+    }>;
+    deleteContext: (contextId: string) => Promise<{
+        success: boolean;
+        result: any;
+    }>;
+    readFile: (path: string) => Promise<{
+        path: string;
+        content: any;
+    }>;
+    writeFile: (path: string, content: string, mode?: string, encoding?: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemList: (path?: string, depth?: number) => Promise<{
+        path: string;
+        entries: any;
+    }>;
+    fileSystemStat: (path: string) => Promise<{
+        path: string;
+        stat: any;
+    }>;
+    fileSystemMkdir: (path: string, parents?: boolean, mode?: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemMove: (source: string, destination: string) => Promise<{
+        source: string;
+        destination: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemRemove: (path: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    processExecCmd: (command: string, cwd?: string, timeout?: number) => Promise<{
+        command: string;
+        stdout: any;
+        stderr: any;
+        exit_code: any;
+        result: any;
+    }>;
+    processList: () => Promise<{
+        processes: any;
+    }>;
+    processKill: (pid: string) => Promise<{
+        pid: string;
+        success: boolean;
+        result: any;
+    }>;
+}
+/**
+ * Browser ToolSet
+ * 浏览器沙箱工具集
+ *
+ * Provides browser automation capabilities compatible with Playwright-style APIs.
+ * Requires optional 'playwright' peer dependency for full functionality.
+ */
+declare class BrowserToolSet extends SandboxToolSet {
+    private playwrightBrowser;
+    private currentPage;
+    private pages;
+    constructor(options: {
+        templateName: string;
+        config?: Config;
+        sandboxIdleTimeoutSeconds?: number;
+    });
+    /**
+     * Load Playwright dynamically (optional dependency)
+     */
+    private loadPlaywright;
+    /**
+     * Ensure Playwright browser is connected
+     */
+    private ensurePlaywright;
+    /**
+     * Close Playwright browser connection
+     */
+    close(): void;
+    private _createTools;
+    checkHealth: () => Promise<{
+        [key: string]: any;
+        status: string;
+    }>;
+    browserNavigate: (url: string) => Promise<{
+        url: string;
+        success: boolean;
+        title: string;
+        error?: undefined;
+    } | {
+        url: string;
+        success: boolean;
+        error: string;
+        title?: undefined;
+    }>;
+    browserNavigateBack: () => Promise<{
+        success: boolean;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        error: string;
+        url?: undefined;
+    }>;
+    browserSnapshot: () => Promise<{
+        html: string;
+        title: string;
+        url: string;
+        error?: undefined;
+    } | {
+        html: string;
+        title: string;
+        error: string;
+        url?: undefined;
+    }>;
+    browserTakeScreenshot: (fullPage?: boolean, type?: string) => Promise<{
+        screenshot: string;
+        format: string;
+        full_page: boolean;
+        error?: undefined;
+    } | {
+        screenshot: string;
+        format: string;
+        full_page: boolean;
+        error: string;
+    }>;
+    browserClick: (selector: string) => Promise<{
+        selector: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserFill: (selector: string, value: string) => Promise<{
+        selector: string;
+        value: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        value: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserType: (selector: string, text: string) => Promise<{
+        selector: string;
+        text: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        text: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserHover: (selector: string) => Promise<{
+        selector: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserEvaluate: (expression: string) => Promise<{
+        result: unknown;
+        success: boolean;
+        error?: undefined;
+    } | {
+        result: null;
+        success: boolean;
+        error: string;
+    }>;
+    browserWaitFor: (timeout: number) => Promise<{
+        success: boolean;
+        waited_ms: number;
+        error?: undefined;
+    } | {
+        success: boolean;
+        waited_ms: number;
+        error: string;
+    }>;
+    browserTabsList: () => Promise<{
+        tabs: {
+            index: number;
+            url: string;
+            active: boolean;
+        }[];
+        count: number;
+        error?: undefined;
+    } | {
+        tabs: never[];
+        count: number;
+        error: string;
+    }>;
+    browserTabsNew: (url?: string) => Promise<{
+        success: boolean;
+        index: number;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        url: string;
+        error: string;
+        index?: undefined;
+    }>;
+    browserTabsSelect: (index: number) => Promise<{
+        success: boolean;
+        index: number;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        index: number;
+        error: string;
+        url?: undefined;
+    }>;
+}
+/**
+ * Browser ToolSet
+ * 浏览器沙箱工具集
+ *
+ * Provides browser automation capabilities compatible with Playwright-style APIs.
+ * Requires optional 'playwright' peer dependency for full functionality.
+ */
+declare class AIOToolSet extends SandboxToolSet {
+    private playwrightAIO;
+    private currentPage;
+    private pages;
+    constructor(options: {
+        templateName: string;
+        config?: Config;
+        sandboxIdleTimeoutSeconds?: number;
+    });
+    /**
+     * Load Playwright dynamically (optional dependency)
+     */
+    private loadPlaywright;
+    /**
+     * Ensure Playwright browser is connected
+     */
+    private ensurePlaywright;
+    /**
+     * Close Playwright browser connection
+     */
+    close(): void;
+    private _createTools;
+    checkHealth: () => Promise<{
+        [key: string]: any;
+        status: string;
+    }>;
+    browserNavigate: (url: string) => Promise<{
+        url: string;
+        success: boolean;
+        title: string;
+        error?: undefined;
+    } | {
+        url: string;
+        success: boolean;
+        error: string;
+        title?: undefined;
+    }>;
+    browserNavigateBack: () => Promise<{
+        success: boolean;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        error: string;
+        url?: undefined;
+    }>;
+    browserSnapshot: () => Promise<{
+        html: string;
+        title: string;
+        url: string;
+        error?: undefined;
+    } | {
+        html: string;
+        title: string;
+        error: string;
+        url?: undefined;
+    }>;
+    browserTakeScreenshot: (fullPage?: boolean, type?: string) => Promise<{
+        screenshot: string;
+        format: string;
+        full_page: boolean;
+        error?: undefined;
+    } | {
+        screenshot: string;
+        format: string;
+        full_page: boolean;
+        error: string;
+    }>;
+    browserClick: (selector: string) => Promise<{
+        selector: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserFill: (selector: string, value: string) => Promise<{
+        selector: string;
+        value: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        value: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserType: (selector: string, text: string) => Promise<{
+        selector: string;
+        text: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        text: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserHover: (selector: string) => Promise<{
+        selector: string;
+        success: boolean;
+        error?: undefined;
+    } | {
+        selector: string;
+        success: boolean;
+        error: string;
+    }>;
+    browserEvaluate: (expression: string) => Promise<{
+        result: unknown;
+        success: boolean;
+        error?: undefined;
+    } | {
+        result: null;
+        success: boolean;
+        error: string;
+    }>;
+    browserWaitFor: (timeout: number) => Promise<{
+        success: boolean;
+        waited_ms: number;
+        error?: undefined;
+    } | {
+        success: boolean;
+        waited_ms: number;
+        error: string;
+    }>;
+    browserTabsList: () => Promise<{
+        tabs: {
+            index: number;
+            url: string;
+            active: boolean;
+        }[];
+        count: number;
+        error?: undefined;
+    } | {
+        tabs: never[];
+        count: number;
+        error: string;
+    }>;
+    browserTabsNew: (url?: string) => Promise<{
+        success: boolean;
+        index: number;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        url: string;
+        error: string;
+        index?: undefined;
+    }>;
+    browserTabsSelect: (index: number) => Promise<{
+        success: boolean;
+        index: number;
+        url: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        index: number;
+        error: string;
+        url?: undefined;
+    }>;
+    runCode: (code: string, language?: string, timeout?: number, contextId?: string) => Promise<{
+        stdout: any;
+        stderr: any;
+        exit_code: any;
+        result: any;
+    }>;
+    listContexts: () => Promise<{
+        contexts: any;
+    }>;
+    createContext: (language?: string, cwd?: string) => Promise<{
+        context_id: string | undefined;
+        language: CodeLanguage;
+        cwd: string;
+    }>;
+    deleteContext: (contextId: string) => Promise<{
+        success: boolean;
+        result: any;
+    }>;
+    readFile: (path: string) => Promise<{
+        path: string;
+        content: any;
+    }>;
+    writeFile: (path: string, content: string, mode?: string, encoding?: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemList: (path?: string, depth?: number) => Promise<{
+        path: string;
+        entries: any;
+    }>;
+    fileSystemStat: (path: string) => Promise<{
+        path: string;
+        stat: any;
+    }>;
+    fileSystemMkdir: (path: string, parents?: boolean, mode?: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemMove: (source: string, destination: string) => Promise<{
+        source: string;
+        destination: string;
+        success: boolean;
+        result: any;
+    }>;
+    fileSystemRemove: (path: string) => Promise<{
+        path: string;
+        success: boolean;
+        result: any;
+    }>;
+    processExecCmd: (command: string, cwd?: string, timeout?: number) => Promise<{
+        command: string;
+        stdout: any;
+        stderr: any;
+        exit_code: any;
+        result: any;
+    }>;
+    processList: () => Promise<{
+        processes: any;
+    }>;
+    processKill: (pid: string) => Promise<{
+        pid: string;
+        success: boolean;
+        result: any;
+    }>;
+}
+/**
+ * Create a sandbox toolset
+ * 创建沙箱工具集
+ */
+declare function sandboxToolset(templateName: string, options?: {
+    config?: Config;
+    sandboxIdleTimeoutSeconds?: number;
+}): Promise<CodeInterpreterToolSet | BrowserToolSet | AIOToolSet>;
+
+/**
+ * Built-in ToolSet Integration Functions
+ * 内置工具集集成函数
+ *
+ * Provides convenient functions for quickly creating common toolset objects.
+ * 提供快速创建通用工具集对象的便捷函数。
+ */
+
+/**
+ * Wrap built-in toolset as CommonToolSet
+ * 将内置工具集封装为通用工具集
+ *
+ * Supports creating CommonToolSet from toolset name or ToolSet instance.
+ * 支持从工具集名称或 ToolSet 实例创建通用工具集。
+ *
+ * @param input - Toolset name or ToolSet instance / 工具集名称或 ToolSet 实例
+ * @param config - Configuration object / 配置对象
+ * @returns CommonToolSet instance / 通用工具集实例
+ *
+ * @example
+ * ```typescript
+ * // Create from toolset name
+ * const ts = await toolset("my-toolset");
+ *
+ * // Create from ToolSet instance
+ * const toolsetObj = await new ToolSetClient().get({ name: "my-toolset" });
+ * const ts = await toolset(toolsetObj);
+ *
+ * // Convert to OpenAI functions
+ * const openaiTools = ts.toOpenAIFunctions();
+ *
+ * // Convert to Mastra tools
+ * const mastraTools = await ts.toMastra();
+ * ```
+ */
+declare function toolset(input: string | ToolSet, config?: Config): Promise<CommonToolSet>;
+
+/**
+ * Built-in Model Integration Functions
+ * 内置模型集成函数
+ *
+ * Provides convenient functions for quickly creating common model objects.
+ * 提供快速创建通用模型对象的便捷函数。
+ */
+
+/**
+ * Model arguments interface
+ */
+interface ModelArgs {
+    /** Model name to request */
+    model?: string;
+    /** Backend type (proxy or service) */
+    backendType?: BackendType;
+    /** Configuration object */
+    config?: Config;
+}
+/**
+ * Common Model wrapper class
+ * 通用模型封装类
+ *
+ * Wraps AgentRun model and provides cross-framework conversion capabilities.
+ */
+declare class CommonModel {
+    private modelObj;
+    private _backendType?;
+    private specificModel?;
+    private _config?;
+    constructor(options: {
+        modelObj: ModelService | ModelProxy;
+        backendType?: BackendType;
+        specificModel?: string;
+        config?: Config;
+    });
+    /**
+     * Get model info
+     */
+    getModelInfo(config?: Config): Promise<{
+        baseUrl: string;
+        apiKey?: string;
+        model: string;
+        headers?: Record<string, string>;
+    }>;
+    /**
+     * Get the underlying model object
+     */
+    get model(): ModelService | ModelProxy;
+    /**
+     * Get backend type
+     */
+    get backendType(): BackendType | undefined;
+    /**
+     * Get model name from the underlying model object
+     */
+    private getModelName;
+    /**
+     * Convert to Mastra-compatible model
+     * Returns a model compatible with Mastra framework using AI SDK
+     */
+    toMastra(): Promise<unknown>;
+    /**
+     * Convert to OpenAI-compatible configuration
+     * Returns configuration that can be used with OpenAI SDK
+     */
+    toOpenAI(): Promise<{
+        baseURL: string;
+        apiKey?: string;
+        defaultHeaders?: Record<string, string>;
+        defaultQuery?: Record<string, string>;
+    }>;
+}
+/**
+ * Get AgentRun model and wrap as CommonModel
+ * 获取 AgentRun 模型并封装为通用 Model 对象
+ *
+ * Equivalent to ModelClient.get(), but returns a CommonModel object.
+ * 等价于 ModelClient.get()，但返回通用 Model 对象。
+ *
+ * @param input - AgentRun model name, ModelProxy, or ModelService instance
+ * @param args - Additional arguments (model, backendType, config)
+ * @returns CommonModel instance
+ *
+ * @example
+ * ```typescript
+ * // Create from model name
+ * const m = await model("qwen-max");
+ *
+ * // Create from ModelProxy
+ * const proxy = await new ModelClient().get({ name: "my-proxy", backendType: "proxy" });
+ * const m = await model(proxy);
+ *
+ * // Create from ModelService
+ * const service = await new ModelClient().get({ name: "my-service", backendType: "service" });
+ * const m = await model(service);
+ *
+ * // Convert to Mastra model
+ * const mastraModel = await m.toMastra();
+ *
+ * // Get OpenAI-compatible config
+ * const openaiConfig = await m.toOpenAI();
+ * ```
+ */
+declare function model(input: string | ModelProxy | ModelService, args?: ModelArgs): Promise<CommonModel>;
+
+export { BrowserToolSet, CodeInterpreterToolSet, CommonModel, CommonToolSet, type ModelArgs, SandboxToolSet, model, sandboxToolset, toolset };