diff --git a/docs/plugins/sdk-migration.md b/docs/plugins/sdk-migration.md index e6faf27cfa2..9753e62babc 100644 --- a/docs/plugins/sdk-migration.md +++ b/docs/plugins/sdk-migration.md @@ -290,6 +290,19 @@ bundled-plugin maintenance and compatibility, but they are intentionally omitted from the common migration table and are not the recommended target for new plugin code. +The same rule applies to other generated bundled-helper families such as: + +- browser: `plugin-sdk/browser*` +- Matrix: `plugin-sdk/matrix*` +- LINE: `plugin-sdk/line*` +- IRC: `plugin-sdk/irc*` +- bundled helper/plugin surfaces like `plugin-sdk/googlechat`, + `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles*`, + `plugin-sdk/mattermost*`, `plugin-sdk/openai`, `plugin-sdk/moonshot`, + `plugin-sdk/modelstudio*`, `plugin-sdk/provider-moonshot`, + `plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`, + `plugin-sdk/thread-ownership`, and `plugin-sdk/voice-call` + Use the narrowest import that matches the job. If you cannot find an export, check the source at `src/plugin-sdk/` or ask in Discord. diff --git a/docs/plugins/sdk-overview.md b/docs/plugins/sdk-overview.md index a8eff2a698d..3537a1ffd7d 100644 --- a/docs/plugins/sdk-overview.md +++ b/docs/plugins/sdk-overview.md @@ -251,6 +251,18 @@ explicitly promotes one as public. | `plugin-sdk/memory-core-host-runtime-files` | Memory host file/runtime helpers | | `plugin-sdk/memory-lancedb` | Bundled memory-lancedb helper surface | + + + | Family | Current generated subpaths | Intended use | + | --- | --- | --- | + | Browser | `plugin-sdk/browser`, `plugin-sdk/browser-runtime`, `plugin-sdk/browser-config-support`, `plugin-sdk/browser-support` | Bundled browser plugin maintenance and compatibility | + | Matrix | `plugin-sdk/matrix`, `plugin-sdk/matrix-helper`, `plugin-sdk/matrix-runtime-heavy`, `plugin-sdk/matrix-runtime-shared`, `plugin-sdk/matrix-runtime-surface`, `plugin-sdk/matrix-surface`, `plugin-sdk/matrix-thread-bindings` | Bundled Matrix helper/runtime surface | + | Line | `plugin-sdk/line`, `plugin-sdk/line-core`, `plugin-sdk/line-runtime`, `plugin-sdk/line-surface` | Bundled LINE helper/runtime surface | + | IRC | `plugin-sdk/irc`, `plugin-sdk/irc-surface` | Bundled IRC helper surface | + | Channel-specific helpers | `plugin-sdk/googlechat`, `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles`, `plugin-sdk/bluebubbles-policy`, `plugin-sdk/mattermost`, `plugin-sdk/mattermost-policy`, `plugin-sdk/feishu-conversation` | Bundled channel compatibility/helper seams | + | Provider-specific helpers | `plugin-sdk/openai`, `plugin-sdk/moonshot`, `plugin-sdk/modelstudio`, `plugin-sdk/modelstudio-definitions`, `plugin-sdk/provider-moonshot`, `plugin-sdk/together`, `plugin-sdk/amazon-bedrock`, `plugin-sdk/anthropic-vertex` | Bundled provider-specific helper seams | + | Plugin-specific helpers | `plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`, `plugin-sdk/thread-ownership`, `plugin-sdk/voice-call` | Bundled feature/plugin helper seams | + ## Registration API