openbot 0.3.6 → 0.4.2

package/src/app/types.ts

@@ -6,9 +6,9 @@ import {
   PluginDescriptor,
   Thread,
   ThreadDetails,
-} from '../bus/types.js';
-import type { PluginRef } from '../bus/plugin.js';
-import type { MemoryRecord } from '../services/memory.js';
+} from '../services/plugins/domain.js';
+import type { PluginRef } from '../services/plugins/types.js';
+import type { MemoryRecord } from '../plugins/memory/service.js';
 
 export interface OpenBotState {
   agentId: string;
@@ -19,15 +19,16 @@ export interface OpenBotState {
   channelDetails?: ChannelDetails;
   threadDetails?: ThreadDetails;
   triggerEvent?: OpenBotEvent;
-  shortTermMessages?: ShortTermMessage[];
+  /** Active model string (e.g. `openai/gpt-4o-mini`). */
+  model?: string;
+  /** Persisted tool call IDs waiting for results. */
+  pendingToolCallIds?: string[];
+  /** Current user information if available. */
+  currentUser?: {
+    userName?: string;
+  };
 }
 
-export type ShortTermMessage =
-  | { role: 'system'; content: string }
-  | { role: 'user'; content: string }
-  | { role: 'assistant'; content: string; toolCalls?: any[] }
-  | { role: 'tool'; content: string; toolCallId: string; toolName: string };
-
 export type BaseEvent = {
   id?: string;
   type: string;
@@ -68,6 +69,23 @@ export type GetThreadsResultEvent = BaseEvent & {
   };
 };
 
+export type SetLastReadEvent = BaseEvent & {
+  type: 'action:storage:set-last-read';
+  data: {
+    channelId?: string;
+    threadId?: string;
+    lastReadEventId: string;
+  };
+};
+
+export type SetLastReadResultEvent = BaseEvent & {
+  type: 'action:storage:set-last-read-result';
+  data: {
+    success: boolean;
+    error?: string;
+  };
+};
+
 export type GetChannelDetailsEvent = BaseEvent & {
   type: 'action:storage:get-channel-details';
 };
@@ -144,6 +162,7 @@ export type CreateAgentEvent = BaseEvent & {
     name: string;
     description?: string;
     image?: string;
+    hidden?: boolean;
     instructions: string;
     plugins: PluginRef[];
   };
@@ -164,6 +183,7 @@ export type UpdateAgentEvent = BaseEvent & {
     name?: string;
     description?: string;
     image?: string;
+    hidden?: boolean;
     instructions?: string;
     plugins?: PluginRef[];
   };
@@ -325,6 +345,7 @@ export type ReadFileEvent = BaseEvent & {
   type: 'action:storage:read-file';
   data: {
     path: string;
+    encoding?: 'utf8' | 'base64';
   };
 };
 
@@ -334,6 +355,107 @@ export type ReadFileResultEvent = BaseEvent & {
     success: boolean;
     content?: string;
     path: string;
+    encoding?: 'utf8' | 'base64';
+    mimeType?: string;
+    size?: number;
+    error?: string;
+  };
+};
+
+export type ServeFileEvent = BaseEvent & {
+  type: 'action:storage:serve-file';
+  data: {
+    path: string;
+  };
+};
+
+export type WriteFileEvent = BaseEvent & {
+  type: 'action:storage:write-file';
+  data: {
+    path: string;
+    content: string;
+    encoding?: 'utf8' | 'base64';
+    overwrite?: boolean;
+  };
+};
+
+export type WriteFileResultEvent = BaseEvent & {
+  type: 'action:storage:write-file:result';
+  data: {
+    success: boolean;
+    path: string;
+    url?: string;
+    mimeType?: string;
+    size?: number;
+    error?: string;
+  };
+};
+
+export type GetFileUrlEvent = BaseEvent & {
+  type: 'action:storage:get-file-url';
+  data: {
+    path: string;
+  };
+};
+
+export type GetFileUrlResultEvent = BaseEvent & {
+  type: 'action:storage:get-file-url:result';
+  data: {
+    success: boolean;
+    path: string;
+    url?: string;
+    mimeType?: string;
+    size?: number;
+    error?: string;
+  };
+};
+
+export type GetWorkspaceFileUrlEvent = BaseEvent & {
+  type: 'action:get_workspace_file_url';
+  data: {
+    path: string;
+  };
+  meta?: {
+    toolCallId?: string;
+    agentId?: string;
+    threadId?: string;
+  };
+};
+
+export type GetWorkspaceFileUrlResultEvent = BaseEvent & {
+  type: 'action:get_workspace_file_url:result';
+  data: {
+    success: boolean;
+    path: string;
+    url?: string;
+    mimeType?: string;
+    size?: number;
+    output?: string;
+    error?: string;
+  };
+  meta?: {
+    toolCallId?: string;
+    agentId?: string;
+    threadId?: string;
+  };
+};
+
+export type UploadFileEvent = BaseEvent & {
+  type: 'action:storage:upload-file';
+  data: {
+    path: string;
+    overwrite?: boolean;
+  };
+};
+
+export type UploadFileResultEvent = BaseEvent & {
+  type: 'action:storage:upload-file:result';
+  data: {
+    success: boolean;
+    path: string;
+    url?: string;
+    mimeType?: string;
+    size?: number;
     error?: string;
   };
 };
