experimental-agent 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,20 +1,16 @@
 import * as _vercel_sandbox from '@vercel/sandbox';
-import { S as SandboxBinding, a as SandboxSetupFields, b as SandboxInstance, W as WithConfig, c as LoggingConfig, E as ExecResult, U as UploadableFile } from './steps-BnkRQKlc.js';
-export { d as SandboxAgentRef } from './steps-BnkRQKlc.js';
-import { L as LocalBindingConfig, a as LocalBindingMetadata, V as VercelBindingConfig, b as VercelBindingMetadata, D as DockerBindingConfig, c as DockerBindingMetadata } from './entry-BmQ8FO-5.js';
+import { S as SandboxBinding, a as SandboxSetupFields, b as SandboxInstance, W as WithConfig, c as LoggingConfig, E as ExecResult, U as UploadableFile } from './steps-XA4wG8W3.js';
+export { d as SandboxAgentRef } from './steps-XA4wG8W3.js';
+import { L as LocalBindingConfig, a as LocalBindingMetadata, V as VercelBindingConfig, b as VercelBindingMetadata, D as DockerBindingConfig, c as DockerBindingMetadata } from './entry-QNyd4S1s.js';
+import { G as GenerationOptions, j as StorageInput, f as Storage, c as Session } from './adapter-Cl735Kp4.js';
 import * as ai from 'ai';
