@ycodium-ai/plugin-api 0.2.3018 → 0.2.3020

package/README.md

@@ -56,7 +56,7 @@ import { definePlugin } from "@ycodium-ai/plugin-api";
 
 export default definePlugin({
   id: "my-plugin",
-  apiVersion: 8,
+  apiVersion: 9,
   activate: (ctx) => {
     ctx.log.info("hello");
 
@@ -230,12 +230,26 @@ shows up there without anyone registering it.
 
 ## THERE WILL BE COMPATIBILITY-BREAKING CHANGES
 
-The definition's `apiVersion` is a closed window: the host loads 8, and refuses every other
+The definition's `apiVersion` is a closed window: the host loads 9, and refuses every other
 value. Declare the version your plugin targets as a literal; do not read the host's
-`PLUGIN_API_VERSION` to make the declaration automatically match. The current API is 8. Plugins
+`PLUGIN_API_VERSION` to make the declaration automatically match. The current API is 9. Plugins
 targeting an older API are refused before activation; the message names the version the plugin
 declared and the one this Ycodium loads, and the plugin card offers an update. A plugin that
-declares a version newer than 8 is refused until Ycodium itself is updated, with no update button.
+declares a version newer than 9 is refused until Ycodium itself is updated, with no update button.
+
+API 9 changed how a plugin reads a thread: `ctx.projections.getThread` is gone, and so are the
+types `PluginThread` and `PluginActivity`. Read one thread through the data ports: `ctx.threads.get`
+returns the shell (status, title, model, and session state; archived threads are included),
+`ctx.threads.messages.list` returns messages newest first, paginated, with the body readable in
+segments and attachments as metadata only, `ctx.threads.activities.list` returns activities
+(`kinds` is required, paginated, and a large payload is a stub), and `ctx.threads.history` returns
+the whole detail, which was already there. `threadOrNull(ctx.threads, threadId, options?)` returns
+`null` when there is no such thread, and an archived thread is `null` by default until you pass
+`{ archived: "include" }`; `isThreadNotFound(error)` is also new. The new constants are
+`TOOL_LIFECYCLE_ACTIVITY_KINDS`, `THREAD_MESSAGES_LIST_LIMIT`, and `THREAD_ACTIVITIES_LIST_LIMIT`.
+`ctx.communication.inbox.read` is gone; that port always rejected a plugin, because only the agent
+in the thread has its own inbox. A plugin written for 8 (`apiVersion: 8`) is refused on a 9 host,
+the same as every earlier bump: the minimum version is 9 itself.
 
 API 8 changed what the UI gets for a communication record. `ConversationCommunicationRecord`
 (from the conversation host's `useCommunicationRecord`) and `CommunicationViewExchange` carry `bodyState`, and their