@ycodium-ai/plugin-api 0.2.2968 → 0.2.2974

package/README.md

@@ -257,6 +257,35 @@ the instance, sorted, without values. `driverConfig` now carries only the scalar
 provider's card declares in `configSchema`, without password fields, undeclared keys, objects
 or arrays. The API version was not bumped for this change.
 
+Added within API 4: `ctx.settings.onChange(handler)`. When only the plugin's config changes (a
+settings card Save or `ctx.settings.write`), the host hands the new config to the handler, with
+passwords resolved, instead of restarting the plugin, and `ctx.config` returns the new value from
+then on. A plugin that registers no handler is restarted as before, and so is one whose handler
+throws or rejects. The call returns a function that removes the handler. The API version was not
+bumped.
+
+Added within API 4: `ctx.commands.dispatch()` returns the command's `result` when the command
+type defines one (for example the id of an object it created); replaying the same `commandId`
+returns the same value, and most commands have none. `ctx.commands.getReceipt()` also answers
+for declared commands that do not target an existing thread. Those command ids are scoped to
+your plugin's install, so you only see receipts for commands your plugin dispatched, and
+`threadId` may be left out for them; commands on an existing thread still need `threadId` and
+thread ownership. Both are optional additions, so the API version was not bumped.
+
+Added within API 4, for a plugin that draws its own settings in the `settings.section` seat. None
+of these bumped the API version.
+
+- `presentation: "hidden"` on `ctx.settingsCard`: clients stop drawing the card's form. Keep the
+  field declarations: a `kind: "proxy"` field is how the host knows which proxy you use, and
+  `password` fields and columns are how it knows which positions are secrets.
+- `clearSecrets` in the options of `ctx.settings.write`: paths whose stored password is removed.
+  The host drops the key at each path from the config it writes, whatever you put there. A path
+  listed in both `secrets` and `clearSecrets` rejects the write.
+- `bridge.ui.QRCodeSvg` and `bridge.ui.ProxyChoiceSelect`, typed by `QRCodeSvgProps` and
+  `ProxyChoiceSelectProps` in `@ycodium-ai/plugin-api/ui`. The proxy select draws the options you
+  pass it; get them from `ctx.proxies.list()` in a command of your own. An older host does not
+  have them, so check that they exist before rendering.
+
 ### API 3
 
 API 3 deletes the host's old usage path and fixes the executor contract that the built-in agents