mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 18:01:22 +00:00
d6283f99dc
Major changes: - Replace monolithic SessionEvent with reason discriminator with individual event types: session_start, session_before_switch, session_switch, session_before_new, session_new, session_before_branch, session_branch, session_before_compact, session_compact, session_shutdown - Each event has dedicated result type (SessionBeforeSwitchResult, etc.) - HookHandler type now allows bare return statements (void in return type) - HookAPI.on() has proper overloads for each event with correct typing Additional fixes: - AgentSession now always subscribes to agent in constructor (was only subscribing when external subscribe() called, breaking internal handlers) - Standardize on undefined over null throughout codebase - HookUIContext methods return undefined instead of null - SessionManager methods return undefined instead of null - Simplify hook exports to 'export type * from types.js' - Add detailed JSDoc for skipConversationRestore vs cancel - Fix createBranchedSession to rebuild index in persist mode - newSession() now returns the session file path Updated all example hooks, tests, and emission sites to use new event types.
68 lines
2.5 KiB
TypeScript
68 lines
2.5 KiB
TypeScript
/**
|
|
* Verify the documentation example from hooks.md compiles and works.
|
|
*/
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
import type { HookAPI, SessionBeforeCompactEvent, SessionCompactEvent } from "../src/core/hooks/index.js";
|
|
|
|
describe("Documentation example", () => {
|
|
it("custom compaction example should type-check correctly", () => {
|
|
// This is the example from hooks.md - verify it compiles
|
|
const exampleHook = (pi: HookAPI) => {
|
|
pi.on("session_before_compact", async (event: SessionBeforeCompactEvent, ctx) => {
|
|
// All these should be accessible on the event
|
|
const { preparation, previousCompactions, model } = event;
|
|
// sessionManager and modelRegistry come from ctx, not event
|
|
const { sessionManager, modelRegistry } = ctx;
|
|
const { messagesToSummarize, messagesToKeep, tokensBefore, firstKeptEntryId, cutPoint } = preparation;
|
|
|
|
// Get previous summary from most recent compaction
|
|
const _previousSummary = previousCompactions[0]?.summary;
|
|
|
|
// Verify types
|
|
expect(Array.isArray(messagesToSummarize)).toBe(true);
|
|
expect(Array.isArray(messagesToKeep)).toBe(true);
|
|
expect(typeof cutPoint.firstKeptEntryIndex).toBe("number");
|
|
expect(typeof tokensBefore).toBe("number");
|
|
expect(model).toBeDefined();
|
|
expect(typeof sessionManager.getEntries).toBe("function");
|
|
expect(typeof modelRegistry.getApiKey).toBe("function");
|
|
expect(typeof firstKeptEntryId).toBe("string");
|
|
|
|
const summary = messagesToSummarize
|
|
.filter((m) => m.role === "user")
|
|
.map((m) => `- ${typeof m.content === "string" ? m.content.slice(0, 100) : "[complex]"}`)
|
|
.join("\n");
|
|
|
|
// Hooks return compaction content - SessionManager adds id/parentId
|
|
return {
|
|
compaction: {
|
|
summary: `User requests:\n${summary}`,
|
|
firstKeptEntryId,
|
|
tokensBefore,
|
|
},
|
|
};
|
|
});
|
|
};
|
|
|
|
// Just verify the function exists and is callable
|
|
expect(typeof exampleHook).toBe("function");
|
|
});
|
|
|
|
it("compact event should have correct fields", () => {
|
|
const checkCompactEvent = (pi: HookAPI) => {
|
|
pi.on("session_compact", async (event: SessionCompactEvent) => {
|
|
// These should all be accessible
|
|
const entry = event.compactionEntry;
|
|
const fromHook = event.fromHook;
|
|
|
|
expect(entry.type).toBe("compaction");
|
|
expect(typeof entry.summary).toBe("string");
|
|
expect(typeof entry.tokensBefore).toBe("number");
|
|
expect(typeof fromHook).toBe("boolean");
|
|
});
|
|
};
|
|
|
|
expect(typeof checkCompactEvent).toBe("function");
|
|
});
|
|
});
|