@ycodium-ai/plugin-api 0.2.3250 → 0.2.3252

package/README.md

@@ -56,7 +56,7 @@ import { definePlugin } from "@ycodium-ai/plugin-api";
 
 export default definePlugin({
   id: "my-plugin",
-  apiVersion: 28,
+  apiVersion: 29,
   activate: (ctx) => {
     ctx.log.info("hello");
 
@@ -247,12 +247,19 @@ shows up there without anyone registering it.
 
 ## THERE WILL BE COMPATIBILITY-BREAKING CHANGES
 
-The definition's `apiVersion` is a closed window: the host loads 28, and refuses every other
+The definition's `apiVersion` is a closed window: the host loads 29, 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 28. Plugins
+`PLUGIN_API_VERSION` to make the declaration automatically match. The current API is 29. 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 28 is refused until Ycodium itself is updated, with no update button.
+declares a version newer than 29 is refused until Ycodium itself is updated, with no update button.
+
+API 29 adds an optional `notice` to `ExecutorProbeResult`: `{ messageKey, params? }`, where
+`messageKey` is a key in the executor plugin's own locale catalog (the same catalog as its card
+form's `titleKey`) and `params` are string values. The host shows it only when the instance is
+enabled and the probe says `ready`, passes it on unchanged as the provider's optional
+`probeNotice`, and never interprets the key. Provider entries read through the data ports gain the
+same optional `probeNotice`. Older machines omit it. No other public type changes.
 
 API 28 adds `ctx.threads.artifacts.deliver` (hand a file to the user; the file is copied into the
 thread's attachments; a plugin may deliver only into a thread it opened directly, and with
@@ -457,7 +464,7 @@ An empty page with a cursor still continues. All failures propagate unchanged, i
 `ThreadNotFoundError` when the thread is missing; use `isThreadNotFound(error)` to identify it.
 `ctx.communication.inbox.read` is gone; that port always rejected a plugin, because only the agent
 in the thread has its own inbox. Plugins targeting these earlier versions are refused on the current host;
-the minimum version is 28.
+the minimum version is 29.
 
 API 8 changed what the UI gets for a communication record. `ConversationCommunicationRecord`
 (from the conversation host's `useCommunicationRecord`) and `CommunicationViewExchange` carry `bodyState`, and their

package/dist/dataPorts.gen.d.ts

@@ -2598,6 +2598,12 @@ export type MachineSettingsProvidersGetOutput = {
             readonly "checkedAt": string | null;
             readonly "message": string | null;
         };
+        readonly "probeNotice"?: {
+            readonly "messageKey": string;
+            readonly "params"?: {
+                readonly [x: string]: string;
+            };
+        };
         readonly "installCommand"?: string;
         readonly "installUrl"?: string;
         readonly "signIn"?: ReadonlyArray<{