docs: refresh whatsapp helper sdk refs

This commit is contained in:
Peter Steinberger
2026-04-04 20:36:30 +01:00
parent ba8eb4af38
commit 420f2191f5
4 changed files with 22 additions and 4 deletions

View File

@@ -1140,9 +1140,14 @@ authoring plugins:
- Facade-loaded public entry points prefer the active runtime config snapshot
when one exists, then fall back to the resolved config file on disk when
OpenClaw is not yet serving a runtime snapshot.
- No bundled channel-branded public subpaths remain. Channel-specific helper and
runtime seams live under `<plugin-package-root>/api.js` and `<plugin-package-root>/runtime-api.js`;
the public SDK contract is the generic shared primitives instead.
- Generic shared primitives remain the preferred public SDK contract. A small
reserved compatibility set of bundled channel-branded helper seams still
exists, including `plugin-sdk/whatsapp-surface` for narrow WhatsApp
auth/account, directory-config, group-policy, outbound-target, and web-media
helper exports. Treat those as bundled-maintenance/compatibility seams, not
new third-party import targets; new cross-channel contracts should still land
on generic `plugin-sdk/*` subpaths or the plugin-local `api.js` /
`runtime-api.js` barrels.
Compatibility note:

View File

@@ -493,6 +493,14 @@ Write colocated tests in `src/channel.test.ts`:
</Card>
</CardGroup>
<Note>
Reserved bundled-helper seams such as `plugin-sdk/whatsapp-surface` still
exist for bundled-plugin maintenance and compatibility. They are not the
recommended pattern for new channel plugins; prefer the generic channel/setup/
reply/runtime subpaths from the common SDK surface unless you are maintaining
that bundled plugin family directly.
</Note>
## Next steps
- [Provider Plugins](/plugins/sdk-provider-plugins) — if your plugin also provides models

View File

@@ -337,6 +337,11 @@ The same rule applies to other generated bundled-helper families such as:
surface `DEFAULT_COPILOT_API_BASE_URL`,
`deriveCopilotApiBaseUrlFromToken`, and `resolveCopilotApiToken`.
`plugin-sdk/whatsapp-surface` currently exposes `DEFAULT_WEB_MEDIA_BYTES`,
WhatsApp auth/account helpers, directory-config helpers, group-policy helpers,
outbound-target resolution, and the narrow `WebChannelStatus` /
`WebInboundMessage` / `WebListenerCloseReason` / `WebMonitorTuning` types.
For Qwen specifically, prefer the canonical `plugin-sdk/qwen` and
`plugin-sdk/qwen-definitions` seams. `plugin-sdk/modelstudio*` remains
exported as a compatibility alias for older plugin code.

View File

@@ -271,7 +271,7 @@ explicitly promotes one as public.
| 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/whatsapp-surface`, `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles`, `plugin-sdk/bluebubbles-policy`, `plugin-sdk/mattermost`, `plugin-sdk/mattermost-policy`, `plugin-sdk/feishu-conversation`, `plugin-sdk/msteams`, `plugin-sdk/nextcloud-talk`, `plugin-sdk/nostr`, `plugin-sdk/tlon`, `plugin-sdk/twitch` | Bundled channel compatibility/helper seams |
| Channel-specific helpers | `plugin-sdk/googlechat`, `plugin-sdk/whatsapp-surface`, `plugin-sdk/zalouser`, `plugin-sdk/bluebubbles`, `plugin-sdk/bluebubbles-policy`, `plugin-sdk/mattermost`, `plugin-sdk/mattermost-policy`, `plugin-sdk/feishu-conversation`, `plugin-sdk/msteams`, `plugin-sdk/nextcloud-talk`, `plugin-sdk/nostr`, `plugin-sdk/tlon`, `plugin-sdk/twitch` | Bundled channel compatibility/helper seams. `plugin-sdk/whatsapp-surface` currently exports `DEFAULT_WEB_MEDIA_BYTES`, WhatsApp auth/account helpers, directory-config helpers, group-policy helpers, outbound-target resolution, and the narrow `WebChannelStatus` / `WebInboundMessage` / `WebListenerCloseReason` / `WebMonitorTuning` types. |
| Provider-specific helpers | `plugin-sdk/openai`, `plugin-sdk/moonshot`, `plugin-sdk/qwen`, `plugin-sdk/qwen-definitions`, `plugin-sdk/modelstudio`, `plugin-sdk/modelstudio-definitions`, `plugin-sdk/provider-moonshot`, `plugin-sdk/together`, `plugin-sdk/amazon-bedrock`, `plugin-sdk/anthropic-vertex`, `plugin-sdk/cloudflare-ai-gateway`, `plugin-sdk/byteplus`, `plugin-sdk/chutes`, `plugin-sdk/deepseek`, `plugin-sdk/google`, `plugin-sdk/huggingface`, `plugin-sdk/kimi-coding`, `plugin-sdk/kilocode`, `plugin-sdk/minimax`, `plugin-sdk/mistral`, `plugin-sdk/nvidia`, `plugin-sdk/ollama`, `plugin-sdk/ollama-surface`, `plugin-sdk/opencode`, `plugin-sdk/opencode-go`, `plugin-sdk/qianfan`, `plugin-sdk/sglang`, `plugin-sdk/synthetic`, `plugin-sdk/venice`, `plugin-sdk/vllm`, `plugin-sdk/xai`, `plugin-sdk/volcengine` | Bundled provider-specific helper seams; prefer canonical `qwen*`, keep `modelstudio*` as compatibility aliases |
| Auth/plugin-specific helpers | `plugin-sdk/github-copilot-login`, `plugin-sdk/github-copilot-token`, `plugin-sdk/diagnostics-otel`, `plugin-sdk/diffs`, `plugin-sdk/llm-task`, `plugin-sdk/thread-ownership`, `plugin-sdk/voice-call` | Bundled feature/plugin helper seams; `plugin-sdk/github-copilot-token` currently exports `DEFAULT_COPILOT_API_BASE_URL`, `deriveCopilotApiBaseUrlFromToken`, and `resolveCopilotApiToken` |
</Accordion>