From dd030fb76139f5223dff387786177f5cb20c2c6b Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 13:04:01 +0100 Subject: [PATCH] docs: refresh sdk core runtime refs --- docs/plugins/sdk-migration.md | 21 +++++++++++++++++++++ docs/plugins/sdk-overview.md | 21 +++++++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/docs/plugins/sdk-migration.md b/docs/plugins/sdk-migration.md index 7658b16ed75..672ac42f0b8 100644 --- a/docs/plugins/sdk-migration.md +++ b/docs/plugins/sdk-migration.md @@ -184,12 +184,22 @@ Current bundled provider examples: | `plugin-sdk/channel-runtime` | Deprecated compatibility shim | Legacy channel runtime utilities only | | `plugin-sdk/channel-send-result` | Send result types | Reply result types | | `plugin-sdk/runtime-store` | Persistent plugin storage | `createPluginRuntimeStore` | + | `plugin-sdk/runtime` | Broad runtime helpers | Runtime/logging/backup/plugin-install helpers | + | `plugin-sdk/runtime-env` | Narrow runtime env helpers | Logger/runtime env, timeout, retry, and backoff helpers | + | `plugin-sdk/plugin-runtime` | Shared plugin runtime helpers | Plugin commands/hooks/http/interactive helpers | + | `plugin-sdk/hook-runtime` | Hook pipeline helpers | Shared webhook/internal hook pipeline helpers | + | `plugin-sdk/process-runtime` | Process helpers | Shared exec helpers | + | `plugin-sdk/cli-runtime` | CLI runtime helpers | Command formatting, waits, version helpers | + | `plugin-sdk/gateway-runtime` | Gateway helpers | Gateway client and channel-status patch helpers | | `plugin-sdk/approval-runtime` | Approval prompt helpers | Exec/plugin approval payload, approval capability/profile helpers, native approval routing/runtime helpers | | `plugin-sdk/approval-auth-runtime` | Approval auth helpers | Approver resolution, same-chat action auth | | `plugin-sdk/approval-client-runtime` | Approval client helpers | Native exec approval profile/filter helpers | | `plugin-sdk/approval-delivery-runtime` | Approval delivery helpers | Native approval capability/delivery adapters | | `plugin-sdk/approval-native-runtime` | Approval target helpers | Native approval target/account binding helpers | | `plugin-sdk/approval-reply-runtime` | Approval reply helpers | Exec/plugin approval reply payload helpers | + | `plugin-sdk/security-runtime` | Security helpers | Shared trust, DM gating, external-content, and secret-collection helpers | + | `plugin-sdk/ssrf-policy` | SSRF policy helpers | Host allowlist and private-network policy helpers | + | `plugin-sdk/ssrf-runtime` | SSRF runtime helpers | Pinned-dispatcher, guarded fetch, SSRF policy helpers | | `plugin-sdk/collection-runtime` | Bounded cache helpers | `pruneMapToMaxSize` | | `plugin-sdk/diagnostic-runtime` | Diagnostic gating helpers | `isDiagnosticFlagEnabled`, `isDiagnosticsEnabled` | | `plugin-sdk/error-runtime` | Error formatting helpers | `formatUncaughtError`, error graph helpers | @@ -206,6 +216,17 @@ Current bundled provider examples: | `plugin-sdk/reply-dispatch-runtime` | Narrow reply dispatch helpers | Finalize + provider dispatch helpers | | `plugin-sdk/reply-reference` | Reply reference planning | `createReplyReferencePlanner` | | `plugin-sdk/reply-chunking` | Reply chunk helpers | Text/markdown chunking helpers | + | `plugin-sdk/session-store-runtime` | Session store helpers | Store path + updated-at helpers | + | `plugin-sdk/state-paths` | State path helpers | State and OAuth dir helpers | + | `plugin-sdk/target-resolver-runtime` | Target resolver helpers | Shared target resolver helpers | + | `plugin-sdk/string-normalization-runtime` | String normalization helpers | Slug/string normalization helpers | + | `plugin-sdk/request-url` | Request URL helpers | Extract string URLs from request-like inputs | + | `plugin-sdk/run-command` | Timed command helpers | Timed command runner with normalized stdout/stderr | + | `plugin-sdk/param-readers` | Param readers | Common tool/CLI param readers | + | `plugin-sdk/tool-send` | Tool send extraction | Extract canonical send target fields from tool args | + | `plugin-sdk/temp-path` | Temp path helpers | Shared temp-download path helpers | + | `plugin-sdk/logging-core` | Logging helpers | Subsystem logger and redaction helpers | + | `plugin-sdk/markdown-table-runtime` | Markdown-table helpers | Markdown table mode helpers | | `plugin-sdk/reply-payload` | Message reply types | Reply payload types | | `plugin-sdk/provider-setup` | Curated local/self-hosted provider setup helpers | Self-hosted provider discovery/config helpers | | `plugin-sdk/self-hosted-provider-setup` | Focused OpenAI-compatible self-hosted provider setup helpers | Same self-hosted provider discovery/config helpers | diff --git a/docs/plugins/sdk-overview.md b/docs/plugins/sdk-overview.md index 66f170698e9..4079e5050e8 100644 --- a/docs/plugins/sdk-overview.md +++ b/docs/plugins/sdk-overview.md @@ -128,6 +128,9 @@ explicitly promotes one as public. | `plugin-sdk/approval-native-runtime` | Native approval target + account-binding helpers | | `plugin-sdk/approval-reply-runtime` | Exec/plugin approval reply payload helpers | | `plugin-sdk/allow-from` | `formatAllowFromLowercase` | + | `plugin-sdk/security-runtime` | Shared trust, DM gating, external-content, and secret-collection helpers | + | `plugin-sdk/ssrf-policy` | Host allowlist and private-network SSRF policy helpers | + | `plugin-sdk/ssrf-runtime` | Pinned-dispatcher, SSRF-guarded fetch, and SSRF policy helpers | | `plugin-sdk/secret-input` | Secret input parsing helpers | | `plugin-sdk/webhook-ingress` | Webhook request/target helpers | | `plugin-sdk/webhook-request-guards` | Request body size/timeout helpers | @@ -136,13 +139,31 @@ explicitly promotes one as public. | Subpath | Key exports | | --- | --- | + | `plugin-sdk/runtime` | Broad runtime/logging/backup/plugin-install helpers | + | `plugin-sdk/runtime-env` | Narrow runtime env, logger, timeout, retry, and backoff helpers | | `plugin-sdk/runtime-store` | `createPluginRuntimeStore` | + | `plugin-sdk/plugin-runtime` | Shared plugin command/hook/http/interactive helpers | + | `plugin-sdk/hook-runtime` | Shared webhook/internal hook pipeline helpers | + | `plugin-sdk/process-runtime` | Process exec helpers | + | `plugin-sdk/cli-runtime` | CLI formatting, wait, and version helpers | + | `plugin-sdk/gateway-runtime` | Gateway client and channel-status patch helpers | | `plugin-sdk/config-runtime` | Config load/write helpers | | `plugin-sdk/approval-runtime` | Exec/plugin approval helpers, approval-capability builders, auth/profile helpers, native routing/runtime helpers | | `plugin-sdk/reply-runtime` | Shared inbound/reply runtime helpers, chunking, dispatch, heartbeat, reply planner | | `plugin-sdk/reply-dispatch-runtime` | Narrow reply dispatch/finalize helpers | | `plugin-sdk/reply-reference` | `createReplyReferencePlanner` | | `plugin-sdk/reply-chunking` | Narrow text/markdown chunking helpers | + | `plugin-sdk/session-store-runtime` | Session store path + updated-at helpers | + | `plugin-sdk/state-paths` | State/OAuth dir path helpers | + | `plugin-sdk/target-resolver-runtime` | Shared target resolver helpers | + | `plugin-sdk/string-normalization-runtime` | Slug/string normalization helpers | + | `plugin-sdk/request-url` | Extract string URLs from fetch/request-like inputs | + | `plugin-sdk/run-command` | Timed command runner with normalized stdout/stderr results | + | `plugin-sdk/param-readers` | Common tool/CLI param readers | + | `plugin-sdk/tool-send` | Extract canonical send target fields from tool args | + | `plugin-sdk/temp-path` | Shared temp-download path helpers | + | `plugin-sdk/logging-core` | Subsystem logger and redaction helpers | + | `plugin-sdk/markdown-table-runtime` | Markdown table mode helpers | | `plugin-sdk/infra-runtime` | System event/heartbeat helpers | | `plugin-sdk/collection-runtime` | Small bounded cache helpers | | `plugin-sdk/diagnostic-runtime` | Diagnostic flag and event helpers |