@@ -482,6 +604,42 @@ export type UpdateChannelResultEvent = BaseEvent & {
   };
 };
 
+export type DeleteChannelEvent = BaseEvent & {
+  type: 'action:storage:delete-channel';
+  data: {
+    channelId: string;
+  };
+};
+
+export type DeleteChannelResultEvent = BaseEvent & {
+  type: 'action:storage:delete-channel-result';
+  data: {
+    success: boolean;
+    error?: string;
+  };
+};
+
+export type DeleteChannelToolEvent = BaseEvent & {
+  type: 'action:delete_channel';
+  data: {
+    channelId: string;
+  };
+  meta?: {
+    toolCallId?: string;
+    agentId?: string;
+    threadId?: string;
+  };
+};
+
+export type DeleteChannelToolResultEvent = BaseEvent & {
+  type: 'action:delete_channel:result';
+  data: {
+    success: boolean;
+    channelId: string;
+    error?: string;
+  };
+};
+
 export type UIWidgetAction = {
   id: string;
   label: string;
@@ -509,12 +667,26 @@ export type UIWidgetListItem = {
   metadata?: Record<string, unknown>;
 };
 
+export type UIMediaItem = {
+  type: 'image' | 'video' | 'audio' | 'file';
+  url: string;
+  title?: string;
+  alt?: string;
+  thumbnailUrl?: string;
+  metadata?: Record<string, unknown>;
+};
+
 export type UIWidgetBase = {
   widgetId: string;
   title?: string;
   description?: string;
-  body?: string;
+  /** Optional hero media for the widget */
+  media?: UIMediaItem;
+  /** Optional actions for the widget */
+  actions?: UIWidgetAction[];
   state?: 'open' | 'submitted' | 'cancelled' | 'error';
+  display?: 'expanded' | 'collapsed';
+  size?: 'small' | 'medium' | 'large' | 'full';
   metadata?: Record<string, unknown>;
 };
 
@@ -543,19 +715,6 @@ export type UIListWidget = UIWidgetBase & {
 
 export type UIWidgetSpec = UIMessageWidget | UIChoiceWidget | UIFormWidget | UIListWidget;
 
-export type RenderUIWidgetData =
-  | (Omit<UIMessageWidget, 'widgetId'> & { widgetId?: string })
-  | (Omit<UIChoiceWidget, 'widgetId'> & { widgetId?: string })
-  | (Omit<UIFormWidget, 'widgetId'> & { widgetId?: string })
-  | (Omit<UIListWidget, 'widgetId'> & { widgetId?: string })
-  | {
-      kind: 'approval' | 'todo_list';
-      widgetId?: string;
-      title?: string;
-      props?: Record<string, unknown>;
-      metadata?: Record<string, unknown>;
-    };
-
 export type UIWidgetEvent = BaseEvent & {
   type: 'client:ui:widget';
   data: UIWidgetSpec;
@@ -565,11 +724,6 @@ export type UIWidgetEvent = BaseEvent & {
   };
 };
 
-export type RenderUIWidgetEvent = BaseEvent & {
-  type: 'action:render_ui_widget';
-  data: RenderUIWidgetData;
-};
-
 export type UIWidgetResponseEvent = BaseEvent & {
   type: 'client:ui:widget:response';
   data: {
@@ -580,118 +734,61 @@ export type UIWidgetResponseEvent = BaseEvent & {
   };
 };
 
-export type HandoffEvent = BaseEvent & {
-  type: 'action:handoff';
+export type BashEvent = BaseEvent & {
+  type: 'action:bash';
   data: {
-    agentId: string;
-    content: string;
+    command: string;
+    restart?: boolean;
   };
   meta?: {
     toolCallId?: string;
+    approvalId?: string;
+    approvalStatus?: 'approved' | 'denied';
     [key: string]: any;
   };
 };
 
-export type HandoffResultEvent = BaseEvent & {
-  type: 'action:handoff:result';
-  data: {
-    success: boolean;
-    agentId: string;
-    accepted: boolean;
-  };
-  meta: {
-    toolCallId: string;
-    agentId: string;
-    threadId?: string;
-    [key: string]: any;
-  };
-};
-
-/** Internal routing: handoff plugin → orchestrator only (not stored or broadcast). */
-export type HandoffRequestEvent = BaseEvent & {
-  type: 'handoff:request';
-  data: {
-    agentId: string;
-    content: string;
-  };
-  meta?: Record<string, unknown>;
-};
-
-export type MCPListToolsEvent = BaseEvent & {
-  type: 'action:mcp_list_tools';
-  data: {
-    serverId: string;
-  };
-};
-
-export type MCPListToolsResultEvent = BaseEvent & {
-  type: 'action:mcp_list_tools:result';
+export type BashResultEvent = BaseEvent & {
+  type: 'action:bash:result';
   data: {
     success: boolean;
-    serverId: string;
-    tools: Array<{ name: string; description?: string; inputSchema?: unknown }>;
+    approved?: boolean;
+    exitCode: number | null;
+    stdout: string;
+    stderr: string;
+    timedOut: boolean;
     error?: string;
   };
 };
 
-export type MCPCallEvent = BaseEvent & {
-  type: 'action:mcp_call';
+export type BashStopEvent = BaseEvent & {
+  type: 'action:bash_stop';
   data: {
-    serverId: string;
-    toolName: string;
-    args?: Record<string, unknown>;
+    channelId?: string;
   };
 };
 
-export type MCPCallResultEvent = BaseEvent & {
-  type: 'action:mcp_call:result';
+export type BashStopResultEvent = BaseEvent & {
+  type: 'action:bash_stop:result';
   data: {
     success: boolean;
-    serverId: string;
-    toolName: string;
-    result?: unknown;
-    error?: string;
   };
 };
 
-export type ShellExecEvent = BaseEvent & {
-  type: 'action:shell_exec';
-  data: {
-    command: string;
-    cwd?: string;
-    shell?: string;
-    timeoutMs?: number;
-  };
-  meta?: {
-    toolCallId?: string;
-    approvalId?: string;
-    approvalStatus?: 'approved' | 'denied';
-    [key: string]: any;
-  };
+export type BashListSessionsEvent = BaseEvent & {
+  type: 'action:bash_list_sessions';
+  data: {};
 };
 
-export type ShellExecResultEvent = BaseEvent & {
-  type: 'action:shell_exec:result';
+export type BashListSessionsResultEvent = BaseEvent & {
+  type: 'action:bash_list_sessions:result';
   data: {
     success: boolean;
-    approved?: boolean;
-    exitCode: number | null;
-    stdout: string;
-    stderr: string;
-    timedOut: boolean;
-    error?: string;
-  };
-};
-
-export type UserInputEvent = BaseEvent & {
-  type: 'user:input';
-  data: {
-    content: string;
-  };
-  meta?: {
-    userId?: string;
-    userName?: string;
-    userAvatarUrl?: string;
+    sessions: Array<{
+      channelId: string;
+      cwd: string;
+      lastActivity: number;
+    }>;
   };
 };
 
@@ -727,11 +824,11 @@ export type UninstallPluginResultEvent = BaseEvent & {
   };
 };
 
-export type ListMarketplaceAgentsEvent = BaseEvent & {
+export type ListMarketplaceRegistryEvent = BaseEvent & {
   type: 'action:marketplace:list';
 };
 
-export type ListMarketplaceAgentsResultEvent = BaseEvent & {
+export type ListMarketplaceRegistryResultEvent = BaseEvent & {
   type: 'action:marketplace:list:result';
   data: {
     success: boolean;
@@ -743,6 +840,36 @@ export type ListMarketplaceAgentsResultEvent = BaseEvent & {
       instructions: string;
       plugins: PluginRef[];
     }>;
+    channels: Array<{
+      id: string;
+      name: string;
+      description: string;
+      image?: string;
+      spec?: string;
+      initialState?: Record<string, unknown>;
+      participants: string[];
+      starterPrompts?: Array<{ label: string; prompt: string }>;
+    }>;
+    error?: string;
+  };
+};
+
+export type InstallChannelEvent = BaseEvent & {
+  type: 'action:channel:install';
+  data: {
+    channelId: string;
+    name?: string;
+    participants?: string[];
+    initialState?: Record<string, unknown>;
+  };
+};
+
+export type InstallChannelResultEvent = BaseEvent & {
+  type: 'action:channel:install:result';
+  data: {
+    success: boolean;
+    channelId?: string;
+    channelUrl?: string;
     error?: string;
   };
 };
@@ -770,6 +897,25 @@ export type InstallAgentResultEvent = BaseEvent & {
 
 export type MemoryScopeAlias = 'global' | 'agent' | 'channel';
 
+export interface Usage {
+  promptTokens: number;
+  completionTokens: number;
+  totalTokens: number;
+}
+
+export type AgentUsageEvent = BaseEvent & {
+  type: 'agent:usage';
+  data: {
+    usage: Usage;
+    model?: string;
+  };
+  meta: {
+    agentId: string;
+    threadId?: string;
+    runId?: string;
+  };
+};
+
 export type RememberEvent = BaseEvent & {
   type: 'action:remember';
   data: {
@@ -821,83 +967,68 @@ export type ForgetResultEvent = BaseEvent & {
   };
 };
 
-export type TodoStatus = 'pending' | 'in_progress' | 'done' | 'cancelled';
-
-/**
- * A single unit of work tracked in thread state. Todos are owned by the
- * system (bus services); agents can only mutate them by calling the
- * `todo_write` / `todo_update` tools so every change is observable on the
- * event stream and audit-friendly.
- */
-export interface TodoItem {
-  id: string;
-  content: string;
-  status: TodoStatus;
-  /** Optional agent id responsible for this item — drives autonomous handoffs. */
-  assignee?: string;
-  /** Agent id that created the todo (or "system"). */
-  createdBy: string;
-  createdAt: number;
-  updatedAt: number;
-  /**
-   * Captured final reply when this item reaches `done` (last `agent:output`
-   * from the assignee for that run). Lets downstream agents rely on thread
-   * state instead of merged short-term messages.
-   */
-  result?: string;
-}
-
-export type TodoWriteInput = {
-  id?: string;
-  content: string;
-  status?: TodoStatus;
-  assignee?: string;
-};
-
-export type TodoWriteEvent = BaseEvent & {
-  type: 'action:todo_write';
+export type DelegateTaskEvent = BaseEvent & {
+  type: 'action:delegate_task';
   data: {
-    todos: TodoWriteInput[];
+    agentId: string;
+    prompt: string;
   };
-  meta?: { toolCallId?: string; agentId?: string; threadId?: string };
 };
 
-export type TodoWriteResultEvent = BaseEvent & {
-  type: 'action:todo_write:result';
+export type DelegateTaskResultEvent = BaseEvent & {
+  type: 'action:delegate_task:result';
   data: {
     success: boolean;
-    todos: TodoItem[];
+    output?: string;
     error?: string;
   };
-  meta?: { toolCallId?: string; agentId?: string; threadId?: string };
 };
 
-export type TodoUpdateEvent = BaseEvent & {
-  type: 'action:todo_update';
+export type RenderWidgetEvent = BaseEvent & {
+  type: 'action:render_widget';
   data: {
-    id: string;
-    status?: TodoStatus;
-    content?: string;
-    assignee?: string;
+    kind: 'message' | 'choice' | 'form' | 'list';
+    title: string;
+    description?: string;
+    fields?: UIWidgetField[];
+    actions?: UIWidgetAction[];
+    items?: UIWidgetListItem[];
+    submitLabel?: string;
+  };
+  meta?: {
+    toolCallId?: string;
+    threadId?: string;
+    [key: string]: any;
   };
-  meta?: { toolCallId?: string; agentId?: string; threadId?: string };
 };
 
-export type TodoUpdateResultEvent = BaseEvent & {
-  type: 'action:todo_update:result';
+export type RenderWidgetResultEvent = BaseEvent & {
+  type: 'action:render_widget:result';
   data: {
     success: boolean;
-    todo?: TodoItem;
-    todos: TodoItem[];
-    error?: string;
+    actionId: string;
+    values?: Record<string, unknown>;
   };
-  meta?: { toolCallId?: string; agentId?: string; threadId?: string };
 };
 
+/**
+ * Internal message representation to decouple harness history from specific AI SDKs.
+ */
+export type OpenBotMessage =
+  | { role: 'user'; content: string | OpenBotMessagePart[] }
+  | { role: 'assistant'; content: string | OpenBotMessagePart[] }
+  | { role: 'system'; content: string }
+  | { role: 'tool'; content: OpenBotMessagePart[] };
+
+export type OpenBotMessagePart =
+  | { type: 'text'; text: string }
+  | { type: 'tool-call'; toolCallId: string; toolName: string; input: any }
+  | { type: 'tool-result'; toolCallId: string; toolName: string; output: any };
+
 export type OpenBotEvent =
-  | UserInputEvent
   | AgentInvokeEvent
   | AgentOutputEvent
+  | AgentUsageEvent
   | AgentRunStartEvent
   | AgentRunEndEvent
   | AgentRunStoppedEvent
@@ -908,6 +1039,8 @@ export type OpenBotEvent =
   | GetChannelsResultEvent
   | GetThreadsEvent
   | GetThreadsResultEvent
+  | SetLastReadEvent
+  | SetLastReadResultEvent
   | GetChannelDetailsEvent
   | GetChannelDetailsResultEvent
   | GetThreadDetailsEvent
@@ -945,39 +1078,50 @@ export type OpenBotEvent =
   | ListFilesResultEvent
   | ReadFileEvent
   | ReadFileResultEvent
+  | ServeFileEvent
+  | WriteFileEvent
+  | WriteFileResultEvent
+  | GetFileUrlEvent
+  | GetFileUrlResultEvent
+  | GetWorkspaceFileUrlEvent
+  | GetWorkspaceFileUrlResultEvent
+  | UploadFileEvent
+  | UploadFileResultEvent
   | CreateThreadEvent
   | CreateThreadResultEvent
   | CreateChannelEvent
   | CreateChannelResultEvent
   | UpdateChannelEvent
   | UpdateChannelResultEvent
+  | DeleteChannelEvent
+  | DeleteChannelResultEvent
+  | DeleteChannelToolEvent
+  | DeleteChannelToolResultEvent
   | UIWidgetEvent
-  | RenderUIWidgetEvent
   | UIWidgetResponseEvent
-  | HandoffEvent
-  | HandoffResultEvent
-  | HandoffRequestEvent
-  | MCPListToolsEvent
-  | MCPListToolsResultEvent
-  | MCPCallEvent
-  | MCPCallResultEvent
-  | ShellExecEvent
-  | ShellExecResultEvent
+  | BashEvent
+  | BashResultEvent
+  | BashStopEvent
+  | BashStopResultEvent
+  | BashListSessionsEvent
+  | BashListSessionsResultEvent
   | InstallPluginEvent
   | InstallPluginResultEvent
   | UninstallPluginEvent
   | UninstallPluginResultEvent
-  | ListMarketplaceAgentsEvent
-  | ListMarketplaceAgentsResultEvent
+  | ListMarketplaceRegistryEvent
+  | ListMarketplaceRegistryResultEvent
   | InstallAgentEvent
   | InstallAgentResultEvent
+  | InstallChannelEvent
+  | InstallChannelResultEvent
   | RememberEvent
   | RememberResultEvent
   | RecallEvent
   | RecallResultEvent
   | ForgetEvent
   | ForgetResultEvent
-  | TodoWriteEvent
-  | TodoWriteResultEvent
-  | TodoUpdateEvent
-  | TodoUpdateResultEvent;
+  | DelegateTaskEvent
+  | DelegateTaskResultEvent
+  | RenderWidgetEvent
+  | RenderWidgetResultEvent;