* Hook runner - executes hooks and manages their lifecycle.
*/
import type { AgentMessage } from "@oh-my-pi/pi-agent-core";
import type { Model } from "@oh-my-pi/pi-ai";
import type { ModelRegistry } from "../../config/model-registry";
import type { SessionManager } from "../../session/session-manager";
import { createNoOpUIContext } from "../utils";
import type {
AppendEntryHandler,
BranchHandler,
LoadedHook,
NavigateTreeHandler,
NewSessionHandler,
SendMessageHandler,
} from "./loader";
import type {
BeforeAgentStartEvent,
BeforeAgentStartEventResult,
ContextEvent,
ContextEventResult,
HookCommandContext,
HookContext,
HookError,
HookEvent,
HookMessageRenderer,
HookUIContext,
RegisteredCommand,
SessionBeforeCompactResult,
SessionBeforeTreeResult,
SessionCompactingResult,
ToolCallEvent,
ToolCallEventResult,
ToolResultEventResult,
} from "./types";
* Listener for hook errors.
*/
export type HookErrorListener = (error: HookError) => void;
export { execCommand } from "../../exec/exec";
* HookRunner executes hooks and manages event emission.
*/
export class HookRunner {
#uiContext: HookUIContext;
#hasUI: boolean;
#errorListeners: Set<HookErrorListener> = new Set();
#getModel: () => Model | undefined = () => undefined;
#isIdleFn: () => boolean = () => true;
#waitForIdleFn: () => Promise<void> = async () => {};
#abortFn: () => void = () => {};
#hasQueuedMessagesFn: () => boolean = () => false;
#newSessionHandler: NewSessionHandler = async () => ({ cancelled: false });
#branchHandler: BranchHandler = async () => ({ cancelled: false });
#navigateTreeHandler: NavigateTreeHandler = async () => ({ cancelled: false });
constructor(
private readonly hooks: LoadedHook[],
private readonly cwd: string,
private readonly sessionManager: SessionManager,
private readonly modelRegistry: ModelRegistry,
) {
this.#uiContext = createNoOpUIContext();
this.#hasUI = false;
}
* Initialize HookRunner with all required context.
* Modes call this once the agent session is fully set up.
*/
initialize(options: {
getModel: () => Model | undefined;
sendMessageHandler: SendMessageHandler;
appendEntryHandler: AppendEntryHandler;
newSessionHandler?: NewSessionHandler;
branchHandler?: BranchHandler;
navigateTreeHandler?: NavigateTreeHandler;
isIdle?: () => boolean;
waitForIdle?: () => Promise<void>;
abort?: () => void;
hasQueuedMessages?: () => boolean;
uiContext?: HookUIContext;
hasUI?: boolean;
}): void {
this.#getModel = options.getModel;
this.#isIdleFn = options.isIdle ?? (() => true);
this.#waitForIdleFn = options.waitForIdle ?? (async () => {});
this.#abortFn = options.abort ?? (() => {});
this.#hasQueuedMessagesFn = options.hasQueuedMessages ?? (() => false);
if (options.newSessionHandler) {
this.#newSessionHandler = options.newSessionHandler;
}
if (options.branchHandler) {
this.#branchHandler = options.branchHandler;
}
if (options.navigateTreeHandler) {
this.#navigateTreeHandler = options.navigateTreeHandler;
}
for (const hook of this.hooks) {
hook.setSendMessageHandler(options.sendMessageHandler);
hook.setAppendEntryHandler(options.appendEntryHandler);
}
this.#uiContext = options.uiContext ?? createNoOpUIContext();
this.#hasUI = options.hasUI ?? false;
}
* Get the UI context (set by mode).
*/
getUIContext(): HookUIContext | null {
return this.#uiContext;
}
* Get whether UI is available.
*/
getHasUI(): boolean {
return this.#hasUI;
}
* Get the paths of all loaded hooks.
*/
getHookPaths(): string[] {
return this.hooks.map(h => h.path);
}
* Subscribe to hook errors.
* @returns Unsubscribe function
*/
onError(listener: HookErrorListener): () => void {
this.#errorListeners.add(listener);
return () => this.#errorListeners.delete(listener);
}
* Emit an error to all listeners.
*/
* Emit an error to all error listeners.
*/
emitError(error: HookError): void {
for (const listener of this.#errorListeners) {
listener(error);
}
}
* Check if any hooks have handlers for the given event type.
*/
hasHandlers(eventType: string): boolean {
for (const hook of this.hooks) {
const handlers = hook.handlers.get(eventType);
if (handlers && handlers.length > 0) {
return true;
}
}
return false;
}
* Get a message renderer for the given customType.
* Returns the first renderer found across all hooks, or undefined if none.
*/
getMessageRenderer(customType: string): HookMessageRenderer | undefined {
for (const hook of this.hooks) {
const renderer = hook.messageRenderers.get(customType);
if (renderer) {
return renderer;
}
}
return undefined;
}
* Get all registered commands from all hooks.
*/
getRegisteredCommands(): RegisteredCommand[] {
const commands: RegisteredCommand[] = [];
for (const hook of this.hooks) {
for (const command of hook.commands.values()) {
commands.push(command);
}
}
return commands;
}
* Get a registered command by name.
* Returns the first command found across all hooks, or undefined if none.
*/
getCommand(name: string): RegisteredCommand | undefined {
for (const hook of this.hooks) {
const command = hook.commands.get(name);
if (command) {
return command;
}
}
return undefined;
}
* Create the event context for handlers.
*/
#createContext(): HookContext {
return {
ui: this.#uiContext,
hasUI: this.#hasUI,
cwd: this.cwd,
sessionManager: this.sessionManager,
modelRegistry: this.modelRegistry,
model: this.#getModel(),
isIdle: () => this.#isIdleFn(),
abort: () => this.#abortFn(),
hasQueuedMessages: () => this.#hasQueuedMessagesFn(),
};
}
* Create the command context for slash command handlers.
* Extends HookContext with session control methods that are only safe in commands.
*/
createCommandContext(): HookCommandContext {
return {
...this.#createContext(),
waitForIdle: () => this.#waitForIdleFn(),
newSession: options => this.#newSessionHandler(options),
branch: entryId => this.#branchHandler(entryId),
navigateTree: (targetId, options) => this.#navigateTreeHandler(targetId, options),
};
}
* Check if event type is a session "before_*" event that can be cancelled.
*/
#isSessionBeforeEvent(
type: string,
): type is "session_before_switch" | "session_before_branch" | "session_before_compact" | "session_before_tree" {
return (
type === "session_before_switch" ||
type === "session_before_branch" ||
type === "session_before_compact" ||
type === "session_before_tree"
);
}
* Emit an event to all hooks.
* Returns the result from session before_* / tool_result events (if any handler returns one).
*/
async emit(
event: HookEvent,
): Promise<
SessionBeforeCompactResult | SessionBeforeTreeResult | SessionCompactingResult | ToolResultEventResult | undefined
> {
const ctx = this.#createContext();
let result:
| SessionBeforeCompactResult
| SessionBeforeTreeResult
| SessionCompactingResult
| ToolResultEventResult
| undefined;
for (const hook of this.hooks) {
const handlers = hook.handlers.get(event.type);
if (!handlers || handlers.length === 0) continue;
for (const handler of handlers) {
try {
const handlerResult = await handler(event, ctx);
if (this.#isSessionBeforeEvent(event.type) && handlerResult) {
result = handlerResult as SessionBeforeCompactResult | SessionBeforeTreeResult;
if (result.cancel) {
return result;
}
}
if (event.type === "tool_result" && handlerResult) {
result = handlerResult as ToolResultEventResult;
}
if (event.type === "session.compacting" && handlerResult) {
result = handlerResult as SessionCompactingResult;
}
} catch (err) {
const message = err instanceof Error ? err.message : String(err);
this.emitError({
hookPath: hook.path,
event: event.type,
error: message,
});
}
}
}
return result;
}
* Emit a tool_call event to all hooks.
* No timeout - user prompts can take as long as needed.
* Errors are thrown (not swallowed) so caller can block on failure.
*/
async emitToolCall(event: ToolCallEvent): Promise<ToolCallEventResult | undefined> {
const ctx = this.#createContext();
let result: ToolCallEventResult | undefined;
for (const hook of this.hooks) {
const handlers = hook.handlers.get("tool_call");
if (!handlers || handlers.length === 0) continue;
for (const handler of handlers) {
const handlerResult = await handler(event, ctx);
if (handlerResult) {
result = handlerResult as ToolCallEventResult;
if (result.block) {
return result;
}
}
}
}
return result;
}
* Emit a context event to all hooks.
* Handlers are chained - each gets the previous handler's output (if any).
* Returns the final modified messages, or the original if no modifications.
*
* Note: Messages are already deep-copied by the caller (pi-ai preprocessor).
*/
async emitContext(messages: AgentMessage[]): Promise<AgentMessage[]> {
const ctx = this.#createContext();
let currentMessages = messages;
for (const hook of this.hooks) {
const handlers = hook.handlers.get("context");
if (!handlers || handlers.length === 0) continue;
for (const handler of handlers) {
try {
const event: ContextEvent = { type: "context", messages: currentMessages };
const handlerResult = await handler(event, ctx);
if (handlerResult && (handlerResult as ContextEventResult).messages) {
currentMessages = (handlerResult as ContextEventResult).messages!;
}
} catch (err) {
const message = err instanceof Error ? err.message : String(err);
this.emitError({
hookPath: hook.path,
event: "context",
error: message,
});
}
}
}
return currentMessages;
}
* Emit before_agent_start event to all hooks.
* Returns the first message to inject (if any handler returns one).
*/
async emitBeforeAgentStart(
prompt: string,
images?: import("@oh-my-pi/pi-ai").ImageContent[],
): Promise<BeforeAgentStartEventResult | undefined> {
const ctx = this.#createContext();
let result: BeforeAgentStartEventResult | undefined;
for (const hook of this.hooks) {
const handlers = hook.handlers.get("before_agent_start");
if (!handlers || handlers.length === 0) continue;
for (const handler of handlers) {
try {
const event: BeforeAgentStartEvent = { type: "before_agent_start", prompt, images };
const handlerResult = await handler(event, ctx);
if (handlerResult && (handlerResult as BeforeAgentStartEventResult).message && !result) {
result = handlerResult as BeforeAgentStartEventResult;
}
} catch (err) {
const message = err instanceof Error ? err.message : String(err);
this.emitError({
hookPath: hook.path,
event: "before_agent_start",
error: message,
});
}
}
}
return result;
}
}