add new CodebuffMessage

Author: charleslien

common/src/tools/utils.ts

@@ -21,7 +21,7 @@ export function getToolCallString<T extends ToolName | (string & {})>(
     toolName in llmToolCallSchema
       ? llmToolCallSchema[toolName as keyof typeof llmToolCallSchema]
           .endsAgentStep
-      : endsAgentStep[0]
+      : endsAgentStep[0] ?? false
   const obj: Record<string, any> = {
     [toolNameParam]: toolName,
     ...params,

common/src/types/json.ts

@@ -0,0 +1,29 @@
+import z from 'zod/v4'
+
+export type JSONValue =
+  | null
+  | string
+  | number
+  | boolean
+  | JSONObject
+  | JSONArray
+export const jsonValueSchema: z.ZodType<JSONValue> = z.lazy(() =>
+  z.union([
+    z.null(),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    JSONObjectSchema,
+    JSONArraySchema,
+  ]),
+)
+
+export const JSONObjectSchema: z.ZodType<JSONObject> = z.lazy(() =>
+  z.record(z.string(), jsonValueSchema),
+)
+export type JSONObject = { [key: string]: JSONValue }
+
+export const JSONArraySchema: z.ZodType<JSONArray> = z.lazy(() =>
+  z.array(jsonValueSchema),
+)
+export type JSONArray = JSONValue[]

common/src/types/messages/codebuff-message.ts

@@ -0,0 +1,57 @@
+import z from 'zod/v4'
+
+import {
+  filePartSchema,
+  imagePartSchema,
+  reasoningPartSchema,
+  textPartSchema,
+  toolCallPartSchema,
+  toolResultPartSchema,
+} from './content-part'
+import { providerMetadataSchema } from './provider-metadata'
+
+export const systemCodebuffMessageSchema = z.object({
+  role: z.literal('system'),
+  content: z.string(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type SystemCodebuffMessage = z.infer<typeof systemCodebuffMessageSchema>
+
+export const userCodebuffMessageSchema = z.object({
+  role: z.literal('user'),
+  content: z.union([textPartSchema, imagePartSchema, filePartSchema]).array(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type UserCodebuffMessage = z.infer<typeof userCodebuffMessageSchema>
+
+export const assistantCodebuffMessageSchema = z.object({
+  role: z.literal('assistant'),
+  content: z
+    .union([
+      textPartSchema,
+      filePartSchema,
+      reasoningPartSchema,
+      toolCallPartSchema,
+      toolResultPartSchema,
+    ])
+    .array(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type AssistantCodebuffMessage = z.infer<
+  typeof assistantCodebuffMessageSchema
+>
+
+export const toolCodebuffMessageSchema = z.object({
+  role: z.literal('tool'),
+  content: toolResultPartSchema.array(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type ToolCodebuffMessage = z.infer<typeof toolCodebuffMessageSchema>
+
+export const codebuffMessageSchema = z.union([
+  systemCodebuffMessageSchema,
+  userCodebuffMessageSchema,
+  assistantCodebuffMessageSchema,
+  toolCodebuffMessageSchema,
+])
+export type CodebuffMessage = z.infer<typeof codebuffMessageSchema>

common/src/types/messages/content-part.ts

@@ -0,0 +1,75 @@
+import z from 'zod/v4'
+
+import { providerMetadataSchema } from './provider-metadata'
+import { jsonValueSchema } from '../json'
+import { dataContentSchema } from './data-content'
+
+export const textPartSchema = z.object({
+  type: z.literal('text'),
+  text: z.string(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type TextPart = z.infer<typeof textPartSchema>
+
+export const imagePartSchema = z.object({
+  type: z.literal('image'),
+  image: z.union([dataContentSchema, z.instanceof(URL)]),
+  mediaType: z.string().optional(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type ImagePart = z.infer<typeof imagePartSchema>
+
+export const filePartSchema = z.object({
+  type: z.literal('file'),
+  data: z.union([dataContentSchema, z.instanceof(URL)]),
+  filename: z.string().optional(),
+  mediaType: z.string(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type FilePart = z.infer<typeof filePartSchema>
+
+export const reasoningPartSchema = z.object({
+  type: z.literal('reasoning'),
+  text: z.string(),
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type ReasoningPart = z.infer<typeof reasoningPartSchema>
+
+export const toolCallPartSchema = z.object({
+  type: z.literal('tool-call'),
+  toolCallId: z.string(),
+  toolName: z.string(),
+  input: z.record(z.string(), z.unknown()),
+  providerOptions: providerMetadataSchema.optional(),
+  providerExecuted: z.boolean().optional(),
+})
+export type ToolCallPart = z.infer<typeof toolCallPartSchema>
+
+export const toolResultOutputSchema = z.discriminatedUnion('type', [
+  z.object({
+    type: z.literal('json'),
+    value: z
+      .discriminatedUnion('type', [
+        z.object({
+          type: z.literal('json'),
+          value: jsonValueSchema,
+        }),
+        z.object({
+          type: z.literal('media'),
+          data: z.string(),
+          mediaType: z.string(),
+        }),
+      ])
+      .array(),
+  }),
+])
+export type ToolResultOutput = z.infer<typeof toolResultOutputSchema>
+
+export const toolResultPartSchema = z.object({
+  type: z.literal('tool-result'),
+  toolCallId: z.string(),
+  toolName: z.string(),
+  output: toolResultOutputSchema,
+  providerOptions: providerMetadataSchema.optional(),
+})
+export type ToolResultPart = z.infer<typeof toolResultPartSchema>

common/src/types/messages/data-content.ts

@@ -0,0 +1,14 @@
+import z from 'zod/v4'
+
+export const dataContentSchema = z.union([
+  z.string(),
+  z.instanceof(Uint8Array),
+  z.instanceof(ArrayBuffer),
+  z.custom<Buffer>(
+    // Buffer might not be available in some environments such as CloudFlare:
+    (value: unknown): value is Buffer =>
+      globalThis.Buffer?.isBuffer(value) ?? false,
+    { message: 'Must be a Buffer' },
+  ),
+])
+export type DataContent = z.infer<typeof dataContentSchema>

common/src/types/messages/provider-metadata.ts

@@ -0,0 +1,10 @@
+import z from 'zod/v4'
+
+import { jsonValueSchema } from '../json'
+
+export const providerMetadataSchema = z.record(
+  z.string(),
+  z.record(z.string(), jsonValueSchema),
+)
+
+export type ProviderMetadata = z.infer<typeof providerMetadataSchema>

common/src/types/session-state.ts

@@ -1,11 +1,11 @@
 import { z } from 'zod/v4'
 
-import { CodebuffMessageSchema } from './message'
+import { codebuffMessageSchema } from './messages/codebuff-message'
+import { MAX_AGENT_STEPS_DEFAULT } from '../constants/agents'
 import { ProjectFileContextSchema } from '../util/file'
 
 import type { CodebuffMessage } from './message'
 import type { ProjectFileContext } from '../util/file'
-import { MAX_AGENT_STEPS_DEFAULT } from '../constants/agents'
 
 export const toolCallSchema = z.object({
   toolName: z.string(),
@@ -50,7 +50,7 @@ export const AgentStateSchema: z.ZodType<{
     agentType: z.string().nullable(),
     agentContext: z.record(z.string(), subgoalSchema),
     subagents: AgentStateSchema.array(),
-    messageHistory: CodebuffMessageSchema.array(),
+    messageHistory: codebuffMessageSchema.array(),
     stepsRemaining: z.number(),
     creditsUsed: z.number().default(0),
     output: z.record(z.string(), z.any()).optional(),