@ycodium-ai/plugin-api 0.2.3250 → 0.2.3254

package/README.md

@@ -56,7 +56,7 @@ import { definePlugin } from "@ycodium-ai/plugin-api";
 
 export default definePlugin({
   id: "my-plugin",
-  apiVersion: 28,
+  apiVersion: 30,
   activate: (ctx) => {
     ctx.log.info("hello");
 
@@ -247,12 +247,27 @@ 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 30, 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 30. 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 30 is refused until Ycodium itself is updated, with no update button.
+
+API 30 makes `projectCwd` optional in `bootstrap.prepareWorktree` of `ctx.threads.turns.start`:
+a plugin may ask for a worktree on the first turn of a thread it opened directly, without naming a
+folder, and the host resolves the thread's own start folder. The plugin must declare the
+`thread.worktree.prepare` command in `commands.dispatch`; `createThread`, `runSetupScript` and
+`projectCwd` stay unavailable to plugins, and the turn fails instead of falling back when no worktree can be
+made. Each entry of `ctx.memory.experiences.list` and `get` gains an optional `supersededBy` (ids
+of the experiences that replace it). Older machines omit these. No other public type changes.
+
+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 +472,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 30.
 
 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

@@ -480,6 +480,7 @@ type Objects_79 = {
     readonly "principalId": string;
 };
 type Arrays_15 = ReadonlyArray<string>;
+type Arrays_16 = ReadonlyArray<string>;
 type Objects_80 = {
     readonly "searched": number;
     readonly "read": number;
@@ -522,8 +523,8 @@ type Objects_90 = {
     readonly "group": "backlog" | "unstarted" | "started" | "completed" | "cancelled";
     readonly "name": string;
 };
-type Arrays_18 = ReadonlyArray<string>;
 type Arrays_19 = ReadonlyArray<string>;
+type Arrays_20 = ReadonlyArray<string>;
 type Objects_91 = {
     readonly "total": number;
     readonly "completed": number;
@@ -922,7 +923,7 @@ type Objects_70 = {
     readonly "redeemable"?: true;
     readonly "redeeming"?: true;
 };
-type Arrays_16 = ReadonlyArray<Objects_88>;
+type Arrays_17 = ReadonlyArray<Objects_88>;
 type Objects_89 = {
     readonly "changed": boolean;
     readonly "release": number;
@@ -1141,7 +1142,7 @@ type Objects_85 = {
 };
 type Objects_87 = {
     readonly "release": number;
-    readonly "pages": Arrays_16;
+    readonly "pages": Arrays_17;
     readonly "itemCount": number;
     readonly "itemHighWater": number;
     readonly "requiresAck": boolean;
@@ -1150,7 +1151,7 @@ type Objects_87 = {
     readonly "publishedBy": Union_41;
     readonly "publishedAt": string;
 };
-type Arrays_17 = ReadonlyArray<Union_44>;
+type Arrays_18 = ReadonlyArray<Union_44>;
 type Objects_92 = {
     readonly "commentId": string;
     readonly "workItemId": string;
@@ -2598,6 +2599,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<{
@@ -3626,6 +3633,7 @@ export type MemoryExperiencesListOutput = {
         readonly "createdAt": string;
         readonly "updatedAt": string;
         readonly "supersedes": Arrays_15;
+        readonly "supersededBy"?: Arrays_16;
         readonly "bodyState": "present" | "erased" | "unavailable";
         readonly "usage"?: Objects_80;
         readonly "excerpt": string | null;
@@ -3648,6 +3656,7 @@ export type MemoryExperiencesGetOutput = {
     readonly "createdAt": string;
     readonly "updatedAt": string;
     readonly "supersedes": Arrays_15;
+    readonly "supersededBy"?: Arrays_16;
     readonly "bodyState": "present" | "erased" | "unavailable";
     readonly "usage"?: Objects_80;
     readonly "body": string | null;
@@ -3935,7 +3944,7 @@ export type MemoryHandbookReleasesGetInput = {
 };
 export type MemoryHandbookReleasesGetOutput = {
     readonly "release": number;
-    readonly "pages": Arrays_16;
+    readonly "pages": Arrays_17;
     readonly "itemCount": number;
     readonly "itemHighWater": number;
     readonly "requiresAck": boolean;
@@ -4042,8 +4051,8 @@ export type WorkItemsListOutput = {
         readonly "bodyState": "present" | "erased" | "unavailable";
         readonly "state": Objects_90;
         readonly "priority": "urgent" | "high" | "medium" | "low" | "none";
-        readonly "assignees": Arrays_17;
-        readonly "labelIds": Arrays_18;
+        readonly "assignees": Arrays_18;
+        readonly "labelIds": Arrays_19;
         readonly "parentId": string | null;
         readonly "startDate": string | null;
         readonly "targetDate": string | null;
@@ -4052,7 +4061,7 @@ export type WorkItemsListOutput = {
         readonly "archivedAt": string | null;
         readonly "version": number;
         readonly "revision": number;
-        readonly "blockedBy": Arrays_19;
+        readonly "blockedBy": Arrays_20;
         readonly "blockedByTotal": number;
         readonly "childCounts": Objects_91;
         readonly "createdBy": Union_41;
@@ -4084,8 +4093,8 @@ export type WorkItemsGetOutput = {
         readonly "bodyState": "present" | "erased" | "unavailable";
         readonly "state": Objects_90;
         readonly "priority": "urgent" | "high" | "medium" | "low" | "none";
-        readonly "assignees": Arrays_17;
-        readonly "labelIds": Arrays_18;
+        readonly "assignees": Arrays_18;
+        readonly "labelIds": Arrays_19;
         readonly "parentId": string | null;
         readonly "startDate": string | null;
         readonly "targetDate": string | null;
@@ -4094,7 +4103,7 @@ export type WorkItemsGetOutput = {
         readonly "archivedAt": string | null;
         readonly "version": number;
         readonly "revision": number;
-        readonly "blockedBy": Arrays_19;
+        readonly "blockedBy": Arrays_20;
         readonly "blockedByTotal": number;
         readonly "childCounts": Objects_91;
         readonly "createdBy": Union_41;
@@ -4673,7 +4682,7 @@ export type ThreadsTurnsStartInput = {
             readonly "createdAt": string;
         };
         readonly "prepareWorktree"?: {
-            readonly "projectCwd": string;
+            readonly "projectCwd"?: string;
             readonly "baseBranch": string;
             readonly "branch"?: string;
             readonly "startFromOrigin"?: boolean;