import type { IncomingMessage, ServerResponse } from "node:http"; import type { AgentMessage } from "@mariozechner/pi-agent-core"; import type { Command } from "commander"; import type { AuthProfileCredential, OAuthCredential } from "../agents/auth-profiles/types.js"; import type { AnyAgentTool } from "../agents/tools/common.js"; import type { ReplyPayload } from "../auto-reply/types.js"; import type { ChannelDock } from "../channels/dock.js"; import type { ChannelId, ChannelPlugin } from "../channels/plugins/types.js"; import type { createVpsAwareOAuthHandlers } from "../commands/oauth-flow.js"; import type { BotConfig } from "../config/config.js"; import type { ModelProviderConfig } from "../config/types.js"; import type { GatewayRequestHandler } from "../gateway/server-methods/types.js"; import type { InternalHookHandler } from "../hooks/internal-hooks.js"; import type { HookEntry } from "../hooks/types.js"; import type { RuntimeEnv } from "../runtime.js"; import type { WizardPrompter } from "../wizard/prompts.js"; import type { PluginRuntime } from "./runtime/types.js"; export type { PluginRuntime } from "./runtime/types.js"; export type { AnyAgentTool } from "../agents/tools/common.js"; export type PluginLogger = { debug?: (message: string) => void; info: (message: string) => void; warn: (message: string) => void; error: (message: string) => void; }; export type PluginConfigUiHint = { label?: string; help?: string; tags?: string[]; advanced?: boolean; sensitive?: boolean; placeholder?: string; }; export type PluginKind = "memory" | "context-engine"; export type PluginConfigValidation = { ok: true; value?: unknown; } | { ok: false; errors: string[]; }; export type BotPluginConfigSchema = { safeParse?: (value: unknown) => { success: boolean; data?: unknown; error?: { issues?: Array<{ path: Array; message: string; }>; }; }; parse?: (value: unknown) => unknown; validate?: (value: unknown) => PluginConfigValidation; uiHints?: Record; jsonSchema?: Record; }; export type BotPluginToolContext = { config?: BotConfig; workspaceDir?: string; agentDir?: string; agentId?: string; sessionKey?: string; /** Ephemeral session UUID — regenerated on /new and /reset. Use for per-conversation isolation. */ sessionId?: string; messageChannel?: string; agentAccountId?: string; /** Trusted sender id from inbound context (runtime-provided, not tool args). */ requesterSenderId?: string; /** Whether the trusted sender is an owner. */ senderIsOwner?: boolean; sandboxed?: boolean; }; export type BotPluginToolFactory = (ctx: BotPluginToolContext) => AnyAgentTool | AnyAgentTool[] | null | undefined; export type BotPluginToolOptions = { name?: string; names?: string[]; optional?: boolean; }; export type BotPluginHookOptions = { entry?: HookEntry; name?: string; description?: string; register?: boolean; }; export type ProviderAuthKind = "oauth" | "api_key" | "token" | "device_code" | "custom"; export type ProviderAuthResult = { profiles: Array<{ profileId: string; credential: AuthProfileCredential; }>; configPatch?: Partial; defaultModel?: string; notes?: string[]; }; export type ProviderAuthContext = { config: BotConfig; agentDir?: string; workspaceDir?: string; prompter: WizardPrompter; runtime: RuntimeEnv; isRemote: boolean; openUrl: (url: string) => Promise; oauth: { createVpsAwareHandlers: typeof createVpsAwareOAuthHandlers; }; }; export type ProviderAuthMethod = { id: string; label: string; hint?: string; kind: ProviderAuthKind; run: (ctx: ProviderAuthContext) => Promise; }; export type ProviderPlugin = { id: string; label: string; docsPath?: string; aliases?: string[]; envVars?: string[]; models?: ModelProviderConfig; auth: ProviderAuthMethod[]; formatApiKey?: (cred: AuthProfileCredential) => string; refreshOAuth?: (cred: OAuthCredential) => Promise; }; export type BotPluginGatewayMethod = { method: string; handler: GatewayRequestHandler; }; /** * Context passed to plugin command handlers. */ export type PluginCommandContext = { /** The sender's identifier (e.g., Telegram user ID) */ senderId?: string; /** The channel/surface (e.g., "telegram", "discord") */ channel: string; /** Provider channel id (e.g., "telegram") */ channelId?: ChannelId; /** Whether the sender is on the allowlist */ isAuthorizedSender: boolean; /** Raw command arguments after the command name */ args?: string; /** The full normalized command body */ commandBody: string; /** Current HanzoBot configuration */ config: BotConfig; /** Raw "From" value (channel-scoped id) */ from?: string; /** Raw "To" value (channel-scoped id) */ to?: string; /** Account id for multi-account channels */ accountId?: string; /** Thread/topic id if available */ messageThreadId?: number; }; /** * Result returned by a plugin command handler. */ export type PluginCommandResult = ReplyPayload; /** * Handler function for plugin commands. */ export type PluginCommandHandler = (ctx: PluginCommandContext) => PluginCommandResult | Promise; /** * Definition for a plugin-registered command. */ export type BotPluginCommandDefinition = { /** Command name without leading slash (e.g., "tts") */ name: string; /** Description shown in /help and command menus */ description: string; /** Whether this command accepts arguments */ acceptsArgs?: boolean; /** Whether only authorized senders can use this command (default: true) */ requireAuth?: boolean; /** The handler function */ handler: PluginCommandHandler; }; export type BotPluginHttpRouteAuth = "gateway" | "plugin"; export type BotPluginHttpRouteMatch = "exact" | "prefix"; export type BotPluginHttpRouteHandler = (req: IncomingMessage, res: ServerResponse) => Promise | boolean | void; export type BotPluginHttpRouteParams = { path: string; handler: BotPluginHttpRouteHandler; auth: BotPluginHttpRouteAuth; match?: BotPluginHttpRouteMatch; replaceExisting?: boolean; }; export type BotPluginCliContext = { program: Command; config: BotConfig; workspaceDir?: string; logger: PluginLogger; }; export type BotPluginCliRegistrar = (ctx: BotPluginCliContext) => void | Promise; export type BotPluginServiceContext = { config: BotConfig; workspaceDir?: string; stateDir: string; logger: PluginLogger; }; export type BotPluginService = { id: string; start: (ctx: BotPluginServiceContext) => void | Promise; stop?: (ctx: BotPluginServiceContext) => void | Promise; }; export type BotPluginChannelRegistration = { plugin: ChannelPlugin; dock?: ChannelDock; }; export type BotPluginDefinition = { id?: string; name?: string; description?: string; version?: string; kind?: PluginKind; configSchema?: BotPluginConfigSchema; register?: (api: BotPluginApi) => void | Promise; activate?: (api: BotPluginApi) => void | Promise; }; export type BotPluginModule = BotPluginDefinition | ((api: BotPluginApi) => void | Promise); export type BotPluginApi = { id: string; name: string; version?: string; description?: string; source: string; config: BotConfig; pluginConfig?: Record; runtime: PluginRuntime; logger: PluginLogger; registerTool: (tool: AnyAgentTool | BotPluginToolFactory, opts?: BotPluginToolOptions) => void; registerHook: (events: string | string[], handler: InternalHookHandler, opts?: BotPluginHookOptions) => void; registerHttpRoute: (params: BotPluginHttpRouteParams) => void; registerChannel: (registration: BotPluginChannelRegistration | ChannelPlugin) => void; registerGatewayMethod: (method: string, handler: GatewayRequestHandler) => void; registerCli: (registrar: BotPluginCliRegistrar, opts?: { commands?: string[]; }) => void; registerService: (service: BotPluginService) => void; registerProvider: (provider: ProviderPlugin) => void; /** * Register a custom command that bypasses the LLM agent. * Plugin commands are processed before built-in commands and before agent invocation. * Use this for simple state-toggling or status commands that don't need AI reasoning. */ registerCommand: (command: BotPluginCommandDefinition) => void; /** Register a context engine implementation (exclusive slot — only one active at a time). */ registerContextEngine: (id: string, factory: import("../context-engine/registry.js").ContextEngineFactory) => void; resolvePath: (input: string) => string; /** Register a lifecycle hook handler */ on: (hookName: K, handler: PluginHookHandlerMap[K], opts?: { priority?: number; }) => void; }; export type PluginOrigin = "bundled" | "global" | "workspace" | "config"; export type PluginDiagnostic = { level: "warn" | "error"; message: string; pluginId?: string; source?: string; }; export type PluginHookName = "before_model_resolve" | "before_prompt_build" | "before_agent_start" | "llm_input" | "llm_output" | "agent_end" | "before_compaction" | "after_compaction" | "before_reset" | "message_received" | "message_sending" | "message_sent" | "before_tool_call" | "after_tool_call" | "tool_result_persist" | "before_message_write" | "session_start" | "session_end" | "subagent_spawning" | "subagent_delivery_target" | "subagent_spawned" | "subagent_ended" | "gateway_start" | "gateway_stop"; export declare const PLUGIN_HOOK_NAMES: readonly ["before_model_resolve", "before_prompt_build", "before_agent_start", "llm_input", "llm_output", "agent_end", "before_compaction", "after_compaction", "before_reset", "message_received", "message_sending", "message_sent", "before_tool_call", "after_tool_call", "tool_result_persist", "before_message_write", "session_start", "session_end", "subagent_spawning", "subagent_delivery_target", "subagent_spawned", "subagent_ended", "gateway_start", "gateway_stop"]; export declare const isPluginHookName: (hookName: unknown) => hookName is PluginHookName; export declare const PROMPT_INJECTION_HOOK_NAMES: readonly ["before_prompt_build", "before_agent_start"]; export type PromptInjectionHookName = (typeof PROMPT_INJECTION_HOOK_NAMES)[number]; export declare const isPromptInjectionHookName: (hookName: PluginHookName) => boolean; export type PluginHookAgentContext = { agentId?: string; sessionKey?: string; sessionId?: string; workspaceDir?: string; messageProvider?: string; /** What initiated this agent run: "user", "heartbeat", "cron", or "memory". */ trigger?: string; /** Channel identifier (e.g. "telegram", "discord", "whatsapp"). */ channelId?: string; }; export type PluginHookBeforeModelResolveEvent = { /** User prompt for this run. No session messages are available yet in this phase. */ prompt: string; }; export type PluginHookBeforeModelResolveResult = { /** Override the model for this agent run. E.g. "llama3.3:8b" */ modelOverride?: string; /** Override the provider for this agent run. E.g. "ollama" */ providerOverride?: string; }; export type PluginHookBeforePromptBuildEvent = { prompt: string; /** Session messages prepared for this run. */ messages: unknown[]; }; export type PluginHookBeforePromptBuildResult = { systemPrompt?: string; prependContext?: string; /** * Prepended to the agent system prompt so providers can cache it (e.g. prompt caching). * Use for static plugin guidance instead of prependContext to avoid per-turn token cost. */ prependSystemContext?: string; /** * Appended to the agent system prompt so providers can cache it (e.g. prompt caching). * Use for static plugin guidance instead of prependContext to avoid per-turn token cost. */ appendSystemContext?: string; }; export declare const PLUGIN_PROMPT_MUTATION_RESULT_FIELDS: readonly ["systemPrompt", "prependContext", "prependSystemContext", "appendSystemContext"]; export type PluginHookBeforeAgentStartEvent = { prompt: string; /** Optional because legacy hook can run in pre-session phase. */ messages?: unknown[]; }; export type PluginHookBeforeAgentStartResult = PluginHookBeforePromptBuildResult & PluginHookBeforeModelResolveResult; export type PluginHookBeforeAgentStartOverrideResult = Omit; export declare const stripPromptMutationFieldsFromLegacyHookResult: (result: PluginHookBeforeAgentStartResult | void) => PluginHookBeforeAgentStartOverrideResult | void; export type PluginHookLlmInputEvent = { runId: string; sessionId: string; provider: string; model: string; systemPrompt?: string; prompt: string; historyMessages: unknown[]; imagesCount: number; }; export type PluginHookLlmOutputEvent = { runId: string; sessionId: string; provider: string; model: string; assistantTexts: string[]; lastAssistant?: unknown; usage?: { input?: number; output?: number; cacheRead?: number; cacheWrite?: number; total?: number; }; }; export type PluginHookAgentEndEvent = { messages: unknown[]; success: boolean; error?: string; durationMs?: number; }; export type PluginHookBeforeCompactionEvent = { /** Total messages in the session before any truncation or compaction */ messageCount: number; /** Messages being fed to the compaction LLM (after history-limit truncation) */ compactingCount?: number; tokenCount?: number; messages?: unknown[]; /** Path to the session JSONL transcript. All messages are already on disk * before compaction starts, so plugins can read this file asynchronously * and process in parallel with the compaction LLM call. */ sessionFile?: string; }; export type PluginHookBeforeResetEvent = { sessionFile?: string; messages?: unknown[]; reason?: string; }; export type PluginHookAfterCompactionEvent = { messageCount: number; tokenCount?: number; compactedCount: number; /** Path to the session JSONL transcript. All pre-compaction messages are * preserved on disk, so plugins can read and process them asynchronously * without blocking the compaction pipeline. */ sessionFile?: string; }; export type PluginHookMessageContext = { channelId: string; accountId?: string; conversationId?: string; }; export type PluginHookMessageReceivedEvent = { from: string; content: string; timestamp?: number; metadata?: Record; }; export type PluginHookMessageSendingEvent = { to: string; content: string; metadata?: Record; }; export type PluginHookMessageSendingResult = { content?: string; cancel?: boolean; }; export type PluginHookMessageSentEvent = { to: string; content: string; success: boolean; error?: string; }; export type PluginHookToolContext = { agentId?: string; sessionKey?: string; /** Ephemeral session UUID — regenerated on /new and /reset. */ sessionId?: string; /** Stable run identifier for this agent invocation. */ runId?: string; toolName: string; /** Provider-specific tool call ID when available. */ toolCallId?: string; }; export type PluginHookBeforeToolCallEvent = { toolName: string; params: Record; /** Stable run identifier for this agent invocation. */ runId?: string; /** Provider-specific tool call ID when available. */ toolCallId?: string; }; export type PluginHookBeforeToolCallResult = { params?: Record; block?: boolean; blockReason?: string; }; export type PluginHookAfterToolCallEvent = { toolName: string; params: Record; /** Stable run identifier for this agent invocation. */ runId?: string; /** Provider-specific tool call ID when available. */ toolCallId?: string; result?: unknown; error?: string; durationMs?: number; }; export type PluginHookToolResultPersistContext = { agentId?: string; sessionKey?: string; toolName?: string; toolCallId?: string; }; export type PluginHookToolResultPersistEvent = { toolName?: string; toolCallId?: string; /** * The toolResult message about to be written to the session transcript. * Handlers may return a modified message (e.g. drop non-essential fields). */ message: AgentMessage; /** True when the tool result was synthesized by a guard/repair step. */ isSynthetic?: boolean; }; export type PluginHookToolResultPersistResult = { message?: AgentMessage; }; export type PluginHookBeforeMessageWriteEvent = { message: AgentMessage; sessionKey?: string; agentId?: string; }; export type PluginHookBeforeMessageWriteResult = { block?: boolean; message?: AgentMessage; }; export type PluginHookSessionContext = { agentId?: string; sessionId: string; sessionKey?: string; }; export type PluginHookSessionStartEvent = { sessionId: string; sessionKey?: string; resumedFrom?: string; }; export type PluginHookSessionEndEvent = { sessionId: string; sessionKey?: string; messageCount: number; durationMs?: number; }; export type PluginHookSubagentContext = { runId?: string; childSessionKey?: string; requesterSessionKey?: string; }; export type PluginHookSubagentTargetKind = "subagent" | "acp"; type PluginHookSubagentSpawnBase = { childSessionKey: string; agentId: string; label?: string; mode: "run" | "session"; requester?: { channel?: string; accountId?: string; to?: string; threadId?: string | number; }; threadRequested: boolean; }; export type PluginHookSubagentSpawningEvent = PluginHookSubagentSpawnBase; export type PluginHookSubagentSpawningResult = { status: "ok"; threadBindingReady?: boolean; } | { status: "error"; error: string; }; export type PluginHookSubagentDeliveryTargetEvent = { childSessionKey: string; requesterSessionKey: string; requesterOrigin?: { channel?: string; accountId?: string; to?: string; threadId?: string | number; }; childRunId?: string; spawnMode?: "run" | "session"; expectsCompletionMessage: boolean; }; export type PluginHookSubagentDeliveryTargetResult = { origin?: { channel?: string; accountId?: string; to?: string; threadId?: string | number; }; }; export type PluginHookSubagentSpawnedEvent = PluginHookSubagentSpawnBase & { runId: string; }; export type PluginHookSubagentEndedEvent = { targetSessionKey: string; targetKind: PluginHookSubagentTargetKind; reason: string; sendFarewell?: boolean; accountId?: string; runId?: string; endedAt?: number; outcome?: "ok" | "error" | "timeout" | "killed" | "reset" | "deleted"; error?: string; }; export type PluginHookGatewayContext = { port?: number; }; export type PluginHookGatewayStartEvent = { port: number; }; export type PluginHookGatewayStopEvent = { reason?: string; }; export type PluginHookHandlerMap = { before_model_resolve: (event: PluginHookBeforeModelResolveEvent, ctx: PluginHookAgentContext) => Promise | PluginHookBeforeModelResolveResult | void; before_prompt_build: (event: PluginHookBeforePromptBuildEvent, ctx: PluginHookAgentContext) => Promise | PluginHookBeforePromptBuildResult | void; before_agent_start: (event: PluginHookBeforeAgentStartEvent, ctx: PluginHookAgentContext) => Promise | PluginHookBeforeAgentStartResult | void; llm_input: (event: PluginHookLlmInputEvent, ctx: PluginHookAgentContext) => Promise | void; llm_output: (event: PluginHookLlmOutputEvent, ctx: PluginHookAgentContext) => Promise | void; agent_end: (event: PluginHookAgentEndEvent, ctx: PluginHookAgentContext) => Promise | void; before_compaction: (event: PluginHookBeforeCompactionEvent, ctx: PluginHookAgentContext) => Promise | void; after_compaction: (event: PluginHookAfterCompactionEvent, ctx: PluginHookAgentContext) => Promise | void; before_reset: (event: PluginHookBeforeResetEvent, ctx: PluginHookAgentContext) => Promise | void; message_received: (event: PluginHookMessageReceivedEvent, ctx: PluginHookMessageContext) => Promise | void; message_sending: (event: PluginHookMessageSendingEvent, ctx: PluginHookMessageContext) => Promise | PluginHookMessageSendingResult | void; message_sent: (event: PluginHookMessageSentEvent, ctx: PluginHookMessageContext) => Promise | void; before_tool_call: (event: PluginHookBeforeToolCallEvent, ctx: PluginHookToolContext) => Promise | PluginHookBeforeToolCallResult | void; after_tool_call: (event: PluginHookAfterToolCallEvent, ctx: PluginHookToolContext) => Promise | void; tool_result_persist: (event: PluginHookToolResultPersistEvent, ctx: PluginHookToolResultPersistContext) => PluginHookToolResultPersistResult | void; before_message_write: (event: PluginHookBeforeMessageWriteEvent, ctx: { agentId?: string; sessionKey?: string; }) => PluginHookBeforeMessageWriteResult | void; session_start: (event: PluginHookSessionStartEvent, ctx: PluginHookSessionContext) => Promise | void; session_end: (event: PluginHookSessionEndEvent, ctx: PluginHookSessionContext) => Promise | void; subagent_spawning: (event: PluginHookSubagentSpawningEvent, ctx: PluginHookSubagentContext) => Promise | PluginHookSubagentSpawningResult | void; subagent_delivery_target: (event: PluginHookSubagentDeliveryTargetEvent, ctx: PluginHookSubagentContext) => Promise | PluginHookSubagentDeliveryTargetResult | void; subagent_spawned: (event: PluginHookSubagentSpawnedEvent, ctx: PluginHookSubagentContext) => Promise | void; subagent_ended: (event: PluginHookSubagentEndedEvent, ctx: PluginHookSubagentContext) => Promise | void; gateway_start: (event: PluginHookGatewayStartEvent, ctx: PluginHookGatewayContext) => Promise | void; gateway_stop: (event: PluginHookGatewayStopEvent, ctx: PluginHookGatewayContext) => Promise | void; }; export type PluginHookRegistration = { pluginId: string; hookName: K; handler: PluginHookHandlerMap[K]; priority?: number; source: string; };