strongly type client tool calls

Author: charleslien

backend/src/__tests__/subagent-streaming.test.ts

@@ -18,8 +18,8 @@ import { handleSpawnAgents } from '../tools/handlers/tool/spawn-agents'
 import * as loggerModule from '../util/logger'
 
 import type { AgentTemplate } from '../templates/types'
-import type { CodebuffToolCall } from '../tools/constants'
 import type { SendSubagentChunk } from '../tools/handlers/tool/spawn-agents'
+import type { CodebuffToolCall } from '@codebuff/common/tools/list'
 import type { Mock } from 'bun:test'
 import type { WebSocket } from 'ws'
 

backend/src/loop-main-prompt.ts

@@ -11,7 +11,6 @@ import { expireMessages } from './util/messages'
 import { requestToolCall } from './websockets/websocket-action'
 
 import type { AgentTemplate } from './templates/types'
-import type { ClientToolCall } from './tools/constants'
 import type { ClientAction } from '@codebuff/common/actions'
 import type { CostMode } from '@codebuff/common/constants'
 import type { PrintModeEvent } from '@codebuff/common/types/print-mode'
@@ -35,8 +34,8 @@ export const mainPrompt = async (
   options: MainPromptOptions,
 ): Promise<{
   sessionState: SessionState
-  toolCalls: Array<ClientToolCall>
-  toolResults: Array<ToolResult>
+  toolCalls: []
+  toolResults: ToolResult[]
 }> => {
   const { userId, clientSessionId, onResponseChunk, localAgentTemplates } =
     options

backend/src/main-prompt.ts

@@ -7,7 +7,7 @@ import { SandboxManager } from './util/quickjs-sandbox'
 import { getRequestContext } from './websockets/request-context'
 import { sendAction } from './websockets/websocket-action'
 
-import type { CodebuffToolCall } from './tools/constants'
+import type { CodebuffToolCall } from '@codebuff/common/tools/list'
 import type {
   AgentTemplate,
   StepGenerator,

backend/src/run-programmatic-step.ts

@@ -1,32 +1,3 @@
 import { endsAgentStepParam } from '@codebuff/common/tools/constants'
 
-import type { codebuffToolDefs } from './definitions/list'
-import type { FileChange } from '@codebuff/common/actions'
-import type { ToolName } from '@codebuff/common/tools/constants'
-import type { ToolCallPart } from 'ai'
-import type { z } from 'zod/v4'
-
 export const globalStopSequence = `${JSON.stringify(endsAgentStepParam)}`
-
-// Tool call from LLM
-export type CodebuffToolCall<T extends ToolName = ToolName> = {
-  [K in ToolName]: {
-    toolName: K
-    input: z.infer<(typeof codebuffToolDefs)[K]['parameters']>
-  } & Omit<ToolCallPart, 'type'>
-}[T]
-
-// Tool call to send to client
-export type ClientToolCall<T extends ToolName = ToolName> = {
-  [K in ToolName]: {
-    toolName: K
-    input: K extends 'run_terminal_command'
-      ? CodebuffToolCall<'run_terminal_command'>['input'] & {
-          mode: 'assistant' | 'user'
-        }
-      : K extends 'write_file' | 'str_replace' | 'create_plan'
-        ? FileChange
-        : CodebuffToolCall<K>['input']
-  }
-}[T] &
-  Omit<ToolCallPart, 'type'>

backend/src/tools/constants.ts

@@ -1,5 +1,9 @@
-import type { ClientToolCall, CodebuffToolCall } from '../constants'
 import type { ToolName } from '@codebuff/common/tools/constants'
+import type {
+  ClientToolCall,
+  ClientToolName,
+  CodebuffToolCall,
+} from '@codebuff/common/tools/list'
 import type { ProjectFileContext } from '@codebuff/common/util/file'
 
 type PresentOrAbsent<K extends PropertyKey, V> =
@@ -24,7 +28,9 @@ export type CodebuffToolHandlerFunction<T extends ToolName = ToolName> = (
     state: { [K in string]?: any }
   } & PresentOrAbsent<
     'requestClientToolCall',
-    (toolCall: ClientToolCall<T>) => Promise<string>
+    (
+      toolCall: ClientToolCall<T extends ClientToolName ? T : never>,
+    ) => Promise<string>
   >,
 ) => {
   result: Promise<string | undefined>

backend/src/tools/handlers/handler-function-type.ts

@@ -1,5 +1,5 @@
-import type { CodebuffToolCall } from '../../constants'
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type { CodebuffToolCall } from '@codebuff/common/tools/list'
 import type { CodebuffMessage } from '@codebuff/common/types/message'
 
 export const handleAddMessage = (({

backend/src/tools/handlers/tool/add-message.ts

@@ -1,7 +1,7 @@
 import { buildArray } from '@codebuff/common/util/array'
 
-import type { CodebuffToolCall } from '../../constants'
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type { CodebuffToolCall } from '@codebuff/common/tools/list'
 import type { Subgoal } from '@codebuff/common/types/session-state'
 
 export const handleAddSubgoal = ((params: {

backend/src/tools/handlers/tool/add-subgoal.ts

@@ -1,5 +1,8 @@
-import type { ClientToolCall, CodebuffToolCall } from '../../constants'
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type {
+  ClientToolCall,
+  CodebuffToolCall,
+} from '@codebuff/common/tools/list'
 
 export const handleBrowserLogs = ((params: {
   previousToolCallFinished: Promise<void>

backend/src/tools/handlers/tool/browser-logs.ts

@@ -1,5 +1,8 @@
-import type { ClientToolCall, CodebuffToolCall } from '../../constants'
 import type { CodebuffToolHandlerFunction } from '../handler-function-type'
+import type {
+  ClientToolCall,
+  CodebuffToolCall,
+} from '@codebuff/common/tools/list'
 
 export const handleCodeSearch = ((params: {
   previousToolCallFinished: Promise<void>