π File detail
utils/hooks/apiQueryHookHelper.ts
π― Use case
This file lives under βutils/β, which covers cross-cutting helpers (shell, tempfiles, settings, messages, process input, β¦). On the API surface it exposes ApiQueryHookContext, ApiQueryHookConfig, ApiQueryResult, and createApiQueryHook β mainly types, interfaces, or factory objects. Dependencies touch crypto. It composes internal code from constants, services, types, utils, and errors (relative imports).
Generated from folder role, exports, dependency roots, and inline comments β not hand-reviewed for every path.
π§ Inline summary
import { randomUUID } from 'crypto' import type { QuerySource } from '../../constants/querySource.js' import { queryModelWithoutStreaming } from '../../services/api/claude.js' import type { Message } from '../../types/message.js' import { createAbortController } from '../../utils/abortController.js'
π€ Exports (heuristic)
ApiQueryHookContextApiQueryHookConfigApiQueryResultcreateApiQueryHook
π External import roots
Package roots from from "β¦" (relative paths omitted).
crypto
π₯οΈ Source preview
import { randomUUID } from 'crypto'
import type { QuerySource } from '../../constants/querySource.js'
import { queryModelWithoutStreaming } from '../../services/api/claude.js'
import type { Message } from '../../types/message.js'
import { createAbortController } from '../../utils/abortController.js'
import { logError } from '../../utils/log.js'
import { toError } from '../errors.js'
import { extractTextContent } from '../messages.js'
import { asSystemPrompt } from '../systemPromptType.js'
import type { REPLHookContext } from './postSamplingHooks.js'
export type ApiQueryHookContext = REPLHookContext & {
queryMessageCount?: number
}
export type ApiQueryHookConfig<TResult> = {
name: QuerySource
shouldRun: (context: ApiQueryHookContext) => Promise<boolean>
// Build the complete message list to send to the API
buildMessages: (context: ApiQueryHookContext) => Message[]
// Optional: override system prompt (defaults to context.systemPrompt)
systemPrompt?: string
// Optional: whether to use tools from context (defaults to true)
// Set to false to pass empty tools array
useTools?: boolean
parseResponse: (content: string, context: ApiQueryHookContext) => TResult
logResult: (
result: ApiQueryResult<TResult>,
context: ApiQueryHookContext,
) => void
// Must be a function to ensure lazy loading (config is accessed before allowed)
// Receives context so callers can inherit the main loop model if desired.
getModel: (context: ApiQueryHookContext) => string
}
export type ApiQueryResult<TResult> =
| {
type: 'success'
queryName: string
result: TResult
messageId: string
model: string
uuid: string
}
| {
type: 'error'
queryName: string
error: Error
uuid: string
}
export function createApiQueryHook<TResult>(
config: ApiQueryHookConfig<TResult>,
) {
return async (context: ApiQueryHookContext): Promise<void> => {
try {
const shouldRun = await config.shouldRun(context)
if (!shouldRun) {
return
}
const uuid = randomUUID()
// Build messages using the config's buildMessages function
const messages = config.buildMessages(context)
context.queryMessageCount = messages.length
// Use config's system prompt if provided, otherwise use context's
const systemPrompt = config.systemPrompt
? asSystemPrompt([config.systemPrompt])
: context.systemPrompt
// Use config's tools preference (defaults to true = use context tools)
const useTools = config.useTools ?? true
const tools = useTools ? context.toolUseContext.options.tools : []
// Get model (lazy loaded)
const model = config.getModel(context)
// Make API call
const response = await queryModelWithoutStreaming({
messages,
systemPrompt,
thinkingConfig: { type: 'disabled' as const },
tools,
signal: createAbortController().signal,
options: {
getToolPermissionContext: async () => {
const appState = context.toolUseContext.getAppState()
return appState.toolPermissionContext
},
model,
toolChoice: undefined,
isNonInteractiveSession:
context.toolUseContext.options.isNonInteractiveSession,
hasAppendSystemPrompt:
!!context.toolUseContext.options.appendSystemPrompt,
temperatureOverride: 0,
agents: context.toolUseContext.options.agentDefinitions.activeAgents,
querySource: config.name,
mcpTools: [],
agentId: context.toolUseContext.agentId,
},
})
// Parse response
const content = extractTextContent(response.message.content).trim()
try {
const result = config.parseResponse(content, context)
config.logResult(
{
type: 'success',
queryName: config.name,
result,
messageId: response.message.id,
model,
uuid,
},
context,
)
} catch (error) {
config.logResult(
{
type: 'error',
queryName: config.name,
error: error as Error,
uuid,
},
context,
)
}
} catch (error) {
logError(toError(error))
}
}
}