-import { InferToolInput, ModelMessage, ToolSet, UIMessage, InferUITools, GatewayModelId } from 'ai';
-import { b as Session, e as Storage, i as StorageInput } from './adapter-BigchkkI.js';
+import { ToolSet, InferToolInput, ModelMessage, UIMessage, InferUITools, GatewayModelId } from 'ai';
 import { z } from 'zod';
 import { WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@workflow/serde';
 import * as errore from 'errore';
 
 type BuiltInBindings = SandboxBinding<"local", LocalBindingConfig, LocalBindingMetadata> | SandboxBinding<"vercel", VercelBindingConfig, VercelBindingMetadata> | SandboxBinding<"docker", DockerBindingConfig, DockerBindingMetadata>;
 
-type SandboxOptions = {
-    id?: string;
-};
-
 type SetupCommonFields = Partial<SandboxSetupFields> & {
     cwd?: string;
     run?: (sandbox: SandboxInstance) => Promise<void>;
@@ -32,6 +28,10 @@ type SetupResult = {
     done: Promise<SandboxInstance>;
 };
 
+type SandboxOptions = {
+    id?: string;
+};
+
 type StepUsage = {
     stepIndex: number;
     model: string;
@@ -59,22 +59,59 @@ type SessionUsage = {
     byMessageId: Record<string, UsageSummary | null>;
 };
 
-type StreamOptions = {
-    messageId?: string;
-    startIndex?: number;
+type SkillSourceType = "sandbox" | "host" | "git" | "inline";
+type SandboxSkillInput = {
+    type: "sandbox";
+    path: string;
 };
-type WorkflowRunLike = {
-    getReadable(options?: {
-        startIndex?: number;
-    }): ReadableStream;
+type HostSkillInput = {
+    type: "host";
+    path: string;
 };
-
-type ToolContext<TContext = Record<string, unknown>> = {
-    session: Session;
-    sandbox: SandboxInstance;
-    storage: Storage;
-    context: TContext;
+type GitSkillInput = {
+    type: "git";
+    repo: string;
+    ref?: string;
+    path?: string;
+    /**
+     * Skill directory name under `path`.
+     */
+    name?: string;
+};
+type InlineSkillInput = {
+    type: "inline";
+    name: string;
+    description: string;
+    instructions: string;
+};
+type SkillInput = SandboxSkillInput | HostSkillInput | GitSkillInput | InlineSkillInput;
+type SandboxSkillEntry = {
+    type: "sandbox";
+    path: string;
+};
+type HostSkillEntry = {
+    type: "host";
+    path: string;
+};
+type GitSkillEntry = {
+    type: "git";
+    repo: string;
+    ref?: string;
+    path?: string;
+    /**
+     * Skill directory name under `path`.
+     */
+    name?: string;
 };
+type InlineSkillEntry = {
+    type: "inline";
+    name: string;
+    description: string;
+    instructions: string;
+};
+type SkillEntry = SandboxSkillEntry | HostSkillEntry | GitSkillEntry | InlineSkillEntry;
+
+type ToolContext<TContext = Record<string, unknown>, Tools extends ToolSet = ToolSet> = ResolvableArgs<TContext, Tools>;
 declare const builtInTools: {
     Read: ai.Tool<{
         label: string;
@@ -231,15 +268,41 @@ type NeedsApprovalMap<Tools> = {
 };
 type InferUIMessage<A> = A extends {
     tools: infer T extends ToolSet;
+    $UIMessage: UIMessage<infer M>;
+} ? UIMessage<M, AgentDataTypes, InferUITools<T>> : A extends {
+    tools: infer T extends ToolSet;
 } ? UIMessage<unknown, AgentDataTypes, InferUITools<T>> : UIMessage<unknown, AgentDataTypes>;
-type TypedUIMessage<Tools extends ToolSet = ToolSet> = UIMessage<unknown, AgentDataTypes, InferUITools<Tools>>;
+type TypedUIMessage<TMessageMetadata = unknown, Tools extends ToolSet = ToolSet> = UIMessage<TMessageMetadata, AgentDataTypes, InferUITools<Tools>>;
 
-type UpdateOptions<Tools extends ToolSet> = Partial<Omit<Session, "id" | "activeTools" | "model"> & {
-    model?: GatewayModelId;
-    activeTools?: (Extract<keyof Tools, string> | BuiltInToolName)[];
-}>;
+type StreamOptions = {
+    messageId?: string;
+    startIndex?: number;
+};
+type WorkflowRunLike = {
+    getReadable(options?: {
+        startIndex?: number;
+    }): ReadableStream;
+};
 
-type SendOptions<Tools extends ToolSet, TContext> = {
+type ApprovalData = {
+    approvalId: string;
+    approved: boolean;
+    reason?: string;
+};
+type MessageData<Tools extends ToolSet> = UIMessage | {
+    role?: TypedUIMessage<unknown, Tools>["role"];
+    parts: TypedUIMessage<unknown, Tools>["parts"];
+    metadata?: Record<string, unknown> | null;
+    id?: string;
+};
+type SendInput<Tools extends ToolSet> = string | MessageData<Tools> | {
+    type: "message";
+    message: MessageData<Tools>;
+} | {
+    type: "approval";
+    approval: ApprovalData;
+};
+type SendOptions<TContext> = {
     interruptIfStreaming?: boolean | {
         lastPart: {
             index: number;
@@ -248,7 +311,8 @@ type SendOptions<Tools extends ToolSet, TContext> = {
     };
     context?: TContext;
     abortSignal?: AbortSignal;
-} & UpdateOptions<Tools>;
+    sandboxId?: string;
+};
 type SendResult = {
     assistantMessageId: string;
     done: true | Promise<true>;
@@ -261,14 +325,21 @@ type InterruptOptions = {
     };
 };
 
-type SessionDefaults<Tools extends ToolSet = ToolSet> = {
-    model?: GatewayModelId;
-    system?: string;
-    generation?: Session["generation"];
-    activeTools?: (Extract<keyof Tools, string> | BuiltInToolName)[];
-    skillsDir?: string | string[];
+type ResolvableArgs<TContext = Record<string, unknown>, Tools extends ToolSet = ToolSet> = {
+    context: TContext;
+    sessionId: string;
+    sandbox: SandboxInstance;
+    messages: UIMessage<unknown, AgentDataTypes, InferUITools<Tools>>[];
 };
-type AgentOptions<Tools extends ToolSet = any, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>> = SessionDefaults<Tools> & {
+type Resolvable<T, TContext = Record<string, unknown>, Tools extends ToolSet = ToolSet> = T | ((args: ResolvableArgs<TContext, Tools>) => T | Promise<T>);
+type SessionDefaults<Tools extends ToolSet = ToolSet, TContext extends Record<string, unknown> = Record<string, unknown>> = {
+    model?: Resolvable<GatewayModelId | undefined, TContext, Tools>;
+    system?: Resolvable<string | string[] | undefined, TContext, Tools>;
+    generation?: Resolvable<GenerationOptions | undefined, TContext, Tools>;
+    activeTools?: Resolvable<readonly (Extract<keyof Tools, string> | BuiltInToolName)[] | undefined, TContext, Tools>;
+    skills?: Resolvable<SkillInput[] | undefined, TContext, Tools>;
+};
+type AgentOptions<Tools extends ToolSet = any, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>> = SessionDefaults<Tools, TContext> & {
     storage?: StorageInput;
     sandbox?: TSandboxBindings;
     tools?: Tools;
@@ -277,10 +348,10 @@ type AgentOptions<Tools extends ToolSet = any, TSandboxBindings extends SandboxB
     contextSchema?: z.ZodType<TContext>;
     logging?: Omit<LoggingConfig, "name">;
 };
-type AnyAgent = Agent<any, any, any>;
+type AnyAgent = Agent<any, any, any, any>;
 type InferSession<Agent extends AnyAgent = AnyAgent> = ReturnType<Agent["session"]>;
 type SessionSendArgs<Agent extends AnyAgent, Session extends InferSession<Agent> = InferSession<Agent>> = Parameters<Session["send"]>;
-declare class Agent<Tools extends ToolSet, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>> {
+declare class Agent<TMessageMetadata = unknown, Tools extends ToolSet = ToolSet, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>> {
     readonly name: string;
     options: AgentOptions<Tools, TSandboxBindings, TContext>;
     constructor(name: string, options?: AgentOptions<Tools, TSandboxBindings, TContext>);
@@ -290,53 +361,16 @@ declare class Agent<Tools extends ToolSet, TSandboxBindings extends SandboxBindi
     static [WORKFLOW_DESERIALIZE](data: {
         name: string;
     }): AnyAgent;
-    private _storageWarned;
+    private _resolvedStorage;
     get storage(): Storage;
     get tools(): typeof builtInTools & Tools;
-    get sessionDefaults(): SessionDefaults;
     get hooks(): AgentHooks;
     readonly session: (id?: string | {
         id?: string;
     } | undefined) => {
         id: string;
-        send: (input: (string | {
-            type: "approval";
-            approval: {
-                approvalId: string;
-                approved: boolean;
-                reason?: string;
-            };
-        } | (UIMessage<unknown, ai.UIDataTypes, ai.UITools> | {
-            role?: TypedUIMessage<Tools_1>["role"];
-            parts: ai.UIMessagePart<AgentDataTypes, InferUITools<Tools>>[];
-            id?: string;
-        }) | {
-            type: "message";
-            message: UIMessage<unknown, ai.UIDataTypes, ai.UITools> | {
-                role?: TypedUIMessage<Tools_1>["role"];
-                parts: ai.UIMessagePart<AgentDataTypes, InferUITools<Tools>>[];
-                id?: string;
-            };
-        }) | (string | {
-            type: "approval";
-            approval: {
-                approvalId: string;
-                approved: boolean;
-                reason?: string;
-            };
-        } | (UIMessage<unknown, ai.UIDataTypes, ai.UITools> | {
-            role?: TypedUIMessage<Tools_1>["role"];
-            parts: ai.UIMessagePart<AgentDataTypes, InferUITools<Tools>>[];
-            id?: string;
-        }) | {
-            type: "message";
-            message: UIMessage<unknown, ai.UIDataTypes, ai.UITools> | {
-                role?: TypedUIMessage<Tools_1>["role"];
-                parts: ai.UIMessagePart<AgentDataTypes, InferUITools<Tools>>[];
-                id?: string;
-            };
-        })[], opts?: SendOptions<Tools, TContext> | undefined) => Promise<SendResult>;
-        stream: (runOrOpts?: WorkflowRunLike | StreamOptions | undefined) => Promise<ReadableStream<ai.UIMessageChunk>>;
+        send: (input: SendInput<Tools> | SendInput<Tools>[], opts?: SendOptions<TContext> | undefined) => Promise<SendResult>;
+        stream: (runOrOpts?: StreamOptions | WorkflowRunLike | undefined) => Promise<ReadableStream<ai.UIMessageChunk>>;
         history: () => Promise<{
             messages: UIMessage<unknown, AgentDataTypes, InferUITools<Tools>>[];
             streamingMessageId: string | null;
@@ -344,10 +378,53 @@ declare class Agent<Tools extends ToolSet, TSandboxBindings extends SandboxBindi
         }>;
         interrupt: (opts?: InterruptOptions | undefined) => Promise<void>;
         usage: () => Promise<SessionUsage>;
-        update: (opts: Partial<Omit<Session, "id" | "model" | "activeTools"> & {
-            model?: GatewayModelId;
-            activeTools?: ("Read" | "Grep" | "List" | "Write" | "Edit" | "Bash" | "Skill" | "JavaScript" | Extract<keyof Tools, string>)[] | undefined;
-        }>) => Promise<void>;
+        update: (opts: Partial<Omit<Session, "id" | "createdAt" | "updatedAt">>) => Promise<void>;
+        sandbox: {
+            setup: (opts?: SetupOpts<TSandboxBindings> | undefined) => Promise<SetupResult>;
+            exec: (opts: {
+                command: string;
+                args?: string[];
+                cwd?: string;
+                env?: Record<string, string>;
+                sudo?: boolean;
+                signal?: AbortSignal;
+            }) => Promise<ExecResult>;
+            stop: (opts?: {
+                signal?: AbortSignal;
+            } | undefined) => Promise<void>;
+            snapshot: (opts?: {
+                signal?: AbortSignal;
+            } | undefined) => Promise<{
+                snapshotId: string;
+            }>;
+            getDomain: (opts: {
+                port: number;
+                signal?: AbortSignal;
+            }) => Promise<string>;
+            getStatus: (opts?: {
+                signal?: AbortSignal;
+            } | undefined) => Promise<"pending" | "running" | "stopping" | "stopped" | "failed">;
+            kill: (opts: {
+                commandId: string;
+                signal?: AbortSignal;
+            }) => Promise<void>;
+            readFile: (opts: {
+                path: string;
+                signal?: AbortSignal;
+            }) => Promise<Buffer | null>;
+            start: (opts?: {
+                signal?: AbortSignal;
+            } | undefined) => Promise<void>;
+            updateNetworkPolicy: (opts: {
+                policy: _vercel_sandbox.NetworkPolicy;
+                signal?: AbortSignal;
+            }) => Promise<_vercel_sandbox.NetworkPolicy>;
+            writeFiles: (opts: {
+                files: UploadableFile[];
+                destPath: string;
+                signal?: AbortSignal;
+            }) => Promise<void>;
+        };
     };
     readonly sandbox: (id?: string | SandboxOptions | undefined) => {
         id: string;
@@ -398,9 +475,9 @@ declare class Agent<Tools extends ToolSet, TSandboxBindings extends SandboxBindi
         } | undefined) => Promise<"pending" | "running" | "stopping" | "stopped" | "failed">;
     };
     /** Phantom property for type inference. Use `typeof myAgent.$UIMessage` to get the typed UIMessage. */
-    readonly $UIMessage: UIMessage<unknown, AgentDataTypes, InferUITools<typeof builtInTools & Tools>>;
+    readonly $UIMessage: UIMessage<TMessageMetadata, AgentDataTypes, InferUITools<typeof builtInTools & Tools>>;
 }
-declare function agent<Tools extends ToolSet, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>>(name: string, options?: AgentOptions<Tools, TSandboxBindings, TContext>): Agent<Tools, TSandboxBindings, TContext>;
+declare function agent<TMessageMetadata = unknown, Tools extends ToolSet = ToolSet, TSandboxBindings extends SandboxBinding | SandboxBinding[] = SandboxBinding, TContext extends Record<string, unknown> = Record<string, never>>(name: string, options?: AgentOptions<Tools, TSandboxBindings, TContext>): Agent<TMessageMetadata, Tools, TSandboxBindings, TContext>;
 
 declare const SessionNotFoundError_base: errore.FactoryTaggedErrorClass<"SessionNotFoundError", "Session $id not found", Error>;
 declare class SessionNotFoundError extends SessionNotFoundError_base {
@@ -421,4 +498,4 @@ declare const MessageNotFoundError_base: errore.FactoryTaggedErrorClass<"Message
 declare class MessageNotFoundError extends MessageNotFoundError_base {
 }
 
-export { type AgentDataTypes, type AgentHooks, type AgentOptions, AgentStatus, type AnyAgent, type BuiltInToolName, ExecResult, type InferSession, type InferUIMessage, MessageNotFoundError, type NeedsApprovalMap, SandboxBinding, SandboxError, SandboxInstance, SandboxNotFoundError, SandboxSetupFields, type SessionDefaults, SessionNotFoundError, type SessionSendArgs, type StepUsage, StorageConflictError, StorageError, type ToolContext, UploadableFile, type UsageSummary, type WorkflowRunLike, agent, builtinToolNames };
+export { type AgentDataTypes, type AgentHooks, type AgentOptions, AgentStatus, type AnyAgent, type ApprovalData, type BuiltInToolName, ExecResult, type GitSkillEntry, type GitSkillInput, type HostSkillEntry, type HostSkillInput, type InferSession, type InferUIMessage, type InlineSkillEntry, type InlineSkillInput, MessageNotFoundError, type NeedsApprovalMap, type Resolvable, type ResolvableArgs, SandboxBinding, SandboxError, SandboxInstance, SandboxNotFoundError, SandboxSetupFields, type SandboxSkillEntry, type SandboxSkillInput, type SendInput, type SessionDefaults, SessionNotFoundError, type SessionSendArgs, type SkillEntry, type SkillInput, type SkillSourceType, type StepUsage, StorageConflictError, StorageError, type ToolContext, UploadableFile, type UsageSummary, type WorkflowRunLike, agent, builtinToolNames };