/** * Hook system for OpenClaw agent events * * Provides an extensible event-driven hook system for agent events * like command processing, session lifecycle, etc. */ import type { WorkspaceBootstrapFile } from "../agents/workspace.js"; import type { CliDeps } from "../cli/outbound-send-deps.js"; import type { SessionEntry } from "../config/sessions/types.js"; import type { OpenClawConfig } from "../config/types.openclaw.js"; import type { SessionsPatchParams } from "../gateway/protocol/schema/types.js"; import type { InternalHookEvent, InternalHookEventType, InternalHookHandler } from "./internal-hook-types.js"; export type { InternalHookEvent, InternalHookEventType, InternalHookHandler }; export type AgentBootstrapHookContext = { workspaceDir: string; bootstrapFiles: WorkspaceBootstrapFile[]; cfg?: OpenClawConfig; sessionKey?: string; sessionId?: string; agentId?: string; }; export type AgentBootstrapHookEvent = InternalHookEvent & { type: "agent"; action: "bootstrap"; context: AgentBootstrapHookContext; }; export type GatewayStartupHookContext = { cfg?: OpenClawConfig; deps?: CliDeps; workspaceDir?: string; }; export type GatewayStartupHookEvent = InternalHookEvent & { type: "gateway"; action: "startup"; context: GatewayStartupHookContext; }; export type MessageReceivedHookContext = { /** Sender identifier (e.g., phone number, user ID) */ from: string; /** Message content */ content: string; /** Unix timestamp when the message was received */ timestamp?: number; /** Channel identifier (for example "chat" or "support-chat") */ channelId: string; /** Provider account ID for multi-account setups */ accountId?: string; /** Conversation/chat ID */ conversationId?: string; /** Message ID from the provider */ messageId?: string; /** Additional provider-specific metadata */ metadata?: Record; }; export type MessageReceivedHookEvent = InternalHookEvent & { type: "message"; action: "received"; context: MessageReceivedHookContext; }; export type MessageSentHookContext = { /** Recipient identifier */ to: string; /** Message content */ content: string; /** Whether the message was sent successfully */ success: boolean; /** Error message if sending failed */ error?: string; /** Channel identifier (for example "chat" or "support-chat") */ channelId: string; /** Provider account ID for multi-account setups */ accountId?: string; /** Conversation/chat ID */ conversationId?: string; /** Message ID returned by the provider */ messageId?: string; /** Whether this message was sent in a group/channel context */ isGroup?: boolean; /** Group or channel identifier, if applicable */ groupId?: string; }; export type MessageSentHookEvent = InternalHookEvent & { type: "message"; action: "sent"; context: MessageSentHookContext; }; type MessageEnrichedBodyHookContext = { /** Sender identifier (e.g., phone number, user ID) */ from?: string; /** Recipient identifier */ to?: string; /** Original raw message body (e.g., "🎤 [Audio]") */ body?: string; /** Enriched body shown to the agent, including transcript */ bodyForAgent?: string; /** Unix timestamp when the message was received */ timestamp?: number; /** Channel identifier (for example "chat" or "support-chat") */ channelId: string; /** Conversation/chat ID */ conversationId?: string; /** Message ID from the provider */ messageId?: string; /** Sender user ID */ senderId?: string; /** Sender display name */ senderName?: string; /** Sender username */ senderUsername?: string; /** Provider name */ provider?: string; /** Surface name */ surface?: string; /** Path to the media file that was transcribed */ mediaPath?: string; /** MIME type of the media */ mediaType?: string; }; export type MessageTranscribedHookContext = MessageEnrichedBodyHookContext & { /** The transcribed text from audio */ transcript: string; }; export type MessageTranscribedHookEvent = InternalHookEvent & { type: "message"; action: "transcribed"; context: MessageTranscribedHookContext; }; export type MessagePreprocessedHookContext = MessageEnrichedBodyHookContext & { /** Transcribed audio text, if the message contained audio */ transcript?: string; /** Whether this message was sent in a group/channel context */ isGroup?: boolean; /** Group or channel identifier, if applicable */ groupId?: string; }; export type MessagePreprocessedHookEvent = InternalHookEvent & { type: "message"; action: "preprocessed"; context: MessagePreprocessedHookContext; }; export type SessionPatchHookContext = { sessionEntry: SessionEntry; patch: SessionsPatchParams; cfg: OpenClawConfig; }; export type SessionPatchHookEvent = InternalHookEvent & { type: "session"; action: "patch"; context: SessionPatchHookContext; }; /** * Register a hook handler for a specific event type or event:action combination * * @param eventKey - Event type (e.g., 'command') or specific action (e.g., 'command:new') * @param handler - Function to call when the event is triggered * * @example * ```ts * // Listen to all command events * registerInternalHook('command', async (event) => { * console.log('Command:', event.action); * }); * * // Listen only to /new commands * registerInternalHook('command:new', async (event) => { * await saveSessionToMemory(event); * }); * ``` */ export declare function registerInternalHook(eventKey: string, handler: InternalHookHandler): void; /** * Unregister a specific hook handler * * @param eventKey - Event key the handler was registered for * @param handler - The handler function to remove */ export declare function unregisterInternalHook(eventKey: string, handler: InternalHookHandler): void; /** * Clear all registered hooks (useful for testing) */ export declare function clearInternalHooks(): void; export declare function setInternalHooksEnabled(enabled: boolean): void; /** * Get all registered event keys (useful for debugging) */ export declare function getRegisteredEventKeys(): string[]; export declare function hasInternalHookListeners(type: InternalHookEventType, action: string): boolean; /** * Trigger a hook event * * Calls all handlers registered for: * 1. The general event type (e.g., 'command') * 2. The specific event:action combination (e.g., 'command:new') * * Handlers are called in registration order. Errors are caught and logged * but don't prevent other handlers from running. * * @param event - The event to trigger */ export declare function triggerInternalHook(event: InternalHookEvent): Promise; /** * Create a hook event with common fields filled in * * @param type - The event type * @param action - The action within that type * @param sessionKey - The session key * @param context - Additional context */ export declare function createInternalHookEvent(type: InternalHookEventType, action: string, sessionKey: string, context?: Record): InternalHookEvent; export declare function isAgentBootstrapEvent(event: InternalHookEvent): event is AgentBootstrapHookEvent; export declare function isGatewayStartupEvent(event: InternalHookEvent): event is GatewayStartupHookEvent; export declare function isMessageReceivedEvent(event: InternalHookEvent): event is MessageReceivedHookEvent; export declare function isMessageSentEvent(event: InternalHookEvent): event is MessageSentHookEvent; export declare function isMessageTranscribedEvent(event: InternalHookEvent): event is MessageTranscribedHookEvent; export declare function isMessagePreprocessedEvent(event: InternalHookEvent): event is MessagePreprocessedHookEvent; export declare function isSessionPatchEvent(event: InternalHookEvent): event is SessionPatchHookEvent;