mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-16 19:04:37 +00:00
102 lines
3.6 KiB
Markdown
102 lines
3.6 KiB
Markdown
# Changelog
|
|
|
|
## [0.34.0] - 2026-01-04
|
|
|
|
## [0.33.0] - 2026-01-04
|
|
|
|
## [0.32.3] - 2026-01-03
|
|
|
|
## [0.32.2] - 2026-01-03
|
|
|
|
## [0.32.1] - 2026-01-03
|
|
|
|
## [0.32.0] - 2026-01-03
|
|
|
|
## [0.31.1] - 2026-01-02
|
|
|
|
## [0.31.0] - 2026-01-02
|
|
|
|
### Breaking Changes
|
|
|
|
- **Agent class moved to `@mariozechner/pi-agent-core`**: The `Agent` class, `AgentState`, and related types are no longer exported from this package. Import them from `@mariozechner/pi-agent-core` instead.
|
|
|
|
- **Transport abstraction removed**: `ProviderTransport`, `AppTransport`, `AgentTransport` interface, and related types have been removed. The `Agent` class now uses `streamFn` for custom streaming.
|
|
|
|
- **`AppMessage` renamed to `AgentMessage`**: Now imported from `@mariozechner/pi-agent-core`. Custom message types use declaration merging on `CustomAgentMessages` interface.
|
|
|
|
- **`UserMessageWithAttachments` is now a custom message type**: Has `role: "user-with-attachments"` instead of `role: "user"`. Use `isUserMessageWithAttachments()` type guard.
|
|
|
|
- **`CustomMessages` interface removed**: Use declaration merging on `CustomAgentMessages` from `@mariozechner/pi-agent-core` instead.
|
|
|
|
- **`agent.appendMessage()` removed**: Use `agent.queueMessage()` instead.
|
|
|
|
- **Agent event types changed**: `AgentInterface` now handles new event types from `@mariozechner/pi-agent-core`: `message_start`, `message_end`, `message_update`, `turn_start`, `turn_end`, `agent_start`, `agent_end`.
|
|
|
|
### Added
|
|
|
|
- **`defaultConvertToLlm`**: Default message transformer that handles `UserMessageWithAttachments` and `ArtifactMessage`. Apps can extend this for custom message types.
|
|
|
|
- **`convertAttachments`**: Utility to convert `Attachment[]` to LLM content blocks (images and extracted document text).
|
|
|
|
- **`isUserMessageWithAttachments` / `isArtifactMessage`**: Type guard functions for custom message types.
|
|
|
|
- **`createStreamFn`**: Creates a stream function with CORS proxy support. Reads proxy settings on each call for dynamic configuration.
|
|
|
|
- **Default `streamFn` and `getApiKey`**: `AgentInterface` now sets sensible defaults if not provided:
|
|
- `streamFn`: Uses `createStreamFn` with proxy settings from storage
|
|
- `getApiKey`: Reads from `providerKeys` storage
|
|
|
|
- **Proxy utilities exported**: `applyProxyIfNeeded`, `shouldUseProxyForProvider`, `isCorsError`, `createStreamFn`
|
|
|
|
### Removed
|
|
|
|
- `Agent` class (moved to `@mariozechner/pi-agent-core`)
|
|
- `ProviderTransport` class
|
|
- `AppTransport` class
|
|
- `AgentTransport` interface
|
|
- `AgentRunConfig` type
|
|
- `ProxyAssistantMessageEvent` type
|
|
- `test-sessions.ts` example file
|
|
|
|
### Migration Guide
|
|
|
|
**Before (0.30.x):**
|
|
```typescript
|
|
import { Agent, ProviderTransport, type AppMessage } from '@mariozechner/pi-web-ui';
|
|
|
|
const agent = new Agent({
|
|
transport: new ProviderTransport(),
|
|
messageTransformer: (messages: AppMessage[]) => messages.filter(...)
|
|
});
|
|
```
|
|
|
|
**After:**
|
|
```typescript
|
|
import { Agent, type AgentMessage } from '@mariozechner/pi-agent-core';
|
|
import { defaultConvertToLlm } from '@mariozechner/pi-web-ui';
|
|
|
|
const agent = new Agent({
|
|
convertToLlm: (messages: AgentMessage[]) => {
|
|
// Extend defaultConvertToLlm for custom types
|
|
return defaultConvertToLlm(messages);
|
|
}
|
|
});
|
|
// AgentInterface will set streamFn and getApiKey defaults automatically
|
|
```
|
|
|
|
**Custom message types:**
|
|
```typescript
|
|
// Before: declaration merging on CustomMessages
|
|
declare module "@mariozechner/pi-web-ui" {
|
|
interface CustomMessages {
|
|
"my-message": MyMessage;
|
|
}
|
|
}
|
|
|
|
// After: declaration merging on CustomAgentMessages
|
|
declare module "@mariozechner/pi-agent-core" {
|
|
interface CustomAgentMessages {
|
|
"my-message": MyMessage;
|
|
}
|
|
}
|
|
```
|