Documentation
¶
Overview ¶
Package events provides event system for sprout UI architecture
Index ¶
- Constants
- func AgentMessageEvent(category, message string, extra map[string]interface{}) map[string]interface{}
- func AskUserRequestEvent(requestID, question, clientID string) map[string]interface{}
- func DelegateClarificationRequestedEvent(delegateID, requestID, question string) map[string]interface{}
- func DelegateClarificationRespondedEvent(delegateID, requestID, response string) map[string]interface{}
- func DriftDetectedEvent(similarity float64, threshold float64, sessionID string) map[string]interface{}
- func ErrorEvent(message string, err error) map[string]interface{}
- func FileChangedEvent(filePath, action string, content string) map[string]interface{}
- func FileContentChangedEvent(filePath string, modTime int64, size int64) map[string]interface{}
- func MetricsUpdateEvent(totalTokens, contextTokens, maxContextTokens, iteration int, totalCost float64) map[string]interface{}
- func ProviderNoCredentialEvent(providerID, message string) map[string]interface{}
- func QueryCompletedEvent(query, response string, tokensUsed int, cost float64, duration time.Duration) map[string]interface{}
- func QueryProgressEvent(message string, iteration int, tokensUsed int) map[string]interface{}
- func QueryStartedEvent(query, provider, model string) map[string]interface{}
- func SecurityApprovalRequestEvent(requestID, toolName, riskLevel, reasoning string, extras map[string]string) map[string]interface{}
- func SecurityPromptRequestEvent(requestID, prompt string, defaultResponse bool, extras map[string]string) map[string]interface{}
- func SecurityPromptResponseEvent(requestID, response bool) map[string]interface{}
- func StreamChunkEvent(chunk string, contentType string) map[string]interface{}
- func SubagentActivityEvent(toolCallID, toolName, phase, message string, details map[string]interface{}) map[string]interface{}
- func TodoUpdateEvent(todos []map[string]interface{}) map[string]interface{}
- func ToolEndEvent(toolCallID, toolName, status, result, errorMessage string, ...) map[string]interface{}
- func ToolExecutionEvent(toolName, action string, details map[string]interface{}) map[string]interface{}
- func ToolStartEvent(toolName, toolCallID, arguments, displayName, persona string, isSubagent bool, ...) map[string]interface{}
- func ValidationEvent(filePath string, diagnostics []map[string]interface{}) map[string]interface{}
- func WorkspaceChangedEvent(daemonRoot, workspaceRoot, previousWorkspaceRoot string) map[string]interface{}
- func WorkspacePatchEvent(filePath, content, action string, seqNum int64, ...) map[string]interface{}
- type EventBus
- type PatchConflictInfo
- type UIEvent
Constants ¶
const ( EventTypeQueryStarted = "query_started" EventTypeQueryProgress = "query_progress" EventTypeQueryCompleted = "query_completed" EventTypeError = "error" EventTypeToolExecution = "tool_execution" EventTypeToolStart = "tool_start" EventTypeToolEnd = "tool_end" EventTypeSubagentActivity = "subagent_activity" EventTypeTodoUpdate = "todo_update" EventTypeFileChanged = "file_changed" EventTypeWorkspacePatch = "workspace_patch" EventTypeFileContentChanged = "file_content_changed" EventTypeStreamChunk = "stream_chunk" EventTypeMetricsUpdate = "metrics_update" EventTypeValidation = "validation" EventTypeSecurityApprovalRequest = "security_approval_request" EventTypeSecurityPromptRequest = "security_prompt_request" EventTypeAskUserRequest = "ask_user_request" EventTypeAgentMessage = "agent_message" // EventTypeProviderNoCredential is published when a provider change // would activate a provider that requires an API key but doesn't // have one configured. The frontend surfaces it as a sticky toast // pointing at Settings → Credentials, distinct from generic warning // messages that get inlined into the active assistant bubble. EventTypeProviderNoCredential = "provider_no_credential" EventTypeWorkspaceChanged = "workspace_changed" EventTypeSessionTerminated = "session_terminated" EventTypeDriftDetected = "drift_detected" // EventTypeSessionChanged signals that a chat session's metadata // (name, pin state, active state) changed and tabs viewing that chat // should reconcile. SP-034-3e. EventTypeSessionChanged = "session_changed" // EventTypeDelegateClarificationRequested is published when a delegate // agent requests clarification from its parent agent. EventTypeDelegateClarificationRequested = "delegate_clarification_requested" // EventTypeDelegateClarificationResponded is published when a parent // agent responds to a delegate's clarification request. EventTypeDelegateClarificationResponded = "delegate_clarification_responded" )
Common event types
Variables ¶
This section is empty.
Functions ¶
func AgentMessageEvent ¶
func AgentMessageEvent(category, message string, extra map[string]interface{}) map[string]interface{}
AgentMessageEvent creates an agent system message event. category: "info", "warning", "error", "tool_log", "thought"
func AskUserRequestEvent ¶
AskUserRequestEvent creates an ask_user request event for the webui
func DelegateClarificationRequestedEvent ¶
func DelegateClarificationRequestedEvent(delegateID, requestID, question string) map[string]interface{}
DelegateClarificationRequestedEvent creates a delegate_clarification_requested event payload.
func DelegateClarificationRespondedEvent ¶
func DelegateClarificationRespondedEvent(delegateID, requestID, response string) map[string]interface{}
DelegateClarificationRespondedEvent creates a delegate_clarification_responded event payload.
func DriftDetectedEvent ¶
func DriftDetectedEvent(similarity float64, threshold float64, sessionID string) map[string]interface{}
DriftDetectedEvent creates a drift notification event for the WebUI
func ErrorEvent ¶
ErrorEvent creates an error event
func FileChangedEvent ¶
FileChangedEvent creates a file changed event
func FileContentChangedEvent ¶
FileContentChangedEvent creates an event indicating a file's content on disk has changed while it was open in the editor
func MetricsUpdateEvent ¶
func MetricsUpdateEvent(totalTokens, contextTokens, maxContextTokens, iteration int, totalCost float64) map[string]interface{}
MetricsUpdateEvent creates a metrics update event
func ProviderNoCredentialEvent ¶
ProviderNoCredentialEvent creates an event signalling that the newly active provider requires an API key but doesn't have one configured. The frontend uses providerID to drive a toast that opens Settings → Credentials scoped to this provider.
func QueryCompletedEvent ¶
func QueryCompletedEvent(query, response string, tokensUsed int, cost float64, duration time.Duration) map[string]interface{}
QueryCompletedEvent creates a query completed event
func QueryProgressEvent ¶
QueryProgressEvent creates a query progress event
func QueryStartedEvent ¶
QueryStartedEvent creates a query started event
func SecurityApprovalRequestEvent ¶
func SecurityApprovalRequestEvent(requestID, toolName, riskLevel, reasoning string, extras map[string]string) map[string]interface{}
SecurityApprovalRequestEvent creates a security approval request event for the webui
func SecurityPromptRequestEvent ¶
func SecurityPromptRequestEvent(requestID, prompt string, defaultResponse bool, extras map[string]string) map[string]interface{}
SecurityPromptRequestEvent creates a security prompt request event for the webui
func SecurityPromptResponseEvent ¶
SecurityPromptResponseEvent creates a security prompt response event
func StreamChunkEvent ¶
StreamChunkEvent creates a stream chunk event with content type
func SubagentActivityEvent ¶
func SubagentActivityEvent(toolCallID, toolName, phase, message string, details map[string]interface{}) map[string]interface{}
SubagentActivityEvent creates a structured subagent activity event. phase is typically "spawn", "output", or "complete".
func TodoUpdateEvent ¶
TodoUpdateEvent creates a todo update event
func ToolEndEvent ¶
func ToolEndEvent(toolCallID, toolName, status, result, errorMessage string, duration time.Duration) map[string]interface{}
ToolEndEvent creates a tool end event with result and status
func ToolExecutionEvent ¶
func ToolExecutionEvent(toolName, action string, details map[string]interface{}) map[string]interface{}
ToolExecutionEvent creates a tool execution event
func ToolStartEvent ¶
func ToolStartEvent(toolName, toolCallID, arguments, displayName, persona string, isSubagent bool, subagentType string, toolIndex int) map[string]interface{}
ToolStartEvent creates a tool start event with rich metadata
func ValidationEvent ¶
ValidationEvent creates a validation event
func WorkspaceChangedEvent ¶
func WorkspaceChangedEvent(daemonRoot, workspaceRoot, previousWorkspaceRoot string) map[string]interface{}
WorkspaceChangedEvent creates a workspace changed event
func WorkspacePatchEvent ¶
func WorkspacePatchEvent(filePath, content, action string, seqNum int64, conflictInfo ...PatchConflictInfo) map[string]interface{}
WorkspacePatchEvent creates a workspace_patch event payload for real-time file content synchronization from the agent to the browser. The optional conflictInfo parameter enriches the event with conflict metadata when the container patch conflicts with unsynced browser edits.
Types ¶
type EventBus ¶
type EventBus struct {
// contains filtered or unexported fields
}
EventBus manages event distribution between CLI and Web UI
func (*EventBus) Publish ¶
Publish broadcasts an event to all subscribers. Critical events (security approvals, prompts) are never silently dropped — if the channel is full, they replace the oldest event to make room.
func (*EventBus) Unsubscribe ¶
Unsubscribe removes a subscriber from the event bus
type PatchConflictInfo ¶
PatchConflictInfo holds optional conflict metadata for a workspace_patch event.
type UIEvent ¶
type UIEvent struct {
ID string `json:"id"`
Type string `json:"type"`
Timestamp time.Time `json:"timestamp"`
Data any `json:"data"`
}
UIEvent represents an event that can be forwarded between CLI and Web UI.
@ts-generated webui/src/types/generated.ts::UIEvent SP-034-5b: the EventType* constants below are mirrored as the ServerEventType string-literal union in generated.ts. The outbound registry in pkg/webui/websocket_outbound_registry.go covers the same surface (a test asserts they stay in sync).
Source Files