feat: add agent protocol entry events (#157)

* feat: add agent protocol events

* feat: add tool payload schemas
This commit is contained in:
2026-07-04 15:03:03 +01:00
committed by GitHub
parent 9aaefda216
commit 6401616890
6 changed files with 84 additions and 13 deletions

View File

@@ -6,5 +6,8 @@
"types": "src/index.ts",
"scripts": {
"test": "bun test ./src"
},
"dependencies": {
"@freya/core": "workspace:*"
}
}

View File

@@ -1,20 +1,40 @@
import { ConversationEntryKind, ConversationEntryVisibility } from "@freya/core"
import { describe, expect, test } from "bun:test"
import type { AgentEvent, AgentServerApi } from "./index"
import { AgentEventKind, type AgentEvent, type AgentServerApi } from "./index"
describe("agent protocol", () => {
test("defines server methods and agent events", () => {
const server: AgentServerApi = {
async sendMessage(message) {
return { message, conversationId: "conversation-1" }
return {
id: "entry-1",
conversationId: "conversation-1",
sequence: 1,
kind: ConversationEntryKind.UserMessage,
visibility: ConversationEntryVisibility.UserVisible,
fileId: null,
payload: {
role: "user",
parts: [{ type: "text", text: message }],
},
metadata: {},
createdAt: "2026-07-03T00:00:00.000Z",
}
},
notify() {
// no-op for protocol shape test
},
ping() {
return "pong"
},
}
const event: AgentEvent = { type: "message_finished" }
const event: AgentEvent = {
kind: AgentEventKind.ResponseFinished,
conversationId: "conversation-1",
}
expect(server.ping()).toBe("pong")
expect(event.type).toBe("message_finished")
expect(event.kind).toBe(AgentEventKind.ResponseFinished)
})
})

View File

@@ -1,18 +1,46 @@
export interface SendMessageResult {
message: string
import type { ConversationEntry } from "@freya/core"
export const AgentEventKind = {
ConversationStarted: "conversation_started",
ConversationEntryCreated: "conversation_entry_created",
ResponseFinished: "response_finished",
ResponseFailed: "response_failed",
} as const
export type AgentEventKind = (typeof AgentEventKind)[keyof typeof AgentEventKind]
export interface AgentConversationStartedEvent {
kind: typeof AgentEventKind.ConversationStarted
conversationId: string
}
export interface AgentConversationEntryCreatedEvent {
kind: typeof AgentEventKind.ConversationEntryCreated
entry: ConversationEntry
}
export interface AgentResponseFinishedEvent {
kind: typeof AgentEventKind.ResponseFinished
conversationId: string
}
export interface AgentResponseFailedEvent {
kind: typeof AgentEventKind.ResponseFailed
conversationId: string
error: string
}
export type AgentEvent =
| { type: "conversation_started"; conversationId: string }
| { type: "message_created"; text: string }
| { type: "tool_started"; toolName: string }
| { type: "tool_finished"; toolName: string; ok: boolean }
| { type: "message_finished" }
| { type: "message_failed"; error: string }
| AgentConversationStartedEvent
| AgentConversationEntryCreatedEvent
| AgentResponseFinishedEvent
| AgentResponseFailedEvent
export type UserEvent = { type: "typing" }
export interface AgentServerApi {
sendMessage(message: string): Promise<SendMessageResult>
sendMessage(message: string): Promise<ConversationEntry>
notify(event: UserEvent): void
ping(): "pong"
}