From f4fa84aea7ae4570a81cda6d12af94fe8dbd46c8 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:13:38 -0700 Subject: [PATCH 001/187] feat(plugins): tighten media runtime integration --- .../discord/src/voice/manager.e2e.test.ts | 32 ++-------- extensions/discord/src/voice/manager.ts | 42 +++----------- extensions/whatsapp/src/setup-surface.ts | 1 + extensions/zalo/src/channel.runtime.ts | 4 +- src/plugins/contracts/registry.ts | 58 +++++++++---------- src/plugins/registry.ts | 33 +++-------- src/plugins/runtime/index.test.ts | 8 +++ vitest.e2e.config.ts | 2 +- 8 files changed, 63 insertions(+), 117 deletions(-) diff --git a/extensions/discord/src/voice/manager.e2e.test.ts b/extensions/discord/src/voice/manager.e2e.test.ts index 17d21ff7414..73c6f249021 100644 --- a/extensions/discord/src/voice/manager.e2e.test.ts +++ b/extensions/discord/src/voice/manager.e2e.test.ts @@ -8,10 +8,7 @@ const { createAudioPlayerMock, resolveAgentRouteMock, agentCommandMock, - buildProviderRegistryMock, - createMediaAttachmentCacheMock, - normalizeMediaAttachmentsMock, - runCapabilityMock, + transcribeAudioFileMock, } = vi.hoisted(() => { type EventHandler = (...args: unknown[]) => unknown; type MockConnection = { @@ -68,14 +65,7 @@ const { })), resolveAgentRouteMock: vi.fn(() => ({ agentId: "agent-1", sessionKey: "discord:g1:c1" })), agentCommandMock: vi.fn(async (_opts?: unknown, _runtime?: unknown) => ({ payloads: [] })), - buildProviderRegistryMock: vi.fn(() => ({})), - createMediaAttachmentCacheMock: vi.fn(() => ({ - cleanup: vi.fn(async () => undefined), - })), - normalizeMediaAttachmentsMock: vi.fn(() => [{ kind: "audio", path: "/tmp/test.wav" }]), - runCapabilityMock: vi.fn(async () => ({ - outputs: [{ kind: "audio.transcription", text: "hello from voice" }], - })), + transcribeAudioFileMock: vi.fn(async () => ({ text: "hello from voice" })), }; }); @@ -103,11 +93,8 @@ vi.mock("../../../../src/commands/agent.js", () => ({ agentCommandFromIngress: agentCommandMock, })); -vi.mock("../../../../src/media-understanding/runner.js", () => ({ - buildProviderRegistry: buildProviderRegistryMock, - createMediaAttachmentCache: createMediaAttachmentCacheMock, - normalizeMediaAttachments: normalizeMediaAttachmentsMock, - runCapability: runCapabilityMock, +vi.mock("../../../../src/media-understanding/runtime.js", () => ({ + transcribeAudioFile: transcribeAudioFileMock, })); let managerModule: typeof import("./manager.js"); @@ -149,15 +136,8 @@ describe("DiscordVoiceManager", () => { resolveAgentRouteMock.mockClear(); agentCommandMock.mockReset(); agentCommandMock.mockResolvedValue({ payloads: [] }); - buildProviderRegistryMock.mockReset(); - buildProviderRegistryMock.mockReturnValue({}); - createMediaAttachmentCacheMock.mockClear(); - normalizeMediaAttachmentsMock.mockReset(); - normalizeMediaAttachmentsMock.mockReturnValue([{ kind: "audio", path: "/tmp/test.wav" }]); - runCapabilityMock.mockReset(); - runCapabilityMock.mockResolvedValue({ - outputs: [{ kind: "audio.transcription", text: "hello from voice" }], - }); + transcribeAudioFileMock.mockReset(); + transcribeAudioFileMock.mockResolvedValue({ text: "hello from voice" }); }); const createManager = ( diff --git a/extensions/discord/src/voice/manager.ts b/extensions/discord/src/voice/manager.ts index 90c6c3bb1e6..a9f8d0fd721 100644 --- a/extensions/discord/src/voice/manager.ts +++ b/extensions/discord/src/voice/manager.ts @@ -17,7 +17,6 @@ import { type VoiceConnection, } from "@discordjs/voice"; import { resolveAgentDir } from "../../../../src/agents/agent-scope.js"; -import type { MsgContext } from "../../../../src/auto-reply/templating.js"; import { agentCommandFromIngress } from "../../../../src/commands/agent.js"; import type { OpenClawConfig } from "../../../../src/config/config.js"; import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; @@ -26,12 +25,7 @@ import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; import { formatErrorMessage } from "../../../../src/infra/errors.js"; import { resolvePreferredOpenClawTmpDir } from "../../../../src/infra/tmp-openclaw-dir.js"; import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { - buildProviderRegistry, - createMediaAttachmentCache, - normalizeMediaAttachments, - runCapability, -} from "../../../../src/media-understanding/runner.js"; +import { transcribeAudioFile } from "../../../../src/media-understanding/runtime.js"; import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; import type { RuntimeEnv } from "../../../../src/runtime.js"; import { parseTtsDirectives } from "../../../../src/tts/tts-core.js"; @@ -236,33 +230,13 @@ async function transcribeAudio(params: { agentId: string; filePath: string; }): Promise { - const ctx: MsgContext = { - MediaPath: params.filePath, - MediaType: "audio/wav", - }; - const attachments = normalizeMediaAttachments(ctx); - if (attachments.length === 0) { - return undefined; - } - const cache = createMediaAttachmentCache(attachments); - const providerRegistry = buildProviderRegistry(); - try { - const result = await runCapability({ - capability: "audio", - cfg: params.cfg, - ctx, - attachments: cache, - media: attachments, - agentDir: resolveAgentDir(params.cfg, params.agentId), - providerRegistry, - config: params.cfg.tools?.media?.audio, - }); - const output = result.outputs.find((entry) => entry.kind === "audio.transcription"); - const text = output?.text?.trim(); - return text || undefined; - } finally { - await cache.cleanup(); - } + const result = await transcribeAudioFile({ + cfg: params.cfg, + filePath: params.filePath, + mime: "audio/wav", + agentDir: resolveAgentDir(params.cfg, params.agentId), + }); + return result.text?.trim() || undefined; } export class DiscordVoiceManager { diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index 50a28d419cb..47e84de6860 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -9,6 +9,7 @@ import { pathExists, splitSetupEntries, setSetupChannelEnabled, + type DmPolicy, type OpenClawConfig, } from "../../../src/plugin-sdk-internal/setup.js"; import type { ChannelSetupWizard } from "../../../src/plugin-sdk-internal/setup.js"; diff --git a/extensions/zalo/src/channel.runtime.ts b/extensions/zalo/src/channel.runtime.ts index fc4488b5be8..a376d52b94e 100644 --- a/extensions/zalo/src/channel.runtime.ts +++ b/extensions/zalo/src/channel.runtime.ts @@ -41,7 +41,9 @@ export async function probeZaloAccount(params: { export async function startZaloGatewayAccount( ctx: Parameters< - NonNullable["startAccount"] + NonNullable< + NonNullable["startAccount"] + > >[0], ) { const account = ctx.account; diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index 14dbb17262c..3c5cc8935c9 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -47,26 +47,20 @@ type RegistrablePlugin = { register: (api: ReturnType["api"]) => void; }; -type ProviderContractEntry = { +type CapabilityContractEntry = { pluginId: string; - provider: ProviderPlugin; + provider: T; }; -type WebSearchProviderContractEntry = { - pluginId: string; - provider: WebSearchProviderPlugin; +type ProviderContractEntry = CapabilityContractEntry; + +type WebSearchProviderContractEntry = CapabilityContractEntry & { credentialValue: unknown; }; -type SpeechProviderContractEntry = { - pluginId: string; - provider: SpeechProviderPlugin; -}; - -type MediaUnderstandingProviderContractEntry = { - pluginId: string; - provider: MediaUnderstandingProviderPlugin; -}; +type SpeechProviderContractEntry = CapabilityContractEntry; +type MediaUnderstandingProviderContractEntry = + CapabilityContractEntry; type PluginRegistrationContractEntry = { pluginId: string; @@ -138,15 +132,23 @@ function captureRegistrations(plugin: RegistrablePlugin) { return captured; } -export const providerContractRegistry: ProviderContractEntry[] = bundledProviderPlugins.flatMap( - (plugin) => { +function buildCapabilityContractRegistry(params: { + plugins: RegistrablePlugin[]; + select: (captured: ReturnType) => T[]; +}): CapabilityContractEntry[] { + return params.plugins.flatMap((plugin) => { const captured = captureRegistrations(plugin); - return captured.providers.map((provider) => ({ + return params.select(captured).map((provider) => ({ pluginId: plugin.id, provider, })); - }, -); + }); +} + +export const providerContractRegistry: ProviderContractEntry[] = buildCapabilityContractRegistry({ + plugins: bundledProviderPlugins, + select: (captured) => captured.providers, +}); export const webSearchProviderContractRegistry: WebSearchProviderContractEntry[] = bundledWebSearchPlugins.flatMap((plugin) => { @@ -159,21 +161,15 @@ export const webSearchProviderContractRegistry: WebSearchProviderContractEntry[] }); export const speechProviderContractRegistry: SpeechProviderContractEntry[] = - bundledSpeechPlugins.flatMap((plugin) => { - const captured = captureRegistrations(plugin); - return captured.speechProviders.map((provider) => ({ - pluginId: plugin.id, - provider, - })); + buildCapabilityContractRegistry({ + plugins: bundledSpeechPlugins, + select: (captured) => captured.speechProviders, }); export const mediaUnderstandingProviderContractRegistry: MediaUnderstandingProviderContractEntry[] = - bundledMediaUnderstandingPlugins.flatMap((plugin) => { - const captured = captureRegistrations(plugin); - return captured.mediaUnderstandingProviders.map((provider) => ({ - pluginId: plugin.id, - provider, - })); + buildCapabilityContractRegistry({ + plugins: bundledMediaUnderstandingPlugins, + select: (captured) => captured.mediaUnderstandingProviders, }); const bundledPluginRegistrationList = [ diff --git a/src/plugins/registry.ts b/src/plugins/registry.ts index 6ec51d889fc..c81c2253e0a 100644 --- a/src/plugins/registry.ts +++ b/src/plugins/registry.ts @@ -104,29 +104,20 @@ export type PluginProviderRegistration = { rootDir?: string; }; -export type PluginWebSearchProviderRegistration = { +type PluginOwnedProviderRegistration = { pluginId: string; pluginName?: string; - provider: WebSearchProviderPlugin; + provider: T; source: string; rootDir?: string; }; -export type PluginSpeechProviderRegistration = { - pluginId: string; - pluginName?: string; - provider: SpeechProviderPlugin; - source: string; - rootDir?: string; -}; - -export type PluginMediaUnderstandingProviderRegistration = { - pluginId: string; - pluginName?: string; - provider: MediaUnderstandingProviderPlugin; - source: string; - rootDir?: string; -}; +export type PluginSpeechProviderRegistration = + PluginOwnedProviderRegistration; +export type PluginMediaUnderstandingProviderRegistration = + PluginOwnedProviderRegistration; +export type PluginWebSearchProviderRegistration = + PluginOwnedProviderRegistration; export type PluginHookRegistration = { pluginId: string; @@ -576,13 +567,7 @@ export function createPluginRegistry(registryParams: PluginRegistryParams) { const registerUniqueProviderLike = < T extends { id: string }, - R extends { - pluginId: string; - pluginName?: string; - provider: T; - source: string; - rootDir?: string; - }, + R extends PluginOwnedProviderRegistration, >(params: { record: PluginRecord; provider: T; diff --git a/src/plugins/runtime/index.test.ts b/src/plugins/runtime/index.test.ts index dfca1cfaf4a..9f7613881a5 100644 --- a/src/plugins/runtime/index.test.ts +++ b/src/plugins/runtime/index.test.ts @@ -55,6 +55,14 @@ describe("plugin runtime command execution", () => { expect(runtime.events.onSessionTranscriptUpdate).toBe(onSessionTranscriptUpdate); }); + it("exposes runtime.mediaUnderstanding helpers and keeps stt as an alias", () => { + const runtime = createPluginRuntime(); + expect(typeof runtime.mediaUnderstanding.runFile).toBe("function"); + expect(typeof runtime.mediaUnderstanding.describeImageFile).toBe("function"); + expect(typeof runtime.mediaUnderstanding.describeVideoFile).toBe("function"); + expect(runtime.mediaUnderstanding.transcribeAudioFile).toBe(runtime.stt.transcribeAudioFile); + }); + it("exposes runtime.system.requestHeartbeatNow", () => { const runtime = createPluginRuntime(); expect(runtime.system.requestHeartbeatNow).toBe(requestHeartbeatNow); diff --git a/vitest.e2e.config.ts b/vitest.e2e.config.ts index b70d8c8eedb..67e7cada10e 100644 --- a/vitest.e2e.config.ts +++ b/vitest.e2e.config.ts @@ -26,7 +26,7 @@ export default defineConfig({ pool: "forks", maxWorkers: e2eWorkers, silent: !verboseE2E, - include: ["test/**/*.e2e.test.ts", "src/**/*.e2e.test.ts"], + include: ["test/**/*.e2e.test.ts", "src/**/*.e2e.test.ts", "extensions/**/*.e2e.test.ts"], exclude, }, }); From afc0172cb1d8837755d4d642752775ac83668263 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:13:46 -0700 Subject: [PATCH 002/187] docs(plugins): add capability checklist template --- docs/tools/plugin.md | 59 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index c1dc9398f5c..0e9e831023c 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -1386,6 +1386,65 @@ Recommended sequence: This is how OpenClaw stays opinionated without becoming hardcoded to one provider's worldview. +### Capability checklist + +When you add a new capability, the implementation should usually touch these +surfaces together: + +- core contract types in `src//types.ts` +- core runner/runtime helper in `src//runtime.ts` +- plugin API registration surface in `src/plugins/types.ts` +- plugin registry wiring in `src/plugins/registry.ts` +- plugin runtime exposure in `src/plugins/runtime/*` when feature/channel + plugins need to consume it +- capture/test helpers in `src/test-utils/plugin-registration.ts` +- ownership/contract assertions in `src/plugins/contracts/registry.ts` +- operator/plugin docs in `docs/` + +If one of those surfaces is missing, that is usually a sign the capability is +not fully integrated yet. + +### Capability template + +Minimal pattern: + +```ts +// core contract +export type VideoGenerationProviderPlugin = { + id: string; + label: string; + generateVideo: (req: VideoGenerationRequest) => Promise; +}; + +// plugin API +api.registerVideoGenerationProvider({ + id: "openai", + label: "OpenAI", + async generateVideo(req) { + return await generateOpenAiVideo(req); + }, +}); + +// shared runtime helper for feature/channel plugins +const clip = await api.runtime.videoGeneration.generateFile({ + prompt: "Show the robot walking through the lab.", + cfg, +}); +``` + +Contract test pattern: + +```ts +expect(findVideoGenerationProviderIdsForPlugin("openai")).toEqual(["openai"]); +``` + +That keeps the rule simple: + +- core owns the capability contract + orchestration +- vendor plugins own vendor implementations +- feature/channel plugins consume runtime helpers +- contract tests keep ownership explicit + Context engine plugins can also register a runtime-owned context manager: ```ts From 9ebe38b6e36b6128b194e17892e95920cafee42b Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:13:56 -0700 Subject: [PATCH 003/187] refactor: untangle remaining plugin sdk boundaries --- .../acpx/src/test-utils/runtime-fixtures.ts | 2 +- extensions/anthropic/index.ts | 34 +- extensions/brave/index.ts | 5 +- extensions/byteplus/index.ts | 26 +- extensions/byteplus/provider-catalog.ts | 4 +- extensions/cloudflare-ai-gateway/index.ts | 29 +- extensions/cloudflare-ai-gateway/onboard.ts | 6 +- extensions/discord/src/account-inspect.ts | 4 +- extensions/discord/src/accounts.ts | 6 +- .../src/actions/handle-action.guild-admin.ts | 8 +- .../discord/src/actions/handle-action.ts | 14 +- extensions/discord/src/api.ts | 8 +- extensions/discord/src/audit.ts | 9 +- extensions/discord/src/channel-actions.ts | 6 +- extensions/discord/src/channel.setup.ts | 45 ++- extensions/discord/src/channel.ts | 64 +++- extensions/discord/src/chunk.ts | 2 +- extensions/discord/src/client.ts | 8 +- extensions/discord/src/directory-cache.ts | 2 +- extensions/discord/src/directory-live.ts | 4 +- extensions/discord/src/draft-chunking.ts | 8 +- extensions/discord/src/draft-stream.ts | 2 +- extensions/discord/src/exec-approvals.ts | 6 +- extensions/discord/src/gateway-logging.ts | 4 +- .../src/monitor.tool-result.test-harness.ts | 12 +- .../discord/src/monitor/agent-components.ts | 56 +-- extensions/discord/src/monitor/allow-list.ts | 6 +- .../discord/src/monitor/auto-presence.ts | 6 +- extensions/discord/src/monitor/commands.ts | 2 +- .../discord/src/monitor/dm-command-auth.ts | 4 +- .../src/monitor/dm-command-decision.ts | 4 +- .../discord/src/monitor/exec-approvals.ts | 34 +- .../discord/src/monitor/gateway-plugin.ts | 8 +- .../discord/src/monitor/inbound-context.ts | 2 +- .../discord/src/monitor/inbound-worker.ts | 6 +- extensions/discord/src/monitor/listeners.ts | 22 +- .../message-handler.module-test-helpers.ts | 2 +- .../message-handler.preflight.test-helpers.ts | 4 +- .../src/monitor/message-handler.preflight.ts | 49 ++- .../message-handler.preflight.types.ts | 16 +- .../src/monitor/message-handler.process.ts | 64 ++-- .../monitor/message-handler.test-helpers.ts | 2 +- .../discord/src/monitor/message-handler.ts | 6 +- .../discord/src/monitor/message-utils.ts | 10 +- .../src/monitor/model-picker-preferences.ts | 8 +- .../src/monitor/model-picker.test-utils.ts | 2 +- .../discord/src/monitor/model-picker.ts | 6 +- .../src/monitor/native-command-context.ts | 4 +- .../discord/src/monitor/native-command.ts | 46 +-- .../discord/src/monitor/preflight-audio.ts | 7 +- extensions/discord/src/monitor/presence.ts | 2 +- .../discord/src/monitor/provider.allowlist.ts | 10 +- .../discord/src/monitor/provider.lifecycle.ts | 8 +- extensions/discord/src/monitor/provider.ts | 46 +-- .../discord/src/monitor/reply-delivery.ts | 22 +- extensions/discord/src/monitor/rest-fetch.ts | 6 +- .../discord/src/monitor/route-resolution.ts | 6 +- .../src/monitor/thread-bindings.config.ts | 6 +- .../monitor/thread-bindings.discord-api.ts | 4 +- .../src/monitor/thread-bindings.lifecycle.ts | 9 +- .../src/monitor/thread-bindings.manager.ts | 13 +- .../src/monitor/thread-bindings.messages.ts | 2 +- .../src/monitor/thread-bindings.persona.ts | 2 +- .../src/monitor/thread-bindings.state.ts | 9 +- .../src/monitor/thread-session-close.ts | 4 +- extensions/discord/src/monitor/threading.ts | 10 +- extensions/discord/src/outbound-adapter.ts | 10 +- extensions/discord/src/plugin-shared.ts | 6 +- extensions/discord/src/pluralkit.ts | 2 +- extensions/discord/src/probe.ts | 6 +- extensions/discord/src/runtime.ts | 6 +- extensions/discord/src/send.components.ts | 4 +- extensions/discord/src/send.outbound.ts | 22 +- extensions/discord/src/send.reactions.ts | 2 +- extensions/discord/src/send.shared.ts | 10 +- extensions/discord/src/send.test-harness.ts | 2 +- extensions/discord/src/send.types.ts | 4 +- .../discord/src/session-key-normalization.ts | 4 +- extensions/discord/src/setup-core.ts | 214 ++++++----- extensions/discord/src/setup-surface.ts | 257 +++++++++---- extensions/discord/src/shared-interactive.ts | 4 +- extensions/discord/src/status-issues.ts | 4 +- extensions/discord/src/subagent-hooks.ts | 2 +- extensions/discord/src/targets.ts | 4 +- extensions/discord/src/token.ts | 8 +- extensions/discord/src/ui.ts | 2 +- extensions/discord/src/voice-message.ts | 10 +- extensions/discord/src/voice/command.ts | 8 +- extensions/discord/src/voice/manager.ts | 72 ++-- extensions/elevenlabs/index.ts | 2 +- extensions/feishu/src/bot.ts | 14 +- extensions/feishu/src/media.ts | 2 +- extensions/feishu/src/thread-bindings.ts | 15 +- extensions/firecrawl/index.ts | 8 +- extensions/firecrawl/src/config.ts | 6 +- extensions/firecrawl/src/firecrawl-client.ts | 10 +- .../firecrawl/src/firecrawl-scrape-tool.ts | 6 +- .../src/firecrawl-search-provider.ts | 2 +- .../firecrawl/src/firecrawl-search-tool.ts | 4 +- extensions/github-copilot/index.ts | 12 +- extensions/github-copilot/token.ts | 4 +- extensions/github-copilot/usage.ts | 8 +- extensions/google/gemini-cli-provider.ts | 4 +- extensions/google/index.ts | 15 +- extensions/google/oauth.flow.ts | 2 +- extensions/google/oauth.http.ts | 2 +- extensions/google/provider-models.ts | 4 +- extensions/huggingface/index.ts | 2 +- extensions/huggingface/onboard.ts | 6 +- extensions/huggingface/provider-catalog.ts | 4 +- extensions/imessage/src/accounts.ts | 6 +- extensions/imessage/src/channel.setup.ts | 99 ++++- extensions/imessage/src/channel.ts | 99 ++++- extensions/imessage/src/client.ts | 4 +- extensions/imessage/src/monitor/deliver.ts | 12 +- .../src/monitor/inbound-processing.ts | 35 +- .../imessage/src/monitor/monitor-provider.ts | 52 +-- .../imessage/src/monitor/reflection-guard.ts | 2 +- extensions/imessage/src/monitor/runtime.ts | 4 +- .../imessage/src/monitor/sanitize-outbound.ts | 2 +- extensions/imessage/src/monitor/types.ts | 4 +- extensions/imessage/src/outbound-adapter.ts | 7 +- extensions/imessage/src/plugin-shared.ts | 2 +- extensions/imessage/src/probe.ts | 10 +- extensions/imessage/src/runtime.ts | 6 +- extensions/imessage/src/send.ts | 10 +- extensions/imessage/src/setup-core.ts | 119 ++++--- extensions/imessage/src/setup-surface.ts | 151 ++++++-- .../imessage/src/target-parsing-helpers.ts | 2 +- extensions/imessage/src/targets.ts | 2 +- extensions/irc/src/setup-core.ts | 18 +- extensions/irc/src/setup-surface.ts | 17 +- extensions/kilocode/index.ts | 4 +- extensions/kilocode/onboard.ts | 9 +- extensions/kilocode/provider-catalog.ts | 6 +- extensions/kimi-coding/index.ts | 75 ++-- extensions/kimi-coding/onboard.ts | 40 +-- extensions/kimi-coding/provider-catalog.ts | 2 +- extensions/line/src/channel.setup.ts | 2 +- extensions/line/src/setup-core.ts | 9 +- extensions/line/src/setup-surface.ts | 12 +- extensions/matrix/src/outbound.ts | 2 +- extensions/mattermost/src/setup-core.ts | 52 ++- extensions/mattermost/src/setup-surface.ts | 4 +- extensions/microsoft/index.ts | 2 +- extensions/minimax/index.ts | 15 +- extensions/minimax/onboard.ts | 14 +- extensions/minimax/provider-catalog.ts | 5 +- extensions/mistral/index.ts | 4 +- extensions/mistral/onboard.ts | 15 +- extensions/modelstudio/index.ts | 26 +- extensions/modelstudio/onboard.ts | 12 +- extensions/modelstudio/provider-catalog.ts | 5 +- extensions/moonshot/index.ts | 51 +-- extensions/moonshot/onboard.ts | 4 +- extensions/moonshot/provider-catalog.ts | 2 +- extensions/msteams/src/outbound.ts | 2 +- extensions/nextcloud-talk/src/setup-core.ts | 34 +- .../nextcloud-talk/src/setup-surface.ts | 105 +++++- extensions/nostr/src/setup-surface.ts | 18 +- extensions/nvidia/provider-catalog.ts | 2 +- extensions/ollama/index.ts | 3 +- extensions/openai/index.ts | 4 +- extensions/openai/openai-codex-catalog.ts | 2 +- extensions/openai/openai-codex-provider.ts | 24 +- extensions/openai/openai-provider.ts | 10 +- extensions/openai/shared.ts | 21 +- extensions/opencode-go/index.ts | 4 +- extensions/opencode-go/onboard.ts | 8 +- extensions/opencode/index.ts | 4 +- extensions/opencode/onboard.ts | 8 +- extensions/openrouter/index.ts | 8 +- extensions/openrouter/onboard.ts | 6 +- extensions/openrouter/provider-catalog.ts | 2 +- extensions/perplexity/index.ts | 5 +- extensions/qianfan/index.ts | 2 +- extensions/qianfan/onboard.ts | 6 +- extensions/qianfan/provider-catalog.ts | 2 +- extensions/qwen-portal-auth/index.ts | 6 +- .../qwen-portal-auth/provider-catalog.ts | 5 +- extensions/sglang/index.ts | 12 +- extensions/signal/src/accounts.ts | 6 +- extensions/signal/src/channel.setup.ts | 95 ++++- extensions/signal/src/channel.ts | 95 ++++- extensions/signal/src/client.ts | 6 +- extensions/signal/src/daemon.ts | 2 +- extensions/signal/src/format.ts | 4 +- extensions/signal/src/identity.ts | 4 +- .../src/monitor.tool-result.test-harness.ts | 20 +- extensions/signal/src/monitor.ts | 37 +- .../signal/src/monitor/access-policy.ts | 6 +- .../signal/src/monitor/event-handler.ts | 57 ++- .../signal/src/monitor/event-handler.types.ts | 10 +- extensions/signal/src/outbound-adapter.ts | 13 +- extensions/signal/src/plugin-shared.ts | 4 +- extensions/signal/src/probe.ts | 2 +- extensions/signal/src/reaction-level.ts | 4 +- extensions/signal/src/rpc-context.ts | 2 +- extensions/signal/src/runtime.ts | 6 +- extensions/signal/src/send-reactions.ts | 4 +- extensions/signal/src/send.ts | 8 +- extensions/signal/src/setup-core.ts | 141 +++++--- extensions/signal/src/setup-surface.ts | 169 +++++++-- extensions/signal/src/sse-reconnect.ts | 8 +- extensions/slack/src/account-inspect.ts | 4 +- .../slack/src/account-surface-fields.ts | 2 +- extensions/slack/src/accounts.ts | 6 +- extensions/slack/src/actions.ts | 4 +- extensions/slack/src/blocks-render.ts | 4 +- extensions/slack/src/blocks.test-helpers.ts | 2 +- extensions/slack/src/channel-migration.ts | 6 +- extensions/slack/src/channel.setup.ts | 72 +++- extensions/slack/src/channel.ts | 127 +++++-- extensions/slack/src/directory-live.ts | 4 +- extensions/slack/src/draft-stream.ts | 2 +- extensions/slack/src/format.ts | 10 +- extensions/slack/src/interactive-replies.ts | 2 +- .../slack/src/message-action-dispatch.ts | 2 +- extensions/slack/src/message-actions.ts | 6 +- extensions/slack/src/monitor.test-helpers.ts | 12 +- extensions/slack/src/monitor/allow-list.ts | 4 +- extensions/slack/src/monitor/auth.ts | 2 +- .../slack/src/monitor/channel-config.ts | 4 +- extensions/slack/src/monitor/commands.ts | 2 +- extensions/slack/src/monitor/context.ts | 22 +- extensions/slack/src/monitor/dm-auth.ts | 6 +- .../slack/src/monitor/events/channels.ts | 8 +- .../events/interactions.block-actions.ts | 6 +- .../src/monitor/events/interactions.modal.ts | 2 +- .../slack/src/monitor/events/members.ts | 4 +- .../slack/src/monitor/events/messages.ts | 4 +- extensions/slack/src/monitor/events/pins.ts | 4 +- .../slack/src/monitor/events/reactions.ts | 4 +- .../monitor/events/system-event-context.ts | 2 +- .../src/monitor/external-arg-menu-store.ts | 2 +- extensions/slack/src/monitor/media.ts | 8 +- .../slack/src/monitor/message-handler.ts | 2 +- .../src/monitor/message-handler/dispatch.ts | 26 +- .../message-handler/prepare-content.ts | 2 +- .../message-handler/prepare-thread-context.ts | 8 +- .../message-handler/prepare.test-helpers.ts | 4 +- .../src/monitor/message-handler/prepare.ts | 55 ++- .../src/monitor/message-handler/types.ts | 4 +- extensions/slack/src/monitor/provider.ts | 30 +- extensions/slack/src/monitor/replies.ts | 14 +- extensions/slack/src/monitor/room-context.ts | 2 +- .../src/monitor/slash-commands.runtime.ts | 2 +- .../src/monitor/slash-dispatch.runtime.ts | 16 +- .../monitor/slash-skill-commands.runtime.ts | 2 +- .../slack/src/monitor/slash.test-harness.ts | 14 +- extensions/slack/src/monitor/slash.ts | 17 +- .../slack/src/monitor/thread-resolution.ts | 4 +- extensions/slack/src/monitor/types.ts | 4 +- extensions/slack/src/outbound-adapter.ts | 12 +- extensions/slack/src/plugin-shared.ts | 6 +- extensions/slack/src/probe.ts | 4 +- extensions/slack/src/runtime.ts | 6 +- extensions/slack/src/scopes.ts | 2 +- extensions/slack/src/send.ts | 18 +- extensions/slack/src/sent-thread-cache.ts | 2 +- extensions/slack/src/setup-core.ts | 337 ++++++++++-------- extensions/slack/src/setup-surface.ts | 284 ++++++++++++--- extensions/slack/src/stream-mode.ts | 2 +- extensions/slack/src/streaming.ts | 2 +- extensions/slack/src/targets.ts | 2 +- .../slack/src/threading-tool-context.ts | 4 +- extensions/slack/src/threading.ts | 2 +- extensions/slack/src/token.ts | 2 +- extensions/synthetic/index.ts | 2 +- extensions/synthetic/onboard.ts | 6 +- extensions/synthetic/provider-catalog.ts | 4 +- extensions/talk-voice/index.ts | 4 +- extensions/telegram/src/account-inspect.ts | 14 +- extensions/telegram/src/accounts.ts | 29 +- extensions/telegram/src/api-logging.ts | 8 +- extensions/telegram/src/approval-buttons.ts | 2 +- .../telegram/src/audit-membership-runtime.ts | 4 +- extensions/telegram/src/audit.ts | 4 +- extensions/telegram/src/bot-access.ts | 6 +- extensions/telegram/src/bot-handlers.ts | 60 ++-- .../telegram/src/bot-message-context.body.ts | 38 +- .../src/bot-message-context.session.ts | 40 +-- .../telegram/src/bot-message-context.ts | 22 +- .../telegram/src/bot-message-context.types.ts | 6 +- .../telegram/src/bot-message-dispatch.ts | 34 +- extensions/telegram/src/bot-message.ts | 8 +- .../telegram/src/bot-native-command-menu.ts | 8 +- .../src/bot-native-commands.test-helpers.ts | 32 +- .../telegram/src/bot-native-commands.ts | 76 ++-- extensions/telegram/src/bot-updates.ts | 2 +- .../bot.create-telegram-bot.test-harness.ts | 26 +- .../telegram/src/bot.media.e2e-harness.ts | 18 +- .../telegram/src/bot.media.test-utils.ts | 4 +- extensions/telegram/src/bot.ts | 31 +- .../telegram/src/bot/delivery.replies.ts | 29 +- .../src/bot/delivery.resolve-media.ts | 10 +- extensions/telegram/src/bot/delivery.send.ts | 4 +- extensions/telegram/src/bot/helpers.ts | 10 +- .../telegram/src/bot/reply-threading.ts | 2 +- extensions/telegram/src/button-types.ts | 4 +- extensions/telegram/src/channel-actions.ts | 17 +- extensions/telegram/src/channel.setup.ts | 71 +++- extensions/telegram/src/channel.ts | 107 ++++-- extensions/telegram/src/conversation-route.ts | 14 +- extensions/telegram/src/dm-access.ts | 8 +- extensions/telegram/src/draft-chunking.ts | 8 +- extensions/telegram/src/draft-stream.ts | 4 +- .../telegram/src/exec-approvals-handler.ts | 27 +- extensions/telegram/src/exec-approvals.ts | 8 +- extensions/telegram/src/fetch.ts | 10 +- extensions/telegram/src/format.ts | 6 +- extensions/telegram/src/group-access.ts | 10 +- .../telegram/src/group-config-helpers.ts | 2 +- extensions/telegram/src/group-migration.ts | 6 +- extensions/telegram/src/inline-buttons.ts | 4 +- .../src/lane-delivery-text-deliverer.ts | 2 +- extensions/telegram/src/monitor.ts | 14 +- extensions/telegram/src/network-config.ts | 6 +- extensions/telegram/src/network-errors.ts | 2 +- extensions/telegram/src/outbound-adapter.ts | 13 +- extensions/telegram/src/plugin-shared.ts | 9 +- extensions/telegram/src/polling-session.ts | 6 +- extensions/telegram/src/probe.ts | 6 +- extensions/telegram/src/proxy.ts | 2 +- extensions/telegram/src/reaction-level.ts | 4 +- .../src/reasoning-lane-coordinator.ts | 8 +- extensions/telegram/src/runtime.ts | 6 +- extensions/telegram/src/send.test-harness.ts | 6 +- extensions/telegram/src/send.ts | 28 +- .../src/sendchataction-401-backoff.ts | 6 +- extensions/telegram/src/sent-message-cache.ts | 2 +- extensions/telegram/src/sequential-key.ts | 4 +- extensions/telegram/src/setup-core.ts | 185 ++++------ extensions/telegram/src/setup-surface.ts | 118 +++++- extensions/telegram/src/status-issues.ts | 4 +- .../telegram/src/status-reaction-variants.ts | 5 +- extensions/telegram/src/sticker-cache.ts | 29 +- extensions/telegram/src/target-writeback.ts | 15 +- extensions/telegram/src/thread-bindings.ts | 16 +- extensions/telegram/src/token.ts | 12 +- .../telegram/src/update-offset-store.ts | 4 +- extensions/telegram/src/voice.ts | 2 +- extensions/telegram/src/webhook.ts | 14 +- extensions/test-utils/directory.ts | 2 +- extensions/test-utils/plugin-api.ts | 2 +- extensions/test-utils/plugin-runtime-mock.ts | 2 +- extensions/together/index.ts | 2 +- extensions/together/onboard.ts | 6 +- extensions/together/provider-catalog.ts | 4 +- extensions/twitch/src/plugin.ts | 2 +- extensions/venice/index.ts | 2 +- extensions/venice/onboard.ts | 6 +- extensions/venice/provider-catalog.ts | 7 +- extensions/vercel-ai-gateway/index.ts | 2 +- extensions/vercel-ai-gateway/onboard.ts | 6 +- .../vercel-ai-gateway/provider-catalog.ts | 4 +- extensions/vllm/index.ts | 12 +- extensions/volcengine/index.ts | 26 +- extensions/volcengine/provider-catalog.ts | 4 +- extensions/whatsapp/src/accounts.ts | 12 +- extensions/whatsapp/src/active-listener.ts | 6 +- extensions/whatsapp/src/agent-tools-login.ts | 2 +- extensions/whatsapp/src/auth-store.ts | 16 +- extensions/whatsapp/src/auto-reply.impl.ts | 4 +- .../whatsapp/src/auto-reply.test-harness.ts | 8 +- .../whatsapp/src/auto-reply/deliver-reply.ts | 14 +- .../src/auto-reply/heartbeat-runner.ts | 35 +- extensions/whatsapp/src/auto-reply/loggers.ts | 2 +- .../whatsapp/src/auto-reply/mentions.ts | 9 +- extensions/whatsapp/src/auto-reply/monitor.ts | 30 +- .../src/auto-reply/monitor/ack-reaction.ts | 6 +- .../src/auto-reply/monitor/broadcast.ts | 11 +- .../auto-reply/monitor/group-activation.ts | 8 +- .../src/auto-reply/monitor/group-gating.ts | 12 +- .../src/auto-reply/monitor/group-members.ts | 2 +- .../src/auto-reply/monitor/last-route.ts | 6 +- .../src/auto-reply/monitor/message-line.ts | 6 +- .../src/auto-reply/monitor/on-message.ts | 16 +- .../whatsapp/src/auto-reply/monitor/peer.ts | 2 +- .../src/auto-reply/monitor/process-message.ts | 42 +-- .../src/auto-reply/session-snapshot.ts | 6 +- extensions/whatsapp/src/channel.setup.ts | 159 ++++++++- extensions/whatsapp/src/channel.ts | 168 +++++++-- .../inbound/access-control.test-harness.ts | 6 +- .../whatsapp/src/inbound/access-control.ts | 14 +- extensions/whatsapp/src/inbound/dedupe.ts | 2 +- extensions/whatsapp/src/inbound/extract.ts | 6 +- extensions/whatsapp/src/inbound/media.ts | 2 +- extensions/whatsapp/src/inbound/monitor.ts | 16 +- extensions/whatsapp/src/inbound/send-api.ts | 4 +- extensions/whatsapp/src/inbound/types.ts | 2 +- extensions/whatsapp/src/login-qr.ts | 8 +- extensions/whatsapp/src/login.ts | 10 +- extensions/whatsapp/src/media.ts | 18 +- .../src/monitor-inbox.test-harness.ts | 12 +- extensions/whatsapp/src/normalize.ts | 2 +- extensions/whatsapp/src/outbound-adapter.ts | 12 +- extensions/whatsapp/src/plugin-shared.ts | 2 +- extensions/whatsapp/src/qr-image.ts | 2 +- extensions/whatsapp/src/reconnect.ts | 8 +- extensions/whatsapp/src/runtime.ts | 6 +- extensions/whatsapp/src/send.ts | 20 +- extensions/whatsapp/src/session.ts | 10 +- extensions/whatsapp/src/setup-core.ts | 58 ++- extensions/whatsapp/src/setup-surface.ts | 6 +- extensions/whatsapp/src/status-issues.ts | 6 +- extensions/whatsapp/src/test-helpers.ts | 10 +- extensions/xai/index.ts | 9 +- extensions/xai/onboard.ts | 15 +- extensions/xiaomi/index.ts | 4 +- extensions/xiaomi/onboard.ts | 4 +- extensions/xiaomi/provider-catalog.ts | 2 +- extensions/zai/detect.ts | 2 +- extensions/zai/index.ts | 25 +- extensions/zai/onboard.ts | 15 +- package.json | 120 +++++++ scripts/lib/plugin-sdk-entrypoints.json | 32 +- src/agents/pi-embedded-runner/compact.ts | 4 +- src/agents/pi-embedded-runner/run/attempt.ts | 4 +- src/agents/tools/discord-actions-guild.ts | 4 +- src/agents/tools/discord-actions-messaging.ts | 14 +- .../tools/discord-actions-moderation.ts | 2 +- src/agents/tools/discord-actions-presence.ts | 2 +- src/agents/tools/discord-actions.ts | 2 +- src/agents/tools/slack-actions.ts | 4 +- src/agents/tools/telegram-actions.ts | 15 +- src/agents/tools/whatsapp-actions.ts | 2 +- src/agents/tools/whatsapp-target-auth.ts | 2 +- src/auto-reply/reply/commands-approve.ts | 2 +- src/auto-reply/reply/commands-models.ts | 2 +- .../reply/directive-handling.model.ts | 2 +- src/auto-reply/templating.ts | 2 +- src/channel-web.ts | 16 +- src/channels/plugins/actions/discord.ts | 2 +- src/channels/plugins/actions/signal.ts | 2 +- src/channels/plugins/actions/telegram.ts | 2 +- .../plugins/agent-tools/whatsapp-login.ts | 2 +- src/channels/plugins/group-mentions.ts | 2 +- src/channels/plugins/slack.actions.ts | 36 +- ...ad-only-account-inspect.discord.runtime.ts | 4 +- ...read-only-account-inspect.slack.runtime.ts | 4 +- ...d-only-account-inspect.telegram.runtime.ts | 4 +- src/cli/deps.ts | 14 +- src/commands/doctor-config-flow.ts | 2 +- src/config/plugin-auto-enable.ts | 2 +- src/config/schema.help.ts | 2 +- .../explicit-session-key-normalization.ts | 2 +- src/config/types.discord.ts | 2 +- src/cron/isolated-agent/delivery-target.ts | 2 +- src/gateway/server-http.ts | 2 +- src/infra/state-migrations.ts | 2 +- src/plugin-sdk/account-resolution.ts | 13 + src/plugin-sdk/acp-runtime.ts | 6 + src/plugin-sdk/agent-runtime.ts | 28 ++ src/plugin-sdk/channel-config-helpers.ts | 16 + src/plugin-sdk/channel-runtime.ts | 53 +++ src/plugin-sdk/cli-runtime.ts | 6 + src/plugin-sdk/config-runtime.ts | 42 +++ src/plugin-sdk/conversation-runtime.ts | 41 +++ src/plugin-sdk/discord.ts | 86 +++++ src/plugin-sdk/gateway-runtime.ts | 6 + src/plugin-sdk/hook-runtime.ts | 5 + src/plugin-sdk/imessage.ts | 1 + src/plugin-sdk/infra-runtime.ts | 39 ++ src/plugin-sdk/json-store.ts | 7 + src/plugin-sdk/media-runtime.ts | 21 ++ src/plugin-sdk/plugin-runtime.ts | 6 + src/plugin-sdk/process-runtime.ts | 3 + src/plugin-sdk/provider-auth.ts | 43 +++ src/plugin-sdk/provider-models.ts | 86 +++++ src/plugin-sdk/provider-onboard.ts | 16 + src/plugin-sdk/provider-stream.ts | 17 + src/plugin-sdk/provider-usage.ts | 21 ++ src/plugin-sdk/provider-web-search.ts | 18 + src/plugin-sdk/qwen-portal-auth.ts | 3 + src/plugin-sdk/reply-runtime.ts | 31 ++ src/plugin-sdk/routing.ts | 27 +- src/plugin-sdk/runtime-env.ts | 21 ++ src/plugin-sdk/runtime-store.ts | 2 + src/plugin-sdk/runtime.ts | 18 + src/plugin-sdk/security-runtime.ts | 6 + src/plugin-sdk/setup.ts | 17 + src/plugin-sdk/signal.ts | 15 + src/plugin-sdk/slack.ts | 39 ++ src/plugin-sdk/speech.ts | 7 + src/plugin-sdk/state-paths.ts | 3 + src/plugin-sdk/telegram.ts | 64 ++++ src/plugin-sdk/test-utils.ts | 1 + src/plugin-sdk/text-runtime.ts | 23 ++ src/plugin-sdk/whatsapp.ts | 54 +++ src/plugin-sdk/zai.ts | 7 + src/security/audit-channel.runtime.ts | 2 +- 492 files changed, 5657 insertions(+), 2877 deletions(-) create mode 100644 src/plugin-sdk/acp-runtime.ts create mode 100644 src/plugin-sdk/agent-runtime.ts create mode 100644 src/plugin-sdk/channel-runtime.ts create mode 100644 src/plugin-sdk/cli-runtime.ts create mode 100644 src/plugin-sdk/config-runtime.ts create mode 100644 src/plugin-sdk/conversation-runtime.ts create mode 100644 src/plugin-sdk/gateway-runtime.ts create mode 100644 src/plugin-sdk/hook-runtime.ts create mode 100644 src/plugin-sdk/infra-runtime.ts create mode 100644 src/plugin-sdk/media-runtime.ts create mode 100644 src/plugin-sdk/plugin-runtime.ts create mode 100644 src/plugin-sdk/process-runtime.ts create mode 100644 src/plugin-sdk/provider-auth.ts create mode 100644 src/plugin-sdk/provider-models.ts create mode 100644 src/plugin-sdk/provider-onboard.ts create mode 100644 src/plugin-sdk/provider-stream.ts create mode 100644 src/plugin-sdk/provider-usage.ts create mode 100644 src/plugin-sdk/provider-web-search.ts create mode 100644 src/plugin-sdk/reply-runtime.ts create mode 100644 src/plugin-sdk/runtime-env.ts create mode 100644 src/plugin-sdk/security-runtime.ts create mode 100644 src/plugin-sdk/speech.ts create mode 100644 src/plugin-sdk/state-paths.ts create mode 100644 src/plugin-sdk/text-runtime.ts create mode 100644 src/plugin-sdk/zai.ts diff --git a/extensions/acpx/src/test-utils/runtime-fixtures.ts b/extensions/acpx/src/test-utils/runtime-fixtures.ts index c5cbef83877..ebf5052f450 100644 --- a/extensions/acpx/src/test-utils/runtime-fixtures.ts +++ b/extensions/acpx/src/test-utils/runtime-fixtures.ts @@ -1,7 +1,7 @@ import fs from "node:fs"; import { chmod, mkdtemp, readFile, rm, writeFile } from "node:fs/promises"; import path from "node:path"; -import { resolvePreferredOpenClawTmpDir } from "../../../../src/infra/tmp-openclaw-dir.js"; +import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime"; import type { ResolvedAcpxPluginConfig } from "../config.js"; import { ACPX_PINNED_VERSION } from "../config.js"; import { AcpxRuntime } from "../runtime.js"; diff --git a/extensions/anthropic/index.ts b/extensions/anthropic/index.ts index cf63e876354..25cb604dbcb 100644 --- a/extensions/anthropic/index.ts +++ b/extensions/anthropic/index.ts @@ -1,3 +1,5 @@ +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import { parseDurationMs } from "openclaw/plugin-sdk/cli-runtime"; import { emptyPluginConfigSchema, type OpenClawPluginApi, @@ -7,26 +9,25 @@ import { } from "openclaw/plugin-sdk/core"; import { CLAUDE_CLI_PROFILE_ID, + applyAuthProfileConfig, + buildTokenProfileId, + createProviderApiKeyAuthMethod, + ensureApiKeyFromOptionEnvOrPrompt, listProfilesForProvider, - upsertAuthProfile, -} from "../../src/agents/auth-profiles.js"; -import { suggestOAuthProfileIdForLegacyDefault } from "../../src/agents/auth-profiles/repair.js"; -import type { AuthProfileStore } from "../../src/agents/auth-profiles/types.js"; -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { formatCliCommand } from "../../src/cli/command-format.js"; -import { parseDurationMs } from "../../src/cli/parse-duration.js"; -import { + normalizeApiKeyInput, + suggestOAuthProfileIdForLegacyDefault, + type AuthProfileStore, + type ProviderAuthResult, + normalizeSecretInput, normalizeSecretInputModeInput, promptSecretRefForSetup, resolveSecretInputModeForEnvSelection, -} from "../../src/commands/auth-choice.apply-helpers.js"; -import { buildTokenProfileId, validateAnthropicSetupToken } from "../../src/commands/auth-token.js"; -import { applyAuthProfileConfig } from "../../src/commands/onboard-auth.js"; -import { fetchClaudeUsage } from "../../src/infra/provider-usage.fetch.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import type { ProviderAuthResult } from "../../src/plugins/types.js"; -import { normalizeSecretInput } from "../../src/utils/normalize-secret-input.js"; -import { anthropicMediaUnderstandingProvider } from "./media-understanding-provider.js"; + upsertAuthProfile, + validateAnthropicSetupToken, + validateApiKeyInput, +} from "openclaw/plugin-sdk/provider-auth"; +import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; +import { fetchClaudeUsage } from "openclaw/plugin-sdk/provider-usage"; const PROVIDER_ID = "anthropic"; const DEFAULT_ANTHROPIC_MODEL = "anthropic/claude-sonnet-4-6"; @@ -395,7 +396,6 @@ const anthropicPlugin = { profileId: ctx.profileId, }), }); - api.registerMediaUnderstandingProvider(anthropicMediaUnderstandingProvider); }, }; diff --git a/extensions/brave/index.ts b/extensions/brave/index.ts index 1150dec5d80..f23c5d4d485 100644 --- a/extensions/brave/index.ts +++ b/extensions/brave/index.ts @@ -1,10 +1,9 @@ +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createPluginBackedWebSearchProvider, getTopLevelCredentialValue, setTopLevelCredentialValue, -} from "../../src/agents/tools/web-search-plugin-factory.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/provider-web-search"; const bravePlugin = { id: "brave", diff --git a/extensions/byteplus/index.ts b/extensions/byteplus/index.ts index 7c6cf2f08fe..215ac1a1705 100644 --- a/extensions/byteplus/index.ts +++ b/extensions/byteplus/index.ts @@ -1,7 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { ensureModelAllowlistEntry } from "../../src/commands/model-allowlist.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { buildPairedProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { ensureModelAllowlistEntry } from "openclaw/plugin-sdk/provider-onboard"; import { buildBytePlusCodingProvider, buildBytePlusProvider } from "./provider-catalog.js"; const PROVIDER_ID = "byteplus"; @@ -46,15 +45,18 @@ const byteplusPlugin = { ], catalog: { order: "paired", - run: (ctx) => - buildPairedProviderApiKeyCatalog({ - ctx, - providerId: PROVIDER_ID, - buildProviders: () => ({ - byteplus: buildBytePlusProvider(), - "byteplus-plan": buildBytePlusCodingProvider(), - }), - }), + run: async (ctx) => { + const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; + if (!apiKey) { + return null; + } + return { + providers: { + byteplus: { ...buildBytePlusProvider(), apiKey }, + "byteplus-plan": { ...buildBytePlusCodingProvider(), apiKey }, + }, + }; + }, }, }); }, diff --git a/extensions/byteplus/provider-catalog.ts b/extensions/byteplus/provider-catalog.ts index 77cca06a2db..bcb5b153d20 100644 --- a/extensions/byteplus/provider-catalog.ts +++ b/extensions/byteplus/provider-catalog.ts @@ -4,8 +4,8 @@ import { BYTEPLUS_CODING_BASE_URL, BYTEPLUS_CODING_MODEL_CATALOG, BYTEPLUS_MODEL_CATALOG, -} from "../../src/agents/byteplus-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; + type ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; export function buildBytePlusProvider(): ModelProviderConfig { return { diff --git a/extensions/cloudflare-ai-gateway/index.ts b/extensions/cloudflare-ai-gateway/index.ts index aa584af8208..6c3cda9d0d2 100644 --- a/extensions/cloudflare-ai-gateway/index.ts +++ b/extensions/cloudflare-ai-gateway/index.ts @@ -1,21 +1,22 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { upsertAuthProfile } from "../../src/agents/auth-profiles.js"; -import { ensureAuthProfileStore, listProfilesForProvider } from "../../src/agents/auth-profiles.js"; +import { + applyAuthProfileConfig, + buildApiKeyCredential, + coerceSecretRef, + ensureApiKeyFromOptionEnvOrPrompt, + ensureAuthProfileStore, + listProfilesForProvider, + normalizeApiKeyInput, + normalizeOptionalSecretInput, + resolveNonEnvSecretRefApiKeyMarker, + type SecretInput, + upsertAuthProfile, + validateApiKeyInput, +} from "openclaw/plugin-sdk/provider-auth"; import { buildCloudflareAiGatewayModelDefinition, resolveCloudflareAiGatewayBaseUrl, -} from "../../src/agents/cloudflare-ai-gateway.js"; -import { resolveNonEnvSecretRefApiKeyMarker } from "../../src/agents/model-auth-markers.js"; -import { - normalizeApiKeyInput, - validateApiKeyInput, -} from "../../src/commands/auth-choice.api-key.js"; -import { ensureApiKeyFromOptionEnvOrPrompt } from "../../src/commands/auth-choice.apply-helpers.js"; -import { buildApiKeyCredential } from "../../src/commands/auth-credentials.js"; -import { applyAuthProfileConfig } from "../../src/commands/onboard-auth.js"; -import type { SecretInput } from "../../src/config/types.secrets.js"; -import { coerceSecretRef } from "../../src/config/types.secrets.js"; -import { normalizeOptionalSecretInput } from "../../src/utils/normalize-secret-input.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyCloudflareAiGatewayConfig, buildCloudflareAiGatewayConfigPatch, diff --git a/extensions/cloudflare-ai-gateway/onboard.ts b/extensions/cloudflare-ai-gateway/onboard.ts index 267c2f806f1..5260e1495a8 100644 --- a/extensions/cloudflare-ai-gateway/onboard.ts +++ b/extensions/cloudflare-ai-gateway/onboard.ts @@ -2,12 +2,12 @@ import { buildCloudflareAiGatewayModelDefinition, CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF, resolveCloudflareAiGatewayBaseUrl, -} from "../../src/agents/cloudflare-ai-gateway.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithDefaultModel, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export { CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF }; diff --git a/extensions/discord/src/account-inspect.ts b/extensions/discord/src/account-inspect.ts index a998c5ba874..c74c630cee4 100644 --- a/extensions/discord/src/account-inspect.ts +++ b/extensions/discord/src/account-inspect.ts @@ -1,13 +1,13 @@ import { hasConfiguredSecretInput, normalizeSecretInputString, -} from "../../../src/config/types.secrets.js"; +} from "openclaw/plugin-sdk/config-runtime"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, type DiscordAccountConfig, -} from "../../../src/plugin-sdk-internal/discord.js"; +} from "openclaw/plugin-sdk/discord"; import { mergeDiscordAccountConfig, resolveDefaultDiscordAccountId, diff --git a/extensions/discord/src/accounts.ts b/extensions/discord/src/accounts.ts index 39903077aaf..b9b8ede5fe1 100644 --- a/extensions/discord/src/accounts.ts +++ b/extensions/discord/src/accounts.ts @@ -3,12 +3,12 @@ import { createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; +} from "openclaw/plugin-sdk/account-resolution"; import type { - OpenClawConfig, DiscordAccountConfig, DiscordActionConfig, -} from "../../../src/plugin-sdk-internal/discord.js"; + OpenClawConfig, +} from "openclaw/plugin-sdk/discord"; import { resolveDiscordToken } from "./token.js"; export type ResolvedDiscordAccount = { diff --git a/extensions/discord/src/actions/handle-action.guild-admin.ts b/extensions/discord/src/actions/handle-action.guild-admin.ts index 80cd97217ae..0f6075384a5 100644 --- a/extensions/discord/src/actions/handle-action.guild-admin.ts +++ b/extensions/discord/src/actions/handle-action.guild-admin.ts @@ -4,13 +4,13 @@ import { readNumberParam, readStringArrayParam, readStringParam, -} from "../../../../src/agents/tools/common.js"; +} from "openclaw/plugin-sdk/agent-runtime"; import { isDiscordModerationAction, readDiscordModerationCommand, -} from "../../../../src/agents/tools/discord-actions-moderation-shared.js"; -import { handleDiscordAction } from "../../../../src/agents/tools/discord-actions.js"; -import type { ChannelMessageActionContext } from "../../../../src/channels/plugins/types.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { handleDiscordAction } from "openclaw/plugin-sdk/agent-runtime"; +import type { ChannelMessageActionContext } from "openclaw/plugin-sdk/channel-runtime"; type Ctx = Pick< ChannelMessageActionContext, diff --git a/extensions/discord/src/actions/handle-action.ts b/extensions/discord/src/actions/handle-action.ts index c938d675955..d23b078292a 100644 --- a/extensions/discord/src/actions/handle-action.ts +++ b/extensions/discord/src/actions/handle-action.ts @@ -1,15 +1,15 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; -import { readBooleanParam } from "openclaw/plugin-sdk/boolean-param"; import { readNumberParam, readStringArrayParam, readStringParam, -} from "../../../../src/agents/tools/common.js"; -import { readDiscordParentIdParam } from "../../../../src/agents/tools/discord-actions-shared.js"; -import { handleDiscordAction } from "../../../../src/agents/tools/discord-actions.js"; -import { resolveReactionMessageId } from "../../../../src/channels/plugins/actions/reaction-message-id.js"; -import type { ChannelMessageActionContext } from "../../../../src/channels/plugins/types.js"; -import { normalizeInteractiveReply } from "../../../../src/interactive/payload.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { readDiscordParentIdParam } from "openclaw/plugin-sdk/agent-runtime"; +import { handleDiscordAction } from "openclaw/plugin-sdk/agent-runtime"; +import { readBooleanParam } from "openclaw/plugin-sdk/boolean-param"; +import { resolveReactionMessageId } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelMessageActionContext } from "openclaw/plugin-sdk/channel-runtime"; +import { normalizeInteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; import { buildDiscordInteractiveComponents } from "../shared-interactive.js"; import { resolveDiscordChannelId } from "../targets.js"; import { tryHandleDiscordMessageActionGuildAdmin } from "./handle-action.guild-admin.js"; diff --git a/extensions/discord/src/api.ts b/extensions/discord/src/api.ts index cead5eb8cea..0352656d21b 100644 --- a/extensions/discord/src/api.ts +++ b/extensions/discord/src/api.ts @@ -1,5 +1,9 @@ -import { resolveFetch } from "../../../src/infra/fetch.js"; -import { resolveRetryConfig, retryAsync, type RetryConfig } from "../../../src/infra/retry.js"; +import { resolveFetch } from "openclaw/plugin-sdk/infra-runtime"; +import { + resolveRetryConfig, + retryAsync, + type RetryConfig, +} from "openclaw/plugin-sdk/infra-runtime"; const DISCORD_API_BASE = "https://discord.com/api/v10"; const DISCORD_API_RETRY_DEFAULTS = { diff --git a/extensions/discord/src/audit.ts b/extensions/discord/src/audit.ts index a5a226c5550..79bc9b5b5fc 100644 --- a/extensions/discord/src/audit.ts +++ b/extensions/discord/src/audit.ts @@ -1,6 +1,9 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { DiscordGuildChannelConfig, DiscordGuildEntry } from "../../../src/config/types.js"; -import { isRecord } from "../../../src/utils.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { + DiscordGuildChannelConfig, + DiscordGuildEntry, +} from "openclaw/plugin-sdk/config-runtime"; +import { isRecord } from "openclaw/plugin-sdk/text-runtime"; import { inspectDiscordAccount } from "./account-inspect.js"; import { fetchChannelPermissionsDiscord } from "./send.js"; diff --git a/extensions/discord/src/channel-actions.ts b/extensions/discord/src/channel-actions.ts index 049eb4a320c..21f24fd9553 100644 --- a/extensions/discord/src/channel-actions.ts +++ b/extensions/discord/src/channel-actions.ts @@ -1,12 +1,12 @@ import { createUnionActionGate, listTokenSourcedAccounts, -} from "../../../src/channels/plugins/actions/shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelMessageActionAdapter, ChannelMessageActionName, -} from "../../../src/channels/plugins/types.js"; -import type { DiscordActionConfig } from "../../../src/config/types.discord.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { DiscordActionConfig } from "openclaw/plugin-sdk/config-runtime"; import { createDiscordActionGate, listEnabledDiscordAccounts } from "./accounts.js"; import { handleDiscordMessageAction } from "./actions/handle-action.js"; diff --git a/extensions/discord/src/channel.setup.ts b/extensions/discord/src/channel.setup.ts index 5c7bfe6e659..1988c03ca26 100644 --- a/extensions/discord/src/channel.setup.ts +++ b/extensions/discord/src/channel.setup.ts @@ -1,8 +1,43 @@ -import type { ChannelPlugin } from "openclaw/plugin-sdk/discord"; -import type { ResolvedDiscordAccount } from "./accounts.js"; +import { + buildChannelConfigSchema, + DiscordConfigSchema, + getChatChannelMeta, + type ChannelPlugin, +} from "openclaw/plugin-sdk/discord"; +import { type ResolvedDiscordAccount } from "./accounts.js"; +import { discordConfigAccessors, discordConfigBase, discordSetupWizard } from "./plugin-shared.js"; import { discordSetupAdapter } from "./setup-core.js"; -import { createDiscordPluginBase } from "./shared.js"; -export const discordSetupPlugin: ChannelPlugin = createDiscordPluginBase({ +export const discordSetupPlugin: ChannelPlugin = { + id: "discord", + meta: { + ...getChatChannelMeta("discord"), + }, + setupWizard: discordSetupWizard, + capabilities: { + chatTypes: ["direct", "channel", "thread"], + polls: true, + reactions: true, + threads: true, + media: true, + nativeCommands: true, + }, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.discord"] }, + configSchema: buildChannelConfigSchema(DiscordConfigSchema), + config: { + ...discordConfigBase, + isConfigured: (account) => Boolean(account.token?.trim()), + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: Boolean(account.token?.trim()), + tokenSource: account.tokenSource, + }), + ...discordConfigAccessors, + }, setup: discordSetupAdapter, -}); +}; diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index b598f004cf7..d12813e66a6 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -1,10 +1,12 @@ import { Separator, TextDisplay } from "@buape/carbon"; +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; import { - buildAccountScopedAllowlistConfigEditor, buildAccountScopedDmSecurityPolicy, - collectOpenProviderGroupPolicyWarnings, collectOpenGroupPolicyConfiguredRouteWarnings, -} from "openclaw/plugin-sdk/compat"; + collectOpenProviderGroupPolicyWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, resolveThreadSessionKeys, @@ -12,8 +14,11 @@ import { } from "openclaw/plugin-sdk/core"; import { buildComputedAccountStatusSnapshot, + buildChannelConfigSchema, buildTokenChannelStatusSummary, DEFAULT_ACCOUNT_ID, + DiscordConfigSchema, + getChatChannelMeta, listDiscordDirectoryGroupsFromConfig, listDiscordDirectoryPeersFromConfig, PAIRING_APPROVED_MESSAGE, @@ -25,9 +30,6 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/discord"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; -import { normalizeOutboundThreadId } from "../../../src/infra/outbound/thread-id.js"; -import { normalizeMessageChannel } from "../../../src/utils/message-channel.js"; import { listDiscordAccountIds, resolveDiscordAccount, @@ -43,12 +45,12 @@ import { normalizeDiscordMessagingTarget, normalizeDiscordOutboundTarget, } from "./normalize.js"; +import { discordConfigAccessors, discordConfigBase, discordSetupWizard } from "./plugin-shared.js"; import type { DiscordProbe } from "./probe.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { getDiscordRuntime } from "./runtime.js"; import { fetchChannelPermissionsDiscord } from "./send.js"; import { discordSetupAdapter } from "./setup-core.js"; -import { createDiscordPluginBase, discordConfigAccessors } from "./shared.js"; import { collectDiscordStatusIssues } from "./status-issues.js"; import { parseDiscordTarget } from "./targets.js"; import { DiscordUiContainer } from "./ui.js"; @@ -57,6 +59,7 @@ type DiscordSendFn = ReturnType< typeof getDiscordRuntime >["channel"]["discord"]["sendMessageDiscord"]; +const meta = getChatChannelMeta("discord"); const REQUIRED_DISCORD_PERMISSIONS = ["ViewChannel", "SendMessages"] as const; function formatDiscordIntents(intents?: { @@ -197,6 +200,20 @@ function parseDiscordExplicitTarget(raw: string) { } } +function normalizeOutboundThreadId(value?: string | number | null): string | undefined { + if (value == null) { + return undefined; + } + if (typeof value === "number") { + if (!Number.isFinite(value)) { + return undefined; + } + return String(Math.trunc(value)); + } + const trimmed = value.trim(); + return trimmed ? trimmed : undefined; +} + function buildDiscordBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; @@ -280,9 +297,11 @@ function resolveDiscordOutboundSessionRoute(params: { } export const discordPlugin: ChannelPlugin = { - ...createDiscordPluginBase({ - setup: discordSetupAdapter, - }), + id: "discord", + meta: { + ...meta, + }, + setupWizard: discordSetupWizard, pairing: { idLabel: "discordUserId", normalizeAllowEntry: (entry) => entry.replace(/^(discord|user):/i, ""), @@ -293,6 +312,31 @@ export const discordPlugin: ChannelPlugin = { ); }, }, + capabilities: { + chatTypes: ["direct", "channel", "thread"], + polls: true, + reactions: true, + threads: true, + media: true, + nativeCommands: true, + }, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.discord"] }, + configSchema: buildChannelConfigSchema(DiscordConfigSchema), + config: { + ...discordConfigBase, + isConfigured: (account) => Boolean(account.token?.trim()), + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: Boolean(account.token?.trim()), + tokenSource: account.tokenSource, + }), + ...discordConfigAccessors, + }, allowlist: { supportsScope: ({ scope }) => scope === "dm", readConfig: ({ cfg, accountId }) => diff --git a/extensions/discord/src/chunk.ts b/extensions/discord/src/chunk.ts index a814c10d2c8..5efff023152 100644 --- a/extensions/discord/src/chunk.ts +++ b/extensions/discord/src/chunk.ts @@ -1,4 +1,4 @@ -import { chunkMarkdownTextWithMode, type ChunkMode } from "../../../src/auto-reply/chunk.js"; +import { chunkMarkdownTextWithMode, type ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; export type ChunkDiscordTextOpts = { /** Max characters per Discord message. Default: 2000. */ diff --git a/extensions/discord/src/client.ts b/extensions/discord/src/client.ts index 2e8d53799a6..2688add72cd 100644 --- a/extensions/discord/src/client.ts +++ b/extensions/discord/src/client.ts @@ -1,8 +1,8 @@ import { RequestClient } from "@buape/carbon"; -import { loadConfig } from "../../../src/config/config.js"; -import { createDiscordRetryRunner, type RetryRunner } from "../../../src/infra/retry-policy.js"; -import type { RetryConfig } from "../../../src/infra/retry.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { createDiscordRetryRunner, type RetryRunner } from "openclaw/plugin-sdk/infra-runtime"; +import type { RetryConfig } from "openclaw/plugin-sdk/infra-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { mergeDiscordAccountConfig, resolveDiscordAccount, diff --git a/extensions/discord/src/directory-cache.ts b/extensions/discord/src/directory-cache.ts index d1a85767216..cc8c9d7c546 100644 --- a/extensions/discord/src/directory-cache.ts +++ b/extensions/discord/src/directory-cache.ts @@ -1,4 +1,4 @@ -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/account-id.js"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/routing"; const DISCORD_DIRECTORY_CACHE_MAX_ENTRIES = 4000; const DISCORD_DISCRIMINATOR_SUFFIX = /#\d{4}$/; diff --git a/extensions/discord/src/directory-live.ts b/extensions/discord/src/directory-live.ts index af55475a43e..6bd38204a0a 100644 --- a/extensions/discord/src/directory-live.ts +++ b/extensions/discord/src/directory-live.ts @@ -1,5 +1,5 @@ -import type { DirectoryConfigParams } from "../../../src/channels/plugins/directory-config.js"; -import type { ChannelDirectoryEntry } from "../../../src/channels/plugins/types.js"; +import type { DirectoryConfigParams } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelDirectoryEntry } from "openclaw/plugin-sdk/channel-runtime"; import { resolveDiscordAccount } from "./accounts.js"; import { fetchDiscord } from "./api.js"; import { rememberDiscordDirectoryUser } from "./directory-cache.js"; diff --git a/extensions/discord/src/draft-chunking.ts b/extensions/discord/src/draft-chunking.ts index a6461412ae7..98cc48a2f9f 100644 --- a/extensions/discord/src/draft-chunking.ts +++ b/extensions/discord/src/draft-chunking.ts @@ -1,7 +1,7 @@ -import { resolveTextChunkLimit } from "../../../src/auto-reply/chunk.js"; -import { type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveAccountEntry } from "../../../src/routing/account-lookup.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import { type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAccountEntry } from "openclaw/plugin-sdk/routing"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { DISCORD_TEXT_CHUNK_LIMIT } from "./outbound-adapter.js"; const DEFAULT_DISCORD_DRAFT_STREAM_MIN = 200; diff --git a/extensions/discord/src/draft-stream.ts b/extensions/discord/src/draft-stream.ts index db9089f6176..a12348334bc 100644 --- a/extensions/discord/src/draft-stream.ts +++ b/extensions/discord/src/draft-stream.ts @@ -1,6 +1,6 @@ import type { RequestClient } from "@buape/carbon"; import { Routes } from "discord-api-types/v10"; -import { createFinalizableDraftLifecycle } from "../../../src/channels/draft-stream-controls.js"; +import { createFinalizableDraftLifecycle } from "openclaw/plugin-sdk/channel-runtime"; /** Discord messages cap at 2000 characters. */ const DISCORD_STREAM_MAX_CHARS = 2000; diff --git a/extensions/discord/src/exec-approvals.ts b/extensions/discord/src/exec-approvals.ts index 5640805705a..bdafce36713 100644 --- a/extensions/discord/src/exec-approvals.ts +++ b/extensions/discord/src/exec-approvals.ts @@ -1,6 +1,6 @@ -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { getExecApprovalReplyMetadata } from "../../../src/infra/exec-approval-reply.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { getExecApprovalReplyMetadata } from "openclaw/plugin-sdk/infra-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import { resolveDiscordAccount } from "./accounts.js"; export function isDiscordExecApprovalClientEnabled(params: { diff --git a/extensions/discord/src/gateway-logging.ts b/extensions/discord/src/gateway-logging.ts index 18ce32909ef..3a6802ccaef 100644 --- a/extensions/discord/src/gateway-logging.ts +++ b/extensions/discord/src/gateway-logging.ts @@ -1,6 +1,6 @@ import type { EventEmitter } from "node:events"; -import { logVerbose } from "../../../src/globals.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; type GatewayEmitter = Pick; diff --git a/extensions/discord/src/monitor.tool-result.test-harness.ts b/extensions/discord/src/monitor.tool-result.test-harness.ts index 700e9a63df3..fd4f67b0890 100644 --- a/extensions/discord/src/monitor.tool-result.test-harness.ts +++ b/extensions/discord/src/monitor.tool-result.test-harness.ts @@ -1,5 +1,5 @@ +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; export const sendMock: MockFn = vi.fn(); export const reactMock: MockFn = vi.fn(); @@ -15,8 +15,8 @@ vi.mock("./send.js", () => ({ }, })); -vi.mock("../../../src/auto-reply/dispatch.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/reply-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, dispatchInboundMessage: (...args: unknown[]) => dispatchMock(...args), @@ -36,10 +36,10 @@ function createPairingStoreMocks() { }; } -vi.mock("../../../src/pairing/pairing-store.js", () => createPairingStoreMocks()); +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => createPairingStoreMocks()); -vi.mock("../../../src/config/sessions.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, resolveStorePath: vi.fn(() => "/tmp/openclaw-sessions.json"), diff --git a/extensions/discord/src/monitor/agent-components.ts b/extensions/discord/src/monitor/agent-components.ts index e28bd17b70e..5ac63e76d51 100644 --- a/extensions/discord/src/monitor/agent-components.ts +++ b/extensions/discord/src/monitor/agent-components.ts @@ -18,41 +18,41 @@ import { } from "@buape/carbon"; import type { APIStringSelectComponent } from "discord-api-types/v10"; import { ButtonStyle, ChannelType } from "discord-api-types/v10"; -import { resolveHumanDelayConfig } from "../../../../src/agents/identity.js"; -import { resolveChunkMode, resolveTextChunkLimit } from "../../../../src/auto-reply/chunk.js"; -import { - formatInboundEnvelope, - resolveEnvelopeFormatOptions, -} from "../../../../src/auto-reply/envelope.js"; -import { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; -import { dispatchReplyWithBufferedBlockDispatcher } from "../../../../src/auto-reply/reply/provider-dispatcher.js"; -import { createReplyReferencePlanner } from "../../../../src/auto-reply/reply/reply-reference.js"; -import { resolveCommandAuthorizedFromAuthorizers } from "../../../../src/channels/command-gating.js"; -import { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -import { recordInboundSession } from "../../../../src/channels/session.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import { resolveMarkdownTableMode } from "../../../../src/config/markdown-tables.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../../src/config/sessions.js"; -import type { DiscordAccountConfig } from "../../../../src/config/types.discord.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../src/infra/system-events.js"; -import { logDebug, logError } from "../../../../src/logger.js"; -import { getAgentScopedMediaLocalRoots } from "../../../../src/media/local-roots.js"; -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../../src/pairing/pairing-store.js"; +import { resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordAccountConfig } from "openclaw/plugin-sdk/config-runtime"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; import { buildPluginBindingResolvedText, parsePluginBindingApprovalCustomId, resolvePluginConversationBindingApproval, -} from "../../../../src/plugins/conversation-binding.js"; -import { dispatchPluginInteractiveHandler } from "../../../../src/plugins/interactive.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; -import { createNonExitingRuntime, type RuntimeEnv } from "../../../../src/runtime.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { dispatchPluginInteractiveHandler } from "openclaw/plugin-sdk/plugin-runtime"; +import { resolveChunkMode, resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { + formatInboundEnvelope, + resolveEnvelopeFormatOptions, +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchReplyWithBufferedBlockDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyReferencePlanner } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { readStoreAllowFromForDmPolicy, resolvePinnedMainDmOwnerFromAllowlist, -} from "../../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/security-runtime"; +import { logDebug, logError } from "openclaw/plugin-sdk/text-runtime"; import { resolveDiscordMaxLinesPerMessage } from "../accounts.js"; import { resolveDiscordComponentEntry, resolveDiscordModalEntry } from "../components-registry.js"; import { diff --git a/extensions/discord/src/monitor/allow-list.ts b/extensions/discord/src/monitor/allow-list.ts index a6208eaf63a..31d95f2f45b 100644 --- a/extensions/discord/src/monitor/allow-list.ts +++ b/extensions/discord/src/monitor/allow-list.ts @@ -1,12 +1,12 @@ import type { Guild, User } from "@buape/carbon"; -import { evaluateGroupRouteAccessForPolicy } from "openclaw/plugin-sdk/group-access"; -import type { AllowlistMatch } from "../../../../src/channels/allowlist-match.js"; +import type { AllowlistMatch } from "openclaw/plugin-sdk/channel-runtime"; import { buildChannelKeyCandidates, resolveChannelEntryMatchWithFallback, resolveChannelMatchConfig, type ChannelMatchSource, -} from "../../../../src/channels/channel-config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { evaluateGroupRouteAccessForPolicy } from "openclaw/plugin-sdk/group-access"; import { formatDiscordUserTag } from "./format.js"; export type DiscordAllowList = { diff --git a/extensions/discord/src/monitor/auto-presence.ts b/extensions/discord/src/monitor/auto-presence.ts index 60e5619e348..b76ea6f6d5c 100644 --- a/extensions/discord/src/monitor/auto-presence.ts +++ b/extensions/discord/src/monitor/auto-presence.ts @@ -6,12 +6,12 @@ import { resolveProfilesUnavailableReason, type AuthProfileFailureReason, type AuthProfileStore, -} from "../../../../src/agents/auth-profiles.js"; +} from "openclaw/plugin-sdk/agent-runtime"; import type { DiscordAccountConfig, DiscordAutoPresenceConfig, -} from "../../../../src/config/config.js"; -import { warn } from "../../../../src/globals.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { warn } from "openclaw/plugin-sdk/runtime-env"; import { resolveDiscordPresenceUpdate } from "./presence.js"; const DEFAULT_CUSTOM_ACTIVITY_TYPE = 4; diff --git a/extensions/discord/src/monitor/commands.ts b/extensions/discord/src/monitor/commands.ts index a9bb9c1548e..43e92ea9122 100644 --- a/extensions/discord/src/monitor/commands.ts +++ b/extensions/discord/src/monitor/commands.ts @@ -1,4 +1,4 @@ -import type { DiscordSlashCommandConfig } from "../../../../src/config/types.discord.js"; +import type { DiscordSlashCommandConfig } from "openclaw/plugin-sdk/config-runtime"; export function resolveDiscordSlashCommandConfig( raw?: DiscordSlashCommandConfig, diff --git a/extensions/discord/src/monitor/dm-command-auth.ts b/extensions/discord/src/monitor/dm-command-auth.ts index 2fa02d9d605..1e8f1afbb4b 100644 --- a/extensions/discord/src/monitor/dm-command-auth.ts +++ b/extensions/discord/src/monitor/dm-command-auth.ts @@ -1,9 +1,9 @@ -import { resolveCommandAuthorizedFromAuthorizers } from "../../../../src/channels/command-gating.js"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; import { readStoreAllowFromForDmPolicy, resolveDmGroupAccessWithLists, type DmGroupAccessDecision, -} from "../../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/security-runtime"; import { normalizeDiscordAllowList, resolveDiscordAllowListMatch } from "./allow-list.js"; const DISCORD_ALLOW_LIST_PREFIXES = ["discord:", "user:", "pk:"]; diff --git a/extensions/discord/src/monitor/dm-command-decision.ts b/extensions/discord/src/monitor/dm-command-decision.ts index 8c15e7cac11..ec5cb6330e0 100644 --- a/extensions/discord/src/monitor/dm-command-decision.ts +++ b/extensions/discord/src/monitor/dm-command-decision.ts @@ -1,5 +1,5 @@ -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../../src/pairing/pairing-store.js"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; import type { DiscordDmCommandAccess } from "./dm-command-auth.js"; export async function handleDiscordDmCommandDecision(params: { diff --git a/extensions/discord/src/monitor/exec-approvals.ts b/extensions/discord/src/monitor/exec-approvals.ts index e5fda7682a9..607d5088ad1 100644 --- a/extensions/discord/src/monitor/exec-approvals.ts +++ b/extensions/discord/src/monitor/exec-approvals.ts @@ -10,30 +10,24 @@ import { type TopLevelComponents, } from "@buape/carbon"; import { ButtonStyle, Routes } from "discord-api-types/v10"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { loadSessionStore, resolveStorePath } from "../../../../src/config/sessions.js"; -import type { DiscordExecApprovalConfig } from "../../../../src/config/types.discord.js"; -import { GatewayClient } from "../../../../src/gateway/client.js"; -import { createOperatorApprovalsGatewayClient } from "../../../../src/gateway/operator-approvals-client.js"; -import type { EventFrame } from "../../../../src/gateway/protocol/index.js"; -import { resolveExecApprovalCommandDisplay } from "../../../../src/infra/exec-approval-command-display.js"; -import { getExecApprovalApproverDmNoticeText } from "../../../../src/infra/exec-approval-reply.js"; +import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { loadSessionStore, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordExecApprovalConfig } from "openclaw/plugin-sdk/config-runtime"; +import { GatewayClient } from "openclaw/plugin-sdk/gateway-runtime"; +import { createOperatorApprovalsGatewayClient } from "openclaw/plugin-sdk/gateway-runtime"; +import type { EventFrame } from "openclaw/plugin-sdk/gateway-runtime"; +import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; +import { getExecApprovalApproverDmNoticeText } from "openclaw/plugin-sdk/infra-runtime"; import type { ExecApprovalDecision, ExecApprovalRequest, ExecApprovalResolved, -} from "../../../../src/infra/exec-approvals.js"; -import { logDebug, logError } from "../../../../src/logger.js"; -import { - normalizeAccountId, - resolveAgentIdFromSessionKey, -} from "../../../../src/routing/session-key.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; -import { - compileSafeRegex, - testRegexWithBoundedInput, -} from "../../../../src/security/safe-regex.js"; -import { normalizeMessageChannel } from "../../../../src/utils/message-channel.js"; +} from "openclaw/plugin-sdk/infra-runtime"; +import { normalizeAccountId, resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { compileSafeRegex, testRegexWithBoundedInput } from "openclaw/plugin-sdk/security-runtime"; +import { logDebug, logError } from "openclaw/plugin-sdk/text-runtime"; import { createDiscordClient, stripUndefinedFields } from "../send.shared.js"; import { DiscordUiContainer } from "../ui.js"; diff --git a/extensions/discord/src/monitor/gateway-plugin.ts b/extensions/discord/src/monitor/gateway-plugin.ts index 1799c16d79e..109135a3684 100644 --- a/extensions/discord/src/monitor/gateway-plugin.ts +++ b/extensions/discord/src/monitor/gateway-plugin.ts @@ -1,11 +1,11 @@ import { GatewayIntents, GatewayPlugin } from "@buape/carbon/gateway"; import type { APIGatewayBotInfo } from "discord-api-types/v10"; import { HttpsProxyAgent } from "https-proxy-agent"; +import type { DiscordAccountConfig } from "openclaw/plugin-sdk/config-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { ProxyAgent, fetch as undiciFetch } from "undici"; import WebSocket from "ws"; -import type { DiscordAccountConfig } from "../../../../src/config/types.js"; -import { danger } from "../../../../src/globals.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; const DISCORD_GATEWAY_BOT_URL = "https://discord.com/api/v10/gateway/bot"; const DEFAULT_DISCORD_GATEWAY_URL = "wss://gateway.discord.gg/"; @@ -20,7 +20,7 @@ type DiscordGatewayFetch = ( ) => Promise; export function resolveDiscordGatewayIntents( - intentsConfig?: import("../../../../src/config/types.discord.js").DiscordIntentsConfig, + intentsConfig?: import("openclaw/plugin-sdk/config-runtime").DiscordIntentsConfig, ): number { let intents = GatewayIntents.Guilds | diff --git a/extensions/discord/src/monitor/inbound-context.ts b/extensions/discord/src/monitor/inbound-context.ts index 26b2a07f03e..1f0608d3529 100644 --- a/extensions/discord/src/monitor/inbound-context.ts +++ b/extensions/discord/src/monitor/inbound-context.ts @@ -1,4 +1,4 @@ -import { buildUntrustedChannelMetadata } from "../../../../src/security/channel-metadata.js"; +import { buildUntrustedChannelMetadata } from "openclaw/plugin-sdk/security-runtime"; import { resolveDiscordOwnerAllowFrom, type DiscordChannelConfigResolved, diff --git a/extensions/discord/src/monitor/inbound-worker.ts b/extensions/discord/src/monitor/inbound-worker.ts index cbc8e246704..33986e458a3 100644 --- a/extensions/discord/src/monitor/inbound-worker.ts +++ b/extensions/discord/src/monitor/inbound-worker.ts @@ -1,7 +1,7 @@ +import { createRunStateMachine } from "openclaw/plugin-sdk/channel-runtime"; +import { formatDurationSeconds } from "openclaw/plugin-sdk/infra-runtime"; import { KeyedAsyncQueue } from "openclaw/plugin-sdk/keyed-async-queue"; -import { createRunStateMachine } from "../../../../src/channels/run-state-machine.js"; -import { danger } from "../../../../src/globals.js"; -import { formatDurationSeconds } from "../../../../src/infra/format-time/format-duration.ts"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import { materializeDiscordInboundJob, type DiscordInboundJob } from "./inbound-job.js"; import type { RuntimeEnv } from "./message-handler.preflight.types.js"; import { processDiscordMessage } from "./message-handler.process.js"; diff --git a/extensions/discord/src/monitor/listeners.ts b/extensions/discord/src/monitor/listeners.ts index 318435d5318..9ed94d0a52f 100644 --- a/extensions/discord/src/monitor/listeners.ts +++ b/extensions/discord/src/monitor/listeners.ts @@ -8,16 +8,16 @@ import { ThreadUpdateListener, type User, } from "@buape/carbon"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { danger, logVerbose } from "../../../../src/globals.js"; -import { formatDurationSeconds } from "../../../../src/infra/format-time/format-duration.ts"; -import { enqueueSystemEvent } from "../../../../src/infra/system-events.js"; -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { formatDurationSeconds } from "openclaw/plugin-sdk/infra-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { danger, logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; import { readStoreAllowFromForDmPolicy, resolveDmGroupAccessWithLists, -} from "../../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/security-runtime"; import { isDiscordGroupAllowedByPolicy, normalizeDiscordAllowList, @@ -36,11 +36,9 @@ import { isThreadArchived } from "./thread-bindings.discord-api.js"; import { closeDiscordThreadSessions } from "./thread-session-close.js"; import { normalizeDiscordListenerTimeoutMs, runDiscordTaskWithTimeout } from "./timeouts.js"; -type LoadedConfig = ReturnType; -type RuntimeEnv = import("../../../../src/runtime.js").RuntimeEnv; -type Logger = ReturnType< - typeof import("../../../../src/logging/subsystem.js").createSubsystemLogger ->; +type LoadedConfig = ReturnType; +type RuntimeEnv = import("openclaw/plugin-sdk/runtime-env").RuntimeEnv; +type Logger = ReturnType; export type DiscordMessageEvent = Parameters[0]; diff --git a/extensions/discord/src/monitor/message-handler.module-test-helpers.ts b/extensions/discord/src/monitor/message-handler.module-test-helpers.ts index 83174ad5621..adeaf7953e7 100644 --- a/extensions/discord/src/monitor/message-handler.module-test-helpers.ts +++ b/extensions/discord/src/monitor/message-handler.module-test-helpers.ts @@ -1,5 +1,5 @@ +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; -import type { MockFn } from "../../../../src/test-utils/vitest-mock-fn.js"; export const preflightDiscordMessageMock: MockFn = vi.fn(); export const processDiscordMessageMock: MockFn = vi.fn(); diff --git a/extensions/discord/src/monitor/message-handler.preflight.test-helpers.ts b/extensions/discord/src/monitor/message-handler.preflight.test-helpers.ts index 24895d287f7..8c6aa5f3cc1 100644 --- a/extensions/discord/src/monitor/message-handler.preflight.test-helpers.ts +++ b/extensions/discord/src/monitor/message-handler.preflight.test-helpers.ts @@ -1,5 +1,5 @@ import { ChannelType } from "@buape/carbon"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import type { preflightDiscordMessage } from "./message-handler.preflight.js"; import { createNoopThreadBindingManager } from "./thread-bindings.js"; @@ -90,7 +90,7 @@ export function createDiscordPreflightArgs(params: { discordConfig: params.discordConfig, accountId: "default", token: "token", - runtime: {} as import("../../../../src/runtime.js").RuntimeEnv, + runtime: {} as import("openclaw/plugin-sdk/runtime-env").RuntimeEnv, botUserId: params.botUserId ?? "openclaw-bot", guildHistories: new Map(), historyLimit: 0, diff --git a/extensions/discord/src/monitor/message-handler.preflight.ts b/extensions/discord/src/monitor/message-handler.preflight.ts index 77640784063..0a402518927 100644 --- a/extensions/discord/src/monitor/message-handler.preflight.ts +++ b/extensions/discord/src/monitor/message-handler.preflight.ts @@ -1,36 +1,33 @@ import { ChannelType, MessageType, type User } from "@buape/carbon"; +import { formatAllowlistMatchMeta } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveControlCommandGate } from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMentionGatingWithBypass } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; import { ensureConfiguredAcpRouteReady, resolveConfiguredAcpRoute, -} from "../../../../src/acp/persistent-bindings.route.js"; -import { hasControlCommand } from "../../../../src/auto-reply/command-detection.js"; -import { shouldHandleTextCommands } from "../../../../src/auto-reply/commands-registry.js"; -import { - recordPendingHistoryEntryIfEnabled, - type HistoryEntry, -} from "../../../../src/auto-reply/reply/history.js"; -import { - buildMentionRegexes, - matchesMentionWithExplicit, -} from "../../../../src/auto-reply/reply/mentions.js"; -import { formatAllowlistMatchMeta } from "../../../../src/channels/allowlist-match.js"; -import { resolveControlCommandGate } from "../../../../src/channels/command-gating.js"; -import { logInboundDrop } from "../../../../src/channels/logging.js"; -import { resolveMentionGatingWithBypass } from "../../../../src/channels/mention-gating.js"; -import { loadConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { recordChannelActivity } from "../../../../src/infra/channel-activity.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; import { getSessionBindingService, type SessionBindingRecord, -} from "../../../../src/infra/outbound/session-binding-service.js"; -import { enqueueSystemEvent } from "../../../../src/infra/system-events.js"; -import { logDebug } from "../../../../src/logger.js"; -import { getChildLogger } from "../../../../src/logging.js"; -import { buildPairingReply } from "../../../../src/pairing/pairing-messages.js"; -import { isPluginOwnedSessionBindingRecord } from "../../../../src/plugins/conversation-binding.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { buildPairingReply } from "openclaw/plugin-sdk/conversation-runtime"; +import { isPluginOwnedSessionBindingRecord } from "openclaw/plugin-sdk/conversation-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { shouldHandleTextCommands } from "openclaw/plugin-sdk/reply-runtime"; +import { + recordPendingHistoryEntryIfEnabled, + type HistoryEntry, +} from "openclaw/plugin-sdk/reply-runtime"; +import { buildMentionRegexes, matchesMentionWithExplicit } from "openclaw/plugin-sdk/reply-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import { logDebug } from "openclaw/plugin-sdk/text-runtime"; import { fetchPluralKitMessageInfo } from "../pluralkit.js"; import { sendMessageDiscord } from "../send.js"; import { diff --git a/extensions/discord/src/monitor/message-handler.preflight.types.ts b/extensions/discord/src/monitor/message-handler.preflight.types.ts index a123a22dcaa..368352e1551 100644 --- a/extensions/discord/src/monitor/message-handler.preflight.types.ts +++ b/extensions/discord/src/monitor/message-handler.preflight.types.ts @@ -1,8 +1,8 @@ import type { ChannelType, Client, User } from "@buape/carbon"; -import type { HistoryEntry } from "../../../../src/auto-reply/reply/history.js"; -import type { ReplyToMode } from "../../../../src/config/config.js"; -import type { SessionBindingRecord } from "../../../../src/infra/outbound/session-binding-service.js"; -import type { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import type { SessionBindingRecord } from "openclaw/plugin-sdk/conversation-runtime"; +import type { HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import type { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; import type { DiscordChannelConfigResolved, DiscordGuildEntryResolved } from "./allow-list.js"; import type { DiscordChannelInfo } from "./message-utils.js"; import type { DiscordThreadBindingLookup } from "./reply-delivery.js"; @@ -11,15 +11,17 @@ import type { DiscordSenderIdentity } from "./sender-identity.js"; export type { DiscordSenderIdentity } from "./sender-identity.js"; import type { DiscordThreadChannel } from "./threading.js"; -export type LoadedConfig = ReturnType; -export type RuntimeEnv = import("../../../../src/runtime.js").RuntimeEnv; +export type LoadedConfig = ReturnType< + typeof import("openclaw/plugin-sdk/config-runtime").loadConfig +>; +export type RuntimeEnv = import("openclaw/plugin-sdk/runtime-env").RuntimeEnv; export type DiscordMessageEvent = import("./listeners.js").DiscordMessageEvent; type DiscordMessagePreflightSharedFields = { cfg: LoadedConfig; discordConfig: NonNullable< - import("../../../../src/config/config.js").OpenClawConfig["channels"] + import("openclaw/plugin-sdk/config-runtime").OpenClawConfig["channels"] >["discord"]; accountId: string; token: string; diff --git a/extensions/discord/src/monitor/message-handler.process.ts b/extensions/discord/src/monitor/message-handler.process.ts index dc86c3720ef..526ca4ecb71 100644 --- a/extensions/discord/src/monitor/message-handler.process.ts +++ b/extensions/discord/src/monitor/message-handler.process.ts @@ -1,40 +1,40 @@ import { ChannelType, type RequestClient } from "@buape/carbon"; -import { resolveAckReaction, resolveHumanDelayConfig } from "../../../../src/agents/identity.js"; -import { EmbeddedBlockChunker } from "../../../../src/agents/pi-embedded-block-chunker.js"; -import { resolveChunkMode } from "../../../../src/auto-reply/chunk.js"; -import { dispatchInboundMessage } from "../../../../src/auto-reply/dispatch.js"; -import { - formatInboundEnvelope, - resolveEnvelopeFormatOptions, -} from "../../../../src/auto-reply/envelope.js"; -import { - buildPendingHistoryContextFromMap, - clearHistoryEntriesIfEnabled, -} from "../../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; -import { createReplyDispatcherWithTyping } from "../../../../src/auto-reply/reply/reply-dispatcher.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import { shouldAckReaction as shouldAckReactionGate } from "../../../../src/channels/ack-reactions.js"; -import { logTypingFailure, logAckFailure } from "../../../../src/channels/logging.js"; -import { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -import { recordInboundSession } from "../../../../src/channels/session.js"; +import { resolveAckReaction, resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; +import { EmbeddedBlockChunker } from "openclaw/plugin-sdk/agent-runtime"; +import { shouldAckReaction as shouldAckReactionGate } from "openclaw/plugin-sdk/channel-runtime"; +import { logTypingFailure, logAckFailure } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; import { createStatusReactionController, DEFAULT_TIMING, type StatusReactionAdapter, -} from "../../../../src/channels/status-reactions.js"; -import { createTypingCallbacks } from "../../../../src/channels/typing.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import { resolveDiscordPreviewStreamMode } from "../../../../src/config/discord-preview-streaming.js"; -import { resolveMarkdownTableMode } from "../../../../src/config/markdown-tables.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../../src/config/sessions.js"; -import { danger, logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { convertMarkdownTables } from "../../../../src/markdown/tables.js"; -import { getAgentScopedMediaLocalRoots } from "../../../../src/media/local-roots.js"; -import { buildAgentSessionKey } from "../../../../src/routing/resolve-route.js"; -import { resolveThreadSessionKeys } from "../../../../src/routing/session-key.js"; -import { stripReasoningTagsFromText } from "../../../../src/shared/text/reasoning-tags.js"; -import { truncateUtf16Safe } from "../../../../src/utils.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { createTypingCallbacks } from "openclaw/plugin-sdk/channel-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; +import { resolveDiscordPreviewStreamMode } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchInboundMessage } from "openclaw/plugin-sdk/reply-runtime"; +import { + formatInboundEnvelope, + resolveEnvelopeFormatOptions, +} from "openclaw/plugin-sdk/reply-runtime"; +import { + buildPendingHistoryContextFromMap, + clearHistoryEntriesIfEnabled, +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyDispatcherWithTyping } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { buildAgentSessionKey } from "openclaw/plugin-sdk/routing"; +import { resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { danger, logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; +import { stripReasoningTagsFromText } from "openclaw/plugin-sdk/text-runtime"; +import { truncateUtf16Safe } from "openclaw/plugin-sdk/text-runtime"; import { resolveDiscordMaxLinesPerMessage } from "../accounts.js"; import { chunkDiscordTextWithMode } from "../chunk.js"; import { resolveDiscordDraftStreamingChunking } from "../draft-chunking.js"; diff --git a/extensions/discord/src/monitor/message-handler.test-helpers.ts b/extensions/discord/src/monitor/message-handler.test-helpers.ts index 04bfb9b603c..ed232ae43fb 100644 --- a/extensions/discord/src/monitor/message-handler.test-helpers.ts +++ b/extensions/discord/src/monitor/message-handler.test-helpers.ts @@ -1,5 +1,5 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { vi } from "vitest"; -import type { OpenClawConfig } from "../../../../src/config/types.js"; import type { createDiscordMessageHandler } from "./message-handler.js"; import { createNoopThreadBindingManager } from "./thread-bindings.js"; diff --git a/extensions/discord/src/monitor/message-handler.ts b/extensions/discord/src/monitor/message-handler.ts index 2c9745a8bf0..400f35a2529 100644 --- a/extensions/discord/src/monitor/message-handler.ts +++ b/extensions/discord/src/monitor/message-handler.ts @@ -2,9 +2,9 @@ import type { Client } from "@buape/carbon"; import { createChannelInboundDebouncer, shouldDebounceTextInbound, -} from "../../../../src/channels/inbound-debounce-policy.js"; -import { resolveOpenProviderRuntimeGroupPolicy } from "../../../../src/config/runtime-group-policy.js"; -import { danger } from "../../../../src/globals.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOpenProviderRuntimeGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import { buildDiscordInboundJob } from "./inbound-job.js"; import { createDiscordInboundWorker } from "./inbound-worker.js"; import type { DiscordMessageEvent, DiscordMessageHandler } from "./listeners.js"; diff --git a/extensions/discord/src/monitor/message-utils.ts b/extensions/discord/src/monitor/message-utils.ts index ae37d6615fd..4e84f4b3827 100644 --- a/extensions/discord/src/monitor/message-utils.ts +++ b/extensions/discord/src/monitor/message-utils.ts @@ -1,10 +1,10 @@ import type { ChannelType, Client, Message } from "@buape/carbon"; import { StickerFormatType, type APIAttachment, type APIStickerItem } from "discord-api-types/v10"; -import { buildMediaPayload } from "../../../../src/channels/plugins/media-payload.js"; -import { logVerbose } from "../../../../src/globals.js"; -import type { SsrFPolicy } from "../../../../src/infra/net/ssrf.js"; -import { fetchRemoteMedia, type FetchLike } from "../../../../src/media/fetch.js"; -import { saveMediaBuffer } from "../../../../src/media/store.js"; +import { buildMediaPayload } from "openclaw/plugin-sdk/channel-runtime"; +import type { SsrFPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { fetchRemoteMedia, type FetchLike } from "openclaw/plugin-sdk/media-runtime"; +import { saveMediaBuffer } from "openclaw/plugin-sdk/media-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; const DISCORD_CDN_HOSTNAMES = [ "cdn.discordapp.com", diff --git a/extensions/discord/src/monitor/model-picker-preferences.ts b/extensions/discord/src/monitor/model-picker-preferences.ts index 8657ed66436..ca3483678af 100644 --- a/extensions/discord/src/monitor/model-picker-preferences.ts +++ b/extensions/discord/src/monitor/model-picker-preferences.ts @@ -1,11 +1,11 @@ import os from "node:os"; import path from "node:path"; import { normalizeAccountId as normalizeSharedAccountId } from "openclaw/plugin-sdk/account-id"; +import { normalizeProviderId } from "openclaw/plugin-sdk/agent-runtime"; +import { withFileLock } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveRequiredHomeDir } from "openclaw/plugin-sdk/infra-runtime"; import { readJsonFileWithFallback, writeJsonFileAtomically } from "openclaw/plugin-sdk/json-store"; -import { normalizeProviderId } from "../../../../src/agents/model-selection.js"; -import { resolveStateDir } from "../../../../src/config/paths.js"; -import { withFileLock } from "../../../../src/infra/file-lock.js"; -import { resolveRequiredHomeDir } from "../../../../src/infra/home-dir.js"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; const MODEL_PICKER_PREFERENCES_LOCK_OPTIONS = { retries: { diff --git a/extensions/discord/src/monitor/model-picker.test-utils.ts b/extensions/discord/src/monitor/model-picker.test-utils.ts index 8d9a9dd3197..56dcd7480c1 100644 --- a/extensions/discord/src/monitor/model-picker.test-utils.ts +++ b/extensions/discord/src/monitor/model-picker.test-utils.ts @@ -1,4 +1,4 @@ -import type { ModelsProviderData } from "../../../../src/auto-reply/reply/commands-models.js"; +import type { ModelsProviderData } from "openclaw/plugin-sdk/reply-runtime"; export function createModelsProviderData( entries: Record, diff --git a/extensions/discord/src/monitor/model-picker.ts b/extensions/discord/src/monitor/model-picker.ts index fb9226ac899..ec067ede2dd 100644 --- a/extensions/discord/src/monitor/model-picker.ts +++ b/extensions/discord/src/monitor/model-picker.ts @@ -11,12 +11,12 @@ import { } from "@buape/carbon"; import type { APISelectMenuOption } from "discord-api-types/v10"; import { ButtonStyle } from "discord-api-types/v10"; -import { normalizeProviderId } from "../../../../src/agents/model-selection.js"; +import { normalizeProviderId } from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { buildModelsProviderData, type ModelsProviderData, -} from "../../../../src/auto-reply/reply/commands-models.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; +} from "openclaw/plugin-sdk/reply-runtime"; export const DISCORD_MODEL_PICKER_CUSTOM_ID_KEY = "mdlpk"; export const DISCORD_CUSTOM_ID_MAX_CHARS = 100; diff --git a/extensions/discord/src/monitor/native-command-context.ts b/extensions/discord/src/monitor/native-command-context.ts index fc650827d45..07dc0bf0a76 100644 --- a/extensions/discord/src/monitor/native-command-context.ts +++ b/extensions/discord/src/monitor/native-command-context.ts @@ -1,5 +1,5 @@ -import type { CommandArgs } from "../../../../src/auto-reply/commands-registry.js"; -import { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; +import type { CommandArgs } from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; import { type DiscordChannelConfigResolved, type DiscordGuildEntryResolved } from "./allow-list.js"; import { buildDiscordInboundAccessContext } from "./inbound-context.js"; diff --git a/extensions/discord/src/monitor/native-command.ts b/extensions/discord/src/monitor/native-command.ts index e745063d8d0..ed50aff52a3 100644 --- a/extensions/discord/src/monitor/native-command.ts +++ b/extensions/discord/src/monitor/native-command.ts @@ -15,19 +15,29 @@ import { type StringSelectMenuInteraction, } from "@buape/carbon"; import { ApplicationCommandOptionType, ButtonStyle } from "discord-api-types/v10"; +import { resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveNativeCommandSessionTargets } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig, loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; +import { resolveOpenProviderRuntimeGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { loadSessionStore, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; import { ensureConfiguredAcpRouteReady, resolveConfiguredAcpRoute, -} from "../../../../src/acp/persistent-bindings.route.js"; -import { resolveHumanDelayConfig } from "../../../../src/agents/identity.js"; -import { resolveChunkMode, resolveTextChunkLimit } from "../../../../src/auto-reply/chunk.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { buildPairingReply } from "openclaw/plugin-sdk/conversation-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { executePluginCommand, matchPluginCommand } from "openclaw/plugin-sdk/plugin-runtime"; +import { resolveChunkMode, resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; import type { ChatCommandDefinition, CommandArgDefinition, CommandArgValues, CommandArgs, NativeCommandSpec, -} from "../../../../src/auto-reply/commands-registry.js"; +} from "openclaw/plugin-sdk/reply-runtime"; import { buildCommandTextFromArgs, findCommandByNativeName, @@ -36,25 +46,15 @@ import { resolveCommandArgChoices, resolveCommandArgMenu, serializeCommandArgs, -} from "../../../../src/auto-reply/commands-registry.js"; -import { resolveStoredModelOverride } from "../../../../src/auto-reply/reply/model-selection.js"; -import { dispatchReplyWithDispatcher } from "../../../../src/auto-reply/reply/provider-dispatcher.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import { resolveCommandAuthorizedFromAuthorizers } from "../../../../src/channels/command-gating.js"; -import { resolveNativeCommandSessionTargets } from "../../../../src/channels/native-command-session-targets.js"; -import { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -import type { OpenClawConfig, loadConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import { resolveOpenProviderRuntimeGroupPolicy } from "../../../../src/config/runtime-group-policy.js"; -import { loadSessionStore, resolveStorePath } from "../../../../src/config/sessions.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { getAgentScopedMediaLocalRoots } from "../../../../src/media/local-roots.js"; -import { buildPairingReply } from "../../../../src/pairing/pairing-messages.js"; -import { executePluginCommand, matchPluginCommand } from "../../../../src/plugins/commands.js"; -import type { ResolvedAgentRoute } from "../../../../src/routing/resolve-route.js"; -import { chunkItems } from "../../../../src/utils/chunk-items.js"; -import { withTimeout } from "../../../../src/utils/with-timeout.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { resolveStoredModelOverride } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchReplyWithDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { ResolvedAgentRoute } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { chunkItems } from "openclaw/plugin-sdk/text-runtime"; +import { withTimeout } from "openclaw/plugin-sdk/text-runtime"; import { loadWebMedia } from "../../../whatsapp/src/media.js"; import { resolveDiscordMaxLinesPerMessage } from "../accounts.js"; import { chunkDiscordTextWithMode } from "../chunk.js"; diff --git a/extensions/discord/src/monitor/preflight-audio.ts b/extensions/discord/src/monitor/preflight-audio.ts index f52e2b0df93..f26fe5de9a9 100644 --- a/extensions/discord/src/monitor/preflight-audio.ts +++ b/extensions/discord/src/monitor/preflight-audio.ts @@ -1,5 +1,5 @@ -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { logVerbose } from "../../../../src/globals.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; type DiscordAudioAttachment = { content_type?: string; @@ -50,8 +50,7 @@ export async function resolveDiscordPreflightAudioMentionContext(params: { }; } try { - const { transcribeFirstAudio } = - await import("../../../../src/media-understanding/audio-preflight.js"); + const { transcribeFirstAudio } = await import("openclaw/plugin-sdk/media-runtime"); if (params.abortSignal?.aborted) { return { hasAudioAttachment, diff --git a/extensions/discord/src/monitor/presence.ts b/extensions/discord/src/monitor/presence.ts index b13a21dc2f1..cfe8125e50e 100644 --- a/extensions/discord/src/monitor/presence.ts +++ b/extensions/discord/src/monitor/presence.ts @@ -1,5 +1,5 @@ import type { Activity, UpdatePresenceData } from "@buape/carbon/gateway"; -import type { DiscordAccountConfig } from "../../../../src/config/config.js"; +import type { DiscordAccountConfig } from "openclaw/plugin-sdk/config-runtime"; const DEFAULT_CUSTOM_ACTIVITY_TYPE = 4; const CUSTOM_STATUS_NAME = "Custom Status"; diff --git a/extensions/discord/src/monitor/provider.allowlist.ts b/extensions/discord/src/monitor/provider.allowlist.ts index 3f108e443ea..ac6c89dd9f8 100644 --- a/extensions/discord/src/monitor/provider.allowlist.ts +++ b/extensions/discord/src/monitor/provider.allowlist.ts @@ -4,11 +4,11 @@ import { canonicalizeAllowlistWithResolvedIds, patchAllowlistUsersInConfigEntries, summarizeMapping, -} from "../../../../src/channels/allowlists/resolve-utils.js"; -import type { DiscordGuildEntry } from "../../../../src/config/types.discord.js"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; -import { normalizeStringEntries } from "../../../../src/shared/string-normalization.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { normalizeStringEntries } from "openclaw/plugin-sdk/text-runtime"; import { resolveDiscordChannelAllowlist } from "../resolve-channels.js"; import { resolveDiscordUserAllowlist } from "../resolve-users.js"; diff --git a/extensions/discord/src/monitor/provider.lifecycle.ts b/extensions/discord/src/monitor/provider.lifecycle.ts index 4d2130c3a5d..0d5fbd66b25 100644 --- a/extensions/discord/src/monitor/provider.lifecycle.ts +++ b/extensions/discord/src/monitor/provider.lifecycle.ts @@ -1,9 +1,9 @@ import type { Client } from "@buape/carbon"; import type { GatewayPlugin } from "@buape/carbon/gateway"; -import { createArmableStallWatchdog } from "../../../../src/channels/transport/stall-watchdog.js"; -import { createConnectedChannelStatusPatch } from "../../../../src/gateway/channel-status-patches.js"; -import { danger } from "../../../../src/globals.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import { createArmableStallWatchdog } from "openclaw/plugin-sdk/channel-runtime"; +import { createConnectedChannelStatusPatch } from "openclaw/plugin-sdk/gateway-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { attachDiscordGatewayLogging } from "../gateway-logging.js"; import { getDiscordGatewayEmitter, waitForDiscordGatewayStop } from "../monitor.gateway.js"; import type { DiscordVoiceManager } from "../voice/manager.js"; diff --git a/extensions/discord/src/monitor/provider.ts b/extensions/discord/src/monitor/provider.ts index d4ef01ab0d8..9c766334964 100644 --- a/extensions/discord/src/monitor/provider.ts +++ b/extensions/discord/src/monitor/provider.ts @@ -11,39 +11,45 @@ import { import { GatewayCloseCodes, type GatewayPlugin } from "@buape/carbon/gateway"; import { VoicePlugin } from "@buape/carbon/voice"; import { Routes } from "discord-api-types/v10"; -import { getAcpSessionManager } from "../../../../src/acp/control-plane/manager.js"; -import { isAcpRuntimeError } from "../../../../src/acp/runtime/errors.js"; -import { resolveTextChunkLimit } from "../../../../src/auto-reply/chunk.js"; -import type { NativeCommandSpec } from "../../../../src/auto-reply/commands-registry.js"; -import { listNativeCommandSpecsForConfig } from "../../../../src/auto-reply/commands-registry.js"; -import type { HistoryEntry } from "../../../../src/auto-reply/reply/history.js"; -import { listSkillCommandsForAgents } from "../../../../src/auto-reply/skill-commands.js"; +import { getAcpSessionManager } from "openclaw/plugin-sdk/acp-runtime"; +import { isAcpRuntimeError } from "openclaw/plugin-sdk/acp-runtime"; import { resolveThreadBindingIdleTimeoutMs, resolveThreadBindingMaxAgeMs, resolveThreadBindingsEnabled, -} from "../../../../src/channels/thread-bindings-policy.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import { isNativeCommandsExplicitlyDisabled, resolveNativeCommandsEnabled, resolveNativeSkillsEnabled, -} from "../../../../src/config/commands.js"; -import type { OpenClawConfig, ReplyToMode } from "../../../../src/config/config.js"; -import { loadConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { OpenClawConfig, ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; import { GROUP_POLICY_BLOCKED_LABEL, resolveOpenProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, -} from "../../../../src/config/runtime-group-policy.js"; -import { createConnectedChannelStatusPatch } from "../../../../src/gateway/channel-status-patches.js"; -import { danger, isVerbose, logVerbose, shouldLogVerbose, warn } from "../../../../src/globals.js"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { getPluginCommandSpecs } from "../../../../src/plugins/commands.js"; -import { createNonExitingRuntime, type RuntimeEnv } from "../../../../src/runtime.js"; -import { summarizeStringEntries } from "../../../../src/shared/string-sample.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { createConnectedChannelStatusPatch } from "openclaw/plugin-sdk/gateway-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { getPluginCommandSpecs } from "openclaw/plugin-sdk/plugin-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import type { NativeCommandSpec } from "openclaw/plugin-sdk/reply-runtime"; +import { listNativeCommandSpecsForConfig } from "openclaw/plugin-sdk/reply-runtime"; +import type { HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import { listSkillCommandsForAgents } from "openclaw/plugin-sdk/reply-runtime"; +import { + danger, + isVerbose, + logVerbose, + shouldLogVerbose, + warn, +} from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { summarizeStringEntries } from "openclaw/plugin-sdk/text-runtime"; import { resolveDiscordAccount } from "../accounts.js"; import { getDiscordGatewayEmitter } from "../monitor.gateway.js"; import { fetchDiscordApplicationId } from "../probe.js"; diff --git a/extensions/discord/src/monitor/reply-delivery.ts b/extensions/discord/src/monitor/reply-delivery.ts index 07e5c9e06c5..6e495d420ce 100644 --- a/extensions/discord/src/monitor/reply-delivery.ts +++ b/extensions/discord/src/monitor/reply-delivery.ts @@ -1,13 +1,17 @@ import type { RequestClient } from "@buape/carbon"; -import { resolveAgentAvatar } from "../../../../src/agents/identity-avatar.js"; -import type { ChunkMode } from "../../../../src/auto-reply/chunk.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import type { MarkdownTableMode, ReplyToMode } from "../../../../src/config/types.base.js"; -import { createDiscordRetryRunner, type RetryRunner } from "../../../../src/infra/retry-policy.js"; -import { resolveRetryConfig, retryAsync, type RetryConfig } from "../../../../src/infra/retry.js"; -import { convertMarkdownTables } from "../../../../src/markdown/tables.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import { resolveAgentAvatar } from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { MarkdownTableMode, ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import { createDiscordRetryRunner, type RetryRunner } from "openclaw/plugin-sdk/infra-runtime"; +import { + resolveRetryConfig, + retryAsync, + type RetryConfig, +} from "openclaw/plugin-sdk/infra-runtime"; +import type { ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; import { resolveDiscordAccount } from "../accounts.js"; import { chunkDiscordTextWithMode } from "../chunk.js"; import { sendMessageDiscord, sendVoiceMessageDiscord, sendWebhookMessageDiscord } from "../send.js"; diff --git a/extensions/discord/src/monitor/rest-fetch.ts b/extensions/discord/src/monitor/rest-fetch.ts index 83be5a98325..43b4c768381 100644 --- a/extensions/discord/src/monitor/rest-fetch.ts +++ b/extensions/discord/src/monitor/rest-fetch.ts @@ -1,7 +1,7 @@ +import { wrapFetchWithAbortSignal } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { ProxyAgent, fetch as undiciFetch } from "undici"; -import { danger } from "../../../../src/globals.js"; -import { wrapFetchWithAbortSignal } from "../../../../src/infra/fetch.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; export function resolveDiscordRestFetch( proxyUrl: string | undefined, diff --git a/extensions/discord/src/monitor/route-resolution.ts b/extensions/discord/src/monitor/route-resolution.ts index aacbebbd51e..f76c9b49f65 100644 --- a/extensions/discord/src/monitor/route-resolution.ts +++ b/extensions/discord/src/monitor/route-resolution.ts @@ -1,11 +1,11 @@ -import type { OpenClawConfig } from "../../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { deriveLastRoutePolicy, resolveAgentRoute, type ResolvedAgentRoute, type RoutePeer, -} from "../../../../src/routing/resolve-route.js"; -import { resolveAgentIdFromSessionKey } from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/routing"; +import { resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; export function buildDiscordRoutePeer(params: { isDirectMessage: boolean; diff --git a/extensions/discord/src/monitor/thread-bindings.config.ts b/extensions/discord/src/monitor/thread-bindings.config.ts index 830d54d0d1b..701defcfbe1 100644 --- a/extensions/discord/src/monitor/thread-bindings.config.ts +++ b/extensions/discord/src/monitor/thread-bindings.config.ts @@ -2,9 +2,9 @@ import { resolveThreadBindingIdleTimeoutMs, resolveThreadBindingMaxAgeMs, resolveThreadBindingsEnabled, -} from "../../../../src/channels/thread-bindings-policy.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { normalizeAccountId } from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; export { resolveThreadBindingIdleTimeoutMs, diff --git a/extensions/discord/src/monitor/thread-bindings.discord-api.ts b/extensions/discord/src/monitor/thread-bindings.discord-api.ts index 134eda0f109..d144bb22b72 100644 --- a/extensions/discord/src/monitor/thread-bindings.discord-api.ts +++ b/extensions/discord/src/monitor/thread-bindings.discord-api.ts @@ -1,6 +1,6 @@ import { ChannelType, Routes } from "discord-api-types/v10"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { logVerbose } from "../../../../src/globals.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { createDiscordRestClient } from "../client.js"; import { sendMessageDiscord, sendWebhookMessageDiscord } from "../send.js"; import { createThreadDiscord } from "../send.messages.js"; diff --git a/extensions/discord/src/monitor/thread-bindings.lifecycle.ts b/extensions/discord/src/monitor/thread-bindings.lifecycle.ts index d7d96857250..230a9cd7273 100644 --- a/extensions/discord/src/monitor/thread-bindings.lifecycle.ts +++ b/extensions/discord/src/monitor/thread-bindings.lifecycle.ts @@ -1,9 +1,6 @@ -import { - readAcpSessionEntry, - type AcpSessionStoreEntry, -} from "../../../../src/acp/runtime/session-meta.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { normalizeAccountId } from "../../../../src/routing/session-key.js"; +import { readAcpSessionEntry, type AcpSessionStoreEntry } from "openclaw/plugin-sdk/acp-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { parseDiscordTarget } from "../targets.js"; import { resolveChannelIdForBinding } from "./thread-bindings.discord-api.js"; import { getThreadBindingManager } from "./thread-bindings.manager.js"; diff --git a/extensions/discord/src/monitor/thread-bindings.manager.ts b/extensions/discord/src/monitor/thread-bindings.manager.ts index efa599cadc2..f6d5f7d3d90 100644 --- a/extensions/discord/src/monitor/thread-bindings.manager.ts +++ b/extensions/discord/src/monitor/thread-bindings.manager.ts @@ -1,17 +1,14 @@ import { Routes } from "discord-api-types/v10"; -import { resolveThreadBindingConversationIdFromBindingId } from "../../../../src/channels/thread-binding-id.js"; -import { getRuntimeConfigSnapshot, type OpenClawConfig } from "../../../../src/config/config.js"; -import { logVerbose } from "../../../../src/globals.js"; +import { resolveThreadBindingConversationIdFromBindingId } from "openclaw/plugin-sdk/channel-runtime"; +import { getRuntimeConfigSnapshot, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { registerSessionBindingAdapter, unregisterSessionBindingAdapter, type BindingTargetKind, type SessionBindingRecord, -} from "../../../../src/infra/outbound/session-binding-service.js"; -import { - normalizeAccountId, - resolveAgentIdFromSessionKey, -} from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { normalizeAccountId, resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { createDiscordRestClient } from "../client.js"; import { createThreadForBinding, diff --git a/extensions/discord/src/monitor/thread-bindings.messages.ts b/extensions/discord/src/monitor/thread-bindings.messages.ts index 3fc122cbe71..043e888b7fc 100644 --- a/extensions/discord/src/monitor/thread-bindings.messages.ts +++ b/extensions/discord/src/monitor/thread-bindings.messages.ts @@ -3,4 +3,4 @@ export { resolveThreadBindingFarewellText, resolveThreadBindingIntroText, resolveThreadBindingThreadName, -} from "../../../../src/channels/thread-bindings-messages.js"; +} from "openclaw/plugin-sdk/channel-runtime"; diff --git a/extensions/discord/src/monitor/thread-bindings.persona.ts b/extensions/discord/src/monitor/thread-bindings.persona.ts index 6798df009e0..2ee38c5f49d 100644 --- a/extensions/discord/src/monitor/thread-bindings.persona.ts +++ b/extensions/discord/src/monitor/thread-bindings.persona.ts @@ -1,4 +1,4 @@ -import { SYSTEM_MARK } from "../../../../src/infra/system-message.js"; +import { SYSTEM_MARK } from "openclaw/plugin-sdk/infra-runtime"; import type { ThreadBindingRecord } from "./thread-bindings.types.js"; const THREAD_BINDING_PERSONA_MAX_CHARS = 80; diff --git a/extensions/discord/src/monitor/thread-bindings.state.ts b/extensions/discord/src/monitor/thread-bindings.state.ts index cfcbc65f3f5..97de19c1dd5 100644 --- a/extensions/discord/src/monitor/thread-bindings.state.ts +++ b/extensions/discord/src/monitor/thread-bindings.state.ts @@ -1,11 +1,8 @@ import fs from "node:fs"; import path from "node:path"; -import { resolveStateDir } from "../../../../src/config/paths.js"; -import { loadJsonFile, saveJsonFile } from "../../../../src/infra/json-file.js"; -import { - normalizeAccountId, - resolveAgentIdFromSessionKey, -} from "../../../../src/routing/session-key.js"; +import { loadJsonFile, saveJsonFile } from "openclaw/plugin-sdk/json-store"; +import { normalizeAccountId, resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; import { DEFAULT_THREAD_BINDING_IDLE_TIMEOUT_MS, DEFAULT_THREAD_BINDING_MAX_AGE_MS, diff --git a/extensions/discord/src/monitor/thread-session-close.ts b/extensions/discord/src/monitor/thread-session-close.ts index ca73f623bd0..6a5d6c88c8b 100644 --- a/extensions/discord/src/monitor/thread-session-close.ts +++ b/extensions/discord/src/monitor/thread-session-close.ts @@ -1,5 +1,5 @@ -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { resolveStorePath, updateSessionStore } from "../../../../src/config/sessions.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveStorePath, updateSessionStore } from "openclaw/plugin-sdk/config-runtime"; /** * Marks every session entry in the store whose key contains {@link threadId} diff --git a/extensions/discord/src/monitor/threading.ts b/extensions/discord/src/monitor/threading.ts index 035354b98af..c3bf70d659c 100644 --- a/extensions/discord/src/monitor/threading.ts +++ b/extensions/discord/src/monitor/threading.ts @@ -1,10 +1,10 @@ import { ChannelType, type Client } from "@buape/carbon"; import { Routes } from "discord-api-types/v10"; -import { createReplyReferencePlanner } from "../../../../src/auto-reply/reply/reply-reference.js"; -import type { ReplyToMode } from "../../../../src/config/config.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { buildAgentSessionKey } from "../../../../src/routing/resolve-route.js"; -import { truncateUtf16Safe } from "../../../../src/utils.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import { createReplyReferencePlanner } from "openclaw/plugin-sdk/reply-runtime"; +import { buildAgentSessionKey } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { truncateUtf16Safe } from "openclaw/plugin-sdk/text-runtime"; import type { DiscordChannelConfigResolved } from "./allow-list.js"; import type { DiscordMessageEvent } from "./listeners.js"; import { diff --git a/extensions/discord/src/outbound-adapter.ts b/extensions/discord/src/outbound-adapter.ts index bc2f5f8c2d1..93fd1cb8bfb 100644 --- a/extensions/discord/src/outbound-adapter.ts +++ b/extensions/discord/src/outbound-adapter.ts @@ -2,11 +2,11 @@ import { resolvePayloadMediaUrls, sendPayloadMediaSequence, sendTextMediaPayload, -} from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import type { ChannelOutboundAdapter } from "../../../src/channels/plugins/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { OutboundIdentity } from "../../../src/infra/outbound/identity.js"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { OutboundIdentity } from "openclaw/plugin-sdk/infra-runtime"; import type { DiscordComponentMessageSpec } from "./components.js"; import { getThreadBindingManager, type ThreadBindingRecord } from "./monitor/thread-bindings.js"; import { normalizeDiscordOutboundTarget } from "./normalize.js"; diff --git a/extensions/discord/src/plugin-shared.ts b/extensions/discord/src/plugin-shared.ts index 9b5aec43b9e..f67e04d1a51 100644 --- a/extensions/discord/src/plugin-shared.ts +++ b/extensions/discord/src/plugin-shared.ts @@ -1,9 +1,9 @@ +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, - formatAllowFromLowercase, -} from "../../../src/plugin-sdk-internal/channel-config.js"; -import { type OpenClawConfig } from "../../../src/plugin-sdk-internal/discord.js"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/discord"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/discord/src/pluralkit.ts b/extensions/discord/src/pluralkit.ts index e328fb27eff..b8e6b30609a 100644 --- a/extensions/discord/src/pluralkit.ts +++ b/extensions/discord/src/pluralkit.ts @@ -1,4 +1,4 @@ -import { resolveFetch } from "../../../src/infra/fetch.js"; +import { resolveFetch } from "openclaw/plugin-sdk/infra-runtime"; const PLURALKIT_API_BASE = "https://api.pluralkit.me/v2"; diff --git a/extensions/discord/src/probe.ts b/extensions/discord/src/probe.ts index b434cd8c78d..f84b4aad10a 100644 --- a/extensions/discord/src/probe.ts +++ b/extensions/discord/src/probe.ts @@ -1,6 +1,6 @@ -import type { BaseProbeResult } from "../../../src/channels/plugins/types.js"; -import { resolveFetch } from "../../../src/infra/fetch.js"; -import { fetchWithTimeout } from "../../../src/utils/fetch-timeout.js"; +import type { BaseProbeResult } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveFetch } from "openclaw/plugin-sdk/infra-runtime"; +import { fetchWithTimeout } from "openclaw/plugin-sdk/text-runtime"; import { normalizeDiscordToken } from "./token.js"; const DISCORD_API_BASE = "https://discord.com/api/v10"; diff --git a/extensions/discord/src/runtime.ts b/extensions/discord/src/runtime.ts index b73ec43a065..4a07abdc1f7 100644 --- a/extensions/discord/src/runtime.ts +++ b/extensions/discord/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setDiscordRuntime, getRuntime: getDiscordRuntime } = createPluginRuntimeStore("Discord runtime not initialized"); diff --git a/extensions/discord/src/send.components.ts b/extensions/discord/src/send.components.ts index 9212e383ed7..9c641ba596d 100644 --- a/extensions/discord/src/send.components.ts +++ b/extensions/discord/src/send.components.ts @@ -5,8 +5,8 @@ import { type RequestClient, } from "@buape/carbon"; import { ChannelType, Routes } from "discord-api-types/v10"; -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import { recordChannelActivity } from "../../../src/infra/channel-activity.js"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; import { loadWebMedia } from "../../whatsapp/src/media.js"; import { resolveDiscordAccount } from "./accounts.js"; import { registerDiscordComponentEntries } from "./components-registry.js"; diff --git a/extensions/discord/src/send.outbound.ts b/extensions/discord/src/send.outbound.ts index 8f7b743e0d0..cc71330b192 100644 --- a/extensions/discord/src/send.outbound.ts +++ b/extensions/discord/src/send.outbound.ts @@ -3,17 +3,17 @@ import fs from "node:fs/promises"; import path from "node:path"; import { serializePayload, type MessagePayloadObject, type RequestClient } from "@buape/carbon"; import { ChannelType, Routes } from "discord-api-types/v10"; -import { resolveChunkMode } from "../../../src/auto-reply/chunk.js"; -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { recordChannelActivity } from "../../../src/infra/channel-activity.js"; -import type { RetryConfig } from "../../../src/infra/retry.js"; -import { resolvePreferredOpenClawTmpDir } from "../../../src/infra/tmp-openclaw-dir.js"; -import { convertMarkdownTables } from "../../../src/markdown/tables.js"; -import { maxBytesForKind } from "../../../src/media/constants.js"; -import { extensionForMime } from "../../../src/media/mime.js"; -import { unlinkIfExists } from "../../../src/media/temp-files.js"; -import type { PollInput } from "../../../src/polls.js"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import type { RetryConfig } from "openclaw/plugin-sdk/infra-runtime"; +import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime"; +import { maxBytesForKind } from "openclaw/plugin-sdk/media-runtime"; +import { extensionForMime } from "openclaw/plugin-sdk/media-runtime"; +import { unlinkIfExists } from "openclaw/plugin-sdk/media-runtime"; +import type { PollInput } from "openclaw/plugin-sdk/media-runtime"; +import { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; import { loadWebMediaRaw } from "../../whatsapp/src/media.js"; import { resolveDiscordAccount } from "./accounts.js"; import { rewriteDiscordKnownMentions } from "./mentions.js"; diff --git a/extensions/discord/src/send.reactions.ts b/extensions/discord/src/send.reactions.ts index 26353a7acb5..be48c85771d 100644 --- a/extensions/discord/src/send.reactions.ts +++ b/extensions/discord/src/send.reactions.ts @@ -1,5 +1,5 @@ import { Routes } from "discord-api-types/v10"; -import { loadConfig } from "../../../src/config/config.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { buildReactionIdentifier, createDiscordClient, diff --git a/extensions/discord/src/send.shared.ts b/extensions/discord/src/send.shared.ts index f1a7fd4c28e..115356510d2 100644 --- a/extensions/discord/src/send.shared.ts +++ b/extensions/discord/src/send.shared.ts @@ -9,15 +9,15 @@ import { import { PollLayoutType } from "discord-api-types/payloads/v10"; import type { RESTAPIPoll } from "discord-api-types/rest/v10"; import { Routes, type APIChannel, type APIEmbed } from "discord-api-types/v10"; -import type { ChunkMode } from "../../../src/auto-reply/chunk.js"; -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import type { RetryRunner } from "../../../src/infra/retry-policy.js"; -import { buildOutboundMediaLoadOptions } from "../../../src/media/load-options.js"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RetryRunner } from "openclaw/plugin-sdk/infra-runtime"; +import { buildOutboundMediaLoadOptions } from "openclaw/plugin-sdk/media-runtime"; import { normalizePollDurationHours, normalizePollInput, type PollInput, -} from "../../../src/polls.js"; +} from "openclaw/plugin-sdk/media-runtime"; +import type { ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; import { loadWebMedia } from "../../whatsapp/src/media.js"; import { resolveDiscordAccount } from "./accounts.js"; import { chunkDiscordTextWithMode } from "./chunk.js"; diff --git a/extensions/discord/src/send.test-harness.ts b/extensions/discord/src/send.test-harness.ts index f3c5ae36842..8a2058772fc 100644 --- a/extensions/discord/src/send.test-harness.ts +++ b/extensions/discord/src/send.test-harness.ts @@ -1,5 +1,5 @@ +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; type DiscordWebMediaMockFactoryResult = { loadWebMedia: MockFn; diff --git a/extensions/discord/src/send.types.ts b/extensions/discord/src/send.types.ts index 189c9434d1e..781cb84a435 100644 --- a/extensions/discord/src/send.types.ts +++ b/extensions/discord/src/send.types.ts @@ -1,6 +1,6 @@ import type { RequestClient } from "@buape/carbon"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { RetryConfig } from "../../../src/infra/retry.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RetryConfig } from "openclaw/plugin-sdk/infra-runtime"; export class DiscordSendError extends Error { kind?: "missing-permissions" | "dm-blocked"; diff --git a/extensions/discord/src/session-key-normalization.ts b/extensions/discord/src/session-key-normalization.ts index 7e47fe012dd..06164d6aba5 100644 --- a/extensions/discord/src/session-key-normalization.ts +++ b/extensions/discord/src/session-key-normalization.ts @@ -1,5 +1,5 @@ -import type { MsgContext } from "../../../src/auto-reply/templating.js"; -import { normalizeChatType } from "../../../src/channels/chat-type.js"; +import { normalizeChatType } from "openclaw/plugin-sdk/channel-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; export function normalizeExplicitDiscordSessionKey( sessionKey: string, diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index fe2b559a975..a362824a0f3 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -1,7 +1,10 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import type { DiscordGuildEntry } from "../../../src/config/types.discord.js"; +import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { + applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, + formatDocsLink, + migrateBaseNameToDefaultAccount, + normalizeAccountId, noteChannelLookupFailure, noteChannelLookupSummary, parseMentionOrPrefixedId, @@ -9,13 +12,12 @@ import { setLegacyChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; import { type ChannelSetupAdapter, type ChannelSetupDmPolicy, type ChannelSetupWizard, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +} from "openclaw/plugin-sdk/setup"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; @@ -70,8 +72,15 @@ export function parseDiscordAllowFromId(value: string): string | null { }); } -export const discordSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, +export const discordSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), validateInput: ({ accountId, input }) => { if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { return "DISCORD_BOT_TOKEN can only be used for the default account."; @@ -81,46 +90,57 @@ export const discordSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetu } return null; }, - buildPatch: (input) => (input.useEnv ? {} : input.token ? { token: input.token } : {}), -}); - -type DiscordAllowFromResolverParams = { - cfg: OpenClawConfig; - accountId: string; - credentialValues: { token?: string }; - entries: string[]; + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + if (accountId === DEFAULT_ACCOUNT_ID) { + return { + ...next, + channels: { + ...next.channels, + discord: { + ...next.channels?.discord, + enabled: true, + ...(input.useEnv ? {} : input.token ? { token: input.token } : {}), + }, + }, + }; + } + return { + ...next, + channels: { + ...next.channels, + discord: { + ...next.channels?.discord, + enabled: true, + accounts: { + ...next.channels?.discord?.accounts, + [accountId]: { + ...next.channels?.discord?.accounts?.[accountId], + enabled: true, + ...(input.token ? { token: input.token } : {}), + }, + }, + }, + }, + }; + }, }; -type DiscordGroupAllowlistResolverParams = DiscordAllowFromResolverParams & { - prompter: { note: (message: string, title?: string) => Promise }; -}; - -type DiscordGroupAllowlistResolution = Array<{ - input: string; - resolved: boolean; -}>; - -type DiscordSetupWizardHandlers = { - promptAllowFrom: (params: { - cfg: OpenClawConfig; - prompter: import("../../../src/plugin-sdk-internal/setup.js").WizardPrompter; - accountId?: string; - }) => Promise; - resolveAllowFromEntries: (params: DiscordAllowFromResolverParams) => Promise< - Array<{ - input: string; - resolved: boolean; - id: string | null; - }> - >; - resolveGroupAllowlist: ( - params: DiscordGroupAllowlistResolverParams, - ) => Promise; -}; - -export function createDiscordSetupWizardBase( - handlers: DiscordSetupWizardHandlers, -): ChannelSetupWizard { +export function createDiscordSetupWizardProxy( + loadWizard: () => Promise<{ discordSetupWizard: ChannelSetupWizard }>, +) { const discordDmPolicy: ChannelSetupDmPolicy = { label: "Discord", channel, @@ -134,7 +154,13 @@ export function createDiscordSetupWizardBase( channel, dmPolicy: policy, }), - promptAllowFrom: handlers.promptAllowFrom, + promptAllowFrom: async ({ cfg, prompter, accountId }) => { + const wizard = (await loadWizard()).discordSetupWizard; + if (!wizard.dmPolicy?.promptAllowFrom) { + return cfg; + } + return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); + }, }; return { @@ -212,22 +238,44 @@ export function createDiscordSetupWizardBase( accountId, patch: { groupPolicy: policy }, }), - resolveAllowlist: async (params: DiscordGroupAllowlistResolverParams) => { + resolveAllowlist: async ({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { token?: string }; + entries: string[]; + prompter: { note: (message: string, title?: string) => Promise }; + }) => { + const wizard = (await loadWizard()).discordSetupWizard; + if (!wizard.groupAccess?.resolveAllowlist) { + return entries.map((input) => ({ input, resolved: false })); + } try { - return await handlers.resolveGroupAllowlist(params); + return await wizard.groupAccess.resolveAllowlist({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }); } catch (error) { await noteChannelLookupFailure({ - prompter: params.prompter, + prompter, label: "Discord channels", error, }); await noteChannelLookupSummary({ - prompter: params.prompter, + prompter, label: "Discord channels", resolvedSections: [], - unresolved: params.entries, + unresolved: entries, }); - return params.entries.map((input) => ({ input, resolved: false })); + return entries.map((input) => ({ input, resolved: false })); } }, applyAllowlist: ({ @@ -257,7 +305,28 @@ export function createDiscordSetupWizardBase( invalidWithoutCredentialNote: "Bot token missing; use numeric user ids (or mention form) only.", parseId: parseDiscordAllowFromId, - resolveEntries: handlers.resolveAllowFromEntries, + resolveEntries: async ({ + cfg, + accountId, + credentialValues, + entries, + }: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { token?: string }; + entries: string[]; + }) => { + const wizard = (await loadWizard()).discordSetupWizard; + if (!wizard.allowFrom) { + return entries.map((input) => ({ input, resolved: false, id: null })); + } + return await wizard.allowFrom.resolveEntries({ + cfg, + accountId, + credentialValues, + entries, + }); + }, apply: async ({ cfg, accountId, @@ -278,42 +347,3 @@ export function createDiscordSetupWizardBase( disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } - -export function createDiscordSetupWizardProxy( - loadWizard: () => Promise<{ discordSetupWizard: ChannelSetupWizard }>, -) { - return createDiscordSetupWizardBase({ - promptAllowFrom: async ({ cfg, prompter, accountId }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.dmPolicy?.promptAllowFrom) { - return cfg; - } - return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); - }, - resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.allowFrom) { - return entries.map((input) => ({ input, resolved: false, id: null })); - } - return await wizard.allowFrom.resolveEntries({ - cfg, - accountId, - credentialValues, - entries, - }); - }, - resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.groupAccess?.resolveAllowlist) { - return entries.map((input) => ({ input, resolved: false })); - } - return (await wizard.groupAccess.resolveAllowlist({ - cfg, - accountId, - credentialValues, - entries, - prompter, - })) as DiscordGroupAllowlistResolution; - }, - }); -} diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 5f785db6f01..da87bfd77d0 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,14 +1,24 @@ import { + DEFAULT_ACCOUNT_ID, + formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, type OpenClawConfig, + parseMentionOrPrefixedId, + patchChannelConfigForAccount, promptLegacyChannelAllowFrom, resolveSetupAccountId, + setLegacyChannelDmPolicyWithAllowFrom, + setSetupChannelEnabled, type WizardPrompter, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { type ChannelSetupWizard } from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import { resolveDefaultDiscordAccountId, resolveDiscordAccount } from "./accounts.js"; +} from "openclaw/plugin-sdk/setup"; +import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { inspectDiscordAccount } from "./account-inspect.js"; +import { + listDiscordAccountIds, + resolveDefaultDiscordAccountId, + resolveDiscordAccount, +} from "./accounts.js"; import { normalizeDiscordSlug } from "./monitor/allow-list.js"; import { resolveDiscordChannelAllowlist, @@ -16,7 +26,6 @@ import { } from "./resolve-channels.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { - createDiscordSetupWizardBase, discordSetupAdapter, DISCORD_TOKEN_HELP_LINES, parseDiscordAllowFromId, @@ -82,62 +91,186 @@ async function promptDiscordAllowFrom(params: { }); } -export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase({ - promptAllowFrom: promptDiscordAllowFrom, - resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => - await resolveDiscordAllowFromEntries({ - token: - resolveDiscordAccount({ cfg, accountId }).token || - (typeof credentialValues.token === "string" ? credentialValues.token : ""), - entries, +const discordDmPolicy: ChannelSetupDmPolicy = { + label: "Discord", + channel, + policyKey: "channels.discord.dmPolicy", + allowFromKey: "channels.discord.allowFrom", + getCurrent: (cfg) => + cfg.channels?.discord?.dmPolicy ?? cfg.channels?.discord?.dm?.policy ?? "pairing", + setPolicy: (cfg, policy) => + setLegacyChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, }), - resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - const token = - resolveDiscordAccount({ cfg, accountId }).token || - (typeof credentialValues.token === "string" ? credentialValues.token : ""); - let resolved: DiscordChannelResolution[] = entries.map((input) => ({ - input, - resolved: false, - })); - if (!token || entries.length === 0) { - return resolved; - } - try { - resolved = await resolveDiscordChannelAllowlist({ - token, - entries, - }); - const resolvedChannels = resolved.filter((entry) => entry.resolved && entry.channelId); - const resolvedGuilds = resolved.filter( - (entry) => entry.resolved && entry.guildId && !entry.channelId, - ); - const unresolved = resolved.filter((entry) => !entry.resolved).map((entry) => entry.input); - await noteChannelLookupSummary({ - prompter, - label: "Discord channels", - resolvedSections: [ - { - title: "Resolved channels", - values: resolvedChannels - .map((entry) => entry.channelId) - .filter((value): value is string => Boolean(value)), - }, - { - title: "Resolved guilds", - values: resolvedGuilds - .map((entry) => entry.guildId) - .filter((value): value is string => Boolean(value)), - }, - ], - unresolved, - }); - } catch (error) { - await noteChannelLookupFailure({ - prompter, - label: "Discord channels", - error, - }); - } - return resolved; + promptAllowFrom: promptDiscordAllowFrom, +}; + +export const discordSetupWizard: ChannelSetupWizard = { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs token", + configuredHint: "configured", + unconfiguredHint: "needs token", + configuredScore: 2, + unconfiguredScore: 1, + resolveConfigured: ({ cfg }) => + listDiscordAccountIds(cfg).some( + (accountId) => inspectDiscordAccount({ cfg, accountId }).configured, + ), }, -}); + credentials: [ + { + inputKey: "token", + providerHint: channel, + credentialLabel: "Discord bot token", + preferredEnvVar: "DISCORD_BOT_TOKEN", + helpTitle: "Discord bot token", + helpLines: DISCORD_TOKEN_HELP_LINES, + envPrompt: "DISCORD_BOT_TOKEN detected. Use env var?", + keepPrompt: "Discord token already configured. Keep it?", + inputPrompt: "Enter Discord bot token", + allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }) => { + const account = inspectDiscordAccount({ cfg, accountId }); + return { + accountConfigured: account.configured, + hasConfiguredValue: account.tokenStatus !== "missing", + resolvedValue: account.token?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID + ? process.env.DISCORD_BOT_TOKEN?.trim() || undefined + : undefined, + }; + }, + }, + ], + groupAccess: { + label: "Discord channels", + placeholder: "My Server/#general, guildId/channelId, #support", + currentPolicy: ({ cfg, accountId }) => + resolveDiscordAccount({ cfg, accountId }).config.groupPolicy ?? "allowlist", + currentEntries: ({ cfg, accountId }) => + Object.entries(resolveDiscordAccount({ cfg, accountId }).config.guilds ?? {}).flatMap( + ([guildKey, value]) => { + const channels = value?.channels ?? {}; + const channelKeys = Object.keys(channels); + if (channelKeys.length === 0) { + const input = /^\d+$/.test(guildKey) ? `guild:${guildKey}` : guildKey; + return [input]; + } + return channelKeys.map((channelKey) => `${guildKey}/${channelKey}`); + }, + ), + updatePrompt: ({ cfg, accountId }) => + Boolean(resolveDiscordAccount({ cfg, accountId }).config.guilds), + setPolicy: ({ cfg, accountId, policy }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { groupPolicy: policy }, + }), + resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { + const token = + resolveDiscordAccount({ cfg, accountId }).token || + (typeof credentialValues.token === "string" ? credentialValues.token : ""); + let resolved: DiscordChannelResolution[] = entries.map((input) => ({ + input, + resolved: false, + })); + if (!token || entries.length === 0) { + return resolved; + } + try { + resolved = await resolveDiscordChannelAllowlist({ + token, + entries, + }); + const resolvedChannels = resolved.filter((entry) => entry.resolved && entry.channelId); + const resolvedGuilds = resolved.filter( + (entry) => entry.resolved && entry.guildId && !entry.channelId, + ); + const unresolved = resolved.filter((entry) => !entry.resolved).map((entry) => entry.input); + await noteChannelLookupSummary({ + prompter, + label: "Discord channels", + resolvedSections: [ + { + title: "Resolved channels", + values: resolvedChannels + .map((entry) => entry.channelId) + .filter((value): value is string => Boolean(value)), + }, + { + title: "Resolved guilds", + values: resolvedGuilds + .map((entry) => entry.guildId) + .filter((value): value is string => Boolean(value)), + }, + ], + unresolved, + }); + } catch (error) { + await noteChannelLookupFailure({ + prompter, + label: "Discord channels", + error, + }); + } + return resolved; + }, + applyAllowlist: ({ cfg, accountId, resolved }) => { + const allowlistEntries: Array<{ guildKey: string; channelKey?: string }> = []; + for (const entry of resolved as DiscordChannelResolution[]) { + const guildKey = + entry.guildId ?? + (entry.guildName ? normalizeDiscordSlug(entry.guildName) : undefined) ?? + "*"; + const channelKey = + entry.channelId ?? + (entry.channelName ? normalizeDiscordSlug(entry.channelName) : undefined); + if (!channelKey && guildKey === "*") { + continue; + } + allowlistEntries.push({ guildKey, ...(channelKey ? { channelKey } : {}) }); + } + return setDiscordGuildChannelAllowlist(cfg, accountId, allowlistEntries); + }, + }, + allowFrom: { + credentialInputKey: "token", + helpTitle: "Discord allowlist", + helpLines: [ + "Allowlist Discord DMs by username (we resolve to user ids).", + "Examples:", + "- 123456789012345678", + "- @alice", + "- alice#1234", + "Multiple entries: comma-separated.", + `Docs: ${formatDocsLink("/discord", "discord")}`, + ], + message: "Discord allowFrom (usernames or ids)", + placeholder: "@alice, 123456789012345678", + invalidWithoutCredentialNote: "Bot token missing; use numeric user ids (or mention form) only.", + parseId: parseDiscordAllowFromId, + resolveEntries: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordAllowFromEntries({ + token: + resolveDiscordAccount({ cfg, accountId }).token || + (typeof credentialValues.token === "string" ? credentialValues.token : ""), + entries, + }), + apply: async ({ cfg, accountId, allowFrom }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { dmPolicy: "allowlist", allowFrom }, + }), + }, + dmPolicy: discordDmPolicy, + disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), +}; diff --git a/extensions/discord/src/shared-interactive.ts b/extensions/discord/src/shared-interactive.ts index d99f964f5c9..bb8bf1dac70 100644 --- a/extensions/discord/src/shared-interactive.ts +++ b/extensions/discord/src/shared-interactive.ts @@ -1,5 +1,5 @@ -import { reduceInteractiveReply } from "../../../src/channels/plugins/outbound/interactive.js"; -import type { InteractiveButtonStyle, InteractiveReply } from "../../../src/interactive/payload.js"; +import { reduceInteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; +import type { InteractiveButtonStyle, InteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; import type { DiscordComponentButtonStyle, DiscordComponentMessageSpec } from "./components.js"; function resolveDiscordInteractiveButtonStyle( diff --git a/extensions/discord/src/status-issues.ts b/extensions/discord/src/status-issues.ts index baf2551c0f8..4fa26fd011b 100644 --- a/extensions/discord/src/status-issues.ts +++ b/extensions/discord/src/status-issues.ts @@ -3,11 +3,11 @@ import { asString, isRecord, resolveEnabledConfiguredAccountId, -} from "../../../src/channels/plugins/status-issues/shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelAccountSnapshot, ChannelStatusIssue, -} from "../../../src/channels/plugins/types.js"; +} from "openclaw/plugin-sdk/channel-runtime"; type DiscordIntentSummary = { messageContent?: "enabled" | "limited" | "disabled"; diff --git a/extensions/discord/src/subagent-hooks.ts b/extensions/discord/src/subagent-hooks.ts index fa45eadd7c2..c9ba7b97984 100644 --- a/extensions/discord/src/subagent-hooks.ts +++ b/extensions/discord/src/subagent-hooks.ts @@ -1,4 +1,4 @@ -import type { OpenClawPluginApi } from "../../../src/plugin-sdk-internal/core.js"; +import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { resolveDiscordAccount } from "./accounts.js"; import { autoBindSpawnedDiscordSubagent, diff --git a/extensions/discord/src/targets.ts b/extensions/discord/src/targets.ts index 198660dceff..3660f75921e 100644 --- a/extensions/discord/src/targets.ts +++ b/extensions/discord/src/targets.ts @@ -1,4 +1,4 @@ -import type { DirectoryConfigParams } from "../../../src/channels/plugins/directory-config.js"; +import type { DirectoryConfigParams } from "openclaw/plugin-sdk/channel-runtime"; import { buildMessagingTarget, parseMentionPrefixOrAtUserTarget, @@ -6,7 +6,7 @@ import { type MessagingTarget, type MessagingTargetKind, type MessagingTargetParseOptions, -} from "../../../src/channels/targets.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import { rememberDiscordDirectoryUser } from "./directory-cache.js"; import { listDiscordDirectoryPeersLive } from "./directory-live.js"; diff --git a/extensions/discord/src/token.ts b/extensions/discord/src/token.ts index aff802f3ded..2a979ca4b3b 100644 --- a/extensions/discord/src/token.ts +++ b/extensions/discord/src/token.ts @@ -1,7 +1,7 @@ -import type { BaseTokenResolution } from "../../../src/channels/plugins/types.core.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { normalizeResolvedSecretInputString } from "../../../src/config/types.secrets.js"; -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; +import type { BaseTokenResolution } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/config-runtime"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/routing"; export type DiscordTokenSource = "env" | "config" | "none"; diff --git a/extensions/discord/src/ui.ts b/extensions/discord/src/ui.ts index ed4cc9d4fa6..50f818f1471 100644 --- a/extensions/discord/src/ui.ts +++ b/extensions/discord/src/ui.ts @@ -1,5 +1,5 @@ import { Container } from "@buape/carbon"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { inspectDiscordAccount } from "./account-inspect.js"; const DEFAULT_DISCORD_ACCENT_COLOR = "#5865F2"; diff --git a/extensions/discord/src/voice-message.ts b/extensions/discord/src/voice-message.ts index 6f77ebc7bd9..ea014f5f59e 100644 --- a/extensions/discord/src/voice-message.ts +++ b/extensions/discord/src/voice-message.ts @@ -14,15 +14,15 @@ import crypto from "node:crypto"; import fs from "node:fs/promises"; import path from "node:path"; import { RateLimitError, type RequestClient } from "@buape/carbon"; -import type { RetryRunner } from "../../../src/infra/retry-policy.js"; -import { resolvePreferredOpenClawTmpDir } from "../../../src/infra/tmp-openclaw-dir.js"; +import type { RetryRunner } from "openclaw/plugin-sdk/infra-runtime"; +import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime"; import { parseFfprobeCodecAndSampleRate, runFfmpeg, runFfprobe, -} from "../../../src/media/ffmpeg-exec.js"; -import { MEDIA_FFMPEG_MAX_AUDIO_DURATION_SECS } from "../../../src/media/ffmpeg-limits.js"; -import { unlinkIfExists } from "../../../src/media/temp-files.js"; +} from "openclaw/plugin-sdk/media-runtime"; +import { MEDIA_FFMPEG_MAX_AUDIO_DURATION_SECS } from "openclaw/plugin-sdk/media-runtime"; +import { unlinkIfExists } from "openclaw/plugin-sdk/media-runtime"; const DISCORD_VOICE_MESSAGE_FLAG = 1 << 13; const SUPPRESS_NOTIFICATIONS_FLAG = 1 << 12; diff --git a/extensions/discord/src/voice/command.ts b/extensions/discord/src/voice/command.ts index 26ef7b9bbe5..3ed7aa2ccdb 100644 --- a/extensions/discord/src/voice/command.ts +++ b/extensions/discord/src/voice/command.ts @@ -10,10 +10,10 @@ import { ChannelType as DiscordChannelType, type APIApplicationCommandChannelOption, } from "discord-api-types/v10"; -import { resolveCommandAuthorizedFromAuthorizers } from "../../../../src/channels/command-gating.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import type { DiscordAccountConfig } from "../../../../src/config/types.js"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordAccountConfig } from "openclaw/plugin-sdk/config-runtime"; import { formatMention } from "../mentions.js"; import { isDiscordGroupAllowedByPolicy, diff --git a/extensions/discord/src/voice/manager.ts b/extensions/discord/src/voice/manager.ts index a9f8d0fd721..c2fbcbfc686 100644 --- a/extensions/discord/src/voice/manager.ts +++ b/extensions/discord/src/voice/manager.ts @@ -16,20 +16,30 @@ import { type AudioPlayer, type VoiceConnection, } from "@discordjs/voice"; -import { resolveAgentDir } from "../../../../src/agents/agent-scope.js"; -import { agentCommandFromIngress } from "../../../../src/commands/agent.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; -import type { DiscordAccountConfig, TtsConfig } from "../../../../src/config/types.js"; -import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import { resolvePreferredOpenClawTmpDir } from "../../../../src/infra/tmp-openclaw-dir.js"; -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { transcribeAudioFile } from "../../../../src/media-understanding/runtime.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; -import { parseTtsDirectives } from "../../../../src/tts/tts-core.js"; -import { resolveTtsConfig, textToSpeech, type ResolvedTtsConfig } from "../../../../src/tts/tts.js"; +import { resolveAgentDir } from "openclaw/plugin-sdk/agent-runtime"; +import { agentCommandFromIngress } from "openclaw/plugin-sdk/agent-runtime"; +import { + resolveTtsConfig, + textToSpeech, + type ResolvedTtsConfig, +} from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordAccountConfig, TtsConfig } from "openclaw/plugin-sdk/config-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime"; +import { + buildProviderRegistry, + createMediaAttachmentCache, + normalizeMediaAttachments, + runCapability, +} from "openclaw/plugin-sdk/media-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { parseTtsDirectives } from "openclaw/plugin-sdk/speech"; import { formatMention } from "../mentions.js"; import { resolveDiscordOwnerAccess } from "../monitor/allow-list.js"; import { formatDiscordUserTag } from "../monitor/format.js"; @@ -230,13 +240,33 @@ async function transcribeAudio(params: { agentId: string; filePath: string; }): Promise { - const result = await transcribeAudioFile({ - cfg: params.cfg, - filePath: params.filePath, - mime: "audio/wav", - agentDir: resolveAgentDir(params.cfg, params.agentId), - }); - return result.text?.trim() || undefined; + const ctx: MsgContext = { + MediaPath: params.filePath, + MediaType: "audio/wav", + }; + const attachments = normalizeMediaAttachments(ctx); + if (attachments.length === 0) { + return undefined; + } + const cache = createMediaAttachmentCache(attachments); + const providerRegistry = buildProviderRegistry(); + try { + const result = await runCapability({ + capability: "audio", + cfg: params.cfg, + ctx, + attachments: cache, + media: attachments, + agentDir: resolveAgentDir(params.cfg, params.agentId), + providerRegistry, + config: params.cfg.tools?.media?.audio, + }); + const output = result.outputs.find((entry) => entry.kind === "audio.transcription"); + const text = output?.text?.trim(); + return text || undefined; + } finally { + await cache.cleanup(); + } } export class DiscordVoiceManager { diff --git a/extensions/elevenlabs/index.ts b/extensions/elevenlabs/index.ts index 49d792df20f..034c56815c3 100644 --- a/extensions/elevenlabs/index.ts +++ b/extensions/elevenlabs/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { buildElevenLabsSpeechProvider } from "../../src/tts/providers/elevenlabs.js"; +import { buildElevenLabsSpeechProvider } from "openclaw/plugin-sdk/speech"; const elevenLabsPlugin = { id: "elevenlabs", diff --git a/extensions/feishu/src/bot.ts b/extensions/feishu/src/bot.ts index 728bb9a8ffc..6181d32f4af 100644 --- a/extensions/feishu/src/bot.ts +++ b/extensions/feishu/src/bot.ts @@ -1,3 +1,8 @@ +import { + ensureConfiguredAcpRouteReady, + resolveConfiguredAcpRoute, +} from "openclaw/plugin-sdk/conversation-runtime"; +import { getSessionBindingService } from "openclaw/plugin-sdk/conversation-runtime"; import type { ClawdbotConfig, RuntimeEnv } from "openclaw/plugin-sdk/feishu"; import { buildAgentMediaPayload, @@ -14,13 +19,8 @@ import { resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, } from "openclaw/plugin-sdk/feishu"; -import { - ensureConfiguredAcpRouteReady, - resolveConfiguredAcpRoute, -} from "../../../src/acp/persistent-bindings.route.js"; -import { getSessionBindingService } from "../../../src/infra/outbound/session-binding-service.js"; -import { deriveLastRoutePolicy } from "../../../src/routing/resolve-route.js"; -import { resolveAgentIdFromSessionKey } from "../../../src/routing/session-key.js"; +import { deriveLastRoutePolicy } from "openclaw/plugin-sdk/routing"; +import { resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; import { resolveFeishuAccount } from "./accounts.js"; import { createFeishuClient } from "./client.js"; import { buildFeishuConversationId } from "./conversation-id.js"; diff --git a/extensions/feishu/src/media.ts b/extensions/feishu/src/media.ts index b7888b7069e..617bc504756 100644 --- a/extensions/feishu/src/media.ts +++ b/extensions/feishu/src/media.ts @@ -2,7 +2,7 @@ import fs from "fs"; import path from "path"; import { Readable } from "stream"; import { withTempDownloadPath, type ClawdbotConfig } from "openclaw/plugin-sdk/feishu"; -import { mediaKindFromMime } from "../../../src/media/constants.js"; +import { mediaKindFromMime } from "openclaw/plugin-sdk/media-runtime"; import { resolveFeishuAccount } from "./accounts.js"; import { createFeishuClient } from "./client.js"; import { normalizeFeishuExternalKey } from "./external-keys.js"; diff --git a/extensions/feishu/src/thread-bindings.ts b/extensions/feishu/src/thread-bindings.ts index b2ab72467c3..cfae8fb2058 100644 --- a/extensions/feishu/src/thread-bindings.ts +++ b/extensions/feishu/src/thread-bindings.ts @@ -1,20 +1,17 @@ -import { resolveThreadBindingConversationIdFromBindingId } from "../../../src/channels/thread-binding-id.js"; +import { resolveThreadBindingConversationIdFromBindingId } from "openclaw/plugin-sdk/channel-runtime"; import { resolveThreadBindingIdleTimeoutMsForChannel, resolveThreadBindingMaxAgeMsForChannel, -} from "../../../src/channels/thread-bindings-policy.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { registerSessionBindingAdapter, unregisterSessionBindingAdapter, type BindingTargetKind, type SessionBindingRecord, -} from "../../../src/infra/outbound/session-binding-service.js"; -import { - normalizeAccountId, - resolveAgentIdFromSessionKey, -} from "../../../src/routing/session-key.js"; -import { resolveGlobalSingleton } from "../../../src/shared/global-singleton.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { normalizeAccountId, resolveAgentIdFromSessionKey } from "openclaw/plugin-sdk/routing"; +import { resolveGlobalSingleton } from "openclaw/plugin-sdk/text-runtime"; type FeishuBindingTargetKind = "subagent" | "acp"; diff --git a/extensions/firecrawl/index.ts b/extensions/firecrawl/index.ts index 42bd1a3252f..6b38ac6dc75 100644 --- a/extensions/firecrawl/index.ts +++ b/extensions/firecrawl/index.ts @@ -1,6 +1,8 @@ -import type { AnyAgentTool } from "../../src/agents/tools/common.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +import { + emptyPluginConfigSchema, + type AnyAgentTool, + type OpenClawPluginApi, +} from "openclaw/plugin-sdk/core"; import { createFirecrawlScrapeTool } from "./src/firecrawl-scrape-tool.js"; import { createFirecrawlWebSearchProvider } from "./src/firecrawl-search-provider.js"; import { createFirecrawlSearchTool } from "./src/firecrawl-search-tool.js"; diff --git a/extensions/firecrawl/src/config.ts b/extensions/firecrawl/src/config.ts index 808b81891f1..5558c0dce0a 100644 --- a/extensions/firecrawl/src/config.ts +++ b/extensions/firecrawl/src/config.ts @@ -1,6 +1,6 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { normalizeResolvedSecretInputString } from "../../../src/config/types.secrets.js"; -import { normalizeSecretInput } from "../../../src/utils/normalize-secret-input.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeSecretInput } from "openclaw/plugin-sdk/provider-auth"; export const DEFAULT_FIRECRAWL_BASE_URL = "https://api.firecrawl.dev"; export const DEFAULT_FIRECRAWL_SEARCH_TIMEOUT_SECONDS = 30; diff --git a/extensions/firecrawl/src/firecrawl-client.ts b/extensions/firecrawl/src/firecrawl-client.ts index 2929f2f9dde..18500d81c14 100644 --- a/extensions/firecrawl/src/firecrawl-client.ts +++ b/extensions/firecrawl/src/firecrawl-client.ts @@ -1,5 +1,6 @@ -import { markdownToText, truncateText } from "../../../src/agents/tools/web-fetch-utils.js"; -import { withTrustedWebToolsEndpoint } from "../../../src/agents/tools/web-guarded-fetch.js"; +import { markdownToText, truncateText } from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { withTrustedWebToolsEndpoint } from "openclaw/plugin-sdk/provider-web-search"; import { DEFAULT_CACHE_TTL_MINUTES, normalizeCacheKey, @@ -7,9 +8,8 @@ import { readResponseText, resolveCacheTtlMs, writeCache, -} from "../../../src/agents/tools/web-shared.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { wrapExternalContent, wrapWebContent } from "../../../src/security/external-content.js"; +} from "openclaw/plugin-sdk/provider-web-search"; +import { wrapExternalContent, wrapWebContent } from "openclaw/plugin-sdk/security-runtime"; import { resolveFirecrawlApiKey, resolveFirecrawlBaseUrl, diff --git a/extensions/firecrawl/src/firecrawl-scrape-tool.ts b/extensions/firecrawl/src/firecrawl-scrape-tool.ts index 509b3d5fbd6..70f0691d3d7 100644 --- a/extensions/firecrawl/src/firecrawl-scrape-tool.ts +++ b/extensions/firecrawl/src/firecrawl-scrape-tool.ts @@ -1,7 +1,7 @@ import { Type } from "@sinclair/typebox"; -import { optionalStringEnum } from "../../../src/agents/schema/typebox.js"; -import { jsonResult, readNumberParam, readStringParam } from "../../../src/agents/tools/common.js"; -import type { OpenClawPluginApi } from "../../../src/plugins/types.js"; +import { optionalStringEnum } from "openclaw/plugin-sdk/agent-runtime"; +import { jsonResult, readNumberParam, readStringParam } from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime"; import { runFirecrawlScrape } from "./firecrawl-client.js"; const FirecrawlScrapeToolSchema = Type.Object( diff --git a/extensions/firecrawl/src/firecrawl-search-provider.ts b/extensions/firecrawl/src/firecrawl-search-provider.ts index 60489e9618e..0940aedb74d 100644 --- a/extensions/firecrawl/src/firecrawl-search-provider.ts +++ b/extensions/firecrawl/src/firecrawl-search-provider.ts @@ -1,5 +1,5 @@ import { Type } from "@sinclair/typebox"; -import type { WebSearchProviderPlugin } from "../../../src/plugins/types.js"; +import type { WebSearchProviderPlugin } from "openclaw/plugin-sdk/plugin-runtime"; import { runFirecrawlSearch } from "./firecrawl-client.js"; const GenericFirecrawlSearchSchema = Type.Object( diff --git a/extensions/firecrawl/src/firecrawl-search-tool.ts b/extensions/firecrawl/src/firecrawl-search-tool.ts index f2f133fd7ec..9a1201ec6e0 100644 --- a/extensions/firecrawl/src/firecrawl-search-tool.ts +++ b/extensions/firecrawl/src/firecrawl-search-tool.ts @@ -4,8 +4,8 @@ import { readNumberParam, readStringArrayParam, readStringParam, -} from "../../../src/agents/tools/common.js"; -import type { OpenClawPluginApi } from "../../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime"; import { runFirecrawlSearch } from "./firecrawl-client.js"; const FirecrawlSearchToolSchema = Type.Object( diff --git a/extensions/github-copilot/index.ts b/extensions/github-copilot/index.ts index 8dadad31903..45f964c60f0 100644 --- a/extensions/github-copilot/index.ts +++ b/extensions/github-copilot/index.ts @@ -5,11 +5,13 @@ import { type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { listProfilesForProvider } from "../../src/agents/auth-profiles/profiles.js"; -import { ensureAuthProfileStore } from "../../src/agents/auth-profiles/store.js"; -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { coerceSecretRef } from "../../src/config/types.secrets.js"; -import { githubCopilotLoginCommand } from "../../src/providers/github-copilot-auth.js"; +import { + coerceSecretRef, + ensureAuthProfileStore, + githubCopilotLoginCommand, + listProfilesForProvider, +} from "openclaw/plugin-sdk/provider-auth"; +import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; import { DEFAULT_COPILOT_API_BASE_URL, resolveCopilotApiToken } from "./token.js"; import { fetchCopilotUsage } from "./usage.js"; diff --git a/extensions/github-copilot/token.ts b/extensions/github-copilot/token.ts index afb1eb03b61..f743cf8bb88 100644 --- a/extensions/github-copilot/token.ts +++ b/extensions/github-copilot/token.ts @@ -1,6 +1,6 @@ import path from "node:path"; -import { resolveStateDir } from "../../src/config/paths.js"; -import { loadJsonFile, saveJsonFile } from "../../src/infra/json-file.js"; +import { loadJsonFile, saveJsonFile } from "openclaw/plugin-sdk/json-store"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; const COPILOT_TOKEN_URL = "https://api.github.com/copilot_internal/v2/token"; diff --git a/extensions/github-copilot/usage.ts b/extensions/github-copilot/usage.ts index 9035027890c..1e13717c9ea 100644 --- a/extensions/github-copilot/usage.ts +++ b/extensions/github-copilot/usage.ts @@ -1,9 +1,11 @@ import { buildUsageHttpErrorSnapshot, fetchJson, -} from "../../src/infra/provider-usage.fetch.shared.js"; -import { clampPercent, PROVIDER_LABELS } from "../../src/infra/provider-usage.shared.js"; -import type { ProviderUsageSnapshot, UsageWindow } from "../../src/infra/provider-usage.types.js"; + clampPercent, + PROVIDER_LABELS, + type ProviderUsageSnapshot, + type UsageWindow, +} from "openclaw/plugin-sdk/provider-usage"; type CopilotUsageResponse = { quota_snapshots?: { diff --git a/extensions/google/gemini-cli-provider.ts b/extensions/google/gemini-cli-provider.ts index e235a0dfebc..6db7561a10b 100644 --- a/extensions/google/gemini-cli-provider.ts +++ b/extensions/google/gemini-cli-provider.ts @@ -1,10 +1,10 @@ import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/core"; -import { fetchGeminiUsage } from "../../src/infra/provider-usage.fetch.js"; import type { OpenClawPluginApi, ProviderAuthContext, ProviderFetchUsageSnapshotContext, -} from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/core"; +import { fetchGeminiUsage } from "openclaw/plugin-sdk/provider-usage"; import { loginGeminiCliOAuth } from "./oauth.js"; import { isModernGoogleModel, resolveGoogle31ForwardCompatModel } from "./provider-models.js"; diff --git a/extensions/google/index.ts b/extensions/google/index.ts index 6389dd25e48..d310d8183a9 100644 --- a/extensions/google/index.ts +++ b/extensions/google/index.ts @@ -1,15 +1,14 @@ +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { + GOOGLE_GEMINI_DEFAULT_MODEL, + applyGoogleGeminiModelDefault, +} from "openclaw/plugin-sdk/provider-models"; import { createPluginBackedWebSearchProvider, getScopedCredentialValue, setScopedCredentialValue, -} from "../../src/agents/tools/web-search-plugin-factory.js"; -import { - GOOGLE_GEMINI_DEFAULT_MODEL, - applyGoogleGeminiModelDefault, -} from "../../src/commands/google-gemini-model-default.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/provider-web-search"; import { registerGoogleGeminiCliProvider } from "./gemini-cli-provider.js"; import { googleMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { isModernGoogleModel, resolveGoogle31ForwardCompatModel } from "./provider-models.js"; diff --git a/extensions/google/oauth.flow.ts b/extensions/google/oauth.flow.ts index 00cab07dc68..1ac7f260723 100644 --- a/extensions/google/oauth.flow.ts +++ b/extensions/google/oauth.flow.ts @@ -1,6 +1,6 @@ import { createHash, randomBytes } from "node:crypto"; import { createServer } from "node:http"; -import { isWSL2Sync } from "../../src/infra/wsl.js"; +import { isWSL2Sync } from "openclaw/plugin-sdk/infra-runtime"; import { resolveOAuthClientConfig } from "./oauth.credentials.js"; import { AUTH_URL, REDIRECT_URI, SCOPES } from "./oauth.shared.js"; diff --git a/extensions/google/oauth.http.ts b/extensions/google/oauth.http.ts index 6c07c447143..3dcbd086b1c 100644 --- a/extensions/google/oauth.http.ts +++ b/extensions/google/oauth.http.ts @@ -1,4 +1,4 @@ -import { fetchWithSsrFGuard } from "../../src/infra/net/fetch-guard.js"; +import { fetchWithSsrFGuard } from "openclaw/plugin-sdk/infra-runtime"; import { DEFAULT_FETCH_TIMEOUT_MS } from "./oauth.shared.js"; export async function fetchWithTimeout( diff --git a/extensions/google/provider-models.ts b/extensions/google/provider-models.ts index 0a086780b1a..eddda4a9f9a 100644 --- a/extensions/google/provider-models.ts +++ b/extensions/google/provider-models.ts @@ -1,8 +1,8 @@ -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, -} from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/core"; +import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; const GEMINI_3_1_PRO_PREFIX = "gemini-3.1-pro"; const GEMINI_3_1_FLASH_PREFIX = "gemini-3.1-flash"; diff --git a/extensions/huggingface/index.ts b/extensions/huggingface/index.ts index 433223bf268..c0c65f0051b 100644 --- a/extensions/huggingface/index.ts +++ b/extensions/huggingface/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyHuggingfaceConfig, HUGGINGFACE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildHuggingfaceProvider } from "./provider-catalog.js"; diff --git a/extensions/huggingface/onboard.ts b/extensions/huggingface/onboard.ts index 22493f87f0b..40df946abe3 100644 --- a/extensions/huggingface/onboard.ts +++ b/extensions/huggingface/onboard.ts @@ -2,12 +2,12 @@ import { buildHuggingfaceModelDefinition, HUGGINGFACE_BASE_URL, HUGGINGFACE_MODEL_CATALOG, -} from "../../src/agents/huggingface-models.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export const HUGGINGFACE_DEFAULT_MODEL_REF = "huggingface/deepseek-ai/DeepSeek-R1"; diff --git a/extensions/huggingface/provider-catalog.ts b/extensions/huggingface/provider-catalog.ts index 5dc87b751df..502a94f2a9e 100644 --- a/extensions/huggingface/provider-catalog.ts +++ b/extensions/huggingface/provider-catalog.ts @@ -1,10 +1,10 @@ import { buildHuggingfaceModelDefinition, discoverHuggingfaceModels, + type ModelProviderConfig, HUGGINGFACE_BASE_URL, HUGGINGFACE_MODEL_CATALOG, -} from "../../src/agents/huggingface-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +} from "openclaw/plugin-sdk/provider-models"; export async function buildHuggingfaceProvider( discoveryApiKey?: string, diff --git a/extensions/imessage/src/accounts.ts b/extensions/imessage/src/accounts.ts index 67ffb5e6865..5ee90339aa8 100644 --- a/extensions/imessage/src/accounts.ts +++ b/extensions/imessage/src/accounts.ts @@ -1,10 +1,10 @@ import { - type OpenClawConfig, createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; -import type { IMessageAccountConfig } from "../../../src/plugin-sdk-internal/imessage.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { IMessageAccountConfig } from "openclaw/plugin-sdk/imessage"; export type ResolvedIMessageAccount = { accountId: string; diff --git a/extensions/imessage/src/channel.setup.ts b/extensions/imessage/src/channel.setup.ts index 5587914a0ce..0590eba9356 100644 --- a/extensions/imessage/src/channel.setup.ts +++ b/extensions/imessage/src/channel.setup.ts @@ -1,11 +1,94 @@ -import { type ChannelPlugin } from "openclaw/plugin-sdk/imessage"; -import { type ResolvedIMessageAccount } from "./accounts.js"; +import { + buildAccountScopedDmSecurityPolicy, + collectAllowlistProviderRestrictSendersWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, + deleteAccountFromConfigSection, + formatTrimmedAllowFromEntries, + getChatChannelMeta, + IMessageConfigSchema, + resolveIMessageConfigAllowFrom, + resolveIMessageConfigDefaultTo, + setAccountEnabledInConfigSection, + type ChannelPlugin, +} from "openclaw/plugin-sdk/imessage"; +import { + listIMessageAccountIds, + resolveDefaultIMessageAccountId, + resolveIMessageAccount, + type ResolvedIMessageAccount, +} from "./accounts.js"; +import { imessageSetupWizard } from "./plugin-shared.js"; import { imessageSetupAdapter } from "./setup-core.js"; -import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; -export const imessageSetupPlugin: ChannelPlugin = createIMessagePluginBase( - { - setupWizard: imessageSetupWizard, - setup: imessageSetupAdapter, +export const imessageSetupPlugin: ChannelPlugin = { + id: "imessage", + meta: { + ...getChatChannelMeta("imessage"), + aliases: ["imsg"], + showConfigured: false, }, -); + setupWizard: imessageSetupWizard, + capabilities: { + chatTypes: ["direct", "group"], + media: true, + }, + reload: { configPrefixes: ["channels.imessage"] }, + configSchema: buildChannelConfigSchema(IMessageConfigSchema), + config: { + listAccountIds: (cfg) => listIMessageAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveIMessageAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultIMessageAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => + setAccountEnabledInConfigSection({ + cfg, + sectionKey: "imessage", + accountId, + enabled, + allowTopLevel: true, + }), + deleteAccount: ({ cfg, accountId }) => + deleteAccountFromConfigSection({ + cfg, + sectionKey: "imessage", + accountId, + clearBaseFields: ["cliPath", "dbPath", "service", "region", "name"], + }), + isConfigured: (account) => account.configured, + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: account.configured, + }), + resolveAllowFrom: ({ cfg, accountId }) => resolveIMessageConfigAllowFrom({ cfg, accountId }), + formatAllowFrom: ({ allowFrom }) => formatTrimmedAllowFromEntries(allowFrom), + resolveDefaultTo: ({ cfg, accountId }) => resolveIMessageConfigDefaultTo({ cfg, accountId }), + }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => + buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "imessage", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.config.dmPolicy, + allowFrom: account.config.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + }), + collectWarnings: ({ account, cfg }) => + collectAllowlistProviderRestrictSendersWarnings({ + cfg, + providerConfigPresent: cfg.channels?.imessage !== undefined, + configuredGroupPolicy: account.config.groupPolicy, + surface: "iMessage groups", + openScope: "any member", + groupPolicyPath: "channels.imessage.groupPolicy", + groupAllowFromPath: "channels.imessage.groupAllowFrom", + mentionGated: false, + }), + }, + setup: imessageSetupAdapter, +}; diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index 95cac7d1123..5e3d48817a0 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -1,25 +1,43 @@ -import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/compat"; +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; +import { + buildAccountScopedDmSecurityPolicy, + collectAllowlistProviderRestrictSendersWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; import { + buildChannelConfigSchema, collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, + deleteAccountFromConfigSection, formatTrimmedAllowFromEntries, + getChatChannelMeta, + IMessageConfigSchema, looksLikeIMessageTargetId, normalizeIMessageMessagingTarget, PAIRING_APPROVED_MESSAGE, resolveChannelMediaMaxBytes, + resolveIMessageConfigAllowFrom, + resolveIMessageConfigDefaultTo, resolveIMessageGroupRequireMention, resolveIMessageGroupToolPolicy, + setAccountEnabledInConfigSection, type ChannelPlugin, } from "openclaw/plugin-sdk/imessage"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; -import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; +import { + listIMessageAccountIds, + resolveDefaultIMessageAccountId, + resolveIMessageAccount, + type ResolvedIMessageAccount, +} from "./accounts.js"; +import { imessageSetupWizard } from "./plugin-shared.js"; import { getIMessageRuntime } from "./runtime.js"; import { imessageSetupAdapter } from "./setup-core.js"; -import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; import { normalizeIMessageHandle, parseIMessageTarget } from "./targets.js"; +const meta = getChatChannelMeta("imessage"); + type IMessageSendFn = ReturnType< typeof getIMessageRuntime >["channel"]["imessage"]["sendMessageIMessage"]; @@ -132,16 +150,55 @@ function resolveIMessageOutboundSessionRoute(params: { } export const imessagePlugin: ChannelPlugin = { - ...createIMessagePluginBase({ - setupWizard: imessageSetupWizard, - setup: imessageSetupAdapter, - }), + id: "imessage", + meta: { + ...meta, + aliases: ["imsg"], + showConfigured: false, + }, + setupWizard: imessageSetupWizard, pairing: { idLabel: "imessageSenderId", notifyApproval: async ({ id }) => { await getIMessageRuntime().channel.imessage.sendMessageIMessage(id, PAIRING_APPROVED_MESSAGE); }, }, + capabilities: { + chatTypes: ["direct", "group"], + media: true, + }, + reload: { configPrefixes: ["channels.imessage"] }, + configSchema: buildChannelConfigSchema(IMessageConfigSchema), + config: { + listAccountIds: (cfg) => listIMessageAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveIMessageAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultIMessageAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => + setAccountEnabledInConfigSection({ + cfg, + sectionKey: "imessage", + accountId, + enabled, + allowTopLevel: true, + }), + deleteAccount: ({ cfg, accountId }) => + deleteAccountFromConfigSection({ + cfg, + sectionKey: "imessage", + accountId, + clearBaseFields: ["cliPath", "dbPath", "service", "region", "name"], + }), + isConfigured: (account) => account.configured, + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: account.configured, + }), + resolveAllowFrom: ({ cfg, accountId }) => resolveIMessageConfigAllowFrom({ cfg, accountId }), + formatAllowFrom: ({ allowFrom }) => formatTrimmedAllowFromEntries(allowFrom), + resolveDefaultTo: ({ cfg, accountId }) => resolveIMessageConfigDefaultTo({ cfg, accountId }), + }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { @@ -162,6 +219,31 @@ export const imessagePlugin: ChannelPlugin = { }), }), }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => { + return buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "imessage", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.config.dmPolicy, + allowFrom: account.config.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + }); + }, + collectWarnings: ({ account, cfg }) => { + return collectAllowlistProviderRestrictSendersWarnings({ + cfg, + providerConfigPresent: cfg.channels?.imessage !== undefined, + configuredGroupPolicy: account.config.groupPolicy, + surface: "iMessage groups", + openScope: "any member", + groupPolicyPath: "channels.imessage.groupPolicy", + groupAllowFromPath: "channels.imessage.groupAllowFrom", + mentionGated: false, + }); + }, + }, groups: { resolveRequireMention: resolveIMessageGroupRequireMention, resolveToolPolicy: resolveIMessageGroupToolPolicy, @@ -174,6 +256,7 @@ export const imessagePlugin: ChannelPlugin = { hint: "", }, }, + setup: imessageSetupAdapter, outbound: { deliveryMode: "direct", chunker: (text, limit) => getIMessageRuntime().channel.text.chunkText(text, limit), diff --git a/extensions/imessage/src/client.ts b/extensions/imessage/src/client.ts index efe9e5deb3b..4c9dea59c2c 100644 --- a/extensions/imessage/src/client.ts +++ b/extensions/imessage/src/client.ts @@ -1,7 +1,7 @@ import { type ChildProcessWithoutNullStreams, spawn } from "node:child_process"; import { createInterface, type Interface } from "node:readline"; -import type { RuntimeEnv } from "../../../src/runtime.js"; -import { resolveUserPath } from "../../../src/utils.js"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { resolveUserPath } from "openclaw/plugin-sdk/text-runtime"; import { DEFAULT_IMESSAGE_PROBE_TIMEOUT_MS } from "./constants.js"; export type IMessageRpcError = { diff --git a/extensions/imessage/src/monitor/deliver.ts b/extensions/imessage/src/monitor/deliver.ts index e8db8c0cac9..65dc125be68 100644 --- a/extensions/imessage/src/monitor/deliver.ts +++ b/extensions/imessage/src/monitor/deliver.ts @@ -1,9 +1,9 @@ -import { chunkTextWithMode, resolveChunkMode } from "../../../../src/auto-reply/chunk.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import { loadConfig } from "../../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../../src/config/markdown-tables.js"; -import { convertMarkdownTables } from "../../../../src/markdown/tables.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { chunkTextWithMode, resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; import type { createIMessageRpcClient } from "../client.js"; import { sendMessageIMessage } from "../send.js"; import type { SentMessageCache } from "./echo-cache.js"; diff --git a/extensions/imessage/src/monitor/inbound-processing.ts b/extensions/imessage/src/monitor/inbound-processing.ts index af900e21b40..531a8324dfd 100644 --- a/extensions/imessage/src/monitor/inbound-processing.ts +++ b/extensions/imessage/src/monitor/inbound-processing.ts @@ -1,34 +1,31 @@ -import { hasControlCommand } from "../../../../src/auto-reply/command-detection.js"; +import { resolveDualTextControlCommandGate } from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { + resolveChannelGroupPolicy, + resolveChannelGroupRequireMention, +} from "openclaw/plugin-sdk/config-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; import { formatInboundEnvelope, formatInboundFromLabel, resolveEnvelopeFormatOptions, type EnvelopeFormatOptions, -} from "../../../../src/auto-reply/envelope.js"; +} from "openclaw/plugin-sdk/reply-runtime"; import { buildPendingHistoryContextFromMap, recordPendingHistoryEntryIfEnabled, type HistoryEntry, -} from "../../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; -import { - buildMentionRegexes, - matchesMentionPatterns, -} from "../../../../src/auto-reply/reply/mentions.js"; -import { resolveDualTextControlCommandGate } from "../../../../src/channels/command-gating.js"; -import { logInboundDrop } from "../../../../src/channels/logging.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import { - resolveChannelGroupPolicy, - resolveChannelGroupRequireMention, -} from "../../../../src/config/group-policy.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { buildMentionRegexes, matchesMentionPatterns } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; import { DM_GROUP_ACCESS_REASON, resolveDmGroupAccessWithLists, -} from "../../../../src/security/dm-policy-shared.js"; -import { sanitizeTerminalText } from "../../../../src/terminal/safe-text.js"; -import { truncateUtf16Safe } from "../../../../src/utils.js"; +} from "openclaw/plugin-sdk/security-runtime"; +import { sanitizeTerminalText } from "openclaw/plugin-sdk/text-runtime"; +import { truncateUtf16Safe } from "openclaw/plugin-sdk/text-runtime"; import { formatIMessageChatTarget, isAllowedIMessageSender, diff --git a/extensions/imessage/src/monitor/monitor-provider.ts b/extensions/imessage/src/monitor/monitor-provider.ts index e3c062cd814..dc15715d652 100644 --- a/extensions/imessage/src/monitor/monitor-provider.ts +++ b/extensions/imessage/src/monitor/monitor-provider.ts @@ -1,42 +1,42 @@ import fs from "node:fs/promises"; -import { resolveHumanDelayConfig } from "../../../../src/agents/identity.js"; -import { resolveTextChunkLimit } from "../../../../src/auto-reply/chunk.js"; -import { dispatchInboundMessage } from "../../../../src/auto-reply/dispatch.js"; -import { - clearHistoryEntriesIfEnabled, - DEFAULT_GROUP_HISTORY_LIMIT, - type HistoryEntry, -} from "../../../../src/auto-reply/reply/history.js"; -import { createReplyDispatcher } from "../../../../src/auto-reply/reply/reply-dispatcher.js"; +import { resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; import { createChannelInboundDebouncer, shouldDebounceTextInbound, -} from "../../../../src/channels/inbound-debounce-policy.js"; -import { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -import { recordInboundSession } from "../../../../src/channels/session.js"; -import { loadConfig } from "../../../../src/config/config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveOpenProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, -} from "../../../../src/config/runtime-group-policy.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../../src/config/sessions.js"; -import { danger, logVerbose, shouldLogVerbose, warn } from "../../../../src/globals.js"; -import { normalizeScpRemoteHost } from "../../../../src/infra/scp-host.js"; -import { waitForTransportReady } from "../../../../src/infra/transport-ready.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { + readChannelAllowFromStore, + upsertChannelPairingRequest, +} from "openclaw/plugin-sdk/conversation-runtime"; +import { normalizeScpRemoteHost } from "openclaw/plugin-sdk/infra-runtime"; +import { waitForTransportReady } from "openclaw/plugin-sdk/infra-runtime"; import { isInboundPathAllowed, resolveIMessageAttachmentRoots, resolveIMessageRemoteAttachmentRoots, -} from "../../../../src/media/inbound-path-policy.js"; -import { kindFromMime } from "../../../../src/media/mime.js"; -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; +} from "openclaw/plugin-sdk/media-runtime"; +import { kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchInboundMessage } from "openclaw/plugin-sdk/reply-runtime"; import { - readChannelAllowFromStore, - upsertChannelPairingRequest, -} from "../../../../src/pairing/pairing-store.js"; -import { resolvePinnedMainDmOwnerFromAllowlist } from "../../../../src/security/dm-policy-shared.js"; -import { truncateUtf16Safe } from "../../../../src/utils.js"; + clearHistoryEntriesIfEnabled, + DEFAULT_GROUP_HISTORY_LIMIT, + type HistoryEntry, +} from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose, shouldLogVerbose, warn } from "openclaw/plugin-sdk/runtime-env"; +import { resolvePinnedMainDmOwnerFromAllowlist } from "openclaw/plugin-sdk/security-runtime"; +import { truncateUtf16Safe } from "openclaw/plugin-sdk/text-runtime"; import { resolveIMessageAccount } from "../accounts.js"; import { createIMessageRpcClient } from "../client.js"; import { DEFAULT_IMESSAGE_PROBE_TIMEOUT_MS } from "../constants.js"; diff --git a/extensions/imessage/src/monitor/reflection-guard.ts b/extensions/imessage/src/monitor/reflection-guard.ts index 0af95d957cc..9ed38d2a175 100644 --- a/extensions/imessage/src/monitor/reflection-guard.ts +++ b/extensions/imessage/src/monitor/reflection-guard.ts @@ -4,7 +4,7 @@ * bounced back as a new inbound message — creating an echo loop. */ -import { findCodeRegions, isInsideCode } from "../../../../src/shared/text/code-regions.js"; +import { findCodeRegions, isInsideCode } from "openclaw/plugin-sdk/text-runtime"; const INTERNAL_SEPARATOR_RE = /(?:#\+){2,}#?/; const ASSISTANT_ROLE_MARKER_RE = /\bassistant\s+to\s*=\s*\w+/i; diff --git a/extensions/imessage/src/monitor/runtime.ts b/extensions/imessage/src/monitor/runtime.ts index e4fe6ae4336..437224013d4 100644 --- a/extensions/imessage/src/monitor/runtime.ts +++ b/extensions/imessage/src/monitor/runtime.ts @@ -1,5 +1,5 @@ -import { createNonExitingRuntime, type RuntimeEnv } from "../../../../src/runtime.js"; -import { normalizeStringEntries } from "../../../../src/shared/string-normalization.js"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { normalizeStringEntries } from "openclaw/plugin-sdk/text-runtime"; import type { MonitorIMessageOpts } from "./types.js"; export function resolveRuntime(opts: MonitorIMessageOpts): RuntimeEnv { diff --git a/extensions/imessage/src/monitor/sanitize-outbound.ts b/extensions/imessage/src/monitor/sanitize-outbound.ts index 83eb75a8da2..533eb7f2176 100644 --- a/extensions/imessage/src/monitor/sanitize-outbound.ts +++ b/extensions/imessage/src/monitor/sanitize-outbound.ts @@ -1,4 +1,4 @@ -import { stripAssistantInternalScaffolding } from "../../../../src/shared/text/assistant-visible-text.js"; +import { stripAssistantInternalScaffolding } from "openclaw/plugin-sdk/text-runtime"; /** * Patterns that indicate assistant-internal metadata leaked into text. diff --git a/extensions/imessage/src/monitor/types.ts b/extensions/imessage/src/monitor/types.ts index 074c7c34c9f..a03ed5faea8 100644 --- a/extensions/imessage/src/monitor/types.ts +++ b/extensions/imessage/src/monitor/types.ts @@ -1,5 +1,5 @@ -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; export type IMessageAttachment = { original_path?: string | null; diff --git a/extensions/imessage/src/outbound-adapter.ts b/extensions/imessage/src/outbound-adapter.ts index ae5e7c2836a..cd961c30bfa 100644 --- a/extensions/imessage/src/outbound-adapter.ts +++ b/extensions/imessage/src/outbound-adapter.ts @@ -1,11 +1,8 @@ import { createScopedChannelMediaMaxBytesResolver, createDirectTextMediaOutbound, -} from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import { - resolveOutboundSendDep, - type OutboundSendDeps, -} from "../../../src/infra/outbound/send-deps.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep, type OutboundSendDeps } from "openclaw/plugin-sdk/channel-runtime"; import { sendMessageIMessage } from "./send.js"; function resolveIMessageSender(deps: OutboundSendDeps | undefined) { diff --git a/extensions/imessage/src/plugin-shared.ts b/extensions/imessage/src/plugin-shared.ts index c7ed39cd21a..415a152f56a 100644 --- a/extensions/imessage/src/plugin-shared.ts +++ b/extensions/imessage/src/plugin-shared.ts @@ -1,4 +1,4 @@ -import { type ChannelPlugin } from "../../../src/plugin-sdk-internal/imessage.js"; +import type { ChannelPlugin } from "openclaw/plugin-sdk/imessage"; import { type ResolvedIMessageAccount } from "./accounts.js"; import { createIMessageSetupWizardProxy } from "./setup-core.js"; diff --git a/extensions/imessage/src/probe.ts b/extensions/imessage/src/probe.ts index 1b6ab665d09..7ae049f02eb 100644 --- a/extensions/imessage/src/probe.ts +++ b/extensions/imessage/src/probe.ts @@ -1,8 +1,8 @@ -import type { BaseProbeResult } from "../../../src/channels/plugins/types.js"; -import { detectBinary } from "../../../src/commands/onboard-helpers.js"; -import { loadConfig } from "../../../src/config/config.js"; -import { runCommandWithTimeout } from "../../../src/process/exec.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import type { BaseProbeResult } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { runCommandWithTimeout } from "openclaw/plugin-sdk/process-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { detectBinary } from "openclaw/plugin-sdk/setup"; import { createIMessageRpcClient } from "./client.js"; import { DEFAULT_IMESSAGE_PROBE_TIMEOUT_MS } from "./constants.js"; diff --git a/extensions/imessage/src/runtime.ts b/extensions/imessage/src/runtime.ts index 3a49020348f..a7ed927b9ab 100644 --- a/extensions/imessage/src/runtime.ts +++ b/extensions/imessage/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setIMessageRuntime, getRuntime: getIMessageRuntime } = createPluginRuntimeStore("iMessage runtime not initialized"); diff --git a/extensions/imessage/src/send.ts b/extensions/imessage/src/send.ts index 5bc02b6bb7f..70c996329e1 100644 --- a/extensions/imessage/src/send.ts +++ b/extensions/imessage/src/send.ts @@ -1,8 +1,8 @@ -import { loadConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { convertMarkdownTables } from "../../../src/markdown/tables.js"; -import { kindFromMime } from "../../../src/media/mime.js"; -import { resolveOutboundAttachmentFromUrl } from "../../../src/media/outbound-attachment.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { resolveOutboundAttachmentFromUrl } from "openclaw/plugin-sdk/media-runtime"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; import { createIMessageRpcClient, type IMessageRpcClient } from "./client.js"; import { formatIMessageChatTarget, type IMessageService, parseIMessageTarget } from "./targets.js"; diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index 45f385e0691..eed33e64192 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,18 +1,21 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; import { + applyAccountNameToChannelSection, + DEFAULT_ACCOUNT_ID, + formatDocsLink, + migrateBaseNameToDefaultAccount, + normalizeAccountId, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, setChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, type OpenClawConfig, type WizardPrompter, -} from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy, ChannelSetupWizard, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +} from "openclaw/plugin-sdk/setup"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, @@ -95,23 +98,66 @@ async function promptIMessageAllowFrom(params: { }); } -export const imessageSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, - buildPatch: (input) => buildIMessageSetupPatch(input), -}); - -type IMessageSetupWizardHandlers = { - resolveStatusLines: NonNullable["resolveStatusLines"]; - resolveSelectionHint: NonNullable["resolveSelectionHint"]; - resolveQuickstartScore: NonNullable["resolveQuickstartScore"]; - shouldPromptCliPath: NonNullable< - NonNullable[number]["shouldPrompt"] - >; +export const imessageSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + if (accountId === DEFAULT_ACCOUNT_ID) { + return { + ...next, + channels: { + ...next.channels, + imessage: { + ...next.channels?.imessage, + enabled: true, + ...buildIMessageSetupPatch(input), + }, + }, + }; + } + return { + ...next, + channels: { + ...next.channels, + imessage: { + ...next.channels?.imessage, + enabled: true, + accounts: { + ...next.channels?.imessage?.accounts, + [accountId]: { + ...next.channels?.imessage?.accounts?.[accountId], + enabled: true, + ...buildIMessageSetupPatch(input), + }, + }, + }, + }, + }; + }, }; -export function createIMessageSetupWizardBase( - handlers: IMessageSetupWizardHandlers, -): ChannelSetupWizard { +export function createIMessageSetupWizardProxy( + loadWizard: () => Promise<{ imessageSetupWizard: ChannelSetupWizard }>, +) { const imessageDmPolicy: ChannelSetupDmPolicy = { label: "iMessage", channel, @@ -147,9 +193,12 @@ export function createIMessageSetupWizardBase( account.config.region, ); }), - resolveStatusLines: handlers.resolveStatusLines, - resolveSelectionHint: handlers.resolveSelectionHint, - resolveQuickstartScore: handlers.resolveQuickstartScore, + resolveStatusLines: async (params) => + (await loadWizard()).imessageSetupWizard.status.resolveStatusLines?.(params) ?? [], + resolveSelectionHint: async (params) => + await (await loadWizard()).imessageSetupWizard.status.resolveSelectionHint?.(params), + resolveQuickstartScore: async (params) => + await (await loadWizard()).imessageSetupWizard.status.resolveQuickstartScore?.(params), }, credentials: [], textInputs: [ @@ -160,7 +209,12 @@ export function createIMessageSetupWizardBase( resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", currentValue: ({ cfg, accountId }) => resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", - shouldPrompt: handlers.shouldPromptCliPath, + shouldPrompt: async (params) => { + const input = (await loadWizard()).imessageSetupWizard.textInputs?.find( + (entry) => entry.inputKey === "cliPath", + ); + return (await input?.shouldPrompt?.(params)) ?? false; + }, confirmCurrentValue: false, applyCurrentValue: true, helpTitle: "iMessage", @@ -181,22 +235,3 @@ export function createIMessageSetupWizardBase( disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } - -export function createIMessageSetupWizardProxy( - loadWizard: () => Promise<{ imessageSetupWizard: ChannelSetupWizard }>, -) { - return createIMessageSetupWizardBase({ - resolveStatusLines: async (params) => - (await loadWizard()).imessageSetupWizard.status.resolveStatusLines?.(params) ?? [], - resolveSelectionHint: async (params) => - await (await loadWizard()).imessageSetupWizard.status.resolveSelectionHint?.(params), - resolveQuickstartScore: async (params) => - await (await loadWizard()).imessageSetupWizard.status.resolveQuickstartScore?.(params), - shouldPromptCliPath: async (params) => { - const input = (await loadWizard()).imessageSetupWizard.textInputs?.find( - (entry) => entry.inputKey === "cliPath", - ); - return (await input?.shouldPrompt?.(params)) ?? false; - }, - }); -} diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index c1158960cec..48c9f130355 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,23 +1,134 @@ -import { detectBinary } from "../../../src/plugin-sdk-internal/setup.js"; -import { createIMessageSetupWizardBase, imessageSetupAdapter } from "./setup-core.js"; +import { + DEFAULT_ACCOUNT_ID, + detectBinary, + formatDocsLink, + type OpenClawConfig, + parseSetupEntriesAllowingWildcard, + promptParsedAllowFromForScopedChannel, + setChannelDmPolicyWithAllowFrom, + setSetupChannelEnabled, + type WizardPrompter, +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { + listIMessageAccountIds, + resolveDefaultIMessageAccountId, + resolveIMessageAccount, +} from "./accounts.js"; +import { imessageSetupAdapter, parseIMessageAllowFromEntries } from "./setup-core.js"; -export const imessageSetupWizard = createIMessageSetupWizardBase({ - resolveStatusLines: async ({ cfg, configured }) => { - const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; - const cliDetected = await detectBinary(cliPath); - return [ - `iMessage: ${configured ? "configured" : "needs setup"}`, - `imsg: ${cliDetected ? "found" : "missing"} (${cliPath})`, - ]; +const channel = "imessage" as const; + +async function promptIMessageAllowFrom(params: { + cfg: OpenClawConfig; + prompter: WizardPrompter; + accountId?: string; +}): Promise { + return promptParsedAllowFromForScopedChannel({ + cfg: params.cfg, + channel, + accountId: params.accountId, + defaultAccountId: resolveDefaultIMessageAccountId(params.cfg), + prompter: params.prompter, + noteTitle: "iMessage allowlist", + noteLines: [ + "Allowlist iMessage DMs by handle or chat target.", + "Examples:", + "- +15555550123", + "- user@example.com", + "- chat_id:123", + "- chat_guid:... or chat_identifier:...", + "Multiple entries: comma-separated.", + `Docs: ${formatDocsLink("/imessage", "imessage")}`, + ], + message: "iMessage allowFrom (handle or chat_id)", + placeholder: "+15555550123, user@example.com, chat_id:123", + parseEntries: parseIMessageAllowFromEntries, + getExistingAllowFrom: ({ cfg, accountId }) => + resolveIMessageAccount({ cfg, accountId }).config.allowFrom ?? [], + }); +} + +const imessageDmPolicy: ChannelSetupDmPolicy = { + label: "iMessage", + channel, + policyKey: "channels.imessage.dmPolicy", + allowFromKey: "channels.imessage.allowFrom", + getCurrent: (cfg) => cfg.channels?.imessage?.dmPolicy ?? "pairing", + setPolicy: (cfg, policy) => + setChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptIMessageAllowFrom, +}; + +export const imessageSetupWizard: ChannelSetupWizard = { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs setup", + configuredHint: "imsg found", + unconfiguredHint: "imsg missing", + configuredScore: 1, + unconfiguredScore: 0, + resolveConfigured: ({ cfg }) => + listIMessageAccountIds(cfg).some((accountId) => { + const account = resolveIMessageAccount({ cfg, accountId }); + return Boolean( + account.config.cliPath || + account.config.dbPath || + account.config.allowFrom || + account.config.service || + account.config.region, + ); + }), + resolveStatusLines: async ({ cfg, configured }) => { + const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; + const cliDetected = await detectBinary(cliPath); + return [ + `iMessage: ${configured ? "configured" : "needs setup"}`, + `imsg: ${cliDetected ? "found" : "missing"} (${cliPath})`, + ]; + }, + resolveSelectionHint: async ({ cfg }) => { + const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; + return (await detectBinary(cliPath)) ? "imsg found" : "imsg missing"; + }, + resolveQuickstartScore: async ({ cfg }) => { + const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; + return (await detectBinary(cliPath)) ? 1 : 0; + }, }, - resolveSelectionHint: async ({ cfg }) => { - const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; - return (await detectBinary(cliPath)) ? "imsg found" : "imsg missing"; + credentials: [], + textInputs: [ + { + inputKey: "cliPath", + message: "imsg CLI path", + initialValue: ({ cfg, accountId }) => + resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", + currentValue: ({ cfg, accountId }) => + resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", + shouldPrompt: async ({ currentValue }) => !(await detectBinary(currentValue ?? "imsg")), + confirmCurrentValue: false, + applyCurrentValue: true, + helpTitle: "iMessage", + helpLines: ["imsg CLI path required to enable iMessage."], + }, + ], + completionNote: { + title: "iMessage next steps", + lines: [ + "This is still a work in progress.", + "Ensure OpenClaw has Full Disk Access to Messages DB.", + "Grant Automation permission for Messages when prompted.", + "List chats with: imsg chats --limit 20", + `Docs: ${formatDocsLink("/imessage", "imessage")}`, + ], }, - resolveQuickstartScore: async ({ cfg }) => { - const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; - return (await detectBinary(cliPath)) ? 1 : 0; - }, - shouldPromptCliPath: async ({ currentValue }) => !(await detectBinary(currentValue ?? "imsg")), -}); -export { imessageSetupAdapter, parseIMessageAllowFromEntries } from "./setup-core.js"; + dmPolicy: imessageDmPolicy, + disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), +}; + +export { imessageSetupAdapter, parseIMessageAllowFromEntries }; diff --git a/extensions/imessage/src/target-parsing-helpers.ts b/extensions/imessage/src/target-parsing-helpers.ts index 7995b271fe4..04881fa2131 100644 --- a/extensions/imessage/src/target-parsing-helpers.ts +++ b/extensions/imessage/src/target-parsing-helpers.ts @@ -1,4 +1,4 @@ -import { isAllowedParsedChatSender } from "../../../src/plugin-sdk-internal/imessage.js"; +import { isAllowedParsedChatSender } from "openclaw/plugin-sdk/allow-from"; export type ServicePrefix = { prefix: string; service: TService }; diff --git a/extensions/imessage/src/targets.ts b/extensions/imessage/src/targets.ts index a376a6e7f45..d6cd6a11f38 100644 --- a/extensions/imessage/src/targets.ts +++ b/extensions/imessage/src/targets.ts @@ -1,4 +1,4 @@ -import { normalizeE164 } from "../../../src/utils.js"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import { createAllowedChatSenderMatcher, type ChatSenderAllowParams, diff --git a/extensions/irc/src/setup-core.ts b/extensions/irc/src/setup-core.ts index 3c28017e1e9..23422e30ba0 100644 --- a/extensions/irc/src/setup-core.ts +++ b/extensions/irc/src/setup-core.ts @@ -1,15 +1,15 @@ +import type { ChannelSetupAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelSetupInput } from "openclaw/plugin-sdk/channel-runtime"; +import type { DmPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { + applyAccountNameToChannelSection, patchScopedAccountConfig, - prepareScopedSetupConfig, -} from "../../../src/channels/plugins/setup-helpers.js"; +} from "openclaw/plugin-sdk/setup"; import { setTopLevelChannelAllowFrom, setTopLevelChannelDmPolicyWithAllowFrom, -} from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { ChannelSetupInput } from "../../../src/channels/plugins/types.core.js"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/setup"; import type { CoreConfig, IrcAccountConfig, IrcNickServConfig } from "./types.js"; const channel = "irc" as const; @@ -100,7 +100,7 @@ export function setIrcGroupAccess( export const ircSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => - prepareScopedSetupConfig({ + applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, @@ -118,7 +118,7 @@ export const ircSetupAdapter: ChannelSetupAdapter = { }, applyAccountConfig: ({ cfg, accountId, input }) => { const setupInput = input as IrcSetupInput; - const namedConfig = prepareScopedSetupConfig({ + const namedConfig = applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, diff --git a/extensions/irc/src/setup-surface.ts b/extensions/irc/src/setup-surface.ts index 1607a9bdd54..cdadcffbaec 100644 --- a/extensions/irc/src/setup-surface.ts +++ b/extensions/irc/src/setup-surface.ts @@ -1,13 +1,10 @@ -import { - resolveSetupAccountId, - setSetupChannelEnabled, -} from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupDmPolicy } from "../../../src/channels/plugins/setup-wizard-types.js"; -import type { ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; +import type { DmPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; +import { resolveSetupAccountId, setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "openclaw/plugin-sdk/setup"; +import type { WizardPrompter } from "openclaw/plugin-sdk/setup"; import { listIrcAccountIds, resolveDefaultIrcAccountId, resolveIrcAccount } from "./accounts.js"; import { isChannelTarget, diff --git a/extensions/kilocode/index.ts b/extensions/kilocode/index.ts index 7089d212628..33dc9718021 100644 --- a/extensions/kilocode/index.ts +++ b/extensions/kilocode/index.ts @@ -1,9 +1,9 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { createKilocodeWrapper, isProxyReasoningUnsupported, -} from "../../src/agents/pi-embedded-runner/proxy-stream-wrappers.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +} from "openclaw/plugin-sdk/provider-stream"; import { applyKilocodeConfig, KILOCODE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildKilocodeProviderWithDiscovery } from "./provider-catalog.js"; diff --git a/extensions/kilocode/onboard.ts b/extensions/kilocode/onboard.ts index 260233c3d34..fd285341f52 100644 --- a/extensions/kilocode/onboard.ts +++ b/extensions/kilocode/onboard.ts @@ -1,12 +1,9 @@ +import { KILOCODE_BASE_URL, KILOCODE_DEFAULT_MODEL_REF } from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; -import { - KILOCODE_BASE_URL, - KILOCODE_DEFAULT_MODEL_REF, -} from "../../src/providers/kilocode-shared.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildKilocodeProvider } from "./provider-catalog.js"; export { KILOCODE_BASE_URL, KILOCODE_DEFAULT_MODEL_REF }; diff --git a/extensions/kilocode/provider-catalog.ts b/extensions/kilocode/provider-catalog.ts index 696b351c530..98e324f4784 100644 --- a/extensions/kilocode/provider-catalog.ts +++ b/extensions/kilocode/provider-catalog.ts @@ -1,12 +1,12 @@ -import { discoverKilocodeModels } from "../../src/agents/kilocode-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; import { + discoverKilocodeModels, + type ModelProviderConfig, KILOCODE_BASE_URL, KILOCODE_DEFAULT_CONTEXT_WINDOW, KILOCODE_DEFAULT_COST, KILOCODE_DEFAULT_MAX_TOKENS, KILOCODE_MODEL_CATALOG, -} from "../../src/providers/kilocode-shared.js"; +} from "openclaw/plugin-sdk/provider-models"; export function buildKilocodeProvider(): ModelProviderConfig { return { diff --git a/extensions/kimi-coding/index.ts b/extensions/kimi-coding/index.ts index 709e5a8de4c..3803a0af951 100644 --- a/extensions/kimi-coding/index.ts +++ b/extensions/kimi-coding/index.ts @@ -1,69 +1,47 @@ -import { - emptyPluginConfigSchema, - type OpenClawPluginApi, - type ProviderRuntimeModel, -} from "openclaw/plugin-sdk/core"; -import { findNormalizedProviderValue, normalizeProviderId } from "../../src/agents/provider-id.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { isRecord } from "../../src/utils.js"; -import { applyKimiCodeConfig, KIMI_DEFAULT_MODEL_REF } from "./onboard.js"; -import { - buildKimiProvider, - KIMI_DEFAULT_MODEL_ID, - KIMI_LEGACY_MODEL_ID, - KIMI_UPSTREAM_MODEL_ID, -} from "./provider-catalog.js"; +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { isRecord } from "openclaw/plugin-sdk/text-runtime"; +import { applyKimiCodeConfig, KIMI_CODING_MODEL_REF } from "./onboard.js"; +import { buildKimiCodingProvider } from "./provider-catalog.js"; -const PROVIDER_ID = "kimi"; -const KIMI_TRANSPORT_MODEL_IDS = new Set([KIMI_DEFAULT_MODEL_ID, KIMI_LEGACY_MODEL_ID]); - -function normalizeKimiTransportModel(model: ProviderRuntimeModel): ProviderRuntimeModel { - if (!KIMI_TRANSPORT_MODEL_IDS.has(model.id)) { - return model; - } - return { - ...model, - id: KIMI_UPSTREAM_MODEL_ID, - name: "Kimi Code", - }; -} +const PROVIDER_ID = "kimi-coding"; const kimiCodingPlugin = { id: PROVIDER_ID, - name: "Kimi Code Provider", - description: "Bundled Kimi Code provider plugin", + name: "Kimi Provider", + description: "Bundled Kimi provider plugin", configSchema: emptyPluginConfigSchema(), register(api: OpenClawPluginApi) { api.registerProvider({ id: PROVIDER_ID, - label: "Kimi Code", - aliases: ["kimi-code", "kimi-coding"], + label: "Kimi", + aliases: ["kimi", "kimi-code"], docsPath: "/providers/moonshot", envVars: ["KIMI_API_KEY", "KIMICODE_API_KEY"], auth: [ createProviderApiKeyAuthMethod({ providerId: PROVIDER_ID, methodId: "api-key", - label: "Kimi Code API key", - hint: "Dedicated coding endpoint", + label: "Kimi API key (subscription)", + hint: "Kimi K2.5 + Kimi", optionKey: "kimiCodeApiKey", flagName: "--kimi-code-api-key", envVar: "KIMI_API_KEY", - promptMessage: "Enter Kimi Code API key", - defaultModel: KIMI_DEFAULT_MODEL_REF, + promptMessage: "Enter Kimi API key", + defaultModel: KIMI_CODING_MODEL_REF, expectedProviders: ["kimi", "kimi-code", "kimi-coding"], applyConfig: (cfg) => applyKimiCodeConfig(cfg), noteMessage: [ - "Kimi Code uses a dedicated coding endpoint and API key.", + "Kimi uses a dedicated coding endpoint and API key.", "Get your API key at: https://www.kimi.com/code/en", ].join("\n"), - noteTitle: "Kimi Code", + noteTitle: "Kimi", wizard: { choiceId: "kimi-code-api-key", - choiceLabel: "Kimi Code API key", - groupId: "kimi-code", - groupLabel: "Kimi Code", - groupHint: "Dedicated coding endpoint", + choiceLabel: "Kimi API key (subscription)", + groupId: "moonshot", + groupLabel: "Moonshot AI (Kimi K2.5)", + groupHint: "Kimi K2.5 + Kimi", }, }), ], @@ -74,11 +52,8 @@ const kimiCodingPlugin = { if (!apiKey) { return null; } - const explicitProvider = findNormalizedProviderValue( - ctx.config.models?.providers, - PROVIDER_ID, - ); - const builtInProvider = buildKimiProvider(); + const explicitProvider = ctx.config.models?.providers?.[PROVIDER_ID]; + const builtInProvider = buildKimiCodingProvider(); const explicitBaseUrl = typeof explicitProvider?.baseUrl === "string" ? explicitProvider.baseUrl.trim() : ""; const explicitHeaders = isRecord(explicitProvider?.headers) @@ -104,12 +79,6 @@ const kimiCodingPlugin = { capabilities: { preserveAnthropicThinkingSignatures: false, }, - normalizeResolvedModel: (ctx) => { - if (normalizeProviderId(ctx.provider) !== PROVIDER_ID) { - return undefined; - } - return normalizeKimiTransportModel(ctx.model); - }, }); }, }; diff --git a/extensions/kimi-coding/onboard.ts b/extensions/kimi-coding/onboard.ts index 07feea91327..c97738f1e72 100644 --- a/extensions/kimi-coding/onboard.ts +++ b/extensions/kimi-coding/onboard.ts @@ -1,44 +1,38 @@ import { applyAgentDefaultModelPrimary, - applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + applyProviderConfigWithDefaultModel, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildKimiCodingProvider, - KIMI_BASE_URL, - KIMI_DEFAULT_MODEL_ID, - KIMI_LEGACY_MODEL_ID, + KIMI_CODING_BASE_URL, + KIMI_CODING_DEFAULT_MODEL_ID, } from "./provider-catalog.js"; -export const KIMI_DEFAULT_MODEL_REF = `kimi/${KIMI_DEFAULT_MODEL_ID}`; -export const KIMI_LEGACY_MODEL_REF = `kimi/${KIMI_LEGACY_MODEL_ID}`; -export const KIMI_CODING_MODEL_REF = KIMI_DEFAULT_MODEL_REF; +export const KIMI_CODING_MODEL_REF = `kimi-coding/${KIMI_CODING_DEFAULT_MODEL_ID}`; export function applyKimiCodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig { const models = { ...cfg.agents?.defaults?.models }; - models[KIMI_DEFAULT_MODEL_REF] = { - ...models[KIMI_DEFAULT_MODEL_REF], - alias: models[KIMI_DEFAULT_MODEL_REF]?.alias ?? "Kimi Code", - }; - models[KIMI_LEGACY_MODEL_REF] = { - ...models[KIMI_LEGACY_MODEL_REF], - alias: models[KIMI_LEGACY_MODEL_REF]?.alias ?? "Kimi Code", + models[KIMI_CODING_MODEL_REF] = { + ...models[KIMI_CODING_MODEL_REF], + alias: models[KIMI_CODING_MODEL_REF]?.alias ?? "Kimi", }; - const catalog = buildKimiCodingProvider().models ?? []; - if (catalog.length === 0) { + const defaultModel = buildKimiCodingProvider().models[0]; + if (!defaultModel) { return cfg; } - return applyProviderConfigWithModelCatalog(cfg, { + return applyProviderConfigWithDefaultModel(cfg, { agentModels: models, - providerId: "kimi", + providerId: "kimi-coding", api: "anthropic-messages", - baseUrl: KIMI_BASE_URL, - catalogModels: catalog, + baseUrl: KIMI_CODING_BASE_URL, + defaultModel, + defaultModelId: KIMI_CODING_DEFAULT_MODEL_ID, }); } export function applyKimiCodeConfig(cfg: OpenClawConfig): OpenClawConfig { - return applyAgentDefaultModelPrimary(applyKimiCodeProviderConfig(cfg), KIMI_DEFAULT_MODEL_REF); + return applyAgentDefaultModelPrimary(applyKimiCodeProviderConfig(cfg), KIMI_CODING_MODEL_REF); } diff --git a/extensions/kimi-coding/provider-catalog.ts b/extensions/kimi-coding/provider-catalog.ts index 439c86fdff0..5fc27495c76 100644 --- a/extensions/kimi-coding/provider-catalog.ts +++ b/extensions/kimi-coding/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; export const KIMI_BASE_URL = "https://api.kimi.com/coding/"; const KIMI_CODING_USER_AGENT = "claude-code/0.1.0"; diff --git a/extensions/line/src/channel.setup.ts b/extensions/line/src/channel.setup.ts index 71a1d87c45d..771107dff58 100644 --- a/extensions/line/src/channel.setup.ts +++ b/extensions/line/src/channel.setup.ts @@ -9,7 +9,7 @@ import { listLineAccountIds, resolveDefaultLineAccountId, resolveLineAccount, -} from "../../../src/line/accounts.js"; +} from "openclaw/plugin-sdk/line"; import { lineSetupAdapter } from "./setup-core.js"; import { lineSetupWizard } from "./setup-surface.js"; diff --git a/extensions/line/src/setup-core.ts b/extensions/line/src/setup-core.ts index 67c9c674df5..737ba1cc856 100644 --- a/extensions/line/src/setup-core.ts +++ b/extensions/line/src/setup-core.ts @@ -1,12 +1,11 @@ -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; import { listLineAccountIds, normalizeAccountId, resolveLineAccount, -} from "../../../src/line/accounts.js"; -import type { LineConfig } from "../../../src/line/types.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; + type LineConfig, +} from "openclaw/plugin-sdk/line"; +import type { ChannelSetupAdapter, OpenClawConfig } from "openclaw/plugin-sdk/setup"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/setup"; const channel = "line" as const; diff --git a/extensions/line/src/setup-surface.ts b/extensions/line/src/setup-surface.ts index 9ea7dd4ce68..d548b096434 100644 --- a/extensions/line/src/setup-surface.ts +++ b/extensions/line/src/setup-surface.ts @@ -1,13 +1,13 @@ +import { resolveLineAccount } from "openclaw/plugin-sdk/line"; import { + DEFAULT_ACCOUNT_ID, + formatDocsLink, setSetupChannelEnabled, setTopLevelChannelDmPolicyWithAllowFrom, splitSetupEntries, -} from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupDmPolicy } from "../../../src/channels/plugins/setup-wizard-types.js"; -import type { ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { resolveLineAccount } from "../../../src/line/accounts.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; + type ChannelSetupDmPolicy, + type ChannelSetupWizard, +} from "openclaw/plugin-sdk/setup"; import { isLineConfigured, listLineAccountIds, diff --git a/extensions/matrix/src/outbound.ts b/extensions/matrix/src/outbound.ts index 072ab2fb8c1..09374b7746e 100644 --- a/extensions/matrix/src/outbound.ts +++ b/extensions/matrix/src/outbound.ts @@ -1,5 +1,5 @@ +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/matrix"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; import { sendMessageMatrix, sendPollMatrix } from "./matrix/send.js"; import { getMatrixRuntime } from "./runtime.js"; diff --git a/extensions/mattermost/src/setup-core.ts b/extensions/mattermost/src/setup-core.ts index 45bfbc5ac82..781967c70a6 100644 --- a/extensions/mattermost/src/setup-core.ts +++ b/extensions/mattermost/src/setup-core.ts @@ -1,10 +1,13 @@ +import type { ChannelSetupAdapter } from "openclaw/plugin-sdk/channel-runtime"; import { + applyAccountNameToChannelSection, + applySetupAccountConfigPatch, DEFAULT_ACCOUNT_ID, hasConfiguredSecretInput, + migrateBaseNameToDefaultAccount, + normalizeAccountId, type OpenClawConfig, } from "openclaw/plugin-sdk/mattermost"; -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; import { resolveMattermostAccount, type ResolvedMattermostAccount } from "./mattermost/accounts.js"; import { normalizeMattermostBaseUrl } from "./mattermost/client.js"; @@ -24,8 +27,15 @@ export function resolveMattermostAccountWithSecrets(cfg: OpenClawConfig, account }); } -export const mattermostSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, +export const mattermostSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), validateInput: ({ accountId, input }) => { const token = input.botToken ?? input.token; const baseUrl = normalizeMattermostBaseUrl(input.httpUrl); @@ -40,14 +50,32 @@ export const mattermostSetupAdapter: ChannelSetupAdapter = createPatchedAccountS } return null; }, - buildPatch: (input) => { + applyAccountConfig: ({ cfg, accountId, input }) => { const token = input.botToken ?? input.token; const baseUrl = normalizeMattermostBaseUrl(input.httpUrl); - return input.useEnv - ? {} - : { - ...(token ? { botToken: token } : {}), - ...(baseUrl ? { baseUrl } : {}), - }; + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + return applySetupAccountConfigPatch({ + cfg: next, + channelKey: channel, + accountId, + patch: input.useEnv + ? {} + : { + ...(token ? { botToken: token } : {}), + ...(baseUrl ? { baseUrl } : {}), + }, + }); }, -}); +}; diff --git a/extensions/mattermost/src/setup-surface.ts b/extensions/mattermost/src/setup-surface.ts index 13b69542d02..d3b0a66b4c8 100644 --- a/extensions/mattermost/src/setup-surface.ts +++ b/extensions/mattermost/src/setup-surface.ts @@ -4,8 +4,8 @@ import { hasConfiguredSecretInput, type OpenClawConfig, } from "openclaw/plugin-sdk/mattermost"; -import { type ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "openclaw/plugin-sdk/setup"; import { listMattermostAccountIds } from "./mattermost/accounts.js"; import { normalizeMattermostBaseUrl } from "./mattermost/client.js"; import { diff --git a/extensions/microsoft/index.ts b/extensions/microsoft/index.ts index 358ea2057a0..db0bebbcc0b 100644 --- a/extensions/microsoft/index.ts +++ b/extensions/microsoft/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { buildMicrosoftSpeechProvider } from "../../src/tts/providers/microsoft.js"; +import { buildMicrosoftSpeechProvider } from "openclaw/plugin-sdk/speech"; const microsoftPlugin = { id: "microsoft", diff --git a/extensions/minimax/index.ts b/extensions/minimax/index.ts index 8dbe47f466c..30894be556d 100644 --- a/extensions/minimax/index.ts +++ b/extensions/minimax/index.ts @@ -6,14 +6,13 @@ import { type ProviderAuthResult, type ProviderCatalogContext, } from "openclaw/plugin-sdk/minimax-portal-auth"; -import { ensureAuthProfileStore, listProfilesForProvider } from "../../src/agents/auth-profiles.js"; -import { MINIMAX_OAUTH_MARKER } from "../../src/agents/model-auth-markers.js"; -import { fetchMinimaxUsage } from "../../src/infra/provider-usage.fetch.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; import { - minimaxMediaUnderstandingProvider, - minimaxPortalMediaUnderstandingProvider, -} from "./media-understanding-provider.js"; + MINIMAX_OAUTH_MARKER, + createProviderApiKeyAuthMethod, + ensureAuthProfileStore, + listProfilesForProvider, +} from "openclaw/plugin-sdk/provider-auth"; +import { fetchMinimaxUsage } from "openclaw/plugin-sdk/provider-usage"; import { loginMiniMaxPortalOAuth, type MiniMaxRegion } from "./oauth.js"; import { applyMinimaxApiConfig, applyMinimaxApiConfigCn } from "./onboard.js"; import { buildMinimaxPortalProvider, buildMinimaxProvider } from "./provider-catalog.js"; @@ -274,8 +273,6 @@ const minimaxPlugin = { ], isModernModelRef: ({ modelId }) => isModernMiniMaxModel(modelId), }); - api.registerMediaUnderstandingProvider(minimaxMediaUnderstandingProvider); - api.registerMediaUnderstandingProvider(minimaxPortalMediaUnderstandingProvider); }, }; diff --git a/extensions/minimax/onboard.ts b/extensions/minimax/onboard.ts index 6a2ff47e1f0..2edcf9637e4 100644 --- a/extensions/minimax/onboard.ts +++ b/extensions/minimax/onboard.ts @@ -1,14 +1,14 @@ -import { - applyAgentDefaultModelPrimary, - applyOnboardAuthAgentModelsAndProviders, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; import { buildMinimaxApiModelDefinition, MINIMAX_API_BASE_URL, MINIMAX_CN_API_BASE_URL, -} from "./model-definitions.js"; +} from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + applyOnboardAuthAgentModelsAndProviders, + type ModelProviderConfig, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; type MinimaxApiProviderConfigParams = { providerId: string; diff --git a/extensions/minimax/provider-catalog.ts b/extensions/minimax/provider-catalog.ts index 83c1c46df13..ab8cceb9c53 100644 --- a/extensions/minimax/provider-catalog.ts +++ b/extensions/minimax/provider-catalog.ts @@ -1,4 +1,7 @@ -import type { ModelDefinitionConfig, ModelProviderConfig } from "../../src/config/types.models.js"; +import type { + ModelDefinitionConfig, + ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; const MINIMAX_PORTAL_BASE_URL = "https://api.minimax.io/anthropic"; export const MINIMAX_DEFAULT_MODEL_ID = "MiniMax-M2.5"; diff --git a/extensions/mistral/index.ts b/extensions/mistral/index.ts index 6da8e431759..72b3b6a60ac 100644 --- a/extensions/mistral/index.ts +++ b/extensions/mistral/index.ts @@ -1,6 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { mistralMediaUnderstandingProvider } from "./media-understanding-provider.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyMistralConfig, MISTRAL_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "mistral"; @@ -51,7 +50,6 @@ const mistralPlugin = { ], }, }); - api.registerMediaUnderstandingProvider(mistralMediaUnderstandingProvider); }, }; diff --git a/extensions/mistral/onboard.ts b/extensions/mistral/onboard.ts index 9a60e3f7c72..cefdeda2d01 100644 --- a/extensions/mistral/onboard.ts +++ b/extensions/mistral/onboard.ts @@ -1,16 +1,15 @@ -import { - applyAgentDefaultModelPrimary, - applyProviderConfigWithDefaultModel, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; import { buildMistralModelDefinition, MISTRAL_BASE_URL, MISTRAL_DEFAULT_MODEL_ID, - MISTRAL_DEFAULT_MODEL_REF, -} from "./model-definitions.js"; +} from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + applyProviderConfigWithDefaultModel, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; -export { MISTRAL_DEFAULT_MODEL_REF }; +export const MISTRAL_DEFAULT_MODEL_REF = `mistral/${MISTRAL_DEFAULT_MODEL_ID}`; export function applyMistralProviderConfig(cfg: OpenClawConfig): OpenClawConfig { const models = { ...cfg.agents?.defaults?.models }; diff --git a/extensions/modelstudio/index.ts b/extensions/modelstudio/index.ts index e4dc27ee6df..ad5c1852b59 100644 --- a/extensions/modelstudio/index.ts +++ b/extensions/modelstudio/index.ts @@ -1,6 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyModelStudioConfig, applyModelStudioConfigCn, @@ -79,13 +78,22 @@ const modelStudioPlugin = { ], catalog: { order: "simple", - run: (ctx) => - buildSingleProviderApiKeyCatalog({ - ctx, - providerId: PROVIDER_ID, - buildProvider: buildModelStudioProvider, - allowExplicitBaseUrl: true, - }), + run: async (ctx) => { + const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; + if (!apiKey) { + return null; + } + const explicitProvider = ctx.config.models?.providers?.[PROVIDER_ID]; + const explicitBaseUrl = + typeof explicitProvider?.baseUrl === "string" ? explicitProvider.baseUrl.trim() : ""; + return { + provider: { + ...buildModelStudioProvider(), + ...(explicitBaseUrl ? { baseUrl: explicitBaseUrl } : {}), + apiKey, + }, + }; + }, }, }); }, diff --git a/extensions/modelstudio/onboard.ts b/extensions/modelstudio/onboard.ts index 9a8760b8550..881b742dde4 100644 --- a/extensions/modelstudio/onboard.ts +++ b/extensions/modelstudio/onboard.ts @@ -1,13 +1,13 @@ -import { - applyAgentDefaultModelPrimary, - applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; import { MODELSTUDIO_CN_BASE_URL, MODELSTUDIO_DEFAULT_MODEL_REF, MODELSTUDIO_GLOBAL_BASE_URL, -} from "./model-definitions.js"; +} from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + applyProviderConfigWithModelCatalog, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildModelStudioProvider } from "./provider-catalog.js"; export { MODELSTUDIO_CN_BASE_URL, MODELSTUDIO_DEFAULT_MODEL_REF, MODELSTUDIO_GLOBAL_BASE_URL }; diff --git a/extensions/modelstudio/provider-catalog.ts b/extensions/modelstudio/provider-catalog.ts index ea9f2b2ae72..0908155a5f8 100644 --- a/extensions/modelstudio/provider-catalog.ts +++ b/extensions/modelstudio/provider-catalog.ts @@ -1,4 +1,7 @@ -import type { ModelDefinitionConfig, ModelProviderConfig } from "../../src/config/types.models.js"; +import type { + ModelDefinitionConfig, + ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; export const MODELSTUDIO_BASE_URL = "https://coding-intl.dashscope.aliyuncs.com/v1"; export const MODELSTUDIO_DEFAULT_MODEL_ID = "qwen3.5-plus"; diff --git a/extensions/moonshot/index.ts b/extensions/moonshot/index.ts index 5ef777edcc4..e8d7ecedb0c 100644 --- a/extensions/moonshot/index.ts +++ b/extensions/moonshot/index.ts @@ -1,17 +1,14 @@ +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { createMoonshotThinkingWrapper, resolveMoonshotThinkingType, -} from "../../src/agents/pi-embedded-runner/moonshot-stream-wrappers.js"; +} from "openclaw/plugin-sdk/provider-stream"; import { createPluginBackedWebSearchProvider, getScopedCredentialValue, setScopedCredentialValue, -} from "../../src/agents/tools/web-search-plugin-factory.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; -import { moonshotMediaUnderstandingProvider } from "./media-understanding-provider.js"; +} from "openclaw/plugin-sdk/provider-web-search"; import { applyMoonshotConfig, applyMoonshotConfigCn, @@ -36,8 +33,8 @@ const moonshotPlugin = { createProviderApiKeyAuthMethod({ providerId: PROVIDER_ID, methodId: "api-key", - label: "Moonshot API key (.ai)", - hint: "Kimi K2.5", + label: "Kimi API key (.ai)", + hint: "Kimi K2.5 + Kimi", optionKey: "moonshotApiKey", flagName: "--moonshot-api-key", envVar: "MOONSHOT_API_KEY", @@ -47,17 +44,17 @@ const moonshotPlugin = { applyConfig: (cfg) => applyMoonshotConfig(cfg), wizard: { choiceId: "moonshot-api-key", - choiceLabel: "Moonshot API key (.ai)", + choiceLabel: "Kimi API key (.ai)", groupId: "moonshot", groupLabel: "Moonshot AI (Kimi K2.5)", - groupHint: "Kimi K2.5", + groupHint: "Kimi K2.5 + Kimi", }, }), createProviderApiKeyAuthMethod({ providerId: PROVIDER_ID, methodId: "api-key-cn", - label: "Moonshot API key (.cn)", - hint: "Kimi K2.5", + label: "Kimi API key (.cn)", + hint: "Kimi K2.5 + Kimi", optionKey: "moonshotApiKey", flagName: "--moonshot-api-key", envVar: "MOONSHOT_API_KEY", @@ -67,22 +64,31 @@ const moonshotPlugin = { applyConfig: (cfg) => applyMoonshotConfigCn(cfg), wizard: { choiceId: "moonshot-api-key-cn", - choiceLabel: "Moonshot API key (.cn)", + choiceLabel: "Kimi API key (.cn)", groupId: "moonshot", groupLabel: "Moonshot AI (Kimi K2.5)", - groupHint: "Kimi K2.5", + groupHint: "Kimi K2.5 + Kimi", }, }), ], catalog: { order: "simple", - run: (ctx) => - buildSingleProviderApiKeyCatalog({ - ctx, - providerId: PROVIDER_ID, - buildProvider: buildMoonshotProvider, - allowExplicitBaseUrl: true, - }), + run: async (ctx) => { + const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; + if (!apiKey) { + return null; + } + const explicitProvider = ctx.config.models?.providers?.[PROVIDER_ID]; + const explicitBaseUrl = + typeof explicitProvider?.baseUrl === "string" ? explicitProvider.baseUrl.trim() : ""; + return { + provider: { + ...buildMoonshotProvider(), + ...(explicitBaseUrl ? { baseUrl: explicitBaseUrl } : {}), + apiKey, + }, + }; + }, }, wrapStreamFn: (ctx) => { const thinkingType = resolveMoonshotThinkingType({ @@ -92,7 +98,6 @@ const moonshotPlugin = { return createMoonshotThinkingWrapper(ctx.streamFn, thinkingType); }, }); - api.registerMediaUnderstandingProvider(moonshotMediaUnderstandingProvider); api.registerWebSearchProvider( createPluginBackedWebSearchProvider({ id: "kimi", diff --git a/extensions/moonshot/onboard.ts b/extensions/moonshot/onboard.ts index 57459b724ce..61cc537a622 100644 --- a/extensions/moonshot/onboard.ts +++ b/extensions/moonshot/onboard.ts @@ -1,8 +1,8 @@ import { applyAgentDefaultModelPrimary, applyProviderConfigWithDefaultModel, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildMoonshotProvider, MOONSHOT_BASE_URL, diff --git a/extensions/moonshot/provider-catalog.ts b/extensions/moonshot/provider-catalog.ts index 86ab93e6e05..37f7213701e 100644 --- a/extensions/moonshot/provider-catalog.ts +++ b/extensions/moonshot/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; export const MOONSHOT_BASE_URL = "https://api.moonshot.ai/v1"; export const MOONSHOT_DEFAULT_MODEL_ID = "kimi-k2.5"; diff --git a/extensions/msteams/src/outbound.ts b/extensions/msteams/src/outbound.ts index 60d78a2dac5..8f56ab2ce4c 100644 --- a/extensions/msteams/src/outbound.ts +++ b/extensions/msteams/src/outbound.ts @@ -1,5 +1,5 @@ +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/msteams"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; import { createMSTeamsPollStoreFs } from "./polls.js"; import { getMSTeamsRuntime } from "./runtime.js"; import { sendMessageMSTeams, sendPollMSTeams } from "./send.js"; diff --git a/extensions/nextcloud-talk/src/setup-core.ts b/extensions/nextcloud-talk/src/setup-core.ts index a94482b8d43..0b74753dcb6 100644 --- a/extensions/nextcloud-talk/src/setup-core.ts +++ b/extensions/nextcloud-talk/src/setup-core.ts @@ -1,21 +1,21 @@ +import type { ChannelSetupAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelSetupInput } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { + applyAccountNameToChannelSection, patchScopedAccountConfig, - prepareScopedSetupConfig, -} from "../../../src/channels/plugins/setup-helpers.js"; +} from "openclaw/plugin-sdk/setup"; import { mergeAllowFromEntries, resolveSetupAccountId, setSetupChannelEnabled, setTopLevelChannelDmPolicyWithAllowFrom, -} from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupDmPolicy } from "../../../src/channels/plugins/setup-wizard-types.js"; -import { type ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { ChannelSetupInput } from "../../../src/channels/plugins/types.core.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "openclaw/plugin-sdk/setup"; +import type { WizardPrompter } from "openclaw/plugin-sdk/setup"; import { listNextcloudTalkAccountIds, resolveDefaultNextcloudTalkAccountId, @@ -115,7 +115,7 @@ export function clearNextcloudTalkAccountFields( } as CoreConfig; } -export async function promptNextcloudTalkAllowFrom(params: { +async function promptNextcloudTalkAllowFrom(params: { cfg: CoreConfig; prompter: WizardPrompter; accountId: string; @@ -127,7 +127,7 @@ export async function promptNextcloudTalkAllowFrom(params: { "1) Check the Nextcloud admin panel for user IDs", "2) Or look at the webhook payload logs when someone messages", "3) User IDs are typically lowercase usernames in Nextcloud", - `Docs: ${formatDocsLink("/channels/nextcloud-talk", "channels/nextcloud-talk")}`, + `Docs: ${formatDocsLink("/channels/nextcloud-talk", "nextcloud-talk")}`, ].join("\n"), "Nextcloud Talk user id", ); @@ -158,7 +158,7 @@ export async function promptNextcloudTalkAllowFrom(params: { }); } -export async function promptNextcloudTalkAllowFromForAccount(params: { +async function promptNextcloudTalkAllowFromForAccount(params: { cfg: OpenClawConfig; prompter: WizardPrompter; accountId?: string; @@ -174,7 +174,7 @@ export async function promptNextcloudTalkAllowFromForAccount(params: { }); } -export const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { +const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { label: "Nextcloud Talk", channel, policyKey: "channels.nextcloud-talk.dmPolicy", @@ -187,7 +187,7 @@ export const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { export const nextcloudTalkSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => - prepareScopedSetupConfig({ + applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, @@ -208,7 +208,7 @@ export const nextcloudTalkSetupAdapter: ChannelSetupAdapter = { }, applyAccountConfig: ({ cfg, accountId, input }) => { const setupInput = input as NextcloudSetupInput; - const namedConfig = prepareScopedSetupConfig({ + const namedConfig = applyAccountNameToChannelSection({ cfg, channelKey: channel, accountId, diff --git a/extensions/nextcloud-talk/src/setup-surface.ts b/extensions/nextcloud-talk/src/setup-surface.ts index 46561f5b274..ecb7b29084d 100644 --- a/extensions/nextcloud-talk/src/setup-surface.ts +++ b/extensions/nextcloud-talk/src/setup-surface.ts @@ -1,22 +1,111 @@ -import { setSetupChannelEnabled } from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import { type ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import { listNextcloudTalkAccountIds, resolveNextcloudTalkAccount } from "./accounts.js"; +import type { ChannelSetupInput } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { hasConfiguredSecretInput } from "openclaw/plugin-sdk/config-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; +import { + mergeAllowFromEntries, + resolveSetupAccountId, + setSetupChannelEnabled, + setTopLevelChannelDmPolicyWithAllowFrom, +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "openclaw/plugin-sdk/setup"; +import type { WizardPrompter } from "openclaw/plugin-sdk/setup"; +import { + listNextcloudTalkAccountIds, + resolveDefaultNextcloudTalkAccountId, + resolveNextcloudTalkAccount, +} from "./accounts.js"; import { clearNextcloudTalkAccountFields, - nextcloudTalkDmPolicy, nextcloudTalkSetupAdapter, normalizeNextcloudTalkBaseUrl, setNextcloudTalkAccountConfig, validateNextcloudTalkBaseUrl, } from "./setup-core.js"; -import type { CoreConfig } from "./types.js"; +import type { CoreConfig, DmPolicy } from "./types.js"; const channel = "nextcloud-talk" as const; const CONFIGURE_API_FLAG = "__nextcloudTalkConfigureApiCredentials"; +function setNextcloudTalkDmPolicy(cfg: CoreConfig, dmPolicy: DmPolicy): CoreConfig { + return setTopLevelChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy, + }) as CoreConfig; +} + +async function promptNextcloudTalkAllowFrom(params: { + cfg: CoreConfig; + prompter: WizardPrompter; + accountId: string; +}): Promise { + const resolved = resolveNextcloudTalkAccount({ cfg: params.cfg, accountId: params.accountId }); + const existingAllowFrom = resolved.config.allowFrom ?? []; + await params.prompter.note( + [ + "1) Check the Nextcloud admin panel for user IDs", + "2) Or look at the webhook payload logs when someone messages", + "3) User IDs are typically lowercase usernames in Nextcloud", + `Docs: ${formatDocsLink("/channels/nextcloud-talk", "channels/nextcloud-talk")}`, + ].join("\n"), + "Nextcloud Talk user id", + ); + + let resolvedIds: string[] = []; + while (resolvedIds.length === 0) { + const entry = await params.prompter.text({ + message: "Nextcloud Talk allowFrom (user id)", + placeholder: "username", + initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined, + validate: (value) => (String(value ?? "").trim() ? undefined : "Required"), + }); + resolvedIds = String(entry) + .split(/[\n,;]+/g) + .map((value) => value.trim().toLowerCase()) + .filter(Boolean); + if (resolvedIds.length === 0) { + await params.prompter.note("Please enter at least one valid user ID.", "Nextcloud Talk"); + } + } + + return setNextcloudTalkAccountConfig(params.cfg, params.accountId, { + dmPolicy: "allowlist", + allowFrom: mergeAllowFromEntries( + existingAllowFrom.map((value) => String(value).trim().toLowerCase()), + resolvedIds, + ), + }); +} + +async function promptNextcloudTalkAllowFromForAccount(params: { + cfg: OpenClawConfig; + prompter: WizardPrompter; + accountId?: string; +}): Promise { + const accountId = resolveSetupAccountId({ + accountId: params.accountId, + defaultAccountId: resolveDefaultNextcloudTalkAccountId(params.cfg as CoreConfig), + }); + return await promptNextcloudTalkAllowFrom({ + cfg: params.cfg as CoreConfig, + prompter: params.prompter, + accountId, + }); +} + +const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { + label: "Nextcloud Talk", + channel, + policyKey: "channels.nextcloud-talk.dmPolicy", + allowFromKey: "channels.nextcloud-talk.allowFrom", + getCurrent: (cfg) => cfg.channels?.["nextcloud-talk"]?.dmPolicy ?? "pairing", + setPolicy: (cfg, policy) => setNextcloudTalkDmPolicy(cfg as CoreConfig, policy as DmPolicy), + promptAllowFrom: promptNextcloudTalkAllowFromForAccount, +}; + export const nextcloudTalkSetupWizard: ChannelSetupWizard = { channel, stepOrder: "text-first", diff --git a/extensions/nostr/src/setup-surface.ts b/extensions/nostr/src/setup-surface.ts index e284d7b68a6..fca302e75fb 100644 --- a/extensions/nostr/src/setup-surface.ts +++ b/extensions/nostr/src/setup-surface.ts @@ -1,18 +1,18 @@ +import type { ChannelSetupAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { DmPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; import { mergeAllowFromEntries, parseSetupEntriesWithParser, setTopLevelChannelAllowFrom, setTopLevelChannelDmPolicyWithAllowFrom, splitSetupEntries, -} from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupDmPolicy } from "../../../src/channels/plugins/setup-wizard-types.js"; -import type { ChannelSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "openclaw/plugin-sdk/setup"; +import type { WizardPrompter } from "openclaw/plugin-sdk/setup"; import { DEFAULT_RELAYS } from "./default-relays.js"; import { getPublicKeyFromPrivate, normalizePubkey } from "./nostr-bus.js"; import { resolveNostrAccount } from "./types.js"; diff --git a/extensions/nvidia/provider-catalog.ts b/extensions/nvidia/provider-catalog.ts index f506839fa33..ce66986e20a 100644 --- a/extensions/nvidia/provider-catalog.ts +++ b/extensions/nvidia/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; const NVIDIA_BASE_URL = "https://integrate.api.nvidia.com/v1"; const NVIDIA_DEFAULT_MODEL_ID = "nvidia/llama-3.1-nemotron-70b-instruct"; diff --git a/extensions/ollama/index.ts b/extensions/ollama/index.ts index 5386a37d270..6f75f9b08a5 100644 --- a/extensions/ollama/index.ts +++ b/extensions/ollama/index.ts @@ -6,8 +6,7 @@ import { type ProviderAuthResult, type ProviderDiscoveryContext, } from "openclaw/plugin-sdk/core"; -import { OLLAMA_DEFAULT_BASE_URL } from "../../src/agents/ollama-defaults.js"; -import { resolveOllamaApiBase } from "../../src/agents/ollama-models.js"; +import { OLLAMA_DEFAULT_BASE_URL, resolveOllamaApiBase } from "openclaw/plugin-sdk/provider-models"; const PROVIDER_ID = "ollama"; const DEFAULT_API_KEY = "ollama-local"; diff --git a/extensions/openai/index.ts b/extensions/openai/index.ts index e45c9718087..831e49acdd8 100644 --- a/extensions/openai/index.ts +++ b/extensions/openai/index.ts @@ -1,6 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { buildOpenAISpeechProvider } from "../../src/tts/providers/openai.js"; -import { openaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; +import { buildOpenAISpeechProvider } from "openclaw/plugin-sdk/speech"; import { buildOpenAICodexProviderPlugin } from "./openai-codex-provider.js"; import { buildOpenAIProvider } from "./openai-provider.js"; @@ -13,7 +12,6 @@ const openAIPlugin = { api.registerProvider(buildOpenAIProvider()); api.registerProvider(buildOpenAICodexProviderPlugin()); api.registerSpeechProvider(buildOpenAISpeechProvider()); - api.registerMediaUnderstandingProvider(openaiMediaUnderstandingProvider); }, }; diff --git a/extensions/openai/openai-codex-catalog.ts b/extensions/openai/openai-codex-catalog.ts index ecea655547b..11c1d564986 100644 --- a/extensions/openai/openai-codex-catalog.ts +++ b/extensions/openai/openai-codex-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; export const OPENAI_CODEX_BASE_URL = "https://chatgpt.com/backend-api"; diff --git a/extensions/openai/openai-codex-provider.ts b/extensions/openai/openai-codex-provider.ts index e8be8bd4eb1..6ea59a2e7a7 100644 --- a/extensions/openai/openai-codex-provider.ts +++ b/extensions/openai/openai-codex-provider.ts @@ -5,16 +5,20 @@ import type { ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/core"; -import { CODEX_CLI_PROFILE_ID } from "../../src/agents/auth-profiles.js"; -import { listProfilesForProvider } from "../../src/agents/auth-profiles/profiles.js"; -import { ensureAuthProfileStore } from "../../src/agents/auth-profiles/store.js"; -import type { OAuthCredential } from "../../src/agents/auth-profiles/types.js"; -import { DEFAULT_CONTEXT_TOKENS } from "../../src/agents/defaults.js"; -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { normalizeProviderId } from "../../src/agents/provider-id.js"; -import { loginOpenAICodexOAuth } from "../../src/commands/openai-codex-oauth.js"; -import { fetchCodexUsage } from "../../src/infra/provider-usage.fetch.js"; -import type { ProviderPlugin } from "../../src/plugins/types.js"; +import { + CODEX_CLI_PROFILE_ID, + ensureAuthProfileStore, + listProfilesForProvider, + loginOpenAICodexOAuth, + type OAuthCredential, +} from "openclaw/plugin-sdk/provider-auth"; +import { + DEFAULT_CONTEXT_TOKENS, + normalizeModelCompat, + normalizeProviderId, + type ProviderPlugin, +} from "openclaw/plugin-sdk/provider-models"; +import { fetchCodexUsage } from "openclaw/plugin-sdk/provider-usage"; import { buildOpenAICodexProvider } from "./openai-codex-catalog.js"; import { cloneFirstTemplateModel, diff --git a/extensions/openai/openai-provider.ts b/extensions/openai/openai-provider.ts index 9c93ec1bd27..8e97b56573f 100644 --- a/extensions/openai/openai-provider.ts +++ b/extensions/openai/openai-provider.ts @@ -2,14 +2,14 @@ import { type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { normalizeProviderId } from "../../src/agents/provider-id.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyOpenAIConfig, + normalizeModelCompat, + normalizeProviderId, OPENAI_DEFAULT_MODEL, -} from "../../src/commands/openai-model-default.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import type { ProviderPlugin } from "../../src/plugins/types.js"; + type ProviderPlugin, +} from "openclaw/plugin-sdk/provider-models"; import { cloneFirstTemplateModel, findCatalogTemplate, diff --git a/extensions/openai/shared.ts b/extensions/openai/shared.ts index ad469a2f136..2b67454fc07 100644 --- a/extensions/openai/shared.ts +++ b/extensions/openai/shared.ts @@ -1,9 +1,8 @@ -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { findCatalogTemplate } from "../../src/plugins/provider-catalog.js"; import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, -} from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/core"; +import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; export const OPENAI_API_BASE_URL = "https://api.openai.com/v1"; @@ -49,4 +48,18 @@ export function cloneFirstTemplateModel(params: { return undefined; } -export { findCatalogTemplate }; +export function findCatalogTemplate(params: { + entries: ReadonlyArray<{ provider: string; id: string }>; + providerId: string; + templateIds: readonly string[]; +}) { + return params.templateIds + .map((templateId) => + params.entries.find( + (entry) => + entry.provider.toLowerCase() === params.providerId.toLowerCase() && + entry.id.toLowerCase() === templateId.toLowerCase(), + ), + ) + .find((entry) => entry !== undefined); +} diff --git a/extensions/opencode-go/index.ts b/extensions/opencode-go/index.ts index ddfd9a5858c..09319628684 100644 --- a/extensions/opencode-go/index.ts +++ b/extensions/opencode-go/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { OPENCODE_GO_DEFAULT_MODEL_REF } from "../../src/commands/opencode-go-model-default.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { OPENCODE_GO_DEFAULT_MODEL_REF } from "openclaw/plugin-sdk/provider-models"; import { applyOpencodeGoConfig } from "./onboard.js"; const PROVIDER_ID = "opencode-go"; diff --git a/extensions/opencode-go/onboard.ts b/extensions/opencode-go/onboard.ts index 8ca47a0f9d0..ec5727f9525 100644 --- a/extensions/opencode-go/onboard.ts +++ b/extensions/opencode-go/onboard.ts @@ -1,6 +1,8 @@ -import { applyAgentDefaultModelPrimary } from "../../src/commands/onboard-auth.config-shared.js"; -import { OPENCODE_GO_DEFAULT_MODEL_REF } from "../../src/commands/opencode-go-model-default.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; +import { OPENCODE_GO_DEFAULT_MODEL_REF } from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export { OPENCODE_GO_DEFAULT_MODEL_REF }; diff --git a/extensions/opencode/index.ts b/extensions/opencode/index.ts index 01ccea24656..4f9bbb1384a 100644 --- a/extensions/opencode/index.ts +++ b/extensions/opencode/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { OPENCODE_ZEN_DEFAULT_MODEL } from "../../src/commands/opencode-zen-model-default.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { OPENCODE_ZEN_DEFAULT_MODEL } from "openclaw/plugin-sdk/provider-models"; import { applyOpencodeZenConfig } from "./onboard.js"; const PROVIDER_ID = "opencode"; diff --git a/extensions/opencode/onboard.ts b/extensions/opencode/onboard.ts index a308129b688..5bccbb34d8a 100644 --- a/extensions/opencode/onboard.ts +++ b/extensions/opencode/onboard.ts @@ -1,6 +1,8 @@ -import { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "../../src/agents/opencode-zen-models.js"; -import { applyAgentDefaultModelPrimary } from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; +import { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export { OPENCODE_ZEN_DEFAULT_MODEL_REF }; diff --git a/extensions/openrouter/index.ts b/extensions/openrouter/index.ts index 2246424787a..b4c1d908c4f 100644 --- a/extensions/openrouter/index.ts +++ b/extensions/openrouter/index.ts @@ -5,17 +5,15 @@ import { type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { DEFAULT_CONTEXT_TOKENS } from "../../src/agents/defaults.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { DEFAULT_CONTEXT_TOKENS } from "openclaw/plugin-sdk/provider-models"; import { getOpenRouterModelCapabilities, loadOpenRouterModelCapabilities, -} from "../../src/agents/pi-embedded-runner/openrouter-model-capabilities.js"; -import { createOpenRouterSystemCacheWrapper, createOpenRouterWrapper, isProxyReasoningUnsupported, -} from "../../src/agents/pi-embedded-runner/proxy-stream-wrappers.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +} from "openclaw/plugin-sdk/provider-stream"; import { applyOpenrouterConfig, OPENROUTER_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildOpenrouterProvider } from "./provider-catalog.js"; diff --git a/extensions/openrouter/onboard.ts b/extensions/openrouter/onboard.ts index 03ec7bf86bc..f5662399192 100644 --- a/extensions/openrouter/onboard.ts +++ b/extensions/openrouter/onboard.ts @@ -1,5 +1,7 @@ -import { applyAgentDefaultModelPrimary } from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; +import { + applyAgentDefaultModelPrimary, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export const OPENROUTER_DEFAULT_MODEL_REF = "openrouter/auto"; diff --git a/extensions/openrouter/provider-catalog.ts b/extensions/openrouter/provider-catalog.ts index cfb5fecf8bf..52be862e34d 100644 --- a/extensions/openrouter/provider-catalog.ts +++ b/extensions/openrouter/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; const OPENROUTER_BASE_URL = "https://openrouter.ai/api/v1"; const OPENROUTER_DEFAULT_MODEL_ID = "auto"; diff --git a/extensions/perplexity/index.ts b/extensions/perplexity/index.ts index 513c70d131d..0fe3034a000 100644 --- a/extensions/perplexity/index.ts +++ b/extensions/perplexity/index.ts @@ -1,10 +1,9 @@ +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createPluginBackedWebSearchProvider, getScopedCredentialValue, setScopedCredentialValue, -} from "../../src/agents/tools/web-search-plugin-factory.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/provider-web-search"; const perplexityPlugin = { id: "perplexity", diff --git a/extensions/qianfan/index.ts b/extensions/qianfan/index.ts index 04bd8429755..e8f2f2cc59d 100644 --- a/extensions/qianfan/index.ts +++ b/extensions/qianfan/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyQianfanConfig, QIANFAN_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildQianfanProvider } from "./provider-catalog.js"; diff --git a/extensions/qianfan/onboard.ts b/extensions/qianfan/onboard.ts index 6df59e49a40..c389868c7d8 100644 --- a/extensions/qianfan/onboard.ts +++ b/extensions/qianfan/onboard.ts @@ -1,9 +1,9 @@ import { applyAgentDefaultModelPrimary, applyProviderConfigWithDefaultModels, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; -import type { ModelApi } from "../../src/config/types.models.js"; + type ModelApi, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildQianfanProvider, QIANFAN_BASE_URL, diff --git a/extensions/qianfan/provider-catalog.ts b/extensions/qianfan/provider-catalog.ts index f96fca8e14c..c8aee208a8e 100644 --- a/extensions/qianfan/provider-catalog.ts +++ b/extensions/qianfan/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; export const QIANFAN_BASE_URL = "https://qianfan.baidubce.com/v2"; export const QIANFAN_DEFAULT_MODEL_ID = "deepseek-v3.2"; diff --git a/extensions/qwen-portal-auth/index.ts b/extensions/qwen-portal-auth/index.ts index 7c64c9b7683..2a9538a33ab 100644 --- a/extensions/qwen-portal-auth/index.ts +++ b/extensions/qwen-portal-auth/index.ts @@ -1,3 +1,5 @@ +import { ensureAuthProfileStore, listProfilesForProvider } from "openclaw/plugin-sdk/agent-runtime"; +import { QWEN_OAUTH_MARKER } from "openclaw/plugin-sdk/agent-runtime"; import { buildOauthProviderAuthResult, emptyPluginConfigSchema, @@ -5,9 +7,7 @@ import { type ProviderAuthContext, type ProviderCatalogContext, } from "openclaw/plugin-sdk/qwen-portal-auth"; -import { ensureAuthProfileStore, listProfilesForProvider } from "../../src/agents/auth-profiles.js"; -import { QWEN_OAUTH_MARKER } from "../../src/agents/model-auth-markers.js"; -import { refreshQwenPortalCredentials } from "../../src/providers/qwen-portal-oauth.js"; +import { refreshQwenPortalCredentials } from "openclaw/plugin-sdk/qwen-portal-auth"; import { loginQwenPortalOAuth } from "./oauth.js"; import { buildQwenPortalProvider, QWEN_PORTAL_BASE_URL } from "./provider-catalog.js"; diff --git a/extensions/qwen-portal-auth/provider-catalog.ts b/extensions/qwen-portal-auth/provider-catalog.ts index aa038c0810e..f8d350fc2da 100644 --- a/extensions/qwen-portal-auth/provider-catalog.ts +++ b/extensions/qwen-portal-auth/provider-catalog.ts @@ -1,4 +1,7 @@ -import type { ModelDefinitionConfig, ModelProviderConfig } from "../../src/config/types.models.js"; +import type { + ModelDefinitionConfig, + ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; export const QWEN_PORTAL_BASE_URL = "https://portal.qwen.ai/v1"; const QWEN_PORTAL_DEFAULT_CONTEXT_WINDOW = 128000; diff --git a/extensions/sglang/index.ts b/extensions/sglang/index.ts index fc7522ef15b..9918c7ee98b 100644 --- a/extensions/sglang/index.ts +++ b/extensions/sglang/index.ts @@ -1,14 +1,14 @@ -import { - emptyPluginConfigSchema, - type OpenClawPluginApi, - type ProviderAuthMethodNonInteractiveContext, -} from "openclaw/plugin-sdk/core"; import { SGLANG_DEFAULT_API_KEY_ENV_VAR, SGLANG_DEFAULT_BASE_URL, SGLANG_MODEL_PLACEHOLDER, SGLANG_PROVIDER_LABEL, -} from "../../src/agents/sglang-defaults.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { + emptyPluginConfigSchema, + type OpenClawPluginApi, + type ProviderAuthMethodNonInteractiveContext, +} from "openclaw/plugin-sdk/core"; const PROVIDER_ID = "sglang"; diff --git a/extensions/signal/src/accounts.ts b/extensions/signal/src/accounts.ts index 30a3b56189c..456db907685 100644 --- a/extensions/signal/src/accounts.ts +++ b/extensions/signal/src/accounts.ts @@ -1,10 +1,10 @@ import { - type OpenClawConfig, createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; -import type { SignalAccountConfig } from "../../../src/plugin-sdk-internal/signal.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { SignalAccountConfig } from "openclaw/plugin-sdk/signal"; export type ResolvedSignalAccount = { accountId: string; diff --git a/extensions/signal/src/channel.setup.ts b/extensions/signal/src/channel.setup.ts index d633ff6a251..b81d10cc99d 100644 --- a/extensions/signal/src/channel.setup.ts +++ b/extensions/signal/src/channel.setup.ts @@ -1,9 +1,94 @@ -import { type ChannelPlugin } from "openclaw/plugin-sdk/signal"; -import { type ResolvedSignalAccount } from "./accounts.js"; +import { + buildAccountScopedDmSecurityPolicy, + collectAllowlistProviderRestrictSendersWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, + deleteAccountFromConfigSection, + getChatChannelMeta, + normalizeE164, + setAccountEnabledInConfigSection, + SignalConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/signal"; +import { + listSignalAccountIds, + resolveDefaultSignalAccountId, + resolveSignalAccount, + type ResolvedSignalAccount, +} from "./accounts.js"; +import { signalConfigAccessors, signalSetupWizard } from "./plugin-shared.js"; import { signalSetupAdapter } from "./setup-core.js"; -import { createSignalPluginBase, signalSetupWizard } from "./shared.js"; -export const signalSetupPlugin: ChannelPlugin = createSignalPluginBase({ +export const signalSetupPlugin: ChannelPlugin = { + id: "signal", + meta: { + ...getChatChannelMeta("signal"), + }, setupWizard: signalSetupWizard, + capabilities: { + chatTypes: ["direct", "group"], + media: true, + reactions: true, + }, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.signal"] }, + configSchema: buildChannelConfigSchema(SignalConfigSchema), + config: { + listAccountIds: (cfg) => listSignalAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveSignalAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultSignalAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => + setAccountEnabledInConfigSection({ + cfg, + sectionKey: "signal", + accountId, + enabled, + allowTopLevel: true, + }), + deleteAccount: ({ cfg, accountId }) => + deleteAccountFromConfigSection({ + cfg, + sectionKey: "signal", + accountId, + clearBaseFields: ["account", "httpUrl", "httpHost", "httpPort", "cliPath", "name"], + }), + isConfigured: (account) => account.configured, + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: account.configured, + baseUrl: account.baseUrl, + }), + ...signalConfigAccessors, + }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => + buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "signal", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.config.dmPolicy, + allowFrom: account.config.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + normalizeEntry: (raw) => normalizeE164(raw.replace(/^signal:/i, "").trim()), + }), + collectWarnings: ({ account, cfg }) => + collectAllowlistProviderRestrictSendersWarnings({ + cfg, + providerConfigPresent: cfg.channels?.signal !== undefined, + configuredGroupPolicy: account.config.groupPolicy, + surface: "Signal groups", + openScope: "any member", + groupPolicyPath: "channels.signal.groupPolicy", + groupAllowFromPath: "channels.signal.groupAllowFrom", + mentionGated: false, + }), + }, setup: signalSetupAdapter, -}); +}; diff --git a/extensions/signal/src/channel.ts b/extensions/signal/src/channel.ts index 2b392bbacf2..aba60d3e29a 100644 --- a/extensions/signal/src/channel.ts +++ b/extensions/signal/src/channel.ts @@ -1,21 +1,31 @@ -import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/compat"; +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; +import { + buildAccountScopedDmSecurityPolicy, + collectAllowlistProviderRestrictSendersWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; import { buildBaseAccountStatusSnapshot, buildBaseChannelStatusSummary, + buildChannelConfigSchema, collectStatusIssuesFromLastError, createDefaultChannelRuntimeState, DEFAULT_ACCOUNT_ID, + deleteAccountFromConfigSection, + getChatChannelMeta, looksLikeSignalTargetId, + normalizeE164, normalizeSignalMessagingTarget, PAIRING_APPROVED_MESSAGE, resolveChannelMediaMaxBytes, + setAccountEnabledInConfigSection, + SignalConfigSchema, type ChannelMessageActionAdapter, type ChannelPlugin, } from "openclaw/plugin-sdk/signal"; -import { resolveTextChunkLimit } from "../../../src/auto-reply/chunk.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, @@ -29,10 +39,10 @@ import { resolveSignalRecipient, resolveSignalSender, } from "./identity.js"; +import { signalConfigAccessors, signalSetupWizard } from "./plugin-shared.js"; import type { SignalProbe } from "./probe.js"; import { getSignalRuntime } from "./runtime.js"; import { signalSetupAdapter } from "./setup-core.js"; -import { createSignalPluginBase, signalConfigAccessors, signalSetupWizard } from "./shared.js"; const signalMessageActions: ChannelMessageActionAdapter = { listActions: (ctx) => getSignalRuntime().channel.signal.messageActions?.listActions?.(ctx) ?? [], @@ -282,10 +292,11 @@ async function sendFormattedSignalMedia(ctx: { } export const signalPlugin: ChannelPlugin = { - ...createSignalPluginBase({ - setupWizard: signalSetupWizard, - setup: signalSetupAdapter, - }), + id: "signal", + meta: { + ...getChatChannelMeta("signal"), + }, + setupWizard: signalSetupWizard, pairing: { idLabel: "signalNumber", normalizeAllowEntry: (entry) => entry.replace(/^signal:/i, ""), @@ -293,7 +304,46 @@ export const signalPlugin: ChannelPlugin = { await getSignalRuntime().channel.signal.sendMessageSignal(id, PAIRING_APPROVED_MESSAGE); }, }, + capabilities: { + chatTypes: ["direct", "group"], + media: true, + reactions: true, + }, actions: signalMessageActions, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.signal"] }, + configSchema: buildChannelConfigSchema(SignalConfigSchema), + config: { + listAccountIds: (cfg) => listSignalAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveSignalAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultSignalAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => + setAccountEnabledInConfigSection({ + cfg, + sectionKey: "signal", + accountId, + enabled, + allowTopLevel: true, + }), + deleteAccount: ({ cfg, accountId }) => + deleteAccountFromConfigSection({ + cfg, + sectionKey: "signal", + accountId, + clearBaseFields: ["account", "httpUrl", "httpHost", "httpPort", "cliPath", "name"], + }), + isConfigured: (account) => account.configured, + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: account.configured, + baseUrl: account.baseUrl, + }), + ...signalConfigAccessors, + }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { @@ -315,6 +365,32 @@ export const signalPlugin: ChannelPlugin = { }), }), }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => { + return buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "signal", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.config.dmPolicy, + allowFrom: account.config.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + normalizeEntry: (raw) => normalizeE164(raw.replace(/^signal:/i, "").trim()), + }); + }, + collectWarnings: ({ account, cfg }) => { + return collectAllowlistProviderRestrictSendersWarnings({ + cfg, + providerConfigPresent: cfg.channels?.signal !== undefined, + configuredGroupPolicy: account.config.groupPolicy, + surface: "Signal groups", + openScope: "any member", + groupPolicyPath: "channels.signal.groupPolicy", + groupAllowFromPath: "channels.signal.groupAllowFrom", + mentionGated: false, + }); + }, + }, messaging: { normalizeTarget: normalizeSignalMessagingTarget, parseExplicitTarget: ({ raw }) => parseSignalExplicitTarget(raw), @@ -325,6 +401,7 @@ export const signalPlugin: ChannelPlugin = { hint: "", }, }, + setup: signalSetupAdapter, outbound: { deliveryMode: "direct", chunker: (text, limit) => getSignalRuntime().channel.text.chunkText(text, limit), diff --git a/extensions/signal/src/client.ts b/extensions/signal/src/client.ts index 394aec4e297..4a6d63bd685 100644 --- a/extensions/signal/src/client.ts +++ b/extensions/signal/src/client.ts @@ -1,6 +1,6 @@ -import { resolveFetch } from "../../../src/infra/fetch.js"; -import { generateSecureUuid } from "../../../src/infra/secure-random.js"; -import { fetchWithTimeout } from "../../../src/utils/fetch-timeout.js"; +import { resolveFetch } from "openclaw/plugin-sdk/infra-runtime"; +import { generateSecureUuid } from "openclaw/plugin-sdk/infra-runtime"; +import { fetchWithTimeout } from "openclaw/plugin-sdk/text-runtime"; export type SignalRpcOptions = { baseUrl: string; diff --git a/extensions/signal/src/daemon.ts b/extensions/signal/src/daemon.ts index d53597a296b..028b9fbe964 100644 --- a/extensions/signal/src/daemon.ts +++ b/extensions/signal/src/daemon.ts @@ -1,5 +1,5 @@ import { spawn } from "node:child_process"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; export type SignalDaemonOpts = { cliPath: string; diff --git a/extensions/signal/src/format.ts b/extensions/signal/src/format.ts index 2180693293e..73574832df8 100644 --- a/extensions/signal/src/format.ts +++ b/extensions/signal/src/format.ts @@ -1,10 +1,10 @@ -import type { MarkdownTableMode } from "../../../src/config/types.base.js"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; import { chunkMarkdownIR, markdownToIR, type MarkdownIR, type MarkdownStyle, -} from "../../../src/markdown/ir.js"; +} from "openclaw/plugin-sdk/text-runtime"; type SignalTextStyle = "BOLD" | "ITALIC" | "STRIKETHROUGH" | "MONOSPACE" | "SPOILER"; diff --git a/extensions/signal/src/identity.ts b/extensions/signal/src/identity.ts index 464713559c3..dbd86ca1584 100644 --- a/extensions/signal/src/identity.ts +++ b/extensions/signal/src/identity.ts @@ -1,5 +1,5 @@ -import { evaluateSenderGroupAccessForPolicy } from "../../../src/plugin-sdk-internal/signal.js"; -import { normalizeE164 } from "../../../src/utils.js"; +import { evaluateSenderGroupAccessForPolicy } from "openclaw/plugin-sdk/group-access"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; export type SignalSender = | { kind: "phone"; raw: string; e164: string } diff --git a/extensions/signal/src/monitor.tool-result.test-harness.ts b/extensions/signal/src/monitor.tool-result.test-harness.ts index 252e039b0fb..10cf32b383a 100644 --- a/extensions/signal/src/monitor.tool-result.test-harness.ts +++ b/extensions/signal/src/monitor.tool-result.test-harness.ts @@ -1,7 +1,7 @@ +import { resetSystemEventsForTest } from "openclaw/plugin-sdk/infra-runtime"; +import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { beforeEach, vi } from "vitest"; -import { resetInboundDedupe } from "../../../src/auto-reply/reply/inbound-dedupe.js"; -import { resetSystemEventsForTest } from "../../../src/infra/system-events.js"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; import type { SignalDaemonExitEvent, SignalDaemonHandle } from "./daemon.js"; type SignalToolResultTestMocks = { @@ -68,15 +68,15 @@ export function createMockSignalDaemonHandle( }; } -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => config, }; }); -vi.mock("../../../src/auto-reply/reply.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ getReplyFromConfig: (...args: unknown[]) => replyMock(...args), })); @@ -86,13 +86,13 @@ vi.mock("./send.js", () => ({ sendReadReceiptSignal: vi.fn().mockResolvedValue(true), })); -vi.mock("../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: (...args: unknown[]) => readAllowFromStoreMock(...args), upsertChannelPairingRequest: (...args: unknown[]) => upsertPairingRequestMock(...args), })); -vi.mock("../../../src/config/sessions.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, resolveStorePath: vi.fn(() => "/tmp/openclaw-sessions.json"), @@ -116,7 +116,7 @@ vi.mock("./daemon.js", async (importOriginal) => { }; }); -vi.mock("../../../src/infra/transport-ready.js", () => ({ +vi.mock("openclaw/plugin-sdk/infra-runtime", () => ({ waitForTransportReady: (...args: unknown[]) => waitForTransportReadyMock(...args), })); diff --git a/extensions/signal/src/monitor.ts b/extensions/signal/src/monitor.ts index 3febfe740d4..02fd94ff8b8 100644 --- a/extensions/signal/src/monitor.ts +++ b/extensions/signal/src/monitor.ts @@ -1,27 +1,24 @@ -import { - chunkTextWithMode, - resolveChunkMode, - resolveTextChunkLimit, -} from "../../../src/auto-reply/chunk.js"; -import { - DEFAULT_GROUP_HISTORY_LIMIT, - type HistoryEntry, -} from "../../../src/auto-reply/reply/history.js"; -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { loadConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveAllowlistProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, -} from "../../../src/config/runtime-group-policy.js"; -import type { SignalReactionNotificationMode } from "../../../src/config/types.js"; -import type { BackoffPolicy } from "../../../src/infra/backoff.js"; -import { waitForTransportReady } from "../../../src/infra/transport-ready.js"; -import { saveMediaBuffer } from "../../../src/media/store.js"; -import { createNonExitingRuntime, type RuntimeEnv } from "../../../src/runtime.js"; -import { normalizeStringEntries } from "../../../src/shared/string-normalization.js"; -import { normalizeE164 } from "../../../src/utils.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { SignalReactionNotificationMode } from "openclaw/plugin-sdk/config-runtime"; +import type { BackoffPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { waitForTransportReady } from "openclaw/plugin-sdk/infra-runtime"; +import { saveMediaBuffer } from "openclaw/plugin-sdk/media-runtime"; +import { + chunkTextWithMode, + resolveChunkMode, + resolveTextChunkLimit, +} from "openclaw/plugin-sdk/reply-runtime"; +import { DEFAULT_GROUP_HISTORY_LIMIT, type HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { normalizeStringEntries } from "openclaw/plugin-sdk/text-runtime"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import { resolveSignalAccount } from "./accounts.js"; import { signalCheck, signalRpcRequest } from "./client.js"; import { formatSignalDaemonExit, spawnSignalDaemon, type SignalDaemonHandle } from "./daemon.js"; diff --git a/extensions/signal/src/monitor/access-policy.ts b/extensions/signal/src/monitor/access-policy.ts index 72555186031..de083efd9fd 100644 --- a/extensions/signal/src/monitor/access-policy.ts +++ b/extensions/signal/src/monitor/access-policy.ts @@ -1,9 +1,9 @@ -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../../src/pairing/pairing-store.js"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; import { readStoreAllowFromForDmPolicy, resolveDmGroupAccessWithLists, -} from "../../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/security-runtime"; import { isSignalSenderAllowed, type SignalSender } from "../identity.js"; type SignalDmPolicy = "open" | "pairing" | "allowlist" | "disabled"; diff --git a/extensions/signal/src/monitor/event-handler.ts b/extensions/signal/src/monitor/event-handler.ts index 36eb0e8d276..c8f9da661a0 100644 --- a/extensions/signal/src/monitor/event-handler.ts +++ b/extensions/signal/src/monitor/event-handler.ts @@ -1,44 +1,41 @@ -import { resolveHumanDelayConfig } from "../../../../src/agents/identity.js"; -import { hasControlCommand } from "../../../../src/auto-reply/command-detection.js"; -import { dispatchInboundMessage } from "../../../../src/auto-reply/dispatch.js"; +import { resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveControlCommandGate } from "openclaw/plugin-sdk/channel-runtime"; +import { + createChannelInboundDebouncer, + shouldDebounceTextInbound, +} from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop, logTypingFailure } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMentionGatingWithBypass } from "openclaw/plugin-sdk/channel-runtime"; +import { normalizeSignalMessagingTarget } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; +import { createTypingCallbacks } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveChannelGroupRequireMention } from "openclaw/plugin-sdk/config-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchInboundMessage } from "openclaw/plugin-sdk/reply-runtime"; import { formatInboundEnvelope, formatInboundFromLabel, resolveEnvelopeFormatOptions, -} from "../../../../src/auto-reply/envelope.js"; +} from "openclaw/plugin-sdk/reply-runtime"; import { buildPendingHistoryContextFromMap, clearHistoryEntriesIfEnabled, recordPendingHistoryEntryIfEnabled, -} from "../../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; -import { - buildMentionRegexes, - matchesMentionPatterns, -} from "../../../../src/auto-reply/reply/mentions.js"; -import { createReplyDispatcherWithTyping } from "../../../../src/auto-reply/reply/reply-dispatcher.js"; -import { resolveControlCommandGate } from "../../../../src/channels/command-gating.js"; -import { - createChannelInboundDebouncer, - shouldDebounceTextInbound, -} from "../../../../src/channels/inbound-debounce-policy.js"; -import { logInboundDrop, logTypingFailure } from "../../../../src/channels/logging.js"; -import { resolveMentionGatingWithBypass } from "../../../../src/channels/mention-gating.js"; -import { normalizeSignalMessagingTarget } from "../../../../src/channels/plugins/normalize/signal.js"; -import { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -import { recordInboundSession } from "../../../../src/channels/session.js"; -import { createTypingCallbacks } from "../../../../src/channels/typing.js"; -import { resolveChannelGroupRequireMention } from "../../../../src/config/group-policy.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../../src/config/sessions.js"; -import { danger, logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../src/infra/system-events.js"; -import { kindFromMime } from "../../../../src/media/mime.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { buildMentionRegexes, matchesMentionPatterns } from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyDispatcherWithTyping } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { danger, logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; import { DM_GROUP_ACCESS_REASON, resolvePinnedMainDmOwnerFromAllowlist, -} from "../../../../src/security/dm-policy-shared.js"; -import { normalizeE164 } from "../../../../src/utils.js"; +} from "openclaw/plugin-sdk/security-runtime"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import { formatSignalPairingIdLine, formatSignalSenderDisplay, diff --git a/extensions/signal/src/monitor/event-handler.types.ts b/extensions/signal/src/monitor/event-handler.types.ts index c1d0b0b3881..82a96af73cc 100644 --- a/extensions/signal/src/monitor/event-handler.types.ts +++ b/extensions/signal/src/monitor/event-handler.types.ts @@ -1,12 +1,12 @@ -import type { HistoryEntry } from "../../../../src/auto-reply/reply/history.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import type { DmPolicy, GroupPolicy, SignalReactionNotificationMode, -} from "../../../../src/config/types.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { SignalSender } from "../identity.js"; export type SignalEnvelope = { diff --git a/extensions/signal/src/outbound-adapter.ts b/extensions/signal/src/outbound-adapter.ts index b0d77c12bd0..cd61b825981 100644 --- a/extensions/signal/src/outbound-adapter.ts +++ b/extensions/signal/src/outbound-adapter.ts @@ -1,11 +1,8 @@ -import { resolveTextChunkLimit } from "../../../src/auto-reply/chunk.js"; -import { createScopedChannelMediaMaxBytesResolver } from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import type { ChannelOutboundAdapter } from "../../../src/channels/plugins/types.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { - resolveOutboundSendDep, - type OutboundSendDeps, -} from "../../../src/infra/outbound/send-deps.js"; +import { createScopedChannelMediaMaxBytesResolver } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep, type OutboundSendDeps } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; import { markdownToSignalTextChunks } from "./format.js"; import { sendMessageSignal } from "./send.js"; diff --git a/extensions/signal/src/plugin-shared.ts b/extensions/signal/src/plugin-shared.ts index 60559f09dcb..a5713e4c361 100644 --- a/extensions/signal/src/plugin-shared.ts +++ b/extensions/signal/src/plugin-shared.ts @@ -1,5 +1,5 @@ -import { createScopedAccountConfigAccessors } from "../../../src/plugin-sdk-internal/channel-config.js"; -import { normalizeE164, type OpenClawConfig } from "../../../src/plugin-sdk-internal/signal.js"; +import { createScopedAccountConfigAccessors } from "openclaw/plugin-sdk/channel-config-helpers"; +import { normalizeE164, type OpenClawConfig } from "openclaw/plugin-sdk/signal"; import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; import { createSignalSetupWizardProxy } from "./setup-core.js"; diff --git a/extensions/signal/src/probe.ts b/extensions/signal/src/probe.ts index bf200effd6d..ac7dce428e8 100644 --- a/extensions/signal/src/probe.ts +++ b/extensions/signal/src/probe.ts @@ -1,4 +1,4 @@ -import type { BaseProbeResult } from "../../../src/channels/plugins/types.js"; +import type { BaseProbeResult } from "openclaw/plugin-sdk/channel-runtime"; import { signalCheck, signalRpcRequest } from "./client.js"; export type SignalProbe = BaseProbeResult & { diff --git a/extensions/signal/src/reaction-level.ts b/extensions/signal/src/reaction-level.ts index 884bccec58e..2211b9f261a 100644 --- a/extensions/signal/src/reaction-level.ts +++ b/extensions/signal/src/reaction-level.ts @@ -1,9 +1,9 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveReactionLevel, type ReactionLevel, type ResolvedReactionLevel, -} from "../../../src/utils/reaction-level.js"; +} from "openclaw/plugin-sdk/text-runtime"; import { resolveSignalAccount } from "./accounts.js"; export type SignalReactionLevel = ReactionLevel; diff --git a/extensions/signal/src/rpc-context.ts b/extensions/signal/src/rpc-context.ts index 54c123cc6be..255338379d4 100644 --- a/extensions/signal/src/rpc-context.ts +++ b/extensions/signal/src/rpc-context.ts @@ -1,4 +1,4 @@ -import { loadConfig } from "../../../src/config/config.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveSignalAccount } from "./accounts.js"; export function resolveSignalRpcContext( diff --git a/extensions/signal/src/runtime.ts b/extensions/signal/src/runtime.ts index 99bdf04a447..9790195f0e8 100644 --- a/extensions/signal/src/runtime.ts +++ b/extensions/signal/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setSignalRuntime, getRuntime: getSignalRuntime } = createPluginRuntimeStore("Signal runtime not initialized"); diff --git a/extensions/signal/src/send-reactions.ts b/extensions/signal/src/send-reactions.ts index a5000ca9e8f..6b8c3791b2d 100644 --- a/extensions/signal/src/send-reactions.ts +++ b/extensions/signal/src/send-reactions.ts @@ -2,8 +2,8 @@ * Signal reactions via signal-cli JSON-RPC API */ -import { loadConfig } from "../../../src/config/config.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveSignalAccount } from "./accounts.js"; import { signalRpcRequest } from "./client.js"; import { resolveSignalRpcContext } from "./rpc-context.js"; diff --git a/extensions/signal/src/send.ts b/extensions/signal/src/send.ts index bb953680290..c102624836e 100644 --- a/extensions/signal/src/send.ts +++ b/extensions/signal/src/send.ts @@ -1,7 +1,7 @@ -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { kindFromMime } from "../../../src/media/mime.js"; -import { resolveOutboundAttachmentFromUrl } from "../../../src/media/outbound-attachment.js"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { resolveOutboundAttachmentFromUrl } from "openclaw/plugin-sdk/media-runtime"; import { resolveSignalAccount } from "./accounts.js"; import { signalRpcRequest } from "./client.js"; import { markdownToSignalText, type SignalTextStyleRange } from "./format.js"; diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 5e3901f0fae..1e479c38dc6 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,5 +1,10 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; import { + applyAccountNameToChannelSection, + DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, + migrateBaseNameToDefaultAccount, + normalizeAccountId, normalizeE164, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, @@ -7,13 +12,12 @@ import { setSetupChannelEnabled, type OpenClawConfig, type WizardPrompter, -} from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy, ChannelSetupWizard, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +} from "openclaw/plugin-sdk/setup"; import { listSignalAccountIds, resolveDefaultSignalAccountId, @@ -24,7 +28,7 @@ const channel = "signal" as const; const MIN_E164_DIGITS = 5; const MAX_E164_DIGITS = 15; const DIGITS_ONLY = /^\d+$/; -export const INVALID_SIGNAL_ACCOUNT_ERROR = +const INVALID_SIGNAL_ACCOUNT_ERROR = "Invalid E.164 phone number (must start with + and country code, e.g. +15555550123)"; export function normalizeSignalAccountInput(value: string | null | undefined): string | null { @@ -83,7 +87,7 @@ function buildSignalSetupPatch(input: { }; } -export async function promptSignalAllowFrom(params: { +async function promptSignalAllowFrom(params: { cfg: OpenClawConfig; prompter: WizardPrompter; accountId?: string; @@ -111,8 +115,15 @@ export async function promptSignalAllowFrom(params: { }); } -export const signalSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, +export const signalSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), validateInput: ({ input }) => { if ( !input.signalNumber && @@ -125,40 +136,74 @@ export const signalSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetup } return null; }, - buildPatch: (input) => buildSignalSetupPatch(input), -}); - -type SignalSetupWizardHandlers = { - resolveStatusLines: NonNullable["resolveStatusLines"]; - resolveSelectionHint: NonNullable["resolveSelectionHint"]; - resolveQuickstartScore: NonNullable["resolveQuickstartScore"]; - prepare?: ChannelSetupWizard["prepare"]; - shouldPromptCliPath: NonNullable< - NonNullable[number]["shouldPrompt"] - >; + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + if (accountId === DEFAULT_ACCOUNT_ID) { + return { + ...next, + channels: { + ...next.channels, + signal: { + ...next.channels?.signal, + enabled: true, + ...buildSignalSetupPatch(input), + }, + }, + }; + } + return { + ...next, + channels: { + ...next.channels, + signal: { + ...next.channels?.signal, + enabled: true, + accounts: { + ...next.channels?.signal?.accounts, + [accountId]: { + ...next.channels?.signal?.accounts?.[accountId], + enabled: true, + ...buildSignalSetupPatch(input), + }, + }, + }, + }, + }; + }, }; -export function createSignalSetupWizardBase( - handlers: SignalSetupWizardHandlers, -): ChannelSetupWizard { - const setupChannel = "signal" as const; +export function createSignalSetupWizardProxy( + loadWizard: () => Promise<{ signalSetupWizard: ChannelSetupWizard }>, +) { const signalDmPolicy: ChannelSetupDmPolicy = { label: "Signal", - channel: setupChannel, + channel, policyKey: "channels.signal.dmPolicy", allowFromKey: "channels.signal.allowFrom", getCurrent: (cfg: OpenClawConfig) => cfg.channels?.signal?.dmPolicy ?? "pairing", setPolicy: (cfg: OpenClawConfig, policy) => setChannelDmPolicyWithAllowFrom({ cfg, - channel: setupChannel, + channel, dmPolicy: policy, }), promptAllowFrom: promptSignalAllowFrom, }; return { - channel: setupChannel, + channel, status: { configuredLabel: "configured", unconfiguredLabel: "needs setup", @@ -170,11 +215,14 @@ export function createSignalSetupWizardBase( listSignalAccountIds(cfg).some( (accountId) => resolveSignalAccount({ cfg, accountId }).configured, ), - resolveStatusLines: handlers.resolveStatusLines, - resolveSelectionHint: handlers.resolveSelectionHint, - resolveQuickstartScore: handlers.resolveQuickstartScore, + resolveStatusLines: async (params) => + (await loadWizard()).signalSetupWizard.status.resolveStatusLines?.(params) ?? [], + resolveSelectionHint: async (params) => + await (await loadWizard()).signalSetupWizard.status.resolveSelectionHint?.(params), + resolveQuickstartScore: async (params) => + await (await loadWizard()).signalSetupWizard.status.resolveQuickstartScore?.(params), }, - prepare: handlers.prepare, + prepare: async (params) => await (await loadWizard()).signalSetupWizard.prepare?.(params), credentials: [], textInputs: [ { @@ -188,7 +236,12 @@ export function createSignalSetupWizardBase( (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? resolveSignalAccount({ cfg, accountId }).config.cliPath ?? "signal-cli", - shouldPrompt: handlers.shouldPromptCliPath, + shouldPrompt: async (params) => { + const input = (await loadWizard()).signalSetupWizard.textInputs?.find( + (entry) => entry.inputKey === "cliPath", + ); + return (await input?.shouldPrompt?.(params)) ?? false; + }, confirmCurrentValue: false, applyCurrentValue: true, helpTitle: "Signal", @@ -213,31 +266,11 @@ export function createSignalSetupWizardBase( lines: [ 'Link device with: signal-cli link -n "OpenClaw"', "Scan QR in Signal -> Linked Devices", - `Then run: openclaw gateway call channels.status --params '{"probe":true}'`, - "Docs: https://docs.openclaw.ai/signal", + `Then run: ${formatCliCommand("openclaw gateway call channels.status --params '{\"probe\":true}'")}`, + `Docs: ${formatDocsLink("/signal", "signal")}`, ], }, dmPolicy: signalDmPolicy, - disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, setupChannel, false), + disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } - -export function createSignalSetupWizardProxy( - loadWizard: () => Promise<{ signalSetupWizard: ChannelSetupWizard }>, -) { - return createSignalSetupWizardBase({ - resolveStatusLines: async (params) => - (await loadWizard()).signalSetupWizard.status.resolveStatusLines?.(params) ?? [], - resolveSelectionHint: async (params) => - await (await loadWizard()).signalSetupWizard.status.resolveSelectionHint?.(params), - resolveQuickstartScore: async (params) => - await (await loadWizard()).signalSetupWizard.status.resolveQuickstartScore?.(params), - prepare: async (params) => await (await loadWizard()).signalSetupWizard.prepare?.(params), - shouldPromptCliPath: async (params) => { - const input = (await loadWizard()).signalSetupWizard.textInputs?.find( - (entry) => entry.inputKey === "cliPath", - ); - return (await input?.shouldPrompt?.(params)) ?? false; - }, - }); -} diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index e3ac6f7e42a..32270cde952 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,34 +1,104 @@ import { + DEFAULT_ACCOUNT_ID, detectBinary, + formatCliCommand, + formatDocsLink, installSignalCli, type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/setup.js"; -import type { ChannelSetupWizard } from "../../../src/plugin-sdk-internal/setup.js"; -import { resolveSignalAccount } from "./accounts.js"; + parseSetupEntriesAllowingWildcard, + promptParsedAllowFromForScopedChannel, + setChannelDmPolicyWithAllowFrom, + setSetupChannelEnabled, + type WizardPrompter, +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { + listSignalAccountIds, + resolveDefaultSignalAccountId, + resolveSignalAccount, +} from "./accounts.js"; import { - createSignalSetupWizardBase, - INVALID_SIGNAL_ACCOUNT_ERROR, normalizeSignalAccountInput, - promptSignalAllowFrom, + parseSignalAllowFromEntries, signalSetupAdapter, } from "./setup-core.js"; -export const signalSetupWizard: ChannelSetupWizard = createSignalSetupWizardBase({ - resolveStatusLines: async ({ cfg, configured }) => { - const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; - const signalCliDetected = await detectBinary(signalCliPath); - return [ - `Signal: ${configured ? "configured" : "needs setup"}`, - `signal-cli: ${signalCliDetected ? "found" : "missing"} (${signalCliPath})`, - ]; - }, - resolveSelectionHint: async ({ cfg }) => { - const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; - return (await detectBinary(signalCliPath)) ? "signal-cli found" : "signal-cli missing"; - }, - resolveQuickstartScore: async ({ cfg }) => { - const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; - return (await detectBinary(signalCliPath)) ? 1 : 0; +const channel = "signal" as const; +const INVALID_SIGNAL_ACCOUNT_ERROR = + "Invalid E.164 phone number (must start with + and country code, e.g. +15555550123)"; + +async function promptSignalAllowFrom(params: { + cfg: OpenClawConfig; + prompter: WizardPrompter; + accountId?: string; +}): Promise { + return promptParsedAllowFromForScopedChannel({ + cfg: params.cfg, + channel, + accountId: params.accountId, + defaultAccountId: resolveDefaultSignalAccountId(params.cfg), + prompter: params.prompter, + noteTitle: "Signal allowlist", + noteLines: [ + "Allowlist Signal DMs by sender id.", + "Examples:", + "- +15555550123", + "- uuid:123e4567-e89b-12d3-a456-426614174000", + "Multiple entries: comma-separated.", + `Docs: ${formatDocsLink("/signal", "signal")}`, + ], + message: "Signal allowFrom (E.164 or uuid)", + placeholder: "+15555550123, uuid:123e4567-e89b-12d3-a456-426614174000", + parseEntries: parseSignalAllowFromEntries, + getExistingAllowFrom: ({ cfg, accountId }) => + resolveSignalAccount({ cfg, accountId }).config.allowFrom ?? [], + }); +} + +const signalDmPolicy: ChannelSetupDmPolicy = { + label: "Signal", + channel, + policyKey: "channels.signal.dmPolicy", + allowFromKey: "channels.signal.allowFrom", + getCurrent: (cfg) => cfg.channels?.signal?.dmPolicy ?? "pairing", + setPolicy: (cfg, policy) => + setChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptSignalAllowFrom, +}; + +export const signalSetupWizard: ChannelSetupWizard = { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs setup", + configuredHint: "signal-cli found", + unconfiguredHint: "signal-cli missing", + configuredScore: 1, + unconfiguredScore: 0, + resolveConfigured: ({ cfg }) => + listSignalAccountIds(cfg).some( + (accountId) => resolveSignalAccount({ cfg, accountId }).configured, + ), + resolveStatusLines: async ({ cfg, configured }) => { + const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; + const signalCliDetected = await detectBinary(signalCliPath); + return [ + `Signal: ${configured ? "configured" : "needs setup"}`, + `signal-cli: ${signalCliDetected ? "found" : "missing"} (${signalCliPath})`, + ]; + }, + resolveSelectionHint: async ({ cfg }) => { + const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; + return (await detectBinary(signalCliPath)) ? "signal-cli found" : "signal-cli missing"; + }, + resolveQuickstartScore: async ({ cfg }) => { + const signalCliPath = cfg.channels?.signal?.cliPath ?? "signal-cli"; + return (await detectBinary(signalCliPath)) ? 1 : 0; + }, }, prepare: async ({ cfg, accountId, credentialValues, runtime, prompter, options }) => { if (!options?.allowSignalInstall) { @@ -65,13 +135,50 @@ export const signalSetupWizard: ChannelSetupWizard = createSignalSetupWizardBase await prompter.note(`signal-cli install failed: ${String(error)}`, "Signal"); } }, - shouldPromptCliPath: async ({ currentValue }) => - !(await detectBinary(currentValue ?? "signal-cli")), -}); - -export { - INVALID_SIGNAL_ACCOUNT_ERROR, - normalizeSignalAccountInput, - promptSignalAllowFrom, - signalSetupAdapter, + credentials: [], + textInputs: [ + { + inputKey: "cliPath", + message: "signal-cli path", + currentValue: ({ cfg, accountId, credentialValues }) => + (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? + resolveSignalAccount({ cfg, accountId }).config.cliPath ?? + "signal-cli", + initialValue: ({ cfg, accountId, credentialValues }) => + (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? + resolveSignalAccount({ cfg, accountId }).config.cliPath ?? + "signal-cli", + shouldPrompt: async ({ currentValue }) => !(await detectBinary(currentValue ?? "signal-cli")), + confirmCurrentValue: false, + applyCurrentValue: true, + helpTitle: "Signal", + helpLines: [ + "signal-cli not found. Install it, then rerun this step or set channels.signal.cliPath.", + ], + }, + { + inputKey: "signalNumber", + message: "Signal bot number (E.164)", + currentValue: ({ cfg, accountId }) => + normalizeSignalAccountInput(resolveSignalAccount({ cfg, accountId }).config.account) ?? + undefined, + keepPrompt: (value) => `Signal account set (${value}). Keep it?`, + validate: ({ value }) => + normalizeSignalAccountInput(value) ? undefined : INVALID_SIGNAL_ACCOUNT_ERROR, + normalizeValue: ({ value }) => normalizeSignalAccountInput(value) ?? value, + }, + ], + completionNote: { + title: "Signal next steps", + lines: [ + 'Link device with: signal-cli link -n "OpenClaw"', + "Scan QR in Signal -> Linked Devices", + `Then run: ${formatCliCommand("openclaw gateway call channels.status --params '{\"probe\":true}'")}`, + `Docs: ${formatDocsLink("/signal", "signal")}`, + ], + }, + dmPolicy: signalDmPolicy, + disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), }; + +export { normalizeSignalAccountInput, parseSignalAllowFromEntries, signalSetupAdapter }; diff --git a/extensions/signal/src/sse-reconnect.ts b/extensions/signal/src/sse-reconnect.ts index 240ec7a4beb..f825a211afb 100644 --- a/extensions/signal/src/sse-reconnect.ts +++ b/extensions/signal/src/sse-reconnect.ts @@ -1,7 +1,7 @@ -import { logVerbose, shouldLogVerbose } from "../../../src/globals.js"; -import type { BackoffPolicy } from "../../../src/infra/backoff.js"; -import { computeBackoff, sleepWithAbort } from "../../../src/infra/backoff.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import type { BackoffPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { computeBackoff, sleepWithAbort } from "openclaw/plugin-sdk/infra-runtime"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { type SignalSseEvent, streamSignalEvents } from "./client.js"; const DEFAULT_RECONNECT_POLICY: BackoffPolicy = { diff --git a/extensions/slack/src/account-inspect.ts b/extensions/slack/src/account-inspect.ts index 1cc3f2b8509..7ea7ef042c2 100644 --- a/extensions/slack/src/account-inspect.ts +++ b/extensions/slack/src/account-inspect.ts @@ -1,13 +1,13 @@ import { hasConfiguredSecretInput, normalizeSecretInputString, -} from "../../../src/config/types.secrets.js"; +} from "openclaw/plugin-sdk/config-runtime"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, type SlackAccountConfig, -} from "../../../src/plugin-sdk-internal/slack.js"; +} from "openclaw/plugin-sdk/slack"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { mergeSlackAccountConfig, diff --git a/extensions/slack/src/account-surface-fields.ts b/extensions/slack/src/account-surface-fields.ts index 8913a9859fe..be264d9d369 100644 --- a/extensions/slack/src/account-surface-fields.ts +++ b/extensions/slack/src/account-surface-fields.ts @@ -1,4 +1,4 @@ -import type { SlackAccountConfig } from "../../../src/config/types.js"; +import type { SlackAccountConfig } from "openclaw/plugin-sdk/config-runtime"; export type SlackAccountSurfaceFields = { groupPolicy?: SlackAccountConfig["groupPolicy"]; diff --git a/extensions/slack/src/accounts.ts b/extensions/slack/src/accounts.ts index 4297e74902b..e453067e485 100644 --- a/extensions/slack/src/accounts.ts +++ b/extensions/slack/src/accounts.ts @@ -1,12 +1,12 @@ import { - type OpenClawConfig, createAccountListHelpers, DEFAULT_ACCOUNT_ID, normalizeAccountId, normalizeChatType, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; -import type { SlackAccountConfig } from "../../../src/plugin-sdk-internal/slack.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { SlackAccountConfig } from "openclaw/plugin-sdk/slack"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { resolveSlackAppToken, resolveSlackBotToken, resolveSlackUserToken } from "./token.js"; diff --git a/extensions/slack/src/actions.ts b/extensions/slack/src/actions.ts index ba422ac50f2..20b32d15726 100644 --- a/extensions/slack/src/actions.ts +++ b/extensions/slack/src/actions.ts @@ -1,6 +1,6 @@ import type { Block, KnownBlock, WebClient } from "@slack/web-api"; -import { loadConfig } from "../../../src/config/config.js"; -import { logVerbose } from "../../../src/globals.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { resolveSlackAccount } from "./accounts.js"; import { buildSlackBlocksFallbackText } from "./blocks-fallback.js"; import { validateSlackBlocksArray } from "./blocks-input.js"; diff --git a/extensions/slack/src/blocks-render.ts b/extensions/slack/src/blocks-render.ts index f22b179223d..775b988c521 100644 --- a/extensions/slack/src/blocks-render.ts +++ b/extensions/slack/src/blocks-render.ts @@ -1,6 +1,6 @@ import type { Block, KnownBlock } from "@slack/web-api"; -import { reduceInteractiveReply } from "../../../src/channels/plugins/outbound/interactive.js"; -import type { InteractiveReply } from "../../../src/interactive/payload.js"; +import { reduceInteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; +import type { InteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; import { truncateSlackText } from "./truncate.js"; export const SLACK_REPLY_BUTTON_ACTION_ID = "openclaw:reply_button"; diff --git a/extensions/slack/src/blocks.test-helpers.ts b/extensions/slack/src/blocks.test-helpers.ts index 50f7d66b04d..3ee978a2d81 100644 --- a/extensions/slack/src/blocks.test-helpers.ts +++ b/extensions/slack/src/blocks.test-helpers.ts @@ -17,7 +17,7 @@ export type SlackSendTestClient = WebClient & { }; export function installSlackBlockTestMocks() { - vi.mock("../../../src/config/config.js", () => ({ + vi.mock("openclaw/plugin-sdk/config-runtime", () => ({ loadConfig: () => ({}), })); diff --git a/extensions/slack/src/channel-migration.ts b/extensions/slack/src/channel-migration.ts index e78ade084d4..f6b97eb798a 100644 --- a/extensions/slack/src/channel-migration.ts +++ b/extensions/slack/src/channel-migration.ts @@ -1,6 +1,6 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { SlackChannelConfig } from "../../../src/config/types.slack.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { SlackChannelConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; type SlackChannels = Record; diff --git a/extensions/slack/src/channel.setup.ts b/extensions/slack/src/channel.setup.ts index 003c33e04b4..0eaf3053aa2 100644 --- a/extensions/slack/src/channel.setup.ts +++ b/extensions/slack/src/channel.setup.ts @@ -1,19 +1,61 @@ -import { type ChannelPlugin } from "openclaw/plugin-sdk/slack"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + SlackConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/slack"; import { type ResolvedSlackAccount } from "./accounts.js"; -import { createSlackSetupWizardProxy, slackSetupAdapter } from "./setup-core.js"; -import { createSlackPluginBase } from "./shared.js"; - -async function loadSlackChannelRuntime() { - return await import("./channel.runtime.js"); -} - -const slackSetupWizard = createSlackSetupWizardProxy(async () => ({ - slackSetupWizard: (await loadSlackChannelRuntime()).slackSetupWizard, -})); +import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; +import { + isSlackPluginAccountConfigured, + slackConfigAccessors, + slackConfigBase, + slackSetupWizard, +} from "./plugin-shared.js"; +import { slackSetupAdapter } from "./setup-core.js"; export const slackSetupPlugin: ChannelPlugin = { - ...createSlackPluginBase({ - setupWizard: slackSetupWizard, - setup: slackSetupAdapter, - }), + id: "slack", + meta: { + ...getChatChannelMeta("slack"), + preferSessionLookupForAnnounceTarget: true, + }, + setupWizard: slackSetupWizard, + capabilities: { + chatTypes: ["direct", "channel", "thread"], + reactions: true, + threads: true, + media: true, + nativeCommands: true, + }, + agentPrompt: { + messageToolHints: ({ cfg, accountId }) => + isSlackInteractiveRepliesEnabled({ cfg, accountId }) + ? [ + "- Slack interactive replies: use `[[slack_buttons: Label:value, Other:other]]` to add action buttons that route clicks back as Slack interaction system events.", + "- Slack selects: use `[[slack_select: Placeholder | Label:value, Other:other]]` to add a static select menu that routes the chosen value back as a Slack interaction system event.", + ] + : [ + "- Slack interactive replies are disabled. If needed, ask to set `channels.slack.capabilities.interactiveReplies=true` (or the same under `channels.slack.accounts..capabilities`).", + ], + }, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.slack"] }, + configSchema: buildChannelConfigSchema(SlackConfigSchema), + config: { + ...slackConfigBase, + isConfigured: (account) => isSlackPluginAccountConfigured(account), + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: isSlackPluginAccountConfigured(account), + botTokenSource: account.botTokenSource, + appTokenSource: account.appTokenSource, + }), + ...slackConfigAccessors, + }, + setup: slackSetupAdapter, }; diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 2980316a138..3dfb195be86 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -1,9 +1,10 @@ +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; import { - buildAccountScopedAllowlistConfigEditor, buildAccountScopedDmSecurityPolicy, - collectOpenProviderGroupPolicyWarnings, collectOpenGroupPolicyConfiguredRouteWarnings, -} from "openclaw/plugin-sdk/compat"; + collectOpenProviderGroupPolicyWarnings, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, resolveThreadSessionKeys, @@ -11,7 +12,9 @@ import { } from "openclaw/plugin-sdk/core"; import { buildComputedAccountStatusSnapshot, + buildChannelConfigSchema, DEFAULT_ACCOUNT_ID, + getChatChannelMeta, listSlackDirectoryGroupsFromConfig, listSlackDirectoryPeersFromConfig, looksLikeSlackTargetId, @@ -21,12 +24,10 @@ import { resolveConfiguredFromRequiredCredentialStatuses, resolveSlackGroupRequireMention, resolveSlackGroupToolPolicy, + SlackConfigSchema, type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/slack"; -import { createSlackActions } from "../../../src/channels/plugins/slack.actions.js"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; -import { normalizeOutboundThreadId } from "../../../src/infra/outbound/thread-id.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { listEnabledSlackAccounts, @@ -37,26 +38,26 @@ import { import { parseSlackBlocksInput } from "./blocks-input.js"; import { createSlackWebClient } from "./client.js"; import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; +import { handleSlackMessageAction } from "./message-action-dispatch.js"; +import { extractSlackToolSend, listSlackMessageActions } from "./message-actions.js"; import { normalizeAllowListLower } from "./monitor/allow-list.js"; +import { + isSlackPluginAccountConfigured, + slackConfigAccessors, + slackConfigBase, + slackSetupWizard, +} from "./plugin-shared.js"; import type { SlackProbe } from "./probe.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; import { getSlackRuntime } from "./runtime.js"; import { fetchSlackScopes } from "./scopes.js"; -import { createSlackSetupWizardProxy, slackSetupAdapter } from "./setup-core.js"; -import { - createSlackPluginBase, - isSlackPluginAccountConfigured, - slackConfigAccessors, -} from "./shared.js"; +import { slackSetupAdapter } from "./setup-core.js"; import { parseSlackTarget } from "./targets.js"; import { buildSlackThreadingToolContext } from "./threading-tool-context.js"; +const meta = getChatChannelMeta("slack"); const SLACK_CHANNEL_TYPE_CACHE = new Map(); -async function loadSlackChannelRuntime() { - return await import("./channel.runtime.js"); -} - // Select the appropriate Slack token for read/write operations. function getTokenForOperation( account: ResolvedSlackAccount, @@ -136,6 +137,20 @@ function parseSlackExplicitTarget(raw: string) { }; } +function normalizeOutboundThreadId(value?: string | number | null): string | undefined { + if (value == null) { + return undefined; + } + if (typeof value === "number") { + if (!Number.isFinite(value)) { + return undefined; + } + return String(Math.trunc(value)); + } + const trimmed = value.trim(); + return trimmed ? trimmed : undefined; +} + function buildSlackBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; @@ -314,21 +329,13 @@ async function resolveSlackAllowlistNames(params: { return await resolveSlackUserAllowlist({ token, entries: params.entries }); } -const slackSetupWizard = createSlackSetupWizardProxy(async () => ({ - slackSetupWizard: (await loadSlackChannelRuntime()).slackSetupWizard, -})); - -const slackActions = createSlackActions("slack", { - invoke: () => async (action, cfg, toolContext) => - await getSlackRuntime().channel.slack.handleSlackAction(action, cfg, toolContext), - skipNormalizeChannelId: true, -}); - export const slackPlugin: ChannelPlugin = { - ...createSlackPluginBase({ - setupWizard: slackSetupWizard, - setup: slackSetupAdapter, - }), + id: "slack", + meta: { + ...meta, + preferSessionLookupForAnnounceTarget: true, + }, + setupWizard: slackSetupWizard, pairing: { idLabel: "slackUserId", normalizeAllowEntry: (entry) => entry.replace(/^(slack|user):/i, ""), @@ -357,6 +364,42 @@ export const slackPlugin: ChannelPlugin = { } }, }, + capabilities: { + chatTypes: ["direct", "channel", "thread"], + reactions: true, + threads: true, + media: true, + nativeCommands: true, + }, + agentPrompt: { + messageToolHints: ({ cfg, accountId }) => + isSlackInteractiveRepliesEnabled({ cfg, accountId }) + ? [ + "- Slack interactive replies: use `[[slack_buttons: Label:value, Other:other]]` to add action buttons that route clicks back as Slack interaction system events.", + "- Slack selects: use `[[slack_select: Placeholder | Label:value, Other:other]]` to add a static select menu that routes the chosen value back as a Slack interaction system event.", + ] + : [ + "- Slack interactive replies are disabled. If needed, ask to set `channels.slack.capabilities.interactiveReplies=true` (or the same under `channels.slack.accounts..capabilities`).", + ], + }, + streaming: { + blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, + }, + reload: { configPrefixes: ["channels.slack"] }, + configSchema: buildChannelConfigSchema(SlackConfigSchema), + config: { + ...slackConfigBase, + isConfigured: (account) => isSlackPluginAccountConfigured(account), + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: isSlackPluginAccountConfigured(account), + botTokenSource: account.botTokenSource, + appTokenSource: account.appTokenSource, + }), + ...slackConfigAccessors, + }, allowlist: { supportsScope: ({ scope }) => scope === "dm", readConfig: ({ cfg, accountId }) => @@ -511,7 +554,29 @@ export const slackPlugin: ChannelPlugin = { return resolved.map((entry) => toResolvedTarget(entry, entry.note)); }, }, - actions: slackActions, + actions: { + listActions: ({ cfg }) => listSlackMessageActions(cfg), + getCapabilities: ({ cfg }) => { + const capabilities = new Set<"interactive" | "blocks">(); + if (listSlackMessageActions(cfg).includes("send")) { + capabilities.add("blocks"); + } + if (isSlackInteractiveRepliesEnabled({ cfg })) { + capabilities.add("interactive"); + } + return Array.from(capabilities); + }, + extractToolSend: ({ args }) => extractSlackToolSend(args), + handleAction: async (ctx) => + await handleSlackMessageAction({ + providerId: meta.id, + ctx, + includeReadThreadId: true, + invoke: async (action, cfg, toolContext) => + await getSlackRuntime().channel.slack.handleSlackAction(action, cfg, toolContext), + }), + }, + setup: slackSetupAdapter, outbound: { deliveryMode: "direct", chunker: null, diff --git a/extensions/slack/src/directory-live.ts b/extensions/slack/src/directory-live.ts index 225548c646d..0a8bd04af22 100644 --- a/extensions/slack/src/directory-live.ts +++ b/extensions/slack/src/directory-live.ts @@ -1,5 +1,5 @@ -import type { DirectoryConfigParams } from "../../../src/channels/plugins/directory-config.js"; -import type { ChannelDirectoryEntry } from "../../../src/channels/plugins/types.js"; +import type { DirectoryConfigParams } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelDirectoryEntry } from "openclaw/plugin-sdk/channel-runtime"; import { resolveSlackAccount } from "./accounts.js"; import { createSlackWebClient } from "./client.js"; diff --git a/extensions/slack/src/draft-stream.ts b/extensions/slack/src/draft-stream.ts index bb80ff8d536..f122e2664c5 100644 --- a/extensions/slack/src/draft-stream.ts +++ b/extensions/slack/src/draft-stream.ts @@ -1,4 +1,4 @@ -import { createDraftStreamLoop } from "../../../src/channels/draft-stream-loop.js"; +import { createDraftStreamLoop } from "openclaw/plugin-sdk/channel-runtime"; import { deleteSlackMessage, editSlackMessage } from "./actions.js"; import { sendMessageSlack } from "./send.js"; diff --git a/extensions/slack/src/format.ts b/extensions/slack/src/format.ts index 69aeaa6b3b9..e5ab385fc6b 100644 --- a/extensions/slack/src/format.ts +++ b/extensions/slack/src/format.ts @@ -1,6 +1,10 @@ -import type { MarkdownTableMode } from "../../../src/config/types.base.js"; -import { chunkMarkdownIR, markdownToIR, type MarkdownLinkSpan } from "../../../src/markdown/ir.js"; -import { renderMarkdownWithMarkers } from "../../../src/markdown/render.js"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { + chunkMarkdownIR, + markdownToIR, + type MarkdownLinkSpan, +} from "openclaw/plugin-sdk/text-runtime"; +import { renderMarkdownWithMarkers } from "openclaw/plugin-sdk/text-runtime"; // Escape special characters for Slack mrkdwn format. // Preserve Slack's angle-bracket tokens so mentions and links stay intact. diff --git a/extensions/slack/src/interactive-replies.ts b/extensions/slack/src/interactive-replies.ts index 31784bd3b40..2a9703872c4 100644 --- a/extensions/slack/src/interactive-replies.ts +++ b/extensions/slack/src/interactive-replies.ts @@ -1,4 +1,4 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { listSlackAccountIds, resolveSlackAccount } from "./accounts.js"; function resolveInteractiveRepliesFromCapabilities(capabilities: unknown): boolean { diff --git a/extensions/slack/src/message-action-dispatch.ts b/extensions/slack/src/message-action-dispatch.ts index 486acfd4b2b..a589d28fed7 100644 --- a/extensions/slack/src/message-action-dispatch.ts +++ b/extensions/slack/src/message-action-dispatch.ts @@ -1 +1 @@ -export { handleSlackMessageAction } from "../../../src/plugin-sdk-internal/slack.js"; +export { handleSlackMessageAction } from "openclaw/plugin-sdk/slack"; diff --git a/extensions/slack/src/message-actions.ts b/extensions/slack/src/message-actions.ts index 8e2a293f166..938659c9354 100644 --- a/extensions/slack/src/message-actions.ts +++ b/extensions/slack/src/message-actions.ts @@ -1,9 +1,9 @@ -import { createActionGate } from "../../../src/agents/tools/common.js"; +import { createActionGate } from "openclaw/plugin-sdk/agent-runtime"; import type { ChannelMessageActionName, ChannelToolSend, -} from "../../../src/channels/plugins/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { listEnabledSlackAccounts } from "./accounts.js"; export function listSlackMessageActions(cfg: OpenClawConfig): ChannelMessageActionName[] { diff --git a/extensions/slack/src/monitor.test-helpers.ts b/extensions/slack/src/monitor.test-helpers.ts index c62147dd4a4..08cf5810345 100644 --- a/extensions/slack/src/monitor.test-helpers.ts +++ b/extensions/slack/src/monitor.test-helpers.ts @@ -187,15 +187,15 @@ export function resetSlackTestState(config: Record = defaultSla getSlackHandlers()?.clear(); } -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => slackTestState.config, }; }); -vi.mock("../../../src/auto-reply/reply.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ getReplyFromConfig: (...args: unknown[]) => slackTestState.replyMock(...args), })); @@ -213,14 +213,14 @@ vi.mock("./send.js", () => ({ sendMessageSlack: (...args: unknown[]) => slackTestState.sendMock(...args), })); -vi.mock("../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: (...args: unknown[]) => slackTestState.readAllowFromStoreMock(...args), upsertChannelPairingRequest: (...args: unknown[]) => slackTestState.upsertPairingRequestMock(...args), })); -vi.mock("../../../src/config/sessions.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, resolveStorePath: vi.fn(() => "/tmp/openclaw-sessions.json"), diff --git a/extensions/slack/src/monitor/allow-list.ts b/extensions/slack/src/monitor/allow-list.ts index 0e800047502..32fb7f40530 100644 --- a/extensions/slack/src/monitor/allow-list.ts +++ b/extensions/slack/src/monitor/allow-list.ts @@ -2,12 +2,12 @@ import { compileAllowlist, resolveCompiledAllowlistMatch, type AllowlistMatch, -} from "../../../../src/channels/allowlist-match.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import { normalizeHyphenSlug, normalizeStringEntries, normalizeStringEntriesLower, -} from "../../../../src/shared/string-normalization.js"; +} from "openclaw/plugin-sdk/text-runtime"; const SLACK_SLUG_CACHE_MAX = 512; const slackSlugCache = new Map(); diff --git a/extensions/slack/src/monitor/auth.ts b/extensions/slack/src/monitor/auth.ts index 5022a94ad18..df8946a01c0 100644 --- a/extensions/slack/src/monitor/auth.ts +++ b/extensions/slack/src/monitor/auth.ts @@ -1,4 +1,4 @@ -import { readStoreAllowFromForDmPolicy } from "../../../../src/security/dm-policy-shared.js"; +import { readStoreAllowFromForDmPolicy } from "openclaw/plugin-sdk/security-runtime"; import { allowListMatches, normalizeAllowList, diff --git a/extensions/slack/src/monitor/channel-config.ts b/extensions/slack/src/monitor/channel-config.ts index e5f380a7102..32ad0e6f022 100644 --- a/extensions/slack/src/monitor/channel-config.ts +++ b/extensions/slack/src/monitor/channel-config.ts @@ -3,8 +3,8 @@ import { buildChannelKeyCandidates, resolveChannelEntryMatchWithFallback, type ChannelMatchSource, -} from "../../../../src/channels/channel-config.js"; -import type { SlackReactionNotificationMode } from "../../../../src/config/config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { SlackReactionNotificationMode } from "openclaw/plugin-sdk/config-runtime"; import type { SlackMessageEvent } from "../types.js"; import { allowListMatches, normalizeAllowListLower, normalizeSlackSlug } from "./allow-list.js"; diff --git a/extensions/slack/src/monitor/commands.ts b/extensions/slack/src/monitor/commands.ts index 25fbaeb1007..1d83d9f74d1 100644 --- a/extensions/slack/src/monitor/commands.ts +++ b/extensions/slack/src/monitor/commands.ts @@ -1,4 +1,4 @@ -import type { SlackSlashCommandConfig } from "../../../../src/config/config.js"; +import type { SlackSlashCommandConfig } from "openclaw/plugin-sdk/config-runtime"; /** * Strip Slack mentions (<@U123>, <@U123|name>) so command detection works on diff --git a/extensions/slack/src/monitor/context.ts b/extensions/slack/src/monitor/context.ts index ad485a5c202..f39a92ce207 100644 --- a/extensions/slack/src/monitor/context.ts +++ b/extensions/slack/src/monitor/context.ts @@ -1,17 +1,17 @@ import type { App } from "@slack/bolt"; -import type { HistoryEntry } from "../../../../src/auto-reply/reply/history.js"; -import { formatAllowlistMatchMeta } from "../../../../src/channels/allowlist-match.js"; +import { formatAllowlistMatchMeta } from "openclaw/plugin-sdk/channel-runtime"; import type { OpenClawConfig, SlackReactionNotificationMode, -} from "../../../../src/config/config.js"; -import { resolveSessionKey, type SessionScope } from "../../../../src/config/sessions.js"; -import type { DmPolicy, GroupPolicy } from "../../../../src/config/types.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { createDedupeCache } from "../../../../src/infra/dedupe.js"; -import { getChildLogger } from "../../../../src/logging.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { resolveSessionKey, type SessionScope } from "openclaw/plugin-sdk/config-runtime"; +import type { DmPolicy, GroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { createDedupeCache } from "openclaw/plugin-sdk/infra-runtime"; +import type { HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { SlackMessageEvent } from "../types.js"; import { normalizeAllowList, normalizeAllowListLower, normalizeSlackSlug } from "./allow-list.js"; import type { SlackChannelConfigEntries } from "./channel-config.js"; @@ -53,7 +53,7 @@ export type SlackMonitorContext = { replyToMode: "off" | "first" | "all"; threadHistoryScope: "thread" | "channel"; threadInheritParent: boolean; - slashCommand: Required; + slashCommand: Required; textLimit: number; ackReactionScope: string; typingReaction: string; diff --git a/extensions/slack/src/monitor/dm-auth.ts b/extensions/slack/src/monitor/dm-auth.ts index 20d850d869a..930d31efdc5 100644 --- a/extensions/slack/src/monitor/dm-auth.ts +++ b/extensions/slack/src/monitor/dm-auth.ts @@ -1,6 +1,6 @@ -import { formatAllowlistMatchMeta } from "../../../../src/channels/allowlist-match.js"; -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../../src/pairing/pairing-store.js"; +import { formatAllowlistMatchMeta } from "openclaw/plugin-sdk/channel-runtime"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; import { resolveSlackAllowListMatch } from "./allow-list.js"; import type { SlackMonitorContext } from "./context.js"; diff --git a/extensions/slack/src/monitor/events/channels.ts b/extensions/slack/src/monitor/events/channels.ts index 283b6648cf9..e4940f80d9f 100644 --- a/extensions/slack/src/monitor/events/channels.ts +++ b/extensions/slack/src/monitor/events/channels.ts @@ -1,8 +1,8 @@ import type { SlackEventMiddlewareArgs } from "@slack/bolt"; -import { resolveChannelConfigWrites } from "../../../../../src/channels/plugins/config-writes.js"; -import { loadConfig, writeConfigFile } from "../../../../../src/config/config.js"; -import { danger, warn } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { resolveChannelConfigWrites } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig, writeConfigFile } from "openclaw/plugin-sdk/config-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { danger, warn } from "openclaw/plugin-sdk/runtime-env"; import { migrateSlackChannelConfig } from "../../channel-migration.js"; import { resolveSlackChannelLabel } from "../channel-config.js"; import type { SlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/events/interactions.block-actions.ts b/extensions/slack/src/monitor/events/interactions.block-actions.ts index 1f54df45a5d..f8a18720933 100644 --- a/extensions/slack/src/monitor/events/interactions.block-actions.ts +++ b/extensions/slack/src/monitor/events/interactions.block-actions.ts @@ -1,12 +1,12 @@ import type { SlackActionMiddlewareArgs } from "@slack/bolt"; import type { Block, KnownBlock } from "@slack/web-api"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; import { buildPluginBindingResolvedText, parsePluginBindingApprovalCustomId, resolvePluginConversationBindingApproval, -} from "../../../../../src/plugins/conversation-binding.js"; -import { dispatchPluginInteractiveHandler } from "../../../../../src/plugins/interactive.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { dispatchPluginInteractiveHandler } from "openclaw/plugin-sdk/plugin-runtime"; import { SLACK_REPLY_BUTTON_ACTION_ID, SLACK_REPLY_SELECT_ACTION_ID } from "../../blocks-render.js"; import { authorizeSlackSystemEventSender } from "../auth.js"; import type { SlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/events/interactions.modal.ts b/extensions/slack/src/monitor/events/interactions.modal.ts index 48e163c317f..14f7a0af0cd 100644 --- a/extensions/slack/src/monitor/events/interactions.modal.ts +++ b/extensions/slack/src/monitor/events/interactions.modal.ts @@ -1,4 +1,4 @@ -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; import { parseSlackModalPrivateMetadata } from "../../modal-metadata.js"; import { authorizeSlackSystemEventSender } from "../auth.js"; import type { SlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/events/members.ts b/extensions/slack/src/monitor/events/members.ts index 490c0bf6f04..26d02f11613 100644 --- a/extensions/slack/src/monitor/events/members.ts +++ b/extensions/slack/src/monitor/events/members.ts @@ -1,6 +1,6 @@ import type { SlackEventMiddlewareArgs } from "@slack/bolt"; -import { danger } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import type { SlackMonitorContext } from "../context.js"; import type { SlackMemberChannelEvent } from "../types.js"; import { authorizeAndResolveSlackSystemEventContext } from "./system-event-context.js"; diff --git a/extensions/slack/src/monitor/events/messages.ts b/extensions/slack/src/monitor/events/messages.ts index b950d5d19ea..309308caa57 100644 --- a/extensions/slack/src/monitor/events/messages.ts +++ b/extensions/slack/src/monitor/events/messages.ts @@ -1,6 +1,6 @@ import type { SlackEventMiddlewareArgs } from "@slack/bolt"; -import { danger } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import type { SlackAppMentionEvent, SlackMessageEvent } from "../../types.js"; import { normalizeSlackChannelType } from "../channel-type.js"; import type { SlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/events/pins.ts b/extensions/slack/src/monitor/events/pins.ts index f051270624c..ba95f515810 100644 --- a/extensions/slack/src/monitor/events/pins.ts +++ b/extensions/slack/src/monitor/events/pins.ts @@ -1,6 +1,6 @@ import type { SlackEventMiddlewareArgs } from "@slack/bolt"; -import { danger } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import type { SlackMonitorContext } from "../context.js"; import type { SlackPinEvent } from "../types.js"; import { authorizeAndResolveSlackSystemEventContext } from "./system-event-context.js"; diff --git a/extensions/slack/src/monitor/events/reactions.ts b/extensions/slack/src/monitor/events/reactions.ts index 439c15e6d12..f439168dfde 100644 --- a/extensions/slack/src/monitor/events/reactions.ts +++ b/extensions/slack/src/monitor/events/reactions.ts @@ -1,6 +1,6 @@ import type { SlackEventMiddlewareArgs } from "@slack/bolt"; -import { danger } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; import type { SlackMonitorContext } from "../context.js"; import type { SlackReactionEvent } from "../types.js"; import { authorizeAndResolveSlackSystemEventContext } from "./system-event-context.js"; diff --git a/extensions/slack/src/monitor/events/system-event-context.ts b/extensions/slack/src/monitor/events/system-event-context.ts index 278dd2324d7..544a889df5f 100644 --- a/extensions/slack/src/monitor/events/system-event-context.ts +++ b/extensions/slack/src/monitor/events/system-event-context.ts @@ -1,4 +1,4 @@ -import { logVerbose } from "../../../../../src/globals.js"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { authorizeSlackSystemEventSender } from "../auth.js"; import { resolveSlackChannelLabel } from "../channel-config.js"; import type { SlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/external-arg-menu-store.ts b/extensions/slack/src/monitor/external-arg-menu-store.ts index e2cbf68479d..c3327ee88c6 100644 --- a/extensions/slack/src/monitor/external-arg-menu-store.ts +++ b/extensions/slack/src/monitor/external-arg-menu-store.ts @@ -1,4 +1,4 @@ -import { generateSecureToken } from "../../../../src/infra/secure-random.js"; +import { generateSecureToken } from "openclaw/plugin-sdk/infra-runtime"; const SLACK_EXTERNAL_ARG_MENU_TOKEN_BYTES = 18; const SLACK_EXTERNAL_ARG_MENU_TOKEN_LENGTH = Math.ceil( diff --git a/extensions/slack/src/monitor/media.ts b/extensions/slack/src/monitor/media.ts index ef494f2e48c..ef574a7381c 100644 --- a/extensions/slack/src/monitor/media.ts +++ b/extensions/slack/src/monitor/media.ts @@ -1,9 +1,9 @@ import type { WebClient as SlackWebClient } from "@slack/web-api"; +import { normalizeHostname } from "openclaw/plugin-sdk/infra-runtime"; +import type { FetchLike } from "openclaw/plugin-sdk/media-runtime"; +import { fetchRemoteMedia } from "openclaw/plugin-sdk/media-runtime"; +import { saveMediaBuffer } from "openclaw/plugin-sdk/media-runtime"; import { resolveRequestUrl } from "openclaw/plugin-sdk/request-url"; -import { normalizeHostname } from "../../../../src/infra/net/hostname.js"; -import type { FetchLike } from "../../../../src/media/fetch.js"; -import { fetchRemoteMedia } from "../../../../src/media/fetch.js"; -import { saveMediaBuffer } from "../../../../src/media/store.js"; import type { SlackAttachment, SlackFile } from "../types.js"; function isSlackHostname(hostname: string): boolean { diff --git a/extensions/slack/src/monitor/message-handler.ts b/extensions/slack/src/monitor/message-handler.ts index 37e0eb23bd3..feaddff98df 100644 --- a/extensions/slack/src/monitor/message-handler.ts +++ b/extensions/slack/src/monitor/message-handler.ts @@ -1,7 +1,7 @@ import { createChannelInboundDebouncer, shouldDebounceTextInbound, -} from "../../../../src/channels/inbound-debounce-policy.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ResolvedSlackAccount } from "../accounts.js"; import type { SlackMessageEvent } from "../types.js"; import { stripSlackMentionsForCommandDetection } from "./commands.js"; diff --git a/extensions/slack/src/monitor/message-handler/dispatch.ts b/extensions/slack/src/monitor/message-handler/dispatch.ts index 43ee958bdda..569ca8f60a7 100644 --- a/extensions/slack/src/monitor/message-handler/dispatch.ts +++ b/extensions/slack/src/monitor/message-handler/dispatch.ts @@ -1,16 +1,16 @@ -import { resolveHumanDelayConfig } from "../../../../../src/agents/identity.js"; -import { dispatchInboundMessage } from "../../../../../src/auto-reply/dispatch.js"; -import { clearHistoryEntriesIfEnabled } from "../../../../../src/auto-reply/reply/history.js"; -import { createReplyDispatcherWithTyping } from "../../../../../src/auto-reply/reply/reply-dispatcher.js"; -import type { ReplyPayload } from "../../../../../src/auto-reply/types.js"; -import { removeAckReactionAfterReply } from "../../../../../src/channels/ack-reactions.js"; -import { logAckFailure, logTypingFailure } from "../../../../../src/channels/logging.js"; -import { createReplyPrefixOptions } from "../../../../../src/channels/reply-prefix.js"; -import { createTypingCallbacks } from "../../../../../src/channels/typing.js"; -import { resolveStorePath, updateLastRoute } from "../../../../../src/config/sessions.js"; -import { danger, logVerbose, shouldLogVerbose } from "../../../../../src/globals.js"; -import { resolveAgentOutboundIdentity } from "../../../../../src/infra/outbound/identity.js"; -import { resolvePinnedMainDmOwnerFromAllowlist } from "../../../../../src/security/dm-policy-shared.js"; +import { resolveHumanDelayConfig } from "openclaw/plugin-sdk/agent-runtime"; +import { removeAckReactionAfterReply } from "openclaw/plugin-sdk/channel-runtime"; +import { logAckFailure, logTypingFailure } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { createTypingCallbacks } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveStorePath, updateLastRoute } from "openclaw/plugin-sdk/config-runtime"; +import { resolveAgentOutboundIdentity } from "openclaw/plugin-sdk/infra-runtime"; +import { dispatchInboundMessage } from "openclaw/plugin-sdk/reply-runtime"; +import { clearHistoryEntriesIfEnabled } from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyDispatcherWithTyping } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolvePinnedMainDmOwnerFromAllowlist } from "openclaw/plugin-sdk/security-runtime"; import { editSlackMessage, reactSlackMessage, removeSlackReaction } from "../../actions.js"; import { createSlackDraftStream } from "../../draft-stream.js"; import { normalizeSlackOutboundText } from "../../format.js"; diff --git a/extensions/slack/src/monitor/message-handler/prepare-content.ts b/extensions/slack/src/monitor/message-handler/prepare-content.ts index e1db426ad7e..54a5183bfb0 100644 --- a/extensions/slack/src/monitor/message-handler/prepare-content.ts +++ b/extensions/slack/src/monitor/message-handler/prepare-content.ts @@ -1,4 +1,4 @@ -import { logVerbose } from "../../../../../src/globals.js"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import type { SlackFile, SlackMessageEvent } from "../../types.js"; import { MAX_SLACK_MEDIA_FILES, diff --git a/extensions/slack/src/monitor/message-handler/prepare-thread-context.ts b/extensions/slack/src/monitor/message-handler/prepare-thread-context.ts index 9673e8d72cc..5d4020f1b46 100644 --- a/extensions/slack/src/monitor/message-handler/prepare-thread-context.ts +++ b/extensions/slack/src/monitor/message-handler/prepare-thread-context.ts @@ -1,6 +1,6 @@ -import { formatInboundEnvelope } from "../../../../../src/auto-reply/envelope.js"; -import { readSessionUpdatedAt } from "../../../../../src/config/sessions.js"; -import { logVerbose } from "../../../../../src/globals.js"; +import { readSessionUpdatedAt } from "openclaw/plugin-sdk/config-runtime"; +import { formatInboundEnvelope } from "openclaw/plugin-sdk/reply-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import type { ResolvedSlackAccount } from "../../accounts.js"; import type { SlackMessageEvent } from "../../types.js"; import type { SlackMonitorContext } from "../context.js"; @@ -30,7 +30,7 @@ export async function resolveSlackThreadContextData(params: { storePath: string; sessionKey: string; envelopeOptions: ReturnType< - typeof import("../../../../../src/auto-reply/envelope.js").resolveEnvelopeFormatOptions + typeof import("openclaw/plugin-sdk/reply-runtime").resolveEnvelopeFormatOptions >; effectiveDirectMedia: SlackMediaResult[] | null; }): Promise { diff --git a/extensions/slack/src/monitor/message-handler/prepare.test-helpers.ts b/extensions/slack/src/monitor/message-handler/prepare.test-helpers.ts index cdc7a3bc411..f6d3ab21ce9 100644 --- a/extensions/slack/src/monitor/message-handler/prepare.test-helpers.ts +++ b/extensions/slack/src/monitor/message-handler/prepare.test-helpers.ts @@ -1,6 +1,6 @@ import type { App } from "@slack/bolt"; -import type { OpenClawConfig } from "../../../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../../../src/runtime.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { ResolvedSlackAccount } from "../../accounts.js"; import { createSlackMonitorContext } from "../context.js"; diff --git a/extensions/slack/src/monitor/message-handler/prepare.ts b/extensions/slack/src/monitor/message-handler/prepare.ts index ba18b008d37..e6bc3a23446 100644 --- a/extensions/slack/src/monitor/message-handler/prepare.ts +++ b/extensions/slack/src/monitor/message-handler/prepare.ts @@ -1,35 +1,32 @@ -import { resolveAckReaction } from "../../../../../src/agents/identity.js"; -import { hasControlCommand } from "../../../../../src/auto-reply/command-detection.js"; -import { shouldHandleTextCommands } from "../../../../../src/auto-reply/commands-registry.js"; -import { - formatInboundEnvelope, - resolveEnvelopeFormatOptions, -} from "../../../../../src/auto-reply/envelope.js"; -import { - buildPendingHistoryContextFromMap, - recordPendingHistoryEntryIfEnabled, -} from "../../../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../../../src/auto-reply/reply/inbound-context.js"; -import { - buildMentionRegexes, - matchesMentionWithExplicit, -} from "../../../../../src/auto-reply/reply/mentions.js"; -import type { FinalizedMsgContext } from "../../../../../src/auto-reply/templating.js"; +import { resolveAckReaction } from "openclaw/plugin-sdk/agent-runtime"; import { shouldAckReaction as shouldAckReactionGate, type AckReactionScope, -} from "../../../../../src/channels/ack-reactions.js"; -import { resolveControlCommandGate } from "../../../../../src/channels/command-gating.js"; -import { resolveConversationLabel } from "../../../../../src/channels/conversation-label.js"; -import { logInboundDrop } from "../../../../../src/channels/logging.js"; -import { resolveMentionGatingWithBypass } from "../../../../../src/channels/mention-gating.js"; -import { recordInboundSession } from "../../../../../src/channels/session.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../../../src/config/sessions.js"; -import { logVerbose, shouldLogVerbose } from "../../../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../../../src/infra/system-events.js"; -import { resolveAgentRoute } from "../../../../../src/routing/resolve-route.js"; -import { resolveThreadSessionKeys } from "../../../../../src/routing/session-key.js"; -import { resolvePinnedMainDmOwnerFromAllowlist } from "../../../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { resolveControlCommandGate } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveConversationLabel } from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMentionGatingWithBypass } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { shouldHandleTextCommands } from "openclaw/plugin-sdk/reply-runtime"; +import { + formatInboundEnvelope, + resolveEnvelopeFormatOptions, +} from "openclaw/plugin-sdk/reply-runtime"; +import { + buildPendingHistoryContextFromMap, + recordPendingHistoryEntryIfEnabled, +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { buildMentionRegexes, matchesMentionWithExplicit } from "openclaw/plugin-sdk/reply-runtime"; +import type { FinalizedMsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolvePinnedMainDmOwnerFromAllowlist } from "openclaw/plugin-sdk/security-runtime"; import { resolveSlackReplyToMode, type ResolvedSlackAccount } from "../../accounts.js"; import { reactSlackMessage } from "../../actions.js"; import { sendMessageSlack } from "../../send.js"; diff --git a/extensions/slack/src/monitor/message-handler/types.ts b/extensions/slack/src/monitor/message-handler/types.ts index cd1e2bdc40c..bcff64cc470 100644 --- a/extensions/slack/src/monitor/message-handler/types.ts +++ b/extensions/slack/src/monitor/message-handler/types.ts @@ -1,5 +1,5 @@ -import type { FinalizedMsgContext } from "../../../../../src/auto-reply/templating.js"; -import type { ResolvedAgentRoute } from "../../../../../src/routing/resolve-route.js"; +import type { FinalizedMsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import type { ResolvedAgentRoute } from "openclaw/plugin-sdk/routing"; import type { ResolvedSlackAccount } from "../../accounts.js"; import type { SlackMessageEvent } from "../../types.js"; import type { SlackChannelConfigResolved } from "../channel-config.js"; diff --git a/extensions/slack/src/monitor/provider.ts b/extensions/slack/src/monitor/provider.ts index 2104a5355cf..5a382551b47 100644 --- a/extensions/slack/src/monitor/provider.ts +++ b/extensions/slack/src/monitor/provider.ts @@ -1,30 +1,30 @@ import type { IncomingMessage, ServerResponse } from "node:http"; import SlackBolt, * as SlackBoltNamespace from "@slack/bolt"; -import { resolveTextChunkLimit } from "../../../../src/auto-reply/chunk.js"; -import { DEFAULT_GROUP_HISTORY_LIMIT } from "../../../../src/auto-reply/reply/history.js"; import { addAllowlistUserEntriesFromConfigEntry, buildAllowlistResolutionSummary, mergeAllowlist, patchAllowlistUsersInConfigEntries, summarizeMapping, -} from "../../../../src/channels/allowlists/resolve-utils.js"; -import { loadConfig } from "../../../../src/config/config.js"; -import { isDangerousNameMatchingEnabled } from "../../../../src/config/dangerous-name-matching.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; import { resolveOpenProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, -} from "../../../../src/config/runtime-group-policy.js"; -import type { SessionScope } from "../../../../src/config/sessions.js"; -import { normalizeResolvedSecretInputString } from "../../../../src/config/types.secrets.js"; -import { createConnectedChannelStatusPatch } from "../../../../src/gateway/channel-status-patches.js"; -import { warn } from "../../../../src/globals.js"; -import { computeBackoff, sleepWithAbort } from "../../../../src/infra/backoff.js"; -import { installRequestBodyLimitGuard } from "../../../../src/infra/http-body.js"; -import { normalizeMainKey } from "../../../../src/routing/session-key.js"; -import { createNonExitingRuntime, type RuntimeEnv } from "../../../../src/runtime.js"; -import { normalizeStringEntries } from "../../../../src/shared/string-normalization.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { SessionScope } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/config-runtime"; +import { createConnectedChannelStatusPatch } from "openclaw/plugin-sdk/gateway-runtime"; +import { computeBackoff, sleepWithAbort } from "openclaw/plugin-sdk/infra-runtime"; +import { installRequestBodyLimitGuard } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { DEFAULT_GROUP_HISTORY_LIMIT } from "openclaw/plugin-sdk/reply-runtime"; +import { normalizeMainKey } from "openclaw/plugin-sdk/routing"; +import { warn } from "openclaw/plugin-sdk/runtime-env"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { normalizeStringEntries } from "openclaw/plugin-sdk/text-runtime"; import { resolveSlackAccount } from "../accounts.js"; import { resolveSlackWebClientOptions } from "../client.js"; import { normalizeSlackWebhookPath, registerSlackHttpHandler } from "../http/index.js"; diff --git a/extensions/slack/src/monitor/replies.ts b/extensions/slack/src/monitor/replies.ts index 885e71b7818..a8ef26510f0 100644 --- a/extensions/slack/src/monitor/replies.ts +++ b/extensions/slack/src/monitor/replies.ts @@ -1,10 +1,10 @@ -import type { ChunkMode } from "../../../../src/auto-reply/chunk.js"; -import { chunkMarkdownTextWithMode } from "../../../../src/auto-reply/chunk.js"; -import { createReplyReferencePlanner } from "../../../../src/auto-reply/reply/reply-reference.js"; -import { isSilentReplyText, SILENT_REPLY_TOKEN } from "../../../../src/auto-reply/tokens.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import type { MarkdownTableMode } from "../../../../src/config/types.base.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import type { ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import { chunkMarkdownTextWithMode } from "openclaw/plugin-sdk/reply-runtime"; +import { createReplyReferencePlanner } from "openclaw/plugin-sdk/reply-runtime"; +import { isSilentReplyText, SILENT_REPLY_TOKEN } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { parseSlackBlocksInput } from "../blocks-input.js"; import { markdownToSlackMrkdwnChunks } from "../format.js"; import { sendMessageSlack, type SlackSendIdentity } from "../send.js"; diff --git a/extensions/slack/src/monitor/room-context.ts b/extensions/slack/src/monitor/room-context.ts index 3cdf584566a..955f9f3c855 100644 --- a/extensions/slack/src/monitor/room-context.ts +++ b/extensions/slack/src/monitor/room-context.ts @@ -1,4 +1,4 @@ -import { buildUntrustedChannelMetadata } from "../../../../src/security/channel-metadata.js"; +import { buildUntrustedChannelMetadata } from "openclaw/plugin-sdk/security-runtime"; export function resolveSlackRoomContextHints(params: { isRoomish: boolean; diff --git a/extensions/slack/src/monitor/slash-commands.runtime.ts b/extensions/slack/src/monitor/slash-commands.runtime.ts index a87490f43bc..63fa59cd347 100644 --- a/extensions/slack/src/monitor/slash-commands.runtime.ts +++ b/extensions/slack/src/monitor/slash-commands.runtime.ts @@ -4,4 +4,4 @@ export { listNativeCommandSpecsForConfig, parseCommandArgs, resolveCommandArgMenu, -} from "../../../../src/auto-reply/commands-registry.js"; +} from "openclaw/plugin-sdk/reply-runtime"; diff --git a/extensions/slack/src/monitor/slash-dispatch.runtime.ts b/extensions/slack/src/monitor/slash-dispatch.runtime.ts index 01e47782467..0095471359c 100644 --- a/extensions/slack/src/monitor/slash-dispatch.runtime.ts +++ b/extensions/slack/src/monitor/slash-dispatch.runtime.ts @@ -1,9 +1,9 @@ -export { resolveChunkMode } from "../../../../src/auto-reply/chunk.js"; -export { finalizeInboundContext } from "../../../../src/auto-reply/reply/inbound-context.js"; -export { dispatchReplyWithDispatcher } from "../../../../src/auto-reply/reply/provider-dispatcher.js"; -export { resolveConversationLabel } from "../../../../src/channels/conversation-label.js"; -export { createReplyPrefixOptions } from "../../../../src/channels/reply-prefix.js"; -export { recordInboundSessionMetaSafe } from "../../../../src/channels/session-meta.js"; -export { resolveMarkdownTableMode } from "../../../../src/config/markdown-tables.js"; -export { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; +export { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +export { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +export { dispatchReplyWithDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +export { resolveConversationLabel } from "openclaw/plugin-sdk/channel-runtime"; +export { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +export { recordInboundSessionMetaSafe } from "openclaw/plugin-sdk/channel-runtime"; +export { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +export { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; export { deliverSlackSlashReplies } from "./replies.js"; diff --git a/extensions/slack/src/monitor/slash-skill-commands.runtime.ts b/extensions/slack/src/monitor/slash-skill-commands.runtime.ts index 20da07b3ec5..738580cdc0f 100644 --- a/extensions/slack/src/monitor/slash-skill-commands.runtime.ts +++ b/extensions/slack/src/monitor/slash-skill-commands.runtime.ts @@ -1 +1 @@ -export { listSkillCommandsForAgents } from "../../../../src/auto-reply/skill-commands.js"; +export { listSkillCommandsForAgents } from "openclaw/plugin-sdk/reply-runtime"; diff --git a/extensions/slack/src/monitor/slash.test-harness.ts b/extensions/slack/src/monitor/slash.test-harness.ts index 4b6f5a4ea27..3172154739e 100644 --- a/extensions/slack/src/monitor/slash.test-harness.ts +++ b/extensions/slack/src/monitor/slash.test-harness.ts @@ -12,32 +12,32 @@ const mocks = vi.hoisted(() => ({ resolveStorePathMock: vi.fn(), })); -vi.mock("../../../../src/auto-reply/reply/provider-dispatcher.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ dispatchReplyWithDispatcher: (...args: unknown[]) => mocks.dispatchMock(...args), })); -vi.mock("../../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: (...args: unknown[]) => mocks.readAllowFromStoreMock(...args), upsertChannelPairingRequest: (...args: unknown[]) => mocks.upsertPairingRequestMock(...args), })); -vi.mock("../../../../src/routing/resolve-route.js", () => ({ +vi.mock("openclaw/plugin-sdk/routing", () => ({ resolveAgentRoute: (...args: unknown[]) => mocks.resolveAgentRouteMock(...args), })); -vi.mock("../../../../src/auto-reply/reply/inbound-context.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ finalizeInboundContext: (...args: unknown[]) => mocks.finalizeInboundContextMock(...args), })); -vi.mock("../../../../src/channels/conversation-label.js", () => ({ +vi.mock("openclaw/plugin-sdk/channel-runtime", () => ({ resolveConversationLabel: (...args: unknown[]) => mocks.resolveConversationLabelMock(...args), })); -vi.mock("../../../../src/channels/reply-prefix.js", () => ({ +vi.mock("openclaw/plugin-sdk/channel-runtime", () => ({ createReplyPrefixOptions: (...args: unknown[]) => mocks.createReplyPrefixOptionsMock(...args), })); -vi.mock("../../../../src/config/sessions.js", () => ({ +vi.mock("openclaw/plugin-sdk/config-runtime", () => ({ recordSessionMetaFromInbound: (...args: unknown[]) => mocks.recordSessionMetaFromInboundMock(...args), resolveStorePath: (...args: unknown[]) => mocks.resolveStorePathMock(...args), diff --git a/extensions/slack/src/monitor/slash.ts b/extensions/slack/src/monitor/slash.ts index adf173a0961..a1c0bfa13a4 100644 --- a/extensions/slack/src/monitor/slash.ts +++ b/extensions/slack/src/monitor/slash.ts @@ -1,17 +1,14 @@ import type { SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs } from "@slack/bolt"; -import { - type ChatCommandDefinition, - type CommandArgs, -} from "../../../../src/auto-reply/commands-registry.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import { resolveCommandAuthorizedFromAuthorizers } from "../../../../src/channels/command-gating.js"; -import { resolveNativeCommandSessionTargets } from "../../../../src/channels/native-command-session-targets.js"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveNativeCommandSessionTargets } from "openclaw/plugin-sdk/channel-runtime"; import { resolveNativeCommandsEnabled, resolveNativeSkillsEnabled, -} from "../../../../src/config/commands.js"; -import { danger, logVerbose } from "../../../../src/globals.js"; -import { chunkItems } from "../../../../src/utils/chunk-items.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { type ChatCommandDefinition, type CommandArgs } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { chunkItems } from "openclaw/plugin-sdk/text-runtime"; import type { ResolvedSlackAccount } from "../accounts.js"; import { truncateSlackText } from "../truncate.js"; import { resolveSlackAllowListMatch, resolveSlackUserAllowed } from "./allow-list.js"; diff --git a/extensions/slack/src/monitor/thread-resolution.ts b/extensions/slack/src/monitor/thread-resolution.ts index 4230d5fc50f..11d54cd1ea6 100644 --- a/extensions/slack/src/monitor/thread-resolution.ts +++ b/extensions/slack/src/monitor/thread-resolution.ts @@ -1,6 +1,6 @@ import type { WebClient as SlackWebClient } from "@slack/web-api"; -import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { pruneMapToMaxSize } from "../../../../src/infra/map-size.js"; +import { pruneMapToMaxSize } from "openclaw/plugin-sdk/infra-runtime"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; import type { SlackMessageEvent } from "../types.js"; type ThreadTsCacheEntry = { diff --git a/extensions/slack/src/monitor/types.ts b/extensions/slack/src/monitor/types.ts index 1239ab771f5..5543697dcfa 100644 --- a/extensions/slack/src/monitor/types.ts +++ b/extensions/slack/src/monitor/types.ts @@ -1,5 +1,5 @@ -import type { OpenClawConfig, SlackSlashCommandConfig } from "../../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import type { OpenClawConfig, SlackSlashCommandConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { SlackFile, SlackMessageEvent } from "../types.js"; export type MonitorSlackOpts = { diff --git a/extensions/slack/src/outbound-adapter.ts b/extensions/slack/src/outbound-adapter.ts index 1c851c8f69e..56a5c995e40 100644 --- a/extensions/slack/src/outbound-adapter.ts +++ b/extensions/slack/src/outbound-adapter.ts @@ -2,15 +2,15 @@ import { resolvePayloadMediaUrls, sendPayloadMediaSequence, sendTextMediaPayload, -} from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import type { ChannelOutboundAdapter } from "../../../src/channels/plugins/types.js"; -import type { OutboundIdentity } from "../../../src/infra/outbound/identity.js"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { resolveInteractiveTextFallback, type InteractiveReply, -} from "../../../src/interactive/payload.js"; -import { getGlobalHookRunner } from "../../../src/plugins/hook-runner-global.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { OutboundIdentity } from "openclaw/plugin-sdk/infra-runtime"; +import { getGlobalHookRunner } from "openclaw/plugin-sdk/plugin-runtime"; import { parseSlackBlocksInput } from "./blocks-input.js"; import { buildSlackInteractiveBlocks, type SlackBlock } from "./blocks-render.js"; import { sendMessageSlack, type SlackSendIdentity } from "./send.js"; diff --git a/extensions/slack/src/plugin-shared.ts b/extensions/slack/src/plugin-shared.ts index 0c5a6c7957e..0a5eb6ea3ec 100644 --- a/extensions/slack/src/plugin-shared.ts +++ b/extensions/slack/src/plugin-shared.ts @@ -1,9 +1,9 @@ +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, - formatAllowFromLowercase, -} from "../../../src/plugin-sdk-internal/channel-config.js"; -import { type OpenClawConfig } from "../../../src/plugin-sdk-internal/slack.js"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/slack"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/slack/src/probe.ts b/extensions/slack/src/probe.ts index dba8744a18c..c370b11be9b 100644 --- a/extensions/slack/src/probe.ts +++ b/extensions/slack/src/probe.ts @@ -1,5 +1,5 @@ -import type { BaseProbeResult } from "../../../src/channels/plugins/types.js"; -import { withTimeout } from "../../../src/utils/with-timeout.js"; +import type { BaseProbeResult } from "openclaw/plugin-sdk/channel-runtime"; +import { withTimeout } from "openclaw/plugin-sdk/text-runtime"; import { createSlackWebClient } from "./client.js"; export type SlackProbe = BaseProbeResult & { diff --git a/extensions/slack/src/runtime.ts b/extensions/slack/src/runtime.ts index d7d09dbcb6b..2121ee9f902 100644 --- a/extensions/slack/src/runtime.ts +++ b/extensions/slack/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setSlackRuntime, getRuntime: getSlackRuntime } = createPluginRuntimeStore("Slack runtime not initialized"); diff --git a/extensions/slack/src/scopes.ts b/extensions/slack/src/scopes.ts index e0fe58161f3..fc7e14d741b 100644 --- a/extensions/slack/src/scopes.ts +++ b/extensions/slack/src/scopes.ts @@ -1,5 +1,5 @@ import type { WebClient } from "@slack/web-api"; -import { isRecord } from "../../../src/utils.js"; +import { isRecord } from "openclaw/plugin-sdk/text-runtime"; import { createSlackWebClient } from "./client.js"; export type SlackScopesResult = { diff --git a/extensions/slack/src/send.ts b/extensions/slack/src/send.ts index 293affe0218..cc352284ca3 100644 --- a/extensions/slack/src/send.ts +++ b/extensions/slack/src/send.ts @@ -1,17 +1,17 @@ import { type Block, type KnownBlock, type WebClient } from "@slack/web-api"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { + fetchWithSsrFGuard, + withTrustedEnvProxyGuardedFetchMode, +} from "openclaw/plugin-sdk/infra-runtime"; import { chunkMarkdownTextWithMode, resolveChunkMode, resolveTextChunkLimit, -} from "../../../src/auto-reply/chunk.js"; -import { isSilentReplyText } from "../../../src/auto-reply/tokens.js"; -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { logVerbose } from "../../../src/globals.js"; -import { - fetchWithSsrFGuard, - withTrustedEnvProxyGuardedFetchMode, -} from "../../../src/infra/net/fetch-guard.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { isSilentReplyText } from "openclaw/plugin-sdk/reply-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { loadWebMedia } from "../../whatsapp/src/media.js"; import type { SlackTokenSource } from "./accounts.js"; import { resolveSlackAccount } from "./accounts.js"; diff --git a/extensions/slack/src/sent-thread-cache.ts b/extensions/slack/src/sent-thread-cache.ts index 37cf8155472..f155571a1b4 100644 --- a/extensions/slack/src/sent-thread-cache.ts +++ b/extensions/slack/src/sent-thread-cache.ts @@ -1,4 +1,4 @@ -import { resolveGlobalMap } from "../../../src/shared/global-singleton.js"; +import { resolveGlobalMap } from "openclaw/plugin-sdk/text-runtime"; /** * In-memory cache of Slack threads the bot has participated in. diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index b53472c3ce9..2b3753a3c6d 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,7 +1,10 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; import { + applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, + formatDocsLink, hasConfiguredSecretInput, + migrateBaseNameToDefaultAccount, + normalizeAccountId, type OpenClawConfig, noteChannelLookupFailure, noteChannelLookupSummary, @@ -10,14 +13,13 @@ import { setAccountGroupPolicyForChannel, setLegacyChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, -} from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; import { type ChannelSetupAdapter, type ChannelSetupDmPolicy, type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +} from "openclaw/plugin-sdk/setup"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { @@ -36,8 +38,15 @@ function enableSlackAccount(cfg: OpenClawConfig, accountId: string): OpenClawCon }); } -export const slackSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, +export const slackSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), validateInput: ({ accountId, input }) => { if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { return "Slack env tokens can only be used for the default account."; @@ -47,93 +56,63 @@ export const slackSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupA } return null; }, - buildPatch: (input) => - input.useEnv - ? {} - : { - ...(input.botToken ? { botToken: input.botToken } : {}), - ...(input.appToken ? { appToken: input.appToken } : {}), - }, -}); - -type SlackAllowFromResolverParams = { - cfg: OpenClawConfig; - accountId: string; - credentialValues: { botToken?: string }; - entries: string[]; -}; - -type SlackGroupAllowlistResolverParams = SlackAllowFromResolverParams & { - prompter: { note: (message: string, title?: string) => Promise }; -}; - -type SlackSetupWizardHandlers = { - promptAllowFrom: (params: { - cfg: OpenClawConfig; - prompter: import("../../../src/plugin-sdk-internal/setup.js").WizardPrompter; - accountId?: string; - }) => Promise; - resolveAllowFromEntries: ( - params: SlackAllowFromResolverParams, - ) => Promise; - resolveGroupAllowlist: (params: SlackGroupAllowlistResolverParams) => Promise; -}; - -function buildSlackTokenCredential(params: { - inputKey: "botToken" | "appToken"; - providerHint: "slack-bot" | "slack-app"; - credentialLabel: string; - preferredEnvVar: "SLACK_BOT_TOKEN" | "SLACK_APP_TOKEN"; - inputPrompt: string; -}): NonNullable[number] { - const configKey = params.inputKey; - return { - inputKey: params.inputKey, - providerHint: params.providerHint, - credentialLabel: params.credentialLabel, - preferredEnvVar: params.preferredEnvVar, - envPrompt: `${params.preferredEnvVar} detected. Use env var?`, - keepPrompt: `${params.credentialLabel} already configured. Keep it?`, - inputPrompt: params.inputPrompt, - allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { - const resolved = resolveSlackAccount({ cfg, accountId }); - const tokenValue = resolved[configKey]?.trim() || undefined; - const configuredValue = resolved.config[configKey]; - return { - accountConfigured: Boolean(tokenValue) || hasConfiguredSecretInput(configuredValue), - hasConfiguredValue: hasConfiguredSecretInput(configuredValue), - resolvedValue: tokenValue, - envValue: - accountId === DEFAULT_ACCOUNT_ID - ? process.env[params.preferredEnvVar]?.trim() - : undefined, - }; - }, - applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => - enableSlackAccount(cfg, accountId), - applySet: ({ + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ cfg, + channelKey: channel, accountId, - value, - }: { - cfg: OpenClawConfig; - accountId: string; - value: unknown; - }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { - enabled: true, - [configKey]: value, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + if (accountId === DEFAULT_ACCOUNT_ID) { + return { + ...next, + channels: { + ...next.channels, + slack: { + ...next.channels?.slack, + enabled: true, + ...(input.useEnv + ? {} + : { + ...(input.botToken ? { botToken: input.botToken } : {}), + ...(input.appToken ? { appToken: input.appToken } : {}), + }), + }, }, - }), - }; -} + }; + } + return { + ...next, + channels: { + ...next.channels, + slack: { + ...next.channels?.slack, + enabled: true, + accounts: { + ...next.channels?.slack?.accounts, + [accountId]: { + ...next.channels?.slack?.accounts?.[accountId], + enabled: true, + ...(input.botToken ? { botToken: input.botToken } : {}), + ...(input.appToken ? { appToken: input.appToken } : {}), + }, + }, + }, + }, + }; + }, +}; -export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): ChannelSetupWizard { +export function createSlackSetupWizardProxy( + loadWizard: () => Promise<{ slackSetupWizard: ChannelSetupWizard }>, +) { const slackDmPolicy: ChannelSetupDmPolicy = { label: "Slack", channel, @@ -147,7 +126,13 @@ export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): channel, dmPolicy: policy, }), - promptAllowFrom: handlers.promptAllowFrom, + promptAllowFrom: async ({ cfg, prompter, accountId }) => { + const wizard = (await loadWizard()).slackSetupWizard; + if (!wizard.dmPolicy?.promptAllowFrom) { + return cfg; + } + return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); + }, }; return { @@ -182,20 +167,88 @@ export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): apply: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), }, credentials: [ - buildSlackTokenCredential({ + { inputKey: "botToken", providerHint: "slack-bot", credentialLabel: "Slack bot token", preferredEnvVar: "SLACK_BOT_TOKEN", + envPrompt: "SLACK_BOT_TOKEN detected. Use env var?", + keepPrompt: "Slack bot token already configured. Keep it?", inputPrompt: "Enter Slack bot token (xoxb-...)", - }), - buildSlackTokenCredential({ + allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { + const resolved = resolveSlackAccount({ cfg, accountId }); + return { + accountConfigured: + Boolean(resolved.botToken) || hasConfiguredSecretInput(resolved.config.botToken), + hasConfiguredValue: hasConfiguredSecretInput(resolved.config.botToken), + resolvedValue: resolved.botToken?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_BOT_TOKEN?.trim() : undefined, + }; + }, + applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => + enableSlackAccount(cfg, accountId), + applySet: ({ + cfg, + accountId, + value, + }: { + cfg: OpenClawConfig; + accountId: string; + value: unknown; + }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { + enabled: true, + botToken: value, + }, + }), + }, + { inputKey: "appToken", providerHint: "slack-app", credentialLabel: "Slack app token", preferredEnvVar: "SLACK_APP_TOKEN", + envPrompt: "SLACK_APP_TOKEN detected. Use env var?", + keepPrompt: "Slack app token already configured. Keep it?", inputPrompt: "Enter Slack app token (xapp-...)", - }), + allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { + const resolved = resolveSlackAccount({ cfg, accountId }); + return { + accountConfigured: + Boolean(resolved.appToken) || hasConfiguredSecretInput(resolved.config.appToken), + hasConfiguredValue: hasConfiguredSecretInput(resolved.config.appToken), + resolvedValue: resolved.appToken?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_APP_TOKEN?.trim() : undefined, + }; + }, + applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => + enableSlackAccount(cfg, accountId), + applySet: ({ + cfg, + accountId, + value, + }: { + cfg: OpenClawConfig; + accountId: string; + value: unknown; + }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { + enabled: true, + appToken: value, + }, + }), + }, ], dmPolicy: slackDmPolicy, allowFrom: { @@ -220,7 +273,28 @@ export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): idPattern: /^[A-Z][A-Z0-9]+$/i, normalizeId: (id) => id.toUpperCase(), }), - resolveEntries: handlers.resolveAllowFromEntries, + resolveEntries: async ({ + cfg, + accountId, + credentialValues, + entries, + }: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { botToken?: string }; + entries: string[]; + }) => { + const wizard = (await loadWizard()).slackSetupWizard; + if (!wizard.allowFrom) { + return entries.map((input) => ({ input, resolved: false, id: null })); + } + return await wizard.allowFrom.resolveEntries({ + cfg, + accountId, + credentialValues, + entries, + }); + }, apply: ({ cfg, accountId, @@ -263,22 +337,44 @@ export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): accountId, groupPolicy: policy, }), - resolveAllowlist: async (params: SlackGroupAllowlistResolverParams) => { + resolveAllowlist: async ({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { botToken?: string }; + entries: string[]; + prompter: { note: (message: string, title?: string) => Promise }; + }) => { try { - return await handlers.resolveGroupAllowlist(params); + const wizard = (await loadWizard()).slackSetupWizard; + if (!wizard.groupAccess?.resolveAllowlist) { + return entries; + } + return await wizard.groupAccess.resolveAllowlist({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }); } catch (error) { await noteChannelLookupFailure({ - prompter: params.prompter, + prompter, label: "Slack channels", error, }); await noteChannelLookupSummary({ - prompter: params.prompter, + prompter, label: "Slack channels", resolvedSections: [], - unresolved: params.entries, + unresolved: entries, }); - return params.entries; + return entries; } }, applyAllowlist: ({ @@ -294,42 +390,3 @@ export function createSlackSetupWizardBase(handlers: SlackSetupWizardHandlers): disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } - -export function createSlackSetupWizardProxy( - loadWizard: () => Promise<{ slackSetupWizard: ChannelSetupWizard }>, -) { - return createSlackSetupWizardBase({ - promptAllowFrom: async ({ cfg, prompter, accountId }) => { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.dmPolicy?.promptAllowFrom) { - return cfg; - } - return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); - }, - resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.allowFrom) { - return entries.map((input) => ({ input, resolved: false, id: null })); - } - return await wizard.allowFrom.resolveEntries({ - cfg, - accountId, - credentialValues, - entries, - }); - }, - resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.groupAccess?.resolveAllowlist) { - return entries; - } - return (await wizard.groupAccess.resolveAllowlist({ - cfg, - accountId, - credentialValues, - entries, - prompter, - })) as string[]; - }, - }); -} diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 8f5024276ca..1dbfa4f02ce 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,22 +1,50 @@ import { + DEFAULT_ACCOUNT_ID, formatDocsLink, + hasConfiguredSecretInput, noteChannelLookupFailure, noteChannelLookupSummary, + normalizeAccountId, type OpenClawConfig, parseMentionOrPrefixedId, + patchChannelConfigForAccount, promptLegacyChannelAllowFrom, resolveSetupAccountId, + setAccountGroupPolicyForChannel, + setLegacyChannelDmPolicyWithAllowFrom, + setSetupChannelEnabled, type WizardPrompter, -} from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; import type { + ChannelSetupDmPolicy, ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { resolveDefaultSlackAccountId, resolveSlackAccount } from "./accounts.js"; +} from "openclaw/plugin-sdk/setup"; +import { inspectSlackAccount } from "./account-inspect.js"; +import { + listSlackAccountIds, + resolveDefaultSlackAccountId, + resolveSlackAccount, + type ResolvedSlackAccount, +} from "./accounts.js"; import { resolveSlackChannelAllowlist } from "./resolve-channels.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; -import { createSlackSetupWizardBase } from "./setup-core.js"; -import { SLACK_CHANNEL as channel } from "./shared.js"; +import { slackSetupAdapter } from "./setup-core.js"; +import { + buildSlackSetupLines, + isSlackSetupAccountConfigured, + setSlackChannelAllowlist, + SLACK_CHANNEL as channel, +} from "./shared.js"; + +function enableSlackAccount(cfg: OpenClawConfig, accountId: string): OpenClawConfig { + return patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { enabled: true }, + }); +} async function resolveSlackAllowFromEntries(params: { token?: string; @@ -89,45 +117,211 @@ async function promptSlackAllowFrom(params: { }); } -export const slackSetupWizard: ChannelSetupWizard = createSlackSetupWizardBase({ - promptAllowFrom: promptSlackAllowFrom, - resolveAllowFromEntries: async ({ credentialValues, entries }) => - await resolveSlackAllowFromEntries({ - token: credentialValues.botToken, - entries, - }), - resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - let keys = entries; - const accountWithTokens = resolveSlackAccount({ +const slackDmPolicy: ChannelSetupDmPolicy = { + label: "Slack", + channel, + policyKey: "channels.slack.dmPolicy", + allowFromKey: "channels.slack.allowFrom", + getCurrent: (cfg) => + cfg.channels?.slack?.dmPolicy ?? cfg.channels?.slack?.dm?.policy ?? "pairing", + setPolicy: (cfg, policy) => + setLegacyChannelDmPolicyWithAllowFrom({ cfg, - accountId, - }); - const activeBotToken = accountWithTokens.botToken || credentialValues.botToken || ""; - if (activeBotToken && entries.length > 0) { - try { - const resolved = await resolveSlackChannelAllowlist({ - token: activeBotToken, - entries, - }); - const resolvedKeys = resolved - .filter((entry) => entry.resolved && entry.id) - .map((entry) => entry.id as string); - const unresolved = resolved.filter((entry) => !entry.resolved).map((entry) => entry.input); - keys = [...resolvedKeys, ...unresolved.map((entry) => entry.trim()).filter(Boolean)]; - await noteChannelLookupSummary({ - prompter, - label: "Slack channels", - resolvedSections: [{ title: "Resolved", values: resolvedKeys }], - unresolved, - }); - } catch (error) { - await noteChannelLookupFailure({ - prompter, - label: "Slack channels", - error, - }); - } - } - return keys; + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptSlackAllowFrom, +}; + +export const slackSetupWizard: ChannelSetupWizard = { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs tokens", + configuredHint: "configured", + unconfiguredHint: "needs tokens", + configuredScore: 2, + unconfiguredScore: 1, + resolveConfigured: ({ cfg }) => + listSlackAccountIds(cfg).some((accountId) => { + const account = inspectSlackAccount({ cfg, accountId }); + return account.configured; + }), }, -}); + introNote: { + title: "Slack socket mode tokens", + lines: buildSlackSetupLines(), + shouldShow: ({ cfg, accountId }) => + !isSlackSetupAccountConfigured(resolveSlackAccount({ cfg, accountId })), + }, + envShortcut: { + prompt: "SLACK_BOT_TOKEN + SLACK_APP_TOKEN detected. Use env vars?", + preferredEnvVar: "SLACK_BOT_TOKEN", + isAvailable: ({ cfg, accountId }) => + accountId === DEFAULT_ACCOUNT_ID && + Boolean(process.env.SLACK_BOT_TOKEN?.trim()) && + Boolean(process.env.SLACK_APP_TOKEN?.trim()) && + !isSlackSetupAccountConfigured(resolveSlackAccount({ cfg, accountId })), + apply: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), + }, + credentials: [ + { + inputKey: "botToken", + providerHint: "slack-bot", + credentialLabel: "Slack bot token", + preferredEnvVar: "SLACK_BOT_TOKEN", + envPrompt: "SLACK_BOT_TOKEN detected. Use env var?", + keepPrompt: "Slack bot token already configured. Keep it?", + inputPrompt: "Enter Slack bot token (xoxb-...)", + allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }) => { + const resolved = resolveSlackAccount({ cfg, accountId }); + return { + accountConfigured: + Boolean(resolved.botToken) || hasConfiguredSecretInput(resolved.config.botToken), + hasConfiguredValue: hasConfiguredSecretInput(resolved.config.botToken), + resolvedValue: resolved.botToken?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_BOT_TOKEN?.trim() : undefined, + }; + }, + applyUseEnv: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), + applySet: ({ cfg, accountId, value }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { + enabled: true, + botToken: value, + }, + }), + }, + { + inputKey: "appToken", + providerHint: "slack-app", + credentialLabel: "Slack app token", + preferredEnvVar: "SLACK_APP_TOKEN", + envPrompt: "SLACK_APP_TOKEN detected. Use env var?", + keepPrompt: "Slack app token already configured. Keep it?", + inputPrompt: "Enter Slack app token (xapp-...)", + allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }) => { + const resolved = resolveSlackAccount({ cfg, accountId }); + return { + accountConfigured: + Boolean(resolved.appToken) || hasConfiguredSecretInput(resolved.config.appToken), + hasConfiguredValue: hasConfiguredSecretInput(resolved.config.appToken), + resolvedValue: resolved.appToken?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_APP_TOKEN?.trim() : undefined, + }; + }, + applyUseEnv: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), + applySet: ({ cfg, accountId, value }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { + enabled: true, + appToken: value, + }, + }), + }, + ], + dmPolicy: slackDmPolicy, + allowFrom: { + helpTitle: "Slack allowlist", + helpLines: [ + "Allowlist Slack DMs by username (we resolve to user ids).", + "Examples:", + "- U12345678", + "- @alice", + "Multiple entries: comma-separated.", + `Docs: ${formatDocsLink("/slack", "slack")}`, + ], + credentialInputKey: "botToken", + message: "Slack allowFrom (usernames or ids)", + placeholder: "@alice, U12345678", + invalidWithoutCredentialNote: "Slack token missing; use user ids (or mention form) only.", + parseId: (value) => + parseMentionOrPrefixedId({ + value, + mentionPattern: /^<@([A-Z0-9]+)>$/i, + prefixPattern: /^(slack:|user:)/i, + idPattern: /^[A-Z][A-Z0-9]+$/i, + normalizeId: (id) => id.toUpperCase(), + }), + resolveEntries: async ({ credentialValues, entries }) => + await resolveSlackAllowFromEntries({ + token: credentialValues.botToken, + entries, + }), + apply: ({ cfg, accountId, allowFrom }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { dmPolicy: "allowlist", allowFrom }, + }), + }, + groupAccess: { + label: "Slack channels", + placeholder: "#general, #private, C123", + currentPolicy: ({ cfg, accountId }) => + resolveSlackAccount({ cfg, accountId }).config.groupPolicy ?? "allowlist", + currentEntries: ({ cfg, accountId }) => + Object.entries(resolveSlackAccount({ cfg, accountId }).config.channels ?? {}) + .filter(([, value]) => value?.allow !== false && value?.enabled !== false) + .map(([key]) => key), + updatePrompt: ({ cfg, accountId }) => + Boolean(resolveSlackAccount({ cfg, accountId }).config.channels), + setPolicy: ({ cfg, accountId, policy }) => + setAccountGroupPolicyForChannel({ + cfg, + channel, + accountId, + groupPolicy: policy, + }), + resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { + let keys = entries; + const accountWithTokens = resolveSlackAccount({ + cfg, + accountId, + }); + const activeBotToken = accountWithTokens.botToken || credentialValues.botToken || ""; + if (activeBotToken && entries.length > 0) { + try { + const resolved = await resolveSlackChannelAllowlist({ + token: activeBotToken, + entries, + }); + const resolvedKeys = resolved + .filter((entry) => entry.resolved && entry.id) + .map((entry) => entry.id as string); + const unresolved = resolved + .filter((entry) => !entry.resolved) + .map((entry) => entry.input); + keys = [...resolvedKeys, ...unresolved.map((entry) => entry.trim()).filter(Boolean)]; + await noteChannelLookupSummary({ + prompter, + label: "Slack channels", + resolvedSections: [{ title: "Resolved", values: resolvedKeys }], + unresolved, + }); + } catch (error) { + await noteChannelLookupFailure({ + prompter, + label: "Slack channels", + error, + }); + } + } + return keys; + }, + applyAllowlist: ({ cfg, accountId, resolved }) => + setSlackChannelAllowlist(cfg, accountId, resolved as string[]), + }, + disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), +}; diff --git a/extensions/slack/src/stream-mode.ts b/extensions/slack/src/stream-mode.ts index 819eb4fa722..f341c0a5304 100644 --- a/extensions/slack/src/stream-mode.ts +++ b/extensions/slack/src/stream-mode.ts @@ -4,7 +4,7 @@ import { resolveSlackStreamingMode, type SlackLegacyDraftStreamMode, type StreamingMode, -} from "../../../src/config/discord-preview-streaming.js"; +} from "openclaw/plugin-sdk/config-runtime"; export type SlackStreamMode = SlackLegacyDraftStreamMode; export type SlackStreamingMode = StreamingMode; diff --git a/extensions/slack/src/streaming.ts b/extensions/slack/src/streaming.ts index b6269412c9d..1685e378f61 100644 --- a/extensions/slack/src/streaming.ts +++ b/extensions/slack/src/streaming.ts @@ -13,7 +13,7 @@ import type { WebClient } from "@slack/web-api"; import type { ChatStreamer } from "@slack/web-api/dist/chat-stream.js"; -import { logVerbose } from "../../../src/globals.js"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; // --------------------------------------------------------------------------- // Types diff --git a/extensions/slack/src/targets.ts b/extensions/slack/src/targets.ts index 5d80650daff..43162a447d5 100644 --- a/extensions/slack/src/targets.ts +++ b/extensions/slack/src/targets.ts @@ -6,7 +6,7 @@ import { type MessagingTarget, type MessagingTargetKind, type MessagingTargetParseOptions, -} from "../../../src/channels/targets.js"; +} from "openclaw/plugin-sdk/channel-runtime"; export type SlackTargetKind = MessagingTargetKind; diff --git a/extensions/slack/src/threading-tool-context.ts b/extensions/slack/src/threading-tool-context.ts index 206ce98b42f..30451be5b6b 100644 --- a/extensions/slack/src/threading-tool-context.ts +++ b/extensions/slack/src/threading-tool-context.ts @@ -1,8 +1,8 @@ import type { ChannelThreadingContext, ChannelThreadingToolContext, -} from "../../../src/channels/plugins/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveSlackAccount, resolveSlackReplyToMode } from "./accounts.js"; export function buildSlackThreadingToolContext(params: { diff --git a/extensions/slack/src/threading.ts b/extensions/slack/src/threading.ts index ccef2e5e081..d072ab796c0 100644 --- a/extensions/slack/src/threading.ts +++ b/extensions/slack/src/threading.ts @@ -1,4 +1,4 @@ -import type { ReplyToMode } from "../../../src/config/types.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; import type { SlackAppMentionEvent, SlackMessageEvent } from "./types.js"; export type SlackThreadContext = { diff --git a/extensions/slack/src/token.ts b/extensions/slack/src/token.ts index cebda65e335..36f31c89383 100644 --- a/extensions/slack/src/token.ts +++ b/extensions/slack/src/token.ts @@ -1,4 +1,4 @@ -import { normalizeResolvedSecretInputString } from "../../../src/config/types.secrets.js"; +import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/config-runtime"; export function normalizeSlackToken(raw?: unknown): string | undefined { return normalizeResolvedSecretInputString({ diff --git a/extensions/synthetic/index.ts b/extensions/synthetic/index.ts index ed029dc7cce..19e7424bfb7 100644 --- a/extensions/synthetic/index.ts +++ b/extensions/synthetic/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applySyntheticConfig, SYNTHETIC_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildSyntheticProvider } from "./provider-catalog.js"; diff --git a/extensions/synthetic/onboard.ts b/extensions/synthetic/onboard.ts index 34199d4db2b..d11f2cb0e9b 100644 --- a/extensions/synthetic/onboard.ts +++ b/extensions/synthetic/onboard.ts @@ -3,12 +3,12 @@ import { SYNTHETIC_BASE_URL, SYNTHETIC_DEFAULT_MODEL_REF, SYNTHETIC_MODEL_CATALOG, -} from "../../src/agents/synthetic-models.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export { SYNTHETIC_DEFAULT_MODEL_REF }; diff --git a/extensions/synthetic/provider-catalog.ts b/extensions/synthetic/provider-catalog.ts index 181affdde2b..e46b08682c2 100644 --- a/extensions/synthetic/provider-catalog.ts +++ b/extensions/synthetic/provider-catalog.ts @@ -1,9 +1,9 @@ import { buildSyntheticModelDefinition, + type ModelProviderConfig, SYNTHETIC_BASE_URL, SYNTHETIC_MODEL_CATALOG, -} from "../../src/agents/synthetic-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +} from "openclaw/plugin-sdk/provider-models"; export function buildSyntheticProvider(): ModelProviderConfig { return { diff --git a/extensions/talk-voice/index.ts b/extensions/talk-voice/index.ts index 8f698262e3e..fb9e7bdb39d 100644 --- a/extensions/talk-voice/index.ts +++ b/extensions/talk-voice/index.ts @@ -1,6 +1,6 @@ +import { resolveActiveTalkProviderConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { SpeechVoiceOption } from "openclaw/plugin-sdk/speech"; import type { OpenClawPluginApi } from "openclaw/plugin-sdk/talk-voice"; -import { resolveActiveTalkProviderConfig } from "../../src/config/talk.js"; -import type { SpeechVoiceOption } from "../../src/tts/provider-types.js"; function mask(s: string, keep: number = 6): string { const trimmed = s.trim(); diff --git a/extensions/telegram/src/account-inspect.ts b/extensions/telegram/src/account-inspect.ts index 1e428c237fa..6295a231451 100644 --- a/extensions/telegram/src/account-inspect.ts +++ b/extensions/telegram/src/account-inspect.ts @@ -1,14 +1,14 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; +import { resolveAccountWithDefaultFallback } from "openclaw/plugin-sdk/account-resolution"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { coerceSecretRef, hasConfiguredSecretInput, normalizeSecretInputString, -} from "../../../src/config/types.secrets.js"; -import { tryReadSecretFileSync } from "../../../src/infra/secret-file.js"; -import { resolveAccountWithDefaultFallback } from "../../../src/plugin-sdk-internal/accounts.js"; -import type { TelegramAccountConfig } from "../../../src/plugin-sdk-internal/telegram.js"; -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; -import { resolveDefaultSecretProviderAlias } from "../../../src/secrets/ref-contract.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { tryReadSecretFileSync } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveDefaultSecretProviderAlias } from "openclaw/plugin-sdk/provider-auth"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/routing"; +import type { TelegramAccountConfig } from "openclaw/plugin-sdk/telegram"; import { mergeTelegramAccountConfig, resolveDefaultTelegramAccountId, diff --git a/extensions/telegram/src/accounts.ts b/extensions/telegram/src/accounts.ts index 6d2255e00a1..2e0c053d0d4 100644 --- a/extensions/telegram/src/accounts.ts +++ b/extensions/telegram/src/accounts.ts @@ -1,27 +1,22 @@ import util from "node:util"; -import { createAccountActionGate } from "../../../src/channels/plugins/account-action-gate.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { isTruthyEnvValue } from "../../../src/infra/env.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; import { + createAccountActionGate, + DEFAULT_ACCOUNT_ID, listConfiguredAccountIds as listConfiguredAccountIdsFromSection, + normalizeAccountId, + normalizeOptionalAccountId, + resolveAccountEntry, resolveAccountWithDefaultFallback, -} from "../../../src/plugin-sdk-internal/accounts.js"; -import type { - TelegramAccountConfig, - TelegramActionConfig, -} from "../../../src/plugin-sdk-internal/telegram.js"; -import { resolveAccountEntry } from "../../../src/routing/account-lookup.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import { isTruthyEnvValue } from "openclaw/plugin-sdk/infra-runtime"; import { listBoundAccountIds, resolveDefaultAgentBoundAccountId, -} from "../../../src/routing/bindings.js"; -import { formatSetExplicitDefaultInstruction } from "../../../src/routing/default-account-warnings.js"; -import { - DEFAULT_ACCOUNT_ID, - normalizeAccountId, - normalizeOptionalAccountId, -} from "../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/routing"; +import { formatSetExplicitDefaultInstruction } from "openclaw/plugin-sdk/routing"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { TelegramAccountConfig, TelegramActionConfig } from "openclaw/plugin-sdk/telegram"; import { resolveTelegramToken } from "./token.js"; let log: ReturnType | null = null; diff --git a/extensions/telegram/src/api-logging.ts b/extensions/telegram/src/api-logging.ts index 6af9d7ae5a3..2abc74f0894 100644 --- a/extensions/telegram/src/api-logging.ts +++ b/extensions/telegram/src/api-logging.ts @@ -1,7 +1,7 @@ -import { danger } from "../../../src/globals.js"; -import { formatErrorMessage } from "../../../src/infra/errors.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; export type TelegramApiLogger = (message: string) => void; diff --git a/extensions/telegram/src/approval-buttons.ts b/extensions/telegram/src/approval-buttons.ts index a996ed3adf3..8ce836c754b 100644 --- a/extensions/telegram/src/approval-buttons.ts +++ b/extensions/telegram/src/approval-buttons.ts @@ -1,4 +1,4 @@ -import type { ExecApprovalReplyDecision } from "../../../src/infra/exec-approval-reply.js"; +import type { ExecApprovalReplyDecision } from "openclaw/plugin-sdk/infra-runtime"; import type { TelegramInlineButtons } from "./button-types.js"; const MAX_CALLBACK_DATA_BYTES = 64; diff --git a/extensions/telegram/src/audit-membership-runtime.ts b/extensions/telegram/src/audit-membership-runtime.ts index 694ad338c5b..930d768778e 100644 --- a/extensions/telegram/src/audit-membership-runtime.ts +++ b/extensions/telegram/src/audit-membership-runtime.ts @@ -1,5 +1,5 @@ -import { isRecord } from "../../../src/utils.js"; -import { fetchWithTimeout } from "../../../src/utils/fetch-timeout.js"; +import { isRecord } from "openclaw/plugin-sdk/text-runtime"; +import { fetchWithTimeout } from "openclaw/plugin-sdk/text-runtime"; import type { AuditTelegramGroupMembershipParams, TelegramGroupMembershipAudit, diff --git a/extensions/telegram/src/audit.ts b/extensions/telegram/src/audit.ts index 507f161edca..f7fb0969090 100644 --- a/extensions/telegram/src/audit.ts +++ b/extensions/telegram/src/audit.ts @@ -1,5 +1,5 @@ -import type { TelegramGroupConfig } from "../../../src/config/types.js"; -import type { TelegramNetworkConfig } from "../../../src/config/types.telegram.js"; +import type { TelegramGroupConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramNetworkConfig } from "openclaw/plugin-sdk/config-runtime"; export type TelegramGroupMembershipAuditEntry = { chatId: string; diff --git a/extensions/telegram/src/bot-access.ts b/extensions/telegram/src/bot-access.ts index bee8392e686..c89a8fe6f48 100644 --- a/extensions/telegram/src/bot-access.ts +++ b/extensions/telegram/src/bot-access.ts @@ -2,9 +2,9 @@ import { firstDefined, isSenderIdAllowed, mergeDmAllowFromSources, -} from "../../../src/channels/allow-from.js"; -import type { AllowlistMatch } from "../../../src/channels/allowlist-match.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { AllowlistMatch } from "openclaw/plugin-sdk/channel-runtime"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; export type NormalizedAllowFrom = { entries: string[]; diff --git a/extensions/telegram/src/bot-handlers.ts b/extensions/telegram/src/bot-handlers.ts index 88e61e1c567..18db7c3405f 100644 --- a/extensions/telegram/src/bot-handlers.ts +++ b/extensions/telegram/src/bot-handlers.ts @@ -1,47 +1,47 @@ import type { Message, ReactionTypeEmoji } from "@grammyjs/types"; -import { resolveAgentDir, resolveDefaultAgentId } from "../../../src/agents/agent-scope.js"; -import { resolveDefaultModelForAgent } from "../../../src/agents/model-selection.js"; -import { - createInboundDebouncer, - resolveInboundDebounceMs, -} from "../../../src/auto-reply/inbound-debounce.js"; -import { buildCommandsPaginationKeyboard } from "../../../src/auto-reply/reply/commands-info.js"; -import { - buildModelsProviderData, - formatModelsAvailableHeader, -} from "../../../src/auto-reply/reply/commands-models.js"; -import { resolveStoredModelOverride } from "../../../src/auto-reply/reply/model-selection.js"; -import { listSkillCommandsForAgents } from "../../../src/auto-reply/skill-commands.js"; -import { buildCommandsMessagePaginated } from "../../../src/auto-reply/status.js"; -import { shouldDebounceTextInbound } from "../../../src/channels/inbound-debounce-policy.js"; -import { resolveChannelConfigWrites } from "../../../src/channels/plugins/config-writes.js"; -import { loadConfig } from "../../../src/config/config.js"; -import { writeConfigFile } from "../../../src/config/io.js"; +import { resolveAgentDir, resolveDefaultAgentId } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveDefaultModelForAgent } from "openclaw/plugin-sdk/agent-runtime"; +import { shouldDebounceTextInbound } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveChannelConfigWrites } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { writeConfigFile } from "openclaw/plugin-sdk/config-runtime"; import { loadSessionStore, resolveSessionStoreEntry, resolveStorePath, updateSessionStore, -} from "../../../src/config/sessions.js"; -import type { DmPolicy } from "../../../src/config/types.base.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { DmPolicy } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; -import { danger, logVerbose, warn } from "../../../src/globals.js"; -import { enqueueSystemEvent } from "../../../src/infra/system-events.js"; -import { MediaFetchError } from "../../../src/media/fetch.js"; -import { readChannelAllowFromStore } from "../../../src/pairing/pairing-store.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { applyModelOverrideToSessionEntry } from "openclaw/plugin-sdk/config-runtime"; +import { readChannelAllowFromStore } from "openclaw/plugin-sdk/conversation-runtime"; import { buildPluginBindingResolvedText, parsePluginBindingApprovalCustomId, resolvePluginConversationBindingApproval, -} from "../../../src/plugins/conversation-binding.js"; -import { dispatchPluginInteractiveHandler } from "../../../src/plugins/interactive.js"; -import { resolveAgentRoute } from "../../../src/routing/resolve-route.js"; -import { resolveThreadSessionKeys } from "../../../src/routing/session-key.js"; -import { applyModelOverrideToSessionEntry } from "../../../src/sessions/model-overrides.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { MediaFetchError } from "openclaw/plugin-sdk/media-runtime"; +import { dispatchPluginInteractiveHandler } from "openclaw/plugin-sdk/plugin-runtime"; +import { + createInboundDebouncer, + resolveInboundDebounceMs, +} from "openclaw/plugin-sdk/reply-runtime"; +import { buildCommandsPaginationKeyboard } from "openclaw/plugin-sdk/reply-runtime"; +import { + buildModelsProviderData, + formatModelsAvailableHeader, +} from "openclaw/plugin-sdk/reply-runtime"; +import { resolveStoredModelOverride } from "openclaw/plugin-sdk/reply-runtime"; +import { listSkillCommandsForAgents } from "openclaw/plugin-sdk/reply-runtime"; +import { buildCommandsMessagePaginated } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { danger, logVerbose, warn } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { isSenderAllowed, diff --git a/extensions/telegram/src/bot-message-context.body.ts b/extensions/telegram/src/bot-message-context.body.ts index 8290b02169d..5b4dc2f9cae 100644 --- a/extensions/telegram/src/bot-message-context.body.ts +++ b/extensions/telegram/src/bot-message-context.body.ts @@ -2,29 +2,26 @@ import { findModelInCatalog, loadModelCatalog, modelSupportsVision, -} from "../../../src/agents/model-catalog.js"; -import { resolveDefaultModelForAgent } from "../../../src/agents/model-selection.js"; -import { hasControlCommand } from "../../../src/auto-reply/command-detection.js"; -import { - recordPendingHistoryEntryIfEnabled, - type HistoryEntry, -} from "../../../src/auto-reply/reply/history.js"; -import { - buildMentionRegexes, - matchesMentionWithExplicit, -} from "../../../src/auto-reply/reply/mentions.js"; -import type { MsgContext } from "../../../src/auto-reply/templating.js"; -import { resolveControlCommandGate } from "../../../src/channels/command-gating.js"; -import { formatLocationText, type NormalizedLocation } from "../../../src/channels/location.js"; -import { logInboundDrop } from "../../../src/channels/logging.js"; -import { resolveMentionGatingWithBypass } from "../../../src/channels/mention-gating.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { resolveDefaultModelForAgent } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveControlCommandGate } from "openclaw/plugin-sdk/channel-runtime"; +import { formatLocationText, type NormalizedLocation } from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMentionGatingWithBypass } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; -import { logVerbose } from "../../../src/globals.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { + recordPendingHistoryEntryIfEnabled, + type HistoryEntry, +} from "openclaw/plugin-sdk/reply-runtime"; +import { buildMentionRegexes, matchesMentionWithExplicit } from "openclaw/plugin-sdk/reply-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import type { NormalizedAllowFrom } from "./bot-access.js"; import { isSenderAllowed } from "./bot-access.js"; import type { @@ -182,8 +179,7 @@ export async function resolveTelegramInboundBody(params: { if (needsPreflightTranscription) { try { - const { transcribeFirstAudio } = - await import("../../../src/media-understanding/audio-preflight.js"); + const { transcribeFirstAudio } = await import("openclaw/plugin-sdk/media-runtime"); const tempCtx: MsgContext = { MediaPaths: allMedia.length > 0 ? allMedia.map((m) => m.path) : undefined, MediaTypes: diff --git a/extensions/telegram/src/bot-message-context.session.ts b/extensions/telegram/src/bot-message-context.session.ts index 1a2f54cf22f..47bcda8592f 100644 --- a/extensions/telegram/src/bot-message-context.session.ts +++ b/extensions/telegram/src/bot-message-context.session.ts @@ -1,26 +1,26 @@ -import { normalizeCommandBody } from "../../../src/auto-reply/commands-registry.js"; -import { - formatInboundEnvelope, - resolveEnvelopeFormatOptions, -} from "../../../src/auto-reply/envelope.js"; -import { - buildPendingHistoryContextFromMap, - type HistoryEntry, -} from "../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../src/auto-reply/reply/inbound-context.js"; -import { toLocationContext } from "../../../src/channels/location.js"; -import { recordInboundSession } from "../../../src/channels/session.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { readSessionUpdatedAt, resolveStorePath } from "../../../src/config/sessions.js"; +import { toLocationContext } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSession } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { readSessionUpdatedAt, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; -import { logVerbose, shouldLogVerbose } from "../../../src/globals.js"; -import type { ResolvedAgentRoute } from "../../../src/routing/resolve-route.js"; -import { resolveInboundLastRouteSessionKey } from "../../../src/routing/resolve-route.js"; -import { resolvePinnedMainDmOwnerFromAllowlist } from "../../../src/security/dm-policy-shared.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { normalizeCommandBody } from "openclaw/plugin-sdk/reply-runtime"; +import { + formatInboundEnvelope, + resolveEnvelopeFormatOptions, +} from "openclaw/plugin-sdk/reply-runtime"; +import { + buildPendingHistoryContextFromMap, + type HistoryEntry, +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import type { ResolvedAgentRoute } from "openclaw/plugin-sdk/routing"; +import { resolveInboundLastRouteSessionKey } from "openclaw/plugin-sdk/routing"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolvePinnedMainDmOwnerFromAllowlist } from "openclaw/plugin-sdk/security-runtime"; import { normalizeAllowFrom } from "./bot-access.js"; import type { TelegramMediaRef, @@ -63,7 +63,7 @@ export async function buildTelegramInboundContextPayload(params: { stickerCacheHit: boolean; effectiveWasMentioned: boolean; commandAuthorized: boolean; - locationData?: import("../../../src/channels/location.js").NormalizedLocation; + locationData?: import("openclaw/plugin-sdk/channel-runtime").NormalizedLocation; options?: TelegramMessageContextOptions; dmAllowFrom?: Array; }): Promise<{ diff --git a/extensions/telegram/src/bot-message-context.ts b/extensions/telegram/src/bot-message-context.ts index 03bcd429018..d77fd52f2fc 100644 --- a/extensions/telegram/src/bot-message-context.ts +++ b/extensions/telegram/src/bot-message-context.ts @@ -1,17 +1,17 @@ -import { ensureConfiguredAcpRouteReady } from "../../../src/acp/persistent-bindings.route.js"; -import { resolveAckReaction } from "../../../src/agents/identity.js"; -import { shouldAckReaction as shouldAckReactionGate } from "../../../src/channels/ack-reactions.js"; -import { logInboundDrop } from "../../../src/channels/logging.js"; +import { resolveAckReaction } from "openclaw/plugin-sdk/agent-runtime"; +import { shouldAckReaction as shouldAckReactionGate } from "openclaw/plugin-sdk/channel-runtime"; +import { logInboundDrop } from "openclaw/plugin-sdk/channel-runtime"; import { createStatusReactionController, type StatusReactionController, -} from "../../../src/channels/status-reactions.js"; -import { loadConfig } from "../../../src/config/config.js"; -import type { TelegramDirectConfig, TelegramGroupConfig } from "../../../src/config/types.js"; -import { logVerbose } from "../../../src/globals.js"; -import { recordChannelActivity } from "../../../src/infra/channel-activity.js"; -import { buildAgentSessionKey, deriveLastRoutePolicy } from "../../../src/routing/resolve-route.js"; -import { DEFAULT_ACCOUNT_ID, resolveThreadSessionKeys } from "../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramDirectConfig, TelegramGroupConfig } from "openclaw/plugin-sdk/config-runtime"; +import { ensureConfiguredAcpRouteReady } from "openclaw/plugin-sdk/conversation-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import { buildAgentSessionKey, deriveLastRoutePolicy } from "openclaw/plugin-sdk/routing"; +import { DEFAULT_ACCOUNT_ID, resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { firstDefined, normalizeAllowFrom, normalizeDmAllowFromWithStore } from "./bot-access.js"; import { resolveTelegramInboundBody } from "./bot-message-context.body.js"; diff --git a/extensions/telegram/src/bot-message-context.types.ts b/extensions/telegram/src/bot-message-context.types.ts index 2853c1a8e34..ca0fbbf3376 100644 --- a/extensions/telegram/src/bot-message-context.types.ts +++ b/extensions/telegram/src/bot-message-context.types.ts @@ -1,12 +1,12 @@ import type { Bot } from "grammy"; -import type { HistoryEntry } from "../../../src/auto-reply/reply/history.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import type { DmPolicy, TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; import type { StickerMetadata, TelegramContext } from "./bot/types.js"; export type TelegramMediaRef = { diff --git a/extensions/telegram/src/bot-message-dispatch.ts b/extensions/telegram/src/bot-message-dispatch.ts index 9b603393450..a8a4c376b0b 100644 --- a/extensions/telegram/src/bot-message-dispatch.ts +++ b/extensions/telegram/src/bot-message-dispatch.ts @@ -1,33 +1,33 @@ import type { Bot } from "grammy"; -import { resolveAgentDir } from "../../../src/agents/agent-scope.js"; +import { resolveAgentDir } from "openclaw/plugin-sdk/agent-runtime"; import { findModelInCatalog, loadModelCatalog, modelSupportsVision, -} from "../../../src/agents/model-catalog.js"; -import { resolveDefaultModelForAgent } from "../../../src/agents/model-selection.js"; -import { resolveChunkMode } from "../../../src/auto-reply/chunk.js"; -import { clearHistoryEntriesIfEnabled } from "../../../src/auto-reply/reply/history.js"; -import { dispatchReplyWithBufferedBlockDispatcher } from "../../../src/auto-reply/reply/provider-dispatcher.js"; -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; -import { removeAckReactionAfterReply } from "../../../src/channels/ack-reactions.js"; -import { logAckFailure, logTypingFailure } from "../../../src/channels/logging.js"; -import { createReplyPrefixOptions } from "../../../src/channels/reply-prefix.js"; -import { createTypingCallbacks } from "../../../src/channels/typing.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { resolveDefaultModelForAgent } from "openclaw/plugin-sdk/agent-runtime"; +import { removeAckReactionAfterReply } from "openclaw/plugin-sdk/channel-runtime"; +import { logAckFailure, logTypingFailure } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { createTypingCallbacks } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; import { loadSessionStore, resolveSessionStoreEntry, resolveStorePath, -} from "../../../src/config/sessions.js"; +} from "openclaw/plugin-sdk/config-runtime"; import type { OpenClawConfig, ReplyToMode, TelegramAccountConfig, -} from "../../../src/config/types.js"; -import { danger, logVerbose } from "../../../src/globals.js"; -import { getAgentScopedMediaLocalRoots } from "../../../src/media/local-roots.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import { clearHistoryEntriesIfEnabled } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchReplyWithBufferedBlockDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { TelegramMessageContext } from "./bot-message-context.js"; import type { TelegramBotOptions } from "./bot.js"; import { deliverReplies } from "./bot/delivery.js"; diff --git a/extensions/telegram/src/bot-message.ts b/extensions/telegram/src/bot-message.ts index 0a5d44c65db..cb625c7b965 100644 --- a/extensions/telegram/src/bot-message.ts +++ b/extensions/telegram/src/bot-message.ts @@ -1,7 +1,7 @@ -import type { ReplyToMode } from "../../../src/config/config.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.telegram.js"; -import { danger } from "../../../src/globals.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramAccountConfig } from "openclaw/plugin-sdk/config-runtime"; +import { danger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { buildTelegramMessageContext, type BuildTelegramMessageContextParams, diff --git a/extensions/telegram/src/bot-native-command-menu.ts b/extensions/telegram/src/bot-native-command-menu.ts index 73fa2d2345a..091a6e52c1b 100644 --- a/extensions/telegram/src/bot-native-command-menu.ts +++ b/extensions/telegram/src/bot-native-command-menu.ts @@ -3,13 +3,13 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import type { Bot } from "grammy"; -import { resolveStateDir } from "../../../src/config/paths.js"; import { normalizeTelegramCommandName, TELEGRAM_COMMAND_NAME_PATTERN, -} from "../../../src/config/telegram-custom-commands.js"; -import { logVerbose } from "../../../src/globals.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; import { withTelegramApiErrorLogging } from "./api-logging.js"; export const TELEGRAM_MAX_COMMANDS = 100; diff --git a/extensions/telegram/src/bot-native-commands.test-helpers.ts b/extensions/telegram/src/bot-native-commands.test-helpers.ts index 33c3f04f904..a39bdd23da6 100644 --- a/extensions/telegram/src/bot-native-commands.test-helpers.ts +++ b/extensions/telegram/src/bot-native-commands.test-helpers.ts @@ -1,24 +1,24 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { ChannelGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramAccountConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { ChannelGroupPolicy } from "../../../src/config/group-policy.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; type RegisterTelegramNativeCommandsParams = Parameters[0]; type GetPluginCommandSpecsFn = - typeof import("../../../src/plugins/commands.js").getPluginCommandSpecs; -type MatchPluginCommandFn = typeof import("../../../src/plugins/commands.js").matchPluginCommand; + typeof import("openclaw/plugin-sdk/plugin-runtime").getPluginCommandSpecs; +type MatchPluginCommandFn = typeof import("openclaw/plugin-sdk/plugin-runtime").matchPluginCommand; type ExecutePluginCommandFn = - typeof import("../../../src/plugins/commands.js").executePluginCommand; + typeof import("openclaw/plugin-sdk/plugin-runtime").executePluginCommand; type DispatchReplyWithBufferedBlockDispatcherFn = - typeof import("../../../src/auto-reply/reply/provider-dispatcher.js").dispatchReplyWithBufferedBlockDispatcher; + typeof import("openclaw/plugin-sdk/reply-runtime").dispatchReplyWithBufferedBlockDispatcher; type DispatchReplyWithBufferedBlockDispatcherResult = Awaited< ReturnType >; type RecordInboundSessionMetaSafeFn = - typeof import("../../../src/channels/session-meta.js").recordInboundSessionMetaSafe; + typeof import("openclaw/plugin-sdk/channel-runtime").recordInboundSessionMetaSafe; type AnyMock = MockFn<(...args: unknown[]) => unknown>; type AnyAsyncMock = MockFn<(...args: unknown[]) => Promise>; type NativeCommandHarness = { @@ -44,7 +44,7 @@ export const getPluginCommandSpecs = pluginCommandMocks.getPluginCommandSpecs; export const matchPluginCommand = pluginCommandMocks.matchPluginCommand; export const executePluginCommand = pluginCommandMocks.executePluginCommand; -vi.mock("../../../src/plugins/commands.js", () => ({ +vi.mock("openclaw/plugin-sdk/plugin-runtime", () => ({ getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, matchPluginCommand: pluginCommandMocks.matchPluginCommand, executePluginCommand: pluginCommandMocks.executePluginCommand, @@ -67,17 +67,17 @@ const replyPipelineMocks = vi.hoisted(() => { export const dispatchReplyWithBufferedBlockDispatcher = replyPipelineMocks.dispatchReplyWithBufferedBlockDispatcher; -vi.mock("../../../src/auto-reply/reply/inbound-context.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ finalizeInboundContext: replyPipelineMocks.finalizeInboundContext, })); -vi.mock("../../../src/auto-reply/reply/provider-dispatcher.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ dispatchReplyWithBufferedBlockDispatcher: replyPipelineMocks.dispatchReplyWithBufferedBlockDispatcher, })); -vi.mock("../../../src/channels/reply-prefix.js", () => ({ +vi.mock("openclaw/plugin-sdk/channel-runtime", () => ({ createReplyPrefixOptions: replyPipelineMocks.createReplyPrefixOptions, })); -vi.mock("../../../src/channels/session-meta.js", () => ({ +vi.mock("openclaw/plugin-sdk/channel-runtime", () => ({ recordInboundSessionMetaSafe: replyPipelineMocks.recordInboundSessionMetaSafe, })); @@ -86,7 +86,7 @@ const deliveryMocks = vi.hoisted(() => ({ })); export const deliverReplies = deliveryMocks.deliverReplies; vi.mock("./bot/delivery.js", () => ({ deliverReplies: deliveryMocks.deliverReplies })); -vi.mock("../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: vi.fn(async () => []), })); diff --git a/extensions/telegram/src/bot-native-commands.ts b/extensions/telegram/src/bot-native-commands.ts index 64874d1f8eb..9cc757cec91 100644 --- a/extensions/telegram/src/bot-native-commands.ts +++ b/extensions/telegram/src/bot-native-commands.ts @@ -1,8 +1,33 @@ import type { Bot, Context } from "grammy"; -import { ensureConfiguredAcpRouteReady } from "../../../src/acp/persistent-bindings.route.js"; -import { resolveChunkMode } from "../../../src/auto-reply/chunk.js"; -import { resolveCommandAuthorization } from "../../../src/auto-reply/command-auth.js"; -import type { CommandArgs } from "../../../src/auto-reply/commands-registry.js"; +import { resolveCommandAuthorizedFromAuthorizers } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveNativeCommandSessionTargets } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { recordInboundSessionMetaSafe } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { ChannelGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { + normalizeTelegramCommandName, + resolveTelegramCustomCommands, + TELEGRAM_COMMAND_NAME_PATTERN, +} from "openclaw/plugin-sdk/config-runtime"; +import type { + ReplyToMode, + TelegramAccountConfig, + TelegramDirectConfig, + TelegramGroupConfig, + TelegramTopicConfig, +} from "openclaw/plugin-sdk/config-runtime"; +import { ensureConfiguredAcpRouteReady } from "openclaw/plugin-sdk/conversation-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { + executePluginCommand, + getPluginCommandSpecs, + matchPluginCommand, +} from "openclaw/plugin-sdk/plugin-runtime"; +import { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveCommandAuthorization } from "openclaw/plugin-sdk/reply-runtime"; +import type { CommandArgs } from "openclaw/plugin-sdk/reply-runtime"; import { buildCommandTextFromArgs, findCommandByNativeName, @@ -10,40 +35,15 @@ import { listNativeCommandSpecsForConfig, parseCommandArgs, resolveCommandArgMenu, -} from "../../../src/auto-reply/commands-registry.js"; -import { finalizeInboundContext } from "../../../src/auto-reply/reply/inbound-context.js"; -import { dispatchReplyWithBufferedBlockDispatcher } from "../../../src/auto-reply/reply/provider-dispatcher.js"; -import { listSkillCommandsForAgents } from "../../../src/auto-reply/skill-commands.js"; -import { resolveCommandAuthorizedFromAuthorizers } from "../../../src/channels/command-gating.js"; -import { resolveNativeCommandSessionTargets } from "../../../src/channels/native-command-session-targets.js"; -import { createReplyPrefixOptions } from "../../../src/channels/reply-prefix.js"; -import { recordInboundSessionMetaSafe } from "../../../src/channels/session-meta.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { ChannelGroupPolicy } from "../../../src/config/group-policy.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { - normalizeTelegramCommandName, - resolveTelegramCustomCommands, - TELEGRAM_COMMAND_NAME_PATTERN, -} from "../../../src/config/telegram-custom-commands.js"; -import type { - ReplyToMode, - TelegramAccountConfig, - TelegramDirectConfig, - TelegramGroupConfig, - TelegramTopicConfig, -} from "../../../src/config/types.js"; -import { danger, logVerbose } from "../../../src/globals.js"; -import { getChildLogger } from "../../../src/logging.js"; -import { getAgentScopedMediaLocalRoots } from "../../../src/media/local-roots.js"; -import { - executePluginCommand, - getPluginCommandSpecs, - matchPluginCommand, -} from "../../../src/plugins/commands.js"; -import { resolveAgentRoute } from "../../../src/routing/resolve-route.js"; -import { resolveThreadSessionKeys } from "../../../src/routing/session-key.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchReplyWithBufferedBlockDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import { listSkillCommandsForAgents } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { danger, logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { isSenderAllowed, normalizeDmAllowFromWithStore } from "./bot-access.js"; import type { TelegramMediaRef } from "./bot-message-context.js"; diff --git a/extensions/telegram/src/bot-updates.ts b/extensions/telegram/src/bot-updates.ts index 3121f1a487e..4b08c747f8f 100644 --- a/extensions/telegram/src/bot-updates.ts +++ b/extensions/telegram/src/bot-updates.ts @@ -1,5 +1,5 @@ import type { Message } from "@grammyjs/types"; -import { createDedupeCache } from "../../../src/infra/dedupe.js"; +import { createDedupeCache } from "openclaw/plugin-sdk/infra-runtime"; import type { TelegramContext } from "./bot/types.js"; const MEDIA_GROUP_TIMEOUT_MS = 500; diff --git a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts index 2f151066910..69c0557ee3a 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts @@ -1,9 +1,9 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import type { GetReplyOptions, ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { beforeEach, vi } from "vitest"; -import { resetInboundDedupe } from "../../../src/auto-reply/reply/inbound-dedupe.js"; -import type { MsgContext } from "../../../src/auto-reply/templating.js"; -import type { GetReplyOptions, ReplyPayload } from "../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; type AnyMock = MockFn<(...args: unknown[]) => unknown>; type AnyAsyncMock = MockFn<(...args: unknown[]) => Promise>; @@ -31,16 +31,16 @@ const { loadConfig } = vi.hoisted((): { loadConfig: AnyMock } => ({ export function getLoadConfigMock(): AnyMock { return loadConfig; } -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig, }; }); -vi.mock("../../../src/config/sessions.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, resolveStorePath: vi.fn((storePath) => storePath ?? sessionStorePath), @@ -68,7 +68,7 @@ export function getUpsertChannelPairingRequestMock(): AnyAsyncMock { return upsertChannelPairingRequest; } -vi.mock("../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore, upsertChannelPairingRequest, })); @@ -78,7 +78,7 @@ const skillCommandsHoisted = vi.hoisted(() => ({ })); export const listSkillCommandsForAgents = skillCommandsHoisted.listSkillCommandsForAgents; -vi.mock("../../../src/auto-reply/skill-commands.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ listSkillCommandsForAgents, })); @@ -87,7 +87,7 @@ const systemEventsHoisted = vi.hoisted(() => ({ })); export const enqueueSystemEventSpy: AnyMock = systemEventsHoisted.enqueueSystemEventSpy; -vi.mock("../../../src/infra/system-events.js", () => ({ +vi.mock("openclaw/plugin-sdk/infra-runtime", () => ({ enqueueSystemEvent: enqueueSystemEventSpy, })); @@ -209,7 +209,7 @@ export const replySpy: MockFn< return undefined; }); -vi.mock("../../../src/auto-reply/reply.js", () => ({ +vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ getReplyFromConfig: replySpy, __replySpy: replySpy, })); diff --git a/extensions/telegram/src/bot.media.e2e-harness.ts b/extensions/telegram/src/bot.media.e2e-harness.ts index a91362702dd..54ae862ce87 100644 --- a/extensions/telegram/src/bot.media.e2e-harness.ts +++ b/extensions/telegram/src/bot.media.e2e-harness.ts @@ -1,5 +1,5 @@ +import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; import { beforeEach, vi, type Mock } from "vitest"; -import { resetInboundDedupe } from "../../../src/auto-reply/reply/inbound-dedupe.js"; export const useSpy: Mock = vi.fn(); export const middlewareUseSpy: Mock = vi.fn(); @@ -92,8 +92,8 @@ vi.mock("undici", async (importOriginal) => { }; }); -vi.mock("../../../src/media/store.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/media-runtime", async (importOriginal) => { + const actual = await importOriginal(); const mockModule = Object.create(null) as Record; Object.defineProperties(mockModule, Object.getOwnPropertyDescriptors(actual)); Object.defineProperty(mockModule, "saveMediaBuffer", { @@ -105,8 +105,8 @@ vi.mock("../../../src/media/store.js", async (importOriginal) => { return mockModule; }); -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => ({ @@ -115,15 +115,15 @@ vi.mock("../../../src/config/config.js", async (importOriginal) => { }; }); -vi.mock("../../../src/config/sessions.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, updateLastRoute: vi.fn(async () => undefined), }; }); -vi.mock("../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: vi.fn(async () => [] as string[]), upsertChannelPairingRequest: vi.fn(async () => ({ code: "PAIRCODE", @@ -131,7 +131,7 @@ vi.mock("../../../src/pairing/pairing-store.js", () => ({ })), })); -vi.mock("../../../src/auto-reply/reply.js", () => { +vi.mock("openclaw/plugin-sdk/reply-runtime", () => { const replySpy = vi.fn(async (_ctx, opts) => { await opts?.onReplyStart?.(); return undefined; diff --git a/extensions/telegram/src/bot.media.test-utils.ts b/extensions/telegram/src/bot.media.test-utils.ts index fde76f34e23..3fee9271e3e 100644 --- a/extensions/telegram/src/bot.media.test-utils.ts +++ b/extensions/telegram/src/bot.media.test-utils.ts @@ -1,5 +1,5 @@ +import * as ssrf from "openclaw/plugin-sdk/infra-runtime"; import { afterEach, beforeAll, beforeEach, expect, vi, type Mock } from "vitest"; -import * as ssrf from "../../../src/infra/net/ssrf.js"; import { onSpy, sendChatActionSpy } from "./bot.media.e2e-harness.js"; type StickerSpy = Mock<(...args: unknown[]) => unknown>; @@ -103,7 +103,7 @@ afterEach(() => { beforeAll(async () => { ({ createTelegramBot: createTelegramBotRef } = await import("./bot.js")); - const replyModule = await import("../../../src/auto-reply/reply.js"); + const replyModule = await import("openclaw/plugin-sdk/reply-runtime"); replySpyRef = (replyModule as unknown as { __replySpy: ReturnType }).__replySpy; }, TELEGRAM_BOT_IMPORT_TIMEOUT_MS); diff --git a/extensions/telegram/src/bot.ts b/extensions/telegram/src/bot.ts index a817e10cbac..6d1d7bc24b2 100644 --- a/extensions/telegram/src/bot.ts +++ b/extensions/telegram/src/bot.ts @@ -2,34 +2,31 @@ import { sequentialize } from "@grammyjs/runner"; import { apiThrottler } from "@grammyjs/transformer-throttler"; import type { ApiClientOptions } from "grammy"; import { Bot } from "grammy"; -import { resolveDefaultAgentId } from "../../../src/agents/agent-scope.js"; -import { resolveTextChunkLimit } from "../../../src/auto-reply/chunk.js"; -import { - DEFAULT_GROUP_HISTORY_LIMIT, - type HistoryEntry, -} from "../../../src/auto-reply/reply/history.js"; +import { resolveDefaultAgentId } from "openclaw/plugin-sdk/agent-runtime"; import { resolveThreadBindingIdleTimeoutMsForChannel, resolveThreadBindingMaxAgeMsForChannel, resolveThreadBindingSpawnPolicy, -} from "../../../src/channels/thread-bindings-policy.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import { isNativeCommandsExplicitlyDisabled, resolveNativeCommandsEnabled, resolveNativeSkillsEnabled, -} from "../../../src/config/commands.js"; -import type { OpenClawConfig, ReplyToMode } from "../../../src/config/config.js"; -import { loadConfig } from "../../../src/config/config.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import type { OpenClawConfig, ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveChannelGroupPolicy, resolveChannelGroupRequireMention, -} from "../../../src/config/group-policy.js"; -import { loadSessionStore, resolveStorePath } from "../../../src/config/sessions.js"; -import { danger, logVerbose, shouldLogVerbose } from "../../../src/globals.js"; -import { formatUncaughtError } from "../../../src/infra/errors.js"; -import { getChildLogger } from "../../../src/logging.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; -import { createNonExitingRuntime, type RuntimeEnv } from "../../../src/runtime.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { loadSessionStore, resolveStorePath } from "openclaw/plugin-sdk/config-runtime"; +import { formatUncaughtError } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { DEFAULT_GROUP_HISTORY_LIMIT, type HistoryEntry } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { createNonExitingRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { resolveTelegramAccount } from "./accounts.js"; import { registerTelegramHandlers } from "./bot-handlers.js"; import { createTelegramMessageProcessor } from "./bot-message.js"; diff --git a/extensions/telegram/src/bot/delivery.replies.ts b/extensions/telegram/src/bot/delivery.replies.ts index 2dfc1c8e956..d0a2d0fd610 100644 --- a/extensions/telegram/src/bot/delivery.replies.ts +++ b/extensions/telegram/src/bot/delivery.replies.ts @@ -1,25 +1,22 @@ import { type Bot, GrammyError, InputFile } from "grammy"; -import { chunkMarkdownTextWithMode, type ChunkMode } from "../../../../src/auto-reply/chunk.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import type { ReplyToMode } from "../../../../src/config/config.js"; -import type { MarkdownTableMode } from "../../../../src/config/types.base.js"; -import { danger, logVerbose } from "../../../../src/globals.js"; -import { fireAndForgetHook } from "../../../../src/hooks/fire-and-forget.js"; -import { - createInternalHookEvent, - triggerInternalHook, -} from "../../../../src/hooks/internal-hooks.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { fireAndForgetHook } from "openclaw/plugin-sdk/hook-runtime"; +import { createInternalHookEvent, triggerInternalHook } from "openclaw/plugin-sdk/hook-runtime"; import { buildCanonicalSentMessageHookContext, toInternalMessageSentContext, toPluginMessageContext, toPluginMessageSentEvent, -} from "../../../../src/hooks/message-hook-mappers.js"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import { buildOutboundMediaLoadOptions } from "../../../../src/media/load-options.js"; -import { isGifMedia, kindFromMime } from "../../../../src/media/mime.js"; -import { getGlobalHookRunner } from "../../../../src/plugins/hook-runner-global.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +} from "openclaw/plugin-sdk/hook-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { buildOutboundMediaLoadOptions } from "openclaw/plugin-sdk/media-runtime"; +import { isGifMedia, kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { getGlobalHookRunner } from "openclaw/plugin-sdk/plugin-runtime"; +import { chunkMarkdownTextWithMode, type ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { danger, logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { loadWebMedia } from "../../../whatsapp/src/media.js"; import type { TelegramInlineButtons } from "../button-types.js"; import { splitTelegramCaption } from "../caption.js"; diff --git a/extensions/telegram/src/bot/delivery.resolve-media.ts b/extensions/telegram/src/bot/delivery.resolve-media.ts index e42dd11aa1b..36b3bb50be9 100644 --- a/extensions/telegram/src/bot/delivery.resolve-media.ts +++ b/extensions/telegram/src/bot/delivery.resolve-media.ts @@ -1,9 +1,9 @@ import { GrammyError } from "grammy"; -import { logVerbose, warn } from "../../../../src/globals.js"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import { retryAsync } from "../../../../src/infra/retry.js"; -import { fetchRemoteMedia } from "../../../../src/media/fetch.js"; -import { saveMediaBuffer } from "../../../../src/media/store.js"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { retryAsync } from "openclaw/plugin-sdk/infra-runtime"; +import { fetchRemoteMedia } from "openclaw/plugin-sdk/media-runtime"; +import { saveMediaBuffer } from "openclaw/plugin-sdk/media-runtime"; +import { logVerbose, warn } from "openclaw/plugin-sdk/runtime-env"; import { shouldRetryTelegramIpv4Fallback, type TelegramTransport } from "../fetch.js"; import { cacheSticker, getCachedSticker } from "../sticker-cache.js"; import { resolveTelegramMediaPlaceholder } from "./helpers.js"; diff --git a/extensions/telegram/src/bot/delivery.send.ts b/extensions/telegram/src/bot/delivery.send.ts index d8768899c28..9c0c6a77e10 100644 --- a/extensions/telegram/src/bot/delivery.send.ts +++ b/extensions/telegram/src/bot/delivery.send.ts @@ -1,6 +1,6 @@ import { type Bot, GrammyError } from "grammy"; -import { formatErrorMessage } from "../../../../src/infra/errors.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "../api-logging.js"; import { markdownToTelegramHtml } from "../format.js"; import { buildInlineKeyboard } from "../send.js"; diff --git a/extensions/telegram/src/bot/helpers.ts b/extensions/telegram/src/bot/helpers.ts index 3575da81efb..921cdf74e86 100644 --- a/extensions/telegram/src/bot/helpers.ts +++ b/extensions/telegram/src/bot/helpers.ts @@ -1,13 +1,13 @@ import type { Chat, Message, MessageOrigin, User } from "@grammyjs/types"; -import { formatLocationText, type NormalizedLocation } from "../../../../src/channels/location.js"; -import { resolveTelegramPreviewStreamMode } from "../../../../src/config/discord-preview-streaming.js"; +import { formatLocationText, type NormalizedLocation } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveTelegramPreviewStreamMode } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../../src/config/types.js"; -import { readChannelAllowFromStore } from "../../../../src/pairing/pairing-store.js"; -import { normalizeAccountId } from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { readChannelAllowFromStore } from "openclaw/plugin-sdk/conversation-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { firstDefined, normalizeAllowFrom, type NormalizedAllowFrom } from "../bot-access.js"; import type { TelegramStreamMode } from "./types.js"; diff --git a/extensions/telegram/src/bot/reply-threading.ts b/extensions/telegram/src/bot/reply-threading.ts index cdeeba7151b..11f4f099688 100644 --- a/extensions/telegram/src/bot/reply-threading.ts +++ b/extensions/telegram/src/bot/reply-threading.ts @@ -1,4 +1,4 @@ -import type { ReplyToMode } from "../../../../src/config/config.js"; +import type { ReplyToMode } from "openclaw/plugin-sdk/config-runtime"; export type DeliveryProgress = { hasReplied: boolean; diff --git a/extensions/telegram/src/button-types.ts b/extensions/telegram/src/button-types.ts index a6eae71995b..15c307ca8c0 100644 --- a/extensions/telegram/src/button-types.ts +++ b/extensions/telegram/src/button-types.ts @@ -1,9 +1,9 @@ -import { reduceInteractiveReply } from "../../../src/channels/plugins/outbound/interactive.js"; +import { reduceInteractiveReply } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeInteractiveReply, type InteractiveReply, type InteractiveReplyButton, -} from "../../../src/interactive/payload.js"; +} from "openclaw/plugin-sdk/channel-runtime"; export type TelegramButtonStyle = "danger" | "success" | "primary"; diff --git a/extensions/telegram/src/channel-actions.ts b/extensions/telegram/src/channel-actions.ts index c9ae46ca823..50c472ea600 100644 --- a/extensions/telegram/src/channel-actions.ts +++ b/extensions/telegram/src/channel-actions.ts @@ -3,20 +3,21 @@ import { readStringArrayParam, readStringOrNumberParam, readStringParam, -} from "../../../src/agents/tools/common.js"; -import { handleTelegramAction } from "../../../src/agents/tools/telegram-actions.js"; -import { resolveReactionMessageId } from "../../../src/channels/plugins/actions/reaction-message-id.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { handleTelegramAction } from "openclaw/plugin-sdk/agent-runtime"; +import { readBooleanParam } from "openclaw/plugin-sdk/boolean-param"; +import { resolveReactionMessageId } from "openclaw/plugin-sdk/channel-runtime"; import { createUnionActionGate, listTokenSourcedAccounts, -} from "../../../src/channels/plugins/actions/shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelMessageActionAdapter, ChannelMessageActionName, -} from "../../../src/channels/plugins/types.js"; -import type { TelegramActionConfig } from "../../../src/config/types.telegram.js"; -import { extractToolSend, readBooleanParam } from "../../../src/plugin-sdk-internal/telegram.js"; -import { resolveTelegramPollVisibility } from "../../../src/poll-params.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { TelegramActionConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveTelegramPollVisibility } from "openclaw/plugin-sdk/telegram"; +import { extractToolSend } from "openclaw/plugin-sdk/tool-send"; import { createTelegramActionGate, listEnabledTelegramAccounts, diff --git a/extensions/telegram/src/channel.setup.ts b/extensions/telegram/src/channel.setup.ts index 0ed71ae568c..1da52dbe885 100644 --- a/extensions/telegram/src/channel.setup.ts +++ b/extensions/telegram/src/channel.setup.ts @@ -1,12 +1,69 @@ -import { type ChannelPlugin } from "openclaw/plugin-sdk/telegram"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + TelegramConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/telegram"; import { type ResolvedTelegramAccount } from "./accounts.js"; +import { + findTelegramTokenOwnerAccountId, + formatDuplicateTelegramTokenReason, + telegramConfigAccessors, + telegramConfigBase, +} from "./plugin-shared.js"; import type { TelegramProbe } from "./probe.js"; import { telegramSetupAdapter } from "./setup-core.js"; import { telegramSetupWizard } from "./setup-surface.js"; -import { createTelegramPluginBase } from "./shared.js"; -export const telegramSetupPlugin: ChannelPlugin = - createTelegramPluginBase({ - setupWizard: telegramSetupWizard, - setup: telegramSetupAdapter, - }); +export const telegramSetupPlugin: ChannelPlugin = { + id: "telegram", + meta: { + ...getChatChannelMeta("telegram"), + quickstartAllowFrom: true, + }, + setupWizard: telegramSetupWizard, + capabilities: { + chatTypes: ["direct", "group", "channel", "thread"], + reactions: true, + threads: true, + media: true, + polls: true, + nativeCommands: true, + blockStreaming: true, + }, + reload: { configPrefixes: ["channels.telegram"] }, + configSchema: buildChannelConfigSchema(TelegramConfigSchema), + config: { + ...telegramConfigBase, + isConfigured: (account, cfg) => { + if (!account.token?.trim()) { + return false; + } + return !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); + }, + unconfiguredReason: (account, cfg) => { + if (!account.token?.trim()) { + return "not configured"; + } + const ownerAccountId = findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); + if (!ownerAccountId) { + return "not configured"; + } + return formatDuplicateTelegramTokenReason({ + accountId: account.accountId, + ownerAccountId, + }); + }, + describeAccount: (account, cfg) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: + Boolean(account.token?.trim()) && + !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }), + tokenSource: account.tokenSource, + }), + ...telegramConfigAccessors, + }, + setup: telegramSetupAdapter, +}; diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index 797b60c85d8..e157ea34ba7 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -1,18 +1,25 @@ +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; import { - buildAccountScopedAllowlistConfigEditor, collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, createScopedDmSecurityResolver, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { type OutboundSendDeps, resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, resolveThreadSessionKeys, type RoutePeer, } from "openclaw/plugin-sdk/core"; +import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; +import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; +import { parseTelegramTopicConversation } from "openclaw/plugin-sdk/telegram"; import { + buildChannelConfigSchema, buildTokenChannelStatusSummary, clearAccountEntryFields, DEFAULT_ACCOUNT_ID, + getChatChannelMeta, listTelegramDirectoryGroupsFromConfig, listTelegramDirectoryPeersFromConfig, PAIRING_APPROVED_MESSAGE, @@ -20,23 +27,13 @@ import { resolveConfiguredFromCredentialStatuses, resolveTelegramGroupRequireMention, resolveTelegramGroupToolPolicy, - type ChannelMessageActionAdapter, + TelegramConfigSchema, type ChannelPlugin, + type ChannelMessageActionAdapter, type OpenClawConfig, } from "openclaw/plugin-sdk/telegram"; -import { parseTelegramTopicConversation } from "../../../src/acp/conversation-id.js"; -import { resolveExecApprovalCommandDisplay } from "../../../src/infra/exec-approval-command-display.js"; -import { buildExecApprovalPendingReplyPayload } from "../../../src/infra/exec-approval-reply.js"; -import { - type OutboundSendDeps, - resolveOutboundSendDep, -} from "../../../src/infra/outbound/send-deps.js"; -import { normalizeOutboundThreadId } from "../../../src/infra/outbound/thread-id.js"; -import { normalizeMessageChannel } from "../../../src/utils/message-channel.js"; -import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, - resolveDefaultTelegramAccountId, resolveTelegramAccount, type ResolvedTelegramAccount, } from "./accounts.js"; @@ -51,17 +48,17 @@ import { monitorTelegramProvider } from "./monitor.js"; import { looksLikeTelegramTargetId, normalizeTelegramMessagingTarget } from "./normalize.js"; import { sendTelegramPayloadMessages } from "./outbound-adapter.js"; import { parseTelegramReplyToMessageId, parseTelegramThreadId } from "./outbound-params.js"; +import { + findTelegramTokenOwnerAccountId, + formatDuplicateTelegramTokenReason, + telegramConfigAccessors, + telegramConfigBase, +} from "./plugin-shared.js"; import { probeTelegram, type TelegramProbe } from "./probe.js"; import { getTelegramRuntime } from "./runtime.js"; import { sendTypingTelegram } from "./send.js"; import { telegramSetupAdapter } from "./setup-core.js"; import { telegramSetupWizard } from "./setup-surface.js"; -import { - createTelegramPluginBase, - findTelegramTokenOwnerAccountId, - formatDuplicateTelegramTokenReason, - telegramConfigAccessors, -} from "./shared.js"; import { collectTelegramStatusIssues } from "./status-issues.js"; import { parseTelegramTarget } from "./targets.js"; @@ -69,6 +66,8 @@ type TelegramSendFn = ReturnType< typeof getTelegramRuntime >["channel"]["telegram"]["sendMessageTelegram"]; +const meta = getChatChannelMeta("telegram"); + type TelegramSendOptions = NonNullable[2]>; function buildTelegramSendOptions(params: { @@ -186,6 +185,20 @@ function parseTelegramExplicitTarget(raw: string) { }; } +function normalizeOutboundThreadId(value?: string | number | null): string | undefined { + if (value == null) { + return undefined; + } + if (typeof value === "number") { + if (!Number.isFinite(value)) { + return undefined; + } + return String(Math.trunc(value)); + } + const trimmed = value.trim(); + return trimmed ? trimmed : undefined; +} + function buildTelegramBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; @@ -311,10 +324,12 @@ function readTelegramAllowlistConfig(account: ResolvedTelegramAccount) { } export const telegramPlugin: ChannelPlugin = { - ...createTelegramPluginBase({ - setupWizard: telegramSetupWizard, - setup: telegramSetupAdapter, - }), + id: "telegram", + meta: { + ...meta, + quickstartAllowFrom: true, + }, + setupWizard: telegramSetupWizard, pairing: { idLabel: "telegramUserId", normalizeAllowEntry: (entry) => entry.replace(/^(telegram|tg):/i, ""), @@ -332,6 +347,49 @@ export const telegramPlugin: ChannelPlugin { + if (!account.token?.trim()) { + return false; + } + return !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); + }, + unconfiguredReason: (account, cfg) => { + if (!account.token?.trim()) { + return "not configured"; + } + const ownerAccountId = findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); + if (!ownerAccountId) { + return "not configured"; + } + return formatDuplicateTelegramTokenReason({ + accountId: account.accountId, + ownerAccountId, + }); + }, + describeAccount: (account, cfg) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: + Boolean(account.token?.trim()) && + !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }), + tokenSource: account.tokenSource, + }), + ...telegramConfigAccessors, + }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => @@ -487,6 +545,7 @@ export const telegramPlugin: ChannelPlugin listTelegramDirectoryGroupsFromConfig(params), }, actions: telegramMessageActions, + setup: telegramSetupAdapter, outbound: { deliveryMode: "direct", chunker: (text, limit) => getTelegramRuntime().channel.text.chunkMarkdownText(text, limit), diff --git a/extensions/telegram/src/conversation-route.ts b/extensions/telegram/src/conversation-route.ts index f12c896d0ca..fc06221936f 100644 --- a/extensions/telegram/src/conversation-route.ts +++ b/extensions/telegram/src/conversation-route.ts @@ -1,18 +1,18 @@ -import { resolveConfiguredAcpRoute } from "../../../src/acp/persistent-bindings.route.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { logVerbose } from "../../../src/globals.js"; -import { getSessionBindingService } from "../../../src/infra/outbound/session-binding-service.js"; -import { isPluginOwnedSessionBindingRecord } from "../../../src/plugins/conversation-binding.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveConfiguredAcpRoute } from "openclaw/plugin-sdk/conversation-runtime"; +import { getSessionBindingService } from "openclaw/plugin-sdk/conversation-runtime"; +import { isPluginOwnedSessionBindingRecord } from "openclaw/plugin-sdk/conversation-runtime"; import { buildAgentSessionKey, deriveLastRoutePolicy, resolveAgentRoute, -} from "../../../src/routing/resolve-route.js"; +} from "openclaw/plugin-sdk/routing"; import { buildAgentMainSessionKey, resolveAgentIdFromSessionKey, sanitizeAgentId, -} from "../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { buildTelegramGroupPeerId, buildTelegramParentPeer, diff --git a/extensions/telegram/src/dm-access.ts b/extensions/telegram/src/dm-access.ts index db8cc419c6a..5bcacf95567 100644 --- a/extensions/telegram/src/dm-access.ts +++ b/extensions/telegram/src/dm-access.ts @@ -1,9 +1,9 @@ import type { Message } from "@grammyjs/types"; import type { Bot } from "grammy"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { logVerbose } from "../../../src/globals.js"; -import { issuePairingChallenge } from "../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../src/pairing/pairing-store.js"; +import type { DmPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { resolveSenderAllowMatch, type NormalizedAllowFrom } from "./bot-access.js"; diff --git a/extensions/telegram/src/draft-chunking.ts b/extensions/telegram/src/draft-chunking.ts index 76edc1b1811..42911f4fd0e 100644 --- a/extensions/telegram/src/draft-chunking.ts +++ b/extensions/telegram/src/draft-chunking.ts @@ -1,7 +1,7 @@ -import { resolveTextChunkLimit } from "../../../src/auto-reply/chunk.js"; -import { type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveAccountEntry } from "../../../src/routing/account-lookup.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import { type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAccountEntry } from "openclaw/plugin-sdk/routing"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; import { TELEGRAM_TEXT_CHUNK_LIMIT } from "./outbound-adapter.js"; const DEFAULT_TELEGRAM_DRAFT_STREAM_MIN = 200; diff --git a/extensions/telegram/src/draft-stream.ts b/extensions/telegram/src/draft-stream.ts index 5641b042d30..baebe687c50 100644 --- a/extensions/telegram/src/draft-stream.ts +++ b/extensions/telegram/src/draft-stream.ts @@ -1,6 +1,6 @@ import type { Bot } from "grammy"; -import { createFinalizableDraftLifecycle } from "../../../src/channels/draft-stream-controls.js"; -import { resolveGlobalSingleton } from "../../../src/shared/global-singleton.js"; +import { createFinalizableDraftLifecycle } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveGlobalSingleton } from "openclaw/plugin-sdk/text-runtime"; import { buildTelegramThreadParams, type TelegramThreadSpec } from "./bot/helpers.js"; import { isSafeToRetrySendError, isTelegramClientRejection } from "./network-errors.js"; diff --git a/extensions/telegram/src/exec-approvals-handler.ts b/extensions/telegram/src/exec-approvals-handler.ts index a9d32d0887d..97cc2228b98 100644 --- a/extensions/telegram/src/exec-approvals-handler.ts +++ b/extensions/telegram/src/exec-approvals-handler.ts @@ -1,21 +1,18 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { GatewayClient } from "../../../src/gateway/client.js"; -import { createOperatorApprovalsGatewayClient } from "../../../src/gateway/operator-approvals-client.js"; -import type { EventFrame } from "../../../src/gateway/protocol/index.js"; -import { resolveExecApprovalCommandDisplay } from "../../../src/infra/exec-approval-command-display.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { GatewayClient } from "openclaw/plugin-sdk/gateway-runtime"; +import { createOperatorApprovalsGatewayClient } from "openclaw/plugin-sdk/gateway-runtime"; +import type { EventFrame } from "openclaw/plugin-sdk/gateway-runtime"; +import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; import { buildExecApprovalPendingReplyPayload, type ExecApprovalPendingReplyParams, -} from "../../../src/infra/exec-approval-reply.js"; -import { resolveExecApprovalSessionTarget } from "../../../src/infra/exec-approval-session-target.js"; -import type { - ExecApprovalRequest, - ExecApprovalResolved, -} from "../../../src/infra/exec-approvals.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; -import { normalizeAccountId, parseAgentSessionKey } from "../../../src/routing/session-key.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; -import { compileSafeRegex, testRegexWithBoundedInput } from "../../../src/security/safe-regex.js"; +} from "openclaw/plugin-sdk/infra-runtime"; +import { resolveExecApprovalSessionTarget } from "openclaw/plugin-sdk/infra-runtime"; +import type { ExecApprovalRequest, ExecApprovalResolved } from "openclaw/plugin-sdk/infra-runtime"; +import { normalizeAccountId, parseAgentSessionKey } from "openclaw/plugin-sdk/routing"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { compileSafeRegex, testRegexWithBoundedInput } from "openclaw/plugin-sdk/security-runtime"; import { buildTelegramExecApprovalButtons } from "./approval-buttons.js"; import { getTelegramExecApprovalApprovers, diff --git a/extensions/telegram/src/exec-approvals.ts b/extensions/telegram/src/exec-approvals.ts index b1b0eed8d4f..10ae8dd35a0 100644 --- a/extensions/telegram/src/exec-approvals.ts +++ b/extensions/telegram/src/exec-approvals.ts @@ -1,7 +1,7 @@ -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramExecApprovalConfig } from "../../../src/config/types.telegram.js"; -import { getExecApprovalReplyMetadata } from "../../../src/infra/exec-approval-reply.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramExecApprovalConfig } from "openclaw/plugin-sdk/config-runtime"; +import { getExecApprovalReplyMetadata } from "openclaw/plugin-sdk/infra-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import { resolveTelegramAccount } from "./accounts.js"; import { resolveTelegramTargetChatType } from "./targets.js"; diff --git a/extensions/telegram/src/fetch.ts b/extensions/telegram/src/fetch.ts index 4b234c8d107..962d0256af1 100644 --- a/extensions/telegram/src/fetch.ts +++ b/extensions/telegram/src/fetch.ts @@ -1,10 +1,10 @@ import * as dns from "node:dns"; +import type { TelegramNetworkConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveFetch } from "openclaw/plugin-sdk/infra-runtime"; +import { hasEnvHttpProxyConfigured } from "openclaw/plugin-sdk/infra-runtime"; +import type { PinnedDispatcherPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; import { Agent, EnvHttpProxyAgent, ProxyAgent, fetch as undiciFetch } from "undici"; -import type { TelegramNetworkConfig } from "../../../src/config/types.telegram.js"; -import { resolveFetch } from "../../../src/infra/fetch.js"; -import { hasEnvHttpProxyConfigured } from "../../../src/infra/net/proxy-env.js"; -import type { PinnedDispatcherPolicy } from "../../../src/infra/net/ssrf.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; import { resolveTelegramAutoSelectFamilyDecision, resolveTelegramDnsResultOrderDecision, diff --git a/extensions/telegram/src/format.ts b/extensions/telegram/src/format.ts index 0c1bec2a62a..a9a10965243 100644 --- a/extensions/telegram/src/format.ts +++ b/extensions/telegram/src/format.ts @@ -1,11 +1,11 @@ -import type { MarkdownTableMode } from "../../../src/config/types.base.js"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; import { chunkMarkdownIR, markdownToIR, type MarkdownLinkSpan, type MarkdownIR, -} from "../../../src/markdown/ir.js"; -import { renderMarkdownWithMarkers } from "../../../src/markdown/render.js"; +} from "openclaw/plugin-sdk/text-runtime"; +import { renderMarkdownWithMarkers } from "openclaw/plugin-sdk/text-runtime"; export type TelegramFormattedChunk = { html: string; diff --git a/extensions/telegram/src/group-access.ts b/extensions/telegram/src/group-access.ts index e42646a7dcd..d4802a9f0cf 100644 --- a/extensions/telegram/src/group-access.ts +++ b/extensions/telegram/src/group-access.ts @@ -1,13 +1,13 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { ChannelGroupPolicy } from "../../../src/config/group-policy.js"; -import { resolveOpenProviderRuntimeGroupPolicy } from "../../../src/config/runtime-group-policy.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { ChannelGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; +import { resolveOpenProviderRuntimeGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramAccountConfig, TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; -import { evaluateMatchedGroupAccessForPolicy } from "../../../src/plugin-sdk-internal/telegram.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { evaluateMatchedGroupAccessForPolicy } from "openclaw/plugin-sdk/group-access"; import { isSenderAllowed, type NormalizedAllowFrom } from "./bot-access.js"; import { firstDefined } from "./bot-access.js"; diff --git a/extensions/telegram/src/group-config-helpers.ts b/extensions/telegram/src/group-config-helpers.ts index 5a60d116dd3..8c0f4652282 100644 --- a/extensions/telegram/src/group-config-helpers.ts +++ b/extensions/telegram/src/group-config-helpers.ts @@ -2,7 +2,7 @@ import type { TelegramDirectConfig, TelegramGroupConfig, TelegramTopicConfig, -} from "../../../src/config/types.js"; +} from "openclaw/plugin-sdk/config-runtime"; import { firstDefined } from "./bot-access.js"; export function resolveTelegramGroupPromptSettings(params: { diff --git a/extensions/telegram/src/group-migration.ts b/extensions/telegram/src/group-migration.ts index 0609fcf4b5a..95b4529e51f 100644 --- a/extensions/telegram/src/group-migration.ts +++ b/extensions/telegram/src/group-migration.ts @@ -1,6 +1,6 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramGroupConfig } from "../../../src/config/types.telegram.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramGroupConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; type TelegramGroups = Record; diff --git a/extensions/telegram/src/inline-buttons.ts b/extensions/telegram/src/inline-buttons.ts index ead8068feba..5341f2d09f1 100644 --- a/extensions/telegram/src/inline-buttons.ts +++ b/extensions/telegram/src/inline-buttons.ts @@ -1,5 +1,5 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramInlineButtonsScope } from "../../../src/config/types.telegram.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { TelegramInlineButtonsScope } from "openclaw/plugin-sdk/config-runtime"; import { listTelegramAccountIds, resolveTelegramAccount } from "./accounts.js"; const DEFAULT_INLINE_BUTTONS_SCOPE: TelegramInlineButtonsScope = "allowlist"; diff --git a/extensions/telegram/src/lane-delivery-text-deliverer.ts b/extensions/telegram/src/lane-delivery-text-deliverer.ts index 08875329649..c99dc52661a 100644 --- a/extensions/telegram/src/lane-delivery-text-deliverer.ts +++ b/extensions/telegram/src/lane-delivery-text-deliverer.ts @@ -1,4 +1,4 @@ -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import type { TelegramInlineButtons } from "./button-types.js"; import type { TelegramDraftStream } from "./draft-stream.js"; import { diff --git a/extensions/telegram/src/monitor.ts b/extensions/telegram/src/monitor.ts index 8620fb01c2b..11530ad66ef 100644 --- a/extensions/telegram/src/monitor.ts +++ b/extensions/telegram/src/monitor.ts @@ -1,11 +1,11 @@ import type { RunOptions } from "@grammyjs/runner"; -import { resolveAgentMaxConcurrent } from "../../../src/config/agent-limits.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { loadConfig } from "../../../src/config/config.js"; -import { waitForAbortSignal } from "../../../src/infra/abort-signal.js"; -import { formatErrorMessage } from "../../../src/infra/errors.js"; -import { registerUnhandledRejectionHandler } from "../../../src/infra/unhandled-rejections.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; +import { resolveAgentMaxConcurrent } from "openclaw/plugin-sdk/config-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { waitForAbortSignal } from "openclaw/plugin-sdk/runtime-env"; +import { registerUnhandledRejectionHandler } from "openclaw/plugin-sdk/runtime-env"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { resolveTelegramAccount } from "./accounts.js"; import { resolveTelegramAllowedUpdates } from "./allowed-updates.js"; import { TelegramExecApprovalHandler } from "./exec-approvals-handler.js"; diff --git a/extensions/telegram/src/network-config.ts b/extensions/telegram/src/network-config.ts index 81156ce67ac..a37a8656203 100644 --- a/extensions/telegram/src/network-config.ts +++ b/extensions/telegram/src/network-config.ts @@ -1,7 +1,7 @@ import process from "node:process"; -import type { TelegramNetworkConfig } from "../../../src/config/types.telegram.js"; -import { isTruthyEnvValue } from "../../../src/infra/env.js"; -import { isWSL2Sync } from "../../../src/infra/wsl.js"; +import type { TelegramNetworkConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isTruthyEnvValue } from "openclaw/plugin-sdk/infra-runtime"; +import { isWSL2Sync } from "openclaw/plugin-sdk/infra-runtime"; export const TELEGRAM_DISABLE_AUTO_SELECT_FAMILY_ENV = "OPENCLAW_TELEGRAM_DISABLE_AUTO_SELECT_FAMILY"; diff --git a/extensions/telegram/src/network-errors.ts b/extensions/telegram/src/network-errors.ts index 59753f9d8c1..1e7c8523767 100644 --- a/extensions/telegram/src/network-errors.ts +++ b/extensions/telegram/src/network-errors.ts @@ -3,7 +3,7 @@ import { extractErrorCode, formatErrorMessage, readErrorName, -} from "../../../src/infra/errors.js"; +} from "openclaw/plugin-sdk/infra-runtime"; const TELEGRAM_NETWORK_ORIGIN = Symbol("openclaw.telegram.network-origin"); diff --git a/extensions/telegram/src/outbound-adapter.ts b/extensions/telegram/src/outbound-adapter.ts index 25bd2329ed7..1b12c5203a1 100644 --- a/extensions/telegram/src/outbound-adapter.ts +++ b/extensions/telegram/src/outbound-adapter.ts @@ -1,14 +1,11 @@ -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; import { resolvePayloadMediaUrls, sendPayloadMediaSequence, -} from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import type { ChannelOutboundAdapter } from "../../../src/channels/plugins/types.js"; -import { - resolveOutboundSendDep, - type OutboundSendDeps, -} from "../../../src/infra/outbound/send-deps.js"; -import { resolveInteractiveTextFallback } from "../../../src/interactive/payload.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep, type OutboundSendDeps } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveInteractiveTextFallback } from "openclaw/plugin-sdk/channel-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import type { TelegramInlineButtons } from "./button-types.js"; import { resolveTelegramInlineButtons } from "./button-types.js"; import { markdownToTelegramHtmlChunks } from "./format.js"; diff --git a/extensions/telegram/src/plugin-shared.ts b/extensions/telegram/src/plugin-shared.ts index 4d33a6ed6f8..12562f0da61 100644 --- a/extensions/telegram/src/plugin-shared.ts +++ b/extensions/telegram/src/plugin-shared.ts @@ -1,12 +1,9 @@ +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, - formatAllowFromLowercase, -} from "../../../src/plugin-sdk-internal/channel-config.js"; -import { - normalizeAccountId, - type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/telegram.js"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { normalizeAccountId, type OpenClawConfig } from "openclaw/plugin-sdk/telegram"; import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, diff --git a/extensions/telegram/src/polling-session.ts b/extensions/telegram/src/polling-session.ts index 5506ce4e434..89342994387 100644 --- a/extensions/telegram/src/polling-session.ts +++ b/extensions/telegram/src/polling-session.ts @@ -1,7 +1,7 @@ import { type RunOptions, run } from "@grammyjs/runner"; -import { computeBackoff, sleepWithAbort } from "../../../src/infra/backoff.js"; -import { formatErrorMessage } from "../../../src/infra/errors.js"; -import { formatDurationPrecise } from "../../../src/infra/format-time/format-duration.ts"; +import { computeBackoff, sleepWithAbort } from "openclaw/plugin-sdk/infra-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { formatDurationPrecise } from "openclaw/plugin-sdk/infra-runtime"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { createTelegramBot } from "./bot.js"; import { isRecoverableTelegramNetworkError } from "./network-errors.js"; diff --git a/extensions/telegram/src/probe.ts b/extensions/telegram/src/probe.ts index cade90c5ad5..660b9c9fb62 100644 --- a/extensions/telegram/src/probe.ts +++ b/extensions/telegram/src/probe.ts @@ -1,6 +1,6 @@ -import type { BaseProbeResult } from "../../../src/channels/plugins/types.js"; -import type { TelegramNetworkConfig } from "../../../src/plugin-sdk-internal/telegram.js"; -import { fetchWithTimeout } from "../../../src/utils/fetch-timeout.js"; +import type { BaseProbeResult } from "openclaw/plugin-sdk/channel-runtime"; +import type { TelegramNetworkConfig } from "openclaw/plugin-sdk/telegram"; +import { fetchWithTimeout } from "openclaw/plugin-sdk/text-runtime"; import { resolveTelegramFetch } from "./fetch.js"; import { makeProxyFetch } from "./proxy.js"; diff --git a/extensions/telegram/src/proxy.ts b/extensions/telegram/src/proxy.ts index d74710c9cbd..1a06877b90f 100644 --- a/extensions/telegram/src/proxy.ts +++ b/extensions/telegram/src/proxy.ts @@ -1 +1 @@ -export { getProxyUrlFromFetch, makeProxyFetch } from "../../../src/infra/net/proxy-fetch.js"; +export { getProxyUrlFromFetch, makeProxyFetch } from "openclaw/plugin-sdk/infra-runtime"; diff --git a/extensions/telegram/src/reaction-level.ts b/extensions/telegram/src/reaction-level.ts index 4597ce0602e..3f33277d19a 100644 --- a/extensions/telegram/src/reaction-level.ts +++ b/extensions/telegram/src/reaction-level.ts @@ -1,9 +1,9 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveReactionLevel, type ReactionLevel, type ResolvedReactionLevel as BaseResolvedReactionLevel, -} from "../../../src/utils/reaction-level.js"; +} from "openclaw/plugin-sdk/text-runtime"; import { resolveTelegramAccount } from "./accounts.js"; export type TelegramReactionLevel = ReactionLevel; diff --git a/extensions/telegram/src/reasoning-lane-coordinator.ts b/extensions/telegram/src/reasoning-lane-coordinator.ts index 4bc0da94dfe..a4e414a6727 100644 --- a/extensions/telegram/src/reasoning-lane-coordinator.ts +++ b/extensions/telegram/src/reasoning-lane-coordinator.ts @@ -1,7 +1,7 @@ -import { formatReasoningMessage } from "../../../src/agents/pi-embedded-utils.js"; -import type { ReplyPayload } from "../../../src/auto-reply/types.js"; -import { findCodeRegions, isInsideCode } from "../../../src/shared/text/code-regions.js"; -import { stripReasoningTagsFromText } from "../../../src/shared/text/reasoning-tags.js"; +import { formatReasoningMessage } from "openclaw/plugin-sdk/agent-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { findCodeRegions, isInsideCode } from "openclaw/plugin-sdk/text-runtime"; +import { stripReasoningTagsFromText } from "openclaw/plugin-sdk/text-runtime"; const REASONING_MESSAGE_PREFIX = "Reasoning:\n"; const REASONING_TAG_PREFIXES = [ diff --git a/extensions/telegram/src/runtime.ts b/extensions/telegram/src/runtime.ts index 768c15e28f5..1cc0c75b5dc 100644 --- a/extensions/telegram/src/runtime.ts +++ b/extensions/telegram/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setTelegramRuntime, getRuntime: getTelegramRuntime } = createPluginRuntimeStore("Telegram runtime not initialized"); diff --git a/extensions/telegram/src/send.test-harness.ts b/extensions/telegram/src/send.test-harness.ts index 604a7d27dd1..c12a571c642 100644 --- a/extensions/telegram/src/send.test-harness.ts +++ b/extensions/telegram/src/send.test-harness.ts @@ -1,5 +1,5 @@ +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { beforeEach, vi } from "vitest"; -import type { MockFn } from "../../../src/test-utils/vitest-mock-fn.js"; const { botApi, botCtorSpy } = vi.hoisted(() => ({ botApi: { @@ -64,8 +64,8 @@ vi.mock("grammy", () => ({ InputFile: class {}, })); -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig, diff --git a/extensions/telegram/src/send.ts b/extensions/telegram/src/send.ts index b215be835e8..0682fda6786 100644 --- a/extensions/telegram/src/send.ts +++ b/extensions/telegram/src/send.ts @@ -5,20 +5,20 @@ import type { ReactionTypeEmoji, } from "@grammyjs/types"; import { type ApiClientOptions, Bot, HttpError, InputFile } from "grammy"; -import { loadConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { logVerbose } from "../../../src/globals.js"; -import { recordChannelActivity } from "../../../src/infra/channel-activity.js"; -import { isDiagnosticFlagEnabled } from "../../../src/infra/diagnostic-flags.js"; -import { formatErrorMessage, formatUncaughtError } from "../../../src/infra/errors.js"; -import { createTelegramRetryRunner } from "../../../src/infra/retry-policy.js"; -import type { RetryConfig } from "../../../src/infra/retry.js"; -import { redactSensitiveText } from "../../../src/logging/redact.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; -import type { MediaKind } from "../../../src/media/constants.js"; -import { buildOutboundMediaLoadOptions } from "../../../src/media/load-options.js"; -import { isGifMedia, kindFromMime } from "../../../src/media/mime.js"; -import { normalizePollInput, type PollInput } from "../../../src/polls.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import { isDiagnosticFlagEnabled } from "openclaw/plugin-sdk/infra-runtime"; +import { formatErrorMessage, formatUncaughtError } from "openclaw/plugin-sdk/infra-runtime"; +import { createTelegramRetryRunner } from "openclaw/plugin-sdk/infra-runtime"; +import type { RetryConfig } from "openclaw/plugin-sdk/infra-runtime"; +import type { MediaKind } from "openclaw/plugin-sdk/media-runtime"; +import { buildOutboundMediaLoadOptions } from "openclaw/plugin-sdk/media-runtime"; +import { isGifMedia, kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { normalizePollInput, type PollInput } from "openclaw/plugin-sdk/media-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { redactSensitiveText } from "openclaw/plugin-sdk/text-runtime"; import { loadWebMedia } from "../../whatsapp/src/media.js"; import { type ResolvedTelegramAccount, resolveTelegramAccount } from "./accounts.js"; import { withTelegramApiErrorLogging } from "./api-logging.js"; diff --git a/extensions/telegram/src/sendchataction-401-backoff.ts b/extensions/telegram/src/sendchataction-401-backoff.ts index 72ac8690403..0c9865eb2b3 100644 --- a/extensions/telegram/src/sendchataction-401-backoff.ts +++ b/extensions/telegram/src/sendchataction-401-backoff.ts @@ -1,4 +1,8 @@ -import { computeBackoff, sleepWithAbort, type BackoffPolicy } from "../../../src/infra/backoff.js"; +import { + computeBackoff, + sleepWithAbort, + type BackoffPolicy, +} from "openclaw/plugin-sdk/infra-runtime"; export type TelegramSendChatActionLogger = (message: string) => void; diff --git a/extensions/telegram/src/sent-message-cache.ts b/extensions/telegram/src/sent-message-cache.ts index 49a6ab4c3d9..bb48bce3c0f 100644 --- a/extensions/telegram/src/sent-message-cache.ts +++ b/extensions/telegram/src/sent-message-cache.ts @@ -1,4 +1,4 @@ -import { resolveGlobalMap } from "../../../src/shared/global-singleton.js"; +import { resolveGlobalMap } from "openclaw/plugin-sdk/text-runtime"; /** * In-memory cache of sent message IDs per chat. diff --git a/extensions/telegram/src/sequential-key.ts b/extensions/telegram/src/sequential-key.ts index 334c18dc485..5309a88a32c 100644 --- a/extensions/telegram/src/sequential-key.ts +++ b/extensions/telegram/src/sequential-key.ts @@ -1,6 +1,6 @@ import { type Message, type UserFromGetMe } from "@grammyjs/types"; -import { isAbortRequestText } from "../../../src/auto-reply/reply/abort.js"; -import { isBtwRequestText } from "../../../src/auto-reply/reply/btw-command.js"; +import { isAbortRequestText } from "openclaw/plugin-sdk/reply-runtime"; +import { isBtwRequestText } from "openclaw/plugin-sdk/reply-runtime"; import { resolveTelegramForumThreadId } from "./bot/helpers.js"; export type TelegramSequentialKeyContext = { diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 33ce824d17d..13fb01f3a51 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,27 +1,18 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; import { + applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, formatCliCommand, + formatDocsLink, + migrateBaseNameToDefaultAccount, + normalizeAccountId, patchChannelConfigForAccount, promptResolvedAllowFrom, - setSetupChannelEnabled, - setChannelDmPolicyWithAllowFrom, splitSetupEntries, type OpenClawConfig, type WizardPrompter, -} from "../../../src/plugin-sdk-internal/setup.js"; -import type { - ChannelSetupAdapter, - ChannelSetupDmPolicy, - ChannelSetupWizard, -} from "../../../src/plugin-sdk-internal/setup.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import { inspectTelegramAccount } from "./account-inspect.js"; -import { - listTelegramAccountIds, - resolveDefaultTelegramAccountId, - resolveTelegramAccount, -} from "./accounts.js"; +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; const channel = "telegram" as const; @@ -118,93 +109,15 @@ export async function promptTelegramAllowFromForAccount(params: { }); } -type TelegramSetupWizardHandlers = { - inspectToken: (params: { cfg: OpenClawConfig; accountId: string }) => { - accountConfigured: boolean; - hasConfiguredValue: boolean; - resolvedValue?: string; - envValue?: string; - }; -}; - -export function createTelegramSetupWizardBase( - handlers: TelegramSetupWizardHandlers, -): ChannelSetupWizard { - const dmPolicy: ChannelSetupDmPolicy = { - label: "Telegram", - channel, - policyKey: "channels.telegram.dmPolicy", - allowFromKey: "channels.telegram.allowFrom", - getCurrent: (cfg) => cfg.channels?.telegram?.dmPolicy ?? "pairing", - setPolicy: (cfg, policy) => - setChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptTelegramAllowFromForAccount, - }; - - return { - channel, - status: { - configuredLabel: "configured", - unconfiguredLabel: "needs token", - configuredHint: "recommended · configured", - unconfiguredHint: "recommended · newcomer-friendly", - configuredScore: 1, - unconfiguredScore: 10, - resolveConfigured: ({ cfg }) => - listTelegramAccountIds(cfg).some((accountId) => { - const account = inspectTelegramAccount({ cfg, accountId }); - return account.configured; - }), - }, - credentials: [ - { - inputKey: "token", - providerHint: channel, - credentialLabel: "Telegram bot token", - preferredEnvVar: "TELEGRAM_BOT_TOKEN", - helpTitle: "Telegram bot token", - helpLines: TELEGRAM_TOKEN_HELP_LINES, - envPrompt: "TELEGRAM_BOT_TOKEN detected. Use env var?", - keepPrompt: "Telegram token already configured. Keep it?", - inputPrompt: "Enter Telegram bot token", - allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }) => handlers.inspectToken({ cfg, accountId }), - }, - ], - allowFrom: { - helpTitle: "Telegram user id", - helpLines: TELEGRAM_USER_ID_HELP_LINES, - credentialInputKey: "token", - message: "Telegram allowFrom (numeric sender id; @username resolves to id)", - placeholder: "@username", - invalidWithoutCredentialNote: - "Telegram token missing; use numeric sender ids (usernames require a bot token).", - parseInputs: splitSetupEntries, - parseId: parseTelegramAllowFromId, - resolveEntries: async ({ credentialValues, entries }) => - resolveTelegramAllowFromEntries({ - credentialValue: credentialValues.token, - entries, - }), - apply: async ({ cfg, accountId, allowFrom }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { dmPolicy: "allowlist", allowFrom }, - }), - }, - dmPolicy, - disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), - } satisfies ChannelSetupWizard; -} - -export const telegramSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, +export const telegramSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + }), validateInput: ({ accountId, input }) => { if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { return "TELEGRAM_BOT_TOKEN can only be used for the default account."; @@ -214,12 +127,60 @@ export const telegramSetupAdapter: ChannelSetupAdapter = createPatchedAccountSet } return null; }, - buildPatch: (input) => - input.useEnv - ? {} - : input.tokenFile - ? { tokenFile: input.tokenFile } - : input.token - ? { botToken: input.token } - : {}, -}); + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + }); + const next = + accountId !== DEFAULT_ACCOUNT_ID + ? migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + }) + : namedConfig; + if (accountId === DEFAULT_ACCOUNT_ID) { + return { + ...next, + channels: { + ...next.channels, + telegram: { + ...next.channels?.telegram, + enabled: true, + ...(input.useEnv + ? {} + : input.tokenFile + ? { tokenFile: input.tokenFile } + : input.token + ? { botToken: input.token } + : {}), + }, + }, + }; + } + return { + ...next, + channels: { + ...next.channels, + telegram: { + ...next.channels?.telegram, + enabled: true, + accounts: { + ...next.channels?.telegram?.accounts, + [accountId]: { + ...next.channels?.telegram?.accounts?.[accountId], + enabled: true, + ...(input.tokenFile + ? { tokenFile: input.tokenFile } + : input.token + ? { botToken: input.token } + : {}), + }, + }, + }, + }, + }; + }, +}; diff --git a/extensions/telegram/src/setup-surface.ts b/extensions/telegram/src/setup-surface.ts index 4417fc1764a..934fa0688e9 100644 --- a/extensions/telegram/src/setup-surface.ts +++ b/extensions/telegram/src/setup-surface.ts @@ -1,30 +1,110 @@ import { DEFAULT_ACCOUNT_ID, hasConfiguredSecretInput, -} from "../../../src/plugin-sdk-internal/setup.js"; -import type { ChannelSetupWizard } from "../../../src/plugin-sdk-internal/setup.js"; -import { resolveTelegramAccount } from "./accounts.js"; + type OpenClawConfig, + patchChannelConfigForAccount, + setChannelDmPolicyWithAllowFrom, + setSetupChannelEnabled, + splitSetupEntries, +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { inspectTelegramAccount } from "./account-inspect.js"; +import { listTelegramAccountIds, resolveTelegramAccount } from "./accounts.js"; import { - createTelegramSetupWizardBase, parseTelegramAllowFromId, + promptTelegramAllowFromForAccount, + resolveTelegramAllowFromEntries, + TELEGRAM_TOKEN_HELP_LINES, + TELEGRAM_USER_ID_HELP_LINES, telegramSetupAdapter, } from "./setup-core.js"; -export const telegramSetupWizard: ChannelSetupWizard = createTelegramSetupWizardBase({ - inspectToken: ({ cfg, accountId }) => { - const resolved = resolveTelegramAccount({ cfg, accountId }); - const hasConfiguredBotToken = hasConfiguredSecretInput(resolved.config.botToken); - const hasConfiguredValue = hasConfiguredBotToken || Boolean(resolved.config.tokenFile?.trim()); - return { - accountConfigured: Boolean(resolved.token) || hasConfiguredValue, - hasConfiguredValue, - resolvedValue: resolved.token?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID - ? process.env.TELEGRAM_BOT_TOKEN?.trim() || undefined - : undefined, - }; +const channel = "telegram" as const; + +const dmPolicy: ChannelSetupDmPolicy = { + label: "Telegram", + channel, + policyKey: "channels.telegram.dmPolicy", + allowFromKey: "channels.telegram.allowFrom", + getCurrent: (cfg) => cfg.channels?.telegram?.dmPolicy ?? "pairing", + setPolicy: (cfg, policy) => + setChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptTelegramAllowFromForAccount, +}; + +export const telegramSetupWizard: ChannelSetupWizard = { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs token", + configuredHint: "recommended · configured", + unconfiguredHint: "recommended · newcomer-friendly", + configuredScore: 1, + unconfiguredScore: 10, + resolveConfigured: ({ cfg }) => + listTelegramAccountIds(cfg).some((accountId) => { + const account = inspectTelegramAccount({ cfg, accountId }); + return account.configured; + }), }, -}); + credentials: [ + { + inputKey: "token", + providerHint: channel, + credentialLabel: "Telegram bot token", + preferredEnvVar: "TELEGRAM_BOT_TOKEN", + helpTitle: "Telegram bot token", + helpLines: TELEGRAM_TOKEN_HELP_LINES, + envPrompt: "TELEGRAM_BOT_TOKEN detected. Use env var?", + keepPrompt: "Telegram token already configured. Keep it?", + inputPrompt: "Enter Telegram bot token", + allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }) => { + const resolved = resolveTelegramAccount({ cfg, accountId }); + const hasConfiguredBotToken = hasConfiguredSecretInput(resolved.config.botToken); + const hasConfiguredValue = + hasConfiguredBotToken || Boolean(resolved.config.tokenFile?.trim()); + return { + accountConfigured: Boolean(resolved.token) || hasConfiguredValue, + hasConfiguredValue, + resolvedValue: resolved.token?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID + ? process.env.TELEGRAM_BOT_TOKEN?.trim() || undefined + : undefined, + }; + }, + }, + ], + allowFrom: { + helpTitle: "Telegram user id", + helpLines: TELEGRAM_USER_ID_HELP_LINES, + credentialInputKey: "token", + message: "Telegram allowFrom (numeric sender id; @username resolves to id)", + placeholder: "@username", + invalidWithoutCredentialNote: + "Telegram token missing; use numeric sender ids (usernames require a bot token).", + parseInputs: splitSetupEntries, + parseId: parseTelegramAllowFromId, + resolveEntries: async ({ credentialValues, entries }) => + resolveTelegramAllowFromEntries({ + credentialValue: credentialValues.token, + entries, + }), + apply: async ({ cfg, accountId, allowFrom }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { dmPolicy: "allowlist", allowFrom }, + }), + }, + dmPolicy, + disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), +}; export { parseTelegramAllowFromId, telegramSetupAdapter }; diff --git a/extensions/telegram/src/status-issues.ts b/extensions/telegram/src/status-issues.ts index b970f533dd0..0178c0c7346 100644 --- a/extensions/telegram/src/status-issues.ts +++ b/extensions/telegram/src/status-issues.ts @@ -3,11 +3,11 @@ import { asString, isRecord, resolveEnabledConfiguredAccountId, -} from "../../../src/channels/plugins/status-issues/shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelAccountSnapshot, ChannelStatusIssue, -} from "../../../src/channels/plugins/types.js"; +} from "openclaw/plugin-sdk/channel-runtime"; type TelegramAccountStatus = { accountId?: unknown; diff --git a/extensions/telegram/src/status-reaction-variants.ts b/extensions/telegram/src/status-reaction-variants.ts index 6c5c80e9fd8..8c04a87554e 100644 --- a/extensions/telegram/src/status-reaction-variants.ts +++ b/extensions/telegram/src/status-reaction-variants.ts @@ -1,7 +1,4 @@ -import { - DEFAULT_EMOJIS, - type StatusReactionEmojis, -} from "../../../src/channels/status-reactions.js"; +import { DEFAULT_EMOJIS, type StatusReactionEmojis } from "openclaw/plugin-sdk/channel-runtime"; type StatusReactionEmojiKey = keyof Required; diff --git a/extensions/telegram/src/sticker-cache.ts b/extensions/telegram/src/sticker-cache.ts index e6cdfbd9015..18bfbbf4421 100644 --- a/extensions/telegram/src/sticker-cache.ts +++ b/extensions/telegram/src/sticker-cache.ts @@ -1,22 +1,19 @@ import fs from "node:fs/promises"; import path from "node:path"; -import { resolveApiKeyForProvider } from "../../../src/agents/model-auth.js"; -import type { ModelCatalogEntry } from "../../../src/agents/model-catalog.js"; +import { resolveApiKeyForProvider } from "openclaw/plugin-sdk/agent-runtime"; +import type { ModelCatalogEntry } from "openclaw/plugin-sdk/agent-runtime"; import { findModelInCatalog, loadModelCatalog, modelSupportsVision, -} from "../../../src/agents/model-catalog.js"; -import { resolveDefaultModelForAgent } from "../../../src/agents/model-selection.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { STATE_DIR } from "../../../src/config/paths.js"; -import { logVerbose } from "../../../src/globals.js"; -import { loadJsonFile, saveJsonFile } from "../../../src/infra/json-file.js"; -import { - AUTO_IMAGE_KEY_PROVIDERS, - DEFAULT_IMAGE_MODELS, -} from "../../../src/media-understanding/defaults.js"; -import { resolveAutoImageModel } from "../../../src/media-understanding/runner.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { resolveDefaultModelForAgent } from "openclaw/plugin-sdk/agent-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { loadJsonFile, saveJsonFile } from "openclaw/plugin-sdk/json-store"; +import { AUTO_IMAGE_KEY_PROVIDERS, DEFAULT_IMAGE_MODELS } from "openclaw/plugin-sdk/media-runtime"; +import { resolveAutoImageModel } from "openclaw/plugin-sdk/media-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { STATE_DIR } from "openclaw/plugin-sdk/state-paths"; const CACHE_FILE = path.join(STATE_DIR, "telegram", "sticker-cache.json"); const CACHE_VERSION = 1; @@ -146,12 +143,10 @@ export function getCacheStats(): { count: number; oldestAt?: string; newestAt?: const STICKER_DESCRIPTION_PROMPT = "Describe this sticker image in 1-2 sentences. Focus on what the sticker depicts (character, object, action, emotion). Be concise and objective."; -let imageRuntimePromise: Promise< - typeof import("../../../src/media-understanding/providers/image-runtime.js") -> | null = null; +let imageRuntimePromise: Promise | null = null; function loadImageRuntime() { - imageRuntimePromise ??= import("../../../src/media-understanding/providers/image-runtime.js"); + imageRuntimePromise ??= import("openclaw/plugin-sdk/media-runtime"); return imageRuntimePromise; } diff --git a/extensions/telegram/src/target-writeback.ts b/extensions/telegram/src/target-writeback.ts index 6423215ffa2..8e5bf197a23 100644 --- a/extensions/telegram/src/target-writeback.ts +++ b/extensions/telegram/src/target-writeback.ts @@ -1,7 +1,14 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { readConfigFileSnapshotForWrite, writeConfigFile } from "../../../src/config/config.js"; -import { loadCronStore, resolveCronStorePath, saveCronStore } from "../../../src/cron/store.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { + readConfigFileSnapshotForWrite, + writeConfigFile, +} from "openclaw/plugin-sdk/config-runtime"; +import { + loadCronStore, + resolveCronStorePath, + saveCronStore, +} from "openclaw/plugin-sdk/config-runtime"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; import { normalizeTelegramChatId, normalizeTelegramLookupTarget, diff --git a/extensions/telegram/src/thread-bindings.ts b/extensions/telegram/src/thread-bindings.ts index d10fef7f72c..aaf13e15561 100644 --- a/extensions/telegram/src/thread-bindings.ts +++ b/extensions/telegram/src/thread-bindings.ts @@ -1,19 +1,19 @@ import fs from "node:fs"; import os from "node:os"; import path from "node:path"; -import { resolveThreadBindingConversationIdFromBindingId } from "../../../src/channels/thread-binding-id.js"; -import { formatThreadBindingDurationLabel } from "../../../src/channels/thread-bindings-messages.js"; -import { resolveStateDir } from "../../../src/config/paths.js"; -import { logVerbose } from "../../../src/globals.js"; -import { writeJsonAtomic } from "../../../src/infra/json-files.js"; +import { resolveThreadBindingConversationIdFromBindingId } from "openclaw/plugin-sdk/channel-runtime"; +import { formatThreadBindingDurationLabel } from "openclaw/plugin-sdk/channel-runtime"; import { registerSessionBindingAdapter, unregisterSessionBindingAdapter, type BindingTargetKind, type SessionBindingRecord, -} from "../../../src/infra/outbound/session-binding-service.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; -import { resolveGlobalSingleton } from "../../../src/shared/global-singleton.js"; +} from "openclaw/plugin-sdk/conversation-runtime"; +import { writeJsonAtomic } from "openclaw/plugin-sdk/infra-runtime"; +import { normalizeAccountId } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; +import { resolveGlobalSingleton } from "openclaw/plugin-sdk/text-runtime"; const DEFAULT_THREAD_BINDING_IDLE_TIMEOUT_MS = 24 * 60 * 60 * 1000; const DEFAULT_THREAD_BINDING_MAX_AGE_MS = 0; diff --git a/extensions/telegram/src/token.ts b/extensions/telegram/src/token.ts index d26d9657ca1..7a23a34ab12 100644 --- a/extensions/telegram/src/token.ts +++ b/extensions/telegram/src/token.ts @@ -1,9 +1,9 @@ -import type { BaseTokenResolution } from "../../../src/channels/plugins/types.core.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { normalizeResolvedSecretInputString } from "../../../src/config/types.secrets.js"; -import { tryReadSecretFileSync } from "../../../src/infra/secret-file.js"; -import type { TelegramAccountConfig } from "../../../src/plugin-sdk-internal/telegram.js"; -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; +import type { BaseTokenResolution } from "openclaw/plugin-sdk/channel-runtime"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { normalizeResolvedSecretInputString } from "openclaw/plugin-sdk/config-runtime"; +import { tryReadSecretFileSync } from "openclaw/plugin-sdk/infra-runtime"; +import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/routing"; +import type { TelegramAccountConfig } from "openclaw/plugin-sdk/telegram"; export type TelegramTokenSource = "env" | "tokenFile" | "config" | "none"; diff --git a/extensions/telegram/src/update-offset-store.ts b/extensions/telegram/src/update-offset-store.ts index 55b4e96ae23..395b5c1e450 100644 --- a/extensions/telegram/src/update-offset-store.ts +++ b/extensions/telegram/src/update-offset-store.ts @@ -1,8 +1,8 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; -import { resolveStateDir } from "../../../src/config/paths.js"; -import { writeJsonAtomic } from "../../../src/infra/json-files.js"; +import { writeJsonAtomic } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveStateDir } from "openclaw/plugin-sdk/state-paths"; const STORE_VERSION = 2; diff --git a/extensions/telegram/src/voice.ts b/extensions/telegram/src/voice.ts index 865bd82d72e..8a452471603 100644 --- a/extensions/telegram/src/voice.ts +++ b/extensions/telegram/src/voice.ts @@ -1,4 +1,4 @@ -import { isTelegramVoiceCompatibleAudio } from "../../../src/media/audio.js"; +import { isTelegramVoiceCompatibleAudio } from "openclaw/plugin-sdk/media-runtime"; export function resolveTelegramVoiceDecision(opts: { wantsVoice: boolean; diff --git a/extensions/telegram/src/webhook.ts b/extensions/telegram/src/webhook.ts index 39458ae036a..076bd12b279 100644 --- a/extensions/telegram/src/webhook.ts +++ b/extensions/telegram/src/webhook.ts @@ -1,19 +1,19 @@ import { timingSafeEqual } from "node:crypto"; import { createServer } from "node:http"; import { InputFile, webhookCallback } from "grammy"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { isDiagnosticsEnabled } from "../../../src/infra/diagnostic-events.js"; -import { formatErrorMessage } from "../../../src/infra/errors.js"; -import { readJsonBodyWithLimit } from "../../../src/infra/http-body.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { isDiagnosticsEnabled } from "openclaw/plugin-sdk/infra-runtime"; +import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; +import { readJsonBodyWithLimit } from "openclaw/plugin-sdk/infra-runtime"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { defaultRuntime } from "openclaw/plugin-sdk/runtime-env"; import { logWebhookError, logWebhookProcessed, logWebhookReceived, startDiagnosticHeartbeat, stopDiagnosticHeartbeat, -} from "../../../src/logging/diagnostic.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; -import { defaultRuntime } from "../../../src/runtime.js"; +} from "openclaw/plugin-sdk/text-runtime"; import { resolveTelegramAllowedUpdates } from "./allowed-updates.js"; import { withTelegramApiErrorLogging } from "./api-logging.js"; import { createTelegramBot } from "./bot.js"; diff --git a/extensions/test-utils/directory.ts b/extensions/test-utils/directory.ts index 90d2ed445d3..b4edaa12ded 100644 --- a/extensions/test-utils/directory.ts +++ b/extensions/test-utils/directory.ts @@ -1,4 +1,4 @@ -import type { ChannelDirectoryAdapter } from "../../src/channels/plugins/types.js"; +import type { ChannelDirectoryAdapter } from "openclaw/plugin-sdk/channel-runtime"; export function createDirectoryTestRuntime() { return { diff --git a/extensions/test-utils/plugin-api.ts b/extensions/test-utils/plugin-api.ts index 82fe818fdec..2080359d961 100644 --- a/extensions/test-utils/plugin-api.ts +++ b/extensions/test-utils/plugin-api.ts @@ -1,4 +1,4 @@ -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-runtime"; type TestPluginApiInput = Partial & Pick; diff --git a/extensions/test-utils/plugin-runtime-mock.ts b/extensions/test-utils/plugin-runtime-mock.ts index b7ca386028b..a5003620a59 100644 --- a/extensions/test-utils/plugin-runtime-mock.ts +++ b/extensions/test-utils/plugin-runtime-mock.ts @@ -1,7 +1,7 @@ +import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "openclaw/plugin-sdk/agent-runtime"; import type { PluginRuntime } from "openclaw/plugin-sdk/test-utils"; import { removeAckReactionAfterReply, shouldAckReaction } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; -import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "../../src/agents/defaults.js"; type DeepPartial = { [K in keyof T]?: T[K] extends (...args: never[]) => unknown diff --git a/extensions/together/index.ts b/extensions/together/index.ts index a32031f0634..5f6dfb3e7c4 100644 --- a/extensions/together/index.ts +++ b/extensions/together/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyTogetherConfig, TOGETHER_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildTogetherProvider } from "./provider-catalog.js"; diff --git a/extensions/together/onboard.ts b/extensions/together/onboard.ts index a540401e01a..e18595ab21e 100644 --- a/extensions/together/onboard.ts +++ b/extensions/together/onboard.ts @@ -2,12 +2,12 @@ import { buildTogetherModelDefinition, TOGETHER_BASE_URL, TOGETHER_MODEL_CATALOG, -} from "../../src/agents/together-models.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export const TOGETHER_DEFAULT_MODEL_REF = "together/moonshotai/Kimi-K2.5"; diff --git a/extensions/together/provider-catalog.ts b/extensions/together/provider-catalog.ts index 3d902d3bb1a..45d3b5de130 100644 --- a/extensions/together/provider-catalog.ts +++ b/extensions/together/provider-catalog.ts @@ -1,9 +1,9 @@ import { buildTogetherModelDefinition, + type ModelProviderConfig, TOGETHER_BASE_URL, TOGETHER_MODEL_CATALOG, -} from "../../src/agents/together-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +} from "openclaw/plugin-sdk/provider-models"; export function buildTogetherProvider(): ModelProviderConfig { return { diff --git a/extensions/twitch/src/plugin.ts b/extensions/twitch/src/plugin.ts index 3958a05fd8b..490b741d989 100644 --- a/extensions/twitch/src/plugin.ts +++ b/extensions/twitch/src/plugin.ts @@ -136,7 +136,7 @@ export const twitchPlugin: ChannelPlugin = { accountId?: string | null; inputs: string[]; kind: ChannelResolveKind; - runtime: import("../../../src/runtime.js").RuntimeEnv; + runtime: import("openclaw/plugin-sdk/runtime-env").RuntimeEnv; }): Promise => { const account = getAccountConfig(cfg, accountId ?? DEFAULT_ACCOUNT_ID); diff --git a/extensions/venice/index.ts b/extensions/venice/index.ts index 92ff17e6df5..d25e8ffb9b8 100644 --- a/extensions/venice/index.ts +++ b/extensions/venice/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyVeniceConfig, VENICE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildVeniceProvider } from "./provider-catalog.js"; diff --git a/extensions/venice/onboard.ts b/extensions/venice/onboard.ts index fbd535d6264..23634a18540 100644 --- a/extensions/venice/onboard.ts +++ b/extensions/venice/onboard.ts @@ -3,12 +3,12 @@ import { VENICE_BASE_URL, VENICE_DEFAULT_MODEL_REF, VENICE_MODEL_CATALOG, -} from "../../src/agents/venice-models.js"; +} from "openclaw/plugin-sdk/provider-models"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export { VENICE_DEFAULT_MODEL_REF }; diff --git a/extensions/venice/provider-catalog.ts b/extensions/venice/provider-catalog.ts index ec7087a08db..d207ab581b1 100644 --- a/extensions/venice/provider-catalog.ts +++ b/extensions/venice/provider-catalog.ts @@ -1,5 +1,8 @@ -import { discoverVeniceModels, VENICE_BASE_URL } from "../../src/agents/venice-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import { + discoverVeniceModels, + type ModelProviderConfig, + VENICE_BASE_URL, +} from "openclaw/plugin-sdk/provider-models"; export async function buildVeniceProvider(): Promise { const models = await discoverVeniceModels(); diff --git a/extensions/vercel-ai-gateway/index.ts b/extensions/vercel-ai-gateway/index.ts index ea7c734f310..1f126260321 100644 --- a/extensions/vercel-ai-gateway/index.ts +++ b/extensions/vercel-ai-gateway/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyVercelAiGatewayConfig, VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildVercelAiGatewayProvider } from "./provider-catalog.js"; diff --git a/extensions/vercel-ai-gateway/onboard.ts b/extensions/vercel-ai-gateway/onboard.ts index d65d7224781..5ca89c8ad33 100644 --- a/extensions/vercel-ai-gateway/onboard.ts +++ b/extensions/vercel-ai-gateway/onboard.ts @@ -1,5 +1,7 @@ -import { applyAgentDefaultModelPrimary } from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; +import { + applyAgentDefaultModelPrimary, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; export const VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF = "vercel-ai-gateway/anthropic/claude-opus-4.6"; diff --git a/extensions/vercel-ai-gateway/provider-catalog.ts b/extensions/vercel-ai-gateway/provider-catalog.ts index 0e219264ab7..d3475efe9b9 100644 --- a/extensions/vercel-ai-gateway/provider-catalog.ts +++ b/extensions/vercel-ai-gateway/provider-catalog.ts @@ -1,8 +1,8 @@ import { discoverVercelAiGatewayModels, VERCEL_AI_GATEWAY_BASE_URL, -} from "../../src/agents/vercel-ai-gateway.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; + type ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; export async function buildVercelAiGatewayProvider(): Promise { return { diff --git a/extensions/vllm/index.ts b/extensions/vllm/index.ts index 938fb78c9bd..24805e700a6 100644 --- a/extensions/vllm/index.ts +++ b/extensions/vllm/index.ts @@ -1,14 +1,14 @@ -import { - emptyPluginConfigSchema, - type OpenClawPluginApi, - type ProviderAuthMethodNonInteractiveContext, -} from "openclaw/plugin-sdk/core"; import { VLLM_DEFAULT_API_KEY_ENV_VAR, VLLM_DEFAULT_BASE_URL, VLLM_MODEL_PLACEHOLDER, VLLM_PROVIDER_LABEL, -} from "../../src/agents/vllm-defaults.js"; +} from "openclaw/plugin-sdk/agent-runtime"; +import { + emptyPluginConfigSchema, + type OpenClawPluginApi, + type ProviderAuthMethodNonInteractiveContext, +} from "openclaw/plugin-sdk/core"; const PROVIDER_ID = "vllm"; diff --git a/extensions/volcengine/index.ts b/extensions/volcengine/index.ts index f9e3fb72010..975bcce610d 100644 --- a/extensions/volcengine/index.ts +++ b/extensions/volcengine/index.ts @@ -1,7 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { ensureModelAllowlistEntry } from "../../src/commands/model-allowlist.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import { buildPairedProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { ensureModelAllowlistEntry } from "openclaw/plugin-sdk/provider-onboard"; import { buildDoubaoCodingProvider, buildDoubaoProvider } from "./provider-catalog.js"; const PROVIDER_ID = "volcengine"; @@ -46,15 +45,18 @@ const volcenginePlugin = { ], catalog: { order: "paired", - run: (ctx) => - buildPairedProviderApiKeyCatalog({ - ctx, - providerId: PROVIDER_ID, - buildProviders: () => ({ - volcengine: buildDoubaoProvider(), - "volcengine-plan": buildDoubaoCodingProvider(), - }), - }), + run: async (ctx) => { + const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; + if (!apiKey) { + return null; + } + return { + providers: { + volcengine: { ...buildDoubaoProvider(), apiKey }, + "volcengine-plan": { ...buildDoubaoCodingProvider(), apiKey }, + }, + }; + }, }, }); }, diff --git a/extensions/volcengine/provider-catalog.ts b/extensions/volcengine/provider-catalog.ts index ef57e0a86e7..f01a3079bcc 100644 --- a/extensions/volcengine/provider-catalog.ts +++ b/extensions/volcengine/provider-catalog.ts @@ -4,8 +4,8 @@ import { DOUBAO_CODING_BASE_URL, DOUBAO_CODING_MODEL_CATALOG, DOUBAO_MODEL_CATALOG, -} from "../../src/agents/doubao-models.js"; -import type { ModelProviderConfig } from "../../src/config/types.models.js"; + type ModelProviderConfig, +} from "openclaw/plugin-sdk/provider-models"; export function buildDoubaoProvider(): ModelProviderConfig { return { diff --git a/extensions/whatsapp/src/accounts.ts b/extensions/whatsapp/src/accounts.ts index 1d17404a6a2..d2a4e277846 100644 --- a/extensions/whatsapp/src/accounts.ts +++ b/extensions/whatsapp/src/accounts.ts @@ -1,19 +1,15 @@ import fs from "node:fs"; import path from "node:path"; -import { resolveOAuthDir } from "../../../src/config/paths.js"; import { - type OpenClawConfig, createAccountListHelpers, DEFAULT_ACCOUNT_ID, normalizeAccountId, resolveAccountEntry, resolveUserPath, -} from "../../../src/plugin-sdk-internal/accounts.js"; -import type { - DmPolicy, - GroupPolicy, - WhatsAppAccountConfig, -} from "../../../src/plugin-sdk-internal/whatsapp.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import { resolveOAuthDir } from "openclaw/plugin-sdk/state-paths"; +import type { DmPolicy, GroupPolicy, WhatsAppAccountConfig } from "openclaw/plugin-sdk/whatsapp"; import { hasWebCredsSync } from "./auth-store.js"; export type ResolvedWhatsAppAccount = { diff --git a/extensions/whatsapp/src/active-listener.ts b/extensions/whatsapp/src/active-listener.ts index fc8f11fe20e..71b6086f3a0 100644 --- a/extensions/whatsapp/src/active-listener.ts +++ b/extensions/whatsapp/src/active-listener.ts @@ -1,6 +1,6 @@ -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import type { PollInput } from "../../../src/polls.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import type { PollInput } from "openclaw/plugin-sdk/media-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; export type ActiveWebSendOptions = { gifPlayback?: boolean; diff --git a/extensions/whatsapp/src/agent-tools-login.ts b/extensions/whatsapp/src/agent-tools-login.ts index a1ac87a3976..9343e83d21a 100644 --- a/extensions/whatsapp/src/agent-tools-login.ts +++ b/extensions/whatsapp/src/agent-tools-login.ts @@ -1,5 +1,5 @@ import { Type } from "@sinclair/typebox"; -import type { ChannelAgentTool } from "../../../src/channels/plugins/types.js"; +import type { ChannelAgentTool } from "openclaw/plugin-sdk/channel-runtime"; export function createWhatsAppLoginTool(): ChannelAgentTool { return { diff --git a/extensions/whatsapp/src/auth-store.ts b/extensions/whatsapp/src/auth-store.ts index 636c114676f..991be6dff7d 100644 --- a/extensions/whatsapp/src/auth-store.ts +++ b/extensions/whatsapp/src/auth-store.ts @@ -1,14 +1,14 @@ import fsSync from "node:fs"; import fs from "node:fs/promises"; import path from "node:path"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { resolveOAuthDir } from "../../../src/config/paths.js"; -import { info, success } from "../../../src/globals.js"; -import { getChildLogger } from "../../../src/logging.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { defaultRuntime, type RuntimeEnv } from "../../../src/runtime.js"; -import type { WebChannel } from "../../../src/utils.js"; -import { jidToE164, resolveUserPath } from "../../../src/utils.js"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; +import { info, success } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import { defaultRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { resolveOAuthDir } from "openclaw/plugin-sdk/state-paths"; +import type { WebChannel } from "openclaw/plugin-sdk/text-runtime"; +import { jidToE164, resolveUserPath } from "openclaw/plugin-sdk/text-runtime"; export function resolveDefaultWebAuthDir(): string { return path.join(resolveOAuthDir(), "whatsapp", DEFAULT_ACCOUNT_ID); diff --git a/extensions/whatsapp/src/auto-reply.impl.ts b/extensions/whatsapp/src/auto-reply.impl.ts index 57feff1ab4d..e936c63e732 100644 --- a/extensions/whatsapp/src/auto-reply.impl.ts +++ b/extensions/whatsapp/src/auto-reply.impl.ts @@ -1,5 +1,5 @@ -export { HEARTBEAT_PROMPT, stripHeartbeatToken } from "../../../src/auto-reply/heartbeat.js"; -export { HEARTBEAT_TOKEN, SILENT_REPLY_TOKEN } from "../../../src/auto-reply/tokens.js"; +export { HEARTBEAT_PROMPT, stripHeartbeatToken } from "openclaw/plugin-sdk/reply-runtime"; +export { HEARTBEAT_TOKEN, SILENT_REPLY_TOKEN } from "openclaw/plugin-sdk/reply-runtime"; export { DEFAULT_WEB_MEDIA_BYTES } from "./auto-reply/constants.js"; export { resolveHeartbeatRecipients, runWebHeartbeatOnce } from "./auto-reply/heartbeat-runner.js"; diff --git a/extensions/whatsapp/src/auto-reply.test-harness.ts b/extensions/whatsapp/src/auto-reply.test-harness.ts index dfbcf447fa9..f3707f87679 100644 --- a/extensions/whatsapp/src/auto-reply.test-harness.ts +++ b/extensions/whatsapp/src/auto-reply.test-harness.ts @@ -2,10 +2,10 @@ import "./test-helpers.js"; import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; +import * as ssrf from "openclaw/plugin-sdk/infra-runtime"; +import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; +import { resetLogger, setLoggerOverride } from "openclaw/plugin-sdk/runtime-env"; import { afterAll, afterEach, beforeAll, beforeEach, vi } from "vitest"; -import { resetInboundDedupe } from "../../../src/auto-reply/reply/inbound-dedupe.js"; -import * as ssrf from "../../../src/infra/net/ssrf.js"; -import { resetLogger, setLoggerOverride } from "../../../src/logging.js"; import type { WebInboundMessage, WebListenerCloseReason } from "./inbound.js"; import { resetBaileysMocks as _resetBaileysMocks, @@ -29,7 +29,7 @@ type MockWebListener = { export const TEST_NET_IP = "203.0.113.10"; -vi.mock("../../../src/agents/pi-embedded.js", () => ({ +vi.mock("openclaw/plugin-sdk/agent-runtime", () => ({ abortEmbeddedPiRun: vi.fn().mockReturnValue(false), isEmbeddedPiRunActive: vi.fn().mockReturnValue(false), isEmbeddedPiRunStreaming: vi.fn().mockReturnValue(false), diff --git a/extensions/whatsapp/src/auto-reply/deliver-reply.ts b/extensions/whatsapp/src/auto-reply/deliver-reply.ts index 6fb4ce39143..6d9d8b541ae 100644 --- a/extensions/whatsapp/src/auto-reply/deliver-reply.ts +++ b/extensions/whatsapp/src/auto-reply/deliver-reply.ts @@ -1,10 +1,10 @@ -import { chunkMarkdownTextWithMode, type ChunkMode } from "../../../../src/auto-reply/chunk.js"; -import type { ReplyPayload } from "../../../../src/auto-reply/types.js"; -import type { MarkdownTableMode } from "../../../../src/config/types.base.js"; -import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { convertMarkdownTables } from "../../../../src/markdown/tables.js"; -import { markdownToWhatsApp } from "../../../../src/markdown/whatsapp.js"; -import { sleep } from "../../../../src/utils.js"; +import type { MarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { chunkMarkdownTextWithMode, type ChunkMode } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; +import { markdownToWhatsApp } from "openclaw/plugin-sdk/text-runtime"; +import { sleep } from "openclaw/plugin-sdk/text-runtime"; import { loadWebMedia } from "../media.js"; import { newConnectionId } from "../reconnect.js"; import { formatError } from "../session.js"; diff --git a/extensions/whatsapp/src/auto-reply/heartbeat-runner.ts b/extensions/whatsapp/src/auto-reply/heartbeat-runner.ts index 0b423a3f116..7aa35705f43 100644 --- a/extensions/whatsapp/src/auto-reply/heartbeat-runner.ts +++ b/extensions/whatsapp/src/auto-reply/heartbeat-runner.ts @@ -1,28 +1,25 @@ -import { appendCronStyleCurrentTimeLine } from "../../../../src/agents/current-time.js"; -import { resolveHeartbeatReplyPayload } from "../../../../src/auto-reply/heartbeat-reply-payload.js"; -import { - DEFAULT_HEARTBEAT_ACK_MAX_CHARS, - resolveHeartbeatPrompt, - stripHeartbeatToken, -} from "../../../../src/auto-reply/heartbeat.js"; -import { getReplyFromConfig } from "../../../../src/auto-reply/reply.js"; -import { HEARTBEAT_TOKEN } from "../../../../src/auto-reply/tokens.js"; -import { resolveWhatsAppHeartbeatRecipients } from "../../../../src/channels/plugins/whatsapp-heartbeat.js"; -import { loadConfig } from "../../../../src/config/config.js"; +import { appendCronStyleCurrentTimeLine } from "openclaw/plugin-sdk/agent-runtime"; +import { resolveWhatsAppHeartbeatRecipients } from "openclaw/plugin-sdk/channel-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { loadSessionStore, resolveSessionKey, resolveStorePath, updateSessionStore, -} from "../../../../src/config/sessions.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { emitHeartbeatEvent, resolveIndicatorType } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveHeartbeatVisibility } from "openclaw/plugin-sdk/infra-runtime"; +import { resolveHeartbeatReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import { - emitHeartbeatEvent, - resolveIndicatorType, -} from "../../../../src/infra/heartbeat-events.js"; -import { resolveHeartbeatVisibility } from "../../../../src/infra/heartbeat-visibility.js"; -import { getChildLogger } from "../../../../src/logging.js"; -import { redactIdentifier } from "../../../../src/logging/redact-identifier.js"; -import { normalizeMainKey } from "../../../../src/routing/session-key.js"; + DEFAULT_HEARTBEAT_ACK_MAX_CHARS, + resolveHeartbeatPrompt, + stripHeartbeatToken, +} from "openclaw/plugin-sdk/reply-runtime"; +import { getReplyFromConfig } from "openclaw/plugin-sdk/reply-runtime"; +import { HEARTBEAT_TOKEN } from "openclaw/plugin-sdk/reply-runtime"; +import { normalizeMainKey } from "openclaw/plugin-sdk/routing"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import { redactIdentifier } from "openclaw/plugin-sdk/text-runtime"; import { newConnectionId } from "../reconnect.js"; import { sendMessageWhatsApp } from "../send.js"; import { formatError } from "../session.js"; diff --git a/extensions/whatsapp/src/auto-reply/loggers.ts b/extensions/whatsapp/src/auto-reply/loggers.ts index 71575671b2e..1201a412a59 100644 --- a/extensions/whatsapp/src/auto-reply/loggers.ts +++ b/extensions/whatsapp/src/auto-reply/loggers.ts @@ -1,4 +1,4 @@ -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; export const whatsappLog = createSubsystemLogger("gateway/channels/whatsapp"); export const whatsappInboundLog = whatsappLog.child("inbound"); diff --git a/extensions/whatsapp/src/auto-reply/mentions.ts b/extensions/whatsapp/src/auto-reply/mentions.ts index 3891810c617..ad42c814c26 100644 --- a/extensions/whatsapp/src/auto-reply/mentions.ts +++ b/extensions/whatsapp/src/auto-reply/mentions.ts @@ -1,9 +1,6 @@ -import { - buildMentionRegexes, - normalizeMentionText, -} from "../../../../src/auto-reply/reply/mentions.js"; -import type { loadConfig } from "../../../../src/config/config.js"; -import { isSelfChatMode, jidToE164, normalizeE164 } from "../../../../src/utils.js"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { buildMentionRegexes, normalizeMentionText } from "openclaw/plugin-sdk/reply-runtime"; +import { isSelfChatMode, jidToE164, normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import type { WebInboundMsg } from "./types.js"; export type MentionConfig = { diff --git a/extensions/whatsapp/src/auto-reply/monitor.ts b/extensions/whatsapp/src/auto-reply/monitor.ts index 1222c69b71a..2f83e65079a 100644 --- a/extensions/whatsapp/src/auto-reply/monitor.ts +++ b/extensions/whatsapp/src/auto-reply/monitor.ts @@ -1,18 +1,18 @@ -import { hasControlCommand } from "../../../../src/auto-reply/command-detection.js"; -import { resolveInboundDebounceMs } from "../../../../src/auto-reply/inbound-debounce.js"; -import { getReplyFromConfig } from "../../../../src/auto-reply/reply.js"; -import { DEFAULT_GROUP_HISTORY_LIMIT } from "../../../../src/auto-reply/reply/history.js"; -import { formatCliCommand } from "../../../../src/cli/command-format.js"; -import { waitForever } from "../../../../src/cli/wait.js"; -import { loadConfig } from "../../../../src/config/config.js"; -import { createConnectedChannelStatusPatch } from "../../../../src/gateway/channel-status-patches.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { formatDurationPrecise } from "../../../../src/infra/format-time/format-duration.ts"; -import { enqueueSystemEvent } from "../../../../src/infra/system-events.js"; -import { registerUnhandledRejectionHandler } from "../../../../src/infra/unhandled-rejections.js"; -import { getChildLogger } from "../../../../src/logging.js"; -import { resolveAgentRoute } from "../../../../src/routing/resolve-route.js"; -import { defaultRuntime, type RuntimeEnv } from "../../../../src/runtime.js"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import { waitForever } from "openclaw/plugin-sdk/cli-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { createConnectedChannelStatusPatch } from "openclaw/plugin-sdk/gateway-runtime"; +import { formatDurationPrecise } from "openclaw/plugin-sdk/infra-runtime"; +import { enqueueSystemEvent } from "openclaw/plugin-sdk/infra-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveInboundDebounceMs } from "openclaw/plugin-sdk/reply-runtime"; +import { getReplyFromConfig } from "openclaw/plugin-sdk/reply-runtime"; +import { DEFAULT_GROUP_HISTORY_LIMIT } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { registerUnhandledRejectionHandler } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; +import { defaultRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { resolveWhatsAppAccount, resolveWhatsAppMediaMaxBytes } from "../accounts.js"; import { setActiveWebListener } from "../active-listener.js"; import { monitorWebInbox } from "../inbound.js"; diff --git a/extensions/whatsapp/src/auto-reply/monitor/ack-reaction.ts b/extensions/whatsapp/src/auto-reply/monitor/ack-reaction.ts index c5a5d149ab7..126c485ec6f 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/ack-reaction.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/ack-reaction.ts @@ -1,6 +1,6 @@ -import { shouldAckReactionForWhatsApp } from "../../../../../src/channels/ack-reactions.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; -import { logVerbose } from "../../../../../src/globals.js"; +import { shouldAckReactionForWhatsApp } from "openclaw/plugin-sdk/channel-runtime"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { sendReactionWhatsApp } from "../../send.js"; import { formatError } from "../../session.js"; import type { WebInboundMsg } from "../types.js"; diff --git a/extensions/whatsapp/src/auto-reply/monitor/broadcast.ts b/extensions/whatsapp/src/auto-reply/monitor/broadcast.ts index b00ba7aff9b..b2dc74cffe5 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/broadcast.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/broadcast.ts @@ -1,14 +1,11 @@ -import type { loadConfig } from "../../../../../src/config/config.js"; -import type { resolveAgentRoute } from "../../../../../src/routing/resolve-route.js"; -import { - buildAgentSessionKey, - deriveLastRoutePolicy, -} from "../../../../../src/routing/resolve-route.js"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { buildAgentSessionKey, deriveLastRoutePolicy } from "openclaw/plugin-sdk/routing"; import { buildAgentMainSessionKey, DEFAULT_MAIN_KEY, normalizeAgentId, -} from "../../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/routing"; import { formatError } from "../../session.js"; import { whatsappInboundLog } from "../loggers.js"; import type { WebInboundMsg } from "../types.js"; diff --git a/extensions/whatsapp/src/auto-reply/monitor/group-activation.ts b/extensions/whatsapp/src/auto-reply/monitor/group-activation.ts index 60b15f5b3c6..745e62fa17a 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/group-activation.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/group-activation.ts @@ -1,14 +1,14 @@ -import { normalizeGroupActivation } from "../../../../../src/auto-reply/group-activation.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveChannelGroupPolicy, resolveChannelGroupRequireMention, -} from "../../../../../src/config/group-policy.js"; +} from "openclaw/plugin-sdk/config-runtime"; import { loadSessionStore, resolveGroupSessionKey, resolveStorePath, -} from "../../../../../src/config/sessions.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { normalizeGroupActivation } from "openclaw/plugin-sdk/reply-runtime"; export function resolveGroupPolicyFor(cfg: ReturnType, conversationId: string) { const groupId = resolveGroupSessionKey({ diff --git a/extensions/whatsapp/src/auto-reply/monitor/group-gating.ts b/extensions/whatsapp/src/auto-reply/monitor/group-gating.ts index 418d5ebee83..847e5e3182f 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/group-gating.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/group-gating.ts @@ -1,9 +1,9 @@ -import { hasControlCommand } from "../../../../../src/auto-reply/command-detection.js"; -import { parseActivationCommand } from "../../../../../src/auto-reply/group-activation.js"; -import { recordPendingHistoryEntryIfEnabled } from "../../../../../src/auto-reply/reply/history.js"; -import { resolveMentionGating } from "../../../../../src/channels/mention-gating.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; -import { normalizeE164 } from "../../../../../src/utils.js"; +import { resolveMentionGating } from "openclaw/plugin-sdk/channel-runtime"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { hasControlCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { parseActivationCommand } from "openclaw/plugin-sdk/reply-runtime"; +import { recordPendingHistoryEntryIfEnabled } from "openclaw/plugin-sdk/reply-runtime"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import type { MentionConfig } from "../mentions.js"; import { buildMentionConfig, debugMention, resolveOwnerList } from "../mentions.js"; import type { WebInboundMsg } from "../types.js"; diff --git a/extensions/whatsapp/src/auto-reply/monitor/group-members.ts b/extensions/whatsapp/src/auto-reply/monitor/group-members.ts index fc2d541bcf5..a037dcfb38b 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/group-members.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/group-members.ts @@ -1,4 +1,4 @@ -import { normalizeE164 } from "../../../../../src/utils.js"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; function appendNormalizedUnique(entries: Iterable, seen: Set, ordered: string[]) { for (const entry of entries) { diff --git a/extensions/whatsapp/src/auto-reply/monitor/last-route.ts b/extensions/whatsapp/src/auto-reply/monitor/last-route.ts index 9fbe17d104d..915db0ba761 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/last-route.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/last-route.ts @@ -1,6 +1,6 @@ -import type { MsgContext } from "../../../../../src/auto-reply/templating.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; -import { resolveStorePath, updateLastRoute } from "../../../../../src/config/sessions.js"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveStorePath, updateLastRoute } from "openclaw/plugin-sdk/config-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; import { formatError } from "../../session.js"; export function trackBackgroundTask( diff --git a/extensions/whatsapp/src/auto-reply/monitor/message-line.ts b/extensions/whatsapp/src/auto-reply/monitor/message-line.ts index 299d5868bf8..b9494f0325c 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/message-line.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/message-line.ts @@ -1,9 +1,9 @@ -import { resolveMessagePrefix } from "../../../../../src/agents/identity.js"; +import { resolveMessagePrefix } from "openclaw/plugin-sdk/agent-runtime"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { formatInboundEnvelope, type EnvelopeFormatOptions, -} from "../../../../../src/auto-reply/envelope.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; +} from "openclaw/plugin-sdk/reply-runtime"; import type { WebInboundMsg } from "../types.js"; export function formatReplyContext(msg: WebInboundMsg) { diff --git a/extensions/whatsapp/src/auto-reply/monitor/on-message.ts b/extensions/whatsapp/src/auto-reply/monitor/on-message.ts index caa519f5cf0..fe91ffff547 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/on-message.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/on-message.ts @@ -1,10 +1,10 @@ -import type { getReplyFromConfig } from "../../../../../src/auto-reply/reply.js"; -import type { MsgContext } from "../../../../../src/auto-reply/templating.js"; -import { loadConfig } from "../../../../../src/config/config.js"; -import { logVerbose } from "../../../../../src/globals.js"; -import { resolveAgentRoute } from "../../../../../src/routing/resolve-route.js"; -import { buildGroupHistoryKey } from "../../../../../src/routing/session-key.js"; -import { normalizeE164 } from "../../../../../src/utils.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { getReplyFromConfig } from "openclaw/plugin-sdk/reply-runtime"; +import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; +import { buildGroupHistoryKey } from "openclaw/plugin-sdk/routing"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import type { MentionConfig } from "../mentions.js"; import type { WebInboundMsg } from "../types.js"; import { maybeBroadcastMessage } from "./broadcast.js"; @@ -26,7 +26,7 @@ export function createWebOnMessageHandler(params: { echoTracker: EchoTracker; backgroundTasks: Set>; replyResolver: typeof getReplyFromConfig; - replyLogger: ReturnType<(typeof import("../../../../../src/logging.js"))["getChildLogger"]>; + replyLogger: ReturnType<(typeof import("openclaw/plugin-sdk/runtime-env"))["getChildLogger"]>; baseMentionConfig: MentionConfig; account: { authDir?: string; accountId?: string }; }) { diff --git a/extensions/whatsapp/src/auto-reply/monitor/peer.ts b/extensions/whatsapp/src/auto-reply/monitor/peer.ts index 7795ac7c4d1..daaa5a50f01 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/peer.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/peer.ts @@ -1,4 +1,4 @@ -import { jidToE164, normalizeE164 } from "../../../../../src/utils.js"; +import { jidToE164, normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import type { WebInboundMsg } from "../types.js"; export function resolvePeerId(msg: WebInboundMsg) { diff --git a/extensions/whatsapp/src/auto-reply/monitor/process-message.ts b/extensions/whatsapp/src/auto-reply/monitor/process-message.ts index 094e4570bdb..beaa564fe28 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/process-message.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/process-message.ts @@ -1,34 +1,34 @@ -import { resolveIdentityNamePrefix } from "../../../../../src/agents/identity.js"; -import { resolveChunkMode, resolveTextChunkLimit } from "../../../../../src/auto-reply/chunk.js"; -import { shouldComputeCommandAuthorized } from "../../../../../src/auto-reply/command-detection.js"; -import { formatInboundEnvelope } from "../../../../../src/auto-reply/envelope.js"; -import type { getReplyFromConfig } from "../../../../../src/auto-reply/reply.js"; +import { resolveIdentityNamePrefix } from "openclaw/plugin-sdk/agent-runtime"; +import { toLocationContext } from "openclaw/plugin-sdk/channel-runtime"; +import { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveInboundSessionEnvelopeContext } from "openclaw/plugin-sdk/channel-runtime"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { recordSessionMetaFromInbound } from "openclaw/plugin-sdk/config-runtime"; +import { getAgentScopedMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { resolveChunkMode, resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { shouldComputeCommandAuthorized } from "openclaw/plugin-sdk/reply-runtime"; +import { formatInboundEnvelope } from "openclaw/plugin-sdk/reply-runtime"; +import type { getReplyFromConfig } from "openclaw/plugin-sdk/reply-runtime"; import { buildHistoryContextFromEntries, type HistoryEntry, -} from "../../../../../src/auto-reply/reply/history.js"; -import { finalizeInboundContext } from "../../../../../src/auto-reply/reply/inbound-context.js"; -import { dispatchReplyWithBufferedBlockDispatcher } from "../../../../../src/auto-reply/reply/provider-dispatcher.js"; -import type { ReplyPayload } from "../../../../../src/auto-reply/types.js"; -import { toLocationContext } from "../../../../../src/channels/location.js"; -import { createReplyPrefixOptions } from "../../../../../src/channels/reply-prefix.js"; -import { resolveInboundSessionEnvelopeContext } from "../../../../../src/channels/session-envelope.js"; -import type { loadConfig } from "../../../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../../../src/config/markdown-tables.js"; -import { recordSessionMetaFromInbound } from "../../../../../src/config/sessions.js"; -import { logVerbose, shouldLogVerbose } from "../../../../../src/globals.js"; -import type { getChildLogger } from "../../../../../src/logging.js"; -import { getAgentScopedMediaLocalRoots } from "../../../../../src/media/local-roots.js"; +} from "openclaw/plugin-sdk/reply-runtime"; +import { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; +import { dispatchReplyWithBufferedBlockDispatcher } from "openclaw/plugin-sdk/reply-runtime"; +import type { ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; import { resolveInboundLastRouteSessionKey, type resolveAgentRoute, -} from "../../../../../src/routing/resolve-route.js"; +} from "openclaw/plugin-sdk/routing"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import type { getChildLogger } from "openclaw/plugin-sdk/runtime-env"; import { readStoreAllowFromForDmPolicy, resolvePinnedMainDmOwnerFromAllowlist, resolveDmGroupAccessWithCommandGate, -} from "../../../../../src/security/dm-policy-shared.js"; -import { jidToE164, normalizeE164 } from "../../../../../src/utils.js"; +} from "openclaw/plugin-sdk/security-runtime"; +import { jidToE164, normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import { resolveWhatsAppAccount } from "../../accounts.js"; import { newConnectionId } from "../../reconnect.js"; import { formatError } from "../../session.js"; diff --git a/extensions/whatsapp/src/auto-reply/session-snapshot.ts b/extensions/whatsapp/src/auto-reply/session-snapshot.ts index 53b7e3ae615..ff4899d0d52 100644 --- a/extensions/whatsapp/src/auto-reply/session-snapshot.ts +++ b/extensions/whatsapp/src/auto-reply/session-snapshot.ts @@ -1,4 +1,4 @@ -import type { loadConfig } from "../../../../src/config/config.js"; +import type { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { evaluateSessionFreshness, loadSessionStore, @@ -8,8 +8,8 @@ import { resolveSessionResetType, resolveSessionKey, resolveStorePath, -} from "../../../../src/config/sessions.js"; -import { normalizeMainKey } from "../../../../src/routing/session-key.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { normalizeMainKey } from "openclaw/plugin-sdk/routing"; export function getSessionSnapshot( cfg: ReturnType, diff --git a/extensions/whatsapp/src/channel.setup.ts b/extensions/whatsapp/src/channel.setup.ts index 919a75c1a8c..6cf2a75d1ce 100644 --- a/extensions/whatsapp/src/channel.setup.ts +++ b/extensions/whatsapp/src/channel.setup.ts @@ -1,21 +1,150 @@ -import { type ChannelPlugin } from "openclaw/plugin-sdk/whatsapp"; -import { type ResolvedWhatsAppAccount } from "./accounts.js"; +import { + buildAccountScopedDmSecurityPolicy, + buildChannelConfigSchema, + collectAllowlistProviderGroupPolicyWarnings, + collectOpenGroupPolicyRouteAllowlistWarnings, + DEFAULT_ACCOUNT_ID, + formatWhatsAppConfigAllowFromEntries, + getChatChannelMeta, + normalizeE164, + resolveWhatsAppConfigAllowFrom, + resolveWhatsAppConfigDefaultTo, + resolveWhatsAppGroupIntroHint, + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupToolPolicy, + WhatsAppConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/whatsapp"; +import { + listWhatsAppAccountIds, + resolveDefaultWhatsAppAccountId, + resolveWhatsAppAccount, + type ResolvedWhatsAppAccount, +} from "./accounts.js"; import { webAuthExists } from "./auth-store.js"; +import { whatsappSetupWizardProxy } from "./plugin-shared.js"; import { whatsappSetupAdapter } from "./setup-core.js"; -import { createWhatsAppPluginBase, createWhatsAppSetupWizardProxy } from "./shared.js"; - -async function loadWhatsAppChannelRuntime() { - return await import("./channel.runtime.js"); -} - -const whatsappSetupWizardProxy = createWhatsAppSetupWizardProxy(async () => ({ - whatsappSetupWizard: (await loadWhatsAppChannelRuntime()).whatsappSetupWizard, -})); export const whatsappSetupPlugin: ChannelPlugin = { - ...createWhatsAppPluginBase({ - setupWizard: whatsappSetupWizardProxy, - setup: whatsappSetupAdapter, + id: "whatsapp", + meta: { + ...getChatChannelMeta("whatsapp"), + showConfigured: false, + quickstartAllowFrom: true, + forceAccountBinding: true, + preferSessionLookupForAnnounceTarget: true, + }, + setupWizard: whatsappSetupWizardProxy, + capabilities: { + chatTypes: ["direct", "group"], + polls: true, + reactions: true, + media: true, + }, + reload: { configPrefixes: ["web"], noopPrefixes: ["channels.whatsapp"] }, + gatewayMethods: ["web.login.start", "web.login.wait"], + configSchema: buildChannelConfigSchema(WhatsAppConfigSchema), + config: { + listAccountIds: (cfg) => listWhatsAppAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveWhatsAppAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultWhatsAppAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => { + const accountKey = accountId || DEFAULT_ACCOUNT_ID; + const accounts = { ...cfg.channels?.whatsapp?.accounts }; + const existing = accounts[accountKey] ?? {}; + return { + ...cfg, + channels: { + ...cfg.channels, + whatsapp: { + ...cfg.channels?.whatsapp, + accounts: { + ...accounts, + [accountKey]: { + ...existing, + enabled, + }, + }, + }, + }, + }; + }, + deleteAccount: ({ cfg, accountId }) => { + const accountKey = accountId || DEFAULT_ACCOUNT_ID; + const accounts = { ...cfg.channels?.whatsapp?.accounts }; + delete accounts[accountKey]; + return { + ...cfg, + channels: { + ...cfg.channels, + whatsapp: { + ...cfg.channels?.whatsapp, + accounts: Object.keys(accounts).length ? accounts : undefined, + }, + }, + }; + }, + isEnabled: (account, cfg) => account.enabled && cfg.web?.enabled !== false, + disabledReason: () => "disabled", isConfigured: async (account) => await webAuthExists(account.authDir), - }), + unconfiguredReason: () => "not linked", + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: Boolean(account.authDir), + linked: Boolean(account.authDir), + dmPolicy: account.dmPolicy, + allowFrom: account.allowFrom, + }), + resolveAllowFrom: ({ cfg, accountId }) => resolveWhatsAppConfigAllowFrom({ cfg, accountId }), + formatAllowFrom: ({ allowFrom }) => formatWhatsAppConfigAllowFromEntries(allowFrom), + resolveDefaultTo: ({ cfg, accountId }) => resolveWhatsAppConfigDefaultTo({ cfg, accountId }), + }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => + buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "whatsapp", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.dmPolicy, + allowFrom: account.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + normalizeEntry: (raw) => normalizeE164(raw), + }), + collectWarnings: ({ account, cfg }) => { + const groupAllowlistConfigured = + Boolean(account.groups) && Object.keys(account.groups ?? {}).length > 0; + return collectAllowlistProviderGroupPolicyWarnings({ + cfg, + providerConfigPresent: cfg.channels?.whatsapp !== undefined, + configuredGroupPolicy: account.groupPolicy, + collect: (groupPolicy) => + collectOpenGroupPolicyRouteAllowlistWarnings({ + groupPolicy, + routeAllowlistConfigured: groupAllowlistConfigured, + restrictSenders: { + surface: "WhatsApp groups", + openScope: "any member in allowed groups", + groupPolicyPath: "channels.whatsapp.groupPolicy", + groupAllowFromPath: "channels.whatsapp.groupAllowFrom", + }, + noRouteAllowlist: { + surface: "WhatsApp groups", + routeAllowlistPath: "channels.whatsapp.groups", + routeScope: "group", + groupPolicyPath: "channels.whatsapp.groupPolicy", + groupAllowFromPath: "channels.whatsapp.groupAllowFrom", + }, + }), + }); + }, + }, + setup: whatsappSetupAdapter, + groups: { + resolveRequireMention: resolveWhatsAppGroupRequireMention, + resolveToolPolicy: resolveWhatsAppGroupToolPolicy, + resolveGroupIntroHint: resolveWhatsAppGroupIntroHint, + }, }; diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 6fe1663e55f..4701c80070b 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -1,34 +1,45 @@ -import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/compat"; +import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; import { + buildAccountScopedDmSecurityPolicy, + buildChannelConfigSchema, + collectAllowlistProviderGroupPolicyWarnings, + collectOpenGroupPolicyRouteAllowlistWarnings, createActionGate, createWhatsAppOutboundBase, DEFAULT_ACCOUNT_ID, + getChatChannelMeta, listWhatsAppDirectoryGroupsFromConfig, listWhatsAppDirectoryPeersFromConfig, + normalizeE164, formatWhatsAppConfigAllowFromEntries, readStringParam, resolveWhatsAppOutboundTarget, + resolveWhatsAppConfigAllowFrom, + resolveWhatsAppConfigDefaultTo, + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupIntroHint, + resolveWhatsAppGroupToolPolicy, resolveWhatsAppHeartbeatRecipients, resolveWhatsAppMentionStripRegexes, + WhatsAppConfigSchema, type ChannelMessageActionName, type ChannelPlugin, } from "openclaw/plugin-sdk/whatsapp"; -import { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "../../../src/whatsapp/normalize.js"; +import { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "openclaw/plugin-sdk/whatsapp"; // WhatsApp-specific imports from local extension code (moved from src/web/ and src/channels/plugins/) -import { resolveWhatsAppAccount, type ResolvedWhatsAppAccount } from "./accounts.js"; +import { + listWhatsAppAccountIds, + resolveDefaultWhatsAppAccountId, + resolveWhatsAppAccount, + type ResolvedWhatsAppAccount, +} from "./accounts.js"; import { looksLikeWhatsAppTargetId, normalizeWhatsAppMessagingTarget } from "./normalize.js"; +import { whatsappSetupWizardProxy } from "./plugin-shared.js"; import { getWhatsAppRuntime } from "./runtime.js"; import { whatsappSetupAdapter } from "./setup-core.js"; -import { - createWhatsAppPluginBase, - createWhatsAppSetupWizardProxy, - WHATSAPP_CHANNEL, -} from "./shared.js"; import { collectWhatsAppStatusIssues } from "./status-issues.js"; -async function loadWhatsAppChannelRuntime() { - return await import("./channel.runtime.js"); -} +const meta = getChatChannelMeta("whatsapp"); function normalizeWhatsAppPayloadText(text: string | undefined): string { return (text ?? "").replace(/^(?:[ \t]*\r?\n)+/, ""); @@ -45,21 +56,87 @@ function parseWhatsAppExplicitTarget(raw: string) { }; } -const whatsappSetupWizardProxy = createWhatsAppSetupWizardProxy(async () => ({ - whatsappSetupWizard: (await loadWhatsAppChannelRuntime()).whatsappSetupWizard, -})); - export const whatsappPlugin: ChannelPlugin = { - ...createWhatsAppPluginBase({ - setupWizard: whatsappSetupWizardProxy, - setup: whatsappSetupAdapter, - isConfigured: async (account) => - await getWhatsAppRuntime().channel.whatsapp.webAuthExists(account.authDir), - }), + id: "whatsapp", + meta: { + ...meta, + showConfigured: false, + quickstartAllowFrom: true, + forceAccountBinding: true, + preferSessionLookupForAnnounceTarget: true, + }, + setupWizard: whatsappSetupWizardProxy, agentTools: () => [getWhatsAppRuntime().channel.whatsapp.createLoginTool()], pairing: { idLabel: "whatsappSenderId", }, + capabilities: { + chatTypes: ["direct", "group"], + polls: true, + reactions: true, + media: true, + }, + reload: { configPrefixes: ["web"], noopPrefixes: ["channels.whatsapp"] }, + gatewayMethods: ["web.login.start", "web.login.wait"], + configSchema: buildChannelConfigSchema(WhatsAppConfigSchema), + config: { + listAccountIds: (cfg) => listWhatsAppAccountIds(cfg), + resolveAccount: (cfg, accountId) => resolveWhatsAppAccount({ cfg, accountId }), + defaultAccountId: (cfg) => resolveDefaultWhatsAppAccountId(cfg), + setAccountEnabled: ({ cfg, accountId, enabled }) => { + const accountKey = accountId || DEFAULT_ACCOUNT_ID; + const accounts = { ...cfg.channels?.whatsapp?.accounts }; + const existing = accounts[accountKey] ?? {}; + return { + ...cfg, + channels: { + ...cfg.channels, + whatsapp: { + ...cfg.channels?.whatsapp, + accounts: { + ...accounts, + [accountKey]: { + ...existing, + enabled, + }, + }, + }, + }, + }; + }, + deleteAccount: ({ cfg, accountId }) => { + const accountKey = accountId || DEFAULT_ACCOUNT_ID; + const accounts = { ...cfg.channels?.whatsapp?.accounts }; + delete accounts[accountKey]; + return { + ...cfg, + channels: { + ...cfg.channels, + whatsapp: { + ...cfg.channels?.whatsapp, + accounts: Object.keys(accounts).length ? accounts : undefined, + }, + }, + }; + }, + isEnabled: (account, cfg) => account.enabled && cfg.web?.enabled !== false, + disabledReason: () => "disabled", + isConfigured: async (account) => + await getWhatsAppRuntime().channel.whatsapp.webAuthExists(account.authDir), + unconfiguredReason: () => "not linked", + describeAccount: (account) => ({ + accountId: account.accountId, + name: account.name, + enabled: account.enabled, + configured: Boolean(account.authDir), + linked: Boolean(account.authDir), + dmPolicy: account.dmPolicy, + allowFrom: account.allowFrom, + }), + resolveAllowFrom: ({ cfg, accountId }) => resolveWhatsAppConfigAllowFrom({ cfg, accountId }), + formatAllowFrom: ({ allowFrom }) => formatWhatsAppConfigAllowFromEntries(allowFrom), + resolveDefaultTo: ({ cfg, accountId }) => resolveWhatsAppConfigDefaultTo({ cfg, accountId }), + }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { @@ -80,6 +157,53 @@ export const whatsappPlugin: ChannelPlugin = { }), }), }, + security: { + resolveDmPolicy: ({ cfg, accountId, account }) => { + return buildAccountScopedDmSecurityPolicy({ + cfg, + channelKey: "whatsapp", + accountId, + fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, + policy: account.dmPolicy, + allowFrom: account.allowFrom ?? [], + policyPathSuffix: "dmPolicy", + normalizeEntry: (raw) => normalizeE164(raw), + }); + }, + collectWarnings: ({ account, cfg }) => { + const groupAllowlistConfigured = + Boolean(account.groups) && Object.keys(account.groups ?? {}).length > 0; + return collectAllowlistProviderGroupPolicyWarnings({ + cfg, + providerConfigPresent: cfg.channels?.whatsapp !== undefined, + configuredGroupPolicy: account.groupPolicy, + collect: (groupPolicy) => + collectOpenGroupPolicyRouteAllowlistWarnings({ + groupPolicy, + routeAllowlistConfigured: groupAllowlistConfigured, + restrictSenders: { + surface: "WhatsApp groups", + openScope: "any member in allowed groups", + groupPolicyPath: "channels.whatsapp.groupPolicy", + groupAllowFromPath: "channels.whatsapp.groupAllowFrom", + }, + noRouteAllowlist: { + surface: "WhatsApp groups", + routeAllowlistPath: "channels.whatsapp.groups", + routeScope: "group", + groupPolicyPath: "channels.whatsapp.groupPolicy", + groupAllowFromPath: "channels.whatsapp.groupAllowFrom", + }, + }), + }); + }, + }, + setup: whatsappSetupAdapter, + groups: { + resolveRequireMention: resolveWhatsAppGroupRequireMention, + resolveToolPolicy: resolveWhatsAppGroupToolPolicy, + resolveGroupIntroHint: resolveWhatsAppGroupIntroHint, + }, mentions: { stripRegexes: ({ ctx }) => resolveWhatsAppMentionStripRegexes(ctx), }, @@ -132,7 +256,7 @@ export const whatsappPlugin: ChannelPlugin = { supportsAction: ({ action }) => action === "react", handleAction: async ({ action, params, cfg, accountId }) => { if (action !== "react") { - throw new Error(`Action ${action} is not supported for provider ${WHATSAPP_CHANNEL}.`); + throw new Error(`Action ${action} is not supported for provider ${meta.id}.`); } const messageId = readStringParam(params, "messageId", { required: true, diff --git a/extensions/whatsapp/src/inbound/access-control.test-harness.ts b/extensions/whatsapp/src/inbound/access-control.test-harness.ts index a8bf7a9df19..495615a3cbb 100644 --- a/extensions/whatsapp/src/inbound/access-control.test-harness.ts +++ b/extensions/whatsapp/src/inbound/access-control.test-harness.ts @@ -33,15 +33,15 @@ export function setupAccessControlTestHarness(): void { }); } -vi.mock("../../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => config, }; }); -vi.mock("../../../../src/pairing/pairing-store.js", () => ({ +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: (...args: unknown[]) => readAllowFromStoreMock(...args), upsertChannelPairingRequest: (...args: unknown[]) => upsertPairingRequestMock(...args), })); diff --git a/extensions/whatsapp/src/inbound/access-control.ts b/extensions/whatsapp/src/inbound/access-control.ts index ee81e119392..2c57abe8bbf 100644 --- a/extensions/whatsapp/src/inbound/access-control.ts +++ b/extensions/whatsapp/src/inbound/access-control.ts @@ -1,17 +1,17 @@ -import { loadConfig } from "../../../../src/config/config.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import { resolveOpenProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce, -} from "../../../../src/config/runtime-group-policy.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { issuePairingChallenge } from "../../../../src/pairing/pairing-challenge.js"; -import { upsertChannelPairingRequest } from "../../../../src/pairing/pairing-store.js"; +} from "openclaw/plugin-sdk/config-runtime"; +import { issuePairingChallenge } from "openclaw/plugin-sdk/conversation-runtime"; +import { upsertChannelPairingRequest } from "openclaw/plugin-sdk/conversation-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { readStoreAllowFromForDmPolicy, resolveDmGroupAccessWithLists, -} from "../../../../src/security/dm-policy-shared.js"; -import { isSelfChatMode, normalizeE164 } from "../../../../src/utils.js"; +} from "openclaw/plugin-sdk/security-runtime"; +import { isSelfChatMode, normalizeE164 } from "openclaw/plugin-sdk/text-runtime"; import { resolveWhatsAppAccount } from "../accounts.js"; export type InboundAccessControlResult = { diff --git a/extensions/whatsapp/src/inbound/dedupe.ts b/extensions/whatsapp/src/inbound/dedupe.ts index 9d20a25b8c4..cfc74185519 100644 --- a/extensions/whatsapp/src/inbound/dedupe.ts +++ b/extensions/whatsapp/src/inbound/dedupe.ts @@ -1,4 +1,4 @@ -import { createDedupeCache } from "../../../../src/infra/dedupe.js"; +import { createDedupeCache } from "openclaw/plugin-sdk/infra-runtime"; const RECENT_WEB_MESSAGE_TTL_MS = 20 * 60_000; const RECENT_WEB_MESSAGE_MAX = 5000; diff --git a/extensions/whatsapp/src/inbound/extract.ts b/extensions/whatsapp/src/inbound/extract.ts index a34937c9793..9fa663847a6 100644 --- a/extensions/whatsapp/src/inbound/extract.ts +++ b/extensions/whatsapp/src/inbound/extract.ts @@ -4,9 +4,9 @@ import { getContentType, normalizeMessageContent, } from "@whiskeysockets/baileys"; -import { formatLocationText, type NormalizedLocation } from "../../../../src/channels/location.js"; -import { logVerbose } from "../../../../src/globals.js"; -import { jidToE164 } from "../../../../src/utils.js"; +import { formatLocationText, type NormalizedLocation } from "openclaw/plugin-sdk/channel-runtime"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { jidToE164 } from "openclaw/plugin-sdk/text-runtime"; import { parseVcard } from "../vcard.js"; function unwrapMessage(message: proto.IMessage | undefined): proto.IMessage | undefined { diff --git a/extensions/whatsapp/src/inbound/media.ts b/extensions/whatsapp/src/inbound/media.ts index 9f2fe70698a..128b4d945d5 100644 --- a/extensions/whatsapp/src/inbound/media.ts +++ b/extensions/whatsapp/src/inbound/media.ts @@ -1,6 +1,6 @@ import type { proto, WAMessage } from "@whiskeysockets/baileys"; import { downloadMediaMessage, normalizeMessageContent } from "@whiskeysockets/baileys"; -import { logVerbose } from "../../../../src/globals.js"; +import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import type { createWaSocket } from "../session.js"; function unwrapMessage(message: proto.IMessage | undefined): proto.IMessage | undefined { diff --git a/extensions/whatsapp/src/inbound/monitor.ts b/extensions/whatsapp/src/inbound/monitor.ts index 5337c5d6a43..35669bc1b49 100644 --- a/extensions/whatsapp/src/inbound/monitor.ts +++ b/extensions/whatsapp/src/inbound/monitor.ts @@ -1,13 +1,13 @@ import type { AnyMessageContent, proto, WAMessage } from "@whiskeysockets/baileys"; import { DisconnectReason, isJidGroup } from "@whiskeysockets/baileys"; -import { createInboundDebouncer } from "../../../../src/auto-reply/inbound-debounce.js"; -import { formatLocationText } from "../../../../src/channels/location.js"; -import { logVerbose, shouldLogVerbose } from "../../../../src/globals.js"; -import { recordChannelActivity } from "../../../../src/infra/channel-activity.js"; -import { getChildLogger } from "../../../../src/logging/logger.js"; -import { createSubsystemLogger } from "../../../../src/logging/subsystem.js"; -import { saveMediaBuffer } from "../../../../src/media/store.js"; -import { jidToE164, resolveJidToE164 } from "../../../../src/utils.js"; +import { formatLocationText } from "openclaw/plugin-sdk/channel-runtime"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import { saveMediaBuffer } from "openclaw/plugin-sdk/media-runtime"; +import { createInboundDebouncer } from "openclaw/plugin-sdk/reply-runtime"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/text-runtime"; +import { jidToE164, resolveJidToE164 } from "openclaw/plugin-sdk/text-runtime"; import { createWaSocket, getStatusCode, waitForWaConnection } from "../session.js"; import { checkInboundAccessControl } from "./access-control.js"; import { isRecentInboundMessage } from "./dedupe.js"; diff --git a/extensions/whatsapp/src/inbound/send-api.ts b/extensions/whatsapp/src/inbound/send-api.ts index a5619383415..bb0761431f7 100644 --- a/extensions/whatsapp/src/inbound/send-api.ts +++ b/extensions/whatsapp/src/inbound/send-api.ts @@ -1,6 +1,6 @@ import type { AnyMessageContent, WAPresence } from "@whiskeysockets/baileys"; -import { recordChannelActivity } from "../../../../src/infra/channel-activity.js"; -import { toWhatsappJid } from "../../../../src/utils.js"; +import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; +import { toWhatsappJid } from "openclaw/plugin-sdk/text-runtime"; import type { ActiveWebSendOptions } from "../active-listener.js"; function recordWhatsAppOutbound(accountId: string) { diff --git a/extensions/whatsapp/src/inbound/types.ts b/extensions/whatsapp/src/inbound/types.ts index c9c97810bad..42e4b5121d1 100644 --- a/extensions/whatsapp/src/inbound/types.ts +++ b/extensions/whatsapp/src/inbound/types.ts @@ -1,5 +1,5 @@ import type { AnyMessageContent } from "@whiskeysockets/baileys"; -import type { NormalizedLocation } from "../../../../src/channels/location.js"; +import type { NormalizedLocation } from "openclaw/plugin-sdk/channel-runtime"; export type WebListenerCloseReason = { status?: number; diff --git a/extensions/whatsapp/src/login-qr.ts b/extensions/whatsapp/src/login-qr.ts index 3681d646252..352cf6e86b6 100644 --- a/extensions/whatsapp/src/login-qr.ts +++ b/extensions/whatsapp/src/login-qr.ts @@ -1,9 +1,9 @@ import { randomUUID } from "node:crypto"; import { DisconnectReason } from "@whiskeysockets/baileys"; -import { loadConfig } from "../../../src/config/config.js"; -import { danger, info, success } from "../../../src/globals.js"; -import { logInfo } from "../../../src/logger.js"; -import { defaultRuntime, type RuntimeEnv } from "../../../src/runtime.js"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { danger, info, success } from "openclaw/plugin-sdk/runtime-env"; +import { defaultRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { logInfo } from "openclaw/plugin-sdk/text-runtime"; import { resolveWhatsAppAccount } from "./accounts.js"; import { renderQrPngBase64 } from "./qr-image.js"; import { diff --git a/extensions/whatsapp/src/login.ts b/extensions/whatsapp/src/login.ts index 0923a38a122..43c16e1d298 100644 --- a/extensions/whatsapp/src/login.ts +++ b/extensions/whatsapp/src/login.ts @@ -1,9 +1,9 @@ import { DisconnectReason } from "@whiskeysockets/baileys"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { loadConfig } from "../../../src/config/config.js"; -import { danger, info, success } from "../../../src/globals.js"; -import { logInfo } from "../../../src/logger.js"; -import { defaultRuntime, type RuntimeEnv } from "../../../src/runtime.js"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; +import { danger, info, success } from "openclaw/plugin-sdk/runtime-env"; +import { defaultRuntime, type RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import { logInfo } from "openclaw/plugin-sdk/text-runtime"; import { resolveWhatsAppAccount } from "./accounts.js"; import { createWaSocket, diff --git a/extensions/whatsapp/src/media.ts b/extensions/whatsapp/src/media.ts index 2b297ef8907..33339451ec8 100644 --- a/extensions/whatsapp/src/media.ts +++ b/extensions/whatsapp/src/media.ts @@ -1,20 +1,20 @@ import fs from "node:fs/promises"; import path from "node:path"; import { fileURLToPath } from "node:url"; -import { logVerbose, shouldLogVerbose } from "../../../src/globals.js"; -import { SafeOpenError, readLocalFileSafely } from "../../../src/infra/fs-safe.js"; -import type { SsrFPolicy } from "../../../src/infra/net/ssrf.js"; -import { type MediaKind, maxBytesForKind } from "../../../src/media/constants.js"; -import { fetchRemoteMedia } from "../../../src/media/fetch.js"; +import { SafeOpenError, readLocalFileSafely } from "openclaw/plugin-sdk/infra-runtime"; +import type { SsrFPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { type MediaKind, maxBytesForKind } from "openclaw/plugin-sdk/media-runtime"; +import { fetchRemoteMedia } from "openclaw/plugin-sdk/media-runtime"; import { convertHeicToJpeg, hasAlphaChannel, optimizeImageToPng, resizeToJpeg, -} from "../../../src/media/image-ops.js"; -import { getDefaultMediaLocalRoots } from "../../../src/media/local-roots.js"; -import { detectMime, extensionForMime, kindFromMime } from "../../../src/media/mime.js"; -import { resolveUserPath } from "../../../src/utils.js"; +} from "openclaw/plugin-sdk/media-runtime"; +import { getDefaultMediaLocalRoots } from "openclaw/plugin-sdk/media-runtime"; +import { detectMime, extensionForMime, kindFromMime } from "openclaw/plugin-sdk/media-runtime"; +import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolveUserPath } from "openclaw/plugin-sdk/text-runtime"; export type WebMediaResult = { buffer: Buffer; diff --git a/extensions/whatsapp/src/monitor-inbox.test-harness.ts b/extensions/whatsapp/src/monitor-inbox.test-harness.ts index 43bc731c459..3aefaf7a4f1 100644 --- a/extensions/whatsapp/src/monitor-inbox.test-harness.ts +++ b/extensions/whatsapp/src/monitor-inbox.test-harness.ts @@ -2,8 +2,8 @@ import { EventEmitter } from "node:events"; import fsSync from "node:fs"; import os from "node:os"; import path from "node:path"; +import { resetLogger, setLoggerOverride } from "openclaw/plugin-sdk/runtime-env"; import { afterEach, beforeEach, expect, vi } from "vitest"; -import { resetLogger, setLoggerOverride } from "../../../src/logging.js"; // Avoid exporting vitest mock types (TS2742 under pnpm + d.ts emit). // oxlint-disable-next-line typescript/no-explicit-any @@ -81,8 +81,8 @@ function getPairingStoreMocks() { const sock: MockSock = createMockSock(); -vi.mock("../../../src/media/store.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/media-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, saveMediaBuffer: vi.fn().mockResolvedValue({ @@ -94,15 +94,15 @@ vi.mock("../../../src/media/store.js", async (importOriginal) => { }; }); -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => mockLoadConfig(), }; }); -vi.mock("../../../src/pairing/pairing-store.js", () => getPairingStoreMocks()); +vi.mock("openclaw/plugin-sdk/conversation-runtime", () => getPairingStoreMocks()); vi.mock("./session.js", () => ({ createWaSocket: vi.fn().mockResolvedValue(sock), diff --git a/extensions/whatsapp/src/normalize.ts b/extensions/whatsapp/src/normalize.ts index 82ee5d8296d..bfecb31e4a5 100644 --- a/extensions/whatsapp/src/normalize.ts +++ b/extensions/whatsapp/src/normalize.ts @@ -2,4 +2,4 @@ export { looksLikeWhatsAppTargetId, normalizeWhatsAppAllowFromEntries, normalizeWhatsAppMessagingTarget, -} from "../../../src/channels/plugins/normalize/whatsapp.js"; +} from "openclaw/plugin-sdk/channel-runtime"; diff --git a/extensions/whatsapp/src/outbound-adapter.ts b/extensions/whatsapp/src/outbound-adapter.ts index ba84e336d0e..0cd0290e913 100644 --- a/extensions/whatsapp/src/outbound-adapter.ts +++ b/extensions/whatsapp/src/outbound-adapter.ts @@ -1,9 +1,9 @@ -import { chunkText } from "../../../src/auto-reply/chunk.js"; -import { sendTextMediaPayload } from "../../../src/channels/plugins/outbound/direct-text-media.js"; -import type { ChannelOutboundAdapter } from "../../../src/channels/plugins/types.js"; -import { shouldLogVerbose } from "../../../src/globals.js"; -import { resolveOutboundSendDep } from "../../../src/infra/outbound/send-deps.js"; -import { resolveWhatsAppOutboundTarget } from "../../../src/whatsapp/resolve-outbound-target.js"; +import { sendTextMediaPayload } from "openclaw/plugin-sdk/channel-runtime"; +import type { ChannelOutboundAdapter } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { chunkText } from "openclaw/plugin-sdk/reply-runtime"; +import { shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; +import { resolveWhatsAppOutboundTarget } from "openclaw/plugin-sdk/whatsapp"; import { sendMessageWhatsApp, sendPollWhatsApp } from "./send.js"; function trimLeadingWhitespace(text: string | undefined): string { diff --git a/extensions/whatsapp/src/plugin-shared.ts b/extensions/whatsapp/src/plugin-shared.ts index 1ab5d80220c..96a5f86e6f9 100644 --- a/extensions/whatsapp/src/plugin-shared.ts +++ b/extensions/whatsapp/src/plugin-shared.ts @@ -1,4 +1,4 @@ -import { type ChannelPlugin } from "../../../src/plugin-sdk-internal/whatsapp.js"; +import type { ChannelPlugin } from "openclaw/plugin-sdk/whatsapp"; import { type ResolvedWhatsAppAccount } from "./accounts.js"; async function loadWhatsAppChannelRuntime() { diff --git a/extensions/whatsapp/src/qr-image.ts b/extensions/whatsapp/src/qr-image.ts index d4d8b9c7b2f..be6b10f5b0e 100644 --- a/extensions/whatsapp/src/qr-image.ts +++ b/extensions/whatsapp/src/qr-image.ts @@ -1,6 +1,6 @@ +import { encodePngRgba, fillPixel } from "openclaw/plugin-sdk/media-runtime"; import QRCodeModule from "qrcode-terminal/vendor/QRCode/index.js"; import QRErrorCorrectLevelModule from "qrcode-terminal/vendor/QRCode/QRErrorCorrectLevel.js"; -import { encodePngRgba, fillPixel } from "../../../src/media/png-encode.js"; type QRCodeConstructor = new ( typeNumber: number, diff --git a/extensions/whatsapp/src/reconnect.ts b/extensions/whatsapp/src/reconnect.ts index d99ddf98ad6..e5e34888cef 100644 --- a/extensions/whatsapp/src/reconnect.ts +++ b/extensions/whatsapp/src/reconnect.ts @@ -1,8 +1,8 @@ import { randomUUID } from "node:crypto"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { BackoffPolicy } from "../../../src/infra/backoff.js"; -import { computeBackoff, sleepWithAbort } from "../../../src/infra/backoff.js"; -import { clamp } from "../../../src/utils.js"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import type { BackoffPolicy } from "openclaw/plugin-sdk/infra-runtime"; +import { computeBackoff, sleepWithAbort } from "openclaw/plugin-sdk/infra-runtime"; +import { clamp } from "openclaw/plugin-sdk/text-runtime"; export type ReconnectPolicy = BackoffPolicy & { maxAttempts: number; diff --git a/extensions/whatsapp/src/runtime.ts b/extensions/whatsapp/src/runtime.ts index e103cc878f0..8fc8b9e7ed9 100644 --- a/extensions/whatsapp/src/runtime.ts +++ b/extensions/whatsapp/src/runtime.ts @@ -1,7 +1,5 @@ -import { - createPluginRuntimeStore, - type PluginRuntime, -} from "../../../src/plugin-sdk-internal/core.js"; +import type { PluginRuntime } from "openclaw/plugin-sdk/core"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setWhatsAppRuntime, getRuntime: getWhatsAppRuntime } = createPluginRuntimeStore("WhatsApp runtime not initialized"); diff --git a/extensions/whatsapp/src/send.ts b/extensions/whatsapp/src/send.ts index 4ac9c03faf4..c59c5dd2008 100644 --- a/extensions/whatsapp/src/send.ts +++ b/extensions/whatsapp/src/send.ts @@ -1,13 +1,13 @@ -import { loadConfig, type OpenClawConfig } from "../../../src/config/config.js"; -import { resolveMarkdownTableMode } from "../../../src/config/markdown-tables.js"; -import { generateSecureUuid } from "../../../src/infra/secure-random.js"; -import { getChildLogger } from "../../../src/logging/logger.js"; -import { redactIdentifier } from "../../../src/logging/redact-identifier.js"; -import { createSubsystemLogger } from "../../../src/logging/subsystem.js"; -import { convertMarkdownTables } from "../../../src/markdown/tables.js"; -import { markdownToWhatsApp } from "../../../src/markdown/whatsapp.js"; -import { normalizePollInput, type PollInput } from "../../../src/polls.js"; -import { toWhatsappJid } from "../../../src/utils.js"; +import { loadConfig, type OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { generateSecureUuid } from "openclaw/plugin-sdk/infra-runtime"; +import { normalizePollInput, type PollInput } from "openclaw/plugin-sdk/media-runtime"; +import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger } from "openclaw/plugin-sdk/text-runtime"; +import { redactIdentifier } from "openclaw/plugin-sdk/text-runtime"; +import { convertMarkdownTables } from "openclaw/plugin-sdk/text-runtime"; +import { markdownToWhatsApp } from "openclaw/plugin-sdk/text-runtime"; +import { toWhatsappJid } from "openclaw/plugin-sdk/text-runtime"; import { resolveWhatsAppAccount, resolveWhatsAppMediaMaxBytes } from "./accounts.js"; import { type ActiveWebSendOptions, requireActiveWebListener } from "./active-listener.js"; import { loadWebMedia } from "./media.js"; diff --git a/extensions/whatsapp/src/session.ts b/extensions/whatsapp/src/session.ts index 8fc7f9fd1fc..80690b110eb 100644 --- a/extensions/whatsapp/src/session.ts +++ b/extensions/whatsapp/src/session.ts @@ -7,12 +7,12 @@ import { makeWASocket, useMultiFileAuthState, } from "@whiskeysockets/baileys"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; +import { VERSION } from "openclaw/plugin-sdk/cli-runtime"; +import { danger, success } from "openclaw/plugin-sdk/runtime-env"; +import { getChildLogger, toPinoLikeLogger } from "openclaw/plugin-sdk/runtime-env"; +import { ensureDir, resolveUserPath } from "openclaw/plugin-sdk/text-runtime"; import qrcode from "qrcode-terminal"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { danger, success } from "../../../src/globals.js"; -import { getChildLogger, toPinoLikeLogger } from "../../../src/logging.js"; -import { ensureDir, resolveUserPath } from "../../../src/utils.js"; -import { VERSION } from "../../../src/version.js"; import { maybeRestoreCredsFromBackup, readCredsJsonRaw, diff --git a/extensions/whatsapp/src/setup-core.ts b/extensions/whatsapp/src/setup-core.ts index 346c9aa0e8d..e7a11eedbf6 100644 --- a/extensions/whatsapp/src/setup-core.ts +++ b/extensions/whatsapp/src/setup-core.ts @@ -1,12 +1,52 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/plugin-sdk-internal/setup.js"; +import { + applyAccountNameToChannelSection, + type ChannelSetupAdapter, + migrateBaseNameToDefaultAccount, + normalizeAccountId, +} from "openclaw/plugin-sdk/setup"; const channel = "whatsapp" as const; -export const whatsappSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ - channelKey: channel, - alwaysUseAccounts: true, - buildPatch: (input) => ({ - ...(input.authDir ? { authDir: input.authDir } : {}), - }), -}); +export const whatsappSetupAdapter: ChannelSetupAdapter = { + resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), + applyAccountName: ({ cfg, accountId, name }) => + applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name, + alwaysUseAccounts: true, + }), + applyAccountConfig: ({ cfg, accountId, input }) => { + const namedConfig = applyAccountNameToChannelSection({ + cfg, + channelKey: channel, + accountId, + name: input.name, + alwaysUseAccounts: true, + }); + const next = migrateBaseNameToDefaultAccount({ + cfg: namedConfig, + channelKey: channel, + alwaysUseAccounts: true, + }); + const entry = { + ...next.channels?.whatsapp?.accounts?.[accountId], + ...(input.authDir ? { authDir: input.authDir } : {}), + enabled: true, + }; + return { + ...next, + channels: { + ...next.channels, + whatsapp: { + ...next.channels?.whatsapp, + accounts: { + ...next.channels?.whatsapp?.accounts, + [accountId]: entry, + }, + }, + }, + }; + }, +}; diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index 47e84de6860..bb87fc5b962 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -9,10 +9,10 @@ import { pathExists, splitSetupEntries, setSetupChannelEnabled, - type DmPolicy, type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/setup.js"; -import type { ChannelSetupWizard } from "../../../src/plugin-sdk-internal/setup.js"; +} from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { type DmPolicy } from "openclaw/plugin-sdk/whatsapp"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; import { whatsappSetupAdapter } from "./setup-core.js"; diff --git a/extensions/whatsapp/src/status-issues.ts b/extensions/whatsapp/src/status-issues.ts index bddd6dd7d9d..f369ba29cda 100644 --- a/extensions/whatsapp/src/status-issues.ts +++ b/extensions/whatsapp/src/status-issues.ts @@ -2,12 +2,12 @@ import { asString, collectIssuesForEnabledAccounts, isRecord, -} from "../../../src/channels/plugins/status-issues/shared.js"; +} from "openclaw/plugin-sdk/channel-runtime"; import type { ChannelAccountSnapshot, ChannelStatusIssue, -} from "../../../src/channels/plugins/types.js"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; +} from "openclaw/plugin-sdk/channel-runtime"; +import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; type WhatsAppAccountStatus = { accountId?: unknown; diff --git a/extensions/whatsapp/src/test-helpers.ts b/extensions/whatsapp/src/test-helpers.ts index b3289164463..bb2cd3d6fa0 100644 --- a/extensions/whatsapp/src/test-helpers.ts +++ b/extensions/whatsapp/src/test-helpers.ts @@ -30,8 +30,8 @@ export function resetLoadConfigMock() { (globalThis as Record)[CONFIG_KEY] = () => DEFAULT_CONFIG; } -vi.mock("../../../src/config/config.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/config-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, loadConfig: () => { @@ -51,7 +51,7 @@ vi.mock("../../config/config.js", async (importOriginal) => { // `../../config/config.js` is correct for modules under `src/web/auto-reply/*`. // For typing in this file (which lives in `src/web/*`), refer to the same module // via the local relative path. - const actual = await importOriginal(); + const actual = await importOriginal(); return { ...actual, loadConfig: () => { @@ -64,8 +64,8 @@ vi.mock("../../config/config.js", async (importOriginal) => { }; }); -vi.mock("../../../src/media/store.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/media-runtime", async (importOriginal) => { + const actual = await importOriginal(); const mockModule = Object.create(null) as Record; Object.defineProperties(mockModule, Object.getOwnPropertyDescriptors(actual)); Object.defineProperty(mockModule, "saveMediaBuffer", { diff --git a/extensions/xai/index.ts b/extensions/xai/index.ts index b5f6830fd2e..7771575795a 100644 --- a/extensions/xai/index.ts +++ b/extensions/xai/index.ts @@ -1,12 +1,11 @@ -import { normalizeProviderId } from "../../src/agents/provider-id.js"; +import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { normalizeProviderId } from "openclaw/plugin-sdk/provider-models"; import { createPluginBackedWebSearchProvider, getScopedCredentialValue, setScopedCredentialValue, -} from "../../src/agents/tools/web-search-plugin-factory.js"; -import { emptyPluginConfigSchema } from "../../src/plugins/config-schema.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; -import type { OpenClawPluginApi } from "../../src/plugins/types.js"; +} from "openclaw/plugin-sdk/provider-web-search"; import { applyXaiConfig, XAI_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "xai"; diff --git a/extensions/xai/onboard.ts b/extensions/xai/onboard.ts index ee5cfbc92cf..6abc7477e6c 100644 --- a/extensions/xai/onboard.ts +++ b/extensions/xai/onboard.ts @@ -1,16 +1,15 @@ -import { - applyAgentDefaultModelPrimary, - applyProviderConfigWithDefaultModel, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; import { buildXaiModelDefinition, XAI_BASE_URL, XAI_DEFAULT_MODEL_ID, - XAI_DEFAULT_MODEL_REF, -} from "./model-definitions.js"; +} from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + applyProviderConfigWithDefaultModel, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; -export { XAI_DEFAULT_MODEL_REF }; +export const XAI_DEFAULT_MODEL_REF = `xai/${XAI_DEFAULT_MODEL_ID}`; export function applyXaiProviderConfig(cfg: OpenClawConfig): OpenClawConfig { const models = { ...cfg.agents?.defaults?.models }; diff --git a/extensions/xiaomi/index.ts b/extensions/xiaomi/index.ts index 33eb6e47bf9..1badf6e2d9d 100644 --- a/extensions/xiaomi/index.ts +++ b/extensions/xiaomi/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { PROVIDER_LABELS } from "../../src/infra/provider-usage.shared.js"; -import { createProviderApiKeyAuthMethod } from "../../src/plugins/provider-api-key-auth.js"; +import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { PROVIDER_LABELS } from "openclaw/plugin-sdk/provider-usage"; import { applyXiaomiConfig, XIAOMI_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { buildXiaomiProvider } from "./provider-catalog.js"; diff --git a/extensions/xiaomi/onboard.ts b/extensions/xiaomi/onboard.ts index 3f3eef149c4..80d0ad1cd16 100644 --- a/extensions/xiaomi/onboard.ts +++ b/extensions/xiaomi/onboard.ts @@ -1,8 +1,8 @@ import { applyAgentDefaultModelPrimary, applyProviderConfigWithDefaultModels, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; import { buildXiaomiProvider, XIAOMI_DEFAULT_MODEL_ID } from "./provider-catalog.js"; export const XIAOMI_DEFAULT_MODEL_REF = `xiaomi/${XIAOMI_DEFAULT_MODEL_ID}`; diff --git a/extensions/xiaomi/provider-catalog.ts b/extensions/xiaomi/provider-catalog.ts index b62de84cf68..91329eeb87d 100644 --- a/extensions/xiaomi/provider-catalog.ts +++ b/extensions/xiaomi/provider-catalog.ts @@ -1,4 +1,4 @@ -import type { ModelProviderConfig } from "../../src/config/types.models.js"; +import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-models"; const XIAOMI_BASE_URL = "https://api.xiaomimimo.com/anthropic"; export const XIAOMI_DEFAULT_MODEL_ID = "mimo-v2-flash"; diff --git a/extensions/zai/detect.ts b/extensions/zai/detect.ts index 07f06a9f052..9bd1f25f50a 100644 --- a/extensions/zai/detect.ts +++ b/extensions/zai/detect.ts @@ -2,7 +2,7 @@ import { detectZaiEndpoint as detectZaiEndpointCore, type ZaiDetectedEndpoint, type ZaiEndpointId, -} from "../../src/commands/zai-endpoint-detect.js"; +} from "openclaw/plugin-sdk/zai"; type DetectZaiEndpointFn = typeof detectZaiEndpointCore; diff --git a/extensions/zai/index.ts b/extensions/zai/index.ts index 21ddc902902..0faef49c4fb 100644 --- a/extensions/zai/index.ts +++ b/extensions/zai/index.ts @@ -10,23 +10,21 @@ import { type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { upsertAuthProfile } from "../../src/agents/auth-profiles.js"; -import { DEFAULT_CONTEXT_TOKENS } from "../../src/agents/defaults.js"; -import { normalizeModelCompat } from "../../src/agents/model-compat.js"; -import { createZaiToolStreamWrapper } from "../../src/agents/pi-embedded-runner/zai-stream-wrappers.js"; +import { resolveRequiredHomeDir } from "openclaw/plugin-sdk/infra-runtime"; import { + applyAuthProfileConfig, + buildApiKeyCredential, + ensureApiKeyFromOptionEnvOrPrompt, normalizeApiKeyInput, + normalizeOptionalSecretInput, + type SecretInput, + upsertAuthProfile, validateApiKeyInput, -} from "../../src/commands/auth-choice.api-key.js"; -import { ensureApiKeyFromOptionEnvOrPrompt } from "../../src/commands/auth-choice.apply-helpers.js"; -import { buildApiKeyCredential } from "../../src/commands/auth-credentials.js"; -import { applyAuthProfileConfig } from "../../src/commands/onboard-auth.js"; -import type { SecretInput } from "../../src/config/types.secrets.js"; -import { resolveRequiredHomeDir } from "../../src/infra/home-dir.js"; -import { fetchZaiUsage } from "../../src/infra/provider-usage.fetch.js"; -import { normalizeOptionalSecretInput } from "../../src/utils/normalize-secret-input.js"; +} from "openclaw/plugin-sdk/provider-auth"; +import { DEFAULT_CONTEXT_TOKENS, normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; +import { createZaiToolStreamWrapper } from "openclaw/plugin-sdk/provider-stream"; +import { fetchZaiUsage } from "openclaw/plugin-sdk/provider-usage"; import { detectZaiEndpoint, type ZaiEndpointId } from "./detect.js"; -import { zaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyZaiConfig, applyZaiProviderConfig, ZAI_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "zai"; @@ -335,7 +333,6 @@ const zaiPlugin = { fetchUsageSnapshot: async (ctx) => await fetchZaiUsage(ctx.token, ctx.timeoutMs, ctx.fetchFn), isCacheTtlEligible: () => true, }); - api.registerMediaUnderstandingProvider(zaiMediaUnderstandingProvider); }, }; diff --git a/extensions/zai/onboard.ts b/extensions/zai/onboard.ts index a440387cf7b..f293e0f7632 100644 --- a/extensions/zai/onboard.ts +++ b/extensions/zai/onboard.ts @@ -1,16 +1,15 @@ -import { - applyAgentDefaultModelPrimary, - applyProviderConfigWithModelCatalog, -} from "../../src/commands/onboard-auth.config-shared.js"; -import type { OpenClawConfig } from "../../src/config/config.js"; import { buildZaiModelDefinition, resolveZaiBaseUrl, ZAI_DEFAULT_MODEL_ID, - ZAI_DEFAULT_MODEL_REF, -} from "./model-definitions.js"; +} from "openclaw/plugin-sdk/provider-models"; +import { + applyAgentDefaultModelPrimary, + applyProviderConfigWithModelCatalog, + type OpenClawConfig, +} from "openclaw/plugin-sdk/provider-onboard"; -export { ZAI_DEFAULT_MODEL_REF }; +export const ZAI_DEFAULT_MODEL_REF = `zai/${ZAI_DEFAULT_MODEL_ID}`; const ZAI_DEFAULT_MODELS = [ buildZaiModelDefinition({ id: "glm-5" }), diff --git a/package.json b/package.json index 95763eb8a0f..456603ea22c 100644 --- a/package.json +++ b/package.json @@ -70,10 +70,82 @@ "types": "./dist/plugin-sdk/routing.d.ts", "default": "./dist/plugin-sdk/routing.js" }, + "./plugin-sdk/runtime": { + "types": "./dist/plugin-sdk/runtime.d.ts", + "default": "./dist/plugin-sdk/runtime.js" + }, + "./plugin-sdk/runtime-env": { + "types": "./dist/plugin-sdk/runtime-env.d.ts", + "default": "./dist/plugin-sdk/runtime-env.js" + }, "./plugin-sdk/setup": { "types": "./dist/plugin-sdk/setup.d.ts", "default": "./dist/plugin-sdk/setup.js" }, + "./plugin-sdk/config-runtime": { + "types": "./dist/plugin-sdk/config-runtime.d.ts", + "default": "./dist/plugin-sdk/config-runtime.js" + }, + "./plugin-sdk/reply-runtime": { + "types": "./dist/plugin-sdk/reply-runtime.d.ts", + "default": "./dist/plugin-sdk/reply-runtime.js" + }, + "./plugin-sdk/channel-runtime": { + "types": "./dist/plugin-sdk/channel-runtime.d.ts", + "default": "./dist/plugin-sdk/channel-runtime.js" + }, + "./plugin-sdk/infra-runtime": { + "types": "./dist/plugin-sdk/infra-runtime.d.ts", + "default": "./dist/plugin-sdk/infra-runtime.js" + }, + "./plugin-sdk/media-runtime": { + "types": "./dist/plugin-sdk/media-runtime.d.ts", + "default": "./dist/plugin-sdk/media-runtime.js" + }, + "./plugin-sdk/conversation-runtime": { + "types": "./dist/plugin-sdk/conversation-runtime.d.ts", + "default": "./dist/plugin-sdk/conversation-runtime.js" + }, + "./plugin-sdk/text-runtime": { + "types": "./dist/plugin-sdk/text-runtime.d.ts", + "default": "./dist/plugin-sdk/text-runtime.js" + }, + "./plugin-sdk/agent-runtime": { + "types": "./dist/plugin-sdk/agent-runtime.d.ts", + "default": "./dist/plugin-sdk/agent-runtime.js" + }, + "./plugin-sdk/plugin-runtime": { + "types": "./dist/plugin-sdk/plugin-runtime.d.ts", + "default": "./dist/plugin-sdk/plugin-runtime.js" + }, + "./plugin-sdk/security-runtime": { + "types": "./dist/plugin-sdk/security-runtime.d.ts", + "default": "./dist/plugin-sdk/security-runtime.js" + }, + "./plugin-sdk/gateway-runtime": { + "types": "./dist/plugin-sdk/gateway-runtime.d.ts", + "default": "./dist/plugin-sdk/gateway-runtime.js" + }, + "./plugin-sdk/cli-runtime": { + "types": "./dist/plugin-sdk/cli-runtime.d.ts", + "default": "./dist/plugin-sdk/cli-runtime.js" + }, + "./plugin-sdk/hook-runtime": { + "types": "./dist/plugin-sdk/hook-runtime.d.ts", + "default": "./dist/plugin-sdk/hook-runtime.js" + }, + "./plugin-sdk/process-runtime": { + "types": "./dist/plugin-sdk/process-runtime.d.ts", + "default": "./dist/plugin-sdk/process-runtime.js" + }, + "./plugin-sdk/acp-runtime": { + "types": "./dist/plugin-sdk/acp-runtime.d.ts", + "default": "./dist/plugin-sdk/acp-runtime.js" + }, + "./plugin-sdk/zai": { + "types": "./dist/plugin-sdk/zai.d.ts", + "default": "./dist/plugin-sdk/zai.js" + }, "./plugin-sdk/telegram": { "types": "./dist/plugin-sdk/telegram.d.ts", "default": "./dist/plugin-sdk/telegram.js" @@ -230,10 +302,18 @@ "types": "./dist/plugin-sdk/account-id.d.ts", "default": "./dist/plugin-sdk/account-id.js" }, + "./plugin-sdk/account-resolution": { + "types": "./dist/plugin-sdk/account-resolution.d.ts", + "default": "./dist/plugin-sdk/account-resolution.js" + }, "./plugin-sdk/allow-from": { "types": "./dist/plugin-sdk/allow-from.d.ts", "default": "./dist/plugin-sdk/allow-from.js" }, + "./plugin-sdk/allowlist-config-edit": { + "types": "./dist/plugin-sdk/allowlist-config-edit.d.ts", + "default": "./dist/plugin-sdk/allowlist-config-edit.js" + }, "./plugin-sdk/boolean-param": { "types": "./dist/plugin-sdk/boolean-param.d.ts", "default": "./dist/plugin-sdk/boolean-param.js" @@ -254,10 +334,50 @@ "types": "./dist/plugin-sdk/keyed-async-queue.d.ts", "default": "./dist/plugin-sdk/keyed-async-queue.js" }, + "./plugin-sdk/provider-auth": { + "types": "./dist/plugin-sdk/provider-auth.d.ts", + "default": "./dist/plugin-sdk/provider-auth.js" + }, + "./plugin-sdk/provider-models": { + "types": "./dist/plugin-sdk/provider-models.d.ts", + "default": "./dist/plugin-sdk/provider-models.js" + }, + "./plugin-sdk/provider-onboard": { + "types": "./dist/plugin-sdk/provider-onboard.d.ts", + "default": "./dist/plugin-sdk/provider-onboard.js" + }, + "./plugin-sdk/provider-stream": { + "types": "./dist/plugin-sdk/provider-stream.d.ts", + "default": "./dist/plugin-sdk/provider-stream.js" + }, + "./plugin-sdk/provider-usage": { + "types": "./dist/plugin-sdk/provider-usage.d.ts", + "default": "./dist/plugin-sdk/provider-usage.js" + }, + "./plugin-sdk/provider-web-search": { + "types": "./dist/plugin-sdk/provider-web-search.d.ts", + "default": "./dist/plugin-sdk/provider-web-search.js" + }, "./plugin-sdk/request-url": { "types": "./dist/plugin-sdk/request-url.d.ts", "default": "./dist/plugin-sdk/request-url.js" }, + "./plugin-sdk/runtime-store": { + "types": "./dist/plugin-sdk/runtime-store.d.ts", + "default": "./dist/plugin-sdk/runtime-store.js" + }, + "./plugin-sdk/speech": { + "types": "./dist/plugin-sdk/speech.d.ts", + "default": "./dist/plugin-sdk/speech.js" + }, + "./plugin-sdk/state-paths": { + "types": "./dist/plugin-sdk/state-paths.d.ts", + "default": "./dist/plugin-sdk/state-paths.js" + }, + "./plugin-sdk/tool-send": { + "types": "./dist/plugin-sdk/tool-send.d.ts", + "default": "./dist/plugin-sdk/tool-send.js" + }, "./cli-entry": "./openclaw.mjs" }, "scripts": { diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index f99be019a69..e2de1d74f1f 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -7,7 +7,25 @@ "sandbox", "self-hosted-provider-setup", "routing", + "runtime", + "runtime-env", "setup", + "config-runtime", + "reply-runtime", + "channel-runtime", + "infra-runtime", + "media-runtime", + "conversation-runtime", + "text-runtime", + "agent-runtime", + "plugin-runtime", + "security-runtime", + "gateway-runtime", + "cli-runtime", + "hook-runtime", + "process-runtime", + "acp-runtime", + "zai", "telegram", "discord", "slack", @@ -47,11 +65,23 @@ "zalo", "zalouser", "account-id", + "account-resolution", "allow-from", + "allowlist-config-edit", "boolean-param", "channel-config-helpers", "group-access", "json-store", "keyed-async-queue", - "request-url" + "provider-auth", + "provider-models", + "provider-onboard", + "provider-stream", + "provider-usage", + "provider-web-search", + "request-url", + "runtime-store", + "speech", + "state-paths", + "tool-send" ] diff --git a/src/agents/pi-embedded-runner/compact.ts b/src/agents/pi-embedded-runner/compact.ts index ba001a6746a..4daef42a21f 100644 --- a/src/agents/pi-embedded-runner/compact.ts +++ b/src/agents/pi-embedded-runner/compact.ts @@ -19,11 +19,11 @@ import { createInternalHookEvent, triggerInternalHook } from "../../hooks/intern import { getMachineDisplayName } from "../../infra/machine-name.js"; import { generateSecureToken } from "../../infra/secure-random.js"; import { getMemorySearchManager } from "../../memory/index.js"; -import { resolveSignalReactionLevel } from "../../plugin-sdk-internal/signal.js"; +import { resolveSignalReactionLevel } from "../../plugin-sdk/signal.js"; import { resolveTelegramInlineButtonsScope, resolveTelegramReactionLevel, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; import { getGlobalHookRunner } from "../../plugins/hook-runner-global.js"; import { prepareProviderRuntimeAuth } from "../../plugins/provider-runtime.js"; import { type enqueueCommand, enqueueCommandInLane } from "../../process/command-queue.js"; diff --git a/src/agents/pi-embedded-runner/run/attempt.ts b/src/agents/pi-embedded-runner/run/attempt.ts index e8efa015137..0ea66825ff1 100644 --- a/src/agents/pi-embedded-runner/run/attempt.ts +++ b/src/agents/pi-embedded-runner/run/attempt.ts @@ -16,11 +16,11 @@ import { ensureGlobalUndiciStreamTimeouts, } from "../../../infra/net/undici-global-dispatcher.js"; import { MAX_IMAGE_BYTES } from "../../../media/constants.js"; -import { resolveSignalReactionLevel } from "../../../plugin-sdk-internal/signal.js"; +import { resolveSignalReactionLevel } from "../../../plugin-sdk/signal.js"; import { resolveTelegramInlineButtonsScope, resolveTelegramReactionLevel, -} from "../../../plugin-sdk-internal/telegram.js"; +} from "../../../plugin-sdk/telegram.js"; import { getGlobalHookRunner } from "../../../plugins/hook-runner-global.js"; import type { PluginHookAgentContext, diff --git a/src/agents/tools/discord-actions-guild.ts b/src/agents/tools/discord-actions-guild.ts index 54386ad4267..fa427d87650 100644 --- a/src/agents/tools/discord-actions-guild.ts +++ b/src/agents/tools/discord-actions-guild.ts @@ -19,8 +19,8 @@ import { setChannelPermissionDiscord, uploadEmojiDiscord, uploadStickerDiscord, -} from "../../plugin-sdk-internal/discord.js"; -import { getPresence } from "../../plugin-sdk-internal/discord.js"; +} from "../../plugin-sdk/discord.js"; +import { getPresence } from "../../plugin-sdk/discord.js"; import { type ActionGate, jsonResult, diff --git a/src/agents/tools/discord-actions-messaging.ts b/src/agents/tools/discord-actions-messaging.ts index 8a7f93aacbb..20fdfcc6a02 100644 --- a/src/agents/tools/discord-actions-messaging.ts +++ b/src/agents/tools/discord-actions-messaging.ts @@ -1,6 +1,7 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { DiscordActionConfig } from "../../config/config.js"; import type { OpenClawConfig } from "../../config/config.js"; +import { readBooleanParam } from "../../plugin-sdk/boolean-param.js"; import { createThreadDiscord, deleteMessageDiscord, @@ -22,16 +23,9 @@ import { sendStickerDiscord, sendVoiceMessageDiscord, unpinMessageDiscord, -} from "../../plugin-sdk-internal/discord.js"; -import type { - DiscordSendComponents, - DiscordSendEmbeds, -} from "../../plugin-sdk-internal/discord.js"; -import { - readDiscordComponentSpec, - resolveDiscordChannelId, -} from "../../plugin-sdk-internal/discord.js"; -import { readBooleanParam } from "../../plugin-sdk/boolean-param.js"; +} from "../../plugin-sdk/discord.js"; +import type { DiscordSendComponents, DiscordSendEmbeds } from "../../plugin-sdk/discord.js"; +import { readDiscordComponentSpec, resolveDiscordChannelId } from "../../plugin-sdk/discord.js"; import { resolvePollMaxSelections } from "../../polls.js"; import { withNormalizedTimestamp } from "../date-time.js"; import { assertMediaNotDataUrl } from "../sandbox-paths.js"; diff --git a/src/agents/tools/discord-actions-moderation.ts b/src/agents/tools/discord-actions-moderation.ts index 63c3cc601bc..56d7a80d4c9 100644 --- a/src/agents/tools/discord-actions-moderation.ts +++ b/src/agents/tools/discord-actions-moderation.ts @@ -5,7 +5,7 @@ import { hasAnyGuildPermissionDiscord, kickMemberDiscord, timeoutMemberDiscord, -} from "../../plugin-sdk-internal/discord.js"; +} from "../../plugin-sdk/discord.js"; import { type ActionGate, jsonResult, readStringParam } from "./common.js"; import { isDiscordModerationAction, diff --git a/src/agents/tools/discord-actions-presence.ts b/src/agents/tools/discord-actions-presence.ts index fdfa53e2323..53c42829bb0 100644 --- a/src/agents/tools/discord-actions-presence.ts +++ b/src/agents/tools/discord-actions-presence.ts @@ -1,7 +1,7 @@ import type { Activity, UpdatePresenceData } from "@buape/carbon/gateway"; import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { DiscordActionConfig } from "../../config/config.js"; -import { getGateway } from "../../plugin-sdk-internal/discord.js"; +import { getGateway } from "../../plugin-sdk/discord.js"; import { type ActionGate, jsonResult, readStringParam } from "./common.js"; const ACTIVITY_TYPE_MAP: Record = { diff --git a/src/agents/tools/discord-actions.ts b/src/agents/tools/discord-actions.ts index 0e380b8d383..b953e56cffd 100644 --- a/src/agents/tools/discord-actions.ts +++ b/src/agents/tools/discord-actions.ts @@ -1,6 +1,6 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { OpenClawConfig } from "../../config/config.js"; -import { createDiscordActionGate } from "../../plugin-sdk-internal/discord.js"; +import { createDiscordActionGate } from "../../plugin-sdk/discord.js"; import { readStringParam } from "./common.js"; import { handleDiscordGuildAction } from "./discord-actions-guild.js"; import { handleDiscordMessagingAction } from "./discord-actions-messaging.js"; diff --git a/src/agents/tools/slack-actions.ts b/src/agents/tools/slack-actions.ts index c7fc16ed8b1..e9089cbfdcc 100644 --- a/src/agents/tools/slack-actions.ts +++ b/src/agents/tools/slack-actions.ts @@ -15,14 +15,14 @@ import { removeSlackReaction, sendSlackMessage, unpinSlackMessage, -} from "../../plugin-sdk-internal/slack.js"; +} from "../../plugin-sdk/slack.js"; import { parseSlackBlocksInput, parseSlackTarget, recordSlackThreadParticipation, resolveSlackAccount, resolveSlackChannelId, -} from "../../plugin-sdk-internal/slack.js"; +} from "../../plugin-sdk/slack.js"; import { withNormalizedTimestamp } from "../date-time.js"; import { createActionGate, diff --git a/src/agents/tools/telegram-actions.ts b/src/agents/tools/telegram-actions.ts index 9f2d48831c3..d648b1e5f41 100644 --- a/src/agents/tools/telegram-actions.ts +++ b/src/agents/tools/telegram-actions.ts @@ -1,17 +1,15 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { OpenClawConfig } from "../../config/config.js"; +import { readBooleanParam } from "../../plugin-sdk/boolean-param.js"; import { createTelegramActionGate, resolveTelegramPollActionGateState, -} from "../../plugin-sdk-internal/telegram.js"; -import type { - TelegramButtonStyle, - TelegramInlineButtons, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; +import type { TelegramButtonStyle, TelegramInlineButtons } from "../../plugin-sdk/telegram.js"; import { resolveTelegramInlineButtonsScope, resolveTelegramTargetChatType, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; import { createForumTopicTelegram, deleteMessageTelegram, @@ -21,14 +19,13 @@ import { sendMessageTelegram, sendPollTelegram, sendStickerTelegram, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; import { getCacheStats, resolveTelegramReactionLevel, resolveTelegramToken, searchStickers, -} from "../../plugin-sdk-internal/telegram.js"; -import { readBooleanParam } from "../../plugin-sdk/boolean-param.js"; +} from "../../plugin-sdk/telegram.js"; import { resolvePollMaxSelections } from "../../polls.js"; import { jsonResult, diff --git a/src/agents/tools/whatsapp-actions.ts b/src/agents/tools/whatsapp-actions.ts index 30f36331d18..a84dc0a3d5b 100644 --- a/src/agents/tools/whatsapp-actions.ts +++ b/src/agents/tools/whatsapp-actions.ts @@ -1,6 +1,6 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { OpenClawConfig } from "../../config/config.js"; -import { sendReactionWhatsApp } from "../../plugin-sdk-internal/whatsapp.js"; +import { sendReactionWhatsApp } from "../../plugin-sdk/whatsapp.js"; import { createActionGate, jsonResult, readReactionParams, readStringParam } from "./common.js"; import { resolveAuthorizedWhatsAppOutboundTarget } from "./whatsapp-target-auth.js"; diff --git a/src/agents/tools/whatsapp-target-auth.ts b/src/agents/tools/whatsapp-target-auth.ts index 76e7e15d084..edc0052fbab 100644 --- a/src/agents/tools/whatsapp-target-auth.ts +++ b/src/agents/tools/whatsapp-target-auth.ts @@ -1,5 +1,5 @@ import type { OpenClawConfig } from "../../config/config.js"; -import { resolveWhatsAppAccount } from "../../plugin-sdk-internal/whatsapp.js"; +import { resolveWhatsAppAccount } from "../../plugin-sdk/whatsapp.js"; import { resolveWhatsAppOutboundTarget } from "../../whatsapp/resolve-outbound-target.js"; import { ToolAuthorizationError } from "./common.js"; diff --git a/src/auto-reply/reply/commands-approve.ts b/src/auto-reply/reply/commands-approve.ts index 5f259c1b45a..630ea988c05 100644 --- a/src/auto-reply/reply/commands-approve.ts +++ b/src/auto-reply/reply/commands-approve.ts @@ -3,7 +3,7 @@ import { logVerbose } from "../../globals.js"; import { isTelegramExecApprovalApprover, isTelegramExecApprovalClientEnabled, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; import { GATEWAY_CLIENT_MODES, GATEWAY_CLIENT_NAMES } from "../../utils/message-channel.js"; import { requireGatewayClientScopeForInternalChannel } from "./command-gates.js"; import type { CommandHandler } from "./commands-types.js"; diff --git a/src/auto-reply/reply/commands-models.ts b/src/auto-reply/reply/commands-models.ts index 99e02cfa81e..25f309361d2 100644 --- a/src/auto-reply/reply/commands-models.ts +++ b/src/auto-reply/reply/commands-models.ts @@ -16,7 +16,7 @@ import { calculateTotalPages, getModelsPageSize, type ProviderInfo, -} from "../../plugin-sdk-internal/telegram.js"; +} from "../../plugin-sdk/telegram.js"; import type { ReplyPayload } from "../types.js"; import { rejectUnauthorizedCommand } from "./command-gates.js"; import type { CommandHandler } from "./commands-types.js"; diff --git a/src/auto-reply/reply/directive-handling.model.ts b/src/auto-reply/reply/directive-handling.model.ts index d27bdb25d61..521d3bd6fea 100644 --- a/src/auto-reply/reply/directive-handling.model.ts +++ b/src/auto-reply/reply/directive-handling.model.ts @@ -8,7 +8,7 @@ import { } from "../../agents/model-selection.js"; import type { OpenClawConfig } from "../../config/config.js"; import type { SessionEntry } from "../../config/sessions.js"; -import { buildBrowseProvidersButton } from "../../plugin-sdk-internal/telegram.js"; +import { buildBrowseProvidersButton } from "../../plugin-sdk/telegram.js"; import { shortenHomePath } from "../../utils.js"; import { resolveSelectedAndActiveModel } from "../model-runtime.js"; import type { ReplyPayload } from "../types.js"; diff --git a/src/auto-reply/templating.ts b/src/auto-reply/templating.ts index b426b18eab5..a32fdc3ba87 100644 --- a/src/auto-reply/templating.ts +++ b/src/auto-reply/templating.ts @@ -3,7 +3,7 @@ import type { MediaUnderstandingDecision, MediaUnderstandingOutput, } from "../media-understanding/types.js"; -import type { StickerMetadata } from "../plugin-sdk-internal/telegram.js"; +import type { StickerMetadata } from "../plugin-sdk/telegram.js"; import type { InputProvenance } from "../sessions/input-provenance.js"; import type { InternalMessageChannel } from "../utils/message-channel.js"; import type { CommandArgs } from "./commands-registry.types.js"; diff --git a/src/channel-web.ts b/src/channel-web.ts index f7e451b142a..e6df4bda0d7 100644 --- a/src/channel-web.ts +++ b/src/channel-web.ts @@ -7,15 +7,11 @@ export { monitorWebChannel, resolveHeartbeatRecipients, runWebHeartbeatOnce, -} from "./plugin-sdk-internal/whatsapp.js"; -export { - extractMediaPlaceholder, - extractText, - monitorWebInbox, -} from "./plugin-sdk-internal/whatsapp.js"; -export { loginWeb } from "./plugin-sdk-internal/whatsapp.js"; -export { loadWebMedia, optimizeImageToJpeg } from "./plugin-sdk-internal/whatsapp.js"; -export { sendMessageWhatsApp } from "./plugin-sdk-internal/whatsapp.js"; +} from "./plugin-sdk/whatsapp.js"; +export { extractMediaPlaceholder, extractText, monitorWebInbox } from "./plugin-sdk/whatsapp.js"; +export { loginWeb } from "./plugin-sdk/whatsapp.js"; +export { loadWebMedia, optimizeImageToJpeg } from "./plugin-sdk/whatsapp.js"; +export { sendMessageWhatsApp } from "./plugin-sdk/whatsapp.js"; export { createWaSocket, formatError, @@ -26,4 +22,4 @@ export { WA_WEB_AUTH_DIR, waitForWaConnection, webAuthExists, -} from "./plugin-sdk-internal/whatsapp.js"; +} from "./plugin-sdk/whatsapp.js"; diff --git a/src/channels/plugins/actions/discord.ts b/src/channels/plugins/actions/discord.ts index ec11ca6c970..4615a88f3c5 100644 --- a/src/channels/plugins/actions/discord.ts +++ b/src/channels/plugins/actions/discord.ts @@ -1,2 +1,2 @@ // Public entrypoint for the Discord channel action adapter. -export * from "../../../plugin-sdk-internal/discord.js"; +export * from "../../../plugin-sdk/discord.js"; diff --git a/src/channels/plugins/actions/signal.ts b/src/channels/plugins/actions/signal.ts index 7db723f305e..60a70bac4c0 100644 --- a/src/channels/plugins/actions/signal.ts +++ b/src/channels/plugins/actions/signal.ts @@ -5,7 +5,7 @@ import { resolveSignalAccount, resolveSignalReactionLevel, sendReactionSignal, -} from "../../../plugin-sdk-internal/signal.js"; +} from "../../../plugin-sdk/signal.js"; import type { ChannelMessageActionAdapter, ChannelMessageActionName } from "../types.js"; import { resolveReactionMessageId } from "./reaction-message-id.js"; diff --git a/src/channels/plugins/actions/telegram.ts b/src/channels/plugins/actions/telegram.ts index e34c4598ade..e811e757b94 100644 --- a/src/channels/plugins/actions/telegram.ts +++ b/src/channels/plugins/actions/telegram.ts @@ -1,2 +1,2 @@ // Public entrypoint for the Telegram channel action adapter. -export * from "../../../plugin-sdk-internal/telegram.js"; +export * from "../../../plugin-sdk/telegram.js"; diff --git a/src/channels/plugins/agent-tools/whatsapp-login.ts b/src/channels/plugins/agent-tools/whatsapp-login.ts index 661b49e083b..2204225bdda 100644 --- a/src/channels/plugins/agent-tools/whatsapp-login.ts +++ b/src/channels/plugins/agent-tools/whatsapp-login.ts @@ -1,2 +1,2 @@ // Shim: keep legacy import path while the runtime loads the plugin SDK surface. -export * from "../../../plugin-sdk-internal/whatsapp.js"; +export * from "../../../plugin-sdk/whatsapp.js"; diff --git a/src/channels/plugins/group-mentions.ts b/src/channels/plugins/group-mentions.ts index 94079daed04..f825fc73fe5 100644 --- a/src/channels/plugins/group-mentions.ts +++ b/src/channels/plugins/group-mentions.ts @@ -10,7 +10,7 @@ import type { GroupToolPolicyConfig, } from "../../config/types.tools.js"; import { resolveExactLineGroupConfigKey } from "../../line/group-keys.js"; -import { inspectSlackAccount } from "../../plugin-sdk-internal/slack.js"; +import { inspectSlackAccount } from "../../plugin-sdk/slack.js"; import { normalizeAtHashSlug, normalizeHyphenSlug } from "../../shared/string-normalization.js"; import type { ChannelGroupContext } from "./types.js"; diff --git a/src/channels/plugins/slack.actions.ts b/src/channels/plugins/slack.actions.ts index df53d1ff0e0..d559ca99b6a 100644 --- a/src/channels/plugins/slack.actions.ts +++ b/src/channels/plugins/slack.actions.ts @@ -4,22 +4,11 @@ import { isSlackInteractiveRepliesEnabled, listSlackMessageActions, resolveSlackChannelId, -} from "../../plugin-sdk-internal/slack.js"; -import { handleSlackMessageAction } from "../../plugin-sdk/slack-message-actions.js"; -import type { ChannelMessageActionAdapter, ChannelMessageActionContext } from "./types.js"; + handleSlackMessageAction, +} from "../../plugin-sdk/slack.js"; +import type { ChannelMessageActionAdapter } from "./types.js"; -type SlackActionAdapterOptions = { - includeReadThreadId?: boolean; - invoke?: ( - ctx: ChannelMessageActionContext, - ) => Parameters[0]["invoke"]; - skipNormalizeChannelId?: boolean; -}; - -export function createSlackActions( - providerId: string, - options?: SlackActionAdapterOptions, -): ChannelMessageActionAdapter { +export function createSlackActions(providerId: string): ChannelMessageActionAdapter { return { listActions: ({ cfg }) => listSlackMessageActions(cfg), getCapabilities: ({ cfg }) => { @@ -34,19 +23,16 @@ export function createSlackActions( }, extractToolSend: ({ args }) => extractSlackToolSend(args), handleAction: async (ctx) => { - const invoke = - options?.invoke?.(ctx) ?? - (async (action, cfg, toolContext) => - await handleSlackAction(action, cfg, { - ...(toolContext as SlackActionContext | undefined), - mediaLocalRoots: ctx.mediaLocalRoots, - })); return await handleSlackMessageAction({ providerId, ctx, - normalizeChannelId: options?.skipNormalizeChannelId ? undefined : resolveSlackChannelId, - includeReadThreadId: options?.includeReadThreadId ?? true, - invoke, + normalizeChannelId: resolveSlackChannelId, + includeReadThreadId: true, + invoke: async (action, cfg, toolContext) => + await handleSlackAction(action, cfg, { + ...(toolContext as SlackActionContext | undefined), + mediaLocalRoots: ctx.mediaLocalRoots, + }), }); }, }; diff --git a/src/channels/read-only-account-inspect.discord.runtime.ts b/src/channels/read-only-account-inspect.discord.runtime.ts index 00d0943b1ec..9d2ac6ef427 100644 --- a/src/channels/read-only-account-inspect.discord.runtime.ts +++ b/src/channels/read-only-account-inspect.discord.runtime.ts @@ -1,2 +1,2 @@ -export { inspectDiscordAccount } from "../plugin-sdk-internal/discord.js"; -export type { InspectedDiscordAccount } from "../plugin-sdk-internal/discord.js"; +export { inspectDiscordAccount } from "../plugin-sdk/discord.js"; +export type { InspectedDiscordAccount } from "../plugin-sdk/discord.js"; diff --git a/src/channels/read-only-account-inspect.slack.runtime.ts b/src/channels/read-only-account-inspect.slack.runtime.ts index c3e2bd5d83c..a7526e2ea95 100644 --- a/src/channels/read-only-account-inspect.slack.runtime.ts +++ b/src/channels/read-only-account-inspect.slack.runtime.ts @@ -1,2 +1,2 @@ -export { inspectSlackAccount } from "../plugin-sdk-internal/slack.js"; -export type { InspectedSlackAccount } from "../plugin-sdk-internal/slack.js"; +export { inspectSlackAccount } from "../plugin-sdk/slack.js"; +export type { InspectedSlackAccount } from "../plugin-sdk/slack.js"; diff --git a/src/channels/read-only-account-inspect.telegram.runtime.ts b/src/channels/read-only-account-inspect.telegram.runtime.ts index 1e633a0ff8e..0ab48f2c241 100644 --- a/src/channels/read-only-account-inspect.telegram.runtime.ts +++ b/src/channels/read-only-account-inspect.telegram.runtime.ts @@ -1,2 +1,2 @@ -export { inspectTelegramAccount } from "../plugin-sdk-internal/telegram.js"; -export type { InspectedTelegramAccount } from "../plugin-sdk-internal/telegram.js"; +export { inspectTelegramAccount } from "../plugin-sdk/telegram.js"; +export type { InspectedTelegramAccount } from "../plugin-sdk/telegram.js"; diff --git a/src/cli/deps.ts b/src/cli/deps.ts index 84bb107f97e..7ebfbf74f5b 100644 --- a/src/cli/deps.ts +++ b/src/cli/deps.ts @@ -35,32 +35,32 @@ export function createDefaultDeps(): CliDeps { return { whatsapp: createLazySender( "whatsapp", - () => import("../plugin-sdk-internal/whatsapp.js") as Promise>, + () => import("../plugin-sdk/whatsapp.js") as Promise>, "sendMessageWhatsApp", ), telegram: createLazySender( "telegram", - () => import("../plugin-sdk-internal/telegram.js") as Promise>, + () => import("../plugin-sdk/telegram.js") as Promise>, "sendMessageTelegram", ), discord: createLazySender( "discord", - () => import("../plugin-sdk-internal/discord.js") as Promise>, + () => import("../plugin-sdk/discord.js") as Promise>, "sendMessageDiscord", ), slack: createLazySender( "slack", - () => import("../plugin-sdk-internal/slack.js") as Promise>, + () => import("../plugin-sdk/slack.js") as Promise>, "sendMessageSlack", ), signal: createLazySender( "signal", - () => import("../plugin-sdk-internal/signal.js") as Promise>, + () => import("../plugin-sdk/signal.js") as Promise>, "sendMessageSignal", ), imessage: createLazySender( "imessage", - () => import("../plugin-sdk-internal/imessage.js") as Promise>, + () => import("../plugin-sdk/imessage.js") as Promise>, "sendMessageIMessage", ), }; @@ -70,4 +70,4 @@ export function createOutboundSendDeps(deps: CliDeps): OutboundSendDeps { return createOutboundSendDepsFromCliSource(deps); } -export { logWebSelfId } from "../plugin-sdk-internal/whatsapp.js"; +export { logWebSelfId } from "../plugin-sdk/whatsapp.js"; diff --git a/src/commands/doctor-config-flow.ts b/src/commands/doctor-config-flow.ts index 0c52c9b582a..a1cbf5fa6d9 100644 --- a/src/commands/doctor-config-flow.ts +++ b/src/commands/doctor-config-flow.ts @@ -29,7 +29,7 @@ import { listTelegramAccountIds, normalizeTelegramAllowFromEntry, resolveTelegramAccount, -} from "../plugin-sdk-internal/telegram.js"; +} from "../plugin-sdk/telegram.js"; import { formatChannelAccountsDefaultPath, formatSetExplicitDefaultInstruction, diff --git a/src/config/plugin-auto-enable.ts b/src/config/plugin-auto-enable.ts index c1297e7de4c..1deaad96d6f 100644 --- a/src/config/plugin-auto-enable.ts +++ b/src/config/plugin-auto-enable.ts @@ -9,7 +9,7 @@ import { listChatChannels, normalizeChatChannelId, } from "../channels/registry.js"; -import { hasAnyWhatsAppAuth } from "../plugin-sdk-internal/whatsapp.js"; +import { hasAnyWhatsAppAuth } from "../plugin-sdk/whatsapp.js"; import { loadPluginManifestRegistry, type PluginManifestRegistry, diff --git a/src/config/schema.help.ts b/src/config/schema.help.ts index 1b048bc9aa1..02103650589 100644 --- a/src/config/schema.help.ts +++ b/src/config/schema.help.ts @@ -1,7 +1,7 @@ import { DISCORD_DEFAULT_INBOUND_WORKER_TIMEOUT_MS, DISCORD_DEFAULT_LISTENER_TIMEOUT_MS, -} from "../plugin-sdk-internal/discord.js"; +} from "../plugin-sdk/discord.js"; import { MEDIA_AUDIO_FIELD_HELP } from "./media-audio-field-metadata.js"; import { IRC_FIELD_HELP } from "./schema.irc.js"; import { describeTalkSilenceTimeoutDefaults } from "./talk-defaults.js"; diff --git a/src/config/sessions/explicit-session-key-normalization.ts b/src/config/sessions/explicit-session-key-normalization.ts index 16b43a7c43c..08543e5a6d0 100644 --- a/src/config/sessions/explicit-session-key-normalization.ts +++ b/src/config/sessions/explicit-session-key-normalization.ts @@ -1,5 +1,5 @@ import type { MsgContext } from "../../auto-reply/templating.js"; -import { normalizeExplicitDiscordSessionKey } from "../../plugin-sdk-internal/discord.js"; +import { normalizeExplicitDiscordSessionKey } from "../../plugin-sdk/discord.js"; type ExplicitSessionKeyNormalizer = (sessionKey: string, ctx: MsgContext) => string; type ExplicitSessionKeyNormalizerEntry = { diff --git a/src/config/types.discord.ts b/src/config/types.discord.ts index aea4e7f8cfd..c9269c6b8fd 100644 --- a/src/config/types.discord.ts +++ b/src/config/types.discord.ts @@ -1,4 +1,4 @@ -import type { DiscordPluralKitConfig } from "../plugin-sdk-internal/discord.js"; +import type { DiscordPluralKitConfig } from "../plugin-sdk/discord.js"; import type { BlockStreamingChunkConfig, BlockStreamingCoalesceConfig, diff --git a/src/cron/isolated-agent/delivery-target.ts b/src/cron/isolated-agent/delivery-target.ts index 585e273e613..e903cd15cab 100644 --- a/src/cron/isolated-agent/delivery-target.ts +++ b/src/cron/isolated-agent/delivery-target.ts @@ -13,7 +13,7 @@ import { resolveSessionDeliveryTarget, } from "../../infra/outbound/targets.js"; import { readChannelAllowFromStoreSync } from "../../pairing/pairing-store.js"; -import { resolveWhatsAppAccount } from "../../plugin-sdk-internal/whatsapp.js"; +import { resolveWhatsAppAccount } from "../../plugin-sdk/whatsapp.js"; import { buildChannelAccountBindings } from "../../routing/bindings.js"; import { normalizeAccountId, normalizeAgentId } from "../../routing/session-key.js"; import { normalizeWhatsAppTarget } from "../../whatsapp/normalize.js"; diff --git a/src/gateway/server-http.ts b/src/gateway/server-http.ts index fe35da1f356..0ad655f4990 100644 --- a/src/gateway/server-http.ts +++ b/src/gateway/server-http.ts @@ -13,7 +13,7 @@ import { CANVAS_WS_PATH, handleA2uiHttpRequest } from "../canvas-host/a2ui.js"; import type { CanvasHostHandler } from "../canvas-host/server.js"; import { loadConfig } from "../config/config.js"; import type { createSubsystemLogger } from "../logging/subsystem.js"; -import { handleSlackHttpRequest } from "../plugin-sdk-internal/slack.js"; +import { handleSlackHttpRequest } from "../plugin-sdk/slack.js"; import { safeEqualSecret } from "../security/secret-equal.js"; import { AUTH_RATE_LIMIT_SCOPE_HOOK_AUTH, diff --git a/src/infra/state-migrations.ts b/src/infra/state-migrations.ts index 6646ab02e75..b429365a4a4 100644 --- a/src/infra/state-migrations.ts +++ b/src/infra/state-migrations.ts @@ -15,7 +15,7 @@ import { canonicalizeMainSessionAlias } from "../config/sessions/main-session.js import type { SessionScope } from "../config/sessions/types.js"; import { createSubsystemLogger } from "../logging/subsystem.js"; import { resolveChannelAllowFromPath } from "../pairing/pairing-store.js"; -import { listTelegramAccountIds } from "../plugin-sdk-internal/telegram.js"; +import { listTelegramAccountIds } from "../plugin-sdk/telegram.js"; import { buildAgentMainSessionKey, DEFAULT_ACCOUNT_ID, diff --git a/src/plugin-sdk/account-resolution.ts b/src/plugin-sdk/account-resolution.ts index 4aceec2c945..cb819f57354 100644 --- a/src/plugin-sdk/account-resolution.ts +++ b/src/plugin-sdk/account-resolution.ts @@ -1,3 +1,16 @@ +export type { OpenClawConfig } from "../config/config.js"; + +export { createAccountActionGate } from "../channels/plugins/account-action-gate.js"; +export { createAccountListHelpers } from "../channels/plugins/account-helpers.js"; +export { normalizeChatType } from "../channels/chat-type.js"; +export { resolveAccountEntry } from "../routing/account-lookup.js"; +export { + DEFAULT_ACCOUNT_ID, + normalizeAccountId, + normalizeOptionalAccountId, +} from "../routing/session-key.js"; +export { normalizeE164, pathExists, resolveUserPath } from "../utils.js"; + /** Resolve an account by id, then fall back to the default account when the primary lacks credentials. */ export function resolveAccountWithDefaultFallback(params: { accountId?: string | null; diff --git a/src/plugin-sdk/acp-runtime.ts b/src/plugin-sdk/acp-runtime.ts new file mode 100644 index 00000000000..c50c36419bb --- /dev/null +++ b/src/plugin-sdk/acp-runtime.ts @@ -0,0 +1,6 @@ +// Public ACP runtime helpers for plugins that integrate with ACP control/session state. + +export { getAcpSessionManager } from "../acp/control-plane/manager.js"; +export { isAcpRuntimeError } from "../acp/runtime/errors.js"; +export { readAcpSessionEntry } from "../acp/runtime/session-meta.js"; +export type { AcpSessionStoreEntry } from "../acp/runtime/session-meta.js"; diff --git a/src/plugin-sdk/agent-runtime.ts b/src/plugin-sdk/agent-runtime.ts new file mode 100644 index 00000000000..4eddbd51a29 --- /dev/null +++ b/src/plugin-sdk/agent-runtime.ts @@ -0,0 +1,28 @@ +// Public agent/model/runtime helpers for plugins that integrate with core agent flows. + +export * from "../agents/agent-scope.js"; +export * from "../agents/auth-profiles.js"; +export * from "../agents/current-time.js"; +export * from "../agents/defaults.js"; +export * from "../agents/identity-avatar.js"; +export * from "../agents/identity.js"; +export * from "../agents/model-auth-markers.js"; +export * from "../agents/model-auth.js"; +export * from "../agents/model-catalog.js"; +export * from "../agents/model-selection.js"; +export * from "../agents/pi-embedded-block-chunker.js"; +export * from "../agents/pi-embedded-utils.js"; +export * from "../agents/provider-id.js"; +export * from "../agents/schema/typebox.js"; +export * from "../agents/sglang-defaults.js"; +export * from "../agents/tools/common.js"; +export * from "../agents/tools/discord-actions-shared.js"; +export * from "../agents/tools/discord-actions.js"; +export * from "../agents/tools/telegram-actions.js"; +export * from "../agents/tools/web-guarded-fetch.js"; +export * from "../agents/tools/web-shared.js"; +export * from "../agents/tools/discord-actions-moderation-shared.js"; +export * from "../agents/tools/web-fetch-utils.js"; +export * from "../agents/vllm-defaults.js"; +export * from "../commands/agent.js"; +export * from "../tts/tts.js"; diff --git a/src/plugin-sdk/channel-config-helpers.ts b/src/plugin-sdk/channel-config-helpers.ts index 564bc86bc68..556e2a0c1c1 100644 --- a/src/plugin-sdk/channel-config-helpers.ts +++ b/src/plugin-sdk/channel-config-helpers.ts @@ -2,6 +2,13 @@ import { deleteAccountFromConfigSection, setAccountEnabledInConfigSection, } from "../channels/plugins/config-helpers.js"; +import { + collectAllowlistProviderGroupPolicyWarnings, + collectAllowlistProviderRestrictSendersWarnings, + collectOpenGroupPolicyConfiguredRouteWarnings, + collectOpenGroupPolicyRouteAllowlistWarnings, + collectOpenProviderGroupPolicyWarnings, +} from "../channels/plugins/group-policy-warnings.js"; import { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js"; import { normalizeWhatsAppAllowFromEntries } from "../channels/plugins/normalize/whatsapp.js"; import { getChannelPlugin } from "../channels/plugins/registry.js"; @@ -149,6 +156,15 @@ export function createScopedDmSecurityResolver< }); } +export { buildAccountScopedDmSecurityPolicy }; +export { + collectAllowlistProviderGroupPolicyWarnings, + collectAllowlistProviderRestrictSendersWarnings, + collectOpenGroupPolicyConfiguredRouteWarnings, + collectOpenGroupPolicyRouteAllowlistWarnings, + collectOpenProviderGroupPolicyWarnings, +}; + /** Read the effective WhatsApp allowlist through the active plugin contract. */ export function resolveWhatsAppConfigAllowFrom(params: { cfg: OpenClawConfig; diff --git a/src/plugin-sdk/channel-runtime.ts b/src/plugin-sdk/channel-runtime.ts new file mode 100644 index 00000000000..4fda751b6cb --- /dev/null +++ b/src/plugin-sdk/channel-runtime.ts @@ -0,0 +1,53 @@ +// Shared channel/runtime helpers for plugins. Channel plugins should use this +// surface instead of reaching into src/channels or adjacent infra modules. + +export * from "../channels/ack-reactions.js"; +export * from "../channels/allow-from.js"; +export * from "../channels/allowlists/resolve-utils.js"; +export * from "../channels/allowlist-match.js"; +export * from "../channels/channel-config.js"; +export * from "../channels/chat-type.js"; +export * from "../channels/command-gating.js"; +export * from "../channels/conversation-label.js"; +export * from "../channels/draft-stream-controls.js"; +export * from "../channels/draft-stream-loop.js"; +export * from "../channels/inbound-debounce-policy.js"; +export * from "../channels/location.js"; +export * from "../channels/logging.js"; +export * from "../channels/mention-gating.js"; +export * from "../channels/native-command-session-targets.js"; +export * from "../channels/reply-prefix.js"; +export * from "../channels/run-state-machine.js"; +export * from "../channels/session.js"; +export * from "../channels/session-envelope.js"; +export * from "../channels/session-meta.js"; +export * from "../channels/status-reactions.js"; +export * from "../channels/targets.js"; +export * from "../channels/thread-binding-id.js"; +export * from "../channels/thread-bindings-messages.js"; +export * from "../channels/thread-bindings-policy.js"; +export * from "../channels/transport/stall-watchdog.js"; +export * from "../channels/typing.js"; +export * from "../channels/plugins/actions/reaction-message-id.js"; +export * from "../channels/plugins/actions/shared.js"; +export type * from "../channels/plugins/types.js"; +export * from "../channels/plugins/config-writes.js"; +export * from "../channels/plugins/directory-config.js"; +export * from "../channels/plugins/media-payload.js"; +export * from "../channels/plugins/normalize/signal.js"; +export * from "../channels/plugins/normalize/whatsapp.js"; +export * from "../channels/plugins/outbound/direct-text-media.js"; +export * from "../channels/plugins/outbound/interactive.js"; +export * from "../channels/plugins/status-issues/shared.js"; +export * from "../channels/plugins/whatsapp-heartbeat.js"; +export * from "../infra/outbound/send-deps.js"; +export * from "../utils/message-channel.js"; +export type { + InteractiveButtonStyle, + InteractiveReplyButton, + InteractiveReply, +} from "../interactive/payload.js"; +export { + normalizeInteractiveReply, + resolveInteractiveTextFallback, +} from "../interactive/payload.js"; diff --git a/src/plugin-sdk/cli-runtime.ts b/src/plugin-sdk/cli-runtime.ts new file mode 100644 index 00000000000..23a881da23a --- /dev/null +++ b/src/plugin-sdk/cli-runtime.ts @@ -0,0 +1,6 @@ +// Public CLI/output helpers for plugins that share terminal-facing command behavior. + +export * from "../cli/command-format.js"; +export * from "../cli/parse-duration.js"; +export * from "../cli/wait.js"; +export * from "../version.js"; diff --git a/src/plugin-sdk/config-runtime.ts b/src/plugin-sdk/config-runtime.ts new file mode 100644 index 00000000000..67b2ec82fee --- /dev/null +++ b/src/plugin-sdk/config-runtime.ts @@ -0,0 +1,42 @@ +// Shared config/runtime boundary for plugins that need config loading, +// config writes, or session-store helpers without importing src internals. + +export * from "../config/config.js"; +export * from "../config/markdown-tables.js"; +export * from "../config/group-policy.js"; +export * from "../config/runtime-group-policy.js"; +export * from "../config/commands.js"; +export * from "../config/discord-preview-streaming.js"; +export * from "../config/io.js"; +export * from "../config/telegram-custom-commands.js"; +export * from "../config/talk.js"; +export * from "../config/agent-limits.js"; +export * from "../cron/store.js"; +export * from "../sessions/model-overrides.js"; +export type * from "../config/types.slack.js"; +export { + loadSessionStore, + readSessionUpdatedAt, + recordSessionMetaFromInbound, + resolveSessionKey, + resolveStorePath, + updateLastRoute, + updateSessionStore, + type SessionResetMode, + type SessionScope, +} from "../config/sessions.js"; +export { resolveGroupSessionKey } from "../config/sessions/group.js"; +export { + evaluateSessionFreshness, + resolveChannelResetConfig, + resolveSessionResetPolicy, + resolveSessionResetType, + resolveThreadFlag, +} from "../config/sessions/reset.js"; +export { resolveSessionStoreEntry } from "../config/sessions/store.js"; +export { isDangerousNameMatchingEnabled } from "../config/dangerous-name-matching.js"; +export { + hasConfiguredSecretInput, + normalizeResolvedSecretInputString, + normalizeSecretInputString, +} from "../config/types.secrets.js"; diff --git a/src/plugin-sdk/conversation-runtime.ts b/src/plugin-sdk/conversation-runtime.ts new file mode 100644 index 00000000000..77380f6aa9a --- /dev/null +++ b/src/plugin-sdk/conversation-runtime.ts @@ -0,0 +1,41 @@ +// Public pairing/session-binding helpers for plugins that manage conversation ownership. + +export * from "../acp/persistent-bindings.route.js"; +export { + type BindingStatus, + type BindingTargetKind, + type ConversationRef, + SessionBindingError, + type SessionBindingAdapter, + type SessionBindingAdapterCapabilities, + type SessionBindingBindInput, + type SessionBindingCapabilities, + type SessionBindingPlacement, + type SessionBindingRecord, + type SessionBindingService, + type SessionBindingUnbindInput, + getSessionBindingService, + isSessionBindingError, + registerSessionBindingAdapter, + unregisterSessionBindingAdapter, +} from "../infra/outbound/session-binding-service.js"; +export * from "../pairing/pairing-challenge.js"; +export * from "../pairing/pairing-messages.js"; +export * from "../pairing/pairing-store.js"; +export { + buildPluginBindingApprovalCustomId, + buildPluginBindingDeclinedText, + buildPluginBindingErrorText, + buildPluginBindingResolvedText, + buildPluginBindingUnavailableText, + detachPluginConversationBinding, + getCurrentPluginConversationBinding, + hasShownPluginBindingFallbackNotice, + isPluginOwnedBindingMetadata, + isPluginOwnedSessionBindingRecord, + markPluginBindingFallbackNoticeShown, + parsePluginBindingApprovalCustomId, + requestPluginConversationBinding, + resolvePluginConversationBindingApproval, + toPluginConversationBinding, +} from "../plugins/conversation-binding.js"; diff --git a/src/plugin-sdk/discord.ts b/src/plugin-sdk/discord.ts index d15f5091b9d..b31c796e2d6 100644 --- a/src/plugin-sdk/discord.ts +++ b/src/plugin-sdk/discord.ts @@ -1,6 +1,18 @@ export type { ChannelMessageActionAdapter } from "../channels/plugins/types.js"; export type { OpenClawConfig } from "../config/config.js"; export type { DiscordAccountConfig, DiscordActionConfig } from "../config/types.js"; +export type { DiscordPluralKitConfig } from "../../extensions/discord/src/pluralkit.js"; +export type { InspectedDiscordAccount } from "../../extensions/discord/src/account-inspect.js"; +export type { ResolvedDiscordAccount } from "../../extensions/discord/src/accounts.js"; +export type { + DiscordSendComponents, + DiscordSendEmbeds, +} from "../../extensions/discord/src/send.shared.js"; +export type { + ThreadBindingManager, + ThreadBindingRecord, + ThreadBindingTargetKind, +} from "../../extensions/discord/src/monitor/thread-bindings.js"; export type { ChannelMessageActionContext, ChannelPlugin, @@ -44,3 +56,77 @@ export { buildComputedAccountStatusSnapshot, buildTokenChannelStatusSummary, } from "./status-helpers.js"; + +export { + createDiscordActionGate, + listDiscordAccountIds, + resolveDefaultDiscordAccountId, + resolveDiscordAccount, +} from "../../extensions/discord/src/accounts.js"; +export { inspectDiscordAccount } from "../../extensions/discord/src/account-inspect.js"; +export { + looksLikeDiscordTargetId, + normalizeDiscordMessagingTarget, + normalizeDiscordOutboundTarget, +} from "../../extensions/discord/src/normalize.js"; +export { collectDiscordAuditChannelIds } from "../../extensions/discord/src/audit.js"; +export { collectDiscordStatusIssues } from "../../extensions/discord/src/status-issues.js"; +export { + DISCORD_DEFAULT_INBOUND_WORKER_TIMEOUT_MS, + DISCORD_DEFAULT_LISTENER_TIMEOUT_MS, +} from "../../extensions/discord/src/monitor/timeouts.js"; +export { normalizeExplicitDiscordSessionKey } from "../../extensions/discord/src/session-key-normalization.js"; +export { + autoBindSpawnedDiscordSubagent, + listThreadBindingsBySessionKey, + unbindThreadBindingsBySessionKey, +} from "../../extensions/discord/src/monitor/thread-bindings.js"; +export { getGateway } from "../../extensions/discord/src/monitor/gateway-registry.js"; +export { getPresence } from "../../extensions/discord/src/monitor/presence-cache.js"; +export { readDiscordComponentSpec } from "../../extensions/discord/src/components.js"; +export { resolveDiscordChannelId } from "../../extensions/discord/src/targets.js"; +export { + addRoleDiscord, + banMemberDiscord, + createChannelDiscord, + createScheduledEventDiscord, + createThreadDiscord, + deleteChannelDiscord, + deleteMessageDiscord, + editChannelDiscord, + editMessageDiscord, + fetchChannelInfoDiscord, + fetchChannelPermissionsDiscord, + fetchMemberInfoDiscord, + fetchMessageDiscord, + fetchReactionsDiscord, + fetchRoleInfoDiscord, + fetchVoiceStatusDiscord, + hasAnyGuildPermissionDiscord, + kickMemberDiscord, + listGuildChannelsDiscord, + listGuildEmojisDiscord, + listPinsDiscord, + listScheduledEventsDiscord, + listThreadsDiscord, + moveChannelDiscord, + pinMessageDiscord, + reactMessageDiscord, + readMessagesDiscord, + removeChannelPermissionDiscord, + removeOwnReactionsDiscord, + removeReactionDiscord, + removeRoleDiscord, + searchMessagesDiscord, + sendDiscordComponentMessage, + sendMessageDiscord, + sendPollDiscord, + sendStickerDiscord, + sendVoiceMessageDiscord, + setChannelPermissionDiscord, + timeoutMemberDiscord, + unpinMessageDiscord, + uploadEmojiDiscord, + uploadStickerDiscord, +} from "../../extensions/discord/src/send.js"; +export { discordMessageActions } from "../../extensions/discord/src/channel-actions.js"; diff --git a/src/plugin-sdk/gateway-runtime.ts b/src/plugin-sdk/gateway-runtime.ts new file mode 100644 index 00000000000..f1ef78ef14c --- /dev/null +++ b/src/plugin-sdk/gateway-runtime.ts @@ -0,0 +1,6 @@ +// Public gateway/client helpers for plugins that talk to the host gateway surface. + +export * from "../gateway/channel-status-patches.js"; +export { GatewayClient } from "../gateway/client.js"; +export { createOperatorApprovalsGatewayClient } from "../gateway/operator-approvals-client.js"; +export type { EventFrame } from "../gateway/protocol/index.js"; diff --git a/src/plugin-sdk/hook-runtime.ts b/src/plugin-sdk/hook-runtime.ts new file mode 100644 index 00000000000..dd67f98cf04 --- /dev/null +++ b/src/plugin-sdk/hook-runtime.ts @@ -0,0 +1,5 @@ +// Public hook helpers for plugins that need the shared internal/webhook hook pipeline. + +export * from "../hooks/fire-and-forget.js"; +export * from "../hooks/internal-hooks.js"; +export * from "../hooks/message-hook-mappers.js"; diff --git a/src/plugin-sdk/imessage.ts b/src/plugin-sdk/imessage.ts index a974910e680..5481c117be6 100644 --- a/src/plugin-sdk/imessage.ts +++ b/src/plugin-sdk/imessage.ts @@ -40,3 +40,4 @@ export { IMessageConfigSchema } from "../config/zod-schema.providers-core.js"; export { resolveChannelMediaMaxBytes } from "../channels/plugins/media-limits.js"; export { collectStatusIssuesFromLastError } from "./status-helpers.js"; +export { sendMessageIMessage } from "../../extensions/imessage/src/send.js"; diff --git a/src/plugin-sdk/infra-runtime.ts b/src/plugin-sdk/infra-runtime.ts new file mode 100644 index 00000000000..dd75ac4fea2 --- /dev/null +++ b/src/plugin-sdk/infra-runtime.ts @@ -0,0 +1,39 @@ +// Public runtime/transport helpers for plugins that need shared infra behavior. + +export * from "../infra/backoff.js"; +export * from "../infra/channel-activity.js"; +export * from "../infra/dedupe.js"; +export * from "../infra/diagnostic-events.js"; +export * from "../infra/diagnostic-flags.js"; +export * from "../infra/env.js"; +export * from "../infra/errors.js"; +export * from "../infra/exec-approval-command-display.ts"; +export * from "../infra/exec-approval-reply.ts"; +export * from "../infra/exec-approval-session-target.ts"; +export * from "../infra/exec-approvals.ts"; +export * from "../infra/fetch.js"; +export * from "../infra/file-lock.js"; +export * from "../infra/format-time/format-duration.ts"; +export * from "../infra/fs-safe.ts"; +export * from "../infra/heartbeat-events.ts"; +export * from "../infra/heartbeat-visibility.ts"; +export * from "../infra/home-dir.js"; +export * from "../infra/http-body.js"; +export * from "../infra/json-files.js"; +export * from "../infra/map-size.js"; +export * from "../infra/net/hostname.ts"; +export * from "../infra/net/fetch-guard.js"; +export * from "../infra/net/proxy-env.js"; +export * from "../infra/net/proxy-fetch.js"; +export * from "../infra/net/ssrf.js"; +export * from "../infra/outbound/identity.js"; +export * from "../infra/retry.js"; +export * from "../infra/retry-policy.js"; +export * from "../infra/scp-host.ts"; +export * from "../infra/secret-file.js"; +export * from "../infra/secure-random.js"; +export * from "../infra/system-events.js"; +export * from "../infra/system-message.ts"; +export * from "../infra/tmp-openclaw-dir.js"; +export * from "../infra/transport-ready.js"; +export * from "../infra/wsl.ts"; diff --git a/src/plugin-sdk/json-store.ts b/src/plugin-sdk/json-store.ts index faff8f64e59..b95ee5b819b 100644 --- a/src/plugin-sdk/json-store.ts +++ b/src/plugin-sdk/json-store.ts @@ -1,7 +1,14 @@ import fs from "node:fs"; +import { loadJsonFile, saveJsonFile } from "../infra/json-file.js"; import { writeJsonAtomic } from "../infra/json-files.js"; import { safeParseJson } from "../utils.js"; +/** Read small JSON blobs synchronously for token/state caches. */ +export { loadJsonFile }; + +/** Persist small JSON blobs synchronously with restrictive permissions. */ +export { saveJsonFile }; + /** Read JSON from disk and fall back cleanly when the file is missing or invalid. */ export async function readJsonFileWithFallback( filePath: string, diff --git a/src/plugin-sdk/media-runtime.ts b/src/plugin-sdk/media-runtime.ts new file mode 100644 index 00000000000..2f2d81b0d46 --- /dev/null +++ b/src/plugin-sdk/media-runtime.ts @@ -0,0 +1,21 @@ +// Public media/payload helpers for plugins that fetch, transform, or send attachments. + +export * from "../media/audio.js"; +export * from "../media/constants.js"; +export * from "../media/fetch.js"; +export * from "../media/ffmpeg-exec.js"; +export * from "../media/ffmpeg-limits.js"; +export * from "../media/image-ops.js"; +export * from "../media/inbound-path-policy.js"; +export * from "../media/load-options.js"; +export * from "../media/local-roots.js"; +export * from "../media/mime.js"; +export * from "../media/outbound-attachment.js"; +export * from "../media/png-encode.ts"; +export * from "../media/store.js"; +export * from "../media/temp-files.js"; +export * from "../media-understanding/audio-preflight.ts"; +export * from "../media-understanding/defaults.js"; +export * from "../media-understanding/providers/image-runtime.ts"; +export * from "../media-understanding/runner.js"; +export * from "../polls.js"; diff --git a/src/plugin-sdk/plugin-runtime.ts b/src/plugin-sdk/plugin-runtime.ts new file mode 100644 index 00000000000..ecc80f8f224 --- /dev/null +++ b/src/plugin-sdk/plugin-runtime.ts @@ -0,0 +1,6 @@ +// Public plugin-command/hook helpers for plugins that extend shared command or hook flows. + +export * from "../plugins/commands.js"; +export * from "../plugins/hook-runner-global.js"; +export * from "../plugins/interactive.js"; +export * from "../plugins/types.js"; diff --git a/src/plugin-sdk/process-runtime.ts b/src/plugin-sdk/process-runtime.ts new file mode 100644 index 00000000000..826ed2d1197 --- /dev/null +++ b/src/plugin-sdk/process-runtime.ts @@ -0,0 +1,3 @@ +// Public process helpers for plugins that spawn or probe local commands. + +export * from "../process/exec.js"; diff --git a/src/plugin-sdk/provider-auth.ts b/src/plugin-sdk/provider-auth.ts new file mode 100644 index 00000000000..40669e51d97 --- /dev/null +++ b/src/plugin-sdk/provider-auth.ts @@ -0,0 +1,43 @@ +// Public auth/onboarding helpers for provider plugins. + +export type { OpenClawConfig } from "../config/config.js"; +export type { SecretInput } from "../config/types.secrets.js"; +export type { ProviderAuthResult } from "../plugins/types.js"; +export type { AuthProfileStore, OAuthCredential } from "../agents/auth-profiles/types.js"; + +export { + CLAUDE_CLI_PROFILE_ID, + CODEX_CLI_PROFILE_ID, + ensureAuthProfileStore, + listProfilesForProvider, + suggestOAuthProfileIdForLegacyDefault, + upsertAuthProfile, +} from "../agents/auth-profiles.js"; +export { + MINIMAX_OAUTH_MARKER, + resolveNonEnvSecretRefApiKeyMarker, +} from "../agents/model-auth-markers.js"; +export { + formatApiKeyPreview, + normalizeApiKeyInput, + validateApiKeyInput, +} from "../commands/auth-choice.api-key.js"; +export { + ensureApiKeyFromOptionEnvOrPrompt, + normalizeSecretInputModeInput, + promptSecretRefForSetup, + resolveSecretInputModeForEnvSelection, +} from "../commands/auth-choice.apply-helpers.js"; +export { buildTokenProfileId, validateAnthropicSetupToken } from "../commands/auth-token.js"; +export { buildApiKeyCredential } from "../commands/onboard-auth.credentials.js"; +export { applyAuthProfileConfig } from "../commands/onboard-auth.js"; +export { githubCopilotLoginCommand } from "../providers/github-copilot-auth.js"; +export { loginOpenAICodexOAuth } from "../commands/openai-codex-oauth.js"; +export { createProviderApiKeyAuthMethod } from "../plugins/provider-api-key-auth.js"; +export { coerceSecretRef } from "../config/types.secrets.js"; +export { resolveDefaultSecretProviderAlias } from "../secrets/ref-contract.js"; +export { resolveRequiredHomeDir } from "../infra/home-dir.js"; +export { + normalizeOptionalSecretInput, + normalizeSecretInput, +} from "../utils/normalize-secret-input.js"; diff --git a/src/plugin-sdk/provider-models.ts b/src/plugin-sdk/provider-models.ts new file mode 100644 index 00000000000..5221daec1cd --- /dev/null +++ b/src/plugin-sdk/provider-models.ts @@ -0,0 +1,86 @@ +// Public model/catalog helpers for provider plugins. + +export type { + ModelApi, + ModelDefinitionConfig, + ModelProviderConfig, +} from "../config/types.models.js"; +export type { ProviderPlugin } from "../plugins/types.js"; + +export { DEFAULT_CONTEXT_TOKENS } from "../agents/defaults.js"; +export { normalizeModelCompat } from "../agents/model-compat.js"; +export { normalizeProviderId } from "../agents/provider-id.js"; + +export { + applyGoogleGeminiModelDefault, + GOOGLE_GEMINI_DEFAULT_MODEL, +} from "../commands/google-gemini-model-default.js"; +export { applyOpenAIConfig, OPENAI_DEFAULT_MODEL } from "../commands/openai-model-default.js"; +export { OPENCODE_GO_DEFAULT_MODEL_REF } from "../commands/opencode-go-model-default.js"; +export { OPENCODE_ZEN_DEFAULT_MODEL } from "../commands/opencode-zen-model-default.js"; +export { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "../agents/opencode-zen-models.js"; + +export * from "../commands/onboard-auth.models.js"; + +export { + buildCloudflareAiGatewayModelDefinition, + CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF, + resolveCloudflareAiGatewayBaseUrl, +} from "../agents/cloudflare-ai-gateway.js"; +export { + discoverHuggingfaceModels, + HUGGINGFACE_BASE_URL, + HUGGINGFACE_MODEL_CATALOG, + buildHuggingfaceModelDefinition, +} from "../agents/huggingface-models.js"; +export { discoverKilocodeModels } from "../agents/kilocode-models.js"; +export { resolveOllamaApiBase } from "../agents/ollama-models.js"; +export { + buildSyntheticModelDefinition, + SYNTHETIC_BASE_URL, + SYNTHETIC_DEFAULT_MODEL_REF, + SYNTHETIC_MODEL_CATALOG, +} from "../agents/synthetic-models.js"; +export { + buildTogetherModelDefinition, + TOGETHER_BASE_URL, + TOGETHER_MODEL_CATALOG, +} from "../agents/together-models.js"; +export { + discoverVeniceModels, + VENICE_BASE_URL, + VENICE_DEFAULT_MODEL_REF, + VENICE_MODEL_CATALOG, + buildVeniceModelDefinition, +} from "../agents/venice-models.js"; +export { + BYTEPLUS_BASE_URL, + BYTEPLUS_CODING_BASE_URL, + BYTEPLUS_CODING_MODEL_CATALOG, + BYTEPLUS_MODEL_CATALOG, + buildBytePlusModelDefinition, +} from "../agents/byteplus-models.js"; +export { + DOUBAO_BASE_URL, + DOUBAO_CODING_BASE_URL, + DOUBAO_CODING_MODEL_CATALOG, + DOUBAO_MODEL_CATALOG, + buildDoubaoModelDefinition, +} from "../agents/doubao-models.js"; +export { OLLAMA_DEFAULT_BASE_URL } from "../agents/ollama-defaults.js"; +export { VLLM_DEFAULT_BASE_URL } from "../agents/vllm-defaults.js"; +export { SGLANG_DEFAULT_BASE_URL } from "../agents/sglang-defaults.js"; +export { + KILOCODE_BASE_URL, + KILOCODE_DEFAULT_CONTEXT_WINDOW, + KILOCODE_DEFAULT_COST, + KILOCODE_DEFAULT_MODEL_REF, + KILOCODE_DEFAULT_MAX_TOKENS, + KILOCODE_DEFAULT_MODEL_ID, + KILOCODE_DEFAULT_MODEL_NAME, + KILOCODE_MODEL_CATALOG, +} from "../providers/kilocode-shared.js"; +export { + discoverVercelAiGatewayModels, + VERCEL_AI_GATEWAY_BASE_URL, +} from "../agents/vercel-ai-gateway.js"; diff --git a/src/plugin-sdk/provider-onboard.ts b/src/plugin-sdk/provider-onboard.ts new file mode 100644 index 00000000000..b2175f092fe --- /dev/null +++ b/src/plugin-sdk/provider-onboard.ts @@ -0,0 +1,16 @@ +// Public config patch helpers for provider onboarding flows. + +export type { OpenClawConfig } from "../config/config.js"; +export type { + ModelApi, + ModelDefinitionConfig, + ModelProviderConfig, +} from "../config/types.models.js"; +export { + applyAgentDefaultModelPrimary, + applyOnboardAuthAgentModelsAndProviders, + applyProviderConfigWithDefaultModel, + applyProviderConfigWithDefaultModels, + applyProviderConfigWithModelCatalog, +} from "../commands/onboard-auth.config-shared.js"; +export { ensureModelAllowlistEntry } from "../commands/model-allowlist.js"; diff --git a/src/plugin-sdk/provider-stream.ts b/src/plugin-sdk/provider-stream.ts new file mode 100644 index 00000000000..19b8fe76092 --- /dev/null +++ b/src/plugin-sdk/provider-stream.ts @@ -0,0 +1,17 @@ +// Public stream-wrapper helpers for provider plugins. + +export { + createKilocodeWrapper, + createOpenRouterSystemCacheWrapper, + createOpenRouterWrapper, + isProxyReasoningUnsupported, +} from "../agents/pi-embedded-runner/proxy-stream-wrappers.js"; +export { + createMoonshotThinkingWrapper, + resolveMoonshotThinkingType, +} from "../agents/pi-embedded-runner/moonshot-stream-wrappers.js"; +export { createZaiToolStreamWrapper } from "../agents/pi-embedded-runner/zai-stream-wrappers.js"; +export { + getOpenRouterModelCapabilities, + loadOpenRouterModelCapabilities, +} from "../agents/pi-embedded-runner/openrouter-model-capabilities.js"; diff --git a/src/plugin-sdk/provider-usage.ts b/src/plugin-sdk/provider-usage.ts new file mode 100644 index 00000000000..33757596965 --- /dev/null +++ b/src/plugin-sdk/provider-usage.ts @@ -0,0 +1,21 @@ +// Public usage fetch helpers for provider plugins. + +export type { + ProviderUsageSnapshot, + UsageProviderId, + UsageWindow, +} from "../infra/provider-usage.types.js"; + +export { + fetchClaudeUsage, + fetchCodexUsage, + fetchGeminiUsage, + fetchMinimaxUsage, + fetchZaiUsage, +} from "../infra/provider-usage.fetch.js"; +export { clampPercent, PROVIDER_LABELS } from "../infra/provider-usage.shared.js"; +export { + buildUsageErrorSnapshot, + buildUsageHttpErrorSnapshot, + fetchJson, +} from "../infra/provider-usage.fetch.shared.js"; diff --git a/src/plugin-sdk/provider-web-search.ts b/src/plugin-sdk/provider-web-search.ts new file mode 100644 index 00000000000..551c3d5ed5d --- /dev/null +++ b/src/plugin-sdk/provider-web-search.ts @@ -0,0 +1,18 @@ +// Public web-search registration helpers for provider plugins. + +export { + createPluginBackedWebSearchProvider, + getScopedCredentialValue, + getTopLevelCredentialValue, + setScopedCredentialValue, + setTopLevelCredentialValue, +} from "../agents/tools/web-search-plugin-factory.js"; +export { withTrustedWebToolsEndpoint } from "../agents/tools/web-guarded-fetch.js"; +export { + DEFAULT_CACHE_TTL_MINUTES, + normalizeCacheKey, + readCache, + readResponseText, + resolveCacheTtlMs, + writeCache, +} from "../agents/tools/web-shared.js"; diff --git a/src/plugin-sdk/qwen-portal-auth.ts b/src/plugin-sdk/qwen-portal-auth.ts index 01533a77e8c..f6cde98b90f 100644 --- a/src/plugin-sdk/qwen-portal-auth.ts +++ b/src/plugin-sdk/qwen-portal-auth.ts @@ -8,4 +8,7 @@ export type { ProviderAuthContext, ProviderCatalogContext, } from "../plugins/types.js"; +export { ensureAuthProfileStore, listProfilesForProvider } from "../agents/auth-profiles.js"; +export { QWEN_OAUTH_MARKER } from "../agents/model-auth-markers.js"; +export { refreshQwenPortalCredentials } from "../providers/qwen-portal-oauth.js"; export { generatePkceVerifierChallenge, toFormUrlEncoded } from "./oauth-utils.js"; diff --git a/src/plugin-sdk/reply-runtime.ts b/src/plugin-sdk/reply-runtime.ts new file mode 100644 index 00000000000..689cf4cdba7 --- /dev/null +++ b/src/plugin-sdk/reply-runtime.ts @@ -0,0 +1,31 @@ +// Shared agent/reply runtime helpers for channel plugins. Keep channel plugins +// off direct src/auto-reply imports by routing common reply primitives here. + +export * from "../auto-reply/chunk.js"; +export * from "../auto-reply/command-auth.js"; +export * from "../auto-reply/command-detection.js"; +export * from "../auto-reply/commands-registry.js"; +export * from "../auto-reply/dispatch.js"; +export * from "../auto-reply/group-activation.js"; +export * from "../auto-reply/heartbeat.js"; +export * from "../auto-reply/heartbeat-reply-payload.js"; +export * from "../auto-reply/inbound-debounce.js"; +export * from "../auto-reply/reply.js"; +export * from "../auto-reply/tokens.js"; +export * from "../auto-reply/envelope.js"; +export * from "../auto-reply/reply/history.js"; +export * from "../auto-reply/reply/abort.js"; +export * from "../auto-reply/reply/btw-command.js"; +export * from "../auto-reply/reply/commands-models.js"; +export * from "../auto-reply/reply/inbound-dedupe.js"; +export * from "../auto-reply/reply/inbound-context.js"; +export * from "../auto-reply/reply/mentions.js"; +export * from "../auto-reply/reply/reply-dispatcher.js"; +export * from "../auto-reply/reply/reply-reference.js"; +export * from "../auto-reply/reply/provider-dispatcher.js"; +export * from "../auto-reply/reply/model-selection.js"; +export * from "../auto-reply/reply/commands-info.js"; +export * from "../auto-reply/skill-commands.js"; +export * from "../auto-reply/status.js"; +export type { ReplyPayload } from "../auto-reply/types.js"; +export type { FinalizedMsgContext, MsgContext } from "../auto-reply/templating.js"; diff --git a/src/plugin-sdk/routing.ts b/src/plugin-sdk/routing.ts index 921d085ae55..144304a607c 100644 --- a/src/plugin-sdk/routing.ts +++ b/src/plugin-sdk/routing.ts @@ -1,6 +1,31 @@ export { buildAgentSessionKey, + deriveLastRoutePolicy, + resolveAgentRoute, + resolveInboundLastRouteSessionKey, + type ResolvedAgentRoute, type RoutePeer, type RoutePeerKind, } from "../routing/resolve-route.js"; -export { resolveThreadSessionKeys } from "../routing/session-key.js"; +export { + buildAgentMainSessionKey, + DEFAULT_ACCOUNT_ID, + DEFAULT_MAIN_KEY, + buildGroupHistoryKey, + isCronSessionKey, + isSubagentSessionKey, + normalizeAccountId, + normalizeAgentId, + normalizeMainKey, + normalizeOptionalAccountId, + parseAgentSessionKey, + resolveAgentIdFromSessionKey, + resolveThreadSessionKeys, + sanitizeAgentId, +} from "../routing/session-key.js"; +export { resolveAccountEntry } from "../routing/account-lookup.js"; +export { listBoundAccountIds, resolveDefaultAgentBoundAccountId } from "../routing/bindings.js"; +export { + formatSetExplicitDefaultInstruction, + formatSetExplicitDefaultToConfiguredInstruction, +} from "../routing/default-account-warnings.js"; diff --git a/src/plugin-sdk/runtime-env.ts b/src/plugin-sdk/runtime-env.ts new file mode 100644 index 00000000000..c216bbbfbe6 --- /dev/null +++ b/src/plugin-sdk/runtime-env.ts @@ -0,0 +1,21 @@ +// Shared process/runtime utilities for plugins. This is the public boundary for +// logger wiring, runtime env shims, and global verbose console helpers. + +export type { RuntimeEnv } from "../runtime.js"; +export { createNonExitingRuntime, defaultRuntime } from "../runtime.js"; +export { + danger, + info, + isVerbose, + isYes, + logVerbose, + logVerboseConsole, + setVerbose, + setYes, + shouldLogVerbose, + success, + warn, +} from "../globals.js"; +export * from "../logging.js"; +export { waitForAbortSignal } from "../infra/abort-signal.js"; +export { registerUnhandledRejectionHandler } from "../infra/unhandled-rejections.js"; diff --git a/src/plugin-sdk/runtime-store.ts b/src/plugin-sdk/runtime-store.ts index 67e8bb3644c..34257c918b0 100644 --- a/src/plugin-sdk/runtime-store.ts +++ b/src/plugin-sdk/runtime-store.ts @@ -1,3 +1,5 @@ +export type { PluginRuntime } from "../plugins/runtime/types.js"; + /** Create a tiny mutable runtime slot with strict access when the runtime has not been initialized. */ export function createPluginRuntimeStore(errorMessage: string): { setRuntime: (next: T) => void; diff --git a/src/plugin-sdk/runtime.ts b/src/plugin-sdk/runtime.ts index 75b6f955dc7..ec39c97a549 100644 --- a/src/plugin-sdk/runtime.ts +++ b/src/plugin-sdk/runtime.ts @@ -1,5 +1,23 @@ import { format } from "node:util"; import type { RuntimeEnv } from "../runtime.js"; +export type { RuntimeEnv } from "../runtime.js"; +export { createNonExitingRuntime, defaultRuntime } from "../runtime.js"; +export { + danger, + info, + isVerbose, + isYes, + logVerbose, + logVerboseConsole, + setVerbose, + setYes, + shouldLogVerbose, + success, + warn, +} from "../globals.js"; +export * from "../logging.js"; +export { waitForAbortSignal } from "../infra/abort-signal.js"; +export { registerUnhandledRejectionHandler } from "../infra/unhandled-rejections.js"; type LoggerLike = { info: (message: string) => void; diff --git a/src/plugin-sdk/security-runtime.ts b/src/plugin-sdk/security-runtime.ts new file mode 100644 index 00000000000..4b7c42bbef3 --- /dev/null +++ b/src/plugin-sdk/security-runtime.ts @@ -0,0 +1,6 @@ +// Public security/policy helpers for plugins that need shared trust and DM gating logic. + +export * from "../security/channel-metadata.js"; +export * from "../security/dm-policy-shared.js"; +export * from "../security/external-content.js"; +export * from "../security/safe-regex.js"; diff --git a/src/plugin-sdk/setup.ts b/src/plugin-sdk/setup.ts index e77af2904c3..a2a7cf5c302 100644 --- a/src/plugin-sdk/setup.ts +++ b/src/plugin-sdk/setup.ts @@ -7,11 +7,16 @@ export type { WizardPrompter } from "../wizard/prompts.js"; export type { ChannelSetupAdapter } from "../channels/plugins/types.adapters.js"; export type { ChannelSetupInput } from "../channels/plugins/types.core.js"; export type { ChannelSetupDmPolicy } from "../channels/plugins/setup-wizard-types.js"; +export type { ChannelSetupWizardAllowFromEntry } from "../channels/plugins/setup-wizard.js"; export type { ChannelSetupWizard } from "../channels/plugins/setup-wizard.js"; export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; +export { formatCliCommand } from "../cli/command-format.js"; +export { detectBinary } from "../commands/onboard-helpers.js"; +export { installSignalCli } from "../commands/signal-install.js"; export { formatDocsLink } from "../terminal/links.js"; export { hasConfiguredSecretInput, normalizeSecretInputString } from "../config/types.secrets.js"; +export { normalizeE164, pathExists } from "../utils.js"; export { applyAccountNameToChannelSection, @@ -23,10 +28,22 @@ export { addWildcardAllowFrom, buildSingleChannelSecretPromptState, mergeAllowFromEntries, + normalizeAllowFromEntries, + noteChannelLookupFailure, + noteChannelLookupSummary, + parseMentionOrPrefixedId, + parseSetupEntriesAllowingWildcard, + parseSetupEntriesWithParser, patchChannelConfigForAccount, + promptLegacyChannelAllowFrom, + promptParsedAllowFromForScopedChannel, promptSingleChannelSecretInput, + promptResolvedAllowFrom, resolveSetupAccountId, runSingleChannelSecretStep, + setAccountGroupPolicyForChannel, + setChannelDmPolicyWithAllowFrom, + setLegacyChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, setTopLevelChannelAllowFrom, setTopLevelChannelDmPolicyWithAllowFrom, diff --git a/src/plugin-sdk/signal.ts b/src/plugin-sdk/signal.ts index 8fd6fd2afd0..f7d3ec2d84d 100644 --- a/src/plugin-sdk/signal.ts +++ b/src/plugin-sdk/signal.ts @@ -1,5 +1,7 @@ export type { ChannelMessageActionAdapter } from "../channels/plugins/types.js"; +export type { OpenClawConfig } from "../config/config.js"; export type { SignalAccountConfig } from "../config/types.js"; +export type { ResolvedSignalAccount } from "../../extensions/signal/src/accounts.js"; export type { ChannelMessageActionContext, ChannelPlugin, @@ -40,3 +42,16 @@ export { collectStatusIssuesFromLastError, createDefaultChannelRuntimeState, } from "./status-helpers.js"; + +export { + listEnabledSignalAccounts, + listSignalAccountIds, + resolveDefaultSignalAccountId, + resolveSignalAccount, +} from "../../extensions/signal/src/accounts.js"; +export { resolveSignalReactionLevel } from "../../extensions/signal/src/reaction-level.js"; +export { + removeReactionSignal, + sendReactionSignal, +} from "../../extensions/signal/src/send-reactions.js"; +export { sendMessageSignal } from "../../extensions/signal/src/send.js"; diff --git a/src/plugin-sdk/slack.ts b/src/plugin-sdk/slack.ts index f7533b95687..b883aebac95 100644 --- a/src/plugin-sdk/slack.ts +++ b/src/plugin-sdk/slack.ts @@ -1,5 +1,7 @@ export type { OpenClawConfig } from "../config/config.js"; export type { SlackAccountConfig } from "../config/types.slack.js"; +export type { InspectedSlackAccount } from "../../extensions/slack/src/account-inspect.js"; +export type { ResolvedSlackAccount } from "../../extensions/slack/src/accounts.js"; export type { ChannelMessageActionContext, ChannelPlugin, @@ -43,3 +45,40 @@ export { } from "../channels/plugins/group-mentions.js"; export { SlackConfigSchema } from "../config/zod-schema.providers-core.js"; export { buildComputedAccountStatusSnapshot } from "./status-helpers.js"; + +export { + listEnabledSlackAccounts, + listSlackAccountIds, + resolveDefaultSlackAccountId, + resolveSlackAccount, + resolveSlackReplyToMode, +} from "../../extensions/slack/src/accounts.js"; +export { isSlackInteractiveRepliesEnabled } from "../../extensions/slack/src/interactive-replies.js"; +export { inspectSlackAccount } from "../../extensions/slack/src/account-inspect.js"; +export { parseSlackTarget, resolveSlackChannelId } from "./slack-targets.js"; +export { + extractSlackToolSend, + listSlackMessageActions, +} from "../../extensions/slack/src/message-actions.js"; +export { buildSlackThreadingToolContext } from "../../extensions/slack/src/threading-tool-context.js"; +export { parseSlackBlocksInput } from "../../extensions/slack/src/blocks-input.js"; +export { handleSlackHttpRequest } from "../../extensions/slack/src/http/index.js"; +export { sendMessageSlack } from "../../extensions/slack/src/send.js"; +export { + deleteSlackMessage, + downloadSlackFile, + editSlackMessage, + getSlackMemberInfo, + listSlackEmojis, + listSlackPins, + listSlackReactions, + pinSlackMessage, + reactSlackMessage, + readSlackMessages, + removeOwnSlackReactions, + removeSlackReaction, + sendSlackMessage, + unpinSlackMessage, +} from "../../extensions/slack/src/actions.js"; +export { recordSlackThreadParticipation } from "../../extensions/slack/src/sent-thread-cache.js"; +export { handleSlackMessageAction } from "./slack-message-actions.js"; diff --git a/src/plugin-sdk/speech.ts b/src/plugin-sdk/speech.ts new file mode 100644 index 00000000000..3fb9758ffdc --- /dev/null +++ b/src/plugin-sdk/speech.ts @@ -0,0 +1,7 @@ +// Public speech-provider builders for bundled or third-party plugins. + +export { buildElevenLabsSpeechProvider } from "../tts/providers/elevenlabs.js"; +export { buildMicrosoftSpeechProvider } from "../tts/providers/microsoft.js"; +export { buildOpenAISpeechProvider } from "../tts/providers/openai.js"; +export { parseTtsDirectives } from "../tts/tts-core.js"; +export type { SpeechVoiceOption } from "../tts/provider-types.js"; diff --git a/src/plugin-sdk/state-paths.ts b/src/plugin-sdk/state-paths.ts new file mode 100644 index 00000000000..aeae39fa1f1 --- /dev/null +++ b/src/plugin-sdk/state-paths.ts @@ -0,0 +1,3 @@ +// Public state/config path helpers for plugins that persist small caches. + +export { resolveOAuthDir, resolveStateDir, STATE_DIR } from "../config/paths.js"; diff --git a/src/plugin-sdk/telegram.ts b/src/plugin-sdk/telegram.ts index 6551baffe87..cb26a82cb13 100644 --- a/src/plugin-sdk/telegram.ts +++ b/src/plugin-sdk/telegram.ts @@ -12,9 +12,18 @@ export type { TelegramActionConfig, TelegramNetworkConfig, } from "../config/types.js"; +export type { InspectedTelegramAccount } from "../../extensions/telegram/src/account-inspect.js"; +export type { ResolvedTelegramAccount } from "../../extensions/telegram/src/accounts.js"; +export type { TelegramProbe } from "../../extensions/telegram/src/probe.js"; +export type { + TelegramButtonStyle, + TelegramInlineButtons, +} from "../../extensions/telegram/src/button-types.js"; +export type { StickerMetadata } from "../../extensions/telegram/src/bot/types.js"; export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; +export { parseTelegramTopicConversation } from "../acp/conversation-id.js"; export { PAIRING_APPROVED_MESSAGE, @@ -28,6 +37,7 @@ export { } from "./channel-plugin-common.js"; export { clearAccountEntryFields } from "../channels/plugins/config-helpers.js"; +export { resolveTelegramPollVisibility } from "../poll-params.js"; export { projectCredentialSnapshotFields, @@ -49,3 +59,57 @@ export { export { TelegramConfigSchema } from "../config/zod-schema.providers-core.js"; export { buildTokenChannelStatusSummary } from "./status-helpers.js"; + +export { + createTelegramActionGate, + listTelegramAccountIds, + resolveDefaultTelegramAccountId, + resolveTelegramPollActionGateState, + resolveTelegramAccount, +} from "../../extensions/telegram/src/accounts.js"; +export { inspectTelegramAccount } from "../../extensions/telegram/src/account-inspect.js"; +export { + looksLikeTelegramTargetId, + normalizeTelegramMessagingTarget, +} from "../../extensions/telegram/src/normalize.js"; +export { + parseTelegramReplyToMessageId, + parseTelegramThreadId, +} from "../../extensions/telegram/src/outbound-params.js"; +export { + isNumericTelegramUserId, + normalizeTelegramAllowFromEntry, +} from "../../extensions/telegram/src/allow-from.js"; +export { fetchTelegramChatId } from "../../extensions/telegram/src/api-fetch.js"; +export { + resolveTelegramInlineButtonsScope, + resolveTelegramTargetChatType, +} from "../../extensions/telegram/src/inline-buttons.js"; +export { resolveTelegramReactionLevel } from "../../extensions/telegram/src/reaction-level.js"; +export { + createForumTopicTelegram, + deleteMessageTelegram, + editForumTopicTelegram, + editMessageTelegram, + reactMessageTelegram, + sendMessageTelegram, + sendPollTelegram, + sendStickerTelegram, +} from "../../extensions/telegram/src/send.js"; +export { getCacheStats, searchStickers } from "../../extensions/telegram/src/sticker-cache.js"; +export { resolveTelegramToken } from "../../extensions/telegram/src/token.js"; +export { telegramMessageActions } from "../../extensions/telegram/src/channel-actions.js"; +export { collectTelegramStatusIssues } from "../../extensions/telegram/src/status-issues.js"; +export { sendTelegramPayloadMessages } from "../../extensions/telegram/src/outbound-adapter.js"; +export { + buildBrowseProvidersButton, + buildModelsKeyboard, + buildProviderKeyboard, + calculateTotalPages, + getModelsPageSize, + type ProviderInfo, +} from "../../extensions/telegram/src/model-buttons.js"; +export { + isTelegramExecApprovalApprover, + isTelegramExecApprovalClientEnabled, +} from "../../extensions/telegram/src/exec-approvals.js"; diff --git a/src/plugin-sdk/test-utils.ts b/src/plugin-sdk/test-utils.ts index 78307f694a6..5d825813d0e 100644 --- a/src/plugin-sdk/test-utils.ts +++ b/src/plugin-sdk/test-utils.ts @@ -6,3 +6,4 @@ export type { ChannelAccountSnapshot, ChannelGatewayContext } from "../channels/ export type { OpenClawConfig } from "../config/config.js"; export type { PluginRuntime } from "../plugins/runtime/types.js"; export type { RuntimeEnv } from "../runtime.js"; +export type { MockFn } from "../test-utils/vitest-mock-fn.js"; diff --git a/src/plugin-sdk/text-runtime.ts b/src/plugin-sdk/text-runtime.ts new file mode 100644 index 00000000000..bfdb2db690f --- /dev/null +++ b/src/plugin-sdk/text-runtime.ts @@ -0,0 +1,23 @@ +// Public shared text/formatting helpers for plugins that parse or rewrite message text. + +export * from "../logger.js"; +export * from "../logging/diagnostic.js"; +export * from "../logging/logger.js"; +export * from "../logging/redact.js"; +export * from "../logging/redact-identifier.js"; +export * from "../markdown/ir.js"; +export * from "../markdown/render.js"; +export * from "../markdown/tables.js"; +export * from "../markdown/whatsapp.js"; +export * from "../shared/global-singleton.js"; +export * from "../shared/string-normalization.js"; +export * from "../shared/string-sample.js"; +export * from "../shared/text/assistant-visible-text.js"; +export * from "../shared/text/code-regions.js"; +export * from "../shared/text/reasoning-tags.js"; +export * from "../terminal/safe-text.js"; +export * from "../utils.js"; +export * from "../utils/chunk-items.js"; +export * from "../utils/fetch-timeout.js"; +export * from "../utils/reaction-level.js"; +export * from "../utils/with-timeout.js"; diff --git a/src/plugin-sdk/whatsapp.ts b/src/plugin-sdk/whatsapp.ts index df814fa04eb..3727cc802ec 100644 --- a/src/plugin-sdk/whatsapp.ts +++ b/src/plugin-sdk/whatsapp.ts @@ -1,6 +1,14 @@ export type { ChannelMessageActionName } from "../channels/plugins/types.js"; export type { OpenClawConfig } from "../config/config.js"; export type { DmPolicy, GroupPolicy, WhatsAppAccountConfig } from "../config/types.js"; +export type { + WebChannelStatus, + WebMonitorTuning, +} from "../../extensions/whatsapp/src/auto-reply.js"; +export type { + WebInboundMessage, + WebListenerCloseReason, +} from "../../extensions/whatsapp/src/inbound.js"; export type { ChannelMessageActionContext, ChannelPlugin, @@ -36,6 +44,7 @@ export { } from "../channels/plugins/group-policy-warnings.js"; export { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js"; export { resolveWhatsAppOutboundTarget } from "../whatsapp/resolve-outbound-target.js"; +export { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "../whatsapp/normalize.js"; export { resolveAllowlistProviderRuntimeGroupPolicy, @@ -56,3 +65,48 @@ export { WhatsAppConfigSchema } from "../config/zod-schema.providers-whatsapp.js export { createActionGate, readStringParam } from "../agents/tools/common.js"; export { createPluginRuntimeStore } from "./runtime-store.js"; export { normalizeE164 } from "../utils.js"; + +export { + hasAnyWhatsAppAuth, + listEnabledWhatsAppAccounts, + resolveWhatsAppAccount, +} from "../../extensions/whatsapp/src/accounts.js"; +export { + WA_WEB_AUTH_DIR, + logWebSelfId, + logoutWeb, + pickWebChannel, + webAuthExists, +} from "../../extensions/whatsapp/src/auth-store.js"; +export { + DEFAULT_WEB_MEDIA_BYTES, + HEARTBEAT_PROMPT, + HEARTBEAT_TOKEN, + monitorWebChannel, + resolveHeartbeatRecipients, + runWebHeartbeatOnce, +} from "../../extensions/whatsapp/src/auto-reply.js"; +export { + extractMediaPlaceholder, + extractText, + monitorWebInbox, +} from "../../extensions/whatsapp/src/inbound.js"; +export { loginWeb } from "../../extensions/whatsapp/src/login.js"; +export { + getDefaultLocalRoots, + loadWebMedia, + loadWebMediaRaw, + optimizeImageToJpeg, +} from "../../extensions/whatsapp/src/media.js"; +export { + sendMessageWhatsApp, + sendPollWhatsApp, + sendReactionWhatsApp, +} from "../../extensions/whatsapp/src/send.js"; +export { + createWaSocket, + formatError, + getStatusCode, + waitForWaConnection, +} from "../../extensions/whatsapp/src/session.js"; +export { createWhatsAppLoginTool } from "../../extensions/whatsapp/src/agent-tools-login.js"; diff --git a/src/plugin-sdk/zai.ts b/src/plugin-sdk/zai.ts new file mode 100644 index 00000000000..6981a0994bf --- /dev/null +++ b/src/plugin-sdk/zai.ts @@ -0,0 +1,7 @@ +// Public Z.ai helpers for provider plugins that need endpoint detection. + +export { + detectZaiEndpoint, + type ZaiDetectedEndpoint, + type ZaiEndpointId, +} from "../commands/zai-endpoint-detect.js"; diff --git a/src/security/audit-channel.runtime.ts b/src/security/audit-channel.runtime.ts index c3435fc2a64..867f0a91162 100644 --- a/src/security/audit-channel.runtime.ts +++ b/src/security/audit-channel.runtime.ts @@ -6,4 +6,4 @@ export { export { isNumericTelegramUserId, normalizeTelegramAllowFromEntry, -} from "../plugin-sdk-internal/telegram.js"; +} from "../plugin-sdk/telegram.js"; From 70da383a613ba9f572b449e5b388009ed02425e3 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:18:16 -0700 Subject: [PATCH 004/187] test: fix rebase fallout --- extensions/kilocode/index.ts | 2 +- extensions/qianfan/index.ts | 2 +- extensions/synthetic/index.ts | 2 +- extensions/together/index.ts | 2 +- extensions/venice/index.ts | 2 +- extensions/vercel-ai-gateway/index.ts | 2 +- extensions/xiaomi/index.ts | 2 +- src/plugins/provider-catalog.test.ts | 30 ++++++++++++++++++++------- 8 files changed, 30 insertions(+), 14 deletions(-) diff --git a/extensions/kilocode/index.ts b/extensions/kilocode/index.ts index 33dc9718021..c423606e552 100644 --- a/extensions/kilocode/index.ts +++ b/extensions/kilocode/index.ts @@ -4,8 +4,8 @@ import { createKilocodeWrapper, isProxyReasoningUnsupported, } from "openclaw/plugin-sdk/provider-stream"; -import { applyKilocodeConfig, KILOCODE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyKilocodeConfig, KILOCODE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildKilocodeProviderWithDiscovery } from "./provider-catalog.js"; const PROVIDER_ID = "kilocode"; diff --git a/extensions/qianfan/index.ts b/extensions/qianfan/index.ts index e8f2f2cc59d..42b5b8a0cb7 100644 --- a/extensions/qianfan/index.ts +++ b/extensions/qianfan/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { applyQianfanConfig, QIANFAN_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyQianfanConfig, QIANFAN_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildQianfanProvider } from "./provider-catalog.js"; const PROVIDER_ID = "qianfan"; diff --git a/extensions/synthetic/index.ts b/extensions/synthetic/index.ts index 19e7424bfb7..f538dd1fbcb 100644 --- a/extensions/synthetic/index.ts +++ b/extensions/synthetic/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { applySyntheticConfig, SYNTHETIC_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applySyntheticConfig, SYNTHETIC_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSyntheticProvider } from "./provider-catalog.js"; const PROVIDER_ID = "synthetic"; diff --git a/extensions/together/index.ts b/extensions/together/index.ts index 5f6dfb3e7c4..2ae0072ca88 100644 --- a/extensions/together/index.ts +++ b/extensions/together/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { applyTogetherConfig, TOGETHER_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyTogetherConfig, TOGETHER_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildTogetherProvider } from "./provider-catalog.js"; const PROVIDER_ID = "together"; diff --git a/extensions/venice/index.ts b/extensions/venice/index.ts index d25e8ffb9b8..b67831fe7a9 100644 --- a/extensions/venice/index.ts +++ b/extensions/venice/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { applyVeniceConfig, VENICE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyVeniceConfig, VENICE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildVeniceProvider } from "./provider-catalog.js"; const PROVIDER_ID = "venice"; diff --git a/extensions/vercel-ai-gateway/index.ts b/extensions/vercel-ai-gateway/index.ts index 1f126260321..433f6cee09a 100644 --- a/extensions/vercel-ai-gateway/index.ts +++ b/extensions/vercel-ai-gateway/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { applyVercelAiGatewayConfig, VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyVercelAiGatewayConfig, VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildVercelAiGatewayProvider } from "./provider-catalog.js"; const PROVIDER_ID = "vercel-ai-gateway"; diff --git a/extensions/xiaomi/index.ts b/extensions/xiaomi/index.ts index 1badf6e2d9d..2edc1b33b25 100644 --- a/extensions/xiaomi/index.ts +++ b/extensions/xiaomi/index.ts @@ -1,8 +1,8 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { PROVIDER_LABELS } from "openclaw/plugin-sdk/provider-usage"; -import { applyXiaomiConfig, XIAOMI_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { applyXiaomiConfig, XIAOMI_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildXiaomiProvider } from "./provider-catalog.js"; const PROVIDER_ID = "xiaomi"; diff --git a/src/plugins/provider-catalog.test.ts b/src/plugins/provider-catalog.test.ts index e150d021a7b..b8c865dec5d 100644 --- a/src/plugins/provider-catalog.test.ts +++ b/src/plugins/provider-catalog.test.ts @@ -7,6 +7,15 @@ import { } from "./provider-catalog.js"; import type { ProviderCatalogContext } from "./types.js"; +function createProviderConfig(params?: { provider?: string; baseUrl?: string }) { + return { + api: "openai-completions" as const, + provider: params?.provider ?? "test-provider", + baseUrl: params?.baseUrl ?? "https://default.example/v1", + models: [], + }; +} + function createCatalogContext(params: { config?: OpenClawConfig; apiKeys?: Record; @@ -38,7 +47,7 @@ describe("buildSingleProviderApiKeyCatalog", () => { const result = await buildSingleProviderApiKeyCatalog({ ctx: createCatalogContext({}), providerId: "test-provider", - buildProvider: () => ({ api: "openai-completions", provider: "test-provider" }), + buildProvider: () => createProviderConfig(), }); expect(result).toBeNull(); @@ -50,12 +59,14 @@ describe("buildSingleProviderApiKeyCatalog", () => { apiKeys: { "test-provider": "secret-key" }, }), providerId: "test-provider", - buildProvider: async () => ({ api: "openai-completions", provider: "test-provider" }), + buildProvider: async () => createProviderConfig(), }); expect(result).toEqual({ provider: { api: "openai-completions", + baseUrl: "https://default.example/v1", + models: [], provider: "test-provider", apiKey: "secret-key", }, @@ -71,6 +82,7 @@ describe("buildSingleProviderApiKeyCatalog", () => { providers: { "test-provider": { baseUrl: " https://override.example/v1/ ", + models: [], }, }, }, @@ -78,8 +90,7 @@ describe("buildSingleProviderApiKeyCatalog", () => { }), providerId: "test-provider", buildProvider: () => ({ - api: "openai-completions", - provider: "test-provider", + ...createProviderConfig(), baseUrl: "https://default.example/v1", }), allowExplicitBaseUrl: true, @@ -88,8 +99,9 @@ describe("buildSingleProviderApiKeyCatalog", () => { expect(result).toEqual({ provider: { api: "openai-completions", - provider: "test-provider", baseUrl: "https://override.example/v1/", + models: [], + provider: "test-provider", apiKey: "secret-key", }, }); @@ -102,8 +114,8 @@ describe("buildSingleProviderApiKeyCatalog", () => { }), providerId: "test-provider", buildProviders: async () => ({ - alpha: { api: "openai-completions", provider: "alpha" }, - beta: { api: "openai-completions", provider: "beta" }, + alpha: createProviderConfig({ provider: "alpha" }), + beta: createProviderConfig({ provider: "beta" }), }), }); @@ -111,11 +123,15 @@ describe("buildSingleProviderApiKeyCatalog", () => { providers: { alpha: { api: "openai-completions", + baseUrl: "https://default.example/v1", + models: [], provider: "alpha", apiKey: "secret-key", }, beta: { api: "openai-completions", + baseUrl: "https://default.example/v1", + models: [], provider: "beta", apiKey: "secret-key", }, From 529272d3383e91e365886dbc466b4e34b3626773 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:16:14 -0700 Subject: [PATCH 005/187] WhatsApp: lazy-load channel auth helpers --- extensions/whatsapp/src/channel.runtime.ts | 11 ++++++ extensions/whatsapp/src/channel.ts | 43 +++++++++++----------- 2 files changed, 32 insertions(+), 22 deletions(-) diff --git a/extensions/whatsapp/src/channel.runtime.ts b/extensions/whatsapp/src/channel.runtime.ts index ff67d34ee10..46dd5f987d2 100644 --- a/extensions/whatsapp/src/channel.runtime.ts +++ b/extensions/whatsapp/src/channel.runtime.ts @@ -1 +1,12 @@ +export { getActiveWebListener } from "./active-listener.js"; +export { + getWebAuthAgeMs, + logWebSelfId, + logoutWeb, + readWebSelfId, + webAuthExists, +} from "./auth-store.js"; +export { loginWeb } from "./login.js"; +export { startWebLoginWithQr, waitForWebLogin } from "./login-qr.js"; export { whatsappSetupWizard } from "./setup-surface.js"; +export { monitorWebChannel } from "../../../src/channels/web/index.js"; diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 4701c80070b..7e4be853c23 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -223,7 +223,7 @@ export const whatsappPlugin: ChannelPlugin = { directory: { self: async ({ cfg, accountId }) => { const account = resolveWhatsAppAccount({ cfg, accountId }); - const { e164, jid } = getWhatsAppRuntime().channel.whatsapp.readWebSelfId(account.authDir); + const { e164, jid } = (await loadWhatsAppChannelRuntime()).readWebSelfId(account.authDir); const id = e164 ?? jid; if (!id) { return null; @@ -298,12 +298,9 @@ export const whatsappPlugin: ChannelPlugin = { auth: { login: async ({ cfg, accountId, runtime, verbose }) => { const resolvedAccountId = accountId?.trim() || resolveDefaultWhatsAppAccountId(cfg); - await getWhatsAppRuntime().channel.whatsapp.loginWeb( - Boolean(verbose), - undefined, - runtime, - resolvedAccountId, - ); + await ( + await loadWhatsAppChannelRuntime() + ).loginWeb(Boolean(verbose), undefined, runtime, resolvedAccountId); }, }, heartbeat: { @@ -313,14 +310,14 @@ export const whatsappPlugin: ChannelPlugin = { } const account = resolveWhatsAppAccount({ cfg, accountId }); const authExists = await ( - deps?.webAuthExists ?? getWhatsAppRuntime().channel.whatsapp.webAuthExists + deps?.webAuthExists ?? (await loadWhatsAppChannelRuntime()).webAuthExists )(account.authDir); if (!authExists) { return { ok: false, reason: "whatsapp-not-linked" }; } const listenerActive = deps?.hasActiveWebListener ? deps.hasActiveWebListener() - : Boolean(getWhatsAppRuntime().channel.whatsapp.getActiveWebListener()); + : Boolean((await loadWhatsAppChannelRuntime()).getActiveWebListener()); if (!listenerActive) { return { ok: false, reason: "whatsapp-not-running" }; } @@ -347,13 +344,13 @@ export const whatsappPlugin: ChannelPlugin = { typeof snapshot.linked === "boolean" ? snapshot.linked : authDir - ? await getWhatsAppRuntime().channel.whatsapp.webAuthExists(authDir) + ? await (await loadWhatsAppChannelRuntime()).webAuthExists(authDir) : false; const authAgeMs = - linked && authDir ? getWhatsAppRuntime().channel.whatsapp.getWebAuthAgeMs(authDir) : null; + linked && authDir ? (await loadWhatsAppChannelRuntime()).getWebAuthAgeMs(authDir) : null; const self = linked && authDir - ? getWhatsAppRuntime().channel.whatsapp.readWebSelfId(authDir) + ? (await loadWhatsAppChannelRuntime()).readWebSelfId(authDir) : { e164: null, jid: null }; return { configured: linked, @@ -371,7 +368,7 @@ export const whatsappPlugin: ChannelPlugin = { }; }, buildAccountSnapshot: async ({ account, runtime }) => { - const linked = await getWhatsAppRuntime().channel.whatsapp.webAuthExists(account.authDir); + const linked = await (await loadWhatsAppChannelRuntime()).webAuthExists(account.authDir); return { accountId: account.accountId, name: account.name, @@ -392,20 +389,18 @@ export const whatsappPlugin: ChannelPlugin = { }, resolveAccountState: ({ configured }) => (configured ? "linked" : "not linked"), logSelfId: ({ account, runtime, includeChannelPrefix }) => { - getWhatsAppRuntime().channel.whatsapp.logWebSelfId( - account.authDir, - runtime, - includeChannelPrefix, + void loadWhatsAppChannelRuntime().then((runtimeExports) => + runtimeExports.logWebSelfId(account.authDir, runtime, includeChannelPrefix), ); }, }, gateway: { startAccount: async (ctx) => { const account = ctx.account; - const { e164, jid } = getWhatsAppRuntime().channel.whatsapp.readWebSelfId(account.authDir); + const { e164, jid } = (await loadWhatsAppChannelRuntime()).readWebSelfId(account.authDir); const identity = e164 ? e164 : jid ? `jid ${jid}` : "unknown"; ctx.log?.info(`[${account.accountId}] starting provider (${identity})`); - return getWhatsAppRuntime().channel.whatsapp.monitorWebChannel( + return (await loadWhatsAppChannelRuntime()).monitorWebChannel( getWhatsAppRuntime().logging.shouldLogVerbose(), undefined, true, @@ -419,16 +414,20 @@ export const whatsappPlugin: ChannelPlugin = { ); }, loginWithQrStart: async ({ accountId, force, timeoutMs, verbose }) => - await getWhatsAppRuntime().channel.whatsapp.startWebLoginWithQr({ + await ( + await loadWhatsAppChannelRuntime() + ).startWebLoginWithQr({ accountId, force, timeoutMs, verbose, }), loginWithQrWait: async ({ accountId, timeoutMs }) => - await getWhatsAppRuntime().channel.whatsapp.waitForWebLogin({ accountId, timeoutMs }), + await (await loadWhatsAppChannelRuntime()).waitForWebLogin({ accountId, timeoutMs }), logoutAccount: async ({ account, runtime }) => { - const cleared = await getWhatsAppRuntime().channel.whatsapp.logoutWeb({ + const cleared = await ( + await loadWhatsAppChannelRuntime() + ).logoutWeb({ authDir: account.authDir, isLegacyAuthDir: account.isLegacyAuthDir, runtime, From 9183081bf1aaed88ffbd9f62b8fbb5ffcae00fa6 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:19:37 -0700 Subject: [PATCH 006/187] refactor: move provider auth helpers into plugin layer --- .../auth-choice.apply.api-key-providers.ts | 10 +- src/commands/auth-choice.apply.oauth.ts | 2 +- .../auth-choice.apply.plugin-provider.test.ts | 2 +- .../auth-choice.apply.plugin-provider.ts | 2 +- src/commands/auth-credentials.ts | 195 +-------- src/commands/auth-profile-config.ts | 75 +--- src/commands/models/auth.ts | 2 +- src/commands/ollama-setup.ts | 2 +- src/commands/onboard-auth.config-core.ts | 2 +- src/commands/onboard-auth.config-litellm.ts | 4 +- src/commands/onboard-auth.config-shared.ts | 228 +---------- src/commands/onboard-auth.credentials.ts | 385 ++---------------- .../local/auth-choice.ts | 8 +- src/commands/self-hosted-provider-setup.ts | 2 +- src/plugin-sdk/provider-auth.ts | 3 +- src/plugin-sdk/provider-onboard.ts | 2 +- src/plugins/provider-api-key-auth.runtime.ts | 3 +- src/providers/github-copilot-auth.ts | 2 +- 18 files changed, 68 insertions(+), 861 deletions(-) diff --git a/src/commands/auth-choice.apply.api-key-providers.ts b/src/commands/auth-choice.apply.api-key-providers.ts index 3ff35a46365..0d508ff687f 100644 --- a/src/commands/auth-choice.apply.api-key-providers.ts +++ b/src/commands/auth-choice.apply.api-key-providers.ts @@ -1,14 +1,10 @@ import { ensureAuthProfileStore, resolveAuthProfileOrder } from "../agents/auth-profiles.js"; +import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; +import { LITELLM_DEFAULT_MODEL_REF, setLitellmApiKey } from "../plugins/provider-auth-storage.js"; import { normalizeApiKeyInput, validateApiKeyInput } from "./auth-choice.api-key.js"; import { ensureApiKeyFromOptionEnvOrPrompt } from "./auth-choice.apply-helpers.js"; import type { ApplyAuthChoiceParams, ApplyAuthChoiceResult } from "./auth-choice.apply.js"; -import { - applyAuthProfileConfig, - applyLitellmConfig, - applyLitellmProviderConfig, - LITELLM_DEFAULT_MODEL_REF, - setLitellmApiKey, -} from "./onboard-auth.js"; +import { applyLitellmConfig, applyLitellmProviderConfig } from "./onboard-auth.config-litellm.js"; import type { SecretInputMode } from "./onboard-types.js"; type ApiKeyProviderConfigApplier = ( diff --git a/src/commands/auth-choice.apply.oauth.ts b/src/commands/auth-choice.apply.oauth.ts index 0e9a5523ce0..a2a3104e447 100644 --- a/src/commands/auth-choice.apply.oauth.ts +++ b/src/commands/auth-choice.apply.oauth.ts @@ -1,8 +1,8 @@ +import { applyAuthProfileConfig, writeOAuthCredentials } from "../plugins/provider-auth-helpers.js"; import type { ApplyAuthChoiceParams, ApplyAuthChoiceResult } from "./auth-choice.apply.js"; import { loginChutes } from "./chutes-oauth.js"; import { isRemoteEnvironment } from "./oauth-env.js"; import { createVpsAwareOAuthHandlers } from "./oauth-flow.js"; -import { applyAuthProfileConfig, writeOAuthCredentials } from "./onboard-auth.js"; import { openUrl } from "./onboard-helpers.js"; export async function applyAuthChoiceOAuth( diff --git a/src/commands/auth-choice.apply.plugin-provider.test.ts b/src/commands/auth-choice.apply.plugin-provider.test.ts index 27615989d1d..1e731fde48f 100644 --- a/src/commands/auth-choice.apply.plugin-provider.test.ts +++ b/src/commands/auth-choice.apply.plugin-provider.test.ts @@ -44,7 +44,7 @@ vi.mock("../agents/agent-paths.js", () => ({ })); const applyAuthProfileConfig = vi.hoisted(() => vi.fn((config) => config)); -vi.mock("./onboard-auth.js", () => ({ +vi.mock("../plugins/provider-auth-helpers.js", () => ({ applyAuthProfileConfig, })); diff --git a/src/commands/auth-choice.apply.plugin-provider.ts b/src/commands/auth-choice.apply.plugin-provider.ts index da125a4065d..afdad97ecec 100644 --- a/src/commands/auth-choice.apply.plugin-provider.ts +++ b/src/commands/auth-choice.apply.plugin-provider.ts @@ -7,11 +7,11 @@ import { import { upsertAuthProfile } from "../agents/auth-profiles.js"; import { resolveDefaultAgentWorkspaceDir } from "../agents/workspace.js"; import { enablePluginInConfig } from "../plugins/enable.js"; +import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; import type { ProviderAuthMethod } from "../plugins/types.js"; import type { ApplyAuthChoiceParams, ApplyAuthChoiceResult } from "./auth-choice.apply.js"; import { isRemoteEnvironment } from "./oauth-env.js"; import { createVpsAwareOAuthHandlers } from "./oauth-flow.js"; -import { applyAuthProfileConfig } from "./onboard-auth.js"; import { openUrl } from "./onboard-helpers.js"; import type { OnboardOptions } from "./onboard-types.js"; import { diff --git a/src/commands/auth-credentials.ts b/src/commands/auth-credentials.ts index 4ee69149a92..94e320f48db 100644 --- a/src/commands/auth-credentials.ts +++ b/src/commands/auth-credentials.ts @@ -1,189 +1,6 @@ -import fs from "node:fs"; -import path from "node:path"; -import type { OAuthCredentials } from "@mariozechner/pi-ai"; -import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; -import { upsertAuthProfile } from "../agents/auth-profiles.js"; -import { resolveStateDir } from "../config/paths.js"; -import { - coerceSecretRef, - DEFAULT_SECRET_PROVIDER_ALIAS, - type SecretInput, - type SecretRef, -} from "../config/types.secrets.js"; -import { PROVIDER_ENV_VARS } from "../secrets/provider-env-vars.js"; -import { normalizeSecretInput } from "../utils/normalize-secret-input.js"; -import type { SecretInputMode } from "./onboard-types.js"; - -const ENV_REF_PATTERN = /^\$\{([A-Z][A-Z0-9_]*)\}$/; - -const resolveAuthAgentDir = (agentDir?: string) => agentDir ?? resolveOpenClawAgentDir(); - -export type ApiKeyStorageOptions = { - secretInputMode?: SecretInputMode; -}; - -export type WriteOAuthCredentialsOptions = { - syncSiblingAgents?: boolean; -}; - -function buildEnvSecretRef(id: string): SecretRef { - return { source: "env", provider: DEFAULT_SECRET_PROVIDER_ALIAS, id }; -} - -function parseEnvSecretRef(value: string): SecretRef | null { - const match = ENV_REF_PATTERN.exec(value); - if (!match) { - return null; - } - return buildEnvSecretRef(match[1]); -} - -function resolveProviderDefaultEnvSecretRef(provider: string): SecretRef { - const envVars = PROVIDER_ENV_VARS[provider]; - const envVar = envVars?.find((candidate) => candidate.trim().length > 0); - if (!envVar) { - throw new Error( - `Provider "${provider}" does not have a default env var mapping for secret-input-mode=ref.`, - ); - } - return buildEnvSecretRef(envVar); -} - -function resolveApiKeySecretInput( - provider: string, - input: SecretInput, - options?: ApiKeyStorageOptions, -): SecretInput { - const coercedRef = coerceSecretRef(input); - if (coercedRef) { - return coercedRef; - } - const normalized = normalizeSecretInput(input); - const inlineEnvRef = parseEnvSecretRef(normalized); - if (inlineEnvRef) { - return inlineEnvRef; - } - if (options?.secretInputMode === "ref") { - return resolveProviderDefaultEnvSecretRef(provider); - } - return normalized; -} - -export function buildApiKeyCredential( - provider: string, - input: SecretInput, - metadata?: Record, - options?: ApiKeyStorageOptions, -): { - type: "api_key"; - provider: string; - key?: string; - keyRef?: SecretRef; - metadata?: Record; -} { - const secretInput = resolveApiKeySecretInput(provider, input, options); - if (typeof secretInput === "string") { - return { - type: "api_key", - provider, - key: secretInput, - ...(metadata ? { metadata } : {}), - }; - } - return { - type: "api_key", - provider, - keyRef: secretInput, - ...(metadata ? { metadata } : {}), - }; -} - -/** Resolve real path, returning null if the target doesn't exist. */ -function safeRealpathSync(dir: string): string | null { - try { - return fs.realpathSync(path.resolve(dir)); - } catch { - return null; - } -} - -function resolveSiblingAgentDirs(primaryAgentDir: string): string[] { - const normalized = path.resolve(primaryAgentDir); - const parentOfAgent = path.dirname(normalized); - const candidateAgentsRoot = path.dirname(parentOfAgent); - const looksLikeStandardLayout = - path.basename(normalized) === "agent" && path.basename(candidateAgentsRoot) === "agents"; - - const agentsRoot = looksLikeStandardLayout - ? candidateAgentsRoot - : path.join(resolveStateDir(), "agents"); - - const entries = (() => { - try { - return fs.readdirSync(agentsRoot, { withFileTypes: true }); - } catch { - return []; - } - })(); - const discovered = entries - .filter((entry) => entry.isDirectory() || entry.isSymbolicLink()) - .map((entry) => path.join(agentsRoot, entry.name, "agent")); - - const seen = new Set(); - const result: string[] = []; - for (const dir of [normalized, ...discovered]) { - const real = safeRealpathSync(dir); - if (real && !seen.has(real)) { - seen.add(real); - result.push(real); - } - } - return result; -} - -export async function writeOAuthCredentials( - provider: string, - creds: OAuthCredentials, - agentDir?: string, - options?: WriteOAuthCredentialsOptions, -): Promise { - const email = - typeof creds.email === "string" && creds.email.trim() ? creds.email.trim() : "default"; - const profileId = `${provider}:${email}`; - const resolvedAgentDir = path.resolve(resolveAuthAgentDir(agentDir)); - const targetAgentDirs = options?.syncSiblingAgents - ? resolveSiblingAgentDirs(resolvedAgentDir) - : [resolvedAgentDir]; - - const credential = { - type: "oauth" as const, - provider, - ...creds, - }; - - upsertAuthProfile({ - profileId, - credential, - agentDir: resolvedAgentDir, - }); - - if (options?.syncSiblingAgents) { - const primaryReal = safeRealpathSync(resolvedAgentDir); - for (const targetAgentDir of targetAgentDirs) { - const targetReal = safeRealpathSync(targetAgentDir); - if (targetReal && primaryReal && targetReal === primaryReal) { - continue; - } - try { - upsertAuthProfile({ - profileId, - credential, - agentDir: targetAgentDir, - }); - } catch { - // Best-effort: sibling sync failure must not block primary setup. - } - } - } - return profileId; -} +export { + buildApiKeyCredential, + type ApiKeyStorageOptions, + writeOAuthCredentials, + type WriteOAuthCredentialsOptions, +} from "../plugins/provider-auth-helpers.js"; diff --git a/src/commands/auth-profile-config.ts b/src/commands/auth-profile-config.ts index 90be398f5b0..c3879e01846 100644 --- a/src/commands/auth-profile-config.ts +++ b/src/commands/auth-profile-config.ts @@ -1,74 +1 @@ -import { normalizeProviderIdForAuth } from "../agents/provider-id.js"; -import type { OpenClawConfig } from "../config/config.js"; - -export function applyAuthProfileConfig( - cfg: OpenClawConfig, - params: { - profileId: string; - provider: string; - mode: "api_key" | "oauth" | "token"; - email?: string; - preferProfileFirst?: boolean; - }, -): OpenClawConfig { - const normalizedProvider = normalizeProviderIdForAuth(params.provider); - const profiles = { - ...cfg.auth?.profiles, - [params.profileId]: { - provider: params.provider, - mode: params.mode, - ...(params.email ? { email: params.email } : {}), - }, - }; - - const configuredProviderProfiles = Object.entries(cfg.auth?.profiles ?? {}) - .filter(([, profile]) => normalizeProviderIdForAuth(profile.provider) === normalizedProvider) - .map(([profileId, profile]) => ({ profileId, mode: profile.mode })); - - // Maintain `auth.order` when it already exists. Additionally, if we detect - // mixed auth modes for the same provider (e.g. legacy oauth + newly selected - // api_key), create an explicit order to keep the newly selected profile first. - const existingProviderOrder = cfg.auth?.order?.[params.provider]; - const preferProfileFirst = params.preferProfileFirst ?? true; - const reorderedProviderOrder = - existingProviderOrder && preferProfileFirst - ? [ - params.profileId, - ...existingProviderOrder.filter((profileId) => profileId !== params.profileId), - ] - : existingProviderOrder; - const hasMixedConfiguredModes = configuredProviderProfiles.some( - ({ profileId, mode }) => profileId !== params.profileId && mode !== params.mode, - ); - const derivedProviderOrder = - existingProviderOrder === undefined && preferProfileFirst && hasMixedConfiguredModes - ? [ - params.profileId, - ...configuredProviderProfiles - .map(({ profileId }) => profileId) - .filter((profileId) => profileId !== params.profileId), - ] - : undefined; - const order = - existingProviderOrder !== undefined - ? { - ...cfg.auth?.order, - [params.provider]: reorderedProviderOrder?.includes(params.profileId) - ? reorderedProviderOrder - : [...(reorderedProviderOrder ?? []), params.profileId], - } - : derivedProviderOrder - ? { - ...cfg.auth?.order, - [params.provider]: derivedProviderOrder, - } - : cfg.auth?.order; - return { - ...cfg, - auth: { - ...cfg.auth, - profiles, - ...(order ? { order } : {}), - }, - }; -} +export { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; diff --git a/src/commands/models/auth.ts b/src/commands/models/auth.ts index 6001ede2ea4..c3de2dd06dc 100644 --- a/src/commands/models/auth.ts +++ b/src/commands/models/auth.ts @@ -23,6 +23,7 @@ import { formatCliCommand } from "../../cli/command-format.js"; import { parseDurationMs } from "../../cli/parse-duration.js"; import type { OpenClawConfig } from "../../config/config.js"; import { logConfigUpdated } from "../../config/logging.js"; +import { applyAuthProfileConfig } from "../../plugins/provider-auth-helpers.js"; import { resolvePluginProviders } from "../../plugins/providers.js"; import type { ProviderAuthMethod, @@ -34,7 +35,6 @@ import { stylePromptHint, stylePromptMessage } from "../../terminal/prompt-style import { createClackPrompter } from "../../wizard/clack-prompter.js"; import { isRemoteEnvironment } from "../oauth-env.js"; import { createVpsAwareOAuthHandlers } from "../oauth-flow.js"; -import { applyAuthProfileConfig } from "../onboard-auth.js"; import { openUrl } from "../onboard-helpers.js"; import { applyDefaultModel, diff --git a/src/commands/ollama-setup.ts b/src/commands/ollama-setup.ts index 4557f606bb6..31499d3f0a6 100644 --- a/src/commands/ollama-setup.ts +++ b/src/commands/ollama-setup.ts @@ -8,10 +8,10 @@ import { type OllamaModelWithContext, } from "../agents/ollama-models.js"; import type { OpenClawConfig } from "../config/config.js"; +import { applyAgentDefaultModelPrimary } from "../plugins/provider-onboarding-config.js"; import type { RuntimeEnv } from "../runtime.js"; import { WizardCancelledError, type WizardPrompter } from "../wizard/prompts.js"; import { isRemoteEnvironment } from "./oauth-env.js"; -import { applyAgentDefaultModelPrimary } from "./onboard-auth.config-shared.js"; import { openUrl } from "./onboard-helpers.js"; import type { OnboardMode, OnboardOptions } from "./onboard-types.js"; diff --git a/src/commands/onboard-auth.config-core.ts b/src/commands/onboard-auth.config-core.ts index 7a78df71144..65b4fd40cf0 100644 --- a/src/commands/onboard-auth.config-core.ts +++ b/src/commands/onboard-auth.config-core.ts @@ -10,7 +10,7 @@ export { LITELLM_BASE_URL, LITELLM_DEFAULT_MODEL_ID, } from "./onboard-auth.config-litellm.js"; -export { applyAuthProfileConfig } from "./auth-profile-config.js"; +export { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; export { applyHuggingfaceConfig, applyHuggingfaceProviderConfig, diff --git a/src/commands/onboard-auth.config-litellm.ts b/src/commands/onboard-auth.config-litellm.ts index ec1ba251056..2dd60bab894 100644 --- a/src/commands/onboard-auth.config-litellm.ts +++ b/src/commands/onboard-auth.config-litellm.ts @@ -1,9 +1,9 @@ import type { OpenClawConfig } from "../config/config.js"; +import { LITELLM_DEFAULT_MODEL_REF } from "../plugins/provider-auth-storage.js"; import { applyAgentDefaultModelPrimary, applyProviderConfigWithDefaultModel, -} from "./onboard-auth.config-shared.js"; -import { LITELLM_DEFAULT_MODEL_REF } from "./onboard-auth.credentials.js"; +} from "../plugins/provider-onboarding-config.js"; export const LITELLM_BASE_URL = "http://localhost:4000"; export const LITELLM_DEFAULT_MODEL_ID = "claude-opus-4-6"; diff --git a/src/commands/onboard-auth.config-shared.ts b/src/commands/onboard-auth.config-shared.ts index 9e70eaac192..7c278eec644 100644 --- a/src/commands/onboard-auth.config-shared.ts +++ b/src/commands/onboard-auth.config-shared.ts @@ -1,221 +1,7 @@ -import { findNormalizedProviderKey } from "../agents/provider-id.js"; -import type { OpenClawConfig } from "../config/config.js"; -import type { AgentModelEntryConfig } from "../config/types.agent-defaults.js"; -import type { - ModelApi, - ModelDefinitionConfig, - ModelProviderConfig, -} from "../config/types.models.js"; - -function extractAgentDefaultModelFallbacks(model: unknown): string[] | undefined { - if (!model || typeof model !== "object") { - return undefined; - } - if (!("fallbacks" in model)) { - return undefined; - } - const fallbacks = (model as { fallbacks?: unknown }).fallbacks; - return Array.isArray(fallbacks) ? fallbacks.map((v) => String(v)) : undefined; -} - -export function applyOnboardAuthAgentModelsAndProviders( - cfg: OpenClawConfig, - params: { - agentModels: Record; - providers: Record; - }, -): OpenClawConfig { - return { - ...cfg, - agents: { - ...cfg.agents, - defaults: { - ...cfg.agents?.defaults, - models: params.agentModels, - }, - }, - models: { - mode: cfg.models?.mode ?? "merge", - providers: params.providers, - }, - }; -} - -export function applyAgentDefaultModelPrimary( - cfg: OpenClawConfig, - primary: string, -): OpenClawConfig { - const existingFallbacks = extractAgentDefaultModelFallbacks(cfg.agents?.defaults?.model); - return { - ...cfg, - agents: { - ...cfg.agents, - defaults: { - ...cfg.agents?.defaults, - model: { - ...(existingFallbacks ? { fallbacks: existingFallbacks } : undefined), - primary, - }, - }, - }, - }; -} - -export function applyProviderConfigWithDefaultModels( - cfg: OpenClawConfig, - params: { - agentModels: Record; - providerId: string; - api: ModelApi; - baseUrl: string; - defaultModels: ModelDefinitionConfig[]; - defaultModelId?: string; - }, -): OpenClawConfig { - const providerState = resolveProviderModelMergeState(cfg, params.providerId); - - const defaultModels = params.defaultModels; - const defaultModelId = params.defaultModelId ?? defaultModels[0]?.id; - const hasDefaultModel = defaultModelId - ? providerState.existingModels.some((model) => model.id === defaultModelId) - : true; - const mergedModels = - providerState.existingModels.length > 0 - ? hasDefaultModel || defaultModels.length === 0 - ? providerState.existingModels - : [...providerState.existingModels, ...defaultModels] - : defaultModels; - return applyProviderConfigWithMergedModels(cfg, { - agentModels: params.agentModels, - providerId: params.providerId, - providerState, - api: params.api, - baseUrl: params.baseUrl, - mergedModels, - fallbackModels: defaultModels, - }); -} - -export function applyProviderConfigWithDefaultModel( - cfg: OpenClawConfig, - params: { - agentModels: Record; - providerId: string; - api: ModelApi; - baseUrl: string; - defaultModel: ModelDefinitionConfig; - defaultModelId?: string; - }, -): OpenClawConfig { - return applyProviderConfigWithDefaultModels(cfg, { - agentModels: params.agentModels, - providerId: params.providerId, - api: params.api, - baseUrl: params.baseUrl, - defaultModels: [params.defaultModel], - defaultModelId: params.defaultModelId ?? params.defaultModel.id, - }); -} - -export function applyProviderConfigWithModelCatalog( - cfg: OpenClawConfig, - params: { - agentModels: Record; - providerId: string; - api: ModelApi; - baseUrl: string; - catalogModels: ModelDefinitionConfig[]; - }, -): OpenClawConfig { - const providerState = resolveProviderModelMergeState(cfg, params.providerId); - const catalogModels = params.catalogModels; - const mergedModels = - providerState.existingModels.length > 0 - ? [ - ...providerState.existingModels, - ...catalogModels.filter( - (model) => !providerState.existingModels.some((existing) => existing.id === model.id), - ), - ] - : catalogModels; - return applyProviderConfigWithMergedModels(cfg, { - agentModels: params.agentModels, - providerId: params.providerId, - providerState, - api: params.api, - baseUrl: params.baseUrl, - mergedModels, - fallbackModels: catalogModels, - }); -} - -type ProviderModelMergeState = { - providers: Record; - existingProvider?: ModelProviderConfig; - existingModels: ModelDefinitionConfig[]; -}; - -function resolveProviderModelMergeState( - cfg: OpenClawConfig, - providerId: string, -): ProviderModelMergeState { - const providers = { ...cfg.models?.providers } as Record; - const existingProviderKey = findNormalizedProviderKey(providers, providerId); - const existingProvider = - existingProviderKey !== undefined - ? (providers[existingProviderKey] as ModelProviderConfig | undefined) - : undefined; - const existingModels: ModelDefinitionConfig[] = Array.isArray(existingProvider?.models) - ? existingProvider.models - : []; - if (existingProviderKey && existingProviderKey !== providerId) { - delete providers[existingProviderKey]; - } - return { providers, existingProvider, existingModels }; -} - -function applyProviderConfigWithMergedModels( - cfg: OpenClawConfig, - params: { - agentModels: Record; - providerId: string; - providerState: ProviderModelMergeState; - api: ModelApi; - baseUrl: string; - mergedModels: ModelDefinitionConfig[]; - fallbackModels: ModelDefinitionConfig[]; - }, -): OpenClawConfig { - params.providerState.providers[params.providerId] = buildProviderConfig({ - existingProvider: params.providerState.existingProvider, - api: params.api, - baseUrl: params.baseUrl, - mergedModels: params.mergedModels, - fallbackModels: params.fallbackModels, - }); - return applyOnboardAuthAgentModelsAndProviders(cfg, { - agentModels: params.agentModels, - providers: params.providerState.providers, - }); -} - -function buildProviderConfig(params: { - existingProvider: ModelProviderConfig | undefined; - api: ModelApi; - baseUrl: string; - mergedModels: ModelDefinitionConfig[]; - fallbackModels: ModelDefinitionConfig[]; -}): ModelProviderConfig { - const { apiKey: existingApiKey, ...existingProviderRest } = (params.existingProvider ?? {}) as { - apiKey?: string; - }; - const normalizedApiKey = typeof existingApiKey === "string" ? existingApiKey.trim() : undefined; - - return { - ...existingProviderRest, - baseUrl: params.baseUrl, - api: params.api, - ...(normalizedApiKey ? { apiKey: normalizedApiKey } : {}), - models: params.mergedModels.length > 0 ? params.mergedModels : params.fallbackModels, - }; -} +export { + applyAgentDefaultModelPrimary, + applyOnboardAuthAgentModelsAndProviders, + applyProviderConfigWithDefaultModel, + applyProviderConfigWithDefaultModels, + applyProviderConfigWithModelCatalog, +} from "../plugins/provider-onboarding-config.js"; diff --git a/src/commands/onboard-auth.credentials.ts b/src/commands/onboard-auth.credentials.ts index 4377a8b4de3..578ad17859d 100644 --- a/src/commands/onboard-auth.credentials.ts +++ b/src/commands/onboard-auth.credentials.ts @@ -1,358 +1,43 @@ -import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; -import { upsertAuthProfile } from "../agents/auth-profiles.js"; -import type { SecretInput } from "../config/types.secrets.js"; -import { KILOCODE_DEFAULT_MODEL_REF } from "../providers/kilocode-shared.js"; -import { +export { buildApiKeyCredential, type ApiKeyStorageOptions, + HUGGINGFACE_DEFAULT_MODEL_REF, + KILOCODE_DEFAULT_MODEL_REF, + LITELLM_DEFAULT_MODEL_REF, + OPENROUTER_DEFAULT_MODEL_REF, + setAnthropicApiKey, + setByteplusApiKey, + setCloudflareAiGatewayConfig, + setGeminiApiKey, + setHuggingfaceApiKey, + setKilocodeApiKey, + setKimiCodingApiKey, + setLitellmApiKey, + setMinimaxApiKey, + setMistralApiKey, + setModelStudioApiKey, + setMoonshotApiKey, + setOpenaiApiKey, + setOpencodeGoApiKey, + setOpencodeZenApiKey, + setOpenrouterApiKey, + setQianfanApiKey, + setSyntheticApiKey, + setTogetherApiKey, + setVeniceApiKey, + setVercelAiGatewayApiKey, + setVolcengineApiKey, + setXaiApiKey, + setXiaomiApiKey, + setZaiApiKey, + TOGETHER_DEFAULT_MODEL_REF, + VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF, writeOAuthCredentials, type WriteOAuthCredentialsOptions, -} from "./auth-credentials.js"; + XIAOMI_DEFAULT_MODEL_REF, + ZAI_DEFAULT_MODEL_REF, +} from "../plugins/provider-auth-storage.js"; export { CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF } from "../agents/cloudflare-ai-gateway.js"; export { MISTRAL_DEFAULT_MODEL_REF } from "../../extensions/mistral/onboard.js"; export { MODELSTUDIO_DEFAULT_MODEL_REF } from "../../extensions/modelstudio/onboard.js"; export { XAI_DEFAULT_MODEL_REF } from "../../extensions/xai/onboard.js"; -export { KILOCODE_DEFAULT_MODEL_REF }; -export { - buildApiKeyCredential, - type ApiKeyStorageOptions, - writeOAuthCredentials, - type WriteOAuthCredentialsOptions, -}; - -const resolveAuthAgentDir = (agentDir?: string) => agentDir ?? resolveOpenClawAgentDir(); - -export async function setAnthropicApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "anthropic:default", - credential: buildApiKeyCredential("anthropic", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setOpenaiApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "openai:default", - credential: buildApiKeyCredential("openai", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setGeminiApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "google:default", - credential: buildApiKeyCredential("google", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setMinimaxApiKey( - key: SecretInput, - agentDir?: string, - profileId: string = "minimax:default", - options?: ApiKeyStorageOptions, -) { - const provider = profileId.split(":")[0] ?? "minimax"; - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId, - credential: buildApiKeyCredential(provider, key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setMoonshotApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "moonshot:default", - credential: buildApiKeyCredential("moonshot", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setKimiCodingApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "kimi:default", - credential: buildApiKeyCredential("kimi", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setVolcengineApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "volcengine:default", - credential: buildApiKeyCredential("volcengine", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setByteplusApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "byteplus:default", - credential: buildApiKeyCredential("byteplus", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setSyntheticApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "synthetic:default", - credential: buildApiKeyCredential("synthetic", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setVeniceApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "venice:default", - credential: buildApiKeyCredential("venice", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export const ZAI_DEFAULT_MODEL_REF = "zai/glm-5"; -export const XIAOMI_DEFAULT_MODEL_REF = "xiaomi/mimo-v2-flash"; -export const OPENROUTER_DEFAULT_MODEL_REF = "openrouter/auto"; -export const HUGGINGFACE_DEFAULT_MODEL_REF = "huggingface/deepseek-ai/DeepSeek-R1"; -export const TOGETHER_DEFAULT_MODEL_REF = "together/moonshotai/Kimi-K2.5"; -export const LITELLM_DEFAULT_MODEL_REF = "litellm/claude-opus-4-6"; -export const VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF = "vercel-ai-gateway/anthropic/claude-opus-4.6"; - -export async function setZaiApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Write to resolved agent dir so gateway finds credentials on startup. - upsertAuthProfile({ - profileId: "zai:default", - credential: buildApiKeyCredential("zai", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setXiaomiApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "xiaomi:default", - credential: buildApiKeyCredential("xiaomi", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setOpenrouterApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - // Never persist the literal "undefined" (e.g. when prompt returns undefined and caller used String(key)). - const safeKey = typeof key === "string" && key === "undefined" ? "" : key; - upsertAuthProfile({ - profileId: "openrouter:default", - credential: buildApiKeyCredential("openrouter", safeKey, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setCloudflareAiGatewayConfig( - accountId: string, - gatewayId: string, - apiKey: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - const normalizedAccountId = accountId.trim(); - const normalizedGatewayId = gatewayId.trim(); - upsertAuthProfile({ - profileId: "cloudflare-ai-gateway:default", - credential: buildApiKeyCredential( - "cloudflare-ai-gateway", - apiKey, - { - accountId: normalizedAccountId, - gatewayId: normalizedGatewayId, - }, - options, - ), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setLitellmApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "litellm:default", - credential: buildApiKeyCredential("litellm", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setVercelAiGatewayApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "vercel-ai-gateway:default", - credential: buildApiKeyCredential("vercel-ai-gateway", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setOpencodeZenApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - await setSharedOpencodeApiKey(key, agentDir, options); -} - -export async function setOpencodeGoApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - await setSharedOpencodeApiKey(key, agentDir, options); -} - -async function setSharedOpencodeApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - const resolvedAgentDir = resolveAuthAgentDir(agentDir); - for (const provider of ["opencode", "opencode-go"] as const) { - upsertAuthProfile({ - profileId: `${provider}:default`, - credential: buildApiKeyCredential(provider, key, undefined, options), - agentDir: resolvedAgentDir, - }); - } -} - -export async function setTogetherApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "together:default", - credential: buildApiKeyCredential("together", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setHuggingfaceApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "huggingface:default", - credential: buildApiKeyCredential("huggingface", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export function setQianfanApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "qianfan:default", - credential: buildApiKeyCredential("qianfan", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export function setModelStudioApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "modelstudio:default", - credential: buildApiKeyCredential("modelstudio", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export function setXaiApiKey(key: SecretInput, agentDir?: string, options?: ApiKeyStorageOptions) { - upsertAuthProfile({ - profileId: "xai:default", - credential: buildApiKeyCredential("xai", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setMistralApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "mistral:default", - credential: buildApiKeyCredential("mistral", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} - -export async function setKilocodeApiKey( - key: SecretInput, - agentDir?: string, - options?: ApiKeyStorageOptions, -) { - upsertAuthProfile({ - profileId: "kilocode:default", - credential: buildApiKeyCredential("kilocode", key, undefined, options), - agentDir: resolveAuthAgentDir(agentDir), - }); -} diff --git a/src/commands/onboard-non-interactive/local/auth-choice.ts b/src/commands/onboard-non-interactive/local/auth-choice.ts index c52be44afda..85322122e1f 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.ts @@ -1,15 +1,13 @@ import type { ApiKeyCredential } from "../../../agents/auth-profiles/types.js"; import type { OpenClawConfig } from "../../../config/config.js"; import type { SecretInput } from "../../../config/types.secrets.js"; +import { applyAuthProfileConfig } from "../../../plugins/provider-auth-helpers.js"; +import { setCloudflareAiGatewayConfig } from "../../../plugins/provider-auth-storage.js"; import type { RuntimeEnv } from "../../../runtime.js"; import { resolveDefaultSecretProviderAlias } from "../../../secrets/ref-contract.js"; import { normalizeSecretInputModeInput } from "../../auth-choice.apply-helpers.js"; import { normalizeApiKeyTokenProviderAuthChoice } from "../../auth-choice.apply.api-providers.js"; -import { - applyAuthProfileConfig, - applyCloudflareAiGatewayConfig, - setCloudflareAiGatewayConfig, -} from "../../onboard-auth.js"; +import { applyCloudflareAiGatewayConfig } from "../../onboard-auth.config-gateways.js"; import { applyCustomApiConfig, CustomApiError, diff --git a/src/commands/self-hosted-provider-setup.ts b/src/commands/self-hosted-provider-setup.ts index ec2d8c683e3..e7851fdf550 100644 --- a/src/commands/self-hosted-provider-setup.ts +++ b/src/commands/self-hosted-provider-setup.ts @@ -6,6 +6,7 @@ import { SELF_HOSTED_DEFAULT_MAX_TOKENS, } from "../agents/self-hosted-provider-defaults.js"; import type { OpenClawConfig } from "../config/config.js"; +import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; import type { ProviderDiscoveryContext, ProviderAuthResult, @@ -13,7 +14,6 @@ import type { ProviderNonInteractiveApiKeyResult, } from "../plugins/types.js"; import type { WizardPrompter } from "../wizard/prompts.js"; -import { applyAuthProfileConfig } from "./auth-profile-config.js"; export { SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, diff --git a/src/plugin-sdk/provider-auth.ts b/src/plugin-sdk/provider-auth.ts index 40669e51d97..bb0c307c294 100644 --- a/src/plugin-sdk/provider-auth.ts +++ b/src/plugin-sdk/provider-auth.ts @@ -29,8 +29,7 @@ export { resolveSecretInputModeForEnvSelection, } from "../commands/auth-choice.apply-helpers.js"; export { buildTokenProfileId, validateAnthropicSetupToken } from "../commands/auth-token.js"; -export { buildApiKeyCredential } from "../commands/onboard-auth.credentials.js"; -export { applyAuthProfileConfig } from "../commands/onboard-auth.js"; +export { applyAuthProfileConfig, buildApiKeyCredential } from "../plugins/provider-auth-helpers.js"; export { githubCopilotLoginCommand } from "../providers/github-copilot-auth.js"; export { loginOpenAICodexOAuth } from "../commands/openai-codex-oauth.js"; export { createProviderApiKeyAuthMethod } from "../plugins/provider-api-key-auth.js"; diff --git a/src/plugin-sdk/provider-onboard.ts b/src/plugin-sdk/provider-onboard.ts index b2175f092fe..89b219bedbc 100644 --- a/src/plugin-sdk/provider-onboard.ts +++ b/src/plugin-sdk/provider-onboard.ts @@ -12,5 +12,5 @@ export { applyProviderConfigWithDefaultModel, applyProviderConfigWithDefaultModels, applyProviderConfigWithModelCatalog, -} from "../commands/onboard-auth.config-shared.js"; +} from "../plugins/provider-onboarding-config.js"; export { ensureModelAllowlistEntry } from "../commands/model-allowlist.js"; diff --git a/src/plugins/provider-api-key-auth.runtime.ts b/src/plugins/provider-api-key-auth.runtime.ts index 010e2b3e16e..dade8720478 100644 --- a/src/plugins/provider-api-key-auth.runtime.ts +++ b/src/plugins/provider-api-key-auth.runtime.ts @@ -1,8 +1,7 @@ import { normalizeApiKeyInput, validateApiKeyInput } from "../commands/auth-choice.api-key.js"; import { ensureApiKeyFromOptionEnvOrPrompt } from "../commands/auth-choice.apply-helpers.js"; -import { buildApiKeyCredential } from "../commands/auth-credentials.js"; import { applyPrimaryModel } from "../commands/model-picker.js"; -import { applyAuthProfileConfig } from "../commands/onboard-auth.js"; +import { applyAuthProfileConfig, buildApiKeyCredential } from "./provider-auth-helpers.js"; export { applyAuthProfileConfig, diff --git a/src/providers/github-copilot-auth.ts b/src/providers/github-copilot-auth.ts index d4ffb926a5f..efc3cb8dbb5 100644 --- a/src/providers/github-copilot-auth.ts +++ b/src/providers/github-copilot-auth.ts @@ -1,8 +1,8 @@ import { intro, note, outro, spinner } from "@clack/prompts"; import { ensureAuthProfileStore, upsertAuthProfile } from "../agents/auth-profiles.js"; import { updateConfig } from "../commands/models/shared.js"; -import { applyAuthProfileConfig } from "../commands/onboard-auth.js"; import { logConfigUpdated } from "../config/logging.js"; +import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; import type { RuntimeEnv } from "../runtime.js"; import { stylePromptTitle } from "../terminal/prompt-style.js"; From 6d6825ea182a65425f2a6277ec644228843df49f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:21:11 -0700 Subject: [PATCH 007/187] refactor: add shared provider auth modules --- src/plugins/provider-auth-helpers.ts | 262 ++++++++++++++++ src/plugins/provider-auth-storage.ts | 345 ++++++++++++++++++++++ src/plugins/provider-onboarding-config.ts | 221 ++++++++++++++ 3 files changed, 828 insertions(+) create mode 100644 src/plugins/provider-auth-helpers.ts create mode 100644 src/plugins/provider-auth-storage.ts create mode 100644 src/plugins/provider-onboarding-config.ts diff --git a/src/plugins/provider-auth-helpers.ts b/src/plugins/provider-auth-helpers.ts new file mode 100644 index 00000000000..72075dffc00 --- /dev/null +++ b/src/plugins/provider-auth-helpers.ts @@ -0,0 +1,262 @@ +import fs from "node:fs"; +import path from "node:path"; +import type { OAuthCredentials } from "@mariozechner/pi-ai"; +import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; +import { upsertAuthProfile } from "../agents/auth-profiles.js"; +import { normalizeProviderIdForAuth } from "../agents/provider-id.js"; +import type { SecretInputMode } from "../commands/onboard-types.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { resolveStateDir } from "../config/paths.js"; +import { + coerceSecretRef, + DEFAULT_SECRET_PROVIDER_ALIAS, + type SecretInput, + type SecretRef, +} from "../config/types.secrets.js"; +import { PROVIDER_ENV_VARS } from "../secrets/provider-env-vars.js"; +import { normalizeSecretInput } from "../utils/normalize-secret-input.js"; + +const ENV_REF_PATTERN = /^\$\{([A-Z][A-Z0-9_]*)\}$/; + +const resolveAuthAgentDir = (agentDir?: string) => agentDir ?? resolveOpenClawAgentDir(); + +export type ApiKeyStorageOptions = { + secretInputMode?: SecretInputMode; +}; + +export type WriteOAuthCredentialsOptions = { + syncSiblingAgents?: boolean; +}; + +function buildEnvSecretRef(id: string): SecretRef { + return { source: "env", provider: DEFAULT_SECRET_PROVIDER_ALIAS, id }; +} + +function parseEnvSecretRef(value: string): SecretRef | null { + const match = ENV_REF_PATTERN.exec(value); + if (!match) { + return null; + } + return buildEnvSecretRef(match[1]); +} + +function resolveProviderDefaultEnvSecretRef(provider: string): SecretRef { + const envVars = PROVIDER_ENV_VARS[provider]; + const envVar = envVars?.find((candidate) => candidate.trim().length > 0); + if (!envVar) { + throw new Error( + `Provider "${provider}" does not have a default env var mapping for secret-input-mode=ref.`, + ); + } + return buildEnvSecretRef(envVar); +} + +function resolveApiKeySecretInput( + provider: string, + input: SecretInput, + options?: ApiKeyStorageOptions, +): SecretInput { + const coercedRef = coerceSecretRef(input); + if (coercedRef) { + return coercedRef; + } + const normalized = normalizeSecretInput(input); + const inlineEnvRef = parseEnvSecretRef(normalized); + if (inlineEnvRef) { + return inlineEnvRef; + } + if (options?.secretInputMode === "ref") { + return resolveProviderDefaultEnvSecretRef(provider); + } + return normalized; +} + +export function buildApiKeyCredential( + provider: string, + input: SecretInput, + metadata?: Record, + options?: ApiKeyStorageOptions, +): { + type: "api_key"; + provider: string; + key?: string; + keyRef?: SecretRef; + metadata?: Record; +} { + const secretInput = resolveApiKeySecretInput(provider, input, options); + if (typeof secretInput === "string") { + return { + type: "api_key", + provider, + key: secretInput, + ...(metadata ? { metadata } : {}), + }; + } + return { + type: "api_key", + provider, + keyRef: secretInput, + ...(metadata ? { metadata } : {}), + }; +} + +export function applyAuthProfileConfig( + cfg: OpenClawConfig, + params: { + profileId: string; + provider: string; + mode: "api_key" | "oauth" | "token"; + email?: string; + preferProfileFirst?: boolean; + }, +): OpenClawConfig { + const normalizedProvider = normalizeProviderIdForAuth(params.provider); + const profiles = { + ...cfg.auth?.profiles, + [params.profileId]: { + provider: params.provider, + mode: params.mode, + ...(params.email ? { email: params.email } : {}), + }, + }; + + const configuredProviderProfiles = Object.entries(cfg.auth?.profiles ?? {}) + .filter(([, profile]) => normalizeProviderIdForAuth(profile.provider) === normalizedProvider) + .map(([profileId, profile]) => ({ profileId, mode: profile.mode })); + + // Maintain `auth.order` when it already exists. Additionally, if we detect + // mixed auth modes for the same provider, keep the newly selected profile first. + const existingProviderOrder = cfg.auth?.order?.[params.provider]; + const preferProfileFirst = params.preferProfileFirst ?? true; + const reorderedProviderOrder = + existingProviderOrder && preferProfileFirst + ? [ + params.profileId, + ...existingProviderOrder.filter((profileId) => profileId !== params.profileId), + ] + : existingProviderOrder; + const hasMixedConfiguredModes = configuredProviderProfiles.some( + ({ profileId, mode }) => profileId !== params.profileId && mode !== params.mode, + ); + const derivedProviderOrder = + existingProviderOrder === undefined && preferProfileFirst && hasMixedConfiguredModes + ? [ + params.profileId, + ...configuredProviderProfiles + .map(({ profileId }) => profileId) + .filter((profileId) => profileId !== params.profileId), + ] + : undefined; + const order = + existingProviderOrder !== undefined + ? { + ...cfg.auth?.order, + [params.provider]: reorderedProviderOrder?.includes(params.profileId) + ? reorderedProviderOrder + : [...(reorderedProviderOrder ?? []), params.profileId], + } + : derivedProviderOrder + ? { + ...cfg.auth?.order, + [params.provider]: derivedProviderOrder, + } + : cfg.auth?.order; + return { + ...cfg, + auth: { + ...cfg.auth, + profiles, + ...(order ? { order } : {}), + }, + }; +} + +/** Resolve real path, returning null if the target doesn't exist. */ +function safeRealpathSync(dir: string): string | null { + try { + return fs.realpathSync(path.resolve(dir)); + } catch { + return null; + } +} + +function resolveSiblingAgentDirs(primaryAgentDir: string): string[] { + const normalized = path.resolve(primaryAgentDir); + const parentOfAgent = path.dirname(normalized); + const candidateAgentsRoot = path.dirname(parentOfAgent); + const looksLikeStandardLayout = + path.basename(normalized) === "agent" && path.basename(candidateAgentsRoot) === "agents"; + + const agentsRoot = looksLikeStandardLayout + ? candidateAgentsRoot + : path.join(resolveStateDir(), "agents"); + + const entries = (() => { + try { + return fs.readdirSync(agentsRoot, { withFileTypes: true }); + } catch { + return []; + } + })(); + const discovered = entries + .filter((entry) => entry.isDirectory() || entry.isSymbolicLink()) + .map((entry) => path.join(agentsRoot, entry.name, "agent")); + + const seen = new Set(); + const result: string[] = []; + for (const dir of [normalized, ...discovered]) { + const real = safeRealpathSync(dir); + if (real && !seen.has(real)) { + seen.add(real); + result.push(real); + } + } + return result; +} + +export async function writeOAuthCredentials( + provider: string, + creds: OAuthCredentials, + agentDir?: string, + options?: WriteOAuthCredentialsOptions, +): Promise { + const email = + typeof creds.email === "string" && creds.email.trim() ? creds.email.trim() : "default"; + const profileId = `${provider}:${email}`; + const resolvedAgentDir = path.resolve(resolveAuthAgentDir(agentDir)); + const targetAgentDirs = options?.syncSiblingAgents + ? resolveSiblingAgentDirs(resolvedAgentDir) + : [resolvedAgentDir]; + + const credential = { + type: "oauth" as const, + provider, + ...creds, + }; + + upsertAuthProfile({ + profileId, + credential, + agentDir: resolvedAgentDir, + }); + + if (options?.syncSiblingAgents) { + const primaryReal = safeRealpathSync(resolvedAgentDir); + for (const targetAgentDir of targetAgentDirs) { + const targetReal = safeRealpathSync(targetAgentDir); + if (targetReal && primaryReal && targetReal === primaryReal) { + continue; + } + try { + upsertAuthProfile({ + profileId, + credential, + agentDir: targetAgentDir, + }); + } catch { + // Best-effort: sibling sync failure must not block primary setup. + } + } + } + return profileId; +} diff --git a/src/plugins/provider-auth-storage.ts b/src/plugins/provider-auth-storage.ts new file mode 100644 index 00000000000..d8e15115902 --- /dev/null +++ b/src/plugins/provider-auth-storage.ts @@ -0,0 +1,345 @@ +import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; +import { upsertAuthProfile } from "../agents/auth-profiles.js"; +import type { SecretInput } from "../config/types.secrets.js"; +import { KILOCODE_DEFAULT_MODEL_REF } from "../providers/kilocode-shared.js"; +import { + buildApiKeyCredential, + type ApiKeyStorageOptions, + writeOAuthCredentials, + type WriteOAuthCredentialsOptions, +} from "./provider-auth-helpers.js"; + +const resolveAuthAgentDir = (agentDir?: string) => agentDir ?? resolveOpenClawAgentDir(); + +export { KILOCODE_DEFAULT_MODEL_REF }; +export { + buildApiKeyCredential, + type ApiKeyStorageOptions, + writeOAuthCredentials, + type WriteOAuthCredentialsOptions, +}; + +export async function setAnthropicApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "anthropic:default", + credential: buildApiKeyCredential("anthropic", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setOpenaiApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "openai:default", + credential: buildApiKeyCredential("openai", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setGeminiApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "google:default", + credential: buildApiKeyCredential("google", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setMinimaxApiKey( + key: SecretInput, + agentDir?: string, + profileId: string = "minimax:default", + options?: ApiKeyStorageOptions, +) { + const provider = profileId.split(":")[0] ?? "minimax"; + upsertAuthProfile({ + profileId, + credential: buildApiKeyCredential(provider, key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setMoonshotApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "moonshot:default", + credential: buildApiKeyCredential("moonshot", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setKimiCodingApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "kimi:default", + credential: buildApiKeyCredential("kimi", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setVolcengineApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "volcengine:default", + credential: buildApiKeyCredential("volcengine", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setByteplusApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "byteplus:default", + credential: buildApiKeyCredential("byteplus", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setSyntheticApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "synthetic:default", + credential: buildApiKeyCredential("synthetic", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setVeniceApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "venice:default", + credential: buildApiKeyCredential("venice", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export const ZAI_DEFAULT_MODEL_REF = "zai/glm-5"; +export const XIAOMI_DEFAULT_MODEL_REF = "xiaomi/mimo-v2-flash"; +export const OPENROUTER_DEFAULT_MODEL_REF = "openrouter/auto"; +export const HUGGINGFACE_DEFAULT_MODEL_REF = "huggingface/deepseek-ai/DeepSeek-R1"; +export const TOGETHER_DEFAULT_MODEL_REF = "together/moonshotai/Kimi-K2.5"; +export const LITELLM_DEFAULT_MODEL_REF = "litellm/claude-opus-4-6"; +export const VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF = "vercel-ai-gateway/anthropic/claude-opus-4.6"; + +export async function setZaiApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "zai:default", + credential: buildApiKeyCredential("zai", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setXiaomiApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "xiaomi:default", + credential: buildApiKeyCredential("xiaomi", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setOpenrouterApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + const safeKey = typeof key === "string" && key === "undefined" ? "" : key; + upsertAuthProfile({ + profileId: "openrouter:default", + credential: buildApiKeyCredential("openrouter", safeKey, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setCloudflareAiGatewayConfig( + accountId: string, + gatewayId: string, + apiKey: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + const normalizedAccountId = accountId.trim(); + const normalizedGatewayId = gatewayId.trim(); + upsertAuthProfile({ + profileId: "cloudflare-ai-gateway:default", + credential: buildApiKeyCredential( + "cloudflare-ai-gateway", + apiKey, + { + accountId: normalizedAccountId, + gatewayId: normalizedGatewayId, + }, + options, + ), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setLitellmApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "litellm:default", + credential: buildApiKeyCredential("litellm", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setVercelAiGatewayApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "vercel-ai-gateway:default", + credential: buildApiKeyCredential("vercel-ai-gateway", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setOpencodeZenApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + await setSharedOpencodeApiKey(key, agentDir, options); +} + +export async function setOpencodeGoApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + await setSharedOpencodeApiKey(key, agentDir, options); +} + +async function setSharedOpencodeApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + for (const provider of ["opencode", "opencode-go"] as const) { + upsertAuthProfile({ + profileId: `${provider}:default`, + credential: buildApiKeyCredential(provider, key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); + } +} + +export async function setTogetherApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "together:default", + credential: buildApiKeyCredential("together", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setHuggingfaceApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "huggingface:default", + credential: buildApiKeyCredential("huggingface", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export function setQianfanApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "qianfan:default", + credential: buildApiKeyCredential("qianfan", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export function setModelStudioApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "modelstudio:default", + credential: buildApiKeyCredential("modelstudio", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export function setXaiApiKey(key: SecretInput, agentDir?: string, options?: ApiKeyStorageOptions) { + upsertAuthProfile({ + profileId: "xai:default", + credential: buildApiKeyCredential("xai", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setMistralApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "mistral:default", + credential: buildApiKeyCredential("mistral", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} + +export async function setKilocodeApiKey( + key: SecretInput, + agentDir?: string, + options?: ApiKeyStorageOptions, +) { + upsertAuthProfile({ + profileId: "kilocode:default", + credential: buildApiKeyCredential("kilocode", key, undefined, options), + agentDir: resolveAuthAgentDir(agentDir), + }); +} diff --git a/src/plugins/provider-onboarding-config.ts b/src/plugins/provider-onboarding-config.ts new file mode 100644 index 00000000000..9e70eaac192 --- /dev/null +++ b/src/plugins/provider-onboarding-config.ts @@ -0,0 +1,221 @@ +import { findNormalizedProviderKey } from "../agents/provider-id.js"; +import type { OpenClawConfig } from "../config/config.js"; +import type { AgentModelEntryConfig } from "../config/types.agent-defaults.js"; +import type { + ModelApi, + ModelDefinitionConfig, + ModelProviderConfig, +} from "../config/types.models.js"; + +function extractAgentDefaultModelFallbacks(model: unknown): string[] | undefined { + if (!model || typeof model !== "object") { + return undefined; + } + if (!("fallbacks" in model)) { + return undefined; + } + const fallbacks = (model as { fallbacks?: unknown }).fallbacks; + return Array.isArray(fallbacks) ? fallbacks.map((v) => String(v)) : undefined; +} + +export function applyOnboardAuthAgentModelsAndProviders( + cfg: OpenClawConfig, + params: { + agentModels: Record; + providers: Record; + }, +): OpenClawConfig { + return { + ...cfg, + agents: { + ...cfg.agents, + defaults: { + ...cfg.agents?.defaults, + models: params.agentModels, + }, + }, + models: { + mode: cfg.models?.mode ?? "merge", + providers: params.providers, + }, + }; +} + +export function applyAgentDefaultModelPrimary( + cfg: OpenClawConfig, + primary: string, +): OpenClawConfig { + const existingFallbacks = extractAgentDefaultModelFallbacks(cfg.agents?.defaults?.model); + return { + ...cfg, + agents: { + ...cfg.agents, + defaults: { + ...cfg.agents?.defaults, + model: { + ...(existingFallbacks ? { fallbacks: existingFallbacks } : undefined), + primary, + }, + }, + }, + }; +} + +export function applyProviderConfigWithDefaultModels( + cfg: OpenClawConfig, + params: { + agentModels: Record; + providerId: string; + api: ModelApi; + baseUrl: string; + defaultModels: ModelDefinitionConfig[]; + defaultModelId?: string; + }, +): OpenClawConfig { + const providerState = resolveProviderModelMergeState(cfg, params.providerId); + + const defaultModels = params.defaultModels; + const defaultModelId = params.defaultModelId ?? defaultModels[0]?.id; + const hasDefaultModel = defaultModelId + ? providerState.existingModels.some((model) => model.id === defaultModelId) + : true; + const mergedModels = + providerState.existingModels.length > 0 + ? hasDefaultModel || defaultModels.length === 0 + ? providerState.existingModels + : [...providerState.existingModels, ...defaultModels] + : defaultModels; + return applyProviderConfigWithMergedModels(cfg, { + agentModels: params.agentModels, + providerId: params.providerId, + providerState, + api: params.api, + baseUrl: params.baseUrl, + mergedModels, + fallbackModels: defaultModels, + }); +} + +export function applyProviderConfigWithDefaultModel( + cfg: OpenClawConfig, + params: { + agentModels: Record; + providerId: string; + api: ModelApi; + baseUrl: string; + defaultModel: ModelDefinitionConfig; + defaultModelId?: string; + }, +): OpenClawConfig { + return applyProviderConfigWithDefaultModels(cfg, { + agentModels: params.agentModels, + providerId: params.providerId, + api: params.api, + baseUrl: params.baseUrl, + defaultModels: [params.defaultModel], + defaultModelId: params.defaultModelId ?? params.defaultModel.id, + }); +} + +export function applyProviderConfigWithModelCatalog( + cfg: OpenClawConfig, + params: { + agentModels: Record; + providerId: string; + api: ModelApi; + baseUrl: string; + catalogModels: ModelDefinitionConfig[]; + }, +): OpenClawConfig { + const providerState = resolveProviderModelMergeState(cfg, params.providerId); + const catalogModels = params.catalogModels; + const mergedModels = + providerState.existingModels.length > 0 + ? [ + ...providerState.existingModels, + ...catalogModels.filter( + (model) => !providerState.existingModels.some((existing) => existing.id === model.id), + ), + ] + : catalogModels; + return applyProviderConfigWithMergedModels(cfg, { + agentModels: params.agentModels, + providerId: params.providerId, + providerState, + api: params.api, + baseUrl: params.baseUrl, + mergedModels, + fallbackModels: catalogModels, + }); +} + +type ProviderModelMergeState = { + providers: Record; + existingProvider?: ModelProviderConfig; + existingModels: ModelDefinitionConfig[]; +}; + +function resolveProviderModelMergeState( + cfg: OpenClawConfig, + providerId: string, +): ProviderModelMergeState { + const providers = { ...cfg.models?.providers } as Record; + const existingProviderKey = findNormalizedProviderKey(providers, providerId); + const existingProvider = + existingProviderKey !== undefined + ? (providers[existingProviderKey] as ModelProviderConfig | undefined) + : undefined; + const existingModels: ModelDefinitionConfig[] = Array.isArray(existingProvider?.models) + ? existingProvider.models + : []; + if (existingProviderKey && existingProviderKey !== providerId) { + delete providers[existingProviderKey]; + } + return { providers, existingProvider, existingModels }; +} + +function applyProviderConfigWithMergedModels( + cfg: OpenClawConfig, + params: { + agentModels: Record; + providerId: string; + providerState: ProviderModelMergeState; + api: ModelApi; + baseUrl: string; + mergedModels: ModelDefinitionConfig[]; + fallbackModels: ModelDefinitionConfig[]; + }, +): OpenClawConfig { + params.providerState.providers[params.providerId] = buildProviderConfig({ + existingProvider: params.providerState.existingProvider, + api: params.api, + baseUrl: params.baseUrl, + mergedModels: params.mergedModels, + fallbackModels: params.fallbackModels, + }); + return applyOnboardAuthAgentModelsAndProviders(cfg, { + agentModels: params.agentModels, + providers: params.providerState.providers, + }); +} + +function buildProviderConfig(params: { + existingProvider: ModelProviderConfig | undefined; + api: ModelApi; + baseUrl: string; + mergedModels: ModelDefinitionConfig[]; + fallbackModels: ModelDefinitionConfig[]; +}): ModelProviderConfig { + const { apiKey: existingApiKey, ...existingProviderRest } = (params.existingProvider ?? {}) as { + apiKey?: string; + }; + const normalizedApiKey = typeof existingApiKey === "string" ? existingApiKey.trim() : undefined; + + return { + ...existingProviderRest, + baseUrl: params.baseUrl, + api: params.api, + ...(normalizedApiKey ? { apiKey: normalizedApiKey } : {}), + models: params.mergedModels.length > 0 ? params.mergedModels : params.fallbackModels, + }; +} From 4bba2888e7c1a1095c9f3839df6ea5f0a4644669 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:30:41 -0700 Subject: [PATCH 008/187] feat(plugins): add web search runtime capability --- docs/tools/plugin.md | 26 +++ extensions/test-utils/plugin-runtime-mock.ts | 4 + src/agents/tools/web-search.ts | 149 ++------------ .../tools/web-tools.enabled-defaults.test.ts | 14 ++ src/plugins/runtime/index.test.ts | 26 ++- src/plugins/runtime/index.ts | 5 + src/plugins/runtime/types-core.ts | 4 + src/plugins/web-search-providers.test.ts | 45 +++- src/plugins/web-search-providers.ts | 61 ++++-- src/web-search/runtime.test.ts | 46 +++++ src/web-search/runtime.ts | 194 ++++++++++++++++++ 11 files changed, 409 insertions(+), 165 deletions(-) create mode 100644 src/web-search/runtime.test.ts create mode 100644 src/web-search/runtime.ts diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 0e9e831023c..8ab2ba87e1f 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -782,6 +782,32 @@ Notes: - Returns `{ text: undefined }` when no transcription output is produced (for example skipped/unsupported input). - `api.runtime.stt.transcribeAudioFile(...)` remains as a compatibility alias. +For web search, plugins can consume the shared runtime helper instead of +reaching into the agent tool wiring: + +```ts +const providers = api.runtime.webSearch.listProviders({ + config: api.config, +}); + +const result = await api.runtime.webSearch.search({ + config: api.config, + args: { + query: "OpenClaw plugin runtime helpers", + count: 5, + }, +}); +``` + +Plugins can also register web-search providers via +`api.registerWebSearchProvider(...)`. + +Notes: + +- Keep provider selection, credential resolution, and shared request semantics in core. +- Use web-search providers for vendor-specific search transports. +- `api.runtime.webSearch.*` is the preferred shared surface for feature/channel plugins that need search behavior without depending on the agent tool wrapper. + ## Gateway HTTP routes Plugins can expose HTTP endpoints with `api.registerHttpRoute(...)`. diff --git a/extensions/test-utils/plugin-runtime-mock.ts b/extensions/test-utils/plugin-runtime-mock.ts index a5003620a59..c9f2c44cf10 100644 --- a/extensions/test-utils/plugin-runtime-mock.ts +++ b/extensions/test-utils/plugin-runtime-mock.ts @@ -115,6 +115,10 @@ export function createPluginRuntimeMock(overrides: DeepPartial = transcribeAudioFile: vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["transcribeAudioFile"], }, + webSearch: { + listProviders: vi.fn() as unknown as PluginRuntime["webSearch"]["listProviders"], + search: vi.fn() as unknown as PluginRuntime["webSearch"]["search"], + }, stt: { transcribeAudioFile: vi.fn() as unknown as PluginRuntime["stt"]["transcribeAudioFile"], }, diff --git a/src/agents/tools/web-search.ts b/src/agents/tools/web-search.ts index 869da014d45..62993704377 100644 --- a/src/agents/tools/web-search.ts +++ b/src/agents/tools/web-search.ts @@ -1,148 +1,29 @@ import type { OpenClawConfig } from "../../config/config.js"; -import { normalizeResolvedSecretInputString } from "../../config/types.secrets.js"; -import { logVerbose } from "../../globals.js"; -import { resolvePluginWebSearchProviders } from "../../plugins/web-search-providers.js"; import type { RuntimeWebSearchMetadata } from "../../secrets/runtime-web-tools.types.js"; -import { normalizeSecretInput } from "../../utils/normalize-secret-input.js"; +import { __testing as runtimeTesting } from "../../web-search/runtime.js"; import type { AnyAgentTool } from "./common.js"; -import { jsonResult } from "./common.js"; -import { __testing as coreTesting } from "./web-search-core.js"; - -type WebSearchConfig = NonNullable["web"] extends infer Web - ? Web extends { search?: infer Search } - ? Search - : undefined - : undefined; - -function resolveSearchConfig(cfg?: OpenClawConfig): WebSearchConfig { - const search = cfg?.tools?.web?.search; - if (!search || typeof search !== "object") { - return undefined; - } - return search as WebSearchConfig; -} - -function resolveSearchEnabled(params: { search?: WebSearchConfig; sandboxed?: boolean }): boolean { - if (typeof params.search?.enabled === "boolean") { - return params.search.enabled; - } - if (params.sandboxed) { - return true; - } - return true; -} - -function readProviderEnvValue(envVars: string[]): string | undefined { - for (const envVar of envVars) { - const value = normalizeSecretInput(process.env[envVar]); - if (value) { - return value; - } - } - return undefined; -} - -function hasProviderCredential(providerId: string, search: WebSearchConfig | undefined): boolean { - const providers = resolvePluginWebSearchProviders({ - bundledAllowlistCompat: true, - }); - const provider = providers.find((entry) => entry.id === providerId); - if (!provider) { - return false; - } - const rawValue = provider.getCredentialValue(search as Record | undefined); - const fromConfig = normalizeSecretInput( - normalizeResolvedSecretInputString({ - value: rawValue, - path: - providerId === "brave" - ? "tools.web.search.apiKey" - : `tools.web.search.${providerId}.apiKey`, - }), - ); - return Boolean(fromConfig || readProviderEnvValue(provider.envVars)); -} - -function resolveSearchProvider(search?: WebSearchConfig): string { - const providers = resolvePluginWebSearchProviders({ - bundledAllowlistCompat: true, - }); - const raw = - search && "provider" in search && typeof search.provider === "string" - ? search.provider.trim().toLowerCase() - : ""; - - if (raw) { - const explicit = providers.find((provider) => provider.id === raw); - if (explicit) { - return explicit.id; - } - } - - if (!raw) { - for (const provider of providers) { - if (!hasProviderCredential(provider.id, search)) { - continue; - } - logVerbose( - `web_search: no provider configured, auto-detected "${provider.id}" from available API keys`, - ); - return provider.id; - } - } - - return providers[0]?.id ?? "brave"; -} +import { + __testing as coreTesting, + createWebSearchTool as createWebSearchToolCore, +} from "./web-search-core.js"; export function createWebSearchTool(options?: { config?: OpenClawConfig; sandboxed?: boolean; runtimeWebSearch?: RuntimeWebSearchMetadata; }): AnyAgentTool | null { - const search = resolveSearchConfig(options?.config); - if (!resolveSearchEnabled({ search, sandboxed: options?.sandboxed })) { - return null; - } - - const providers = resolvePluginWebSearchProviders({ - config: options?.config, - bundledAllowlistCompat: true, - }); - if (providers.length === 0) { - return null; - } - - const providerId = - options?.runtimeWebSearch?.selectedProvider ?? - options?.runtimeWebSearch?.providerConfigured ?? - resolveSearchProvider(search); - const provider = - providers.find((entry) => entry.id === providerId) ?? - providers.find((entry) => entry.id === resolveSearchProvider(search)) ?? - providers[0]; - if (!provider) { - return null; - } - - const definition = provider.createTool({ - config: options?.config, - searchConfig: search as Record | undefined, - runtimeMetadata: options?.runtimeWebSearch, - }); - if (!definition) { - return null; - } - - return { - label: "Web Search", - name: "web_search", - description: definition.description, - parameters: definition.parameters, - execute: async (_toolCallId, args) => jsonResult(await definition.execute(args)), - }; + return createWebSearchToolCore(options); } export const __testing = { ...coreTesting, - resolveSearchProvider, + resolveSearchProvider: ( + search?: OpenClawConfig["tools"] extends infer Tools + ? Tools extends { web?: infer Web } + ? Web extends { search?: infer Search } + ? Search + : undefined + : undefined + : undefined, + ) => runtimeTesting.resolveWebSearchProviderId({ search }), }; diff --git a/src/agents/tools/web-tools.enabled-defaults.test.ts b/src/agents/tools/web-tools.enabled-defaults.test.ts index c416804fa11..d06f65e0deb 100644 --- a/src/agents/tools/web-tools.enabled-defaults.test.ts +++ b/src/agents/tools/web-tools.enabled-defaults.test.ts @@ -325,9 +325,16 @@ describe("web_search provider proxy dispatch", () => { describe("web_search perplexity Search API", () => { const priorFetch = global.fetch; + const savedEnv = { ...process.env }; + + beforeEach(() => { + delete process.env.PERPLEXITY_API_KEY; + delete process.env.OPENROUTER_API_KEY; + }); afterEach(() => { vi.unstubAllEnvs(); + process.env = { ...savedEnv }; global.fetch = priorFetch; webSearchTesting.SEARCH_CACHE.clear(); }); @@ -462,9 +469,16 @@ describe("web_search perplexity Search API", () => { describe("web_search perplexity OpenRouter compatibility", () => { const priorFetch = global.fetch; + const savedEnv = { ...process.env }; + + beforeEach(() => { + delete process.env.PERPLEXITY_API_KEY; + delete process.env.OPENROUTER_API_KEY; + }); afterEach(() => { vi.unstubAllEnvs(); + process.env = { ...savedEnv }; global.fetch = priorFetch; webSearchTesting.SEARCH_CACHE.clear(); }); diff --git a/src/plugins/runtime/index.test.ts b/src/plugins/runtime/index.test.ts index 9f7613881a5..2022ac07d37 100644 --- a/src/plugins/runtime/index.test.ts +++ b/src/plugins/runtime/index.test.ts @@ -2,14 +2,8 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "../../agents/defaults.js"; import { onAgentEvent } from "../../infra/agent-events.js"; import { requestHeartbeatNow } from "../../infra/heartbeat-wake.js"; +import * as execModule from "../../process/exec.js"; import { onSessionTranscriptUpdate } from "../../sessions/transcript-events.js"; - -const runCommandWithTimeoutMock = vi.hoisted(() => vi.fn()); - -vi.mock("../../process/exec.js", () => ({ - runCommandWithTimeout: (...args: unknown[]) => runCommandWithTimeoutMock(...args), -})); - import { clearGatewaySubagentRuntime, createPluginRuntime, @@ -18,20 +12,24 @@ import { describe("plugin runtime command execution", () => { beforeEach(() => { - runCommandWithTimeoutMock.mockClear(); + vi.restoreAllMocks(); clearGatewaySubagentRuntime(); }); it("exposes runtime.system.runCommandWithTimeout by default", async () => { const commandResult = { + pid: 12345, stdout: "hello\n", stderr: "", code: 0, signal: null, killed: false, + noOutputTimedOut: false, termination: "exit" as const, }; - runCommandWithTimeoutMock.mockResolvedValue(commandResult); + const runCommandWithTimeoutMock = vi + .spyOn(execModule, "runCommandWithTimeout") + .mockResolvedValue(commandResult); const runtime = createPluginRuntime(); await expect( @@ -41,7 +39,9 @@ describe("plugin runtime command execution", () => { }); it("forwards runtime.system.runCommandWithTimeout errors", async () => { - runCommandWithTimeoutMock.mockRejectedValue(new Error("boom")); + const runCommandWithTimeoutMock = vi + .spyOn(execModule, "runCommandWithTimeout") + .mockRejectedValue(new Error("boom")); const runtime = createPluginRuntime(); await expect( runtime.system.runCommandWithTimeout(["echo", "hello"], { timeoutMs: 1000 }), @@ -63,6 +63,12 @@ describe("plugin runtime command execution", () => { expect(runtime.mediaUnderstanding.transcribeAudioFile).toBe(runtime.stt.transcribeAudioFile); }); + it("exposes runtime.webSearch helpers", () => { + const runtime = createPluginRuntime(); + expect(typeof runtime.webSearch.listProviders).toBe("function"); + expect(typeof runtime.webSearch.search).toBe("function"); + }); + it("exposes runtime.system.requestHeartbeatNow", () => { const runtime = createPluginRuntime(); expect(runtime.system.requestHeartbeatNow).toBe(requestHeartbeatNow); diff --git a/src/plugins/runtime/index.ts b/src/plugins/runtime/index.ts index 48899303e2f..cd76a21916b 100644 --- a/src/plugins/runtime/index.ts +++ b/src/plugins/runtime/index.ts @@ -11,6 +11,7 @@ import { transcribeAudioFile, } from "../../media-understanding/runtime.js"; import { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "../../tts/tts.js"; +import { listWebSearchProviders, runWebSearch } from "../../web-search/runtime.js"; import { createRuntimeAgent } from "./runtime-agent.js"; import { createRuntimeChannel } from "./runtime-channel.js"; import { createRuntimeConfig } from "./runtime-config.js"; @@ -147,6 +148,10 @@ export function createPluginRuntime(_options: CreatePluginRuntimeOptions = {}): describeVideoFile, transcribeAudioFile, }, + webSearch: { + listProviders: listWebSearchProviders, + search: runWebSearch, + }, stt: { transcribeAudioFile }, tools: createRuntimeTools(), channel: createRuntimeChannel(), diff --git a/src/plugins/runtime/types-core.ts b/src/plugins/runtime/types-core.ts index 822f0026b49..528c488d987 100644 --- a/src/plugins/runtime/types-core.ts +++ b/src/plugins/runtime/types-core.ts @@ -57,6 +57,10 @@ export type PluginRuntimeCore = { describeVideoFile: typeof import("../../media-understanding/runtime.js").describeVideoFile; transcribeAudioFile: typeof import("../../media-understanding/runtime.js").transcribeAudioFile; }; + webSearch: { + listProviders: typeof import("../../web-search/runtime.js").listWebSearchProviders; + search: typeof import("../../web-search/runtime.js").runWebSearch; + }; stt: { transcribeAudioFile: typeof import("../../media-understanding/transcribe-audio.js").transcribeAudioFile; }; diff --git a/src/plugins/web-search-providers.test.ts b/src/plugins/web-search-providers.test.ts index 52e326ddc04..9d2fd18e030 100644 --- a/src/plugins/web-search-providers.test.ts +++ b/src/plugins/web-search-providers.test.ts @@ -1,7 +1,16 @@ -import { describe, expect, it } from "vitest"; -import { resolvePluginWebSearchProviders } from "./web-search-providers.js"; +import { afterEach, describe, expect, it } from "vitest"; +import { createEmptyPluginRegistry } from "./registry.js"; +import { setActivePluginRegistry } from "./runtime.js"; +import { + resolvePluginWebSearchProviders, + resolveRuntimeWebSearchProviders, +} from "./web-search-providers.js"; describe("resolvePluginWebSearchProviders", () => { + afterEach(() => { + setActivePluginRegistry(createEmptyPluginRegistry()); + }); + it("returns bundled providers in auto-detect order", () => { const providers = resolvePluginWebSearchProviders({}); @@ -72,4 +81,36 @@ describe("resolvePluginWebSearchProviders", () => { expect(providers).toEqual([]); }); + + it("prefers the active plugin registry for runtime resolution", () => { + const registry = createEmptyPluginRegistry(); + registry.webSearchProviders.push({ + pluginId: "custom-search", + pluginName: "Custom Search", + provider: { + id: "custom", + label: "Custom Search", + hint: "Custom runtime provider", + envVars: ["CUSTOM_SEARCH_API_KEY"], + placeholder: "custom-...", + signupUrl: "https://example.com/signup", + autoDetectOrder: 1, + getCredentialValue: () => "configured", + setCredentialValue: () => {}, + createTool: () => ({ + description: "custom", + parameters: {}, + execute: async () => ({}), + }), + }, + source: "test", + }); + setActivePluginRegistry(registry); + + const providers = resolveRuntimeWebSearchProviders({}); + + expect(providers.map((provider) => `${provider.pluginId}:${provider.id}`)).toEqual([ + "custom-search:custom", + ]); + }); }); diff --git a/src/plugins/web-search-providers.ts b/src/plugins/web-search-providers.ts index 97b6d9ee022..8aba087f1fc 100644 --- a/src/plugins/web-search-providers.ts +++ b/src/plugins/web-search-providers.ts @@ -12,6 +12,7 @@ import { } from "./bundled-compat.js"; import { normalizePluginsConfig, resolveEffectiveEnableState } from "./config-state.js"; import type { PluginLoadOptions } from "./loader.js"; +import { getActivePluginRegistry } from "./runtime.js"; import type { PluginWebSearchProviderEntry } from "./types.js"; const BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS = [ @@ -127,25 +128,47 @@ export function resolvePluginWebSearchProviders(params: { }); const normalizedPlugins = normalizePluginsConfig(config?.plugins); - return BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY.filter( - ({ pluginId }) => - resolveEffectiveEnableState({ - id: pluginId, - origin: "bundled", - config: normalizedPlugins, - rootConfig: config, - }).enabled, - ) - .map((entry) => ({ + return sortWebSearchProviders( + BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY.filter( + ({ pluginId }) => + resolveEffectiveEnableState({ + id: pluginId, + origin: "bundled", + config: normalizedPlugins, + rootConfig: config, + }).enabled, + ).map((entry) => ({ ...entry.provider, pluginId: entry.pluginId, - })) - .toSorted((a, b) => { - const aOrder = a.autoDetectOrder ?? Number.MAX_SAFE_INTEGER; - const bOrder = b.autoDetectOrder ?? Number.MAX_SAFE_INTEGER; - if (aOrder !== bOrder) { - return aOrder - bOrder; - } - return a.id.localeCompare(b.id); - }); + })), + ); +} + +function sortWebSearchProviders( + providers: PluginWebSearchProviderEntry[], +): PluginWebSearchProviderEntry[] { + return providers.toSorted((a, b) => { + const aOrder = a.autoDetectOrder ?? Number.MAX_SAFE_INTEGER; + const bOrder = b.autoDetectOrder ?? Number.MAX_SAFE_INTEGER; + if (aOrder !== bOrder) { + return aOrder - bOrder; + } + return a.id.localeCompare(b.id); + }); +} + +export function resolveRuntimeWebSearchProviders(params: { + config?: PluginLoadOptions["config"]; + bundledAllowlistCompat?: boolean; +}): PluginWebSearchProviderEntry[] { + const runtimeProviders = getActivePluginRegistry()?.webSearchProviders ?? []; + if (runtimeProviders.length > 0) { + return sortWebSearchProviders( + runtimeProviders.map((entry) => ({ + ...entry.provider, + pluginId: entry.pluginId, + })), + ); + } + return resolvePluginWebSearchProviders(params); } diff --git a/src/web-search/runtime.test.ts b/src/web-search/runtime.test.ts new file mode 100644 index 00000000000..68446d33a95 --- /dev/null +++ b/src/web-search/runtime.test.ts @@ -0,0 +1,46 @@ +import { afterEach, describe, expect, it } from "vitest"; +import { createEmptyPluginRegistry } from "../plugins/registry.js"; +import { setActivePluginRegistry } from "../plugins/runtime.js"; +import { runWebSearch } from "./runtime.js"; + +describe("web search runtime", () => { + afterEach(() => { + setActivePluginRegistry(createEmptyPluginRegistry()); + }); + + it("executes searches through the active plugin registry", async () => { + const registry = createEmptyPluginRegistry(); + registry.webSearchProviders.push({ + pluginId: "custom-search", + pluginName: "Custom Search", + provider: { + id: "custom", + label: "Custom Search", + hint: "Custom runtime provider", + envVars: ["CUSTOM_SEARCH_API_KEY"], + placeholder: "custom-...", + signupUrl: "https://example.com/signup", + autoDetectOrder: 1, + getCredentialValue: () => "configured", + setCredentialValue: () => {}, + createTool: () => ({ + description: "custom", + parameters: {}, + execute: async (args) => ({ ...args, ok: true }), + }), + }, + source: "test", + }); + setActivePluginRegistry(registry); + + await expect( + runWebSearch({ + config: {}, + args: { query: "hello" }, + }), + ).resolves.toEqual({ + provider: "custom", + result: { query: "hello", ok: true }, + }); + }); +}); diff --git a/src/web-search/runtime.ts b/src/web-search/runtime.ts new file mode 100644 index 00000000000..cf11dfcb667 --- /dev/null +++ b/src/web-search/runtime.ts @@ -0,0 +1,194 @@ +import type { OpenClawConfig } from "../config/config.js"; +import { normalizeResolvedSecretInputString } from "../config/types.secrets.js"; +import { logVerbose } from "../globals.js"; +import type { + PluginWebSearchProviderEntry, + WebSearchProviderToolDefinition, +} from "../plugins/types.js"; +import { + resolvePluginWebSearchProviders, + resolveRuntimeWebSearchProviders, +} from "../plugins/web-search-providers.js"; +import type { RuntimeWebSearchMetadata } from "../secrets/runtime-web-tools.types.js"; +import { normalizeSecretInput } from "../utils/normalize-secret-input.js"; + +type WebSearchConfig = NonNullable["web"] extends infer Web + ? Web extends { search?: infer Search } + ? Search + : undefined + : undefined; + +export type ResolveWebSearchDefinitionParams = { + config?: OpenClawConfig; + sandboxed?: boolean; + runtimeWebSearch?: RuntimeWebSearchMetadata; + providerId?: string; + preferRuntimeProviders?: boolean; +}; + +export type RunWebSearchParams = ResolveWebSearchDefinitionParams & { + args: Record; +}; + +function resolveSearchConfig(cfg?: OpenClawConfig): WebSearchConfig { + const search = cfg?.tools?.web?.search; + if (!search || typeof search !== "object") { + return undefined; + } + return search as WebSearchConfig; +} + +export function resolveWebSearchEnabled(params: { + search?: WebSearchConfig; + sandboxed?: boolean; +}): boolean { + if (typeof params.search?.enabled === "boolean") { + return params.search.enabled; + } + if (params.sandboxed) { + return true; + } + return true; +} + +function readProviderEnvValue(envVars: string[]): string | undefined { + for (const envVar of envVars) { + const value = normalizeSecretInput(process.env[envVar]); + if (value) { + return value; + } + } + return undefined; +} + +function hasProviderCredential(providerId: string, search: WebSearchConfig | undefined): boolean { + const providers = resolvePluginWebSearchProviders({ + bundledAllowlistCompat: true, + }); + const provider = providers.find((entry) => entry.id === providerId); + if (!provider) { + return false; + } + const rawValue = provider.getCredentialValue(search as Record | undefined); + const fromConfig = normalizeSecretInput( + normalizeResolvedSecretInputString({ + value: rawValue, + path: + providerId === "brave" + ? "tools.web.search.apiKey" + : `tools.web.search.${providerId}.apiKey`, + }), + ); + return Boolean(fromConfig || readProviderEnvValue(provider.envVars)); +} + +export function listWebSearchProviders(params?: { + config?: OpenClawConfig; +}): PluginWebSearchProviderEntry[] { + return resolveRuntimeWebSearchProviders({ + config: params?.config, + bundledAllowlistCompat: true, + }); +} + +export function resolveWebSearchProviderId(params: { + search?: WebSearchConfig; + providers?: PluginWebSearchProviderEntry[]; +}): string { + const providers = + params.providers ?? + resolvePluginWebSearchProviders({ + bundledAllowlistCompat: true, + }); + const raw = + params.search && "provider" in params.search && typeof params.search.provider === "string" + ? params.search.provider.trim().toLowerCase() + : ""; + + if (raw) { + const explicit = providers.find((provider) => provider.id === raw); + if (explicit) { + return explicit.id; + } + } + + if (!raw) { + for (const provider of providers) { + if (!hasProviderCredential(provider.id, params.search)) { + continue; + } + logVerbose( + `web_search: no provider configured, auto-detected "${provider.id}" from available API keys`, + ); + return provider.id; + } + } + + return providers[0]?.id ?? "brave"; +} + +export function resolveWebSearchDefinition( + options?: ResolveWebSearchDefinitionParams, +): { provider: PluginWebSearchProviderEntry; definition: WebSearchProviderToolDefinition } | null { + const search = resolveSearchConfig(options?.config); + if (!resolveWebSearchEnabled({ search, sandboxed: options?.sandboxed })) { + return null; + } + + const providers = ( + options?.preferRuntimeProviders + ? resolveRuntimeWebSearchProviders({ + config: options?.config, + bundledAllowlistCompat: true, + }) + : resolvePluginWebSearchProviders({ + config: options?.config, + bundledAllowlistCompat: true, + }) + ).filter(Boolean); + if (providers.length === 0) { + return null; + } + + const providerId = + options?.providerId ?? + options?.runtimeWebSearch?.selectedProvider ?? + options?.runtimeWebSearch?.providerConfigured ?? + resolveWebSearchProviderId({ search, providers }); + const provider = + providers.find((entry) => entry.id === providerId) ?? + providers.find((entry) => entry.id === resolveWebSearchProviderId({ search, providers })) ?? + providers[0]; + if (!provider) { + return null; + } + + const definition = provider.createTool({ + config: options?.config, + searchConfig: search as Record | undefined, + runtimeMetadata: options?.runtimeWebSearch, + }); + if (!definition) { + return null; + } + + return { provider, definition }; +} + +export async function runWebSearch( + params: RunWebSearchParams, +): Promise<{ provider: string; result: Record }> { + const resolved = resolveWebSearchDefinition({ ...params, preferRuntimeProviders: true }); + if (!resolved) { + throw new Error("web_search is disabled or no provider is available."); + } + return { + provider: resolved.provider.id, + result: await resolved.definition.execute(params.args), + }; +} + +export const __testing = { + resolveSearchConfig, + resolveWebSearchProviderId, +}; From 631f6f47cfb1a7a0ccd96310f2ad12fb9f353cf8 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:30:50 -0700 Subject: [PATCH 009/187] fix(extensions): restore setup and catalog tests --- .../signal/src/setup-allow-from.test.ts | 2 +- extensions/signal/src/setup-surface.ts | 2 -- extensions/whatsapp/src/channel.ts | 4 ++++ src/plugins/provider-catalog.test.ts | 22 +++++++------------ 4 files changed, 13 insertions(+), 17 deletions(-) diff --git a/extensions/signal/src/setup-allow-from.test.ts b/extensions/signal/src/setup-allow-from.test.ts index 959082a2582..c7532870109 100644 --- a/extensions/signal/src/setup-allow-from.test.ts +++ b/extensions/signal/src/setup-allow-from.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { normalizeSignalAccountInput, parseSignalAllowFromEntries } from "./setup-surface.js"; +import { normalizeSignalAccountInput, parseSignalAllowFromEntries } from "./setup-core.js"; describe("normalizeSignalAccountInput", () => { it("normalizes valid E.164 numbers", () => { diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 32270cde952..72b1a4ef958 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,11 +1,9 @@ import { - DEFAULT_ACCOUNT_ID, detectBinary, formatCliCommand, formatDocsLink, installSignalCli, type OpenClawConfig, - parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, setChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 7e4be853c23..ae7a6b1e56c 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -41,6 +41,10 @@ import { collectWhatsAppStatusIssues } from "./status-issues.js"; const meta = getChatChannelMeta("whatsapp"); +async function loadWhatsAppChannelRuntime() { + return await import("./channel.runtime.js"); +} + function normalizeWhatsAppPayloadText(text: string | undefined): string { return (text ?? "").replace(/^(?:[ \t]*\r?\n)+/, ""); } diff --git a/src/plugins/provider-catalog.test.ts b/src/plugins/provider-catalog.test.ts index b8c865dec5d..a49e82a98e6 100644 --- a/src/plugins/provider-catalog.test.ts +++ b/src/plugins/provider-catalog.test.ts @@ -1,5 +1,6 @@ import { describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; +import type { ModelProviderConfig } from "../config/types.models.js"; import { buildPairedProviderApiKeyCatalog, buildSingleProviderApiKeyCatalog, @@ -7,12 +8,12 @@ import { } from "./provider-catalog.js"; import type { ProviderCatalogContext } from "./types.js"; -function createProviderConfig(params?: { provider?: string; baseUrl?: string }) { +function createProviderConfig(overrides: Partial = {}): ModelProviderConfig { return { - api: "openai-completions" as const, - provider: params?.provider ?? "test-provider", - baseUrl: params?.baseUrl ?? "https://default.example/v1", + api: "openai-completions", + baseUrl: "https://default.example/v1", models: [], + ...overrides, }; } @@ -67,7 +68,6 @@ describe("buildSingleProviderApiKeyCatalog", () => { api: "openai-completions", baseUrl: "https://default.example/v1", models: [], - provider: "test-provider", apiKey: "secret-key", }, }); @@ -89,10 +89,7 @@ describe("buildSingleProviderApiKeyCatalog", () => { }, }), providerId: "test-provider", - buildProvider: () => ({ - ...createProviderConfig(), - baseUrl: "https://default.example/v1", - }), + buildProvider: () => createProviderConfig(), allowExplicitBaseUrl: true, }); @@ -101,7 +98,6 @@ describe("buildSingleProviderApiKeyCatalog", () => { api: "openai-completions", baseUrl: "https://override.example/v1/", models: [], - provider: "test-provider", apiKey: "secret-key", }, }); @@ -114,8 +110,8 @@ describe("buildSingleProviderApiKeyCatalog", () => { }), providerId: "test-provider", buildProviders: async () => ({ - alpha: createProviderConfig({ provider: "alpha" }), - beta: createProviderConfig({ provider: "beta" }), + alpha: createProviderConfig(), + beta: createProviderConfig(), }), }); @@ -125,14 +121,12 @@ describe("buildSingleProviderApiKeyCatalog", () => { api: "openai-completions", baseUrl: "https://default.example/v1", models: [], - provider: "alpha", apiKey: "secret-key", }, beta: { api: "openai-completions", baseUrl: "https://default.example/v1", models: [], - provider: "beta", apiKey: "secret-key", }, }, From 73703d977cad5d4409e7bc7d7a3e29edd29eeafd Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:33:35 -0700 Subject: [PATCH 010/187] refactor: remove onboard auth compat barrels --- extensions/kimi-coding/index.ts | 7 +- extensions/kimi-coding/onboard.ts | 13 +- extensions/whatsapp/src/channel.ts | 2 +- extensions/whatsapp/src/plugin-shared.ts | 2 +- .../models-config.providers.moonshot.test.ts | 2 +- src/commands/auth-choice.test.ts | 10 +- src/commands/auth-credentials.ts | 6 - src/commands/auth-profile-config.ts | 1 - .../onboard-auth.config-core.kilocode.test.ts | 14 +- src/commands/onboard-auth.config-core.ts | 82 ---------- src/commands/onboard-auth.config-minimax.ts | 6 - .../onboard-auth.config-opencode-go.ts | 5 - src/commands/onboard-auth.config-opencode.ts | 5 - .../onboard-auth.config-shared.test.ts | 2 +- src/commands/onboard-auth.config-shared.ts | 7 - src/commands/onboard-auth.credentials.test.ts | 2 +- src/commands/onboard-auth.credentials.ts | 43 ----- src/commands/onboard-auth.models.ts | 140 ---------------- src/commands/onboard-auth.test.ts | 64 +++++--- src/commands/onboard-auth.ts | 149 ------------------ ...oard-non-interactive.provider-auth.test.ts | 6 +- .../local/auth-choice.api-key-providers.ts | 8 +- src/plugin-sdk/provider-models.ts | 2 +- 23 files changed, 74 insertions(+), 504 deletions(-) delete mode 100644 src/commands/auth-credentials.ts delete mode 100644 src/commands/auth-profile-config.ts delete mode 100644 src/commands/onboard-auth.config-core.ts delete mode 100644 src/commands/onboard-auth.config-minimax.ts delete mode 100644 src/commands/onboard-auth.config-opencode-go.ts delete mode 100644 src/commands/onboard-auth.config-opencode.ts delete mode 100644 src/commands/onboard-auth.config-shared.ts delete mode 100644 src/commands/onboard-auth.credentials.ts delete mode 100644 src/commands/onboard-auth.models.ts delete mode 100644 src/commands/onboard-auth.ts diff --git a/extensions/kimi-coding/index.ts b/extensions/kimi-coding/index.ts index 3803a0af951..03f680a5c38 100644 --- a/extensions/kimi-coding/index.ts +++ b/extensions/kimi-coding/index.ts @@ -4,10 +4,11 @@ import { isRecord } from "openclaw/plugin-sdk/text-runtime"; import { applyKimiCodeConfig, KIMI_CODING_MODEL_REF } from "./onboard.js"; import { buildKimiCodingProvider } from "./provider-catalog.js"; -const PROVIDER_ID = "kimi-coding"; +const PLUGIN_ID = "kimi"; +const PROVIDER_ID = "kimi"; const kimiCodingPlugin = { - id: PROVIDER_ID, + id: PLUGIN_ID, name: "Kimi Provider", description: "Bundled Kimi provider plugin", configSchema: emptyPluginConfigSchema(), @@ -15,7 +16,7 @@ const kimiCodingPlugin = { api.registerProvider({ id: PROVIDER_ID, label: "Kimi", - aliases: ["kimi", "kimi-code"], + aliases: ["kimi-code", "kimi-coding"], docsPath: "/providers/moonshot", envVars: ["KIMI_API_KEY", "KIMICODE_API_KEY"], auth: [ diff --git a/extensions/kimi-coding/onboard.ts b/extensions/kimi-coding/onboard.ts index c97738f1e72..60ce12553f1 100644 --- a/extensions/kimi-coding/onboard.ts +++ b/extensions/kimi-coding/onboard.ts @@ -9,13 +9,14 @@ import { KIMI_CODING_DEFAULT_MODEL_ID, } from "./provider-catalog.js"; -export const KIMI_CODING_MODEL_REF = `kimi-coding/${KIMI_CODING_DEFAULT_MODEL_ID}`; +export const KIMI_MODEL_REF = `kimi/${KIMI_CODING_DEFAULT_MODEL_ID}`; +export const KIMI_CODING_MODEL_REF = KIMI_MODEL_REF; export function applyKimiCodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig { const models = { ...cfg.agents?.defaults?.models }; - models[KIMI_CODING_MODEL_REF] = { - ...models[KIMI_CODING_MODEL_REF], - alias: models[KIMI_CODING_MODEL_REF]?.alias ?? "Kimi", + models[KIMI_MODEL_REF] = { + ...models[KIMI_MODEL_REF], + alias: models[KIMI_MODEL_REF]?.alias ?? "Kimi", }; const defaultModel = buildKimiCodingProvider().models[0]; @@ -25,7 +26,7 @@ export function applyKimiCodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig return applyProviderConfigWithDefaultModel(cfg, { agentModels: models, - providerId: "kimi-coding", + providerId: "kimi", api: "anthropic-messages", baseUrl: KIMI_CODING_BASE_URL, defaultModel, @@ -34,5 +35,5 @@ export function applyKimiCodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig } export function applyKimiCodeConfig(cfg: OpenClawConfig): OpenClawConfig { - return applyAgentDefaultModelPrimary(applyKimiCodeProviderConfig(cfg), KIMI_CODING_MODEL_REF); + return applyAgentDefaultModelPrimary(applyKimiCodeProviderConfig(cfg), KIMI_MODEL_REF); } diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index ae7a6b1e56c..63d222ba1ed 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -34,7 +34,7 @@ import { type ResolvedWhatsAppAccount, } from "./accounts.js"; import { looksLikeWhatsAppTargetId, normalizeWhatsAppMessagingTarget } from "./normalize.js"; -import { whatsappSetupWizardProxy } from "./plugin-shared.js"; +import { loadWhatsAppChannelRuntime, whatsappSetupWizardProxy } from "./plugin-shared.js"; import { getWhatsAppRuntime } from "./runtime.js"; import { whatsappSetupAdapter } from "./setup-core.js"; import { collectWhatsAppStatusIssues } from "./status-issues.js"; diff --git a/extensions/whatsapp/src/plugin-shared.ts b/extensions/whatsapp/src/plugin-shared.ts index 96a5f86e6f9..fee78e620a4 100644 --- a/extensions/whatsapp/src/plugin-shared.ts +++ b/extensions/whatsapp/src/plugin-shared.ts @@ -1,7 +1,7 @@ import type { ChannelPlugin } from "openclaw/plugin-sdk/whatsapp"; import { type ResolvedWhatsAppAccount } from "./accounts.js"; -async function loadWhatsAppChannelRuntime() { +export async function loadWhatsAppChannelRuntime() { return await import("./channel.runtime.js"); } diff --git a/src/agents/models-config.providers.moonshot.test.ts b/src/agents/models-config.providers.moonshot.test.ts index 1d0d29d1b30..b224d1c44d3 100644 --- a/src/agents/models-config.providers.moonshot.test.ts +++ b/src/agents/models-config.providers.moonshot.test.ts @@ -5,7 +5,7 @@ import { describe, expect, it } from "vitest"; import { MOONSHOT_BASE_URL as MOONSHOT_AI_BASE_URL, MOONSHOT_CN_BASE_URL, -} from "../commands/onboard-auth.models.js"; +} from "../plugins/provider-model-definitions.js"; import { captureEnv } from "../test-utils/env.js"; import { resolveImplicitProvidersForTest } from "./models-config.e2e-harness.js"; import { applyNativeStreamingUsageCompat } from "./models-config.providers.js"; diff --git a/src/commands/auth-choice.test.ts b/src/commands/auth-choice.test.ts index 038c672ee14..a394bf00528 100644 --- a/src/commands/auth-choice.test.ts +++ b/src/commands/auth-choice.test.ts @@ -26,16 +26,16 @@ import { setDetectZaiEndpointForTesting } from "../../extensions/zai/detect.js"; import zaiPlugin from "../../extensions/zai/index.js"; import { resolveAgentDir } from "../agents/agent-scope.js"; import { resolveAgentModelPrimaryValue } from "../config/model-input.js"; +import { + MINIMAX_CN_API_BASE_URL, + ZAI_CODING_CN_BASE_URL, + ZAI_CODING_GLOBAL_BASE_URL, +} from "../plugins/provider-model-definitions.js"; import type { ProviderPlugin } from "../plugins/types.js"; import { createCapturedPluginRegistration } from "../test-utils/plugin-registration.js"; import type { WizardPrompter } from "../wizard/prompts.js"; import { applyAuthChoice, resolvePreferredProviderForAuthChoice } from "./auth-choice.js"; import { GOOGLE_GEMINI_DEFAULT_MODEL } from "./google-gemini-model-default.js"; -import { - MINIMAX_CN_API_BASE_URL, - ZAI_CODING_CN_BASE_URL, - ZAI_CODING_GLOBAL_BASE_URL, -} from "./onboard-auth.js"; import type { AuthChoice } from "./onboard-types.js"; import { authProfilePathForAgent, diff --git a/src/commands/auth-credentials.ts b/src/commands/auth-credentials.ts deleted file mode 100644 index 94e320f48db..00000000000 --- a/src/commands/auth-credentials.ts +++ /dev/null @@ -1,6 +0,0 @@ -export { - buildApiKeyCredential, - type ApiKeyStorageOptions, - writeOAuthCredentials, - type WriteOAuthCredentialsOptions, -} from "../plugins/provider-auth-helpers.js"; diff --git a/src/commands/auth-profile-config.ts b/src/commands/auth-profile-config.ts deleted file mode 100644 index c3879e01846..00000000000 --- a/src/commands/auth-profile-config.ts +++ /dev/null @@ -1 +0,0 @@ -export { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; diff --git a/src/commands/onboard-auth.config-core.kilocode.test.ts b/src/commands/onboard-auth.config-core.kilocode.test.ts index 82faf85c8f0..511b5550890 100644 --- a/src/commands/onboard-auth.config-core.kilocode.test.ts +++ b/src/commands/onboard-auth.config-core.kilocode.test.ts @@ -2,23 +2,23 @@ import { mkdtempSync } from "node:fs"; import { tmpdir } from "node:os"; import { join } from "node:path"; import { describe, expect, it } from "vitest"; -import { resolveApiKeyForProvider, resolveEnvApiKey } from "../agents/model-auth.js"; -import type { OpenClawConfig } from "../config/config.js"; -import { resolveAgentModelPrimaryValue } from "../config/model-input.js"; -import { captureEnv } from "../test-utils/env.js"; import { applyKilocodeProviderConfig, applyKilocodeConfig, KILOCODE_BASE_URL, -} from "./onboard-auth.config-core.js"; -import { KILOCODE_DEFAULT_MODEL_REF } from "./onboard-auth.credentials.js"; + KILOCODE_DEFAULT_MODEL_REF, +} from "../../extensions/kilocode/onboard.js"; +import { resolveApiKeyForProvider, resolveEnvApiKey } from "../agents/model-auth.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { resolveAgentModelPrimaryValue } from "../config/model-input.js"; import { buildKilocodeModelDefinition, KILOCODE_DEFAULT_MODEL_ID, KILOCODE_DEFAULT_CONTEXT_WINDOW, KILOCODE_DEFAULT_MAX_TOKENS, KILOCODE_DEFAULT_COST, -} from "./onboard-auth.models.js"; +} from "../plugins/provider-model-definitions.js"; +import { captureEnv } from "../test-utils/env.js"; const emptyCfg: OpenClawConfig = {}; const KILOCODE_MODEL_IDS = ["kilo/auto"]; diff --git a/src/commands/onboard-auth.config-core.ts b/src/commands/onboard-auth.config-core.ts deleted file mode 100644 index 65b4fd40cf0..00000000000 --- a/src/commands/onboard-auth.config-core.ts +++ /dev/null @@ -1,82 +0,0 @@ -export { - applyCloudflareAiGatewayConfig, - applyCloudflareAiGatewayProviderConfig, - applyVercelAiGatewayConfig, - applyVercelAiGatewayProviderConfig, -} from "./onboard-auth.config-gateways.js"; -export { - applyLitellmConfig, - applyLitellmProviderConfig, - LITELLM_BASE_URL, - LITELLM_DEFAULT_MODEL_ID, -} from "./onboard-auth.config-litellm.js"; -export { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; -export { - applyHuggingfaceConfig, - applyHuggingfaceProviderConfig, - HUGGINGFACE_DEFAULT_MODEL_REF, -} from "../../extensions/huggingface/onboard.js"; -export { - applyKimiCodeConfig, - applyKimiCodeProviderConfig, -} from "../../extensions/kimi-coding/onboard.js"; -export { - applyKilocodeConfig, - applyKilocodeProviderConfig, - KILOCODE_BASE_URL, - KILOCODE_DEFAULT_MODEL_REF, -} from "../../extensions/kilocode/onboard.js"; -export { - applyMistralConfig, - applyMistralProviderConfig, - MISTRAL_DEFAULT_MODEL_REF, -} from "../../extensions/mistral/onboard.js"; -export { - applyModelStudioConfig, - applyModelStudioConfigCn, - applyModelStudioProviderConfig, - applyModelStudioProviderConfigCn, - MODELSTUDIO_CN_BASE_URL, - MODELSTUDIO_DEFAULT_MODEL_REF, - MODELSTUDIO_GLOBAL_BASE_URL, -} from "../../extensions/modelstudio/onboard.js"; -export { - applyMoonshotConfig, - applyMoonshotConfigCn, - applyMoonshotProviderConfig, - applyMoonshotProviderConfigCn, -} from "../../extensions/moonshot/onboard.js"; -export { - applyOpenrouterConfig, - applyOpenrouterProviderConfig, -} from "../../extensions/openrouter/onboard.js"; -export { - applyQianfanConfig, - applyQianfanProviderConfig, -} from "../../extensions/qianfan/onboard.js"; -export { - applySyntheticConfig, - applySyntheticProviderConfig, - SYNTHETIC_DEFAULT_MODEL_REF, -} from "../../extensions/synthetic/onboard.js"; -export { - applyTogetherConfig, - applyTogetherProviderConfig, - TOGETHER_DEFAULT_MODEL_REF, -} from "../../extensions/together/onboard.js"; -export { - applyVeniceConfig, - applyVeniceProviderConfig, - VENICE_DEFAULT_MODEL_REF, -} from "../../extensions/venice/onboard.js"; -export { - applyXaiConfig, - applyXaiProviderConfig, - XAI_DEFAULT_MODEL_REF, -} from "../../extensions/xai/onboard.js"; -export { applyXiaomiConfig, applyXiaomiProviderConfig } from "../../extensions/xiaomi/onboard.js"; -export { - applyZaiConfig, - applyZaiProviderConfig, - ZAI_DEFAULT_MODEL_REF, -} from "../../extensions/zai/onboard.js"; diff --git a/src/commands/onboard-auth.config-minimax.ts b/src/commands/onboard-auth.config-minimax.ts deleted file mode 100644 index 8453154bb7f..00000000000 --- a/src/commands/onboard-auth.config-minimax.ts +++ /dev/null @@ -1,6 +0,0 @@ -export { - applyMinimaxApiConfig, - applyMinimaxApiConfigCn, - applyMinimaxApiProviderConfig, - applyMinimaxApiProviderConfigCn, -} from "../../extensions/minimax/onboard.js"; diff --git a/src/commands/onboard-auth.config-opencode-go.ts b/src/commands/onboard-auth.config-opencode-go.ts deleted file mode 100644 index eb31512e565..00000000000 --- a/src/commands/onboard-auth.config-opencode-go.ts +++ /dev/null @@ -1,5 +0,0 @@ -export { - applyOpencodeGoConfig, - applyOpencodeGoProviderConfig, - OPENCODE_GO_DEFAULT_MODEL_REF, -} from "../../extensions/opencode-go/onboard.js"; diff --git a/src/commands/onboard-auth.config-opencode.ts b/src/commands/onboard-auth.config-opencode.ts deleted file mode 100644 index d9aa6f97436..00000000000 --- a/src/commands/onboard-auth.config-opencode.ts +++ /dev/null @@ -1,5 +0,0 @@ -export { - applyOpencodeZenConfig, - applyOpencodeZenProviderConfig, - OPENCODE_ZEN_DEFAULT_MODEL_REF, -} from "../../extensions/opencode/onboard.js"; diff --git a/src/commands/onboard-auth.config-shared.test.ts b/src/commands/onboard-auth.config-shared.test.ts index de2dc9adb62..01cda96ae74 100644 --- a/src/commands/onboard-auth.config-shared.test.ts +++ b/src/commands/onboard-auth.config-shared.test.ts @@ -6,7 +6,7 @@ import { applyProviderConfigWithDefaultModel, applyProviderConfigWithDefaultModels, applyProviderConfigWithModelCatalog, -} from "./onboard-auth.config-shared.js"; +} from "../plugins/provider-onboarding-config.js"; function makeModel(id: string): ModelDefinitionConfig { return { diff --git a/src/commands/onboard-auth.config-shared.ts b/src/commands/onboard-auth.config-shared.ts deleted file mode 100644 index 7c278eec644..00000000000 --- a/src/commands/onboard-auth.config-shared.ts +++ /dev/null @@ -1,7 +0,0 @@ -export { - applyAgentDefaultModelPrimary, - applyOnboardAuthAgentModelsAndProviders, - applyProviderConfigWithDefaultModel, - applyProviderConfigWithDefaultModels, - applyProviderConfigWithModelCatalog, -} from "../plugins/provider-onboarding-config.js"; diff --git a/src/commands/onboard-auth.credentials.test.ts b/src/commands/onboard-auth.credentials.test.ts index e844ac501c2..8c80f51ec2a 100644 --- a/src/commands/onboard-auth.credentials.test.ts +++ b/src/commands/onboard-auth.credentials.test.ts @@ -6,7 +6,7 @@ import { setOpencodeZenApiKey, setOpenaiApiKey, setVolcengineApiKey, -} from "./onboard-auth.js"; +} from "../plugins/provider-auth-storage.js"; import { createAuthTestLifecycle, readAuthProfilesForAgent, diff --git a/src/commands/onboard-auth.credentials.ts b/src/commands/onboard-auth.credentials.ts deleted file mode 100644 index 578ad17859d..00000000000 --- a/src/commands/onboard-auth.credentials.ts +++ /dev/null @@ -1,43 +0,0 @@ -export { - buildApiKeyCredential, - type ApiKeyStorageOptions, - HUGGINGFACE_DEFAULT_MODEL_REF, - KILOCODE_DEFAULT_MODEL_REF, - LITELLM_DEFAULT_MODEL_REF, - OPENROUTER_DEFAULT_MODEL_REF, - setAnthropicApiKey, - setByteplusApiKey, - setCloudflareAiGatewayConfig, - setGeminiApiKey, - setHuggingfaceApiKey, - setKilocodeApiKey, - setKimiCodingApiKey, - setLitellmApiKey, - setMinimaxApiKey, - setMistralApiKey, - setModelStudioApiKey, - setMoonshotApiKey, - setOpenaiApiKey, - setOpencodeGoApiKey, - setOpencodeZenApiKey, - setOpenrouterApiKey, - setQianfanApiKey, - setSyntheticApiKey, - setTogetherApiKey, - setVeniceApiKey, - setVercelAiGatewayApiKey, - setVolcengineApiKey, - setXaiApiKey, - setXiaomiApiKey, - setZaiApiKey, - TOGETHER_DEFAULT_MODEL_REF, - VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF, - writeOAuthCredentials, - type WriteOAuthCredentialsOptions, - XIAOMI_DEFAULT_MODEL_REF, - ZAI_DEFAULT_MODEL_REF, -} from "../plugins/provider-auth-storage.js"; -export { CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF } from "../agents/cloudflare-ai-gateway.js"; -export { MISTRAL_DEFAULT_MODEL_REF } from "../../extensions/mistral/onboard.js"; -export { MODELSTUDIO_DEFAULT_MODEL_REF } from "../../extensions/modelstudio/onboard.js"; -export { XAI_DEFAULT_MODEL_REF } from "../../extensions/xai/onboard.js"; diff --git a/src/commands/onboard-auth.models.ts b/src/commands/onboard-auth.models.ts deleted file mode 100644 index 5788d0ad2ca..00000000000 --- a/src/commands/onboard-auth.models.ts +++ /dev/null @@ -1,140 +0,0 @@ -import { KIMI_CODING_MODEL_REF } from "../../extensions/kimi-coding/onboard.js"; -import { - KIMI_DEFAULT_MODEL_ID as KIMI_CODING_MODEL_ID, - KIMI_CODING_BASE_URL, -} from "../../extensions/kimi-coding/provider-catalog.js"; -import { - DEFAULT_MINIMAX_BASE_URL, - MINIMAX_API_BASE_URL, - MINIMAX_API_COST, - MINIMAX_CN_API_BASE_URL, - MINIMAX_HOSTED_COST, - MINIMAX_HOSTED_MODEL_ID, - MINIMAX_HOSTED_MODEL_REF, - MINIMAX_LM_STUDIO_COST, - buildMinimaxApiModelDefinition, - buildMinimaxModelDefinition, -} from "../../extensions/minimax/model-definitions.js"; -import { - buildMistralModelDefinition, - MISTRAL_BASE_URL, - MISTRAL_DEFAULT_COST, - MISTRAL_DEFAULT_MODEL_ID, - MISTRAL_DEFAULT_MODEL_REF, -} from "../../extensions/mistral/model-definitions.js"; -import { - MODELSTUDIO_CN_BASE_URL, - MODELSTUDIO_DEFAULT_COST, - MODELSTUDIO_DEFAULT_MODEL_ID, - MODELSTUDIO_DEFAULT_MODEL_REF, - MODELSTUDIO_GLOBAL_BASE_URL, - buildModelStudioDefaultModelDefinition, - buildModelStudioModelDefinition, -} from "../../extensions/modelstudio/model-definitions.js"; -import { - MOONSHOT_CN_BASE_URL, - MOONSHOT_DEFAULT_MODEL_REF, -} from "../../extensions/moonshot/onboard.js"; -import { - buildMoonshotProvider, - MOONSHOT_BASE_URL, - MOONSHOT_DEFAULT_MODEL_ID, -} from "../../extensions/moonshot/provider-catalog.js"; -import { QIANFAN_DEFAULT_MODEL_REF } from "../../extensions/qianfan/onboard.js"; -import { - QIANFAN_BASE_URL, - QIANFAN_DEFAULT_MODEL_ID, -} from "../../extensions/qianfan/provider-catalog.js"; -import { - XAI_BASE_URL, - XAI_DEFAULT_COST, - XAI_DEFAULT_MODEL_ID, - XAI_DEFAULT_MODEL_REF, - buildXaiModelDefinition, -} from "../../extensions/xai/model-definitions.js"; -import { - buildZaiModelDefinition, - resolveZaiBaseUrl, - ZAI_CN_BASE_URL, - ZAI_CODING_CN_BASE_URL, - ZAI_CODING_GLOBAL_BASE_URL, - ZAI_DEFAULT_COST, - ZAI_DEFAULT_MODEL_ID, - ZAI_GLOBAL_BASE_URL, -} from "../../extensions/zai/model-definitions.js"; -import type { ModelDefinitionConfig } from "../config/types.models.js"; -import { - KILOCODE_DEFAULT_CONTEXT_WINDOW, - KILOCODE_DEFAULT_COST, - KILOCODE_DEFAULT_MAX_TOKENS, - KILOCODE_DEFAULT_MODEL_ID, - KILOCODE_DEFAULT_MODEL_NAME, -} from "../providers/kilocode-shared.js"; - -export { - DEFAULT_MINIMAX_BASE_URL, - MINIMAX_API_BASE_URL, - MINIMAX_API_COST, - MINIMAX_CN_API_BASE_URL, - MINIMAX_HOSTED_COST, - MINIMAX_HOSTED_MODEL_ID, - MINIMAX_HOSTED_MODEL_REF, - MINIMAX_LM_STUDIO_COST, - MISTRAL_BASE_URL, - MISTRAL_DEFAULT_COST, - MISTRAL_DEFAULT_MODEL_ID, - MISTRAL_DEFAULT_MODEL_REF, - MODELSTUDIO_CN_BASE_URL, - MODELSTUDIO_DEFAULT_COST, - MODELSTUDIO_DEFAULT_MODEL_ID, - MODELSTUDIO_DEFAULT_MODEL_REF, - MODELSTUDIO_GLOBAL_BASE_URL, - MOONSHOT_BASE_URL, - MOONSHOT_CN_BASE_URL, - MOONSHOT_DEFAULT_MODEL_ID, - MOONSHOT_DEFAULT_MODEL_REF, - QIANFAN_BASE_URL, - QIANFAN_DEFAULT_MODEL_ID, - QIANFAN_DEFAULT_MODEL_REF, - XAI_BASE_URL, - XAI_DEFAULT_COST, - XAI_DEFAULT_MODEL_ID, - XAI_DEFAULT_MODEL_REF, - ZAI_CN_BASE_URL, - ZAI_CODING_CN_BASE_URL, - ZAI_CODING_GLOBAL_BASE_URL, - ZAI_DEFAULT_COST, - ZAI_DEFAULT_MODEL_ID, - ZAI_GLOBAL_BASE_URL, - KIMI_CODING_BASE_URL, - KIMI_CODING_MODEL_ID, - KIMI_CODING_MODEL_REF, - KILOCODE_DEFAULT_CONTEXT_WINDOW, - KILOCODE_DEFAULT_COST, - KILOCODE_DEFAULT_MAX_TOKENS, - KILOCODE_DEFAULT_MODEL_ID, - buildMinimaxApiModelDefinition, - buildMinimaxModelDefinition, - buildMistralModelDefinition, - buildModelStudioDefaultModelDefinition, - buildModelStudioModelDefinition, - buildXaiModelDefinition, - buildZaiModelDefinition, - resolveZaiBaseUrl, -}; - -export function buildMoonshotModelDefinition(): ModelDefinitionConfig { - return buildMoonshotProvider().models[0]; -} - -export function buildKilocodeModelDefinition(): ModelDefinitionConfig { - return { - id: KILOCODE_DEFAULT_MODEL_ID, - name: KILOCODE_DEFAULT_MODEL_NAME, - reasoning: true, - input: ["text", "image"], - cost: KILOCODE_DEFAULT_COST, - contextWindow: KILOCODE_DEFAULT_CONTEXT_WINDOW, - maxTokens: KILOCODE_DEFAULT_MAX_TOKENS, - }; -} diff --git a/src/commands/onboard-auth.test.ts b/src/commands/onboard-auth.test.ts index 8c4b8e38bda..2ad0339a3b2 100644 --- a/src/commands/onboard-auth.test.ts +++ b/src/commands/onboard-auth.test.ts @@ -3,43 +3,57 @@ import os from "node:os"; import path from "node:path"; import type { OAuthCredentials } from "@mariozechner/pi-ai"; import { afterEach, describe, expect, it } from "vitest"; +import { + applyMinimaxApiConfig, + applyMinimaxApiProviderConfig, +} from "../../extensions/minimax/onboard.js"; +import { + applyMistralConfig, + applyMistralProviderConfig, +} from "../../extensions/mistral/onboard.js"; +import { + applyOpencodeGoConfig, + applyOpencodeGoProviderConfig, +} from "../../extensions/opencode-go/onboard.js"; +import { + applyOpencodeZenConfig, + applyOpencodeZenProviderConfig, +} from "../../extensions/opencode/onboard.js"; +import { + applyOpenrouterConfig, + applyOpenrouterProviderConfig, +} from "../../extensions/openrouter/onboard.js"; +import { + applySyntheticConfig, + applySyntheticProviderConfig, + SYNTHETIC_DEFAULT_MODEL_REF, +} from "../../extensions/synthetic/onboard.js"; +import { + applyXaiConfig, + applyXaiProviderConfig, + XAI_DEFAULT_MODEL_REF, +} from "../../extensions/xai/onboard.js"; +import { applyXiaomiConfig, applyXiaomiProviderConfig } from "../../extensions/xiaomi/onboard.js"; +import { applyZaiConfig, applyZaiProviderConfig } from "../../extensions/zai/onboard.js"; +import { SYNTHETIC_DEFAULT_MODEL_ID } from "../agents/synthetic-models.js"; import type { OpenClawConfig } from "../config/config.js"; import { resolveAgentModelFallbackValues, resolveAgentModelPrimaryValue, } from "../config/model-input.js"; import type { ModelApi } from "../config/types.models.js"; +import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; import { - applyAuthProfileConfig, - applyLitellmProviderConfig, - applyMistralConfig, - applyMistralProviderConfig, - applyMinimaxApiConfig, - applyMinimaxApiProviderConfig, - applyOpencodeGoConfig, - applyOpencodeGoProviderConfig, - applyOpencodeZenConfig, - applyOpencodeZenProviderConfig, - applyOpenrouterConfig, - applyOpenrouterProviderConfig, - applySyntheticConfig, - applySyntheticProviderConfig, - applyXaiConfig, - applyXaiProviderConfig, - applyXiaomiConfig, - applyXiaomiProviderConfig, - applyZaiConfig, - applyZaiProviderConfig, OPENROUTER_DEFAULT_MODEL_REF, - MISTRAL_DEFAULT_MODEL_REF, - SYNTHETIC_DEFAULT_MODEL_ID, - SYNTHETIC_DEFAULT_MODEL_REF, - XAI_DEFAULT_MODEL_REF, setMinimaxApiKey, writeOAuthCredentials, +} from "../plugins/provider-auth-storage.js"; +import { + MISTRAL_DEFAULT_MODEL_REF, ZAI_CODING_CN_BASE_URL, ZAI_GLOBAL_BASE_URL, -} from "./onboard-auth.js"; +} from "../plugins/provider-model-definitions.js"; +import { applyLitellmProviderConfig } from "./onboard-auth.config-litellm.js"; import { createAuthTestLifecycle, readAuthProfilesForAgent, diff --git a/src/commands/onboard-auth.ts b/src/commands/onboard-auth.ts deleted file mode 100644 index 9a67a69a287..00000000000 --- a/src/commands/onboard-auth.ts +++ /dev/null @@ -1,149 +0,0 @@ -export { SYNTHETIC_DEFAULT_MODEL_ID } from "../agents/synthetic-models.js"; -export { VENICE_DEFAULT_MODEL_ID } from "../agents/venice-models.js"; -export { - applyAuthProfileConfig, - applyCloudflareAiGatewayConfig, - applyCloudflareAiGatewayProviderConfig, - applyHuggingfaceConfig, - applyHuggingfaceProviderConfig, - applyKilocodeConfig, - applyKilocodeProviderConfig, - applyQianfanConfig, - applyQianfanProviderConfig, - applyKimiCodeConfig, - applyKimiCodeProviderConfig, - applyLitellmConfig, - applyLitellmProviderConfig, - applyMistralConfig, - applyMistralProviderConfig, - applyMoonshotConfig, - applyMoonshotConfigCn, - applyMoonshotProviderConfig, - applyMoonshotProviderConfigCn, - applyOpenrouterConfig, - applyOpenrouterProviderConfig, - applySyntheticConfig, - applySyntheticProviderConfig, - applyTogetherConfig, - applyTogetherProviderConfig, - applyVeniceConfig, - applyVeniceProviderConfig, - applyVercelAiGatewayConfig, - applyVercelAiGatewayProviderConfig, - applyXaiConfig, - applyXaiProviderConfig, - applyXiaomiConfig, - applyXiaomiProviderConfig, - applyZaiConfig, - applyZaiProviderConfig, - applyModelStudioConfig, - applyModelStudioConfigCn, - applyModelStudioProviderConfig, - applyModelStudioProviderConfigCn, - KILOCODE_BASE_URL, -} from "./onboard-auth.config-core.js"; -export { - applyMinimaxApiConfig, - applyMinimaxApiConfigCn, - applyMinimaxApiProviderConfig, - applyMinimaxApiProviderConfigCn, -} from "./onboard-auth.config-minimax.js"; - -export { - applyOpencodeZenConfig, - applyOpencodeZenProviderConfig, -} from "./onboard-auth.config-opencode.js"; -export { - applyOpencodeGoConfig, - applyOpencodeGoProviderConfig, -} from "./onboard-auth.config-opencode-go.js"; -export { - LITELLM_DEFAULT_MODEL_REF, - OPENROUTER_DEFAULT_MODEL_REF, - setOpenaiApiKey, - setAnthropicApiKey, - setCloudflareAiGatewayConfig, - setByteplusApiKey, - setQianfanApiKey, - setGeminiApiKey, - setKilocodeApiKey, - setLitellmApiKey, - setKimiCodingApiKey, - setMinimaxApiKey, - setMistralApiKey, - setMoonshotApiKey, - setOpencodeGoApiKey, - setOpencodeZenApiKey, - setOpenrouterApiKey, - setSyntheticApiKey, - setTogetherApiKey, - setHuggingfaceApiKey, - setVeniceApiKey, - setVercelAiGatewayApiKey, - setXiaomiApiKey, - setVolcengineApiKey, - setZaiApiKey, - setXaiApiKey, - setModelStudioApiKey, - writeOAuthCredentials, - XIAOMI_DEFAULT_MODEL_REF, -} from "./onboard-auth.credentials.js"; -export { CLOUDFLARE_AI_GATEWAY_DEFAULT_MODEL_REF } from "../../extensions/cloudflare-ai-gateway/onboard.js"; -export { HUGGINGFACE_DEFAULT_MODEL_REF } from "../../extensions/huggingface/onboard.js"; -export { KILOCODE_DEFAULT_MODEL_REF } from "../../extensions/kilocode/onboard.js"; -export { MISTRAL_DEFAULT_MODEL_REF } from "../../extensions/mistral/onboard.js"; -export { MODELSTUDIO_DEFAULT_MODEL_REF } from "../../extensions/modelstudio/onboard.js"; -export { SYNTHETIC_DEFAULT_MODEL_REF } from "../../extensions/synthetic/onboard.js"; -export { TOGETHER_DEFAULT_MODEL_REF } from "../../extensions/together/onboard.js"; -export { VENICE_DEFAULT_MODEL_REF } from "../../extensions/venice/onboard.js"; -export { VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "../../extensions/vercel-ai-gateway/onboard.js"; -export { XAI_DEFAULT_MODEL_REF } from "../../extensions/xai/onboard.js"; -export { ZAI_DEFAULT_MODEL_REF } from "../../extensions/zai/onboard.js"; -export { - buildMinimaxApiModelDefinition, - buildMinimaxModelDefinition, - DEFAULT_MINIMAX_BASE_URL, - MINIMAX_API_BASE_URL, - MINIMAX_CN_API_BASE_URL, - MINIMAX_HOSTED_MODEL_ID, - MINIMAX_HOSTED_MODEL_REF, -} from "../../extensions/minimax/model-definitions.js"; -export { KIMI_DEFAULT_MODEL_ID as KIMI_CODING_MODEL_ID } from "../../extensions/kimi-coding/provider-catalog.js"; -export { KIMI_CODING_MODEL_REF } from "../../extensions/kimi-coding/onboard.js"; -export { - buildMistralModelDefinition, - MISTRAL_BASE_URL, - MISTRAL_DEFAULT_MODEL_ID, -} from "../../extensions/mistral/model-definitions.js"; -export { - MOONSHOT_BASE_URL, - MOONSHOT_DEFAULT_MODEL_ID, -} from "../../extensions/moonshot/provider-catalog.js"; -export { - MOONSHOT_CN_BASE_URL, - MOONSHOT_DEFAULT_MODEL_REF, -} from "../../extensions/moonshot/onboard.js"; -export { - QIANFAN_BASE_URL, - QIANFAN_DEFAULT_MODEL_ID, -} from "../../extensions/qianfan/provider-catalog.js"; -export { QIANFAN_DEFAULT_MODEL_REF } from "../../extensions/qianfan/onboard.js"; -export { - buildXaiModelDefinition, - XAI_BASE_URL, - XAI_DEFAULT_MODEL_ID, -} from "../../extensions/xai/model-definitions.js"; -export { - buildZaiModelDefinition, - resolveZaiBaseUrl, - ZAI_CN_BASE_URL, - ZAI_CODING_CN_BASE_URL, - ZAI_CODING_GLOBAL_BASE_URL, - ZAI_DEFAULT_MODEL_ID, - ZAI_GLOBAL_BASE_URL, -} from "../../extensions/zai/model-definitions.js"; -export { - buildKilocodeModelDefinition, - buildMoonshotModelDefinition, - KILOCODE_DEFAULT_MODEL_ID, -} from "./onboard-auth.models.js"; diff --git a/src/commands/onboard-non-interactive.provider-auth.test.ts b/src/commands/onboard-non-interactive.provider-auth.test.ts index 66050fe6f62..085d9d1f102 100644 --- a/src/commands/onboard-non-interactive.provider-auth.test.ts +++ b/src/commands/onboard-non-interactive.provider-auth.test.ts @@ -2,15 +2,15 @@ import fs from "node:fs/promises"; import path from "node:path"; import { setTimeout as delay } from "node:timers/promises"; import { beforeAll, describe, expect, it, vi } from "vitest"; -import { makeTempWorkspace } from "../test-helpers/workspace.js"; -import { withEnvAsync } from "../test-utils/env.js"; import { MINIMAX_API_BASE_URL, MINIMAX_CN_API_BASE_URL, ZAI_CODING_CN_BASE_URL, ZAI_CODING_GLOBAL_BASE_URL, ZAI_GLOBAL_BASE_URL, -} from "./onboard-auth.js"; +} from "../plugins/provider-model-definitions.js"; +import { makeTempWorkspace } from "../test-helpers/workspace.js"; +import { withEnvAsync } from "../test-utils/env.js"; import { createThrowingRuntime, readJsonFile, diff --git a/src/commands/onboard-non-interactive/local/auth-choice.api-key-providers.ts b/src/commands/onboard-non-interactive/local/auth-choice.api-key-providers.ts index 4c0454401ad..bb9ab999411 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.api-key-providers.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.api-key-providers.ts @@ -1,11 +1,9 @@ import type { OpenClawConfig } from "../../../config/config.js"; import type { SecretInput } from "../../../config/types.secrets.js"; +import { applyAuthProfileConfig } from "../../../plugins/provider-auth-helpers.js"; +import { setLitellmApiKey } from "../../../plugins/provider-auth-storage.js"; import type { RuntimeEnv } from "../../../runtime.js"; -import { - applyAuthProfileConfig, - applyLitellmConfig, - setLitellmApiKey, -} from "../../onboard-auth.js"; +import { applyLitellmConfig } from "../../onboard-auth.config-litellm.js"; import type { AuthChoice, OnboardOptions } from "../../onboard-types.js"; type ApiKeyStorageOptions = { diff --git a/src/plugin-sdk/provider-models.ts b/src/plugin-sdk/provider-models.ts index 5221daec1cd..f0a85fe1ed1 100644 --- a/src/plugin-sdk/provider-models.ts +++ b/src/plugin-sdk/provider-models.ts @@ -20,7 +20,7 @@ export { OPENCODE_GO_DEFAULT_MODEL_REF } from "../commands/opencode-go-model-def export { OPENCODE_ZEN_DEFAULT_MODEL } from "../commands/opencode-zen-model-default.js"; export { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "../agents/opencode-zen-models.js"; -export * from "../commands/onboard-auth.models.js"; +export * from "../plugins/provider-model-definitions.js"; export { buildCloudflareAiGatewayModelDefinition, From 0cfc80b81c121fb8ee10bcd7d72a86017e475176 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:33:50 -0700 Subject: [PATCH 011/187] refactor: finish public plugin sdk boundary seams --- .../anthropic/media-understanding-provider.ts | 6 ++++-- extensions/bluebubbles/src/setup-core.ts | 12 +++++------ .../google/media-understanding-provider.ts | 19 +++++++---------- extensions/googlechat/src/setup-core.ts | 3 +-- extensions/kilocode/index.ts | 2 +- extensions/matrix/src/setup-core.ts | 10 +++++---- .../minimax/media-understanding-provider.ts | 6 ++++-- extensions/minimax/model-definitions.ts | 2 +- .../mistral/media-understanding-provider.ts | 6 ++++-- extensions/mistral/model-definitions.ts | 2 +- extensions/modelstudio/model-definitions.ts | 2 +- .../moonshot/media-understanding-provider.ts | 12 +++++------ extensions/nvidia/index.ts | 2 +- .../openai/media-understanding-provider.ts | 13 ++++++------ extensions/qianfan/index.ts | 2 +- extensions/slack/src/shared.ts | 20 ++++++++++-------- extensions/synthetic/index.ts | 2 +- extensions/tlon/src/setup-core.ts | 11 +++++----- extensions/together/index.ts | 2 +- extensions/venice/index.ts | 2 +- extensions/vercel-ai-gateway/index.ts | 2 +- extensions/whatsapp/src/channel.runtime.ts | 2 +- extensions/xai/model-definitions.ts | 2 +- extensions/xiaomi/index.ts | 2 +- .../zai/media-understanding-provider.ts | 6 ++++-- extensions/zai/model-definitions.ts | 2 +- extensions/zalo/src/setup-core.ts | 3 +-- extensions/zalouser/src/setup-core.ts | 2 +- package.json | 12 +++++++++++ scripts/lib/plugin-sdk-entrypoints.json | 3 +++ src/agents/tools/slack-actions.ts | 2 +- src/channels/plugins/actions/signal.ts | 2 +- src/commands/doctor-config-flow.ts | 2 +- src/plugin-sdk/account-resolution.ts | 16 ++++++++++++++ src/plugin-sdk/discord.ts | 1 - src/plugin-sdk/google.ts | 4 ++++ src/plugin-sdk/media-understanding.ts | 21 +++++++++++++++++++ src/plugin-sdk/provider-catalog.ts | 9 ++++++++ src/plugin-sdk/setup.ts | 2 ++ src/plugin-sdk/signal.ts | 1 - src/plugin-sdk/slack.ts | 1 - src/plugin-sdk/telegram.ts | 1 - 42 files changed, 152 insertions(+), 82 deletions(-) create mode 100644 src/plugin-sdk/google.ts create mode 100644 src/plugin-sdk/media-understanding.ts create mode 100644 src/plugin-sdk/provider-catalog.ts diff --git a/extensions/anthropic/media-understanding-provider.ts b/extensions/anthropic/media-understanding-provider.ts index fbd12374e50..5b1f0711705 100644 --- a/extensions/anthropic/media-understanding-provider.ts +++ b/extensions/anthropic/media-understanding-provider.ts @@ -1,5 +1,7 @@ -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; -import type { MediaUnderstandingProvider } from "../../src/media-understanding/types.js"; +import { + describeImageWithModel, + type MediaUnderstandingProvider, +} from "openclaw/plugin-sdk/media-understanding"; export const anthropicMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "anthropic", diff --git a/extensions/bluebubbles/src/setup-core.ts b/extensions/bluebubbles/src/setup-core.ts index 408cd255cf3..a8d3261b7ff 100644 --- a/extensions/bluebubbles/src/setup-core.ts +++ b/extensions/bluebubbles/src/setup-core.ts @@ -1,12 +1,12 @@ import { + normalizeAccountId, patchScopedAccountConfig, prepareScopedSetupConfig, -} from "../../../src/channels/plugins/setup-helpers.js"; -import { setTopLevelChannelDmPolicyWithAllowFrom } from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; + setTopLevelChannelDmPolicyWithAllowFrom, + type ChannelSetupAdapter, + type DmPolicy, + type OpenClawConfig, +} from "openclaw/plugin-sdk/setup"; import { applyBlueBubblesConnectionConfig } from "./config-apply.js"; const channel = "bluebubbles" as const; diff --git a/extensions/google/media-understanding-provider.ts b/extensions/google/media-understanding-provider.ts index 559bd4c63b8..a64f26ca6c8 100644 --- a/extensions/google/media-understanding-provider.ts +++ b/extensions/google/media-understanding-provider.ts @@ -1,18 +1,15 @@ -import { normalizeGoogleModelId } from "../../src/agents/model-id-normalization.js"; -import { parseGeminiAuth } from "../../src/infra/gemini-auth.js"; -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; +import { normalizeGoogleModelId, parseGeminiAuth } from "openclaw/plugin-sdk/google"; import { assertOkOrThrowHttpError, + describeImageWithModel, normalizeBaseUrl, postJsonRequest, -} from "../../src/media-understanding/providers/shared.js"; -import type { - AudioTranscriptionRequest, - AudioTranscriptionResult, - MediaUnderstandingProvider, - VideoDescriptionRequest, - VideoDescriptionResult, -} from "../../src/media-understanding/types.js"; + type AudioTranscriptionRequest, + type AudioTranscriptionResult, + type MediaUnderstandingProvider, + type VideoDescriptionRequest, + type VideoDescriptionResult, +} from "openclaw/plugin-sdk/media-understanding"; export const DEFAULT_GOOGLE_AUDIO_BASE_URL = "https://generativelanguage.googleapis.com/v1beta"; export const DEFAULT_GOOGLE_VIDEO_BASE_URL = "https://generativelanguage.googleapis.com/v1beta"; diff --git a/extensions/googlechat/src/setup-core.ts b/extensions/googlechat/src/setup-core.ts index 09980bad5cd..5643ec4c291 100644 --- a/extensions/googlechat/src/setup-core.ts +++ b/extensions/googlechat/src/setup-core.ts @@ -1,5 +1,4 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/setup"; const channel = "googlechat" as const; diff --git a/extensions/kilocode/index.ts b/extensions/kilocode/index.ts index c423606e552..d875bfdb3c2 100644 --- a/extensions/kilocode/index.ts +++ b/extensions/kilocode/index.ts @@ -1,10 +1,10 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { createKilocodeWrapper, isProxyReasoningUnsupported, } from "openclaw/plugin-sdk/provider-stream"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { applyKilocodeConfig, KILOCODE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildKilocodeProviderWithDiscovery } from "./provider-catalog.js"; diff --git a/extensions/matrix/src/setup-core.ts b/extensions/matrix/src/setup-core.ts index 2e6bc895e0c..5e5973bd05e 100644 --- a/extensions/matrix/src/setup-core.ts +++ b/extensions/matrix/src/setup-core.ts @@ -1,7 +1,9 @@ -import { prepareScopedSetupConfig } from "../../../src/channels/plugins/setup-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import { normalizeSecretInputString } from "../../../src/config/types.secrets.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import { + normalizeAccountId, + normalizeSecretInputString, + prepareScopedSetupConfig, + type ChannelSetupAdapter, +} from "openclaw/plugin-sdk/setup"; import type { CoreConfig } from "./types.js"; const channel = "matrix" as const; diff --git a/extensions/minimax/media-understanding-provider.ts b/extensions/minimax/media-understanding-provider.ts index 2798bbf9593..2bda4f4d193 100644 --- a/extensions/minimax/media-understanding-provider.ts +++ b/extensions/minimax/media-understanding-provider.ts @@ -1,5 +1,7 @@ -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; -import type { MediaUnderstandingProvider } from "../../src/media-understanding/types.js"; +import { + describeImageWithModel, + type MediaUnderstandingProvider, +} from "openclaw/plugin-sdk/media-understanding"; export const minimaxMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "minimax", diff --git a/extensions/minimax/model-definitions.ts b/extensions/minimax/model-definitions.ts index a913a933cf7..48396f21240 100644 --- a/extensions/minimax/model-definitions.ts +++ b/extensions/minimax/model-definitions.ts @@ -1,4 +1,4 @@ -import type { ModelDefinitionConfig } from "../../src/config/types.models.js"; +import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-models"; export const DEFAULT_MINIMAX_BASE_URL = "https://api.minimax.io/v1"; export const MINIMAX_API_BASE_URL = "https://api.minimax.io/anthropic"; diff --git a/extensions/mistral/media-understanding-provider.ts b/extensions/mistral/media-understanding-provider.ts index 6ffe1f0f898..f6ee0f167de 100644 --- a/extensions/mistral/media-understanding-provider.ts +++ b/extensions/mistral/media-understanding-provider.ts @@ -1,5 +1,7 @@ -import { transcribeOpenAiCompatibleAudio } from "../../src/media-understanding/providers/openai-compatible-audio.js"; -import type { MediaUnderstandingProvider } from "../../src/media-understanding/types.js"; +import { + transcribeOpenAiCompatibleAudio, + type MediaUnderstandingProvider, +} from "openclaw/plugin-sdk/media-understanding"; const DEFAULT_MISTRAL_AUDIO_BASE_URL = "https://api.mistral.ai/v1"; const DEFAULT_MISTRAL_AUDIO_MODEL = "voxtral-mini-latest"; diff --git a/extensions/mistral/model-definitions.ts b/extensions/mistral/model-definitions.ts index 90d3c84c73d..2e915da172a 100644 --- a/extensions/mistral/model-definitions.ts +++ b/extensions/mistral/model-definitions.ts @@ -1,4 +1,4 @@ -import type { ModelDefinitionConfig } from "../../src/config/types.models.js"; +import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-models"; export const MISTRAL_BASE_URL = "https://api.mistral.ai/v1"; export const MISTRAL_DEFAULT_MODEL_ID = "mistral-large-latest"; diff --git a/extensions/modelstudio/model-definitions.ts b/extensions/modelstudio/model-definitions.ts index 765e3962329..16fcdc6ec8c 100644 --- a/extensions/modelstudio/model-definitions.ts +++ b/extensions/modelstudio/model-definitions.ts @@ -1,4 +1,4 @@ -import type { ModelDefinitionConfig } from "../../src/config/types.models.js"; +import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-models"; export const MODELSTUDIO_CN_BASE_URL = "https://coding.dashscope.aliyuncs.com/v1"; export const MODELSTUDIO_GLOBAL_BASE_URL = "https://coding-intl.dashscope.aliyuncs.com/v1"; diff --git a/extensions/moonshot/media-understanding-provider.ts b/extensions/moonshot/media-understanding-provider.ts index 52bc9701c26..5814ee96e22 100644 --- a/extensions/moonshot/media-understanding-provider.ts +++ b/extensions/moonshot/media-understanding-provider.ts @@ -1,14 +1,12 @@ -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; import { assertOkOrThrowHttpError, + describeImageWithModel, normalizeBaseUrl, postJsonRequest, -} from "../../src/media-understanding/providers/shared.js"; -import type { - MediaUnderstandingProvider, - VideoDescriptionRequest, - VideoDescriptionResult, -} from "../../src/media-understanding/types.js"; + type MediaUnderstandingProvider, + type VideoDescriptionRequest, + type VideoDescriptionResult, +} from "openclaw/plugin-sdk/media-understanding"; export const DEFAULT_MOONSHOT_VIDEO_BASE_URL = "https://api.moonshot.ai/v1"; const DEFAULT_MOONSHOT_VIDEO_MODEL = "kimi-k2.5"; diff --git a/extensions/nvidia/index.ts b/extensions/nvidia/index.ts index 82b59e40a93..583932bc600 100644 --- a/extensions/nvidia/index.ts +++ b/extensions/nvidia/index.ts @@ -1,5 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { buildNvidiaProvider } from "./provider-catalog.js"; const PROVIDER_ID = "nvidia"; diff --git a/extensions/openai/media-understanding-provider.ts b/extensions/openai/media-understanding-provider.ts index c97f317bf4d..dcb0a731a91 100644 --- a/extensions/openai/media-understanding-provider.ts +++ b/extensions/openai/media-understanding-provider.ts @@ -1,13 +1,14 @@ -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; -import { transcribeOpenAiCompatibleAudio } from "../../src/media-understanding/providers/openai-compatible-audio.js"; -import type { MediaUnderstandingProvider } from "../../src/media-understanding/types.js"; +import { + describeImageWithModel, + transcribeOpenAiCompatibleAudio, + type AudioTranscriptionRequest, + type MediaUnderstandingProvider, +} from "openclaw/plugin-sdk/media-understanding"; export const DEFAULT_OPENAI_AUDIO_BASE_URL = "https://api.openai.com/v1"; const DEFAULT_OPENAI_AUDIO_MODEL = "gpt-4o-mini-transcribe"; -export async function transcribeOpenAiAudio( - params: import("../../src/media-understanding/types.js").AudioTranscriptionRequest, -) { +export async function transcribeOpenAiAudio(params: AudioTranscriptionRequest) { return await transcribeOpenAiCompatibleAudio({ ...params, defaultBaseUrl: DEFAULT_OPENAI_AUDIO_BASE_URL, diff --git a/extensions/qianfan/index.ts b/extensions/qianfan/index.ts index 42b5b8a0cb7..04094e1c2ca 100644 --- a/extensions/qianfan/index.ts +++ b/extensions/qianfan/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyQianfanConfig, QIANFAN_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildQianfanProvider } from "./provider-catalog.js"; diff --git a/extensions/slack/src/shared.ts b/extensions/slack/src/shared.ts index e7276da9ae1..d818eaab196 100644 --- a/extensions/slack/src/shared.ts +++ b/extensions/slack/src/shared.ts @@ -1,18 +1,20 @@ +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; +import { + createScopedAccountConfigAccessors, + createScopedChannelConfigBase, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + formatDocsLink, + hasConfiguredSecretInput, + patchChannelConfigForAccount, + type OpenClawConfig, +} from "openclaw/plugin-sdk/setup"; import { buildChannelConfigSchema, getChatChannelMeta, SlackConfigSchema, type ChannelPlugin, } from "openclaw/plugin-sdk/slack"; -import { patchChannelConfigForAccount } from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; -import { formatAllowFromLowercase } from "../../../src/plugin-sdk/allow-from.js"; -import { - createScopedAccountConfigAccessors, - createScopedChannelConfigBase, -} from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/synthetic/index.ts b/extensions/synthetic/index.ts index f538dd1fbcb..9bdeea0b8a5 100644 --- a/extensions/synthetic/index.ts +++ b/extensions/synthetic/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applySyntheticConfig, SYNTHETIC_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildSyntheticProvider } from "./provider-catalog.js"; diff --git a/extensions/tlon/src/setup-core.ts b/extensions/tlon/src/setup-core.ts index 08d72f2ab28..846af4f08a3 100644 --- a/extensions/tlon/src/setup-core.ts +++ b/extensions/tlon/src/setup-core.ts @@ -1,11 +1,12 @@ import { + DEFAULT_ACCOUNT_ID, + normalizeAccountId, patchScopedAccountConfig, prepareScopedSetupConfig, -} from "../../../src/channels/plugins/setup-helpers.js"; -import type { ChannelSetupAdapter } from "../../../src/channels/plugins/types.adapters.js"; -import type { ChannelSetupInput } from "../../../src/channels/plugins/types.core.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../../src/routing/session-key.js"; + type ChannelSetupAdapter, + type ChannelSetupInput, + type OpenClawConfig, +} from "openclaw/plugin-sdk/setup"; import { buildTlonAccountFields } from "./account-fields.js"; import { resolveTlonAccount } from "./types.js"; diff --git a/extensions/together/index.ts b/extensions/together/index.ts index 2ae0072ca88..01bf59338f1 100644 --- a/extensions/together/index.ts +++ b/extensions/together/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyTogetherConfig, TOGETHER_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildTogetherProvider } from "./provider-catalog.js"; diff --git a/extensions/venice/index.ts b/extensions/venice/index.ts index b67831fe7a9..37d4e767db3 100644 --- a/extensions/venice/index.ts +++ b/extensions/venice/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyVeniceConfig, VENICE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildVeniceProvider } from "./provider-catalog.js"; diff --git a/extensions/vercel-ai-gateway/index.ts b/extensions/vercel-ai-gateway/index.ts index 433f6cee09a..fc4dbae156a 100644 --- a/extensions/vercel-ai-gateway/index.ts +++ b/extensions/vercel-ai-gateway/index.ts @@ -1,6 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyVercelAiGatewayConfig, VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildVercelAiGatewayProvider } from "./provider-catalog.js"; diff --git a/extensions/whatsapp/src/channel.runtime.ts b/extensions/whatsapp/src/channel.runtime.ts index 46dd5f987d2..1273da7bbd0 100644 --- a/extensions/whatsapp/src/channel.runtime.ts +++ b/extensions/whatsapp/src/channel.runtime.ts @@ -9,4 +9,4 @@ export { export { loginWeb } from "./login.js"; export { startWebLoginWithQr, waitForWebLogin } from "./login-qr.js"; export { whatsappSetupWizard } from "./setup-surface.js"; -export { monitorWebChannel } from "../../../src/channels/web/index.js"; +export { monitorWebChannel } from "openclaw/plugin-sdk/whatsapp"; diff --git a/extensions/xai/model-definitions.ts b/extensions/xai/model-definitions.ts index 5d3383eff8e..ff3a892500e 100644 --- a/extensions/xai/model-definitions.ts +++ b/extensions/xai/model-definitions.ts @@ -1,4 +1,4 @@ -import type { ModelDefinitionConfig } from "../../src/config/types.models.js"; +import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-models"; export const XAI_BASE_URL = "https://api.x.ai/v1"; export const XAI_DEFAULT_MODEL_ID = "grok-4"; diff --git a/extensions/xiaomi/index.ts b/extensions/xiaomi/index.ts index 2edc1b33b25..dd18127edfa 100644 --- a/extensions/xiaomi/index.ts +++ b/extensions/xiaomi/index.ts @@ -1,7 +1,7 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { PROVIDER_LABELS } from "openclaw/plugin-sdk/provider-usage"; -import { buildSingleProviderApiKeyCatalog } from "../../src/plugins/provider-catalog.js"; import { applyXiaomiConfig, XIAOMI_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildXiaomiProvider } from "./provider-catalog.js"; diff --git a/extensions/zai/media-understanding-provider.ts b/extensions/zai/media-understanding-provider.ts index bbd8bcc59fc..08f8c186d4d 100644 --- a/extensions/zai/media-understanding-provider.ts +++ b/extensions/zai/media-understanding-provider.ts @@ -1,5 +1,7 @@ -import { describeImageWithModel } from "../../src/media-understanding/providers/image.js"; -import type { MediaUnderstandingProvider } from "../../src/media-understanding/types.js"; +import { + describeImageWithModel, + type MediaUnderstandingProvider, +} from "openclaw/plugin-sdk/media-understanding"; export const zaiMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "zai", diff --git a/extensions/zai/model-definitions.ts b/extensions/zai/model-definitions.ts index 2527ee53031..778d7602f73 100644 --- a/extensions/zai/model-definitions.ts +++ b/extensions/zai/model-definitions.ts @@ -1,4 +1,4 @@ -import type { ModelDefinitionConfig } from "../../src/config/types.models.js"; +import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-models"; export const ZAI_CODING_GLOBAL_BASE_URL = "https://api.z.ai/api/coding/paas/v4"; export const ZAI_CODING_CN_BASE_URL = "https://open.bigmodel.cn/api/coding/paas/v4"; diff --git a/extensions/zalo/src/setup-core.ts b/extensions/zalo/src/setup-core.ts index 3e54c5a86dc..218ff32cf19 100644 --- a/extensions/zalo/src/setup-core.ts +++ b/extensions/zalo/src/setup-core.ts @@ -1,5 +1,4 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/setup"; const channel = "zalo" as const; diff --git a/extensions/zalouser/src/setup-core.ts b/extensions/zalouser/src/setup-core.ts index f3215a16469..e1f9e9fd27c 100644 --- a/extensions/zalouser/src/setup-core.ts +++ b/extensions/zalouser/src/setup-core.ts @@ -1,4 +1,4 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; +import { createPatchedAccountSetupAdapter } from "openclaw/plugin-sdk/setup"; const channel = "zalouser" as const; diff --git a/package.json b/package.json index 456603ea22c..afbcb632ed0 100644 --- a/package.json +++ b/package.json @@ -338,6 +338,10 @@ "types": "./dist/plugin-sdk/provider-auth.d.ts", "default": "./dist/plugin-sdk/provider-auth.js" }, + "./plugin-sdk/provider-catalog": { + "types": "./dist/plugin-sdk/provider-catalog.d.ts", + "default": "./dist/plugin-sdk/provider-catalog.js" + }, "./plugin-sdk/provider-models": { "types": "./dist/plugin-sdk/provider-models.d.ts", "default": "./dist/plugin-sdk/provider-models.js" @@ -358,6 +362,14 @@ "types": "./dist/plugin-sdk/provider-web-search.d.ts", "default": "./dist/plugin-sdk/provider-web-search.js" }, + "./plugin-sdk/media-understanding": { + "types": "./dist/plugin-sdk/media-understanding.d.ts", + "default": "./dist/plugin-sdk/media-understanding.js" + }, + "./plugin-sdk/google": { + "types": "./dist/plugin-sdk/google.d.ts", + "default": "./dist/plugin-sdk/google.js" + }, "./plugin-sdk/request-url": { "types": "./dist/plugin-sdk/request-url.d.ts", "default": "./dist/plugin-sdk/request-url.js" diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index e2de1d74f1f..50813e8dd66 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -74,11 +74,14 @@ "json-store", "keyed-async-queue", "provider-auth", + "provider-catalog", "provider-models", "provider-onboard", "provider-stream", "provider-usage", "provider-web-search", + "media-understanding", + "google", "request-url", "runtime-store", "speech", diff --git a/src/agents/tools/slack-actions.ts b/src/agents/tools/slack-actions.ts index e9089cbfdcc..11283394ec8 100644 --- a/src/agents/tools/slack-actions.ts +++ b/src/agents/tools/slack-actions.ts @@ -1,5 +1,6 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { OpenClawConfig } from "../../config/config.js"; +import { resolveSlackAccount } from "../../plugin-sdk/account-resolution.js"; import { deleteSlackMessage, downloadSlackFile, @@ -20,7 +21,6 @@ import { parseSlackBlocksInput, parseSlackTarget, recordSlackThreadParticipation, - resolveSlackAccount, resolveSlackChannelId, } from "../../plugin-sdk/slack.js"; import { withNormalizedTimestamp } from "../date-time.js"; diff --git a/src/channels/plugins/actions/signal.ts b/src/channels/plugins/actions/signal.ts index 60a70bac4c0..2eacd78857c 100644 --- a/src/channels/plugins/actions/signal.ts +++ b/src/channels/plugins/actions/signal.ts @@ -1,8 +1,8 @@ import { createActionGate, jsonResult, readStringParam } from "../../../agents/tools/common.js"; +import { resolveSignalAccount } from "../../../plugin-sdk/account-resolution.js"; import { listEnabledSignalAccounts, removeReactionSignal, - resolveSignalAccount, resolveSignalReactionLevel, sendReactionSignal, } from "../../../plugin-sdk/signal.js"; diff --git a/src/commands/doctor-config-flow.ts b/src/commands/doctor-config-flow.ts index a1cbf5fa6d9..912869f390b 100644 --- a/src/commands/doctor-config-flow.ts +++ b/src/commands/doctor-config-flow.ts @@ -22,13 +22,13 @@ import { normalizeTrustedSafeBinDirs, } from "../infra/exec-safe-bin-trust.js"; import { readChannelAllowFromStore } from "../pairing/pairing-store.js"; +import { resolveTelegramAccount } from "../plugin-sdk/account-resolution.js"; import { fetchTelegramChatId, inspectTelegramAccount, isNumericTelegramUserId, listTelegramAccountIds, normalizeTelegramAllowFromEntry, - resolveTelegramAccount, } from "../plugin-sdk/telegram.js"; import { formatChannelAccountsDefaultPath, diff --git a/src/plugin-sdk/account-resolution.ts b/src/plugin-sdk/account-resolution.ts index cb819f57354..533d88187d0 100644 --- a/src/plugin-sdk/account-resolution.ts +++ b/src/plugin-sdk/account-resolution.ts @@ -10,6 +10,22 @@ export { normalizeOptionalAccountId, } from "../routing/session-key.js"; export { normalizeE164, pathExists, resolveUserPath } from "../utils.js"; +export { + resolveDiscordAccount, + type ResolvedDiscordAccount, +} from "../../extensions/discord/src/accounts.js"; +export { + resolveSlackAccount, + type ResolvedSlackAccount, +} from "../../extensions/slack/src/accounts.js"; +export { + resolveTelegramAccount, + type ResolvedTelegramAccount, +} from "../../extensions/telegram/src/accounts.js"; +export { + resolveSignalAccount, + type ResolvedSignalAccount, +} from "../../extensions/signal/src/accounts.js"; /** Resolve an account by id, then fall back to the default account when the primary lacks credentials. */ export function resolveAccountWithDefaultFallback(params: { diff --git a/src/plugin-sdk/discord.ts b/src/plugin-sdk/discord.ts index b31c796e2d6..273df91e908 100644 --- a/src/plugin-sdk/discord.ts +++ b/src/plugin-sdk/discord.ts @@ -61,7 +61,6 @@ export { createDiscordActionGate, listDiscordAccountIds, resolveDefaultDiscordAccountId, - resolveDiscordAccount, } from "../../extensions/discord/src/accounts.js"; export { inspectDiscordAccount } from "../../extensions/discord/src/account-inspect.js"; export { diff --git a/src/plugin-sdk/google.ts b/src/plugin-sdk/google.ts new file mode 100644 index 00000000000..b39d4aa4ced --- /dev/null +++ b/src/plugin-sdk/google.ts @@ -0,0 +1,4 @@ +// Public Google-specific helpers used by bundled Google plugins. + +export { normalizeGoogleModelId } from "../agents/model-id-normalization.js"; +export { parseGeminiAuth } from "../infra/gemini-auth.js"; diff --git a/src/plugin-sdk/media-understanding.ts b/src/plugin-sdk/media-understanding.ts new file mode 100644 index 00000000000..052736afc3d --- /dev/null +++ b/src/plugin-sdk/media-understanding.ts @@ -0,0 +1,21 @@ +// Public media-understanding helpers and types for provider plugins. + +export type { + AudioTranscriptionRequest, + AudioTranscriptionResult, + ImageDescriptionRequest, + ImageDescriptionResult, + MediaUnderstandingProvider, + VideoDescriptionRequest, + VideoDescriptionResult, +} from "../media-understanding/types.js"; + +export { describeImageWithModel } from "../media-understanding/providers/image.js"; +export { transcribeOpenAiCompatibleAudio } from "../media-understanding/providers/openai-compatible-audio.js"; +export { + assertOkOrThrowHttpError, + normalizeBaseUrl, + postJsonRequest, + postTranscriptionRequest, + requireTranscriptionText, +} from "../media-understanding/providers/shared.js"; diff --git a/src/plugin-sdk/provider-catalog.ts b/src/plugin-sdk/provider-catalog.ts new file mode 100644 index 00000000000..7295658a3cb --- /dev/null +++ b/src/plugin-sdk/provider-catalog.ts @@ -0,0 +1,9 @@ +// Public provider catalog helpers for provider plugins. + +export type { ProviderCatalogContext, ProviderCatalogResult } from "../plugins/types.js"; + +export { + buildPairedProviderApiKeyCatalog, + buildSingleProviderApiKeyCatalog, + findCatalogTemplate, +} from "../plugins/provider-catalog.js"; diff --git a/src/plugin-sdk/setup.ts b/src/plugin-sdk/setup.ts index a2a7cf5c302..b890045a5f8 100644 --- a/src/plugin-sdk/setup.ts +++ b/src/plugin-sdk/setup.ts @@ -21,8 +21,10 @@ export { normalizeE164, pathExists } from "../utils.js"; export { applyAccountNameToChannelSection, applySetupAccountConfigPatch, + createPatchedAccountSetupAdapter, migrateBaseNameToDefaultAccount, patchScopedAccountConfig, + prepareScopedSetupConfig, } from "../channels/plugins/setup-helpers.js"; export { addWildcardAllowFrom, diff --git a/src/plugin-sdk/signal.ts b/src/plugin-sdk/signal.ts index f7d3ec2d84d..da3d839e356 100644 --- a/src/plugin-sdk/signal.ts +++ b/src/plugin-sdk/signal.ts @@ -47,7 +47,6 @@ export { listEnabledSignalAccounts, listSignalAccountIds, resolveDefaultSignalAccountId, - resolveSignalAccount, } from "../../extensions/signal/src/accounts.js"; export { resolveSignalReactionLevel } from "../../extensions/signal/src/reaction-level.js"; export { diff --git a/src/plugin-sdk/slack.ts b/src/plugin-sdk/slack.ts index b883aebac95..8e6793543af 100644 --- a/src/plugin-sdk/slack.ts +++ b/src/plugin-sdk/slack.ts @@ -50,7 +50,6 @@ export { listEnabledSlackAccounts, listSlackAccountIds, resolveDefaultSlackAccountId, - resolveSlackAccount, resolveSlackReplyToMode, } from "../../extensions/slack/src/accounts.js"; export { isSlackInteractiveRepliesEnabled } from "../../extensions/slack/src/interactive-replies.js"; diff --git a/src/plugin-sdk/telegram.ts b/src/plugin-sdk/telegram.ts index cb26a82cb13..db53fa92a35 100644 --- a/src/plugin-sdk/telegram.ts +++ b/src/plugin-sdk/telegram.ts @@ -65,7 +65,6 @@ export { listTelegramAccountIds, resolveDefaultTelegramAccountId, resolveTelegramPollActionGateState, - resolveTelegramAccount, } from "../../extensions/telegram/src/accounts.js"; export { inspectTelegramAccount } from "../../extensions/telegram/src/account-inspect.js"; export { From 87b9a063ce86d914f387830aa99ba356137f236d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:33:54 -0700 Subject: [PATCH 012/187] refactor: add shared provider model definitions --- src/plugins/provider-model-definitions.ts | 140 ++++++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 src/plugins/provider-model-definitions.ts diff --git a/src/plugins/provider-model-definitions.ts b/src/plugins/provider-model-definitions.ts new file mode 100644 index 00000000000..5788d0ad2ca --- /dev/null +++ b/src/plugins/provider-model-definitions.ts @@ -0,0 +1,140 @@ +import { KIMI_CODING_MODEL_REF } from "../../extensions/kimi-coding/onboard.js"; +import { + KIMI_DEFAULT_MODEL_ID as KIMI_CODING_MODEL_ID, + KIMI_CODING_BASE_URL, +} from "../../extensions/kimi-coding/provider-catalog.js"; +import { + DEFAULT_MINIMAX_BASE_URL, + MINIMAX_API_BASE_URL, + MINIMAX_API_COST, + MINIMAX_CN_API_BASE_URL, + MINIMAX_HOSTED_COST, + MINIMAX_HOSTED_MODEL_ID, + MINIMAX_HOSTED_MODEL_REF, + MINIMAX_LM_STUDIO_COST, + buildMinimaxApiModelDefinition, + buildMinimaxModelDefinition, +} from "../../extensions/minimax/model-definitions.js"; +import { + buildMistralModelDefinition, + MISTRAL_BASE_URL, + MISTRAL_DEFAULT_COST, + MISTRAL_DEFAULT_MODEL_ID, + MISTRAL_DEFAULT_MODEL_REF, +} from "../../extensions/mistral/model-definitions.js"; +import { + MODELSTUDIO_CN_BASE_URL, + MODELSTUDIO_DEFAULT_COST, + MODELSTUDIO_DEFAULT_MODEL_ID, + MODELSTUDIO_DEFAULT_MODEL_REF, + MODELSTUDIO_GLOBAL_BASE_URL, + buildModelStudioDefaultModelDefinition, + buildModelStudioModelDefinition, +} from "../../extensions/modelstudio/model-definitions.js"; +import { + MOONSHOT_CN_BASE_URL, + MOONSHOT_DEFAULT_MODEL_REF, +} from "../../extensions/moonshot/onboard.js"; +import { + buildMoonshotProvider, + MOONSHOT_BASE_URL, + MOONSHOT_DEFAULT_MODEL_ID, +} from "../../extensions/moonshot/provider-catalog.js"; +import { QIANFAN_DEFAULT_MODEL_REF } from "../../extensions/qianfan/onboard.js"; +import { + QIANFAN_BASE_URL, + QIANFAN_DEFAULT_MODEL_ID, +} from "../../extensions/qianfan/provider-catalog.js"; +import { + XAI_BASE_URL, + XAI_DEFAULT_COST, + XAI_DEFAULT_MODEL_ID, + XAI_DEFAULT_MODEL_REF, + buildXaiModelDefinition, +} from "../../extensions/xai/model-definitions.js"; +import { + buildZaiModelDefinition, + resolveZaiBaseUrl, + ZAI_CN_BASE_URL, + ZAI_CODING_CN_BASE_URL, + ZAI_CODING_GLOBAL_BASE_URL, + ZAI_DEFAULT_COST, + ZAI_DEFAULT_MODEL_ID, + ZAI_GLOBAL_BASE_URL, +} from "../../extensions/zai/model-definitions.js"; +import type { ModelDefinitionConfig } from "../config/types.models.js"; +import { + KILOCODE_DEFAULT_CONTEXT_WINDOW, + KILOCODE_DEFAULT_COST, + KILOCODE_DEFAULT_MAX_TOKENS, + KILOCODE_DEFAULT_MODEL_ID, + KILOCODE_DEFAULT_MODEL_NAME, +} from "../providers/kilocode-shared.js"; + +export { + DEFAULT_MINIMAX_BASE_URL, + MINIMAX_API_BASE_URL, + MINIMAX_API_COST, + MINIMAX_CN_API_BASE_URL, + MINIMAX_HOSTED_COST, + MINIMAX_HOSTED_MODEL_ID, + MINIMAX_HOSTED_MODEL_REF, + MINIMAX_LM_STUDIO_COST, + MISTRAL_BASE_URL, + MISTRAL_DEFAULT_COST, + MISTRAL_DEFAULT_MODEL_ID, + MISTRAL_DEFAULT_MODEL_REF, + MODELSTUDIO_CN_BASE_URL, + MODELSTUDIO_DEFAULT_COST, + MODELSTUDIO_DEFAULT_MODEL_ID, + MODELSTUDIO_DEFAULT_MODEL_REF, + MODELSTUDIO_GLOBAL_BASE_URL, + MOONSHOT_BASE_URL, + MOONSHOT_CN_BASE_URL, + MOONSHOT_DEFAULT_MODEL_ID, + MOONSHOT_DEFAULT_MODEL_REF, + QIANFAN_BASE_URL, + QIANFAN_DEFAULT_MODEL_ID, + QIANFAN_DEFAULT_MODEL_REF, + XAI_BASE_URL, + XAI_DEFAULT_COST, + XAI_DEFAULT_MODEL_ID, + XAI_DEFAULT_MODEL_REF, + ZAI_CN_BASE_URL, + ZAI_CODING_CN_BASE_URL, + ZAI_CODING_GLOBAL_BASE_URL, + ZAI_DEFAULT_COST, + ZAI_DEFAULT_MODEL_ID, + ZAI_GLOBAL_BASE_URL, + KIMI_CODING_BASE_URL, + KIMI_CODING_MODEL_ID, + KIMI_CODING_MODEL_REF, + KILOCODE_DEFAULT_CONTEXT_WINDOW, + KILOCODE_DEFAULT_COST, + KILOCODE_DEFAULT_MAX_TOKENS, + KILOCODE_DEFAULT_MODEL_ID, + buildMinimaxApiModelDefinition, + buildMinimaxModelDefinition, + buildMistralModelDefinition, + buildModelStudioDefaultModelDefinition, + buildModelStudioModelDefinition, + buildXaiModelDefinition, + buildZaiModelDefinition, + resolveZaiBaseUrl, +}; + +export function buildMoonshotModelDefinition(): ModelDefinitionConfig { + return buildMoonshotProvider().models[0]; +} + +export function buildKilocodeModelDefinition(): ModelDefinitionConfig { + return { + id: KILOCODE_DEFAULT_MODEL_ID, + name: KILOCODE_DEFAULT_MODEL_NAME, + reasoning: true, + input: ["text", "image"], + cost: KILOCODE_DEFAULT_COST, + contextWindow: KILOCODE_DEFAULT_CONTEXT_WINDOW, + maxTokens: KILOCODE_DEFAULT_MAX_TOKENS, + }; +} From 5572e6965a7626cef22de211b7ab6e75bc93490b Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:36:39 -0700 Subject: [PATCH 013/187] Agents: add provider attribution registry (#48735) * Agents: add provider attribution registry * Agents: record provider attribution matrix * Agents: align OpenRouter attribution headers --- .../pi-embedded-runner-extraparams.test.ts | 3 +- src/agents/pi-embedded-runner/extra-params.ts | 2 +- .../proxy-stream-wrappers.test.ts | 38 +++++ .../proxy-stream-wrappers.ts | 9 +- src/agents/provider-attribution.test.ts | 87 +++++++++++ src/agents/provider-attribution.ts | 138 ++++++++++++++++++ 6 files changed, 269 insertions(+), 8 deletions(-) create mode 100644 src/agents/pi-embedded-runner/proxy-stream-wrappers.test.ts create mode 100644 src/agents/provider-attribution.test.ts create mode 100644 src/agents/provider-attribution.ts diff --git a/src/agents/pi-embedded-runner-extraparams.test.ts b/src/agents/pi-embedded-runner-extraparams.test.ts index 25395ea4827..9b22c59b594 100644 --- a/src/agents/pi-embedded-runner-extraparams.test.ts +++ b/src/agents/pi-embedded-runner-extraparams.test.ts @@ -1160,7 +1160,8 @@ describe("applyExtraParamsToAgent", () => { expect(calls).toHaveLength(1); expect(calls[0]?.headers).toEqual({ "HTTP-Referer": "https://openclaw.ai", - "X-Title": "OpenClaw", + "X-OpenRouter-Title": "OpenClaw", + "X-OpenRouter-Categories": "cli-agent", "X-Custom": "1", }); }); diff --git a/src/agents/pi-embedded-runner/extra-params.ts b/src/agents/pi-embedded-runner/extra-params.ts index 713b193d7e7..7a73280802c 100644 --- a/src/agents/pi-embedded-runner/extra-params.ts +++ b/src/agents/pi-embedded-runner/extra-params.ts @@ -264,7 +264,7 @@ function createParallelToolCallsWrapper( /** * Apply extra params (like temperature) to an agent's streamFn. - * Also adds OpenRouter app attribution headers when using the OpenRouter provider. + * Also applies verified provider-specific request wrappers, such as OpenRouter attribution. * * @internal Exported for testing */ diff --git a/src/agents/pi-embedded-runner/proxy-stream-wrappers.test.ts b/src/agents/pi-embedded-runner/proxy-stream-wrappers.test.ts new file mode 100644 index 00000000000..487d90582ef --- /dev/null +++ b/src/agents/pi-embedded-runner/proxy-stream-wrappers.test.ts @@ -0,0 +1,38 @@ +import type { StreamFn } from "@mariozechner/pi-agent-core"; +import type { Context, Model } from "@mariozechner/pi-ai"; +import { createAssistantMessageEventStream } from "@mariozechner/pi-ai"; +import { describe, expect, it } from "vitest"; +import { createOpenRouterWrapper } from "./proxy-stream-wrappers.js"; + +describe("proxy stream wrappers", () => { + it("adds OpenRouter attribution headers to stream options", () => { + const calls: Array<{ headers?: Record }> = []; + const baseStreamFn: StreamFn = (_model, _context, options) => { + calls.push({ + headers: options?.headers, + }); + return createAssistantMessageEventStream(); + }; + + const wrapped = createOpenRouterWrapper(baseStreamFn); + const model = { + api: "openai-completions", + provider: "openrouter", + id: "openrouter/auto", + } as Model<"openai-completions">; + const context: Context = { messages: [] }; + + void wrapped(model, context, { headers: { "X-Custom": "1" } }); + + expect(calls).toEqual([ + { + headers: { + "HTTP-Referer": "https://openclaw.ai", + "X-OpenRouter-Title": "OpenClaw", + "X-OpenRouter-Categories": "cli-agent", + "X-Custom": "1", + }, + }, + ]); + }); +}); diff --git a/src/agents/pi-embedded-runner/proxy-stream-wrappers.ts b/src/agents/pi-embedded-runner/proxy-stream-wrappers.ts index 4f77c31cfdd..cc5e7596050 100644 --- a/src/agents/pi-embedded-runner/proxy-stream-wrappers.ts +++ b/src/agents/pi-embedded-runner/proxy-stream-wrappers.ts @@ -1,11 +1,7 @@ import type { StreamFn } from "@mariozechner/pi-agent-core"; import { streamSimple } from "@mariozechner/pi-ai"; import type { ThinkLevel } from "../../auto-reply/thinking.js"; - -const OPENROUTER_APP_HEADERS: Record = { - "HTTP-Referer": "https://openclaw.ai", - "X-Title": "OpenClaw", -}; +import { resolveProviderAttributionHeaders } from "../provider-attribution.js"; const KILOCODE_FEATURE_HEADER = "X-KILOCODE-FEATURE"; const KILOCODE_FEATURE_DEFAULT = "openclaw"; const KILOCODE_FEATURE_ENV_VAR = "KILOCODE_FEATURE"; @@ -105,10 +101,11 @@ export function createOpenRouterWrapper( const underlying = baseStreamFn ?? streamSimple; return (model, context, options) => { const onPayload = options?.onPayload; + const attributionHeaders = resolveProviderAttributionHeaders("openrouter"); return underlying(model, context, { ...options, headers: { - ...OPENROUTER_APP_HEADERS, + ...attributionHeaders, ...options?.headers, }, onPayload: (payload) => { diff --git a/src/agents/provider-attribution.test.ts b/src/agents/provider-attribution.test.ts new file mode 100644 index 00000000000..693e165ba21 --- /dev/null +++ b/src/agents/provider-attribution.test.ts @@ -0,0 +1,87 @@ +import { describe, expect, it } from "vitest"; +import { + listProviderAttributionPolicies, + resolveProviderAttributionHeaders, + resolveProviderAttributionIdentity, + resolveProviderAttributionPolicy, +} from "./provider-attribution.js"; + +describe("provider attribution", () => { + it("resolves the canonical OpenClaw product and runtime version", () => { + const identity = resolveProviderAttributionIdentity({ + OPENCLAW_VERSION: "2026.3.99", + }); + + expect(identity).toEqual({ + product: "OpenClaw", + version: "2026.3.99", + }); + }); + + it("returns a documented OpenRouter attribution policy", () => { + const policy = resolveProviderAttributionPolicy("openrouter", { + OPENCLAW_VERSION: "2026.3.14", + }); + + expect(policy).toEqual({ + provider: "openrouter", + enabledByDefault: true, + verification: "vendor-documented", + hook: "request-headers", + docsUrl: "https://openrouter.ai/docs/app-attribution", + reviewNote: "Documented app attribution headers. Verified in OpenClaw runtime wrapper.", + product: "OpenClaw", + version: "2026.3.14", + headers: { + "HTTP-Referer": "https://openclaw.ai", + "X-OpenRouter-Title": "OpenClaw", + "X-OpenRouter-Categories": "cli-agent", + }, + }); + }); + + it("normalizes aliases when resolving provider headers", () => { + expect( + resolveProviderAttributionHeaders("OpenRouter", { + OPENCLAW_VERSION: "2026.3.14", + }), + ).toEqual({ + "HTTP-Referer": "https://openclaw.ai", + "X-OpenRouter-Title": "OpenClaw", + "X-OpenRouter-Categories": "cli-agent", + }); + }); + + it("tracks SDK-hook-only providers without enabling them", () => { + expect(resolveProviderAttributionPolicy("openai", { OPENCLAW_VERSION: "2026.3.14" })).toEqual({ + provider: "openai", + enabledByDefault: false, + verification: "vendor-sdk-hook-only", + hook: "default-headers", + reviewNote: + "OpenAI JS SDK exposes defaultHeaders, but public app attribution support is not yet verified.", + product: "OpenClaw", + version: "2026.3.14", + }); + expect(resolveProviderAttributionHeaders("openai")).toBeUndefined(); + }); + + it("lists the current attribution support matrix", () => { + expect( + listProviderAttributionPolicies({ OPENCLAW_VERSION: "2026.3.14" }).map((policy) => [ + policy.provider, + policy.enabledByDefault, + policy.verification, + policy.hook, + ]), + ).toEqual([ + ["openrouter", true, "vendor-documented", "request-headers"], + ["anthropic", false, "vendor-sdk-hook-only", "default-headers"], + ["google", false, "vendor-sdk-hook-only", "user-agent-extra"], + ["groq", false, "vendor-sdk-hook-only", "default-headers"], + ["mistral", false, "vendor-sdk-hook-only", "custom-user-agent"], + ["openai", false, "vendor-sdk-hook-only", "default-headers"], + ["together", false, "vendor-sdk-hook-only", "default-headers"], + ]); + }); +}); diff --git a/src/agents/provider-attribution.ts b/src/agents/provider-attribution.ts new file mode 100644 index 00000000000..52fe5c8d4c7 --- /dev/null +++ b/src/agents/provider-attribution.ts @@ -0,0 +1,138 @@ +import type { RuntimeVersionEnv } from "../version.js"; +import { resolveRuntimeServiceVersion } from "../version.js"; +import { normalizeProviderId } from "./model-selection.js"; + +export type ProviderAttributionVerification = + | "vendor-documented" + | "vendor-sdk-hook-only" + | "internal-runtime"; + +export type ProviderAttributionHook = + | "request-headers" + | "default-headers" + | "user-agent-extra" + | "custom-user-agent"; + +export type ProviderAttributionPolicy = { + provider: string; + enabledByDefault: boolean; + verification: ProviderAttributionVerification; + hook?: ProviderAttributionHook; + docsUrl?: string; + reviewNote?: string; + product: string; + version: string; + headers?: Record; +}; + +export type ProviderAttributionIdentity = Pick; + +const OPENCLAW_ATTRIBUTION_PRODUCT = "OpenClaw"; + +export function resolveProviderAttributionIdentity( + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionIdentity { + return { + product: OPENCLAW_ATTRIBUTION_PRODUCT, + version: resolveRuntimeServiceVersion(env), + }; +} + +function buildOpenRouterAttributionPolicy( + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy { + const identity = resolveProviderAttributionIdentity(env); + return { + provider: "openrouter", + enabledByDefault: true, + verification: "vendor-documented", + hook: "request-headers", + docsUrl: "https://openrouter.ai/docs/app-attribution", + reviewNote: "Documented app attribution headers. Verified in OpenClaw runtime wrapper.", + ...identity, + headers: { + "HTTP-Referer": "https://openclaw.ai", + "X-OpenRouter-Title": identity.product, + "X-OpenRouter-Categories": "cli-agent", + }, + }; +} + +function buildSdkHookOnlyPolicy( + provider: string, + hook: ProviderAttributionHook, + reviewNote: string, + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy { + return { + provider, + enabledByDefault: false, + verification: "vendor-sdk-hook-only", + hook, + reviewNote, + ...resolveProviderAttributionIdentity(env), + }; +} + +export function listProviderAttributionPolicies( + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy[] { + return [ + buildOpenRouterAttributionPolicy(env), + buildSdkHookOnlyPolicy( + "anthropic", + "default-headers", + "Anthropic JS SDK exposes defaultHeaders, but app attribution is not yet verified.", + env, + ), + buildSdkHookOnlyPolicy( + "google", + "user-agent-extra", + "Google GenAI JS SDK exposes userAgentExtra/httpOptions, but provider-side attribution is not yet verified.", + env, + ), + buildSdkHookOnlyPolicy( + "groq", + "default-headers", + "Groq JS SDK exposes defaultHeaders, but app attribution is not yet verified.", + env, + ), + buildSdkHookOnlyPolicy( + "mistral", + "custom-user-agent", + "Mistral JS SDK exposes a custom userAgent option, but app attribution is not yet verified.", + env, + ), + buildSdkHookOnlyPolicy( + "openai", + "default-headers", + "OpenAI JS SDK exposes defaultHeaders, but public app attribution support is not yet verified.", + env, + ), + buildSdkHookOnlyPolicy( + "together", + "default-headers", + "Together JS SDK exposes defaultHeaders, but app attribution is not yet verified.", + env, + ), + ]; +} + +export function resolveProviderAttributionPolicy( + provider?: string | null, + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy | undefined { + const normalized = normalizeProviderId(provider ?? ""); + return listProviderAttributionPolicies(env).find((policy) => policy.provider === normalized); +} + +export function resolveProviderAttributionHeaders( + provider?: string | null, + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): Record | undefined { + const policy = resolveProviderAttributionPolicy(provider, env); + if (!policy?.enabledByDefault) { + return undefined; + } + return policy.headers; +} From 38bc364aedb7d875564a786905b7bc0f5db9fdaa Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:36:22 -0700 Subject: [PATCH 014/187] Runtime: narrow WhatsApp login tool surface --- .../runtime/runtime-whatsapp-login-tool.ts | 71 +++++++++++++++++++ src/plugins/runtime/runtime-whatsapp.ts | 4 +- src/plugins/runtime/types-channel.ts | 2 +- 3 files changed, 74 insertions(+), 3 deletions(-) create mode 100644 src/plugins/runtime/runtime-whatsapp-login-tool.ts diff --git a/src/plugins/runtime/runtime-whatsapp-login-tool.ts b/src/plugins/runtime/runtime-whatsapp-login-tool.ts new file mode 100644 index 00000000000..88b5d0e6138 --- /dev/null +++ b/src/plugins/runtime/runtime-whatsapp-login-tool.ts @@ -0,0 +1,71 @@ +import { Type } from "@sinclair/typebox"; +import type { ChannelAgentTool } from "openclaw/plugin-sdk/channel-runtime"; + +export function createRuntimeWhatsAppLoginTool(): ChannelAgentTool { + return { + label: "WhatsApp Login", + name: "whatsapp_login", + ownerOnly: true, + description: "Generate a WhatsApp QR code for linking, or wait for the scan to complete.", + parameters: Type.Object({ + action: Type.Unsafe<"start" | "wait">({ + type: "string", + enum: ["start", "wait"], + }), + timeoutMs: Type.Optional(Type.Number()), + force: Type.Optional(Type.Boolean()), + }), + execute: async (_toolCallId, args) => { + const { startWebLoginWithQr, waitForWebLogin } = + await import("../../../extensions/whatsapp/src/login-qr.js"); + const action = (args as { action?: string })?.action ?? "start"; + if (action === "wait") { + const result = await waitForWebLogin({ + timeoutMs: + typeof (args as { timeoutMs?: unknown }).timeoutMs === "number" + ? (args as { timeoutMs?: number }).timeoutMs + : undefined, + }); + return { + content: [{ type: "text", text: result.message }], + details: { connected: result.connected }, + }; + } + + const result = await startWebLoginWithQr({ + timeoutMs: + typeof (args as { timeoutMs?: unknown }).timeoutMs === "number" + ? (args as { timeoutMs?: number }).timeoutMs + : undefined, + force: + typeof (args as { force?: unknown }).force === "boolean" + ? (args as { force?: boolean }).force + : false, + }); + + if (!result.qrDataUrl) { + return { + content: [ + { + type: "text", + text: result.message, + }, + ], + details: { qr: false }, + }; + } + + const text = [ + result.message, + "", + "Open WhatsApp -> Linked Devices and scan:", + "", + `![whatsapp-qr](${result.qrDataUrl})`, + ].join("\n"); + return { + content: [{ type: "text", text }], + details: { qr: true }, + }; + }, + }; +} diff --git a/src/plugins/runtime/runtime-whatsapp.ts b/src/plugins/runtime/runtime-whatsapp.ts index 20d36a936f0..21a92aefe09 100644 --- a/src/plugins/runtime/runtime-whatsapp.ts +++ b/src/plugins/runtime/runtime-whatsapp.ts @@ -6,7 +6,7 @@ import { readWebSelfId, webAuthExists, } from "../../../extensions/whatsapp/src/auth-store.js"; -import { createWhatsAppLoginTool } from "../../channels/plugins/agent-tools/whatsapp-login.js"; +import { createRuntimeWhatsAppLoginTool } from "./runtime-whatsapp-login-tool.js"; import type { PluginRuntime } from "./types.js"; const sendMessageWhatsAppLazy: PluginRuntime["channel"]["whatsapp"]["sendMessageWhatsApp"] = async ( @@ -106,6 +106,6 @@ export function createRuntimeWhatsApp(): PluginRuntime["channel"]["whatsapp"] { waitForWebLogin: waitForWebLoginLazy, monitorWebChannel: monitorWebChannelLazy, handleWhatsAppAction: handleWhatsAppActionLazy, - createLoginTool: createWhatsAppLoginTool, + createLoginTool: createRuntimeWhatsAppLoginTool, }; } diff --git a/src/plugins/runtime/types-channel.ts b/src/plugins/runtime/types-channel.ts index f8e6e095ef5..1b0c21044a8 100644 --- a/src/plugins/runtime/types-channel.ts +++ b/src/plugins/runtime/types-channel.ts @@ -211,7 +211,7 @@ export type PluginRuntimeChannel = { waitForWebLogin: typeof import("../../../extensions/whatsapp/src/login-qr.js").waitForWebLogin; monitorWebChannel: typeof import("../../channels/web/index.js").monitorWebChannel; handleWhatsAppAction: typeof import("../../agents/tools/whatsapp-actions.js").handleWhatsAppAction; - createLoginTool: typeof import("../../channels/plugins/agent-tools/whatsapp-login.js").createWhatsAppLoginTool; + createLoginTool: typeof import("./runtime-whatsapp-login-tool.js").createRuntimeWhatsAppLoginTool; }; line: { listLineAccountIds: typeof import("../../line/accounts.js").listLineAccountIds; From 06459ca0dfba4ca152d2565b6b29efe9f8360b90 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:46:05 -0700 Subject: [PATCH 015/187] Agents: run bundle MCP tools in embedded Pi (#48611) * Agents: run bundle MCP tools in embedded Pi * Plugins: fix bundle MCP path resolution * Plugins: warn on unsupported bundle MCP transports * Commands: add embedded Pi MCP management * Config: move MCP management to top-level config --- CHANGELOG.md | 1 + docs/plugins/bundles.md | 20 +- docs/tools/plugin.md | 11 +- src/agents/embedded-pi-mcp.ts | 29 ++ src/agents/mcp-stdio.ts | 79 +++++ src/agents/pi-bundle-mcp-tools.test.ts | 184 +++++++++++ src/agents/pi-bundle-mcp-tools.ts | 225 +++++++++++++ .../pi-embedded-runner.bundle-mcp.e2e.test.ts | 302 ++++++++++++++++++ src/agents/pi-embedded-runner/compact.ts | 24 +- src/agents/pi-embedded-runner/run/attempt.ts | 26 +- src/agents/pi-project-settings.bundle.test.ts | 100 ++++++ src/agents/pi-project-settings.test.ts | 30 ++ src/agents/pi-project-settings.ts | 14 + src/auto-reply/commands-args.ts | 11 + src/auto-reply/commands-registry.data.ts | 28 ++ src/auto-reply/commands-registry.ts | 3 + src/auto-reply/reply/commands-core.ts | 2 + src/auto-reply/reply/commands-mcp.test.ts | 93 ++++++ src/auto-reply/reply/commands-mcp.ts | 134 ++++++++ src/auto-reply/reply/mcp-commands.ts | 24 ++ src/cli/mcp-cli.test.ts | 83 +++++ src/cli/mcp-cli.ts | 103 ++++++ src/cli/program/command-registry.ts | 13 + src/config/mcp-config.test.ts | 56 ++++ src/config/mcp-config.ts | 150 +++++++++ src/config/schema.help.ts | 5 + src/config/schema.labels.ts | 3 + src/config/types.mcp.ts | 14 + src/config/types.messages.ts | 2 + src/config/types.openclaw.ts | 2 + src/config/types.ts | 1 + src/config/zod-schema.session.ts | 1 + src/config/zod-schema.ts | 19 ++ src/plugins/bundle-mcp.test.ts | 65 ++++ src/plugins/bundle-mcp.ts | 82 ++++- src/plugins/loader.test.ts | 110 +++++++ src/plugins/loader.ts | 32 ++ 37 files changed, 2051 insertions(+), 30 deletions(-) create mode 100644 src/agents/embedded-pi-mcp.ts create mode 100644 src/agents/mcp-stdio.ts create mode 100644 src/agents/pi-bundle-mcp-tools.test.ts create mode 100644 src/agents/pi-bundle-mcp-tools.ts create mode 100644 src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts create mode 100644 src/auto-reply/reply/commands-mcp.test.ts create mode 100644 src/auto-reply/reply/commands-mcp.ts create mode 100644 src/auto-reply/reply/mcp-commands.ts create mode 100644 src/cli/mcp-cli.test.ts create mode 100644 src/cli/mcp-cli.ts create mode 100644 src/config/mcp-config.test.ts create mode 100644 src/config/mcp-config.ts create mode 100644 src/config/types.mcp.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 24335d41a91..4ff37ae11c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,7 @@ Docs: https://docs.openclaw.ai - secrets: harden read-only SecretRef command paths and diagnostics. (#47794) Thanks @joshavant. - Browser/existing-session: support `browser.profiles..userDataDir` so Chrome DevTools MCP can attach to Brave, Edge, and other Chromium-based browsers through their own user data directories. (#48170) Thanks @velvet-shark. - Skills/prompt budget: preserve all registered skills via a compact catalog fallback before dropping entries when the full prompt format exceeds `maxSkillsPromptChars`. (#47553) Thanks @snese. +- Plugins/bundles: make enabled bundle MCP servers expose runnable tools in embedded Pi, and default relative bundle MCP launches to the bundle root so marketplace bundles like Context7 work through Pi instead of stopping at config import. ### Breaking diff --git a/docs/plugins/bundles.md b/docs/plugins/bundles.md index 2fad626ccfe..bc6bc49e5a0 100644 --- a/docs/plugins/bundles.md +++ b/docs/plugins/bundles.md @@ -104,11 +104,15 @@ loader. Cursor command markdown works through the same path. - `HOOK.md` - `handler.ts` or `handler.js` -#### MCP for CLI backends +#### MCP for Pi - enabled bundles can contribute MCP server config -- current runtime wiring is used by the `claude-cli` backend -- OpenClaw merges bundle MCP config into the backend `--mcp-config` file +- OpenClaw merges bundle MCP config into the effective embedded Pi settings as + `mcpServers` +- OpenClaw also exposes supported bundle MCP tools during embedded Pi agent + turns by launching supported stdio MCP servers as subprocesses +- project-local Pi settings still apply after bundle defaults, so workspace + settings can override bundle MCP entries when needed #### Embedded Pi settings @@ -133,7 +137,6 @@ diagnostics/info output, but OpenClaw does not run them yet: - Cursor `.cursor/agents` - Cursor `.cursor/hooks.json` - Cursor `.cursor/rules` -- Cursor `mcpServers` outside the current mapped runtime paths - Codex inline/app metadata beyond capability reporting ## Capability reporting @@ -153,7 +156,8 @@ Current exceptions: - Claude `commands` is considered supported because it maps to skills - Claude `settings` is considered supported because it maps to embedded Pi settings - Cursor `commands` is considered supported because it maps to skills -- bundle MCP is considered supported where OpenClaw actually imports it +- bundle MCP is considered supported because it maps into embedded Pi settings + and exposes supported stdio tools to embedded Pi - Codex `hooks` is considered supported only for OpenClaw hook-pack layouts ## Format differences @@ -195,6 +199,8 @@ Claude-specific notes: - `commands/` is treated like skill content - `settings.json` is imported into embedded Pi settings +- `.mcp.json` and manifest `mcpServers` can expose supported stdio tools to + embedded Pi - `hooks/hooks.json` is detected, but not executed as Claude automation ### Cursor @@ -246,7 +252,9 @@ Current behavior: - bundle discovery reads files inside the plugin root with boundary checks - skills and hook-pack paths must stay inside the plugin root - bundle settings files are read with the same boundary checks -- OpenClaw does not execute arbitrary bundle runtime code in-process +- supported stdio bundle MCP servers may be launched as subprocesses for + embedded Pi tool calls +- OpenClaw does not load arbitrary bundle runtime modules in-process This makes bundle support safer by default than native plugin modules, but you should still treat third-party bundles as trusted content for the features they diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 8ab2ba87e1f..48acd41e202 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -214,18 +214,23 @@ plugins: OpenClaw skill loader - supported now: Claude bundle `settings.json` defaults for embedded Pi agent settings (with shell override keys sanitized) +- supported now: bundle MCP config, merged into embedded Pi agent settings as + `mcpServers`, with supported stdio bundle MCP tools exposed during embedded + Pi agent turns - supported now: Cursor `.cursor/commands/*.md` roots, mapped into the normal OpenClaw skill loader - supported now: Codex bundle hook directories that use the OpenClaw hook-pack layout (`HOOK.md` + `handler.ts`/`handler.js`) - detected but not wired yet: other declared bundle capabilities such as - agents, Claude hook automation, Cursor rules/hooks/MCP metadata, MCP/app/LSP + agents, Claude hook automation, Cursor rules/hooks metadata, app/LSP metadata, output styles That means bundle install/discovery/list/info/enablement all work, and bundle skills, Claude command-skills, Claude bundle settings defaults, and compatible -Codex hook directories load when the bundle is enabled, but bundle runtime code -is not executed in-process. +Codex hook directories load when the bundle is enabled. Supported bundle MCP +servers may also run as subprocesses for embedded Pi tool calls when they use +supported stdio transport, but bundle runtime modules are not loaded +in-process. Bundle hook support is limited to the normal OpenClaw hook directory format (`HOOK.md` plus `handler.ts`/`handler.js` under the declared hook roots). diff --git a/src/agents/embedded-pi-mcp.ts b/src/agents/embedded-pi-mcp.ts new file mode 100644 index 00000000000..82d4d0e486c --- /dev/null +++ b/src/agents/embedded-pi-mcp.ts @@ -0,0 +1,29 @@ +import type { OpenClawConfig } from "../config/config.js"; +import { normalizeConfiguredMcpServers } from "../config/mcp-config.js"; +import type { BundleMcpDiagnostic, BundleMcpServerConfig } from "../plugins/bundle-mcp.js"; +import { loadEnabledBundleMcpConfig } from "../plugins/bundle-mcp.js"; + +export type EmbeddedPiMcpConfig = { + mcpServers: Record; + diagnostics: BundleMcpDiagnostic[]; +}; + +export function loadEmbeddedPiMcpConfig(params: { + workspaceDir: string; + cfg?: OpenClawConfig; +}): EmbeddedPiMcpConfig { + const bundleMcp = loadEnabledBundleMcpConfig({ + workspaceDir: params.workspaceDir, + cfg: params.cfg, + }); + const configuredMcp = normalizeConfiguredMcpServers(params.cfg?.mcp?.servers); + + return { + // OpenClaw config is the owner-managed layer, so it overrides bundle defaults. + mcpServers: { + ...bundleMcp.config.mcpServers, + ...configuredMcp, + }, + diagnostics: bundleMcp.diagnostics, + }; +} diff --git a/src/agents/mcp-stdio.ts b/src/agents/mcp-stdio.ts new file mode 100644 index 00000000000..77ab6171ca7 --- /dev/null +++ b/src/agents/mcp-stdio.ts @@ -0,0 +1,79 @@ +type StdioMcpServerLaunchConfig = { + command: string; + args?: string[]; + env?: Record; + cwd?: string; +}; + +type StdioMcpServerLaunchResult = + | { ok: true; config: StdioMcpServerLaunchConfig } + | { ok: false; reason: string }; + +function isRecord(value: unknown): value is Record { + return value !== null && typeof value === "object" && !Array.isArray(value); +} + +function toStringRecord(value: unknown): Record | undefined { + if (!isRecord(value)) { + return undefined; + } + const entries = Object.entries(value) + .map(([key, entry]) => { + if (typeof entry === "string") { + return [key, entry] as const; + } + if (typeof entry === "number" || typeof entry === "boolean") { + return [key, String(entry)] as const; + } + return null; + }) + .filter((entry): entry is readonly [string, string] => entry !== null); + return entries.length > 0 ? Object.fromEntries(entries) : undefined; +} + +function toStringArray(value: unknown): string[] | undefined { + if (!Array.isArray(value)) { + return undefined; + } + const entries = value.filter((entry): entry is string => typeof entry === "string"); + return entries.length > 0 ? entries : []; +} + +export function resolveStdioMcpServerLaunchConfig(raw: unknown): StdioMcpServerLaunchResult { + if (!isRecord(raw)) { + return { ok: false, reason: "server config must be an object" }; + } + if (typeof raw.command !== "string" || raw.command.trim().length === 0) { + if (typeof raw.url === "string" && raw.url.trim().length > 0) { + return { + ok: false, + reason: "only stdio MCP servers are supported right now", + }; + } + return { ok: false, reason: "its command is missing" }; + } + const cwd = + typeof raw.cwd === "string" && raw.cwd.trim().length > 0 + ? raw.cwd + : typeof raw.workingDirectory === "string" && raw.workingDirectory.trim().length > 0 + ? raw.workingDirectory + : undefined; + return { + ok: true, + config: { + command: raw.command, + args: toStringArray(raw.args), + env: toStringRecord(raw.env), + cwd, + }, + }; +} + +export function describeStdioMcpServerLaunchConfig(config: StdioMcpServerLaunchConfig): string { + const args = + Array.isArray(config.args) && config.args.length > 0 ? ` ${config.args.join(" ")}` : ""; + const cwd = config.cwd ? ` (cwd=${config.cwd})` : ""; + return `${config.command}${args}${cwd}`; +} + +export type { StdioMcpServerLaunchConfig, StdioMcpServerLaunchResult }; diff --git a/src/agents/pi-bundle-mcp-tools.test.ts b/src/agents/pi-bundle-mcp-tools.test.ts new file mode 100644 index 00000000000..69b2839eb94 --- /dev/null +++ b/src/agents/pi-bundle-mcp-tools.test.ts @@ -0,0 +1,184 @@ +import fs from "node:fs/promises"; +import { createRequire } from "node:module"; +import os from "node:os"; +import path from "node:path"; +import { afterEach, describe, expect, it } from "vitest"; +import { createBundleMcpToolRuntime } from "./pi-bundle-mcp-tools.js"; + +const require = createRequire(import.meta.url); +const SDK_SERVER_MCP_PATH = require.resolve("@modelcontextprotocol/sdk/server/mcp.js"); +const SDK_SERVER_STDIO_PATH = require.resolve("@modelcontextprotocol/sdk/server/stdio.js"); + +const tempDirs: string[] = []; + +async function makeTempDir(prefix: string): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix)); + tempDirs.push(dir); + return dir; +} + +async function writeExecutable(filePath: string, content: string): Promise { + await fs.mkdir(path.dirname(filePath), { recursive: true }); + await fs.writeFile(filePath, content, { encoding: "utf-8", mode: 0o755 }); +} + +async function writeBundleProbeMcpServer(filePath: string): Promise { + await writeExecutable( + filePath, + `#!/usr/bin/env node +import { McpServer } from ${JSON.stringify(SDK_SERVER_MCP_PATH)}; +import { StdioServerTransport } from ${JSON.stringify(SDK_SERVER_STDIO_PATH)}; + +const server = new McpServer({ name: "bundle-probe", version: "1.0.0" }); +server.tool("bundle_probe", "Bundle MCP probe", async () => { + return { + content: [{ type: "text", text: process.env.BUNDLE_PROBE_TEXT ?? "missing-probe-text" }], + }; +}); + +await server.connect(new StdioServerTransport()); +`, + ); +} + +async function writeClaudeBundle(params: { + pluginRoot: string; + serverScriptPath: string; +}): Promise { + await fs.mkdir(path.join(params.pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(params.pluginRoot, ".claude-plugin", "plugin.json"), + `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, + "utf-8", + ); + await fs.writeFile( + path.join(params.pluginRoot, ".mcp.json"), + `${JSON.stringify( + { + mcpServers: { + bundleProbe: { + command: "node", + args: [path.relative(params.pluginRoot, params.serverScriptPath)], + env: { + BUNDLE_PROBE_TEXT: "FROM-BUNDLE", + }, + }, + }, + }, + null, + 2, + )}\n`, + "utf-8", + ); +} + +afterEach(async () => { + await Promise.all( + tempDirs.splice(0, tempDirs.length).map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); +}); + +describe("createBundleMcpToolRuntime", () => { + it("loads bundle MCP tools and executes them", async () => { + const workspaceDir = await makeTempDir("openclaw-bundle-mcp-tools-"); + const pluginRoot = path.join(workspaceDir, ".openclaw", "extensions", "bundle-probe"); + const serverScriptPath = path.join(pluginRoot, "servers", "bundle-probe.mjs"); + await writeBundleProbeMcpServer(serverScriptPath); + await writeClaudeBundle({ pluginRoot, serverScriptPath }); + + const runtime = await createBundleMcpToolRuntime({ + workspaceDir, + cfg: { + plugins: { + entries: { + "bundle-probe": { enabled: true }, + }, + }, + }, + }); + + try { + expect(runtime.tools.map((tool) => tool.name)).toEqual(["bundle_probe"]); + const result = await runtime.tools[0].execute("call-bundle-probe", {}, undefined, undefined); + expect(result.content[0]).toMatchObject({ + type: "text", + text: "FROM-BUNDLE", + }); + expect(result.details).toEqual({ + mcpServer: "bundleProbe", + mcpTool: "bundle_probe", + }); + } finally { + await runtime.dispose(); + } + }); + + it("skips bundle MCP tools that collide with existing tool names", async () => { + const workspaceDir = await makeTempDir("openclaw-bundle-mcp-tools-"); + const pluginRoot = path.join(workspaceDir, ".openclaw", "extensions", "bundle-probe"); + const serverScriptPath = path.join(pluginRoot, "servers", "bundle-probe.mjs"); + await writeBundleProbeMcpServer(serverScriptPath); + await writeClaudeBundle({ pluginRoot, serverScriptPath }); + + const runtime = await createBundleMcpToolRuntime({ + workspaceDir, + cfg: { + plugins: { + entries: { + "bundle-probe": { enabled: true }, + }, + }, + }, + reservedToolNames: ["bundle_probe"], + }); + + try { + expect(runtime.tools).toEqual([]); + } finally { + await runtime.dispose(); + } + }); + + it("loads configured stdio MCP tools without a bundle", async () => { + const workspaceDir = await makeTempDir("openclaw-bundle-mcp-tools-"); + const serverScriptPath = path.join(workspaceDir, "servers", "configured-probe.mjs"); + await writeBundleProbeMcpServer(serverScriptPath); + + const runtime = await createBundleMcpToolRuntime({ + workspaceDir, + cfg: { + mcp: { + servers: { + configuredProbe: { + command: "node", + args: [serverScriptPath], + env: { + BUNDLE_PROBE_TEXT: "FROM-CONFIG", + }, + }, + }, + }, + }, + }); + + try { + expect(runtime.tools.map((tool) => tool.name)).toEqual(["bundle_probe"]); + const result = await runtime.tools[0].execute( + "call-configured-probe", + {}, + undefined, + undefined, + ); + expect(result.content[0]).toMatchObject({ + type: "text", + text: "FROM-CONFIG", + }); + expect(result.details).toEqual({ + mcpServer: "configuredProbe", + mcpTool: "bundle_probe", + }); + } finally { + await runtime.dispose(); + } + }); +}); diff --git a/src/agents/pi-bundle-mcp-tools.ts b/src/agents/pi-bundle-mcp-tools.ts new file mode 100644 index 00000000000..159cd8bfe12 --- /dev/null +++ b/src/agents/pi-bundle-mcp-tools.ts @@ -0,0 +1,225 @@ +import type { AgentToolResult } from "@mariozechner/pi-agent-core"; +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js"; +import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { logDebug, logWarn } from "../logger.js"; +import { loadEmbeddedPiMcpConfig } from "./embedded-pi-mcp.js"; +import { + describeStdioMcpServerLaunchConfig, + resolveStdioMcpServerLaunchConfig, +} from "./mcp-stdio.js"; +import type { AnyAgentTool } from "./tools/common.js"; + +type BundleMcpToolRuntime = { + tools: AnyAgentTool[]; + dispose: () => Promise; +}; + +type BundleMcpSession = { + serverName: string; + client: Client; + transport: StdioClientTransport; + detachStderr?: () => void; +}; + +function isRecord(value: unknown): value is Record { + return value !== null && typeof value === "object" && !Array.isArray(value); +} + +async function listAllTools(client: Client) { + const tools: Awaited>["tools"] = []; + let cursor: string | undefined; + do { + const page = await client.listTools(cursor ? { cursor } : undefined); + tools.push(...page.tools); + cursor = page.nextCursor; + } while (cursor); + return tools; +} + +function toAgentToolResult(params: { + serverName: string; + toolName: string; + result: CallToolResult; +}): AgentToolResult { + const content = Array.isArray(params.result.content) + ? (params.result.content as AgentToolResult["content"]) + : []; + const normalizedContent: AgentToolResult["content"] = + content.length > 0 + ? content + : params.result.structuredContent !== undefined + ? [ + { + type: "text", + text: JSON.stringify(params.result.structuredContent, null, 2), + }, + ] + : ([ + { + type: "text", + text: JSON.stringify( + { + status: params.result.isError === true ? "error" : "ok", + server: params.serverName, + tool: params.toolName, + }, + null, + 2, + ), + }, + ] as AgentToolResult["content"]); + const details: Record = { + mcpServer: params.serverName, + mcpTool: params.toolName, + }; + if (params.result.structuredContent !== undefined) { + details.structuredContent = params.result.structuredContent; + } + if (params.result.isError === true) { + details.status = "error"; + } + return { + content: normalizedContent, + details, + }; +} + +function attachStderrLogging(serverName: string, transport: StdioClientTransport) { + const stderr = transport.stderr; + if (!stderr || typeof stderr.on !== "function") { + return undefined; + } + const onData = (chunk: Buffer | string) => { + const message = String(chunk).trim(); + if (!message) { + return; + } + for (const line of message.split(/\r?\n/)) { + const trimmed = line.trim(); + if (trimmed) { + logDebug(`bundle-mcp:${serverName}: ${trimmed}`); + } + } + }; + stderr.on("data", onData); + return () => { + if (typeof stderr.off === "function") { + stderr.off("data", onData); + } else if (typeof stderr.removeListener === "function") { + stderr.removeListener("data", onData); + } + }; +} + +async function disposeSession(session: BundleMcpSession) { + session.detachStderr?.(); + await session.client.close().catch(() => {}); + await session.transport.close().catch(() => {}); +} + +export async function createBundleMcpToolRuntime(params: { + workspaceDir: string; + cfg?: OpenClawConfig; + reservedToolNames?: Iterable; +}): Promise { + const loaded = loadEmbeddedPiMcpConfig({ + workspaceDir: params.workspaceDir, + cfg: params.cfg, + }); + for (const diagnostic of loaded.diagnostics) { + logWarn(`bundle-mcp: ${diagnostic.pluginId}: ${diagnostic.message}`); + } + + const reservedNames = new Set( + Array.from(params.reservedToolNames ?? [], (name) => name.trim().toLowerCase()).filter(Boolean), + ); + const sessions: BundleMcpSession[] = []; + const tools: AnyAgentTool[] = []; + + try { + for (const [serverName, rawServer] of Object.entries(loaded.mcpServers)) { + const launch = resolveStdioMcpServerLaunchConfig(rawServer); + if (!launch.ok) { + logWarn(`bundle-mcp: skipped server "${serverName}" because ${launch.reason}.`); + continue; + } + const launchConfig = launch.config; + + const transport = new StdioClientTransport({ + command: launchConfig.command, + args: launchConfig.args, + env: launchConfig.env, + cwd: launchConfig.cwd, + stderr: "pipe", + }); + const client = new Client( + { + name: "openclaw-bundle-mcp", + version: "0.0.0", + }, + {}, + ); + const session: BundleMcpSession = { + serverName, + client, + transport, + detachStderr: attachStderrLogging(serverName, transport), + }; + + try { + await client.connect(transport); + const listedTools = await listAllTools(client); + sessions.push(session); + for (const tool of listedTools) { + const normalizedName = tool.name.trim().toLowerCase(); + if (!normalizedName) { + continue; + } + if (reservedNames.has(normalizedName)) { + logWarn( + `bundle-mcp: skipped tool "${tool.name}" from server "${serverName}" because the name already exists.`, + ); + continue; + } + reservedNames.add(normalizedName); + tools.push({ + name: tool.name, + label: tool.title ?? tool.name, + description: + tool.description?.trim() || + `Provided by bundle MCP server "${serverName}" (${describeStdioMcpServerLaunchConfig(launchConfig)}).`, + parameters: tool.inputSchema, + execute: async (_toolCallId, input) => { + const result = (await client.callTool({ + name: tool.name, + arguments: isRecord(input) ? input : {}, + })) as CallToolResult; + return toAgentToolResult({ + serverName, + toolName: tool.name, + result, + }); + }, + }); + } + } catch (error) { + logWarn( + `bundle-mcp: failed to start server "${serverName}" (${describeStdioMcpServerLaunchConfig(launchConfig)}): ${String(error)}`, + ); + await disposeSession(session); + } + } + + return { + tools, + dispose: async () => { + await Promise.allSettled(sessions.map((session) => disposeSession(session))); + }, + }; + } catch (error) { + await Promise.allSettled(sessions.map((session) => disposeSession(session))); + throw error; + } +} diff --git a/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts new file mode 100644 index 00000000000..2eac44e922b --- /dev/null +++ b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts @@ -0,0 +1,302 @@ +import fs from "node:fs/promises"; +import { createRequire } from "node:module"; +import path from "node:path"; +import "./test-helpers/fast-coding-tools.js"; +import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; +import { + cleanupEmbeddedPiRunnerTestWorkspace, + createEmbeddedPiRunnerOpenAiConfig, + createEmbeddedPiRunnerTestWorkspace, + type EmbeddedPiRunnerTestWorkspace, + immediateEnqueue, +} from "./test-helpers/pi-embedded-runner-e2e-fixtures.js"; + +const E2E_TIMEOUT_MS = 20_000; +const require = createRequire(import.meta.url); +const SDK_SERVER_MCP_PATH = require.resolve("@modelcontextprotocol/sdk/server/mcp.js"); +const SDK_SERVER_STDIO_PATH = require.resolve("@modelcontextprotocol/sdk/server/stdio.js"); + +function createMockUsage(input: number, output: number) { + return { + input, + output, + cacheRead: 0, + cacheWrite: 0, + totalTokens: input + output, + cost: { + input: 0, + output: 0, + cacheRead: 0, + cacheWrite: 0, + total: 0, + }, + }; +} + +let streamCallCount = 0; +let observedContexts: Array> = []; + +async function writeExecutable(filePath: string, content: string): Promise { + await fs.mkdir(path.dirname(filePath), { recursive: true }); + await fs.writeFile(filePath, content, { encoding: "utf-8", mode: 0o755 }); +} + +async function writeBundleProbeMcpServer(filePath: string): Promise { + await writeExecutable( + filePath, + `#!/usr/bin/env node +import { McpServer } from ${JSON.stringify(SDK_SERVER_MCP_PATH)}; +import { StdioServerTransport } from ${JSON.stringify(SDK_SERVER_STDIO_PATH)}; + +const server = new McpServer({ name: "bundle-probe", version: "1.0.0" }); +server.tool("bundle_probe", "Bundle MCP probe", async () => { + return { + content: [{ type: "text", text: process.env.BUNDLE_PROBE_TEXT ?? "missing-probe-text" }], + }; +}); + +await server.connect(new StdioServerTransport()); +`, + ); +} + +async function writeClaudeBundle(params: { + pluginRoot: string; + serverScriptPath: string; +}): Promise { + await fs.mkdir(path.join(params.pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(params.pluginRoot, ".claude-plugin", "plugin.json"), + `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, + "utf-8", + ); + await fs.writeFile( + path.join(params.pluginRoot, ".mcp.json"), + `${JSON.stringify( + { + mcpServers: { + bundleProbe: { + command: "node", + args: [path.relative(params.pluginRoot, params.serverScriptPath)], + env: { + BUNDLE_PROBE_TEXT: "FROM-BUNDLE", + }, + }, + }, + }, + null, + 2, + )}\n`, + "utf-8", + ); +} + +vi.mock("@mariozechner/pi-coding-agent", async () => { + return await vi.importActual( + "@mariozechner/pi-coding-agent", + ); +}); + +vi.mock("@mariozechner/pi-ai", async () => { + const actual = await vi.importActual("@mariozechner/pi-ai"); + + const buildToolUseMessage = (model: { api: string; provider: string; id: string }) => ({ + role: "assistant" as const, + content: [ + { + type: "toolCall" as const, + id: "tc-bundle-mcp-1", + name: "bundle_probe", + arguments: {}, + }, + ], + stopReason: "toolUse" as const, + api: model.api, + provider: model.provider, + model: model.id, + usage: createMockUsage(1, 1), + timestamp: Date.now(), + }); + + const buildStopMessage = ( + model: { api: string; provider: string; id: string }, + text: string, + ) => ({ + role: "assistant" as const, + content: [{ type: "text" as const, text }], + stopReason: "stop" as const, + api: model.api, + provider: model.provider, + model: model.id, + usage: createMockUsage(1, 1), + timestamp: Date.now(), + }); + + return { + ...actual, + complete: async (model: { api: string; provider: string; id: string }) => { + streamCallCount += 1; + return streamCallCount === 1 + ? buildToolUseMessage(model) + : buildStopMessage(model, "BUNDLE MCP OK FROM-BUNDLE"); + }, + completeSimple: async (model: { api: string; provider: string; id: string }) => { + streamCallCount += 1; + return streamCallCount === 1 + ? buildToolUseMessage(model) + : buildStopMessage(model, "BUNDLE MCP OK FROM-BUNDLE"); + }, + streamSimple: ( + model: { api: string; provider: string; id: string }, + context: { messages?: Array<{ role?: string; content?: unknown }> }, + ) => { + streamCallCount += 1; + const messages = (context.messages ?? []).map((message) => ({ ...message })); + observedContexts.push(messages); + const stream = actual.createAssistantMessageEventStream(); + queueMicrotask(() => { + if (streamCallCount === 1) { + stream.push({ + type: "done", + reason: "toolUse", + message: buildToolUseMessage(model), + }); + stream.end(); + return; + } + + const toolResultText = messages.flatMap((message) => + Array.isArray(message.content) + ? (message.content as Array<{ type?: string; text?: string }>) + .filter((entry) => entry.type === "text" && typeof entry.text === "string") + .map((entry) => entry.text ?? "") + : [], + ); + const sawBundleResult = toolResultText.some((text) => text.includes("FROM-BUNDLE")); + if (!sawBundleResult) { + stream.push({ + type: "done", + reason: "error", + message: { + role: "assistant" as const, + content: [], + stopReason: "error" as const, + errorMessage: "bundle MCP tool result missing from context", + api: model.api, + provider: model.provider, + model: model.id, + usage: createMockUsage(1, 0), + timestamp: Date.now(), + }, + }); + stream.end(); + return; + } + + stream.push({ + type: "done", + reason: "stop", + message: buildStopMessage(model, "BUNDLE MCP OK FROM-BUNDLE"), + }); + stream.end(); + }); + return stream; + }, + }; +}); + +let runEmbeddedPiAgent: typeof import("./pi-embedded-runner/run.js").runEmbeddedPiAgent; +let e2eWorkspace: EmbeddedPiRunnerTestWorkspace | undefined; +let agentDir: string; +let workspaceDir: string; + +beforeAll(async () => { + vi.useRealTimers(); + ({ runEmbeddedPiAgent } = await import("./pi-embedded-runner/run.js")); + e2eWorkspace = await createEmbeddedPiRunnerTestWorkspace("openclaw-bundle-mcp-pi-"); + ({ agentDir, workspaceDir } = e2eWorkspace); +}, 180_000); + +afterAll(async () => { + await cleanupEmbeddedPiRunnerTestWorkspace(e2eWorkspace); + e2eWorkspace = undefined; +}); + +const readSessionMessages = async (sessionFile: string) => { + const raw = await fs.readFile(sessionFile, "utf-8"); + return raw + .split(/\r?\n/) + .filter(Boolean) + .map( + (line) => + JSON.parse(line) as { type?: string; message?: { role?: string; content?: unknown } }, + ) + .filter((entry) => entry.type === "message") + .map((entry) => entry.message) as Array<{ role?: string; content?: unknown }>; +}; + +describe("runEmbeddedPiAgent bundle MCP e2e", () => { + it( + "loads bundle MCP into Pi, executes the MCP tool, and includes the result in the follow-up turn", + { timeout: E2E_TIMEOUT_MS }, + async () => { + streamCallCount = 0; + observedContexts = []; + + const sessionFile = path.join(workspaceDir, "session-bundle-mcp-e2e.jsonl"); + const pluginRoot = path.join(workspaceDir, ".openclaw", "extensions", "bundle-probe"); + const serverScriptPath = path.join(pluginRoot, "servers", "bundle-probe.mjs"); + await writeBundleProbeMcpServer(serverScriptPath); + await writeClaudeBundle({ pluginRoot, serverScriptPath }); + + const cfg = { + ...createEmbeddedPiRunnerOpenAiConfig(["mock-bundle-mcp"]), + plugins: { + entries: { + "bundle-probe": { enabled: true }, + }, + }, + }; + + const result = await runEmbeddedPiAgent({ + sessionId: "bundle-mcp-e2e", + sessionKey: "agent:test:bundle-mcp-e2e", + sessionFile, + workspaceDir, + config: cfg, + prompt: "Use the bundle MCP tool and report its result.", + provider: "openai", + model: "mock-bundle-mcp", + timeoutMs: 10_000, + agentDir, + runId: "run-bundle-mcp-e2e", + enqueue: immediateEnqueue, + }); + + expect(result.meta.stopReason).toBe("stop"); + expect(result.payloads?.[0]?.text).toContain("BUNDLE MCP OK FROM-BUNDLE"); + expect(streamCallCount).toBe(2); + + const followUpContext = observedContexts[1] ?? []; + const followUpTexts = followUpContext.flatMap((message) => + Array.isArray(message.content) + ? (message.content as Array<{ type?: string; text?: string }>) + .filter((entry) => entry.type === "text" && typeof entry.text === "string") + .map((entry) => entry.text ?? "") + : [], + ); + expect(followUpTexts.some((text) => text.includes("FROM-BUNDLE"))).toBe(true); + + const messages = await readSessionMessages(sessionFile); + const toolResults = messages.filter((message) => message?.role === "toolResult"); + const toolResultText = toolResults.flatMap((message) => + Array.isArray(message.content) + ? (message.content as Array<{ type?: string; text?: string }>) + .filter((entry) => entry.type === "text" && typeof entry.text === "string") + .map((entry) => entry.text ?? "") + : [], + ); + expect(toolResultText.some((text) => text.includes("FROM-BUNDLE"))).toBe(true); + }, + ); +}); diff --git a/src/agents/pi-embedded-runner/compact.ts b/src/agents/pi-embedded-runner/compact.ts index 4daef42a21f..98a3b438d21 100644 --- a/src/agents/pi-embedded-runner/compact.ts +++ b/src/agents/pi-embedded-runner/compact.ts @@ -53,6 +53,7 @@ import { supportsModelTools } from "../model-tool-support.js"; import { ensureOpenClawModelsJson } from "../models-config.js"; import { createConfiguredOllamaStreamFn } from "../ollama-stream.js"; import { resolveOwnerDisplaySetting } from "../owner-display.js"; +import { createBundleMcpToolRuntime } from "../pi-bundle-mcp-tools.js"; import { ensureSessionHeader, validateAnthropicTurns, @@ -583,12 +584,24 @@ export async function compactEmbeddedPiSessionDirect( modelContextWindowTokens: ctxInfo.tokens, modelAuthMode: resolveModelAuthMode(model.provider, params.config), }); + const toolsEnabled = supportsModelTools(runtimeModel); const tools = sanitizeToolsForGoogle({ - tools: supportsModelTools(runtimeModel) ? toolsRaw : [], + tools: toolsEnabled ? toolsRaw : [], provider, }); - const allowedToolNames = collectAllowedToolNames({ tools }); - logToolSchemasForGoogle({ tools, provider }); + const bundleMcpRuntime = toolsEnabled + ? await createBundleMcpToolRuntime({ + workspaceDir: effectiveWorkspace, + cfg: params.config, + reservedToolNames: tools.map((tool) => tool.name), + }) + : undefined; + const effectiveTools = + bundleMcpRuntime && bundleMcpRuntime.tools.length > 0 + ? [...tools, ...bundleMcpRuntime.tools] + : tools; + const allowedToolNames = collectAllowedToolNames({ tools: effectiveTools }); + logToolSchemasForGoogle({ tools: effectiveTools, provider }); const machineName = await getMachineDisplayName(); const runtimeChannel = normalizeMessageChannel(params.messageChannel ?? params.messageProvider); let runtimeCapabilities = runtimeChannel @@ -705,7 +718,7 @@ export async function compactEmbeddedPiSessionDirect( reactionGuidance, messageToolHints, sandboxInfo, - tools, + tools: effectiveTools, modelAliasLines: buildModelAliasLines(params.config), userTimezone, userTime, @@ -768,7 +781,7 @@ export async function compactEmbeddedPiSessionDirect( } const { builtInTools, customTools } = splitSdkTools({ - tools, + tools: effectiveTools, sandboxEnabled: !!sandbox?.enabled, }); @@ -1060,6 +1073,7 @@ export async function compactEmbeddedPiSessionDirect( clearPendingOnTimeout: true, }); session.dispose(); + await bundleMcpRuntime?.dispose(); } } finally { await sessionLock.release(); diff --git a/src/agents/pi-embedded-runner/run/attempt.ts b/src/agents/pi-embedded-runner/run/attempt.ts index 0ea66825ff1..dc9df12865d 100644 --- a/src/agents/pi-embedded-runner/run/attempt.ts +++ b/src/agents/pi-embedded-runner/run/attempt.ts @@ -59,6 +59,7 @@ import { supportsModelTools } from "../../model-tool-support.js"; import { createConfiguredOllamaStreamFn } from "../../ollama-stream.js"; import { createOpenAIWebSocketStreamFn, releaseWsSession } from "../../openai-ws-stream.js"; import { resolveOwnerDisplaySetting } from "../../owner-display.js"; +import { createBundleMcpToolRuntime } from "../../pi-bundle-mcp-tools.js"; import { downgradeOpenAIFunctionCallReasoningPairs, isCloudCodeAssistFormatError, @@ -1547,11 +1548,25 @@ export async function runEmbeddedAttempt( provider: params.provider, }); const clientTools = toolsEnabled ? params.clientTools : undefined; + const bundleMcpRuntime = toolsEnabled + ? await createBundleMcpToolRuntime({ + workspaceDir: effectiveWorkspace, + cfg: params.config, + reservedToolNames: [ + ...tools.map((tool) => tool.name), + ...(clientTools?.map((tool) => tool.function.name) ?? []), + ], + }) + : undefined; + const effectiveTools = + bundleMcpRuntime && bundleMcpRuntime.tools.length > 0 + ? [...tools, ...bundleMcpRuntime.tools] + : tools; const allowedToolNames = collectAllowedToolNames({ - tools, + tools: effectiveTools, clientTools, }); - logToolSchemasForGoogle({ tools, provider: params.provider }); + logToolSchemasForGoogle({ tools: effectiveTools, provider: params.provider }); const machineName = await getMachineDisplayName(); const runtimeChannel = normalizeMessageChannel(params.messageChannel ?? params.messageProvider); @@ -1673,7 +1688,7 @@ export async function runEmbeddedAttempt( runtimeInfo, messageToolHints, sandboxInfo, - tools, + tools: effectiveTools, modelAliasLines: buildModelAliasLines(params.config), userTimezone, userTime, @@ -1708,7 +1723,7 @@ export async function runEmbeddedAttempt( bootstrapFiles: hookAdjustedBootstrapFiles, injectedFiles: contextFiles, skillsPrompt, - tools, + tools: effectiveTools, }); const systemPromptOverride = createSystemPromptOverride(appendPrompt); let systemPromptText = systemPromptOverride(); @@ -1808,7 +1823,7 @@ export async function runEmbeddedAttempt( const hookRunner = getGlobalHookRunner(); const { builtInTools, customTools } = splitSdkTools({ - tools, + tools: effectiveTools, sandboxEnabled: !!sandbox?.enabled, }); @@ -2868,6 +2883,7 @@ export async function runEmbeddedAttempt( }); session?.dispose(); releaseWsSession(params.sessionId); + await bundleMcpRuntime?.dispose(); await sessionLock.release(); } } finally { diff --git a/src/agents/pi-project-settings.bundle.test.ts b/src/agents/pi-project-settings.bundle.test.ts index d297b1ef3a1..5859e18ac6e 100644 --- a/src/agents/pi-project-settings.bundle.test.ts +++ b/src/agents/pi-project-settings.bundle.test.ts @@ -79,6 +79,106 @@ describe("loadEnabledBundlePiSettingsSnapshot", () => { expect(snapshot.compaction?.keepRecentTokens).toBe(64_000); }); + it("loads enabled bundle MCP servers into the Pi settings snapshot", async () => { + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await tempDirs.make("openclaw-bundle-"); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.mkdir(path.join(pluginRoot, "servers"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + JSON.stringify({ + name: "claude-bundle", + }), + "utf-8", + ); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + bundleProbe: { + command: "node", + args: ["./servers/probe.mjs"], + }, + }, + }), + "utf-8", + ); + hoisted.loadPluginManifestRegistry.mockReturnValue( + buildRegistry({ pluginRoot, settingsFiles: [] }), + ); + + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: true }, + }, + }, + }, + }); + + expect(snapshot.mcpServers).toEqual({ + bundleProbe: { + command: "node", + args: [path.join(pluginRoot, "servers", "probe.mjs")], + cwd: pluginRoot, + }, + }); + }); + + it("lets top-level MCP config override bundle MCP defaults", async () => { + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await tempDirs.make("openclaw-bundle-"); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + JSON.stringify({ + name: "claude-bundle", + }), + "utf-8", + ); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + sharedServer: { + command: "node", + args: ["./servers/bundle.mjs"], + }, + }, + }), + "utf-8", + ); + hoisted.loadPluginManifestRegistry.mockReturnValue( + buildRegistry({ pluginRoot, settingsFiles: [] }), + ); + + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + mcp: { + servers: { + sharedServer: { + url: "https://example.com/mcp", + }, + }, + }, + plugins: { + entries: { + "claude-bundle": { enabled: true }, + }, + }, + }, + }); + + expect(snapshot.mcpServers).toEqual({ + sharedServer: { + url: "https://example.com/mcp", + }, + }); + }); + it("ignores disabled bundle plugins", async () => { const workspaceDir = await tempDirs.make("openclaw-workspace-"); const pluginRoot = await tempDirs.make("openclaw-bundle-"); diff --git a/src/agents/pi-project-settings.test.ts b/src/agents/pi-project-settings.test.ts index 92d676b8427..2ec9edf523d 100644 --- a/src/agents/pi-project-settings.test.ts +++ b/src/agents/pi-project-settings.test.ts @@ -93,4 +93,34 @@ describe("buildEmbeddedPiSettingsSnapshot", () => { expect(snapshot.compaction?.reserveTokens).toBe(32_000); expect(snapshot.hideThinkingBlock).toBe(true); }); + + it("lets project Pi settings override bundle MCP defaults", () => { + const snapshot = buildEmbeddedPiSettingsSnapshot({ + globalSettings, + pluginSettings: { + mcpServers: { + bundleProbe: { + command: "node", + args: ["/plugins/probe.mjs"], + }, + }, + }, + projectSettings: { + mcpServers: { + bundleProbe: { + command: "deno", + args: ["/workspace/probe.ts"], + }, + }, + }, + policy: "sanitize", + }); + + expect(snapshot.mcpServers).toEqual({ + bundleProbe: { + command: "deno", + args: ["/workspace/probe.ts"], + }, + }); + }); }); diff --git a/src/agents/pi-project-settings.ts b/src/agents/pi-project-settings.ts index 8e08d11bca7..fd66a6ee393 100644 --- a/src/agents/pi-project-settings.ts +++ b/src/agents/pi-project-settings.ts @@ -8,6 +8,7 @@ import { createSubsystemLogger } from "../logging/subsystem.js"; import { normalizePluginsConfig, resolveEffectiveEnableState } from "../plugins/config-state.js"; import { loadPluginManifestRegistry } from "../plugins/manifest-registry.js"; import { isRecord } from "../utils.js"; +import { loadEmbeddedPiMcpConfig } from "./embedded-pi-mcp.js"; import { applyPiCompactionSettingsFromConfig } from "./pi-settings.js"; const log = createSubsystemLogger("embedded-pi-settings"); @@ -107,6 +108,19 @@ export function loadEnabledBundlePiSettingsSnapshot(params: { } } + const embeddedPiMcp = loadEmbeddedPiMcpConfig({ + workspaceDir, + cfg: params.cfg, + }); + for (const diagnostic of embeddedPiMcp.diagnostics) { + log.warn(`bundle MCP skipped for ${diagnostic.pluginId}: ${diagnostic.message}`); + } + if (Object.keys(embeddedPiMcp.mcpServers).length > 0) { + snapshot = applyMergePatch(snapshot, { + mcpServers: embeddedPiMcp.mcpServers, + }) as PiSettingsSnapshot; + } + return snapshot; } diff --git a/src/auto-reply/commands-args.ts b/src/auto-reply/commands-args.ts index ab49b9ea68a..6f37414c053 100644 --- a/src/auto-reply/commands-args.ts +++ b/src/auto-reply/commands-args.ts @@ -51,6 +51,16 @@ const formatConfigArgs: CommandArgsFormatter = (values) => }, }); +const formatMcpArgs: CommandArgsFormatter = (values) => + formatActionArgs(values, { + formatKnownAction: (action, path) => { + if (action === "show" || action === "get") { + return path ? `${action} ${path}` : action; + } + return undefined; + }, + }); + const formatDebugArgs: CommandArgsFormatter = (values) => formatActionArgs(values, { formatKnownAction: (action) => { @@ -124,6 +134,7 @@ const formatExecArgs: CommandArgsFormatter = (values) => { export const COMMAND_ARG_FORMATTERS: Record = { config: formatConfigArgs, + mcp: formatMcpArgs, debug: formatDebugArgs, queue: formatQueueArgs, exec: formatExecArgs, diff --git a/src/auto-reply/commands-registry.data.ts b/src/auto-reply/commands-registry.data.ts index 58064473543..d4d4da530d3 100644 --- a/src/auto-reply/commands-registry.data.ts +++ b/src/auto-reply/commands-registry.data.ts @@ -452,6 +452,34 @@ function buildChatCommands(): ChatCommandDefinition[] { argsParsing: "none", formatArgs: COMMAND_ARG_FORMATTERS.config, }), + defineChatCommand({ + key: "mcp", + nativeName: "mcp", + description: "Show or set embedded Pi MCP servers.", + textAlias: "/mcp", + category: "management", + args: [ + { + name: "action", + description: "show | get | set | unset", + type: "string", + choices: ["show", "get", "set", "unset"], + }, + { + name: "path", + description: "MCP server name", + type: "string", + }, + { + name: "value", + description: "JSON config for set", + type: "string", + captureRemaining: true, + }, + ], + argsParsing: "none", + formatArgs: COMMAND_ARG_FORMATTERS.mcp, + }), defineChatCommand({ key: "debug", nativeName: "debug", diff --git a/src/auto-reply/commands-registry.ts b/src/auto-reply/commands-registry.ts index 93f8872e37b..8b0d7a5b5d6 100644 --- a/src/auto-reply/commands-registry.ts +++ b/src/auto-reply/commands-registry.ts @@ -99,6 +99,9 @@ export function isCommandEnabled(cfg: OpenClawConfig, commandKey: string): boole if (commandKey === "config") { return isCommandFlagEnabled(cfg, "config"); } + if (commandKey === "mcp") { + return isCommandFlagEnabled(cfg, "mcp"); + } if (commandKey === "debug") { return isCommandFlagEnabled(cfg, "debug"); } diff --git a/src/auto-reply/reply/commands-core.ts b/src/auto-reply/reply/commands-core.ts index 7a6cc36c05e..f969c9f5f24 100644 --- a/src/auto-reply/reply/commands-core.ts +++ b/src/auto-reply/reply/commands-core.ts @@ -22,6 +22,7 @@ import { handleStatusCommand, handleWhoamiCommand, } from "./commands-info.js"; +import { handleMcpCommand } from "./commands-mcp.js"; import { handleModelsCommand } from "./commands-models.js"; import { handlePluginCommand } from "./commands-plugin.js"; import { @@ -194,6 +195,7 @@ export async function handleCommands(params: HandleCommandsParams): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-command-mcp-")); + tempDirs.push(dir); + return dir; +} + +function buildCfg(): OpenClawConfig { + return { + commands: { + text: true, + mcp: true, + }, + }; +} + +describe("handleCommands /mcp", () => { + afterEach(async () => { + await Promise.all( + tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); + }); + + it("writes MCP config and shows it back", async () => { + await withTempHome("openclaw-command-mcp-home-", async () => { + const workspaceDir = await createWorkspace(); + const setParams = buildCommandTestParams( + '/mcp set context7={"command":"uvx","args":["context7-mcp"]}', + buildCfg(), + undefined, + { workspaceDir }, + ); + setParams.command.senderIsOwner = true; + + const setResult = await handleCommands(setParams); + expect(setResult.reply?.text).toContain('MCP server "context7" saved'); + + const showParams = buildCommandTestParams("/mcp show context7", buildCfg(), undefined, { + workspaceDir, + }); + showParams.command.senderIsOwner = true; + const showResult = await handleCommands(showParams); + expect(showResult.reply?.text).toContain('"command": "uvx"'); + expect(showResult.reply?.text).toContain('"args": ['); + }); + }); + + it("rejects internal writes without operator.admin", async () => { + await withTempHome("openclaw-command-mcp-home-", async () => { + const workspaceDir = await createWorkspace(); + const params = buildCommandTestParams( + '/mcp set context7={"command":"uvx","args":["context7-mcp"]}', + buildCfg(), + { + Provider: "webchat", + Surface: "webchat", + GatewayClientScopes: ["operator.write"], + }, + { workspaceDir }, + ); + params.command.senderIsOwner = true; + + const result = await handleCommands(params); + expect(result.reply?.text).toContain("requires operator.admin"); + }); + }); + + it("accepts non-stdio MCP config at the config layer", async () => { + await withTempHome("openclaw-command-mcp-home-", async () => { + const workspaceDir = await createWorkspace(); + const params = buildCommandTestParams( + '/mcp set remote={"url":"https://example.com/mcp"}', + buildCfg(), + undefined, + { workspaceDir }, + ); + params.command.senderIsOwner = true; + + const result = await handleCommands(params); + expect(result.reply?.text).toContain('MCP server "remote" saved'); + }); + }); +}); diff --git a/src/auto-reply/reply/commands-mcp.ts b/src/auto-reply/reply/commands-mcp.ts new file mode 100644 index 00000000000..ff805a9b878 --- /dev/null +++ b/src/auto-reply/reply/commands-mcp.ts @@ -0,0 +1,134 @@ +import { + listConfiguredMcpServers, + setConfiguredMcpServer, + unsetConfiguredMcpServer, +} from "../../config/mcp-config.js"; +import { isInternalMessageChannel } from "../../utils/message-channel.js"; +import { + rejectNonOwnerCommand, + rejectUnauthorizedCommand, + requireCommandFlagEnabled, + requireGatewayClientScopeForInternalChannel, +} from "./command-gates.js"; +import type { CommandHandler } from "./commands-types.js"; +import { parseMcpCommand } from "./mcp-commands.js"; + +function renderJsonBlock(label: string, value: unknown): string { + return `${label}\n\`\`\`json\n${JSON.stringify(value, null, 2)}\n\`\`\``; +} + +export const handleMcpCommand: CommandHandler = async (params, allowTextCommands) => { + if (!allowTextCommands) { + return null; + } + const mcpCommand = parseMcpCommand(params.command.commandBodyNormalized); + if (!mcpCommand) { + return null; + } + const unauthorized = rejectUnauthorizedCommand(params, "/mcp"); + if (unauthorized) { + return unauthorized; + } + const allowInternalReadOnlyShow = + mcpCommand.action === "show" && isInternalMessageChannel(params.command.channel); + const nonOwner = allowInternalReadOnlyShow ? null : rejectNonOwnerCommand(params, "/mcp"); + if (nonOwner) { + return nonOwner; + } + const disabled = requireCommandFlagEnabled(params.cfg, { + label: "/mcp", + configKey: "mcp", + }); + if (disabled) { + return disabled; + } + if (mcpCommand.action === "error") { + return { + shouldContinue: false, + reply: { text: `⚠️ ${mcpCommand.message}` }, + }; + } + + if (mcpCommand.action === "show") { + const loaded = await listConfiguredMcpServers(); + if (!loaded.ok) { + return { + shouldContinue: false, + reply: { text: `⚠️ ${loaded.error}` }, + }; + } + if (mcpCommand.name) { + const server = loaded.mcpServers[mcpCommand.name]; + if (!server) { + return { + shouldContinue: false, + reply: { text: `🔌 No MCP server named "${mcpCommand.name}" in ${loaded.path}.` }, + }; + } + return { + shouldContinue: false, + reply: { + text: renderJsonBlock(`🔌 MCP server "${mcpCommand.name}" (${loaded.path})`, server), + }, + }; + } + if (Object.keys(loaded.mcpServers).length === 0) { + return { + shouldContinue: false, + reply: { text: `🔌 No MCP servers configured in ${loaded.path}.` }, + }; + } + return { + shouldContinue: false, + reply: { + text: renderJsonBlock(`🔌 MCP servers (${loaded.path})`, loaded.mcpServers), + }, + }; + } + + const missingAdminScope = requireGatewayClientScopeForInternalChannel(params, { + label: "/mcp write", + allowedScopes: ["operator.admin"], + missingText: "❌ /mcp set|unset requires operator.admin for gateway clients.", + }); + if (missingAdminScope) { + return missingAdminScope; + } + + if (mcpCommand.action === "set") { + const result = await setConfiguredMcpServer({ + name: mcpCommand.name, + server: mcpCommand.value, + }); + if (!result.ok) { + return { + shouldContinue: false, + reply: { text: `⚠️ ${result.error}` }, + }; + } + return { + shouldContinue: false, + reply: { + text: `🔌 MCP server "${mcpCommand.name}" saved to ${result.path}.`, + }, + }; + } + + const result = await unsetConfiguredMcpServer({ name: mcpCommand.name }); + if (!result.ok) { + return { + shouldContinue: false, + reply: { text: `⚠️ ${result.error}` }, + }; + } + if (!result.removed) { + return { + shouldContinue: false, + reply: { text: `🔌 No MCP server named "${mcpCommand.name}" in ${result.path}.` }, + }; + } + return { + shouldContinue: false, + reply: { text: `🔌 MCP server "${mcpCommand.name}" removed from ${result.path}.` }, + }; +}; diff --git a/src/auto-reply/reply/mcp-commands.ts b/src/auto-reply/reply/mcp-commands.ts new file mode 100644 index 00000000000..506efe015df --- /dev/null +++ b/src/auto-reply/reply/mcp-commands.ts @@ -0,0 +1,24 @@ +import { parseStandardSetUnsetSlashCommand } from "./commands-setunset-standard.js"; + +export type McpCommand = + | { action: "show"; name?: string } + | { action: "set"; name: string; value: unknown } + | { action: "unset"; name: string } + | { action: "error"; message: string }; + +export function parseMcpCommand(raw: string): McpCommand | null { + return parseStandardSetUnsetSlashCommand({ + raw, + slash: "/mcp", + invalidMessage: "Invalid /mcp syntax.", + usageMessage: "Usage: /mcp show|set|unset", + onKnownAction: (action, args) => { + if (action === "show" || action === "get") { + return { action: "show", name: args || undefined }; + } + return undefined; + }, + onSet: (name, value) => ({ action: "set", name, value }), + onUnset: (name) => ({ action: "unset", name }), + }); +} diff --git a/src/cli/mcp-cli.test.ts b/src/cli/mcp-cli.test.ts new file mode 100644 index 00000000000..299406d5f31 --- /dev/null +++ b/src/cli/mcp-cli.test.ts @@ -0,0 +1,83 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import { Command } from "commander"; +import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { withTempHome } from "../config/home-env.test-harness.js"; + +const mockLog = vi.fn(); +const mockError = vi.fn(); +const mockExit = vi.fn((code: number) => { + throw new Error(`__exit__:${code}`); +}); + +vi.mock("../runtime.js", () => ({ + defaultRuntime: { + log: (...args: unknown[]) => mockLog(...args), + error: (...args: unknown[]) => mockError(...args), + exit: (code: number) => mockExit(code), + }, +})); + +const tempDirs: string[] = []; + +async function createWorkspace(): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-cli-mcp-")); + tempDirs.push(dir); + return dir; +} + +let registerMcpCli: typeof import("./mcp-cli.js").registerMcpCli; +let sharedProgram: Command; +let previousCwd = process.cwd(); + +async function runMcpCommand(args: string[]) { + await sharedProgram.parseAsync(args, { from: "user" }); +} + +describe("mcp cli", () => { + beforeAll(async () => { + ({ registerMcpCli } = await import("./mcp-cli.js")); + sharedProgram = new Command(); + sharedProgram.exitOverride(); + registerMcpCli(sharedProgram); + }, 300_000); + + beforeEach(() => { + vi.clearAllMocks(); + previousCwd = process.cwd(); + }); + + afterEach(async () => { + process.chdir(previousCwd); + await Promise.all( + tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); + }); + + it("sets and shows a configured MCP server", async () => { + await withTempHome("openclaw-cli-mcp-home-", async () => { + const workspaceDir = await createWorkspace(); + process.chdir(workspaceDir); + + await runMcpCommand(["mcp", "set", "context7", '{"command":"uvx","args":["context7-mcp"]}']); + expect(mockLog).toHaveBeenCalledWith(expect.stringContaining('Saved MCP server "context7"')); + + mockLog.mockClear(); + await runMcpCommand(["mcp", "show", "context7", "--json"]); + expect(mockLog).toHaveBeenCalledWith(expect.stringContaining('"command": "uvx"')); + }); + }); + + it("fails when removing an unknown MCP server", async () => { + await withTempHome("openclaw-cli-mcp-home-", async () => { + const workspaceDir = await createWorkspace(); + process.chdir(workspaceDir); + + await expect(runMcpCommand(["mcp", "unset", "missing"])).rejects.toThrow("__exit__:1"); + expect(mockError).toHaveBeenCalledWith( + expect.stringContaining('No MCP server named "missing"'), + ); + }); + }); +}); diff --git a/src/cli/mcp-cli.ts b/src/cli/mcp-cli.ts new file mode 100644 index 00000000000..62831ee827d --- /dev/null +++ b/src/cli/mcp-cli.ts @@ -0,0 +1,103 @@ +import { Command } from "commander"; +import { parseConfigValue } from "../auto-reply/reply/config-value.js"; +import { + listConfiguredMcpServers, + setConfiguredMcpServer, + unsetConfiguredMcpServer, +} from "../config/mcp-config.js"; +import { defaultRuntime } from "../runtime.js"; + +function fail(message: string): never { + defaultRuntime.error(message); + defaultRuntime.exit(1); +} + +function printJson(value: unknown): void { + defaultRuntime.log(JSON.stringify(value, null, 2)); +} + +export function registerMcpCli(program: Command) { + const mcp = program.command("mcp").description("Manage OpenClaw MCP server config"); + + mcp + .command("list") + .description("List configured MCP servers") + .option("--json", "Print JSON") + .action(async (opts: { json?: boolean }) => { + const loaded = await listConfiguredMcpServers(); + if (!loaded.ok) { + fail(loaded.error); + } + if (opts.json) { + printJson(loaded.mcpServers); + return; + } + const names = Object.keys(loaded.mcpServers).toSorted(); + if (names.length === 0) { + defaultRuntime.log(`No MCP servers configured in ${loaded.path}.`); + return; + } + defaultRuntime.log(`MCP servers (${loaded.path}):`); + for (const name of names) { + defaultRuntime.log(`- ${name}`); + } + }); + + mcp + .command("show") + .description("Show one configured MCP server or the full MCP config") + .argument("[name]", "MCP server name") + .option("--json", "Print JSON") + .action(async (name: string | undefined, opts: { json?: boolean }) => { + const loaded = await listConfiguredMcpServers(); + if (!loaded.ok) { + fail(loaded.error); + } + const value = name ? loaded.mcpServers[name] : loaded.mcpServers; + if (name && !value) { + fail(`No MCP server named "${name}" in ${loaded.path}.`); + } + if (opts.json) { + printJson(value ?? {}); + return; + } + if (name) { + defaultRuntime.log(`MCP server "${name}" (${loaded.path}):`); + } else { + defaultRuntime.log(`MCP servers (${loaded.path}):`); + } + printJson(value ?? {}); + }); + + mcp + .command("set") + .description("Set one configured MCP server from a JSON object") + .argument("", "MCP server name") + .argument("", 'JSON object, for example {"command":"uvx","args":["context7-mcp"]}') + .action(async (name: string, rawValue: string) => { + const parsed = parseConfigValue(rawValue); + if (parsed.error) { + fail(parsed.error); + } + const result = await setConfiguredMcpServer({ name, server: parsed.value }); + if (!result.ok) { + fail(result.error); + } + defaultRuntime.log(`Saved MCP server "${name}" to ${result.path}.`); + }); + + mcp + .command("unset") + .description("Remove one configured MCP server") + .argument("", "MCP server name") + .action(async (name: string) => { + const result = await unsetConfiguredMcpServer({ name }); + if (!result.ok) { + fail(result.error); + } + if (!result.removed) { + fail(`No MCP server named "${name}" in ${result.path}.`); + } + defaultRuntime.log(`Removed MCP server "${name}" from ${result.path}.`); + }); +} diff --git a/src/cli/program/command-registry.ts b/src/cli/program/command-registry.ts index 1955e851357..93c4616594e 100644 --- a/src/cli/program/command-registry.ts +++ b/src/cli/program/command-registry.ts @@ -160,6 +160,19 @@ const coreEntries: CoreCliEntry[] = [ mod.registerMemoryCli(program); }, }, + { + commands: [ + { + name: "mcp", + description: "Manage embedded Pi MCP servers", + hasSubcommands: true, + }, + ], + register: async ({ program }) => { + const mod = await import("../mcp-cli.js"); + mod.registerMcpCli(program); + }, + }, { commands: [ { diff --git a/src/config/mcp-config.test.ts b/src/config/mcp-config.test.ts new file mode 100644 index 00000000000..bd7032fb8a4 --- /dev/null +++ b/src/config/mcp-config.test.ts @@ -0,0 +1,56 @@ +import fs from "node:fs/promises"; +import { describe, expect, it } from "vitest"; +import { + listConfiguredMcpServers, + setConfiguredMcpServer, + unsetConfiguredMcpServer, +} from "./mcp-config.js"; +import { withTempHomeConfig } from "./test-helpers.js"; + +describe("config mcp config", () => { + it("writes and removes top-level mcp servers", async () => { + await withTempHomeConfig({}, async () => { + const setResult = await setConfiguredMcpServer({ + name: "context7", + server: { + command: "uvx", + args: ["context7-mcp"], + }, + }); + + expect(setResult.ok).toBe(true); + const loaded = await listConfiguredMcpServers(); + expect(loaded.ok).toBe(true); + if (!loaded.ok) { + throw new Error("expected MCP config to load"); + } + expect(loaded.mcpServers.context7).toEqual({ + command: "uvx", + args: ["context7-mcp"], + }); + + const unsetResult = await unsetConfiguredMcpServer({ name: "context7" }); + expect(unsetResult.ok).toBe(true); + + const reloaded = await listConfiguredMcpServers(); + expect(reloaded.ok).toBe(true); + if (!reloaded.ok) { + throw new Error("expected MCP config to reload"); + } + expect(reloaded.mcpServers).toEqual({}); + }); + }); + + it("fails closed when the config file is invalid", async () => { + await withTempHomeConfig({}, async ({ configPath }) => { + await fs.writeFile(configPath, "{", "utf-8"); + + const loaded = await listConfiguredMcpServers(); + expect(loaded.ok).toBe(false); + if (loaded.ok) { + throw new Error("expected invalid config to fail"); + } + expect(loaded.path).toBe(configPath); + }); + }); +}); diff --git a/src/config/mcp-config.ts b/src/config/mcp-config.ts new file mode 100644 index 00000000000..eb24e3c0ae4 --- /dev/null +++ b/src/config/mcp-config.ts @@ -0,0 +1,150 @@ +import { readConfigFileSnapshot, writeConfigFile } from "./io.js"; +import type { OpenClawConfig } from "./types.openclaw.js"; +import { validateConfigObjectWithPlugins } from "./validation.js"; + +export type ConfigMcpServers = Record>; + +type ConfigMcpReadResult = + | { ok: true; path: string; config: OpenClawConfig; mcpServers: ConfigMcpServers } + | { ok: false; path: string; error: string }; + +type ConfigMcpWriteResult = + | { + ok: true; + path: string; + config: OpenClawConfig; + mcpServers: ConfigMcpServers; + removed?: boolean; + } + | { ok: false; path: string; error: string }; + +function isRecord(value: unknown): value is Record { + return value !== null && typeof value === "object" && !Array.isArray(value); +} + +export function normalizeConfiguredMcpServers(value: unknown): ConfigMcpServers { + if (!isRecord(value)) { + return {}; + } + return Object.fromEntries( + Object.entries(value) + .filter(([, server]) => isRecord(server)) + .map(([name, server]) => [name, { ...(server as Record) }]), + ); +} + +export async function listConfiguredMcpServers(): Promise { + const snapshot = await readConfigFileSnapshot(); + if (!snapshot.valid) { + return { + ok: false, + path: snapshot.path, + error: "Config file is invalid; fix it before using MCP config commands.", + }; + } + return { + ok: true, + path: snapshot.path, + config: structuredClone(snapshot.resolved), + mcpServers: normalizeConfiguredMcpServers(snapshot.resolved.mcp?.servers), + }; +} + +export async function setConfiguredMcpServer(params: { + name: string; + server: unknown; +}): Promise { + const name = params.name.trim(); + if (!name) { + return { ok: false, path: "", error: "MCP server name is required." }; + } + if (!isRecord(params.server)) { + return { ok: false, path: "", error: "MCP server config must be a JSON object." }; + } + + const loaded = await listConfiguredMcpServers(); + if (!loaded.ok) { + return loaded; + } + + const next = structuredClone(loaded.config); + const servers = normalizeConfiguredMcpServers(next.mcp?.servers); + servers[name] = { ...params.server }; + next.mcp = { + ...next.mcp, + servers, + }; + + const validated = validateConfigObjectWithPlugins(next); + if (!validated.ok) { + const issue = validated.issues[0]; + return { + ok: false, + path: loaded.path, + error: `Config invalid after MCP set (${issue.path}: ${issue.message}).`, + }; + } + await writeConfigFile(validated.config); + return { + ok: true, + path: loaded.path, + config: validated.config, + mcpServers: servers, + }; +} + +export async function unsetConfiguredMcpServer(params: { + name: string; +}): Promise { + const name = params.name.trim(); + if (!name) { + return { ok: false, path: "", error: "MCP server name is required." }; + } + + const loaded = await listConfiguredMcpServers(); + if (!loaded.ok) { + return loaded; + } + if (!Object.hasOwn(loaded.mcpServers, name)) { + return { + ok: true, + path: loaded.path, + config: loaded.config, + mcpServers: loaded.mcpServers, + removed: false, + }; + } + + const next = structuredClone(loaded.config); + const servers = normalizeConfiguredMcpServers(next.mcp?.servers); + delete servers[name]; + if (Object.keys(servers).length > 0) { + next.mcp = { + ...next.mcp, + servers, + }; + } else if (next.mcp) { + delete next.mcp.servers; + if (Object.keys(next.mcp).length === 0) { + delete next.mcp; + } + } + + const validated = validateConfigObjectWithPlugins(next); + if (!validated.ok) { + const issue = validated.issues[0]; + return { + ok: false, + path: loaded.path, + error: `Config invalid after MCP unset (${issue.path}: ${issue.message}).`, + }; + } + await writeConfigFile(validated.config); + return { + ok: true, + path: loaded.path, + config: validated.config, + mcpServers: servers, + removed: true, + }; +} diff --git a/src/config/schema.help.ts b/src/config/schema.help.ts index 02103650589..02d9ea5f6c9 100644 --- a/src/config/schema.help.ts +++ b/src/config/schema.help.ts @@ -1093,6 +1093,8 @@ export const FIELD_HELP: Record = { "commands.bashForegroundMs": "How long bash waits before backgrounding (default: 2000; 0 backgrounds immediately).", "commands.config": "Allow /config chat command to read/write config on disk (default: false).", + "commands.mcp": + "Allow /mcp chat command to manage OpenClaw MCP server config under mcp.servers (default: false).", "commands.debug": "Allow /debug chat command for runtime-only overrides (default: false).", "commands.restart": "Allow /restart and gateway restart tool actions (default: true).", "commands.useAccessGroups": "Enforce access-group allowlists/policies for commands.", @@ -1104,6 +1106,9 @@ export const FIELD_HELP: Record = { "Optional secret used to HMAC hash owner IDs when ownerDisplay=hash. Prefer env substitution.", "commands.allowFrom": "Defines elevated command allow rules by channel and sender for owner-level command surfaces. Use narrow provider-specific identities so privileged commands are not exposed to broad chat audiences.", + mcp: "Global MCP server definitions managed by OpenClaw. Embedded Pi and other runtime adapters can consume these servers without storing them inside Pi-owned project settings.", + "mcp.servers": + "Named MCP server definitions. OpenClaw stores them in its own config and runtime adapters decide which transports are supported at execution time.", session: "Global session routing, reset, delivery policy, and maintenance controls for conversation history behavior. Keep defaults unless you need stricter isolation, retention, or delivery constraints.", "session.scope": diff --git a/src/config/schema.labels.ts b/src/config/schema.labels.ts index a88cdc1ded5..f00b9fd9226 100644 --- a/src/config/schema.labels.ts +++ b/src/config/schema.labels.ts @@ -503,6 +503,7 @@ export const FIELD_LABELS: Record = { "commands.bash": "Allow Bash Chat Command", "commands.bashForegroundMs": "Bash Foreground Window (ms)", "commands.config": "Allow /config", + "commands.mcp": "Allow /mcp", "commands.debug": "Allow /debug", "commands.restart": "Allow Restart", "commands.useAccessGroups": "Use Access Groups", @@ -510,6 +511,8 @@ export const FIELD_LABELS: Record = { "commands.ownerDisplay": "Owner ID Display", "commands.ownerDisplaySecret": "Owner ID Hash Secret", // pragma: allowlist secret "commands.allowFrom": "Command Elevated Access Rules", + mcp: "MCP", + "mcp.servers": "MCP Servers", ui: "UI", "ui.seamColor": "Accent Color", "ui.assistant": "Assistant Appearance", diff --git a/src/config/types.mcp.ts b/src/config/types.mcp.ts new file mode 100644 index 00000000000..9d6b5e5a1d6 --- /dev/null +++ b/src/config/types.mcp.ts @@ -0,0 +1,14 @@ +export type McpServerConfig = { + command?: string; + args?: string[]; + env?: Record; + cwd?: string; + workingDirectory?: string; + url?: string; + [key: string]: unknown; +}; + +export type McpConfig = { + /** Named MCP server definitions managed by OpenClaw. */ + servers?: Record; +}; diff --git a/src/config/types.messages.ts b/src/config/types.messages.ts index 002a1200b8b..e6f976f2df2 100644 --- a/src/config/types.messages.ts +++ b/src/config/types.messages.ts @@ -148,6 +148,8 @@ export type CommandsConfig = { bashForegroundMs?: number; /** Allow /config command (default: false). */ config?: boolean; + /** Allow /mcp command for project-local embedded Pi MCP settings (default: false). */ + mcp?: boolean; /** Allow /debug command (default: false). */ debug?: boolean; /** Allow restart commands/tools (default: true). */ diff --git a/src/config/types.openclaw.ts b/src/config/types.openclaw.ts index 3d1f0a90080..9997ecc6f84 100644 --- a/src/config/types.openclaw.ts +++ b/src/config/types.openclaw.ts @@ -14,6 +14,7 @@ import type { TalkConfig, } from "./types.gateway.js"; import type { HooksConfig } from "./types.hooks.js"; +import type { McpConfig } from "./types.mcp.js"; import type { MemoryConfig } from "./types.memory.js"; import type { AudioConfig, @@ -120,6 +121,7 @@ export type OpenClawConfig = { talk?: TalkConfig; gateway?: GatewayConfig; memory?: MemoryConfig; + mcp?: McpConfig; }; export type ConfigValidationIssue = { diff --git a/src/config/types.ts b/src/config/types.ts index 52e45b32aaf..47c46e48c68 100644 --- a/src/config/types.ts +++ b/src/config/types.ts @@ -33,3 +33,4 @@ export * from "./types.tts.js"; export * from "./types.tools.js"; export * from "./types.whatsapp.js"; export * from "./types.memory.js"; +export * from "./types.mcp.js"; diff --git a/src/config/zod-schema.session.ts b/src/config/zod-schema.session.ts index b8bb99b1b14..08a3af7c911 100644 --- a/src/config/zod-schema.session.ts +++ b/src/config/zod-schema.session.ts @@ -200,6 +200,7 @@ export const CommandsSchema = z bash: z.boolean().optional(), bashForegroundMs: z.number().int().min(0).max(30_000).optional(), config: z.boolean().optional(), + mcp: z.boolean().optional(), debug: z.boolean().optional(), restart: z.boolean().optional().default(true), useAccessGroups: z.boolean().optional(), diff --git a/src/config/zod-schema.ts b/src/config/zod-schema.ts index 817183cab5d..b32a86dc68f 100644 --- a/src/config/zod-schema.ts +++ b/src/config/zod-schema.ts @@ -203,6 +203,24 @@ const TalkSchema = z } }); +const McpServerSchema = z + .object({ + command: z.string().optional(), + args: z.array(z.string()).optional(), + env: z.record(z.string(), z.union([z.string(), z.number(), z.boolean()])).optional(), + cwd: z.string().optional(), + workingDirectory: z.string().optional(), + url: HttpUrlSchema.optional(), + }) + .catchall(z.unknown()); + +const McpConfigSchema = z + .object({ + servers: z.record(z.string(), McpServerSchema).optional(), + }) + .strict() + .optional(); + export const OpenClawSchema = z .object({ $schema: z.string().optional(), @@ -851,6 +869,7 @@ export const OpenClawSchema = z }) .optional(), memory: MemorySchema, + mcp: McpConfigSchema, skills: z .object({ allowBundled: z.array(z.string()).optional(), diff --git a/src/plugins/bundle-mcp.test.ts b/src/plugins/bundle-mcp.test.ts index 939580f9cfe..ce4c460baf0 100644 --- a/src/plugins/bundle-mcp.test.ts +++ b/src/plugins/bundle-mcp.test.ts @@ -81,6 +81,7 @@ describe("loadEnabledBundleMcpConfig", () => { const loadedServer = loaded.config.mcpServers.bundleProbe; const loadedArgs = getServerArgs(loadedServer); const loadedServerPath = typeof loadedArgs?.[0] === "string" ? loadedArgs[0] : undefined; + const resolvedPluginRoot = await fs.realpath(pluginRoot); expect(loaded.diagnostics).toEqual([]); expect(isRecord(loadedServer) ? loadedServer.command : undefined).toBe("node"); @@ -90,6 +91,7 @@ describe("loadEnabledBundleMcpConfig", () => { throw new Error("expected bundled MCP args to include the server path"); } expect(await fs.realpath(loadedServerPath)).toBe(resolvedServerPath); + expect(loadedServer.cwd).toBe(resolvedPluginRoot); } finally { env.restore(); } @@ -164,4 +166,67 @@ describe("loadEnabledBundleMcpConfig", () => { env.restore(); } }); + + it("resolves inline Claude MCP paths from the plugin root and expands CLAUDE_PLUGIN_ROOT", async () => { + const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); + try { + const homeDir = await createTempDir("openclaw-bundle-inline-placeholder-home-"); + const workspaceDir = await createTempDir("openclaw-bundle-inline-placeholder-workspace-"); + process.env.HOME = homeDir; + process.env.USERPROFILE = homeDir; + delete process.env.OPENCLAW_HOME; + delete process.env.OPENCLAW_STATE_DIR; + + const pluginRoot = path.join(homeDir, ".openclaw", "extensions", "inline-claude"); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + `${JSON.stringify( + { + name: "inline-claude", + mcpServers: { + inlineProbe: { + command: "${CLAUDE_PLUGIN_ROOT}/bin/server.sh", + args: ["${CLAUDE_PLUGIN_ROOT}/servers/probe.mjs", "./local-probe.mjs"], + cwd: "${CLAUDE_PLUGIN_ROOT}", + env: { + PLUGIN_ROOT: "${CLAUDE_PLUGIN_ROOT}", + }, + }, + }, + }, + null, + 2, + )}\n`, + "utf-8", + ); + + const loaded = loadEnabledBundleMcpConfig({ + workspaceDir, + cfg: { + plugins: { + entries: { + "inline-claude": { enabled: true }, + }, + }, + }, + }); + const resolvedPluginRoot = await fs.realpath(pluginRoot); + + expect(loaded.diagnostics).toEqual([]); + expect(loaded.config.mcpServers.inlineProbe).toEqual({ + command: path.join(resolvedPluginRoot, "bin", "server.sh"), + args: [ + path.join(resolvedPluginRoot, "servers", "probe.mjs"), + path.join(resolvedPluginRoot, "local-probe.mjs"), + ], + cwd: resolvedPluginRoot, + env: { + PLUGIN_ROOT: resolvedPluginRoot, + }, + }); + } finally { + env.restore(); + } + }); }); diff --git a/src/plugins/bundle-mcp.ts b/src/plugins/bundle-mcp.ts index 62c10e59156..29bd2b3a6c9 100644 --- a/src/plugins/bundle-mcp.ts +++ b/src/plugins/bundle-mcp.ts @@ -28,12 +28,18 @@ export type EnabledBundleMcpConfigResult = { config: BundleMcpConfig; diagnostics: BundleMcpDiagnostic[]; }; +export type BundleMcpRuntimeSupport = { + hasSupportedStdioServer: boolean; + unsupportedServerNames: string[]; + diagnostics: string[]; +}; const MANIFEST_PATH_BY_FORMAT: Record = { claude: CLAUDE_BUNDLE_MANIFEST_RELATIVE_PATH, codex: CODEX_BUNDLE_MANIFEST_RELATIVE_PATH, cursor: CURSOR_BUNDLE_MANIFEST_RELATIVE_PATH, }; +const CLAUDE_PLUGIN_ROOT_PLACEHOLDER = "${CLAUDE_PLUGIN_ROOT}"; function normalizePathList(value: unknown): string[] { if (typeof value === "string") { @@ -131,36 +137,68 @@ function isExplicitRelativePath(value: string): boolean { return value === "." || value === ".." || value.startsWith("./") || value.startsWith("../"); } +function expandBundleRootPlaceholders(value: string, rootDir: string): string { + if (!value.includes(CLAUDE_PLUGIN_ROOT_PLACEHOLDER)) { + return value; + } + return value.split(CLAUDE_PLUGIN_ROOT_PLACEHOLDER).join(rootDir); +} + function absolutizeBundleMcpServer(params: { + rootDir: string; baseDir: string; server: BundleMcpServerConfig; }): BundleMcpServerConfig { const next: BundleMcpServerConfig = { ...params.server }; + if (typeof next.cwd !== "string" && typeof next.workingDirectory !== "string") { + next.cwd = params.baseDir; + } + const command = next.command; - if (typeof command === "string" && isExplicitRelativePath(command)) { - next.command = path.resolve(params.baseDir, command); + if (typeof command === "string") { + const expanded = expandBundleRootPlaceholders(command, params.rootDir); + next.command = isExplicitRelativePath(expanded) + ? path.resolve(params.baseDir, expanded) + : expanded; } const cwd = next.cwd; - if (typeof cwd === "string" && !path.isAbsolute(cwd)) { - next.cwd = path.resolve(params.baseDir, cwd); + if (typeof cwd === "string") { + const expanded = expandBundleRootPlaceholders(cwd, params.rootDir); + next.cwd = path.isAbsolute(expanded) ? expanded : path.resolve(params.baseDir, expanded); } const workingDirectory = next.workingDirectory; - if (typeof workingDirectory === "string" && !path.isAbsolute(workingDirectory)) { - next.workingDirectory = path.resolve(params.baseDir, workingDirectory); + if (typeof workingDirectory === "string") { + const expanded = expandBundleRootPlaceholders(workingDirectory, params.rootDir); + next.workingDirectory = path.isAbsolute(expanded) + ? expanded + : path.resolve(params.baseDir, expanded); } if (Array.isArray(next.args)) { next.args = next.args.map((entry) => { - if (typeof entry !== "string" || !isExplicitRelativePath(entry)) { + if (typeof entry !== "string") { return entry; } - return path.resolve(params.baseDir, entry); + const expanded = expandBundleRootPlaceholders(entry, params.rootDir); + if (!isExplicitRelativePath(expanded)) { + return expanded; + } + return path.resolve(params.baseDir, expanded); }); } + if (isRecord(next.env)) { + next.env = Object.fromEntries( + Object.entries(next.env).map(([key, value]) => [ + key, + typeof value === "string" ? expandBundleRootPlaceholders(value, params.rootDir) : value, + ]), + ); + } + return next; } @@ -190,7 +228,7 @@ function loadBundleFileBackedMcpConfig(params: { mcpServers: Object.fromEntries( Object.entries(servers).map(([serverName, server]) => [ serverName, - absolutizeBundleMcpServer({ baseDir, server }), + absolutizeBundleMcpServer({ rootDir: params.rootDir, baseDir, server }), ]), ), }; @@ -211,7 +249,7 @@ function loadBundleInlineMcpConfig(params: { mcpServers: Object.fromEntries( Object.entries(servers).map(([serverName, server]) => [ serverName, - absolutizeBundleMcpServer({ baseDir: params.baseDir, server }), + absolutizeBundleMcpServer({ rootDir: params.baseDir, baseDir: params.baseDir, server }), ]), ), }; @@ -252,13 +290,35 @@ function loadBundleMcpConfig(params: { merged, loadBundleInlineMcpConfig({ raw: manifestLoaded.raw, - baseDir: path.dirname(path.join(params.rootDir, manifestRelativePath)), + baseDir: params.rootDir, }), ) as BundleMcpConfig; return { config: merged, diagnostics: [] }; } +export function inspectBundleMcpRuntimeSupport(params: { + pluginId: string; + rootDir: string; + bundleFormat: PluginBundleFormat; +}): BundleMcpRuntimeSupport { + const loaded = loadBundleMcpConfig(params); + const unsupportedServerNames: string[] = []; + let hasSupportedStdioServer = false; + for (const [serverName, server] of Object.entries(loaded.config.mcpServers)) { + if (typeof server.command === "string" && server.command.trim().length > 0) { + hasSupportedStdioServer = true; + continue; + } + unsupportedServerNames.push(serverName); + } + return { + hasSupportedStdioServer, + unsupportedServerNames, + diagnostics: loaded.diagnostics, + }; +} + export function loadEnabledBundleMcpConfig(params: { workspaceDir: string; cfg?: OpenClawConfig; diff --git a/src/plugins/loader.test.ts b/src/plugins/loader.test.ts index 808ba4c8cb7..a1e25c0ea3e 100644 --- a/src/plugins/loader.test.ts +++ b/src/plugins/loader.test.ts @@ -420,6 +420,116 @@ describe("bundle plugins", () => { ).toBe(false); }); + it("treats bundle MCP as a supported bundle surface", () => { + const workspaceDir = makeTempDir(); + const bundleRoot = path.join(workspaceDir, ".openclaw", "extensions", "claude-mcp"); + mkdirSafe(path.join(bundleRoot, ".claude-plugin")); + fs.writeFileSync( + path.join(bundleRoot, ".claude-plugin", "plugin.json"), + JSON.stringify({ + name: "Claude MCP", + }), + "utf-8", + ); + fs.writeFileSync( + path.join(bundleRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + probe: { + command: "node", + args: ["./probe.mjs"], + }, + }, + }), + "utf-8", + ); + + const registry = loadOpenClawPlugins({ + workspaceDir, + config: { + plugins: { + entries: { + "claude-mcp": { + enabled: true, + }, + }, + }, + }, + cache: false, + }); + + const plugin = registry.plugins.find((entry) => entry.id === "claude-mcp"); + expect(plugin?.status).toBe("loaded"); + expect(plugin?.bundleFormat).toBe("claude"); + expect(plugin?.bundleCapabilities).toEqual(expect.arrayContaining(["mcpServers"])); + expect( + registry.diagnostics.some( + (diag) => + diag.pluginId === "claude-mcp" && + diag.message.includes("bundle capability detected but not wired"), + ), + ).toBe(false); + }); + + it("warns when bundle MCP only declares unsupported non-stdio transports", () => { + useNoBundledPlugins(); + const workspaceDir = makeTempDir(); + const stateDir = makeTempDir(); + const bundleRoot = path.join(workspaceDir, ".openclaw", "extensions", "claude-mcp-url"); + fs.mkdirSync(path.join(bundleRoot, ".claude-plugin"), { recursive: true }); + fs.writeFileSync( + path.join(bundleRoot, ".claude-plugin", "plugin.json"), + JSON.stringify({ + name: "Claude MCP URL", + }), + "utf-8", + ); + fs.writeFileSync( + path.join(bundleRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + remoteProbe: { + url: "http://127.0.0.1:8787/mcp", + }, + }, + }), + "utf-8", + ); + + const registry = withEnv( + { + OPENCLAW_HOME: stateDir, + OPENCLAW_STATE_DIR: stateDir, + }, + () => + loadOpenClawPlugins({ + workspaceDir, + config: { + plugins: { + entries: { + "claude-mcp-url": { + enabled: true, + }, + }, + }, + }, + cache: false, + }), + ); + + const plugin = registry.plugins.find((entry) => entry.id === "claude-mcp-url"); + expect(plugin?.status).toBe("loaded"); + expect(plugin?.bundleCapabilities).toEqual(expect.arrayContaining(["mcpServers"])); + expect( + registry.diagnostics.some( + (diag) => + diag.pluginId === "claude-mcp-url" && + diag.message.includes("stdio only today") && + diag.message.includes("remoteProbe"), + ), + ).toBe(true); + }); + it("treats Cursor command roots as supported bundle skill surfaces", () => { useNoBundledPlugins(); const workspaceDir = makeTempDir(); diff --git a/src/plugins/loader.ts b/src/plugins/loader.ts index 873fff6b9bf..86273793006 100644 --- a/src/plugins/loader.ts +++ b/src/plugins/loader.ts @@ -11,6 +11,7 @@ import { openBoundaryFileSync } from "../infra/boundary-file-read.js"; import { resolveOpenClawPackageRootSync } from "../infra/openclaw-root.js"; import { createSubsystemLogger } from "../logging/subsystem.js"; import { resolveUserPath } from "../utils.js"; +import { inspectBundleMcpRuntimeSupport } from "./bundle-mcp.js"; import { clearPluginCommands } from "./commands.js"; import { applyTestPluginDefaults, @@ -1099,6 +1100,7 @@ export function loadOpenClawPlugins(options: PluginLoadOptions = {}): PluginRegi const unsupportedCapabilities = (record.bundleCapabilities ?? []).filter( (capability) => capability !== "skills" && + capability !== "mcpServers" && capability !== "settings" && !( capability === "commands" && @@ -1114,6 +1116,36 @@ export function loadOpenClawPlugins(options: PluginLoadOptions = {}): PluginRegi message: `bundle capability detected but not wired into OpenClaw yet: ${capability}`, }); } + if ( + enableState.enabled && + record.rootDir && + record.bundleFormat && + (record.bundleCapabilities ?? []).includes("mcpServers") + ) { + const runtimeSupport = inspectBundleMcpRuntimeSupport({ + pluginId: record.id, + rootDir: record.rootDir, + bundleFormat: record.bundleFormat, + }); + for (const message of runtimeSupport.diagnostics) { + registry.diagnostics.push({ + level: "warn", + pluginId: record.id, + source: record.source, + message, + }); + } + if (runtimeSupport.unsupportedServerNames.length > 0) { + registry.diagnostics.push({ + level: "warn", + pluginId: record.id, + source: record.source, + message: + "bundle MCP servers use unsupported transports or incomplete configs " + + `(stdio only today): ${runtimeSupport.unsupportedServerNames.join(", ")}`, + }); + } + } registry.plugins.push(record); seenIds.set(pluginId, candidate.origin); continue; From ad7924b0ac14d8a08134bf857f9b2a7155a778cd Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:47:16 -0700 Subject: [PATCH 016/187] Agents: add OpenAI attribution headers (#48737) --- src/agents/openai-ws-connection.test.ts | 18 +++ src/agents/openai-ws-connection.ts | 22 +++- .../extra-params.openai.test.ts | 110 ++++++++++++++++++ src/agents/pi-embedded-runner/extra-params.ts | 10 +- .../openai-stream-wrappers.ts | 54 +++++++++ src/agents/provider-attribution.test.ts | 41 +++++-- src/agents/provider-attribution.ts | 48 +++++++- 7 files changed, 286 insertions(+), 17 deletions(-) create mode 100644 src/agents/pi-embedded-runner/extra-params.openai.test.ts diff --git a/src/agents/openai-ws-connection.test.ts b/src/agents/openai-ws-connection.test.ts index 2a7b95f7eb9..4f3f2d4e706 100644 --- a/src/agents/openai-ws-connection.test.ts +++ b/src/agents/openai-ws-connection.test.ts @@ -167,6 +167,8 @@ function buildManager(opts?: ConstructorParameters + new MockWebSocket(url, options as Record) as never, ...opts, }); } @@ -232,6 +234,22 @@ describe("OpenAIWebSocketManager", () => { await connectPromise; }); + it("adds OpenClaw attribution headers on the native OpenAI websocket", async () => { + const manager = buildManager(); + const connectPromise = manager.connect("sk-test-key"); + + const sock = lastSocket(); + expect(sock.options).toMatchObject({ + headers: expect.objectContaining({ + originator: "openclaw", + "User-Agent": expect.stringMatching(/^openclaw\//), + }), + }); + + sock.simulateOpen(); + await connectPromise; + }); + it("resolves when the connection opens", async () => { const manager = buildManager(); const connectPromise = manager.connect("sk-test"); diff --git a/src/agents/openai-ws-connection.ts b/src/agents/openai-ws-connection.ts index 2d9c6ffe7e6..1765eb00172 100644 --- a/src/agents/openai-ws-connection.ts +++ b/src/agents/openai-ws-connection.ts @@ -15,6 +15,7 @@ import { EventEmitter } from "node:events"; import WebSocket from "ws"; +import { resolveProviderAttributionHeaders } from "./provider-attribution.js"; // ───────────────────────────────────────────────────────────────────────────── // WebSocket Event Types (Server → Client) @@ -251,6 +252,14 @@ const MAX_RETRIES = 5; /** Backoff delays in ms: 1s, 2s, 4s, 8s, 16s */ const BACKOFF_DELAYS_MS = [1000, 2000, 4000, 8000, 16000] as const; +function isOpenAIPublicWebSocketUrl(url: string): boolean { + try { + return new URL(url).hostname.toLowerCase() === "api.openai.com"; + } catch { + return url.toLowerCase().includes("api.openai.com"); + } +} + export interface OpenAIWebSocketManagerOptions { /** Override the default WebSocket URL (useful for testing) */ url?: string; @@ -258,6 +267,8 @@ export interface OpenAIWebSocketManagerOptions { maxRetries?: number; /** Custom backoff delays in ms (default: [1000, 2000, 4000, 8000, 16000]) */ backoffDelaysMs?: readonly number[]; + /** Custom socket factory for tests. */ + socketFactory?: (url: string, options: ConstructorParameters[1]) => WebSocket; } type InternalEvents = { @@ -297,12 +308,18 @@ export class OpenAIWebSocketManager extends EventEmitter { private readonly wsUrl: string; private readonly maxRetries: number; private readonly backoffDelaysMs: readonly number[]; + private readonly socketFactory: ( + url: string, + options: ConstructorParameters[1], + ) => WebSocket; constructor(options: OpenAIWebSocketManagerOptions = {}) { super(); this.wsUrl = options.url ?? OPENAI_WS_URL; this.maxRetries = options.maxRetries ?? MAX_RETRIES; this.backoffDelaysMs = options.backoffDelaysMs ?? BACKOFF_DELAYS_MS; + this.socketFactory = + options.socketFactory ?? ((url, socketOptions) => new WebSocket(url, socketOptions)); } // ─── Public API ──────────────────────────────────────────────────────────── @@ -382,10 +399,13 @@ export class OpenAIWebSocketManager extends EventEmitter { return; } - const socket = new WebSocket(this.wsUrl, { + const socket = this.socketFactory(this.wsUrl, { headers: { Authorization: `Bearer ${this.apiKey}`, "OpenAI-Beta": "responses-websocket=v1", + ...(isOpenAIPublicWebSocketUrl(this.wsUrl) + ? resolveProviderAttributionHeaders("openai") + : undefined), }, }); diff --git a/src/agents/pi-embedded-runner/extra-params.openai.test.ts b/src/agents/pi-embedded-runner/extra-params.openai.test.ts new file mode 100644 index 00000000000..92e26c95ee0 --- /dev/null +++ b/src/agents/pi-embedded-runner/extra-params.openai.test.ts @@ -0,0 +1,110 @@ +import type { StreamFn } from "@mariozechner/pi-agent-core"; +import type { Context, Model } from "@mariozechner/pi-ai"; +import { createAssistantMessageEventStream } from "@mariozechner/pi-ai"; +import { afterEach, describe, expect, it } from "vitest"; +import { captureEnv } from "../../test-utils/env.js"; +import { applyExtraParamsToAgent } from "./extra-params.js"; + +type CapturedCall = { + headers?: Record; +}; + +function applyAndCapture(params: { + provider: string; + modelId: string; + baseUrl?: string; + callerHeaders?: Record; +}): CapturedCall { + const captured: CapturedCall = {}; + const baseStreamFn: StreamFn = (model, _context, options) => { + captured.headers = options?.headers; + options?.onPayload?.({}, model); + return createAssistantMessageEventStream(); + }; + const agent = { streamFn: baseStreamFn }; + + applyExtraParamsToAgent(agent, undefined, params.provider, params.modelId); + + const model = { + api: "openai-responses", + provider: params.provider, + id: params.modelId, + baseUrl: params.baseUrl, + } as Model<"openai-responses">; + const context: Context = { messages: [] }; + + void agent.streamFn?.(model, context, { headers: params.callerHeaders }); + + return captured; +} + +describe("extra-params: OpenAI attribution", () => { + const envSnapshot = captureEnv(["OPENCLAW_VERSION"]); + + afterEach(() => { + envSnapshot.restore(); + }); + + it("injects originator and release-based user agent for native OpenAI", () => { + process.env.OPENCLAW_VERSION = "2026.3.14"; + + const { headers } = applyAndCapture({ + provider: "openai", + modelId: "gpt-5.4", + baseUrl: "https://api.openai.com/v1", + }); + + expect(headers).toEqual({ + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + }); + }); + + it("overrides caller-supplied OpenAI attribution headers", () => { + process.env.OPENCLAW_VERSION = "2026.3.14"; + + const { headers } = applyAndCapture({ + provider: "openai", + modelId: "gpt-5.4", + baseUrl: "https://api.openai.com/v1", + callerHeaders: { + originator: "spoofed", + "User-Agent": "spoofed/0.0.0", + "X-Custom": "1", + }, + }); + + expect(headers).toEqual({ + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + "X-Custom": "1", + }); + }); + + it("does not inject attribution on non-native OpenAI-compatible base URLs", () => { + process.env.OPENCLAW_VERSION = "2026.3.14"; + + const { headers } = applyAndCapture({ + provider: "openai", + modelId: "gpt-5.4", + baseUrl: "https://proxy.example.com/v1", + }); + + expect(headers).toBeUndefined(); + }); + + it("injects attribution for ChatGPT-backed OpenAI Codex traffic", () => { + process.env.OPENCLAW_VERSION = "2026.3.14"; + + const { headers } = applyAndCapture({ + provider: "openai-codex", + modelId: "gpt-5.4", + baseUrl: "https://chatgpt.com/backend-api", + }); + + expect(headers).toEqual({ + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + }); + }); +}); diff --git a/src/agents/pi-embedded-runner/extra-params.ts b/src/agents/pi-embedded-runner/extra-params.ts index 7a73280802c..e3aa8b1dbcc 100644 --- a/src/agents/pi-embedded-runner/extra-params.ts +++ b/src/agents/pi-embedded-runner/extra-params.ts @@ -26,6 +26,7 @@ import { shouldApplySiliconFlowThinkingOffCompat, } from "./moonshot-stream-wrappers.js"; import { + createOpenAIAttributionHeadersWrapper, createOpenAIDefaultTransportWrapper, createOpenAIFastModeWrapper, createOpenAIResponsesContextManagementWrapper, @@ -303,9 +304,12 @@ export function applyExtraParamsToAgent( }, }) ?? merged; - if (provider === "openai") { - // Default OpenAI Responses to WebSocket-first with transparent SSE fallback. - agent.streamFn = createOpenAIDefaultTransportWrapper(agent.streamFn); + if (provider === "openai" || provider === "openai-codex") { + if (provider === "openai") { + // Default OpenAI Responses to WebSocket-first with transparent SSE fallback. + agent.streamFn = createOpenAIDefaultTransportWrapper(agent.streamFn); + } + agent.streamFn = createOpenAIAttributionHeadersWrapper(agent.streamFn); } const wrappedStreamFn = createStreamFnWithExtraParams( agent.streamFn, diff --git a/src/agents/pi-embedded-runner/openai-stream-wrappers.ts b/src/agents/pi-embedded-runner/openai-stream-wrappers.ts index 8542f329cbe..4131a33f08d 100644 --- a/src/agents/pi-embedded-runner/openai-stream-wrappers.ts +++ b/src/agents/pi-embedded-runner/openai-stream-wrappers.ts @@ -1,6 +1,7 @@ import type { StreamFn } from "@mariozechner/pi-agent-core"; import type { SimpleStreamOptions } from "@mariozechner/pi-ai"; import { streamSimple } from "@mariozechner/pi-ai"; +import { resolveProviderAttributionHeaders } from "../provider-attribution.js"; import { log } from "./logger.js"; import { streamWithPayloadPatch } from "./stream-payload-utils.js"; @@ -42,6 +43,40 @@ function isOpenAIPublicApiBaseUrl(baseUrl: unknown): boolean { } } +function isOpenAICodexBaseUrl(baseUrl: unknown): boolean { + if (typeof baseUrl !== "string" || !baseUrl.trim()) { + return false; + } + + try { + return new URL(baseUrl).hostname.toLowerCase() === "chatgpt.com"; + } catch { + return baseUrl.toLowerCase().includes("chatgpt.com"); + } +} + +function shouldApplyOpenAIAttributionHeaders(model: { + api?: unknown; + provider?: unknown; + baseUrl?: unknown; +}): "openai" | "openai-codex" | undefined { + if ( + model.provider === "openai" && + (model.api === "openai-completions" || model.api === "openai-responses") && + isOpenAIPublicApiBaseUrl(model.baseUrl) + ) { + return "openai"; + } + if ( + model.provider === "openai-codex" && + (model.api === "openai-codex-responses" || model.api === "openai-responses") && + isOpenAICodexBaseUrl(model.baseUrl) + ) { + return "openai-codex"; + } + return undefined; +} + function shouldForceResponsesStore(model: { api?: unknown; provider?: unknown; @@ -357,3 +392,22 @@ export function createOpenAIDefaultTransportWrapper(baseStreamFn: StreamFn | und return underlying(model, context, mergedOptions); }; } + +export function createOpenAIAttributionHeadersWrapper( + baseStreamFn: StreamFn | undefined, +): StreamFn { + const underlying = baseStreamFn ?? streamSimple; + return (model, context, options) => { + const attributionProvider = shouldApplyOpenAIAttributionHeaders(model); + if (!attributionProvider) { + return underlying(model, context, options); + } + return underlying(model, context, { + ...options, + headers: { + ...options?.headers, + ...resolveProviderAttributionHeaders(attributionProvider), + }, + }); + }; +} diff --git a/src/agents/provider-attribution.test.ts b/src/agents/provider-attribution.test.ts index 693e165ba21..04c7d040b17 100644 --- a/src/agents/provider-attribution.test.ts +++ b/src/agents/provider-attribution.test.ts @@ -52,18 +52,44 @@ describe("provider attribution", () => { }); }); - it("tracks SDK-hook-only providers without enabling them", () => { + it("returns a hidden-spec OpenAI attribution policy", () => { expect(resolveProviderAttributionPolicy("openai", { OPENCLAW_VERSION: "2026.3.14" })).toEqual({ provider: "openai", - enabledByDefault: false, - verification: "vendor-sdk-hook-only", - hook: "default-headers", + enabledByDefault: true, + verification: "vendor-hidden-api-spec", + hook: "request-headers", reviewNote: - "OpenAI JS SDK exposes defaultHeaders, but public app attribution support is not yet verified.", + "OpenAI native traffic supports hidden originator/User-Agent attribution. Verified against the Codex wire contract.", product: "OpenClaw", version: "2026.3.14", + headers: { + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + }, + }); + expect(resolveProviderAttributionHeaders("openai", { OPENCLAW_VERSION: "2026.3.14" })).toEqual({ + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + }); + }); + + it("returns a hidden-spec OpenAI Codex attribution policy", () => { + expect( + resolveProviderAttributionPolicy("openai-codex", { OPENCLAW_VERSION: "2026.3.14" }), + ).toEqual({ + provider: "openai-codex", + enabledByDefault: true, + verification: "vendor-hidden-api-spec", + hook: "request-headers", + reviewNote: + "OpenAI Codex ChatGPT-backed traffic supports the same hidden originator/User-Agent attribution contract.", + product: "OpenClaw", + version: "2026.3.14", + headers: { + originator: "openclaw", + "User-Agent": "openclaw/2026.3.14", + }, }); - expect(resolveProviderAttributionHeaders("openai")).toBeUndefined(); }); it("lists the current attribution support matrix", () => { @@ -76,11 +102,12 @@ describe("provider attribution", () => { ]), ).toEqual([ ["openrouter", true, "vendor-documented", "request-headers"], + ["openai", true, "vendor-hidden-api-spec", "request-headers"], + ["openai-codex", true, "vendor-hidden-api-spec", "request-headers"], ["anthropic", false, "vendor-sdk-hook-only", "default-headers"], ["google", false, "vendor-sdk-hook-only", "user-agent-extra"], ["groq", false, "vendor-sdk-hook-only", "default-headers"], ["mistral", false, "vendor-sdk-hook-only", "custom-user-agent"], - ["openai", false, "vendor-sdk-hook-only", "default-headers"], ["together", false, "vendor-sdk-hook-only", "default-headers"], ]); }); diff --git a/src/agents/provider-attribution.ts b/src/agents/provider-attribution.ts index 52fe5c8d4c7..f1111a8e5bd 100644 --- a/src/agents/provider-attribution.ts +++ b/src/agents/provider-attribution.ts @@ -4,6 +4,7 @@ import { normalizeProviderId } from "./model-selection.js"; export type ProviderAttributionVerification = | "vendor-documented" + | "vendor-hidden-api-spec" | "vendor-sdk-hook-only" | "internal-runtime"; @@ -28,6 +29,7 @@ export type ProviderAttributionPolicy = { export type ProviderAttributionIdentity = Pick; const OPENCLAW_ATTRIBUTION_PRODUCT = "OpenClaw"; +const OPENCLAW_ATTRIBUTION_ORIGINATOR = "openclaw"; export function resolveProviderAttributionIdentity( env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, @@ -58,6 +60,44 @@ function buildOpenRouterAttributionPolicy( }; } +function buildOpenAIAttributionPolicy( + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy { + const identity = resolveProviderAttributionIdentity(env); + return { + provider: "openai", + enabledByDefault: true, + verification: "vendor-hidden-api-spec", + hook: "request-headers", + reviewNote: + "OpenAI native traffic supports hidden originator/User-Agent attribution. Verified against the Codex wire contract.", + ...identity, + headers: { + originator: OPENCLAW_ATTRIBUTION_ORIGINATOR, + "User-Agent": `${OPENCLAW_ATTRIBUTION_ORIGINATOR}/${identity.version}`, + }, + }; +} + +function buildOpenAICodexAttributionPolicy( + env: RuntimeVersionEnv = process.env as RuntimeVersionEnv, +): ProviderAttributionPolicy { + const identity = resolveProviderAttributionIdentity(env); + return { + provider: "openai-codex", + enabledByDefault: true, + verification: "vendor-hidden-api-spec", + hook: "request-headers", + reviewNote: + "OpenAI Codex ChatGPT-backed traffic supports the same hidden originator/User-Agent attribution contract.", + ...identity, + headers: { + originator: OPENCLAW_ATTRIBUTION_ORIGINATOR, + "User-Agent": `${OPENCLAW_ATTRIBUTION_ORIGINATOR}/${identity.version}`, + }, + }; +} + function buildSdkHookOnlyPolicy( provider: string, hook: ProviderAttributionHook, @@ -79,6 +119,8 @@ export function listProviderAttributionPolicies( ): ProviderAttributionPolicy[] { return [ buildOpenRouterAttributionPolicy(env), + buildOpenAIAttributionPolicy(env), + buildOpenAICodexAttributionPolicy(env), buildSdkHookOnlyPolicy( "anthropic", "default-headers", @@ -103,12 +145,6 @@ export function listProviderAttributionPolicies( "Mistral JS SDK exposes a custom userAgent option, but app attribution is not yet verified.", env, ), - buildSdkHookOnlyPolicy( - "openai", - "default-headers", - "OpenAI JS SDK exposes defaultHeaders, but public app attribution support is not yet verified.", - env, - ), buildSdkHookOnlyPolicy( "together", "default-headers", From dde89d2a834af2ccf9429d5ee9cbcaeee18a559d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:47:21 -0700 Subject: [PATCH 017/187] refactor: isolate provider sdk auth and model helpers --- extensions/whatsapp/src/channel.ts | 4 - src/channels/plugins/setup-wizard-helpers.ts | 8 +- src/commands/auth-choice.api-key.ts | 53 +- src/commands/auth-choice.apply-helpers.ts | 464 +--------------- .../auth-choice.apply.plugin-provider.ts | 8 +- src/commands/auth-token.ts | 46 +- src/commands/google-gemini-model-default.ts | 15 +- src/commands/model-allowlist.ts | 42 +- src/commands/model-default.ts | 49 +- src/commands/model-picker.ts | 30 +- src/commands/oauth-flow.ts | 54 +- src/commands/oauth-tls-preflight.ts | 165 +----- .../local/auth-choice.plugin-providers.ts | 3 +- src/commands/onboard-types.ts | 3 +- src/commands/openai-codex-oauth.ts | 66 +-- src/commands/openai-model-default.ts | 52 +- src/commands/opencode-go-model-default.ts | 15 +- src/commands/opencode-zen-model-default.ts | 23 +- src/commands/self-hosted-provider-setup.ts | 12 +- src/plugin-sdk/provider-auth.ts | 11 +- src/plugin-sdk/provider-models.ts | 8 +- src/plugin-sdk/provider-onboard.ts | 2 +- src/plugins/provider-api-key-auth.runtime.ts | 9 +- src/plugins/provider-auth-helpers.ts | 2 +- src/plugins/provider-auth-input.ts | 496 ++++++++++++++++++ src/plugins/provider-auth-token.ts | 38 ++ src/plugins/provider-auth-types.ts | 1 + src/plugins/provider-model-allowlist.ts | 41 ++ src/plugins/provider-model-defaults.ts | 81 +++ src/plugins/provider-model-primary.ts | 72 +++ src/plugins/provider-oauth-flow.ts | 53 ++ .../provider-openai-codex-oauth-tls.ts | 164 ++++++ src/plugins/provider-openai-codex-oauth.ts | 65 +++ src/plugins/types.ts | 17 +- src/wizard/setup.gateway-config.ts | 8 +- 35 files changed, 1118 insertions(+), 1062 deletions(-) create mode 100644 src/plugins/provider-auth-input.ts create mode 100644 src/plugins/provider-auth-token.ts create mode 100644 src/plugins/provider-auth-types.ts create mode 100644 src/plugins/provider-model-allowlist.ts create mode 100644 src/plugins/provider-model-defaults.ts create mode 100644 src/plugins/provider-model-primary.ts create mode 100644 src/plugins/provider-oauth-flow.ts create mode 100644 src/plugins/provider-openai-codex-oauth-tls.ts create mode 100644 src/plugins/provider-openai-codex-oauth.ts diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 63d222ba1ed..dda6215c27f 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -41,10 +41,6 @@ import { collectWhatsAppStatusIssues } from "./status-issues.js"; const meta = getChatChannelMeta("whatsapp"); -async function loadWhatsAppChannelRuntime() { - return await import("./channel.runtime.js"); -} - function normalizeWhatsAppPayloadText(text: string | undefined): string { return (text ?? "").replace(/^(?:[ \t]*\r?\n)+/, ""); } diff --git a/src/channels/plugins/setup-wizard-helpers.ts b/src/channels/plugins/setup-wizard-helpers.ts index de513f64d27..c80a00dd324 100644 --- a/src/channels/plugins/setup-wizard-helpers.ts +++ b/src/channels/plugins/setup-wizard-helpers.ts @@ -1,10 +1,10 @@ -import { - promptSecretRefForSetup, - resolveSecretInputModeForEnvSelection, -} from "../../commands/auth-choice.apply-helpers.js"; import type { OpenClawConfig } from "../../config/config.js"; import type { DmPolicy, GroupPolicy } from "../../config/types.js"; import type { SecretInput } from "../../config/types.secrets.js"; +import { + promptSecretRefForSetup, + resolveSecretInputModeForEnvSelection, +} from "../../plugins/provider-auth-input.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../routing/session-key.js"; import type { WizardPrompter } from "../../wizard/prompts.js"; import { diff --git a/src/commands/auth-choice.api-key.ts b/src/commands/auth-choice.api-key.ts index 59a7ca08e6f..ae5e716a46f 100644 --- a/src/commands/auth-choice.api-key.ts +++ b/src/commands/auth-choice.api-key.ts @@ -1,48 +1,5 @@ -const DEFAULT_KEY_PREVIEW = { head: 4, tail: 4 }; - -export function normalizeApiKeyInput(raw: string): string { - const trimmed = String(raw ?? "").trim(); - if (!trimmed) { - return ""; - } - - // Handle shell-style assignments: export KEY="value" or KEY=value - const assignmentMatch = trimmed.match(/^(?:export\s+)?[A-Za-z_][A-Za-z0-9_]*\s*=\s*(.+)$/); - const valuePart = assignmentMatch ? assignmentMatch[1].trim() : trimmed; - - const unquoted = - valuePart.length >= 2 && - ((valuePart.startsWith('"') && valuePart.endsWith('"')) || - (valuePart.startsWith("'") && valuePart.endsWith("'")) || - (valuePart.startsWith("`") && valuePart.endsWith("`"))) - ? valuePart.slice(1, -1) - : valuePart; - - const withoutSemicolon = unquoted.endsWith(";") ? unquoted.slice(0, -1) : unquoted; - - return withoutSemicolon.trim(); -} - -export const validateApiKeyInput = (value: string) => - normalizeApiKeyInput(value).length > 0 ? undefined : "Required"; - -export function formatApiKeyPreview( - raw: string, - opts: { head?: number; tail?: number } = {}, -): string { - const trimmed = raw.trim(); - if (!trimmed) { - return "…"; - } - const head = opts.head ?? DEFAULT_KEY_PREVIEW.head; - const tail = opts.tail ?? DEFAULT_KEY_PREVIEW.tail; - if (trimmed.length <= head + tail) { - const shortHead = Math.min(2, trimmed.length); - const shortTail = Math.min(2, trimmed.length - shortHead); - if (shortTail <= 0) { - return `${trimmed.slice(0, shortHead)}…`; - } - return `${trimmed.slice(0, shortHead)}…${trimmed.slice(-shortTail)}`; - } - return `${trimmed.slice(0, head)}…${trimmed.slice(-tail)}`; -} +export { + formatApiKeyPreview, + normalizeApiKeyInput, + validateApiKeyInput, +} from "../plugins/provider-auth-input.js"; diff --git a/src/commands/auth-choice.apply-helpers.ts b/src/commands/auth-choice.apply-helpers.ts index 7029dd081c3..b123f50f99c 100644 --- a/src/commands/auth-choice.apply-helpers.ts +++ b/src/commands/auth-choice.apply-helpers.ts @@ -1,280 +1,19 @@ -import { resolveEnvApiKey } from "../agents/model-auth.js"; -import type { OpenClawConfig } from "../config/types.js"; -import { - isValidEnvSecretRefId, - type SecretInput, - type SecretRef, -} from "../config/types.secrets.js"; -import { encodeJsonPointerToken } from "../secrets/json-pointer.js"; -import { PROVIDER_ENV_VARS } from "../secrets/provider-env-vars.js"; -import { - formatExecSecretRefIdValidationMessage, - isValidExecSecretRefId, - isValidFileSecretRefId, - resolveDefaultSecretProviderAlias, -} from "../secrets/ref-contract.js"; -import { resolveSecretRefString } from "../secrets/resolve.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; -import { formatApiKeyPreview } from "./auth-choice.api-key.js"; import type { ApplyAuthChoiceParams } from "./auth-choice.apply.js"; import { applyDefaultModelChoice } from "./auth-choice.default-model.js"; -import type { SecretInputMode } from "./onboard-types.js"; -const ENV_SOURCE_LABEL_RE = /(?:^|:\s)([A-Z][A-Z0-9_]*)$/; - -type SecretRefChoice = "env" | "provider"; // pragma: allowlist secret - -export type SecretInputModePromptCopy = { - modeMessage?: string; - plaintextLabel?: string; - plaintextHint?: string; - refLabel?: string; - refHint?: string; -}; - -export type SecretRefSetupPromptCopy = { - sourceMessage?: string; - envVarMessage?: string; - envVarPlaceholder?: string; - envVarFormatError?: string; - envVarMissingError?: (envVar: string) => string; - noProvidersMessage?: string; - envValidatedMessage?: (envVar: string) => string; - providerValidatedMessage?: (provider: string, id: string, source: "file" | "exec") => string; -}; - -function formatErrorMessage(error: unknown): string { - if (error instanceof Error && typeof error.message === "string" && error.message.trim()) { - return error.message; - } - return String(error); -} - -function extractEnvVarFromSourceLabel(source: string): string | undefined { - const match = ENV_SOURCE_LABEL_RE.exec(source.trim()); - return match?.[1]; -} - -function resolveDefaultProviderEnvVar(provider: string): string | undefined { - const envVars = PROVIDER_ENV_VARS[provider]; - return envVars?.find((candidate) => candidate.trim().length > 0); -} - -function resolveDefaultFilePointerId(provider: string): string { - return `/providers/${encodeJsonPointerToken(provider)}/apiKey`; -} - -function resolveRefFallbackInput(params: { - config: OpenClawConfig; - provider: string; - preferredEnvVar?: string; -}): { ref: SecretRef; resolvedValue: string } { - const fallbackEnvVar = params.preferredEnvVar ?? resolveDefaultProviderEnvVar(params.provider); - if (!fallbackEnvVar) { - throw new Error( - `No default environment variable mapping found for provider "${params.provider}". Set a provider-specific env var, or re-run setup in an interactive terminal to configure a ref.`, - ); - } - const value = process.env[fallbackEnvVar]?.trim(); - if (!value) { - throw new Error( - `Environment variable "${fallbackEnvVar}" is required for --secret-input-mode ref in non-interactive setup.`, - ); - } - return { - ref: { - source: "env", - provider: resolveDefaultSecretProviderAlias(params.config, "env", { - preferFirstProviderForSource: true, - }), - id: fallbackEnvVar, - }, - resolvedValue: value, - }; -} - -export async function promptSecretRefForSetup(params: { - provider: string; - config: OpenClawConfig; - prompter: WizardPrompter; - preferredEnvVar?: string; - copy?: SecretRefSetupPromptCopy; -}): Promise<{ ref: SecretRef; resolvedValue: string }> { - const defaultEnvVar = - params.preferredEnvVar ?? resolveDefaultProviderEnvVar(params.provider) ?? ""; - const defaultFilePointer = resolveDefaultFilePointerId(params.provider); - let sourceChoice: SecretRefChoice = "env"; // pragma: allowlist secret - - while (true) { - const sourceRaw: SecretRefChoice = await params.prompter.select({ - message: params.copy?.sourceMessage ?? "Where is this API key stored?", - initialValue: sourceChoice, - options: [ - { - value: "env", - label: "Environment variable", - hint: "Reference a variable from your runtime environment", - }, - { - value: "provider", - label: "Configured secret provider", - hint: "Use a configured file or exec secret provider", - }, - ], - }); - const source: SecretRefChoice = sourceRaw === "provider" ? "provider" : "env"; - sourceChoice = source; - - if (source === "env") { - const envVarRaw = await params.prompter.text({ - message: params.copy?.envVarMessage ?? "Environment variable name", - initialValue: defaultEnvVar || undefined, - placeholder: params.copy?.envVarPlaceholder ?? "OPENAI_API_KEY", - validate: (value) => { - const candidate = value.trim(); - if (!isValidEnvSecretRefId(candidate)) { - return ( - params.copy?.envVarFormatError ?? - 'Use an env var name like "OPENAI_API_KEY" (uppercase letters, numbers, underscores).' - ); - } - if (!process.env[candidate]?.trim()) { - return ( - params.copy?.envVarMissingError?.(candidate) ?? - `Environment variable "${candidate}" is missing or empty in this session.` - ); - } - return undefined; - }, - }); - const envCandidate = String(envVarRaw ?? "").trim(); - const envVar = - envCandidate && isValidEnvSecretRefId(envCandidate) ? envCandidate : defaultEnvVar; - if (!envVar) { - throw new Error( - `No valid environment variable name provided for provider "${params.provider}".`, - ); - } - const ref: SecretRef = { - source: "env", - provider: resolveDefaultSecretProviderAlias(params.config, "env", { - preferFirstProviderForSource: true, - }), - id: envVar, - }; - const resolvedValue = await resolveSecretRefString(ref, { - config: params.config, - env: process.env, - }); - await params.prompter.note( - params.copy?.envValidatedMessage?.(envVar) ?? - `Validated environment variable ${envVar}. OpenClaw will store a reference, not the key value.`, - "Reference validated", - ); - return { ref, resolvedValue }; - } - - const externalProviders = Object.entries(params.config.secrets?.providers ?? {}).filter( - ([, provider]) => provider?.source === "file" || provider?.source === "exec", - ); - if (externalProviders.length === 0) { - await params.prompter.note( - params.copy?.noProvidersMessage ?? - "No file/exec secret providers are configured yet. Add one under secrets.providers, or select Environment variable.", - "No providers configured", - ); - continue; - } - const defaultProvider = resolveDefaultSecretProviderAlias(params.config, "file", { - preferFirstProviderForSource: true, - }); - const selectedProvider = await params.prompter.select({ - message: "Select secret provider", - initialValue: - externalProviders.find(([providerName]) => providerName === defaultProvider)?.[0] ?? - externalProviders[0]?.[0], - options: externalProviders.map(([providerName, provider]) => ({ - value: providerName, - label: providerName, - hint: provider?.source === "exec" ? "Exec provider" : "File provider", - })), - }); - const providerEntry = params.config.secrets?.providers?.[selectedProvider]; - if (!providerEntry || (providerEntry.source !== "file" && providerEntry.source !== "exec")) { - await params.prompter.note( - `Provider "${selectedProvider}" is not a file/exec provider.`, - "Invalid provider", - ); - continue; - } - const idPrompt = - providerEntry.source === "file" - ? "Secret id (JSON pointer for json mode, or 'value' for singleValue mode)" - : "Secret id for the exec provider"; - const idDefault = - providerEntry.source === "file" - ? providerEntry.mode === "singleValue" - ? "value" - : defaultFilePointer - : `${params.provider}/apiKey`; - const idRaw = await params.prompter.text({ - message: idPrompt, - initialValue: idDefault, - placeholder: providerEntry.source === "file" ? "/providers/openai/apiKey" : "openai/api-key", - validate: (value) => { - const candidate = value.trim(); - if (!candidate) { - return "Secret id cannot be empty."; - } - if ( - providerEntry.source === "file" && - providerEntry.mode !== "singleValue" && - !isValidFileSecretRefId(candidate) - ) { - return 'Use an absolute JSON pointer like "/providers/openai/apiKey".'; - } - if ( - providerEntry.source === "file" && - providerEntry.mode === "singleValue" && - candidate !== "value" - ) { - return 'singleValue mode expects id "value".'; - } - if (providerEntry.source === "exec" && !isValidExecSecretRefId(candidate)) { - return formatExecSecretRefIdValidationMessage(); - } - return undefined; - }, - }); - const id = String(idRaw ?? "").trim() || idDefault; - const ref: SecretRef = { - source: providerEntry.source, - provider: selectedProvider, - id, - }; - try { - const resolvedValue = await resolveSecretRefString(ref, { - config: params.config, - env: process.env, - }); - await params.prompter.note( - params.copy?.providerValidatedMessage?.(selectedProvider, id, providerEntry.source) ?? - `Validated ${providerEntry.source} reference ${selectedProvider}:${id}. OpenClaw will store a reference, not the key value.`, - "Reference validated", - ); - return { ref, resolvedValue }; - } catch (error) { - await params.prompter.note( - [ - `Could not validate provider reference ${selectedProvider}:${id}.`, - formatErrorMessage(error), - "Check your provider configuration and try again.", - ].join("\n"), - "Reference check failed", - ); - } - } -} +export type { + SecretInputModePromptCopy, + SecretRefSetupPromptCopy, +} from "../plugins/provider-auth-input.js"; +export { + ensureApiKeyFromEnvOrPrompt, + ensureApiKeyFromOptionEnvOrPrompt, + maybeApplyApiKeyFromOption, + normalizeSecretInputModeInput, + normalizeTokenProviderInput, + promptSecretRefForSetup, + resolveSecretInputModeForEnvSelection, +} from "../plugins/provider-auth-input.js"; export function createAuthChoiceAgentModelNoter( params: ApplyAuthChoiceParams, @@ -358,180 +97,3 @@ export function createAuthChoiceDefaultModelApplierForMutableState( }), ); } - -export function normalizeTokenProviderInput( - tokenProvider: string | null | undefined, -): string | undefined { - const normalized = String(tokenProvider ?? "") - .trim() - .toLowerCase(); - return normalized || undefined; -} - -export function normalizeSecretInputModeInput( - secretInputMode: string | null | undefined, -): SecretInputMode | undefined { - const normalized = String(secretInputMode ?? "") - .trim() - .toLowerCase(); - if (normalized === "plaintext" || normalized === "ref") { - return normalized; - } - return undefined; -} - -export async function resolveSecretInputModeForEnvSelection(params: { - prompter: WizardPrompter; - explicitMode?: SecretInputMode; - copy?: SecretInputModePromptCopy; -}): Promise { - if (params.explicitMode) { - return params.explicitMode; - } - // Some tests pass partial prompt harnesses without a select implementation. - // Preserve backward-compatible behavior by defaulting to plaintext in that case. - if (typeof params.prompter.select !== "function") { - return "plaintext"; - } - const selected = await params.prompter.select({ - message: params.copy?.modeMessage ?? "How do you want to provide this API key?", - initialValue: "plaintext", - options: [ - { - value: "plaintext", - label: params.copy?.plaintextLabel ?? "Paste API key now", - hint: params.copy?.plaintextHint ?? "Stores the key directly in OpenClaw config", - }, - { - value: "ref", - label: params.copy?.refLabel ?? "Use external secret provider", - hint: - params.copy?.refHint ?? - "Stores a reference to env or configured external secret providers", - }, - ], - }); - return selected === "ref" ? "ref" : "plaintext"; -} - -export async function maybeApplyApiKeyFromOption(params: { - token: string | undefined; - tokenProvider: string | undefined; - secretInputMode?: SecretInputMode; - expectedProviders: string[]; - normalize: (value: string) => string; - setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; -}): Promise { - const tokenProvider = normalizeTokenProviderInput(params.tokenProvider); - const expectedProviders = params.expectedProviders - .map((provider) => normalizeTokenProviderInput(provider)) - .filter((provider): provider is string => Boolean(provider)); - if (!params.token || !tokenProvider || !expectedProviders.includes(tokenProvider)) { - return undefined; - } - const apiKey = params.normalize(params.token); - await params.setCredential(apiKey, params.secretInputMode); - return apiKey; -} - -export async function ensureApiKeyFromOptionEnvOrPrompt(params: { - token: string | undefined; - tokenProvider: string | undefined; - secretInputMode?: SecretInputMode; - config: OpenClawConfig; - expectedProviders: string[]; - provider: string; - envLabel: string; - promptMessage: string; - normalize: (value: string) => string; - validate: (value: string) => string | undefined; - prompter: WizardPrompter; - setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; - noteMessage?: string; - noteTitle?: string; -}): Promise { - const optionApiKey = await maybeApplyApiKeyFromOption({ - token: params.token, - tokenProvider: params.tokenProvider, - secretInputMode: params.secretInputMode, - expectedProviders: params.expectedProviders, - normalize: params.normalize, - setCredential: params.setCredential, - }); - if (optionApiKey) { - return optionApiKey; - } - - if (params.noteMessage) { - await params.prompter.note(params.noteMessage, params.noteTitle); - } - - return await ensureApiKeyFromEnvOrPrompt({ - config: params.config, - provider: params.provider, - envLabel: params.envLabel, - promptMessage: params.promptMessage, - normalize: params.normalize, - validate: params.validate, - prompter: params.prompter, - secretInputMode: params.secretInputMode, - setCredential: params.setCredential, - }); -} - -export async function ensureApiKeyFromEnvOrPrompt(params: { - config: OpenClawConfig; - provider: string; - envLabel: string; - promptMessage: string; - normalize: (value: string) => string; - validate: (value: string) => string | undefined; - prompter: WizardPrompter; - secretInputMode?: SecretInputMode; - setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; -}): Promise { - const selectedMode = await resolveSecretInputModeForEnvSelection({ - prompter: params.prompter, - explicitMode: params.secretInputMode, - }); - const envKey = resolveEnvApiKey(params.provider); - - if (selectedMode === "ref") { - if (typeof params.prompter.select !== "function") { - const fallback = resolveRefFallbackInput({ - config: params.config, - provider: params.provider, - preferredEnvVar: envKey?.source ? extractEnvVarFromSourceLabel(envKey.source) : undefined, - }); - await params.setCredential(fallback.ref, selectedMode); - return fallback.resolvedValue; - } - const resolved = await promptSecretRefForSetup({ - provider: params.provider, - config: params.config, - prompter: params.prompter, - preferredEnvVar: envKey?.source ? extractEnvVarFromSourceLabel(envKey.source) : undefined, - }); - await params.setCredential(resolved.ref, selectedMode); - return resolved.resolvedValue; - } - - if (envKey && selectedMode === "plaintext") { - const useExisting = await params.prompter.confirm({ - message: `Use existing ${params.envLabel} (${envKey.source}, ${formatApiKeyPreview(envKey.apiKey)})?`, - initialValue: true, - }); - if (useExisting) { - await params.setCredential(envKey.apiKey, selectedMode); - return envKey.apiKey; - } - } - - const key = await params.prompter.text({ - message: params.promptMessage, - validate: params.validate, - }); - const apiKey = params.normalize(String(key ?? "")); - await params.setCredential(apiKey, selectedMode); - return apiKey; -} diff --git a/src/commands/auth-choice.apply.plugin-provider.ts b/src/commands/auth-choice.apply.plugin-provider.ts index afdad97ecec..ce459020039 100644 --- a/src/commands/auth-choice.apply.plugin-provider.ts +++ b/src/commands/auth-choice.apply.plugin-provider.ts @@ -8,7 +8,7 @@ import { upsertAuthProfile } from "../agents/auth-profiles.js"; import { resolveDefaultAgentWorkspaceDir } from "../agents/workspace.js"; import { enablePluginInConfig } from "../plugins/enable.js"; import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; -import type { ProviderAuthMethod } from "../plugins/types.js"; +import type { ProviderAuthMethod, ProviderAuthOptionBag } from "../plugins/types.js"; import type { ApplyAuthChoiceParams, ApplyAuthChoiceResult } from "./auth-choice.apply.js"; import { isRemoteEnvironment } from "./oauth-env.js"; import { createVpsAwareOAuthHandlers } from "./oauth-flow.js"; @@ -97,7 +97,7 @@ export async function runProviderPluginAuthMethod(params: { workspaceDir, prompter: params.prompter, runtime: params.runtime, - opts: params.opts, + opts: params.opts as ProviderAuthOptionBag | undefined, secretInputMode: params.secretInputMode, allowSecretRefPrompt: params.allowSecretRefPrompt, isRemote, @@ -173,7 +173,7 @@ export async function applyAuthChoiceLoadedPluginProvider( workspaceDir, secretInputMode: params.opts?.secretInputMode, allowSecretRefPrompt: false, - opts: params.opts, + opts: params.opts as ProviderAuthOptionBag | undefined, }); let nextConfig = applied.config; @@ -260,7 +260,7 @@ export async function applyAuthChoicePluginProvider( workspaceDir, secretInputMode: params.opts?.secretInputMode, allowSecretRefPrompt: false, - opts: params.opts, + opts: params.opts as ProviderAuthOptionBag | undefined, }); nextConfig = applied.config; diff --git a/src/commands/auth-token.ts b/src/commands/auth-token.ts index d003c2aa1b7..b371599b222 100644 --- a/src/commands/auth-token.ts +++ b/src/commands/auth-token.ts @@ -1,38 +1,8 @@ -import { normalizeProviderId } from "../agents/model-selection.js"; - -export const ANTHROPIC_SETUP_TOKEN_PREFIX = "sk-ant-oat01-"; -export const ANTHROPIC_SETUP_TOKEN_MIN_LENGTH = 80; -export const DEFAULT_TOKEN_PROFILE_NAME = "default"; - -export function normalizeTokenProfileName(raw: string): string { - const trimmed = raw.trim(); - if (!trimmed) { - return DEFAULT_TOKEN_PROFILE_NAME; - } - const slug = trimmed - .toLowerCase() - .replace(/[^a-z0-9._-]+/g, "-") - .replace(/-+/g, "-") - .replace(/^-+|-+$/g, ""); - return slug || DEFAULT_TOKEN_PROFILE_NAME; -} - -export function buildTokenProfileId(params: { provider: string; name: string }): string { - const provider = normalizeProviderId(params.provider); - const name = normalizeTokenProfileName(params.name); - return `${provider}:${name}`; -} - -export function validateAnthropicSetupToken(raw: string): string | undefined { - const trimmed = raw.trim(); - if (!trimmed) { - return "Required"; - } - if (!trimmed.startsWith(ANTHROPIC_SETUP_TOKEN_PREFIX)) { - return `Expected token starting with ${ANTHROPIC_SETUP_TOKEN_PREFIX}`; - } - if (trimmed.length < ANTHROPIC_SETUP_TOKEN_MIN_LENGTH) { - return "Token looks too short; paste the full setup-token"; - } - return undefined; -} +export { + ANTHROPIC_SETUP_TOKEN_MIN_LENGTH, + ANTHROPIC_SETUP_TOKEN_PREFIX, + buildTokenProfileId, + DEFAULT_TOKEN_PROFILE_NAME, + normalizeTokenProfileName, + validateAnthropicSetupToken, +} from "../plugins/provider-auth-token.js"; diff --git a/src/commands/google-gemini-model-default.ts b/src/commands/google-gemini-model-default.ts index 491fdd3c6d9..25b92d6459f 100644 --- a/src/commands/google-gemini-model-default.ts +++ b/src/commands/google-gemini-model-default.ts @@ -1,11 +1,4 @@ -import type { OpenClawConfig } from "../config/config.js"; -import { applyAgentDefaultPrimaryModel } from "./model-default.js"; - -export const GOOGLE_GEMINI_DEFAULT_MODEL = "google/gemini-3.1-pro-preview"; - -export function applyGoogleGeminiModelDefault(cfg: OpenClawConfig): { - next: OpenClawConfig; - changed: boolean; -} { - return applyAgentDefaultPrimaryModel({ cfg, model: GOOGLE_GEMINI_DEFAULT_MODEL }); -} +export { + applyGoogleGeminiModelDefault, + GOOGLE_GEMINI_DEFAULT_MODEL, +} from "../plugins/provider-model-defaults.js"; diff --git a/src/commands/model-allowlist.ts b/src/commands/model-allowlist.ts index bc6dfc5308d..37f664aef36 100644 --- a/src/commands/model-allowlist.ts +++ b/src/commands/model-allowlist.ts @@ -1,41 +1 @@ -import { DEFAULT_PROVIDER } from "../agents/defaults.js"; -import { resolveAllowlistModelKey } from "../agents/model-selection.js"; -import type { OpenClawConfig } from "../config/config.js"; - -export function ensureModelAllowlistEntry(params: { - cfg: OpenClawConfig; - modelRef: string; - defaultProvider?: string; -}): OpenClawConfig { - const rawModelRef = params.modelRef.trim(); - if (!rawModelRef) { - return params.cfg; - } - - const models = { ...params.cfg.agents?.defaults?.models }; - const keySet = new Set([rawModelRef]); - const canonicalKey = resolveAllowlistModelKey( - rawModelRef, - params.defaultProvider ?? DEFAULT_PROVIDER, - ); - if (canonicalKey) { - keySet.add(canonicalKey); - } - - for (const key of keySet) { - models[key] = { - ...models[key], - }; - } - - return { - ...params.cfg, - agents: { - ...params.cfg.agents, - defaults: { - ...params.cfg.agents?.defaults, - models, - }, - }, - }; -} +export { ensureModelAllowlistEntry } from "../plugins/provider-model-allowlist.js"; diff --git a/src/commands/model-default.ts b/src/commands/model-default.ts index ce121973da3..d70e5208f3b 100644 --- a/src/commands/model-default.ts +++ b/src/commands/model-default.ts @@ -1,45 +1,4 @@ -import type { OpenClawConfig } from "../config/config.js"; -import type { AgentModelListConfig } from "../config/types.js"; - -export function resolvePrimaryModel(model?: AgentModelListConfig | string): string | undefined { - if (typeof model === "string") { - return model; - } - if (model && typeof model === "object" && typeof model.primary === "string") { - return model.primary; - } - return undefined; -} - -export function applyAgentDefaultPrimaryModel(params: { - cfg: OpenClawConfig; - model: string; - legacyModels?: Set; -}): { next: OpenClawConfig; changed: boolean } { - const current = resolvePrimaryModel(params.cfg.agents?.defaults?.model)?.trim(); - const normalizedCurrent = current && params.legacyModels?.has(current) ? params.model : current; - if (normalizedCurrent === params.model) { - return { next: params.cfg, changed: false }; - } - - return { - next: { - ...params.cfg, - agents: { - ...params.cfg.agents, - defaults: { - ...params.cfg.agents?.defaults, - model: - params.cfg.agents?.defaults?.model && - typeof params.cfg.agents.defaults.model === "object" - ? { - ...params.cfg.agents.defaults.model, - primary: params.model, - } - : { primary: params.model }, - }, - }, - }, - changed: true, - }; -} +export { + applyAgentDefaultPrimaryModel, + resolvePrimaryModel, +} from "../plugins/provider-model-primary.js"; diff --git a/src/commands/model-picker.ts b/src/commands/model-picker.ts index 483997511cb..c0b67ea7d7c 100644 --- a/src/commands/model-picker.ts +++ b/src/commands/model-picker.ts @@ -11,10 +11,13 @@ import { } from "../agents/model-selection.js"; import type { OpenClawConfig } from "../config/config.js"; import { resolveAgentModelPrimaryValue } from "../config/model-input.js"; +import { applyPrimaryModel } from "../plugins/provider-model-primary.js"; import type { ProviderPlugin } from "../plugins/types.js"; import type { WizardPrompter, WizardSelectOption } from "../wizard/prompts.js"; import { formatTokenK } from "./models/shared.js"; +export { applyPrimaryModel } from "../plugins/provider-model-primary.js"; + const KEEP_VALUE = "__keep__"; const MANUAL_VALUE = "__manual__"; const PROVIDER_FILTER_THRESHOLD = 30; @@ -516,33 +519,6 @@ export async function promptModelAllowlist(params: { return { models: [] }; } -export function applyPrimaryModel(cfg: OpenClawConfig, model: string): OpenClawConfig { - const defaults = cfg.agents?.defaults; - const existingModel = defaults?.model; - const existingModels = defaults?.models; - const fallbacks = - typeof existingModel === "object" && existingModel !== null && "fallbacks" in existingModel - ? (existingModel as { fallbacks?: string[] }).fallbacks - : undefined; - return { - ...cfg, - agents: { - ...cfg.agents, - defaults: { - ...defaults, - model: { - ...(fallbacks ? { fallbacks } : undefined), - primary: model, - }, - models: { - ...existingModels, - [model]: existingModels?.[model] ?? {}, - }, - }, - }, - }; -} - export function applyModelAllowlist(cfg: OpenClawConfig, models: string[]): OpenClawConfig { const defaults = cfg.agents?.defaults; const normalized = normalizeModelKeys(models); diff --git a/src/commands/oauth-flow.ts b/src/commands/oauth-flow.ts index 1b0eba3b4f8..48e89b25720 100644 --- a/src/commands/oauth-flow.ts +++ b/src/commands/oauth-flow.ts @@ -1,53 +1 @@ -import type { RuntimeEnv } from "../runtime.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; - -type OAuthPrompt = { message: string; placeholder?: string }; - -const validateRequiredInput = (value: string) => (value.trim().length > 0 ? undefined : "Required"); - -export function createVpsAwareOAuthHandlers(params: { - isRemote: boolean; - prompter: WizardPrompter; - runtime: RuntimeEnv; - spin: ReturnType; - openUrl: (url: string) => Promise; - localBrowserMessage: string; - manualPromptMessage?: string; -}): { - onAuth: (event: { url: string }) => Promise; - onPrompt: (prompt: OAuthPrompt) => Promise; -} { - const manualPromptMessage = params.manualPromptMessage ?? "Paste the redirect URL"; - let manualCodePromise: Promise | undefined; - - return { - onAuth: async ({ url }) => { - if (params.isRemote) { - params.spin.stop("OAuth URL ready"); - params.runtime.log(`\nOpen this URL in your LOCAL browser:\n\n${url}\n`); - manualCodePromise = params.prompter - .text({ - message: manualPromptMessage, - validate: validateRequiredInput, - }) - .then((value) => String(value)); - return; - } - - params.spin.update(params.localBrowserMessage); - await params.openUrl(url); - params.runtime.log(`Open: ${url}`); - }, - onPrompt: async (prompt) => { - if (manualCodePromise) { - return manualCodePromise; - } - const code = await params.prompter.text({ - message: prompt.message, - placeholder: prompt.placeholder, - validate: validateRequiredInput, - }); - return String(code); - }, - }; -} +export * from "../plugins/provider-oauth-flow.js"; diff --git a/src/commands/oauth-tls-preflight.ts b/src/commands/oauth-tls-preflight.ts index bf9e69b0519..6852c58ad5c 100644 --- a/src/commands/oauth-tls-preflight.ts +++ b/src/commands/oauth-tls-preflight.ts @@ -1,164 +1 @@ -import path from "node:path"; -import { formatCliCommand } from "../cli/command-format.js"; -import type { OpenClawConfig } from "../config/config.js"; -import { note } from "../terminal/note.js"; - -const TLS_CERT_ERROR_CODES = new Set([ - "UNABLE_TO_GET_ISSUER_CERT_LOCALLY", - "UNABLE_TO_VERIFY_LEAF_SIGNATURE", - "CERT_HAS_EXPIRED", - "DEPTH_ZERO_SELF_SIGNED_CERT", - "SELF_SIGNED_CERT_IN_CHAIN", - "ERR_TLS_CERT_ALTNAME_INVALID", -]); - -const TLS_CERT_ERROR_PATTERNS = [ - /unable to get local issuer certificate/i, - /unable to verify the first certificate/i, - /self[- ]signed certificate/i, - /certificate has expired/i, -]; - -const OPENAI_AUTH_PROBE_URL = - "https://auth.openai.com/oauth/authorize?response_type=code&client_id=openclaw-preflight&redirect_uri=http%3A%2F%2Flocalhost%3A1455%2Fauth%2Fcallback&scope=openid+profile+email"; - -type PreflightFailureKind = "tls-cert" | "network"; - -export type OpenAIOAuthTlsPreflightResult = - | { ok: true } - | { - ok: false; - kind: PreflightFailureKind; - code?: string; - message: string; - }; - -function asRecord(value: unknown): Record | null { - return value && typeof value === "object" ? (value as Record) : null; -} - -function extractFailure(error: unknown): { - code?: string; - message: string; - kind: PreflightFailureKind; -} { - const root = asRecord(error); - const rootCause = asRecord(root?.cause); - const code = typeof rootCause?.code === "string" ? rootCause.code : undefined; - const message = - typeof rootCause?.message === "string" - ? rootCause.message - : typeof root?.message === "string" - ? root.message - : String(error); - const isTlsCertError = - (code ? TLS_CERT_ERROR_CODES.has(code) : false) || - TLS_CERT_ERROR_PATTERNS.some((pattern) => pattern.test(message)); - return { - code, - message, - kind: isTlsCertError ? "tls-cert" : "network", - }; -} - -function resolveHomebrewPrefixFromExecPath(execPath: string): string | null { - const marker = `${path.sep}Cellar${path.sep}`; - const idx = execPath.indexOf(marker); - if (idx > 0) { - return execPath.slice(0, idx); - } - const envPrefix = process.env.HOMEBREW_PREFIX?.trim(); - return envPrefix ? envPrefix : null; -} - -function resolveCertBundlePath(): string | null { - const prefix = resolveHomebrewPrefixFromExecPath(process.execPath); - if (!prefix) { - return null; - } - return path.join(prefix, "etc", "openssl@3", "cert.pem"); -} - -function hasOpenAICodexOAuthProfile(cfg: OpenClawConfig): boolean { - const profiles = cfg.auth?.profiles; - if (!profiles) { - return false; - } - return Object.values(profiles).some( - (profile) => profile.provider === "openai-codex" && profile.mode === "oauth", - ); -} - -function shouldRunOpenAIOAuthTlsPrerequisites(params: { - cfg: OpenClawConfig; - deep?: boolean; -}): boolean { - if (params.deep === true) { - return true; - } - return hasOpenAICodexOAuthProfile(params.cfg); -} - -export async function runOpenAIOAuthTlsPreflight(options?: { - timeoutMs?: number; - fetchImpl?: typeof fetch; -}): Promise { - const timeoutMs = options?.timeoutMs ?? 5000; - const fetchImpl = options?.fetchImpl ?? fetch; - try { - await fetchImpl(OPENAI_AUTH_PROBE_URL, { - method: "GET", - redirect: "manual", - signal: AbortSignal.timeout(timeoutMs), - }); - return { ok: true }; - } catch (error) { - const failure = extractFailure(error); - return { - ok: false, - kind: failure.kind, - code: failure.code, - message: failure.message, - }; - } -} - -export function formatOpenAIOAuthTlsPreflightFix( - result: Exclude, -): string { - if (result.kind !== "tls-cert") { - return [ - "OpenAI OAuth prerequisites check failed due to a network error before the browser flow.", - `Cause: ${result.message}`, - "Verify DNS/firewall/proxy access to auth.openai.com and retry.", - ].join("\n"); - } - const certBundlePath = resolveCertBundlePath(); - const lines = [ - "OpenAI OAuth prerequisites check failed: Node/OpenSSL cannot validate TLS certificates.", - `Cause: ${result.code ? `${result.code} (${result.message})` : result.message}`, - "", - "Fix (Homebrew Node/OpenSSL):", - `- ${formatCliCommand("brew postinstall ca-certificates")}`, - `- ${formatCliCommand("brew postinstall openssl@3")}`, - ]; - if (certBundlePath) { - lines.push(`- Verify cert bundle exists: ${certBundlePath}`); - } - lines.push("- Retry the OAuth login flow."); - return lines.join("\n"); -} - -export async function noteOpenAIOAuthTlsPrerequisites(params: { - cfg: OpenClawConfig; - deep?: boolean; -}): Promise { - if (!shouldRunOpenAIOAuthTlsPrerequisites(params)) { - return; - } - const result = await runOpenAIOAuthTlsPreflight({ timeoutMs: 4000 }); - if (result.ok || result.kind !== "tls-cert") { - return; - } - note(formatOpenAIOAuthTlsPreflightFix(result), "OAuth TLS prerequisites"); -} +export * from "../plugins/provider-openai-codex-oauth-tls.js"; diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts index 3f11a7367a9..54f25857441 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts @@ -8,6 +8,7 @@ import { resolveDefaultAgentWorkspaceDir } from "../../../agents/workspace.js"; import type { OpenClawConfig } from "../../../config/config.js"; import { enablePluginInConfig } from "../../../plugins/enable.js"; import type { + ProviderAuthOptionBag, ProviderNonInteractiveApiKeyCredentialParams, ProviderResolveNonInteractiveApiKeyParams, } from "../../../plugins/types.js"; @@ -130,7 +131,7 @@ export async function applyNonInteractivePluginProviderChoice(params: { authChoice: params.authChoice, config: enableResult.config, baseConfig: params.baseConfig, - opts: params.opts, + opts: params.opts as ProviderAuthOptionBag, runtime: params.runtime, agentDir, workspaceDir, diff --git a/src/commands/onboard-types.ts b/src/commands/onboard-types.ts index 9d738298e52..832fae75448 100644 --- a/src/commands/onboard-types.ts +++ b/src/commands/onboard-types.ts @@ -1,4 +1,5 @@ import type { ChannelId } from "../channels/plugins/types.js"; +import type { SecretInputMode } from "../plugins/provider-auth-types.js"; import type { GatewayDaemonRuntime } from "./daemon-runtime.js"; export type OnboardMode = "local" | "remote"; @@ -90,7 +91,7 @@ export type NodeManagerChoice = "npm" | "pnpm" | "bun"; export type ChannelChoice = ChannelId; // Legacy alias (pre-rename). export type ProviderChoice = ChannelChoice; -export type SecretInputMode = "plaintext" | "ref"; // pragma: allowlist secret +export type { SecretInputMode } from "../plugins/provider-auth-types.js"; export type OnboardOptions = { mode?: OnboardMode; diff --git a/src/commands/openai-codex-oauth.ts b/src/commands/openai-codex-oauth.ts index a868217750b..0c5f098c41f 100644 --- a/src/commands/openai-codex-oauth.ts +++ b/src/commands/openai-codex-oauth.ts @@ -1,65 +1 @@ -import { loginOpenAICodex, type OAuthCredentials } from "@mariozechner/pi-ai/oauth"; -import type { RuntimeEnv } from "../runtime.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; -import { createVpsAwareOAuthHandlers } from "./oauth-flow.js"; -import { - formatOpenAIOAuthTlsPreflightFix, - runOpenAIOAuthTlsPreflight, -} from "./oauth-tls-preflight.js"; - -export async function loginOpenAICodexOAuth(params: { - prompter: WizardPrompter; - runtime: RuntimeEnv; - isRemote: boolean; - openUrl: (url: string) => Promise; - localBrowserMessage?: string; -}): Promise { - const { prompter, runtime, isRemote, openUrl, localBrowserMessage } = params; - const preflight = await runOpenAIOAuthTlsPreflight(); - if (!preflight.ok && preflight.kind === "tls-cert") { - const hint = formatOpenAIOAuthTlsPreflightFix(preflight); - runtime.error(hint); - await prompter.note(hint, "OAuth prerequisites"); - throw new Error(preflight.message); - } - - await prompter.note( - isRemote - ? [ - "You are running in a remote/VPS environment.", - "A URL will be shown for you to open in your LOCAL browser.", - "After signing in, paste the redirect URL back here.", - ].join("\n") - : [ - "Browser will open for OpenAI authentication.", - "If the callback doesn't auto-complete, paste the redirect URL.", - "OpenAI OAuth uses localhost:1455 for the callback.", - ].join("\n"), - "OpenAI Codex OAuth", - ); - - const spin = prompter.progress("Starting OAuth flow…"); - try { - const { onAuth: baseOnAuth, onPrompt } = createVpsAwareOAuthHandlers({ - isRemote, - prompter, - runtime, - spin, - openUrl, - localBrowserMessage: localBrowserMessage ?? "Complete sign-in in browser…", - }); - - const creds = await loginOpenAICodex({ - onAuth: baseOnAuth, - onPrompt, - onProgress: (msg: string) => spin.update(msg), - }); - spin.stop("OpenAI OAuth complete"); - return creds ?? null; - } catch (err) { - spin.stop("OpenAI OAuth failed"); - runtime.error(String(err)); - await prompter.note("Trouble with OAuth? See https://docs.openclaw.ai/start/faq", "OAuth help"); - throw err; - } -} +export { loginOpenAICodexOAuth } from "../plugins/provider-openai-codex-oauth.js"; diff --git a/src/commands/openai-model-default.ts b/src/commands/openai-model-default.ts index 191756e0fa0..81316e753ed 100644 --- a/src/commands/openai-model-default.ts +++ b/src/commands/openai-model-default.ts @@ -1,47 +1,5 @@ -import type { OpenClawConfig } from "../config/config.js"; -import { ensureModelAllowlistEntry } from "./model-allowlist.js"; - -export const OPENAI_DEFAULT_MODEL = "openai/gpt-5.1-codex"; - -export function applyOpenAIProviderConfig(cfg: OpenClawConfig): OpenClawConfig { - const next = ensureModelAllowlistEntry({ - cfg, - modelRef: OPENAI_DEFAULT_MODEL, - }); - const models = { ...next.agents?.defaults?.models }; - models[OPENAI_DEFAULT_MODEL] = { - ...models[OPENAI_DEFAULT_MODEL], - alias: models[OPENAI_DEFAULT_MODEL]?.alias ?? "GPT", - }; - - return { - ...next, - agents: { - ...next.agents, - defaults: { - ...next.agents?.defaults, - models, - }, - }, - }; -} - -export function applyOpenAIConfig(cfg: OpenClawConfig): OpenClawConfig { - const next = applyOpenAIProviderConfig(cfg); - return { - ...next, - agents: { - ...next.agents, - defaults: { - ...next.agents?.defaults, - model: - next.agents?.defaults?.model && typeof next.agents.defaults.model === "object" - ? { - ...next.agents.defaults.model, - primary: OPENAI_DEFAULT_MODEL, - } - : { primary: OPENAI_DEFAULT_MODEL }, - }, - }, - }; -} +export { + applyOpenAIConfig, + applyOpenAIProviderConfig, + OPENAI_DEFAULT_MODEL, +} from "../plugins/provider-model-defaults.js"; diff --git a/src/commands/opencode-go-model-default.ts b/src/commands/opencode-go-model-default.ts index c959f23ff2e..c87816456c3 100644 --- a/src/commands/opencode-go-model-default.ts +++ b/src/commands/opencode-go-model-default.ts @@ -1,11 +1,4 @@ -import type { OpenClawConfig } from "../config/config.js"; -import { applyAgentDefaultPrimaryModel } from "./model-default.js"; - -export const OPENCODE_GO_DEFAULT_MODEL_REF = "opencode-go/kimi-k2.5"; - -export function applyOpencodeGoModelDefault(cfg: OpenClawConfig): { - next: OpenClawConfig; - changed: boolean; -} { - return applyAgentDefaultPrimaryModel({ cfg, model: OPENCODE_GO_DEFAULT_MODEL_REF }); -} +export { + applyOpencodeGoModelDefault, + OPENCODE_GO_DEFAULT_MODEL_REF, +} from "../plugins/provider-model-defaults.js"; diff --git a/src/commands/opencode-zen-model-default.ts b/src/commands/opencode-zen-model-default.ts index 9efb9c17ade..0d874241076 100644 --- a/src/commands/opencode-zen-model-default.ts +++ b/src/commands/opencode-zen-model-default.ts @@ -1,19 +1,4 @@ -import type { OpenClawConfig } from "../config/config.js"; -import { applyAgentDefaultPrimaryModel } from "./model-default.js"; - -export const OPENCODE_ZEN_DEFAULT_MODEL = "opencode/claude-opus-4-6"; -const LEGACY_OPENCODE_ZEN_DEFAULT_MODELS = new Set([ - "opencode/claude-opus-4-5", - "opencode-zen/claude-opus-4-5", -]); - -export function applyOpencodeZenModelDefault(cfg: OpenClawConfig): { - next: OpenClawConfig; - changed: boolean; -} { - return applyAgentDefaultPrimaryModel({ - cfg, - model: OPENCODE_ZEN_DEFAULT_MODEL, - legacyModels: LEGACY_OPENCODE_ZEN_DEFAULT_MODELS, - }); -} +export { + applyOpencodeZenModelDefault, + OPENCODE_ZEN_DEFAULT_MODEL, +} from "../plugins/provider-model-defaults.js"; diff --git a/src/commands/self-hosted-provider-setup.ts b/src/commands/self-hosted-provider-setup.ts index e7851fdf550..2b1e0a3027b 100644 --- a/src/commands/self-hosted-provider-setup.ts +++ b/src/commands/self-hosted-provider-setup.ts @@ -13,6 +13,7 @@ import type { ProviderAuthMethodNonInteractiveContext, ProviderNonInteractiveApiKeyResult, } from "../plugins/types.js"; +import { normalizeOptionalSecretInput } from "../utils/normalize-secret-input.js"; import type { WizardPrompter } from "../wizard/prompts.js"; export { @@ -240,11 +241,10 @@ export async function configureOpenAICompatibleSelfHostedProviderNonInteractive( contextWindow?: number; maxTokens?: number; }): Promise { - const baseUrl = (params.ctx.opts.customBaseUrl?.trim() || params.defaultBaseUrl).replace( - /\/+$/, - "", - ); - const modelId = params.ctx.opts.customModelId?.trim(); + const baseUrl = ( + normalizeOptionalSecretInput(params.ctx.opts.customBaseUrl) ?? params.defaultBaseUrl + ).replace(/\/+$/, ""); + const modelId = normalizeOptionalSecretInput(params.ctx.opts.customModelId); if (!modelId) { params.ctx.runtime.error( buildMissingNonInteractiveModelIdMessage({ @@ -259,7 +259,7 @@ export async function configureOpenAICompatibleSelfHostedProviderNonInteractive( const resolved = await params.ctx.resolveApiKey({ provider: params.providerId, - flagValue: params.ctx.opts.customApiKey, + flagValue: normalizeOptionalSecretInput(params.ctx.opts.customApiKey), flagName: "--custom-api-key", envVar: params.defaultApiKeyEnvVar, envVarName: params.defaultApiKeyEnvVar, diff --git a/src/plugin-sdk/provider-auth.ts b/src/plugin-sdk/provider-auth.ts index bb0c307c294..baecefe62e9 100644 --- a/src/plugin-sdk/provider-auth.ts +++ b/src/plugin-sdk/provider-auth.ts @@ -21,17 +21,20 @@ export { formatApiKeyPreview, normalizeApiKeyInput, validateApiKeyInput, -} from "../commands/auth-choice.api-key.js"; +} from "../plugins/provider-auth-input.js"; export { ensureApiKeyFromOptionEnvOrPrompt, normalizeSecretInputModeInput, promptSecretRefForSetup, resolveSecretInputModeForEnvSelection, -} from "../commands/auth-choice.apply-helpers.js"; -export { buildTokenProfileId, validateAnthropicSetupToken } from "../commands/auth-token.js"; +} from "../plugins/provider-auth-input.js"; +export { + buildTokenProfileId, + validateAnthropicSetupToken, +} from "../plugins/provider-auth-token.js"; export { applyAuthProfileConfig, buildApiKeyCredential } from "../plugins/provider-auth-helpers.js"; export { githubCopilotLoginCommand } from "../providers/github-copilot-auth.js"; -export { loginOpenAICodexOAuth } from "../commands/openai-codex-oauth.js"; +export { loginOpenAICodexOAuth } from "../plugins/provider-openai-codex-oauth.js"; export { createProviderApiKeyAuthMethod } from "../plugins/provider-api-key-auth.js"; export { coerceSecretRef } from "../config/types.secrets.js"; export { resolveDefaultSecretProviderAlias } from "../secrets/ref-contract.js"; diff --git a/src/plugin-sdk/provider-models.ts b/src/plugin-sdk/provider-models.ts index f0a85fe1ed1..5694a540075 100644 --- a/src/plugin-sdk/provider-models.ts +++ b/src/plugin-sdk/provider-models.ts @@ -14,10 +14,10 @@ export { normalizeProviderId } from "../agents/provider-id.js"; export { applyGoogleGeminiModelDefault, GOOGLE_GEMINI_DEFAULT_MODEL, -} from "../commands/google-gemini-model-default.js"; -export { applyOpenAIConfig, OPENAI_DEFAULT_MODEL } from "../commands/openai-model-default.js"; -export { OPENCODE_GO_DEFAULT_MODEL_REF } from "../commands/opencode-go-model-default.js"; -export { OPENCODE_ZEN_DEFAULT_MODEL } from "../commands/opencode-zen-model-default.js"; +} from "../plugins/provider-model-defaults.js"; +export { applyOpenAIConfig, OPENAI_DEFAULT_MODEL } from "../plugins/provider-model-defaults.js"; +export { OPENCODE_GO_DEFAULT_MODEL_REF } from "../plugins/provider-model-defaults.js"; +export { OPENCODE_ZEN_DEFAULT_MODEL } from "../plugins/provider-model-defaults.js"; export { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "../agents/opencode-zen-models.js"; export * from "../plugins/provider-model-definitions.js"; diff --git a/src/plugin-sdk/provider-onboard.ts b/src/plugin-sdk/provider-onboard.ts index 89b219bedbc..35b9287bcc8 100644 --- a/src/plugin-sdk/provider-onboard.ts +++ b/src/plugin-sdk/provider-onboard.ts @@ -13,4 +13,4 @@ export { applyProviderConfigWithDefaultModels, applyProviderConfigWithModelCatalog, } from "../plugins/provider-onboarding-config.js"; -export { ensureModelAllowlistEntry } from "../commands/model-allowlist.js"; +export { ensureModelAllowlistEntry } from "../plugins/provider-model-allowlist.js"; diff --git a/src/plugins/provider-api-key-auth.runtime.ts b/src/plugins/provider-api-key-auth.runtime.ts index dade8720478..ad37b986b91 100644 --- a/src/plugins/provider-api-key-auth.runtime.ts +++ b/src/plugins/provider-api-key-auth.runtime.ts @@ -1,7 +1,10 @@ -import { normalizeApiKeyInput, validateApiKeyInput } from "../commands/auth-choice.api-key.js"; -import { ensureApiKeyFromOptionEnvOrPrompt } from "../commands/auth-choice.apply-helpers.js"; -import { applyPrimaryModel } from "../commands/model-picker.js"; import { applyAuthProfileConfig, buildApiKeyCredential } from "./provider-auth-helpers.js"; +import { + ensureApiKeyFromOptionEnvOrPrompt, + normalizeApiKeyInput, + validateApiKeyInput, +} from "./provider-auth-input.js"; +import { applyPrimaryModel } from "./provider-model-primary.js"; export { applyAuthProfileConfig, diff --git a/src/plugins/provider-auth-helpers.ts b/src/plugins/provider-auth-helpers.ts index 72075dffc00..bf397044eae 100644 --- a/src/plugins/provider-auth-helpers.ts +++ b/src/plugins/provider-auth-helpers.ts @@ -4,7 +4,6 @@ import type { OAuthCredentials } from "@mariozechner/pi-ai"; import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; import { upsertAuthProfile } from "../agents/auth-profiles.js"; import { normalizeProviderIdForAuth } from "../agents/provider-id.js"; -import type { SecretInputMode } from "../commands/onboard-types.js"; import type { OpenClawConfig } from "../config/config.js"; import { resolveStateDir } from "../config/paths.js"; import { @@ -15,6 +14,7 @@ import { } from "../config/types.secrets.js"; import { PROVIDER_ENV_VARS } from "../secrets/provider-env-vars.js"; import { normalizeSecretInput } from "../utils/normalize-secret-input.js"; +import type { SecretInputMode } from "./provider-auth-types.js"; const ENV_REF_PATTERN = /^\$\{([A-Z][A-Z0-9_]*)\}$/; diff --git a/src/plugins/provider-auth-input.ts b/src/plugins/provider-auth-input.ts new file mode 100644 index 00000000000..02abf92592d --- /dev/null +++ b/src/plugins/provider-auth-input.ts @@ -0,0 +1,496 @@ +import { resolveEnvApiKey } from "../agents/model-auth.js"; +import type { OpenClawConfig } from "../config/types.js"; +import { + isValidEnvSecretRefId, + type SecretInput, + type SecretRef, +} from "../config/types.secrets.js"; +import { encodeJsonPointerToken } from "../secrets/json-pointer.js"; +import { PROVIDER_ENV_VARS } from "../secrets/provider-env-vars.js"; +import { + formatExecSecretRefIdValidationMessage, + isValidExecSecretRefId, + isValidFileSecretRefId, + resolveDefaultSecretProviderAlias, +} from "../secrets/ref-contract.js"; +import { resolveSecretRefString } from "../secrets/resolve.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; +import type { SecretInputMode } from "./provider-auth-types.js"; + +const DEFAULT_KEY_PREVIEW = { head: 4, tail: 4 }; +const ENV_SOURCE_LABEL_RE = /(?:^|:\s)([A-Z][A-Z0-9_]*)$/; + +type SecretRefChoice = "env" | "provider"; // pragma: allowlist secret + +export type SecretInputModePromptCopy = { + modeMessage?: string; + plaintextLabel?: string; + plaintextHint?: string; + refLabel?: string; + refHint?: string; +}; + +export type SecretRefSetupPromptCopy = { + sourceMessage?: string; + envVarMessage?: string; + envVarPlaceholder?: string; + envVarFormatError?: string; + envVarMissingError?: (envVar: string) => string; + noProvidersMessage?: string; + envValidatedMessage?: (envVar: string) => string; + providerValidatedMessage?: (provider: string, id: string, source: "file" | "exec") => string; +}; + +export function normalizeApiKeyInput(raw: string): string { + const trimmed = String(raw ?? "").trim(); + if (!trimmed) { + return ""; + } + + const assignmentMatch = trimmed.match(/^(?:export\s+)?[A-Za-z_][A-Za-z0-9_]*\s*=\s*(.+)$/); + const valuePart = assignmentMatch ? assignmentMatch[1].trim() : trimmed; + + const unquoted = + valuePart.length >= 2 && + ((valuePart.startsWith('"') && valuePart.endsWith('"')) || + (valuePart.startsWith("'") && valuePart.endsWith("'")) || + (valuePart.startsWith("`") && valuePart.endsWith("`"))) + ? valuePart.slice(1, -1) + : valuePart; + + const withoutSemicolon = unquoted.endsWith(";") ? unquoted.slice(0, -1) : unquoted; + + return withoutSemicolon.trim(); +} + +export const validateApiKeyInput = (value: string) => + normalizeApiKeyInput(value).length > 0 ? undefined : "Required"; + +export function formatApiKeyPreview( + raw: string, + opts: { head?: number; tail?: number } = {}, +): string { + const trimmed = raw.trim(); + if (!trimmed) { + return "…"; + } + const head = opts.head ?? DEFAULT_KEY_PREVIEW.head; + const tail = opts.tail ?? DEFAULT_KEY_PREVIEW.tail; + if (trimmed.length <= head + tail) { + const shortHead = Math.min(2, trimmed.length); + const shortTail = Math.min(2, trimmed.length - shortHead); + if (shortTail <= 0) { + return `${trimmed.slice(0, shortHead)}…`; + } + return `${trimmed.slice(0, shortHead)}…${trimmed.slice(-shortTail)}`; + } + return `${trimmed.slice(0, head)}…${trimmed.slice(-tail)}`; +} + +function formatErrorMessage(error: unknown): string { + if (error instanceof Error && typeof error.message === "string" && error.message.trim()) { + return error.message; + } + return String(error); +} + +function extractEnvVarFromSourceLabel(source: string): string | undefined { + const match = ENV_SOURCE_LABEL_RE.exec(source.trim()); + return match?.[1]; +} + +function resolveDefaultProviderEnvVar(provider: string): string | undefined { + const envVars = PROVIDER_ENV_VARS[provider]; + return envVars?.find((candidate) => candidate.trim().length > 0); +} + +function resolveDefaultFilePointerId(provider: string): string { + return `/providers/${encodeJsonPointerToken(provider)}/apiKey`; +} + +function resolveRefFallbackInput(params: { + config: OpenClawConfig; + provider: string; + preferredEnvVar?: string; +}): { ref: SecretRef; resolvedValue: string } { + const fallbackEnvVar = params.preferredEnvVar ?? resolveDefaultProviderEnvVar(params.provider); + if (!fallbackEnvVar) { + throw new Error( + `No default environment variable mapping found for provider "${params.provider}". Set a provider-specific env var, or re-run setup in an interactive terminal to configure a ref.`, + ); + } + const value = process.env[fallbackEnvVar]?.trim(); + if (!value) { + throw new Error( + `Environment variable "${fallbackEnvVar}" is required for --secret-input-mode ref in non-interactive setup.`, + ); + } + return { + ref: { + source: "env", + provider: resolveDefaultSecretProviderAlias(params.config, "env", { + preferFirstProviderForSource: true, + }), + id: fallbackEnvVar, + }, + resolvedValue: value, + }; +} + +export async function promptSecretRefForSetup(params: { + provider: string; + config: OpenClawConfig; + prompter: WizardPrompter; + preferredEnvVar?: string; + copy?: SecretRefSetupPromptCopy; +}): Promise<{ ref: SecretRef; resolvedValue: string }> { + const defaultEnvVar = + params.preferredEnvVar ?? resolveDefaultProviderEnvVar(params.provider) ?? ""; + const defaultFilePointer = resolveDefaultFilePointerId(params.provider); + let sourceChoice: SecretRefChoice = "env"; // pragma: allowlist secret + + while (true) { + const sourceRaw: SecretRefChoice = await params.prompter.select({ + message: params.copy?.sourceMessage ?? "Where is this API key stored?", + initialValue: sourceChoice, + options: [ + { + value: "env", + label: "Environment variable", + hint: "Reference a variable from your runtime environment", + }, + { + value: "provider", + label: "Configured secret provider", + hint: "Use a configured file or exec secret provider", + }, + ], + }); + const source: SecretRefChoice = sourceRaw === "provider" ? "provider" : "env"; + sourceChoice = source; + + if (source === "env") { + const envVarRaw = await params.prompter.text({ + message: params.copy?.envVarMessage ?? "Environment variable name", + initialValue: defaultEnvVar || undefined, + placeholder: params.copy?.envVarPlaceholder ?? "OPENAI_API_KEY", + validate: (value) => { + const candidate = value.trim(); + if (!isValidEnvSecretRefId(candidate)) { + return ( + params.copy?.envVarFormatError ?? + 'Use an env var name like "OPENAI_API_KEY" (uppercase letters, numbers, underscores).' + ); + } + if (!process.env[candidate]?.trim()) { + return ( + params.copy?.envVarMissingError?.(candidate) ?? + `Environment variable "${candidate}" is missing or empty in this session.` + ); + } + return undefined; + }, + }); + const envCandidate = String(envVarRaw ?? "").trim(); + const envVar = + envCandidate && isValidEnvSecretRefId(envCandidate) ? envCandidate : defaultEnvVar; + if (!envVar) { + throw new Error( + `No valid environment variable name provided for provider "${params.provider}".`, + ); + } + const ref: SecretRef = { + source: "env", + provider: resolveDefaultSecretProviderAlias(params.config, "env", { + preferFirstProviderForSource: true, + }), + id: envVar, + }; + const resolvedValue = await resolveSecretRefString(ref, { + config: params.config, + env: process.env, + }); + await params.prompter.note( + params.copy?.envValidatedMessage?.(envVar) ?? + `Validated environment variable ${envVar}. OpenClaw will store a reference, not the key value.`, + "Reference validated", + ); + return { ref, resolvedValue }; + } + + const externalProviders = Object.entries(params.config.secrets?.providers ?? {}).filter( + ([, provider]) => provider?.source === "file" || provider?.source === "exec", + ); + if (externalProviders.length === 0) { + await params.prompter.note( + params.copy?.noProvidersMessage ?? + "No file/exec secret providers are configured yet. Add one under secrets.providers, or select Environment variable.", + "No providers configured", + ); + continue; + } + const defaultProvider = resolveDefaultSecretProviderAlias(params.config, "file", { + preferFirstProviderForSource: true, + }); + const selectedProvider = await params.prompter.select({ + message: "Select secret provider", + initialValue: + externalProviders.find(([providerName]) => providerName === defaultProvider)?.[0] ?? + externalProviders[0]?.[0], + options: externalProviders.map(([providerName, provider]) => ({ + value: providerName, + label: providerName, + hint: provider?.source === "exec" ? "Exec provider" : "File provider", + })), + }); + const providerEntry = params.config.secrets?.providers?.[selectedProvider]; + if (!providerEntry || (providerEntry.source !== "file" && providerEntry.source !== "exec")) { + await params.prompter.note( + `Provider "${selectedProvider}" is not a file/exec provider.`, + "Invalid provider", + ); + continue; + } + const idPrompt = + providerEntry.source === "file" + ? "Secret id (JSON pointer for json mode, or 'value' for singleValue mode)" + : "Secret id for the exec provider"; + const idDefault = + providerEntry.source === "file" + ? providerEntry.mode === "singleValue" + ? "value" + : defaultFilePointer + : `${params.provider}/apiKey`; + const idRaw = await params.prompter.text({ + message: idPrompt, + initialValue: idDefault, + placeholder: providerEntry.source === "file" ? "/providers/openai/apiKey" : "openai/api-key", + validate: (value) => { + const candidate = value.trim(); + if (!candidate) { + return "Secret id cannot be empty."; + } + if ( + providerEntry.source === "file" && + providerEntry.mode !== "singleValue" && + !isValidFileSecretRefId(candidate) + ) { + return 'Use an absolute JSON pointer like "/providers/openai/apiKey".'; + } + if ( + providerEntry.source === "file" && + providerEntry.mode === "singleValue" && + candidate !== "value" + ) { + return 'singleValue mode expects id "value".'; + } + if (providerEntry.source === "exec" && !isValidExecSecretRefId(candidate)) { + return formatExecSecretRefIdValidationMessage(); + } + return undefined; + }, + }); + const id = String(idRaw ?? "").trim() || idDefault; + const ref: SecretRef = { + source: providerEntry.source, + provider: selectedProvider, + id, + }; + try { + const resolvedValue = await resolveSecretRefString(ref, { + config: params.config, + env: process.env, + }); + await params.prompter.note( + params.copy?.providerValidatedMessage?.(selectedProvider, id, providerEntry.source) ?? + `Validated ${providerEntry.source} reference ${selectedProvider}:${id}. OpenClaw will store a reference, not the key value.`, + "Reference validated", + ); + return { ref, resolvedValue }; + } catch (error) { + await params.prompter.note( + [ + `Could not validate provider reference ${selectedProvider}:${id}.`, + formatErrorMessage(error), + "Check your provider configuration and try again.", + ].join("\n"), + "Reference check failed", + ); + } + } +} + +export function normalizeTokenProviderInput( + tokenProvider: string | null | undefined, +): string | undefined { + const normalized = String(tokenProvider ?? "") + .trim() + .toLowerCase(); + return normalized || undefined; +} + +export function normalizeSecretInputModeInput( + secretInputMode: string | null | undefined, +): SecretInputMode | undefined { + const normalized = String(secretInputMode ?? "") + .trim() + .toLowerCase(); + if (normalized === "plaintext" || normalized === "ref") { + return normalized; + } + return undefined; +} + +export async function resolveSecretInputModeForEnvSelection(params: { + prompter: WizardPrompter; + explicitMode?: SecretInputMode; + copy?: SecretInputModePromptCopy; +}): Promise { + if (params.explicitMode) { + return params.explicitMode; + } + if (typeof params.prompter.select !== "function") { + return "plaintext"; + } + const selected = await params.prompter.select({ + message: params.copy?.modeMessage ?? "How do you want to provide this API key?", + initialValue: "plaintext", + options: [ + { + value: "plaintext", + label: params.copy?.plaintextLabel ?? "Paste API key now", + hint: params.copy?.plaintextHint ?? "Stores the key directly in OpenClaw config", + }, + { + value: "ref", + label: params.copy?.refLabel ?? "Use external secret provider", + hint: + params.copy?.refHint ?? + "Stores a reference to env or configured external secret providers", + }, + ], + }); + return selected === "ref" ? "ref" : "plaintext"; +} + +export async function maybeApplyApiKeyFromOption(params: { + token: string | undefined; + tokenProvider: string | undefined; + secretInputMode?: SecretInputMode; + expectedProviders: string[]; + normalize: (value: string) => string; + setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; +}): Promise { + const tokenProvider = normalizeTokenProviderInput(params.tokenProvider); + const expectedProviders = params.expectedProviders + .map((provider) => normalizeTokenProviderInput(provider)) + .filter((provider): provider is string => Boolean(provider)); + if (!params.token || !tokenProvider || !expectedProviders.includes(tokenProvider)) { + return undefined; + } + const apiKey = params.normalize(params.token); + await params.setCredential(apiKey, params.secretInputMode); + return apiKey; +} + +export async function ensureApiKeyFromOptionEnvOrPrompt(params: { + token: string | undefined; + tokenProvider: string | undefined; + secretInputMode?: SecretInputMode; + config: OpenClawConfig; + expectedProviders: string[]; + provider: string; + envLabel: string; + promptMessage: string; + normalize: (value: string) => string; + validate: (value: string) => string | undefined; + prompter: WizardPrompter; + setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; + noteMessage?: string; + noteTitle?: string; +}): Promise { + const optionApiKey = await maybeApplyApiKeyFromOption({ + token: params.token, + tokenProvider: params.tokenProvider, + secretInputMode: params.secretInputMode, + expectedProviders: params.expectedProviders, + normalize: params.normalize, + setCredential: params.setCredential, + }); + if (optionApiKey) { + return optionApiKey; + } + + if (params.noteMessage) { + await params.prompter.note(params.noteMessage, params.noteTitle); + } + + return await ensureApiKeyFromEnvOrPrompt({ + config: params.config, + provider: params.provider, + envLabel: params.envLabel, + promptMessage: params.promptMessage, + normalize: params.normalize, + validate: params.validate, + prompter: params.prompter, + secretInputMode: params.secretInputMode, + setCredential: params.setCredential, + }); +} + +export async function ensureApiKeyFromEnvOrPrompt(params: { + config: OpenClawConfig; + provider: string; + envLabel: string; + promptMessage: string; + normalize: (value: string) => string; + validate: (value: string) => string | undefined; + prompter: WizardPrompter; + secretInputMode?: SecretInputMode; + setCredential: (apiKey: SecretInput, mode?: SecretInputMode) => Promise; +}): Promise { + const selectedMode = await resolveSecretInputModeForEnvSelection({ + prompter: params.prompter, + explicitMode: params.secretInputMode, + }); + const envKey = resolveEnvApiKey(params.provider); + + if (selectedMode === "ref") { + if (typeof params.prompter.select !== "function") { + const fallback = resolveRefFallbackInput({ + config: params.config, + provider: params.provider, + preferredEnvVar: envKey?.source ? extractEnvVarFromSourceLabel(envKey.source) : undefined, + }); + await params.setCredential(fallback.ref, selectedMode); + return fallback.resolvedValue; + } + const resolved = await promptSecretRefForSetup({ + provider: params.provider, + config: params.config, + prompter: params.prompter, + preferredEnvVar: envKey?.source ? extractEnvVarFromSourceLabel(envKey.source) : undefined, + }); + await params.setCredential(resolved.ref, selectedMode); + return resolved.resolvedValue; + } + + if (envKey && selectedMode === "plaintext") { + const useExisting = await params.prompter.confirm({ + message: `Use existing ${params.envLabel} (${envKey.source}, ${formatApiKeyPreview(envKey.apiKey)})?`, + initialValue: true, + }); + if (useExisting) { + await params.setCredential(envKey.apiKey, selectedMode); + return envKey.apiKey; + } + } + + const key = await params.prompter.text({ + message: params.promptMessage, + validate: params.validate, + }); + const apiKey = params.normalize(String(key ?? "")); + await params.setCredential(apiKey, selectedMode); + return apiKey; +} diff --git a/src/plugins/provider-auth-token.ts b/src/plugins/provider-auth-token.ts new file mode 100644 index 00000000000..d003c2aa1b7 --- /dev/null +++ b/src/plugins/provider-auth-token.ts @@ -0,0 +1,38 @@ +import { normalizeProviderId } from "../agents/model-selection.js"; + +export const ANTHROPIC_SETUP_TOKEN_PREFIX = "sk-ant-oat01-"; +export const ANTHROPIC_SETUP_TOKEN_MIN_LENGTH = 80; +export const DEFAULT_TOKEN_PROFILE_NAME = "default"; + +export function normalizeTokenProfileName(raw: string): string { + const trimmed = raw.trim(); + if (!trimmed) { + return DEFAULT_TOKEN_PROFILE_NAME; + } + const slug = trimmed + .toLowerCase() + .replace(/[^a-z0-9._-]+/g, "-") + .replace(/-+/g, "-") + .replace(/^-+|-+$/g, ""); + return slug || DEFAULT_TOKEN_PROFILE_NAME; +} + +export function buildTokenProfileId(params: { provider: string; name: string }): string { + const provider = normalizeProviderId(params.provider); + const name = normalizeTokenProfileName(params.name); + return `${provider}:${name}`; +} + +export function validateAnthropicSetupToken(raw: string): string | undefined { + const trimmed = raw.trim(); + if (!trimmed) { + return "Required"; + } + if (!trimmed.startsWith(ANTHROPIC_SETUP_TOKEN_PREFIX)) { + return `Expected token starting with ${ANTHROPIC_SETUP_TOKEN_PREFIX}`; + } + if (trimmed.length < ANTHROPIC_SETUP_TOKEN_MIN_LENGTH) { + return "Token looks too short; paste the full setup-token"; + } + return undefined; +} diff --git a/src/plugins/provider-auth-types.ts b/src/plugins/provider-auth-types.ts new file mode 100644 index 00000000000..c26ba4778d8 --- /dev/null +++ b/src/plugins/provider-auth-types.ts @@ -0,0 +1 @@ +export type SecretInputMode = "plaintext" | "ref"; // pragma: allowlist secret diff --git a/src/plugins/provider-model-allowlist.ts b/src/plugins/provider-model-allowlist.ts new file mode 100644 index 00000000000..bc6dfc5308d --- /dev/null +++ b/src/plugins/provider-model-allowlist.ts @@ -0,0 +1,41 @@ +import { DEFAULT_PROVIDER } from "../agents/defaults.js"; +import { resolveAllowlistModelKey } from "../agents/model-selection.js"; +import type { OpenClawConfig } from "../config/config.js"; + +export function ensureModelAllowlistEntry(params: { + cfg: OpenClawConfig; + modelRef: string; + defaultProvider?: string; +}): OpenClawConfig { + const rawModelRef = params.modelRef.trim(); + if (!rawModelRef) { + return params.cfg; + } + + const models = { ...params.cfg.agents?.defaults?.models }; + const keySet = new Set([rawModelRef]); + const canonicalKey = resolveAllowlistModelKey( + rawModelRef, + params.defaultProvider ?? DEFAULT_PROVIDER, + ); + if (canonicalKey) { + keySet.add(canonicalKey); + } + + for (const key of keySet) { + models[key] = { + ...models[key], + }; + } + + return { + ...params.cfg, + agents: { + ...params.cfg.agents, + defaults: { + ...params.cfg.agents?.defaults, + models, + }, + }, + }; +} diff --git a/src/plugins/provider-model-defaults.ts b/src/plugins/provider-model-defaults.ts new file mode 100644 index 00000000000..60a18c1a759 --- /dev/null +++ b/src/plugins/provider-model-defaults.ts @@ -0,0 +1,81 @@ +import type { OpenClawConfig } from "../config/config.js"; +import { ensureModelAllowlistEntry } from "./provider-model-allowlist.js"; +import { applyAgentDefaultPrimaryModel } from "./provider-model-primary.js"; + +export const GOOGLE_GEMINI_DEFAULT_MODEL = "google/gemini-3.1-pro-preview"; +export const OPENAI_DEFAULT_MODEL = "openai/gpt-5.1-codex"; +export const OPENCODE_GO_DEFAULT_MODEL_REF = "opencode-go/kimi-k2.5"; +export const OPENCODE_ZEN_DEFAULT_MODEL = "opencode/claude-opus-4-6"; + +const LEGACY_OPENCODE_ZEN_DEFAULT_MODELS = new Set([ + "opencode/claude-opus-4-5", + "opencode-zen/claude-opus-4-5", +]); + +export function applyGoogleGeminiModelDefault(cfg: OpenClawConfig): { + next: OpenClawConfig; + changed: boolean; +} { + return applyAgentDefaultPrimaryModel({ cfg, model: GOOGLE_GEMINI_DEFAULT_MODEL }); +} + +export function applyOpenAIProviderConfig(cfg: OpenClawConfig): OpenClawConfig { + const next = ensureModelAllowlistEntry({ + cfg, + modelRef: OPENAI_DEFAULT_MODEL, + }); + const models = { ...next.agents?.defaults?.models }; + models[OPENAI_DEFAULT_MODEL] = { + ...models[OPENAI_DEFAULT_MODEL], + alias: models[OPENAI_DEFAULT_MODEL]?.alias ?? "GPT", + }; + + return { + ...next, + agents: { + ...next.agents, + defaults: { + ...next.agents?.defaults, + models, + }, + }, + }; +} + +export function applyOpenAIConfig(cfg: OpenClawConfig): OpenClawConfig { + const next = applyOpenAIProviderConfig(cfg); + return { + ...next, + agents: { + ...next.agents, + defaults: { + ...next.agents?.defaults, + model: + next.agents?.defaults?.model && typeof next.agents.defaults.model === "object" + ? { + ...next.agents.defaults.model, + primary: OPENAI_DEFAULT_MODEL, + } + : { primary: OPENAI_DEFAULT_MODEL }, + }, + }, + }; +} + +export function applyOpencodeGoModelDefault(cfg: OpenClawConfig): { + next: OpenClawConfig; + changed: boolean; +} { + return applyAgentDefaultPrimaryModel({ cfg, model: OPENCODE_GO_DEFAULT_MODEL_REF }); +} + +export function applyOpencodeZenModelDefault(cfg: OpenClawConfig): { + next: OpenClawConfig; + changed: boolean; +} { + return applyAgentDefaultPrimaryModel({ + cfg, + model: OPENCODE_ZEN_DEFAULT_MODEL, + legacyModels: LEGACY_OPENCODE_ZEN_DEFAULT_MODELS, + }); +} diff --git a/src/plugins/provider-model-primary.ts b/src/plugins/provider-model-primary.ts new file mode 100644 index 00000000000..bf4bd8a2fe7 --- /dev/null +++ b/src/plugins/provider-model-primary.ts @@ -0,0 +1,72 @@ +import type { OpenClawConfig } from "../config/config.js"; +import type { AgentModelListConfig } from "../config/types.js"; + +export function resolvePrimaryModel(model?: AgentModelListConfig | string): string | undefined { + if (typeof model === "string") { + return model; + } + if (model && typeof model === "object" && typeof model.primary === "string") { + return model.primary; + } + return undefined; +} + +export function applyAgentDefaultPrimaryModel(params: { + cfg: OpenClawConfig; + model: string; + legacyModels?: Set; +}): { next: OpenClawConfig; changed: boolean } { + const current = resolvePrimaryModel(params.cfg.agents?.defaults?.model)?.trim(); + const normalizedCurrent = current && params.legacyModels?.has(current) ? params.model : current; + if (normalizedCurrent === params.model) { + return { next: params.cfg, changed: false }; + } + + return { + next: { + ...params.cfg, + agents: { + ...params.cfg.agents, + defaults: { + ...params.cfg.agents?.defaults, + model: + params.cfg.agents?.defaults?.model && + typeof params.cfg.agents.defaults.model === "object" + ? { + ...params.cfg.agents.defaults.model, + primary: params.model, + } + : { primary: params.model }, + }, + }, + }, + changed: true, + }; +} + +export function applyPrimaryModel(cfg: OpenClawConfig, model: string): OpenClawConfig { + const defaults = cfg.agents?.defaults; + const existingModel = defaults?.model; + const existingModels = defaults?.models; + const fallbacks = + typeof existingModel === "object" && existingModel !== null && "fallbacks" in existingModel + ? (existingModel as { fallbacks?: string[] }).fallbacks + : undefined; + return { + ...cfg, + agents: { + ...cfg.agents, + defaults: { + ...defaults, + model: { + ...(fallbacks ? { fallbacks } : undefined), + primary: model, + }, + models: { + ...existingModels, + [model]: existingModels?.[model] ?? {}, + }, + }, + }, + }; +} diff --git a/src/plugins/provider-oauth-flow.ts b/src/plugins/provider-oauth-flow.ts new file mode 100644 index 00000000000..e2ae6717c60 --- /dev/null +++ b/src/plugins/provider-oauth-flow.ts @@ -0,0 +1,53 @@ +import type { RuntimeEnv } from "../runtime.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; + +export type OAuthPrompt = { message: string; placeholder?: string }; + +const validateRequiredInput = (value: string) => (value.trim().length > 0 ? undefined : "Required"); + +export function createVpsAwareOAuthHandlers(params: { + isRemote: boolean; + prompter: WizardPrompter; + runtime: RuntimeEnv; + spin: ReturnType; + openUrl: (url: string) => Promise; + localBrowserMessage: string; + manualPromptMessage?: string; +}): { + onAuth: (event: { url: string }) => Promise; + onPrompt: (prompt: OAuthPrompt) => Promise; +} { + const manualPromptMessage = params.manualPromptMessage ?? "Paste the redirect URL"; + let manualCodePromise: Promise | undefined; + + return { + onAuth: async ({ url }) => { + if (params.isRemote) { + params.spin.stop("OAuth URL ready"); + params.runtime.log(`\nOpen this URL in your LOCAL browser:\n\n${url}\n`); + manualCodePromise = params.prompter + .text({ + message: manualPromptMessage, + validate: validateRequiredInput, + }) + .then((value) => String(value)); + return; + } + + params.spin.update(params.localBrowserMessage); + await params.openUrl(url); + params.runtime.log(`Open: ${url}`); + }, + onPrompt: async (prompt) => { + if (manualCodePromise) { + return manualCodePromise; + } + const code = await params.prompter.text({ + message: prompt.message, + placeholder: prompt.placeholder, + validate: validateRequiredInput, + }); + return String(code); + }, + }; +} diff --git a/src/plugins/provider-openai-codex-oauth-tls.ts b/src/plugins/provider-openai-codex-oauth-tls.ts new file mode 100644 index 00000000000..bf9e69b0519 --- /dev/null +++ b/src/plugins/provider-openai-codex-oauth-tls.ts @@ -0,0 +1,164 @@ +import path from "node:path"; +import { formatCliCommand } from "../cli/command-format.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { note } from "../terminal/note.js"; + +const TLS_CERT_ERROR_CODES = new Set([ + "UNABLE_TO_GET_ISSUER_CERT_LOCALLY", + "UNABLE_TO_VERIFY_LEAF_SIGNATURE", + "CERT_HAS_EXPIRED", + "DEPTH_ZERO_SELF_SIGNED_CERT", + "SELF_SIGNED_CERT_IN_CHAIN", + "ERR_TLS_CERT_ALTNAME_INVALID", +]); + +const TLS_CERT_ERROR_PATTERNS = [ + /unable to get local issuer certificate/i, + /unable to verify the first certificate/i, + /self[- ]signed certificate/i, + /certificate has expired/i, +]; + +const OPENAI_AUTH_PROBE_URL = + "https://auth.openai.com/oauth/authorize?response_type=code&client_id=openclaw-preflight&redirect_uri=http%3A%2F%2Flocalhost%3A1455%2Fauth%2Fcallback&scope=openid+profile+email"; + +type PreflightFailureKind = "tls-cert" | "network"; + +export type OpenAIOAuthTlsPreflightResult = + | { ok: true } + | { + ok: false; + kind: PreflightFailureKind; + code?: string; + message: string; + }; + +function asRecord(value: unknown): Record | null { + return value && typeof value === "object" ? (value as Record) : null; +} + +function extractFailure(error: unknown): { + code?: string; + message: string; + kind: PreflightFailureKind; +} { + const root = asRecord(error); + const rootCause = asRecord(root?.cause); + const code = typeof rootCause?.code === "string" ? rootCause.code : undefined; + const message = + typeof rootCause?.message === "string" + ? rootCause.message + : typeof root?.message === "string" + ? root.message + : String(error); + const isTlsCertError = + (code ? TLS_CERT_ERROR_CODES.has(code) : false) || + TLS_CERT_ERROR_PATTERNS.some((pattern) => pattern.test(message)); + return { + code, + message, + kind: isTlsCertError ? "tls-cert" : "network", + }; +} + +function resolveHomebrewPrefixFromExecPath(execPath: string): string | null { + const marker = `${path.sep}Cellar${path.sep}`; + const idx = execPath.indexOf(marker); + if (idx > 0) { + return execPath.slice(0, idx); + } + const envPrefix = process.env.HOMEBREW_PREFIX?.trim(); + return envPrefix ? envPrefix : null; +} + +function resolveCertBundlePath(): string | null { + const prefix = resolveHomebrewPrefixFromExecPath(process.execPath); + if (!prefix) { + return null; + } + return path.join(prefix, "etc", "openssl@3", "cert.pem"); +} + +function hasOpenAICodexOAuthProfile(cfg: OpenClawConfig): boolean { + const profiles = cfg.auth?.profiles; + if (!profiles) { + return false; + } + return Object.values(profiles).some( + (profile) => profile.provider === "openai-codex" && profile.mode === "oauth", + ); +} + +function shouldRunOpenAIOAuthTlsPrerequisites(params: { + cfg: OpenClawConfig; + deep?: boolean; +}): boolean { + if (params.deep === true) { + return true; + } + return hasOpenAICodexOAuthProfile(params.cfg); +} + +export async function runOpenAIOAuthTlsPreflight(options?: { + timeoutMs?: number; + fetchImpl?: typeof fetch; +}): Promise { + const timeoutMs = options?.timeoutMs ?? 5000; + const fetchImpl = options?.fetchImpl ?? fetch; + try { + await fetchImpl(OPENAI_AUTH_PROBE_URL, { + method: "GET", + redirect: "manual", + signal: AbortSignal.timeout(timeoutMs), + }); + return { ok: true }; + } catch (error) { + const failure = extractFailure(error); + return { + ok: false, + kind: failure.kind, + code: failure.code, + message: failure.message, + }; + } +} + +export function formatOpenAIOAuthTlsPreflightFix( + result: Exclude, +): string { + if (result.kind !== "tls-cert") { + return [ + "OpenAI OAuth prerequisites check failed due to a network error before the browser flow.", + `Cause: ${result.message}`, + "Verify DNS/firewall/proxy access to auth.openai.com and retry.", + ].join("\n"); + } + const certBundlePath = resolveCertBundlePath(); + const lines = [ + "OpenAI OAuth prerequisites check failed: Node/OpenSSL cannot validate TLS certificates.", + `Cause: ${result.code ? `${result.code} (${result.message})` : result.message}`, + "", + "Fix (Homebrew Node/OpenSSL):", + `- ${formatCliCommand("brew postinstall ca-certificates")}`, + `- ${formatCliCommand("brew postinstall openssl@3")}`, + ]; + if (certBundlePath) { + lines.push(`- Verify cert bundle exists: ${certBundlePath}`); + } + lines.push("- Retry the OAuth login flow."); + return lines.join("\n"); +} + +export async function noteOpenAIOAuthTlsPrerequisites(params: { + cfg: OpenClawConfig; + deep?: boolean; +}): Promise { + if (!shouldRunOpenAIOAuthTlsPrerequisites(params)) { + return; + } + const result = await runOpenAIOAuthTlsPreflight({ timeoutMs: 4000 }); + if (result.ok || result.kind !== "tls-cert") { + return; + } + note(formatOpenAIOAuthTlsPreflightFix(result), "OAuth TLS prerequisites"); +} diff --git a/src/plugins/provider-openai-codex-oauth.ts b/src/plugins/provider-openai-codex-oauth.ts new file mode 100644 index 00000000000..6e16cf863f0 --- /dev/null +++ b/src/plugins/provider-openai-codex-oauth.ts @@ -0,0 +1,65 @@ +import { loginOpenAICodex, type OAuthCredentials } from "@mariozechner/pi-ai/oauth"; +import type { RuntimeEnv } from "../runtime.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; +import { createVpsAwareOAuthHandlers } from "./provider-oauth-flow.js"; +import { + formatOpenAIOAuthTlsPreflightFix, + runOpenAIOAuthTlsPreflight, +} from "./provider-openai-codex-oauth-tls.js"; + +export async function loginOpenAICodexOAuth(params: { + prompter: WizardPrompter; + runtime: RuntimeEnv; + isRemote: boolean; + openUrl: (url: string) => Promise; + localBrowserMessage?: string; +}): Promise { + const { prompter, runtime, isRemote, openUrl, localBrowserMessage } = params; + const preflight = await runOpenAIOAuthTlsPreflight(); + if (!preflight.ok && preflight.kind === "tls-cert") { + const hint = formatOpenAIOAuthTlsPreflightFix(preflight); + runtime.error(hint); + await prompter.note(hint, "OAuth prerequisites"); + throw new Error(preflight.message); + } + + await prompter.note( + isRemote + ? [ + "You are running in a remote/VPS environment.", + "A URL will be shown for you to open in your LOCAL browser.", + "After signing in, paste the redirect URL back here.", + ].join("\n") + : [ + "Browser will open for OpenAI authentication.", + "If the callback doesn't auto-complete, paste the redirect URL.", + "OpenAI OAuth uses localhost:1455 for the callback.", + ].join("\n"), + "OpenAI Codex OAuth", + ); + + const spin = prompter.progress("Starting OAuth flow…"); + try { + const { onAuth: baseOnAuth, onPrompt } = createVpsAwareOAuthHandlers({ + isRemote, + prompter, + runtime, + spin, + openUrl, + localBrowserMessage: localBrowserMessage ?? "Complete sign-in in browser…", + }); + + const creds = await loginOpenAICodex({ + onAuth: baseOnAuth, + onPrompt, + onProgress: (msg: string) => spin.update(msg), + }); + spin.stop("OpenAI OAuth complete"); + return creds ?? null; + } catch (err) { + spin.stop("OpenAI OAuth failed"); + runtime.error(String(err)); + await prompter.note("Trouble with OAuth? See https://docs.openclaw.ai/start/faq", "OAuth help"); + throw err; + } +} diff --git a/src/plugins/types.ts b/src/plugins/types.ts index 23e761940df..52cb2787977 100644 --- a/src/plugins/types.ts +++ b/src/plugins/types.ts @@ -17,8 +17,6 @@ import type { AnyAgentTool } from "../agents/tools/common.js"; import type { ThinkLevel } from "../auto-reply/thinking.js"; import type { ReplyPayload } from "../auto-reply/types.js"; import type { ChannelId, ChannelPlugin } from "../channels/plugins/types.js"; -import type { createVpsAwareOAuthHandlers } from "../commands/oauth-flow.js"; -import type { OnboardOptions } from "../commands/onboard-types.js"; import type { OpenClawConfig } from "../config/config.js"; import type { ModelProviderConfig } from "../config/types.js"; import type { GatewayRequestHandler } from "../gateway/server-methods/types.js"; @@ -39,11 +37,20 @@ import type { SpeechVoiceOption, } from "../tts/provider-types.js"; import type { WizardPrompter } from "../wizard/prompts.js"; +import type { SecretInputMode } from "./provider-auth-types.js"; +import type { createVpsAwareOAuthHandlers } from "./provider-oauth-flow.js"; import type { PluginRuntime } from "./runtime/types.js"; export type { PluginRuntime } from "./runtime/types.js"; export type { AnyAgentTool } from "../agents/tools/common.js"; +export type ProviderAuthOptionBag = { + token?: string; + tokenProvider?: string; + secretInputMode?: SecretInputMode; + [key: string]: unknown; +}; + export type PluginLogger = { debug?: (message: string) => void; info: (message: string) => void; @@ -144,7 +151,7 @@ export type ProviderAuthContext = { * `--token/--token-provider` pairs. Direct `models auth login` usually * leaves this undefined. */ - opts?: Partial; + opts?: ProviderAuthOptionBag; /** * Onboarding secret persistence preference. * @@ -152,7 +159,7 @@ export type ProviderAuthContext = { * plaintext or env/file/exec ref storage. Ad-hoc `models auth login` flows * usually leave it undefined. */ - secretInputMode?: OnboardOptions["secretInputMode"]; + secretInputMode?: SecretInputMode; /** * Whether the provider auth flow should offer the onboarding secret-storage * mode picker when `secretInputMode` is unset. @@ -196,7 +203,7 @@ export type ProviderAuthMethodNonInteractiveContext = { authChoice: string; config: OpenClawConfig; baseConfig: OpenClawConfig; - opts: OnboardOptions; + opts: ProviderAuthOptionBag; runtime: RuntimeEnv; agentDir?: string; workspaceDir?: string; diff --git a/src/wizard/setup.gateway-config.ts b/src/wizard/setup.gateway-config.ts index 74420c1dac2..ae6c9e42c6f 100644 --- a/src/wizard/setup.gateway-config.ts +++ b/src/wizard/setup.gateway-config.ts @@ -1,7 +1,3 @@ -import { - promptSecretRefForSetup, - resolveSecretInputModeForEnvSelection, -} from "../commands/auth-choice.apply-helpers.js"; import { normalizeGatewayTokenInput, randomToken, @@ -23,6 +19,10 @@ import { } from "../gateway/gateway-config-prompts.shared.js"; import { DEFAULT_DANGEROUS_NODE_COMMANDS } from "../gateway/node-command-policy.js"; import { findTailscaleBinary } from "../infra/tailscale.js"; +import { + promptSecretRefForSetup, + resolveSecretInputModeForEnvSelection, +} from "../plugins/provider-auth-input.js"; import type { RuntimeEnv } from "../runtime.js"; import { validateIPv4AddressInput } from "../shared/net/ipv4.js"; import type { WizardPrompter } from "./prompts.js"; From 68d2bd27c9a7c1d27daf4ba68ed51b2fc0ec53aa Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:08:55 -0700 Subject: [PATCH 018/187] Plugins: reject conflicting native command aliases --- src/plugins/commands.test.ts | 44 +++++++++++++++++++ src/plugins/commands.ts | 84 +++++++++++++++++++++++------------- 2 files changed, 99 insertions(+), 29 deletions(-) diff --git a/src/plugins/commands.test.ts b/src/plugins/commands.test.ts index d41841be380..c1c482e2bd2 100644 --- a/src/plugins/commands.test.ts +++ b/src/plugins/commands.test.ts @@ -131,6 +131,50 @@ describe("registerPluginCommand", () => { }); }); + it("rejects provider aliases that collide with another registered command", () => { + expect( + registerPluginCommand("demo-plugin", { + name: "voice", + nativeNames: { + telegram: "pair_device", + }, + description: "Voice command", + handler: async () => ({ text: "ok" }), + }), + ).toEqual({ ok: true }); + + expect( + registerPluginCommand("other-plugin", { + name: "pair", + nativeNames: { + telegram: "pair_device", + }, + description: "Pair command", + handler: async () => ({ text: "ok" }), + }), + ).toEqual({ + ok: false, + error: 'Command "pair_device" already registered by plugin "demo-plugin"', + }); + }); + + it("rejects reserved provider aliases", () => { + expect( + registerPluginCommand("demo-plugin", { + name: "voice", + nativeNames: { + telegram: "help", + }, + description: "Voice command", + handler: async () => ({ text: "ok" }), + }), + ).toEqual({ + ok: false, + error: + 'Native command alias "telegram" invalid: Command name "help" is reserved by a built-in command', + }); + }); + it("resolves Discord DM command bindings with the user target prefix intact", () => { expect( __testing.resolveBindingConversationFromCommand({ diff --git a/src/plugins/commands.ts b/src/plugins/commands.ts index 945d5cbfb15..b16b3aef4ed 100644 --- a/src/plugins/commands.ts +++ b/src/plugins/commands.ts @@ -130,7 +130,38 @@ export function validatePluginCommandDefinition( if (!command.description.trim()) { return "Command description cannot be empty"; } - return validateCommandName(command.name.trim()); + const nameError = validateCommandName(command.name.trim()); + if (nameError) { + return nameError; + } + for (const [label, alias] of Object.entries(command.nativeNames ?? {})) { + if (typeof alias !== "string") { + continue; + } + const aliasError = validateCommandName(alias.trim()); + if (aliasError) { + return `Native command alias "${label}" invalid: ${aliasError}`; + } + } + return null; +} + +function listPluginInvocationKeys(command: OpenClawPluginCommandDefinition): string[] { + const keys = new Set(); + const push = (value: string | undefined) => { + const normalized = value?.trim().toLowerCase(); + if (!normalized) { + return; + } + keys.add(`/${normalized}`); + }; + + push(command.name); + push(command.nativeNames?.default); + push(command.nativeNames?.telegram); + push(command.nativeNames?.discord); + + return [...keys]; } /** @@ -154,22 +185,31 @@ export function registerPluginCommand( const name = command.name.trim(); const description = command.description.trim(); - - const key = `/${name.toLowerCase()}`; - - // Check for duplicate registration - if (pluginCommands.has(key)) { - const existing = pluginCommands.get(key)!; - return { - ok: false, - error: `Command "${name}" already registered by plugin "${existing.pluginId}"`, - }; - } - - pluginCommands.set(key, { + const normalizedCommand = { ...command, name, description, + }; + const invocationKeys = listPluginInvocationKeys(normalizedCommand); + const key = `/${name.toLowerCase()}`; + + // Check for duplicate registration + for (const invocationKey of invocationKeys) { + const existing = + pluginCommands.get(invocationKey) ?? + Array.from(pluginCommands.values()).find((candidate) => + listPluginInvocationKeys(candidate).includes(invocationKey), + ); + if (existing) { + return { + ok: false, + error: `Command "${invocationKey.slice(1)}" already registered by plugin "${existing.pluginId}"`, + }; + } + } + + pluginCommands.set(key, { + ...normalizedCommand, pluginId, pluginName: opts?.pluginName, pluginRoot: opts?.pluginRoot, @@ -463,21 +503,7 @@ function resolvePluginNativeName( } function listPluginInvocationNames(command: OpenClawPluginCommandDefinition): string[] { - const names = new Set(); - const push = (value: string | undefined) => { - const normalized = value?.trim().toLowerCase(); - if (!normalized) { - return; - } - names.add(`/${normalized}`); - }; - - push(command.name); - push(command.nativeNames?.default); - push(command.nativeNames?.telegram); - push(command.nativeNames?.discord); - - return [...names]; + return listPluginInvocationKeys(command); } /** From 21f5675f031556eb4db447a5c937754c1bf1c8f1 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 21:26:35 -0700 Subject: [PATCH 019/187] Setup: trim channel setup import cycles --- extensions/discord/src/account-inspect.ts | 4 ++-- extensions/discord/src/accounts.ts | 9 +++------ extensions/discord/src/setup-core.ts | 2 +- extensions/discord/src/setup-surface.ts | 2 +- extensions/imessage/src/accounts.ts | 6 +++--- extensions/imessage/src/setup-core.ts | 2 +- extensions/imessage/src/setup-surface.ts | 4 ++-- extensions/signal/src/accounts.ts | 6 +++--- extensions/signal/src/plugin-shared.ts | 5 +++-- extensions/signal/src/setup-core.ts | 4 ++-- extensions/signal/src/setup-surface.ts | 9 +++++---- extensions/slack/src/account-inspect.ts | 6 +++--- extensions/slack/src/accounts.ts | 6 +++--- extensions/slack/src/setup-core.ts | 2 +- extensions/slack/src/setup-surface.ts | 2 +- extensions/telegram/src/setup-core.ts | 4 ++-- extensions/whatsapp/src/setup-surface.ts | 6 +++--- src/plugin-sdk-internal/discord.ts | 3 +-- src/plugin-sdk-internal/imessage.ts | 3 +-- src/plugin-sdk-internal/setup.ts | 2 -- src/plugin-sdk-internal/signal.ts | 3 +-- src/plugin-sdk-internal/slack.ts | 3 +-- 22 files changed, 43 insertions(+), 50 deletions(-) diff --git a/extensions/discord/src/account-inspect.ts b/extensions/discord/src/account-inspect.ts index c74c630cee4..3109a0f9bde 100644 --- a/extensions/discord/src/account-inspect.ts +++ b/extensions/discord/src/account-inspect.ts @@ -1,3 +1,4 @@ +import type { DiscordAccountConfig } from "../../../src/config/types.js"; import { hasConfiguredSecretInput, normalizeSecretInputString, @@ -6,8 +7,7 @@ import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, - type DiscordAccountConfig, -} from "openclaw/plugin-sdk/discord"; +} from "../../../src/plugin-sdk-internal/accounts.js"; import { mergeDiscordAccountConfig, resolveDefaultDiscordAccountId, diff --git a/extensions/discord/src/accounts.ts b/extensions/discord/src/accounts.ts index b9b8ede5fe1..f9984272bcd 100644 --- a/extensions/discord/src/accounts.ts +++ b/extensions/discord/src/accounts.ts @@ -1,14 +1,11 @@ +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { DiscordAccountConfig, DiscordActionConfig } from "../../../src/config/types.js"; import { createAccountActionGate, createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "openclaw/plugin-sdk/account-resolution"; -import type { - DiscordAccountConfig, - DiscordActionConfig, - OpenClawConfig, -} from "openclaw/plugin-sdk/discord"; +} from "../../../src/plugin-sdk-internal/accounts.js"; import { resolveDiscordToken } from "./token.js"; export type ResolvedDiscordAccount = { diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index a362824a0f3..7cdf9aa2434 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -2,7 +2,6 @@ import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, noteChannelLookupFailure, @@ -18,6 +17,7 @@ import { type ChannelSetupDmPolicy, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index da87bfd77d0..be5a374d0fa 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,6 +1,5 @@ import { DEFAULT_ACCOUNT_ID, - formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, type OpenClawConfig, @@ -13,6 +12,7 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/imessage/src/accounts.ts b/extensions/imessage/src/accounts.ts index 5ee90339aa8..8ebbe9d8ffc 100644 --- a/extensions/imessage/src/accounts.ts +++ b/extensions/imessage/src/accounts.ts @@ -1,10 +1,10 @@ +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { IMessageAccountConfig } from "../../../src/config/types.js"; import { createAccountListHelpers, normalizeAccountId, resolveAccountEntry, - type OpenClawConfig, -} from "openclaw/plugin-sdk/account-resolution"; -import type { IMessageAccountConfig } from "openclaw/plugin-sdk/imessage"; +} from "../../../src/plugin-sdk-internal/accounts.js"; export type ResolvedIMessageAccount = { accountId: string; diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index eed33e64192..2560c1cb919 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,7 +1,6 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, parseSetupEntriesAllowingWildcard, @@ -16,6 +15,7 @@ import type { ChannelSetupDmPolicy, ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index 48c9f130355..2d66c4ab6b2 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,7 +1,6 @@ +import { detectBinary } from "../../../src/commands/onboard-helpers.js"; import { DEFAULT_ACCOUNT_ID, - detectBinary, - formatDocsLink, type OpenClawConfig, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, @@ -10,6 +9,7 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/signal/src/accounts.ts b/extensions/signal/src/accounts.ts index 456db907685..9699f9394f4 100644 --- a/extensions/signal/src/accounts.ts +++ b/extensions/signal/src/accounts.ts @@ -1,10 +1,10 @@ +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { SignalAccountConfig } from "../../../src/config/types.js"; import { createAccountListHelpers, normalizeAccountId, resolveAccountEntry, - type OpenClawConfig, -} from "openclaw/plugin-sdk/account-resolution"; -import type { SignalAccountConfig } from "openclaw/plugin-sdk/signal"; +} from "../../../src/plugin-sdk-internal/accounts.js"; export type ResolvedSignalAccount = { accountId: string; diff --git a/extensions/signal/src/plugin-shared.ts b/extensions/signal/src/plugin-shared.ts index a5713e4c361..8755caf240f 100644 --- a/extensions/signal/src/plugin-shared.ts +++ b/extensions/signal/src/plugin-shared.ts @@ -1,5 +1,6 @@ -import { createScopedAccountConfigAccessors } from "openclaw/plugin-sdk/channel-config-helpers"; -import { normalizeE164, type OpenClawConfig } from "openclaw/plugin-sdk/signal"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import { createScopedAccountConfigAccessors } from "../../../src/plugin-sdk-internal/channel-config.js"; +import { normalizeE164 } from "../../../src/utils.js"; import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; import { createSignalSetupWizardProxy } from "./setup-core.js"; diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 1e479c38dc6..9b487ead841 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,8 +1,7 @@ +import { formatCliCommand } from "../../../src/cli/command-format.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, normalizeE164, @@ -18,6 +17,7 @@ import type { ChannelSetupDmPolicy, ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 72b1a4ef958..3e2f39cde2d 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,8 +1,8 @@ +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import { detectBinary } from "../../../src/commands/onboard-helpers.js"; +import { installSignalCli } from "../../../src/commands/signal-install.js"; import { - detectBinary, - formatCliCommand, - formatDocsLink, - installSignalCli, + DEFAULT_ACCOUNT_ID, type OpenClawConfig, promptParsedAllowFromForScopedChannel, setChannelDmPolicyWithAllowFrom, @@ -10,6 +10,7 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/slack/src/account-inspect.ts b/extensions/slack/src/account-inspect.ts index 7ea7ef042c2..0606a16b0bc 100644 --- a/extensions/slack/src/account-inspect.ts +++ b/extensions/slack/src/account-inspect.ts @@ -1,13 +1,13 @@ import { hasConfiguredSecretInput, normalizeSecretInputString, -} from "openclaw/plugin-sdk/config-runtime"; +} from "../../../src/config/types.secrets.js"; +import type { SlackAccountConfig } from "../../../src/config/types.slack.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, - type SlackAccountConfig, -} from "openclaw/plugin-sdk/slack"; +} from "../../../src/plugin-sdk-internal/accounts.js"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { mergeSlackAccountConfig, diff --git a/extensions/slack/src/accounts.ts b/extensions/slack/src/accounts.ts index e453067e485..7a1c25845ae 100644 --- a/extensions/slack/src/accounts.ts +++ b/extensions/slack/src/accounts.ts @@ -1,12 +1,12 @@ +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { SlackAccountConfig } from "../../../src/config/types.slack.js"; import { createAccountListHelpers, DEFAULT_ACCOUNT_ID, normalizeAccountId, normalizeChatType, resolveAccountEntry, - type OpenClawConfig, -} from "openclaw/plugin-sdk/account-resolution"; -import type { SlackAccountConfig } from "openclaw/plugin-sdk/slack"; +} from "../../../src/plugin-sdk-internal/accounts.js"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { resolveSlackAppToken, resolveSlackBotToken, resolveSlackUserToken } from "./token.js"; diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 2b3753a3c6d..8fc53239c81 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,7 +1,6 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatDocsLink, hasConfiguredSecretInput, migrateBaseNameToDefaultAccount, normalizeAccountId, @@ -20,6 +19,7 @@ import { type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 1dbfa4f02ce..4e3670ac843 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,6 +1,5 @@ import { DEFAULT_ACCOUNT_ID, - formatDocsLink, hasConfiguredSecretInput, noteChannelLookupFailure, noteChannelLookupSummary, @@ -20,6 +19,7 @@ import type { ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 13fb01f3a51..896b3b98f04 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,8 +1,7 @@ +import { formatCliCommand } from "../../../src/cli/command-format.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, patchChannelConfigForAccount, @@ -12,6 +11,7 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index bb87fc5b962..be314af285d 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -1,8 +1,8 @@ import path from "node:path"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import type { DmPolicy } from "../../../src/config/types.js"; import { DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, normalizeAccountId, normalizeAllowFromEntries, normalizeE164, @@ -12,7 +12,7 @@ import { type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { type DmPolicy } from "openclaw/plugin-sdk/whatsapp"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; import { whatsappSetupAdapter } from "./setup-core.js"; diff --git a/src/plugin-sdk-internal/discord.ts b/src/plugin-sdk-internal/discord.ts index 9a29900c717..b978b678e9d 100644 --- a/src/plugin-sdk-internal/discord.ts +++ b/src/plugin-sdk-internal/discord.ts @@ -46,8 +46,7 @@ export { resolveDiscordGroupRequireMention, resolveDiscordGroupToolPolicy, } from "../channels/plugins/group-mentions.js"; -export { discordSetupWizard } from "../../extensions/discord/src/setup-surface.js"; -export { discordSetupAdapter } from "../../extensions/discord/src/setup-core.js"; +export { discordSetupWizard } from "../../extensions/discord/src/plugin-shared.js"; export { DiscordConfigSchema } from "../config/zod-schema.providers-core.js"; export { diff --git a/src/plugin-sdk-internal/imessage.ts b/src/plugin-sdk-internal/imessage.ts index 757885fc616..ec338483b98 100644 --- a/src/plugin-sdk-internal/imessage.ts +++ b/src/plugin-sdk-internal/imessage.ts @@ -39,8 +39,7 @@ export { resolveIMessageGroupRequireMention, resolveIMessageGroupToolPolicy, } from "../channels/plugins/group-mentions.js"; -export { imessageSetupWizard } from "../../extensions/imessage/src/setup-surface.js"; -export { imessageSetupAdapter } from "../../extensions/imessage/src/setup-core.js"; +export { imessageSetupWizard } from "../../extensions/imessage/src/plugin-shared.js"; export { IMessageConfigSchema } from "../config/zod-schema.providers-core.js"; export { resolveChannelMediaMaxBytes } from "../channels/plugins/media-limits.js"; diff --git a/src/plugin-sdk-internal/setup.ts b/src/plugin-sdk-internal/setup.ts index c035d40376a..d012e201bd8 100644 --- a/src/plugin-sdk-internal/setup.ts +++ b/src/plugin-sdk-internal/setup.ts @@ -30,8 +30,6 @@ export { setSetupChannelEnabled, splitSetupEntries, } from "../channels/plugins/setup-wizard-helpers.js"; -export { detectBinary } from "../commands/onboard-helpers.js"; -export { installSignalCli } from "../commands/signal-install.js"; export { formatCliCommand } from "../cli/command-format.js"; export { formatDocsLink } from "../terminal/links.js"; export { hasConfiguredSecretInput } from "../config/types.secrets.js"; diff --git a/src/plugin-sdk-internal/signal.ts b/src/plugin-sdk-internal/signal.ts index 6b938e66518..237298f9111 100644 --- a/src/plugin-sdk-internal/signal.ts +++ b/src/plugin-sdk-internal/signal.ts @@ -25,8 +25,7 @@ export { resolveDefaultGroupPolicy, } from "../config/runtime-group-policy.js"; export { evaluateSenderGroupAccessForPolicy } from "../plugin-sdk/group-access.js"; -export { signalSetupWizard } from "../../extensions/signal/src/setup-surface.js"; -export { signalSetupAdapter } from "../../extensions/signal/src/setup-core.js"; +export { signalSetupWizard } from "../../extensions/signal/src/plugin-shared.js"; export { SignalConfigSchema } from "../config/zod-schema.providers-core.js"; export { normalizeE164 } from "../utils.js"; diff --git a/src/plugin-sdk-internal/slack.ts b/src/plugin-sdk-internal/slack.ts index abde5688cdb..c375010a9de 100644 --- a/src/plugin-sdk-internal/slack.ts +++ b/src/plugin-sdk-internal/slack.ts @@ -61,8 +61,7 @@ export { resolveSlackGroupRequireMention, resolveSlackGroupToolPolicy, } from "../channels/plugins/group-mentions.js"; -export { slackSetupAdapter } from "../../extensions/slack/src/setup-core.js"; -export { slackSetupWizard } from "../../extensions/slack/src/setup-surface.js"; +export { slackSetupWizard } from "../../extensions/slack/src/plugin-shared.js"; export { SlackConfigSchema } from "../config/zod-schema.providers-core.js"; export { handleSlackMessageAction } from "../plugin-sdk/slack-message-actions.js"; From 7fa3825e80cb888c58b116066cda3ca870802a9c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:59:30 -0700 Subject: [PATCH 020/187] feat(plugins): derive bundled web search providers from plugins --- src/plugins/contracts/loader.contract.test.ts | 73 +++--- src/plugins/providers.ts | 5 + src/plugins/web-search-providers.ts | 248 ++++++++---------- 3 files changed, 142 insertions(+), 184 deletions(-) diff --git a/src/plugins/contracts/loader.contract.test.ts b/src/plugins/contracts/loader.contract.test.ts index 874a94a0b5e..740366394a6 100644 --- a/src/plugins/contracts/loader.contract.test.ts +++ b/src/plugins/contracts/loader.contract.test.ts @@ -1,36 +1,27 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; +import { withBundledPluginAllowlistCompat } from "../bundled-compat.js"; +import { __testing as providerTesting } from "../providers.js"; +import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; import { providerContractRegistry, webSearchProviderContractRegistry } from "./registry.js"; -const loadOpenClawPluginsMock = vi.fn(); - -vi.mock("../loader.js", () => ({ - loadOpenClawPlugins: (...args: unknown[]) => loadOpenClawPluginsMock(...args), -})); - -const { resolvePluginProviders } = await import("../providers.js"); -const { resolvePluginWebSearchProviders } = await import("../web-search-providers.js"); - function uniqueSortedPluginIds(values: string[]) { return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); } +function normalizeProviderContractPluginId(pluginId: string) { + return pluginId === "kimi-coding" ? "kimi" : pluginId; +} + describe("plugin loader contract", () => { beforeEach(() => { - loadOpenClawPluginsMock.mockReset(); - loadOpenClawPluginsMock.mockReturnValue({ - providers: [], - mediaUnderstandingProviders: [], - webSearchProviders: [], - }); + vi.restoreAllMocks(); }); it("keeps bundled provider compatibility wired to the provider registry", () => { const providerPluginIds = uniqueSortedPluginIds( - providerContractRegistry.map((entry) => entry.pluginId), + providerContractRegistry.map((entry) => normalizeProviderContractPluginId(entry.pluginId)), ); - - resolvePluginProviders({ - bundledProviderAllowlistCompat: true, + const compatPluginIds = providerTesting.resolveBundledProviderCompatPluginIds({ config: { plugins: { allow: ["openrouter"], @@ -38,37 +29,35 @@ describe("plugin loader contract", () => { }, }); - expect(loadOpenClawPluginsMock).toHaveBeenCalledWith( - expect.objectContaining({ - config: expect.objectContaining({ - plugins: expect.objectContaining({ - allow: expect.arrayContaining(providerPluginIds), - }), - }), - }), + const compatConfig = withBundledPluginAllowlistCompat({ + config: { + plugins: { + allow: ["openrouter"], + }, + }, + pluginIds: compatPluginIds, + }); + + expect(uniqueSortedPluginIds(compatPluginIds)).toEqual( + expect.arrayContaining(providerPluginIds), ); + expect(compatConfig?.plugins?.allow).toEqual(expect.arrayContaining(providerPluginIds)); }); it("keeps vitest bundled provider enablement wired to the provider registry", () => { const providerPluginIds = uniqueSortedPluginIds( - providerContractRegistry.map((entry) => entry.pluginId), + providerContractRegistry.map((entry) => normalizeProviderContractPluginId(entry.pluginId)), ); - - resolvePluginProviders({ - bundledProviderVitestCompat: true, + const compatConfig = providerTesting.withBundledProviderVitestCompat({ + config: undefined, + pluginIds: providerPluginIds, env: { VITEST: "1" } as NodeJS.ProcessEnv, }); - expect(loadOpenClawPluginsMock).toHaveBeenCalledWith( - expect.objectContaining({ - config: expect.objectContaining({ - plugins: expect.objectContaining({ - enabled: true, - allow: expect.arrayContaining(providerPluginIds), - }), - }), - }), - ); + expect(compatConfig?.plugins).toMatchObject({ + enabled: true, + allow: expect.arrayContaining(providerPluginIds), + }); }); it("keeps bundled web search loading scoped to the web search registry", () => { @@ -81,7 +70,6 @@ describe("plugin loader contract", () => { expect(uniqueSortedPluginIds(providers.map((provider) => provider.pluginId))).toEqual( webSearchPluginIds, ); - expect(loadOpenClawPluginsMock).not.toHaveBeenCalled(); }); it("keeps bundled web search allowlist compatibility wired to the web search registry", () => { @@ -101,6 +89,5 @@ describe("plugin loader contract", () => { expect(uniqueSortedPluginIds(providers.map((provider) => provider.pluginId))).toEqual( webSearchPluginIds, ); - expect(loadOpenClawPluginsMock).not.toHaveBeenCalled(); }); }); diff --git a/src/plugins/providers.ts b/src/plugins/providers.ts index 35ef2703553..45c84986e6c 100644 --- a/src/plugins/providers.ts +++ b/src/plugins/providers.ts @@ -82,6 +82,11 @@ function resolveBundledProviderCompatPluginIds(params: { .toSorted((left, right) => left.localeCompare(right)); } +export const __testing = { + resolveBundledProviderCompatPluginIds, + withBundledProviderVitestCompat, +} as const; + export function resolveOwningPluginIdsForProvider(params: { provider: string; config?: PluginLoadOptions["config"]; diff --git a/src/plugins/web-search-providers.ts b/src/plugins/web-search-providers.ts index 8aba087f1fc..9ecdef1fd3c 100644 --- a/src/plugins/web-search-providers.ts +++ b/src/plugins/web-search-providers.ts @@ -1,148 +1,37 @@ -import { createFirecrawlWebSearchProvider } from "../../extensions/firecrawl/src/firecrawl-search-provider.js"; -import { - createPluginBackedWebSearchProvider, - getScopedCredentialValue, - getTopLevelCredentialValue, - setScopedCredentialValue, - setTopLevelCredentialValue, -} from "../agents/tools/web-search-plugin-factory.js"; +import bravePlugin from "../../extensions/brave/index.js"; +import firecrawlPlugin from "../../extensions/firecrawl/index.js"; +import googlePlugin from "../../extensions/google/index.js"; +import moonshotPlugin from "../../extensions/moonshot/index.js"; +import perplexityPlugin from "../../extensions/perplexity/index.js"; +import xaiPlugin from "../../extensions/xai/index.js"; import { withBundledPluginAllowlistCompat, withBundledPluginEnablementCompat, } from "./bundled-compat.js"; -import { normalizePluginsConfig, resolveEffectiveEnableState } from "./config-state.js"; import type { PluginLoadOptions } from "./loader.js"; +import type { PluginWebSearchProviderRegistration } from "./registry.js"; import { getActivePluginRegistry } from "./runtime.js"; +import type { OpenClawPluginApi, WebSearchProviderPlugin } from "./types.js"; import type { PluginWebSearchProviderEntry } from "./types.js"; -const BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS = [ - "brave", - "firecrawl", - "google", - "moonshot", - "perplexity", - "xai", -] as const; +type RegistrablePlugin = { + id: string; + name: string; + register: (api: OpenClawPluginApi) => void; +}; -const BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY = [ - { - pluginId: "brave", - provider: createPluginBackedWebSearchProvider({ - id: "brave", - label: "Brave Search", - hint: "Structured results · country/language/time filters", - envVars: ["BRAVE_API_KEY"], - placeholder: "BSA...", - signupUrl: "https://brave.com/search/api/", - docsUrl: "https://docs.openclaw.ai/brave-search", - autoDetectOrder: 10, - getCredentialValue: getTopLevelCredentialValue, - setCredentialValue: setTopLevelCredentialValue, - }), - }, - { - pluginId: "google", - provider: createPluginBackedWebSearchProvider({ - id: "gemini", - label: "Gemini (Google Search)", - hint: "Google Search grounding · AI-synthesized", - envVars: ["GEMINI_API_KEY"], - placeholder: "AIza...", - signupUrl: "https://aistudio.google.com/apikey", - docsUrl: "https://docs.openclaw.ai/tools/web", - autoDetectOrder: 20, - getCredentialValue: (searchConfig) => getScopedCredentialValue(searchConfig, "gemini"), - setCredentialValue: (searchConfigTarget, value) => - setScopedCredentialValue(searchConfigTarget, "gemini", value), - }), - }, - { - pluginId: "xai", - provider: createPluginBackedWebSearchProvider({ - id: "grok", - label: "Grok (xAI)", - hint: "xAI web-grounded responses", - envVars: ["XAI_API_KEY"], - placeholder: "xai-...", - signupUrl: "https://console.x.ai/", - docsUrl: "https://docs.openclaw.ai/tools/web", - autoDetectOrder: 30, - getCredentialValue: (searchConfig) => getScopedCredentialValue(searchConfig, "grok"), - setCredentialValue: (searchConfigTarget, value) => - setScopedCredentialValue(searchConfigTarget, "grok", value), - }), - }, - { - pluginId: "moonshot", - provider: createPluginBackedWebSearchProvider({ - id: "kimi", - label: "Kimi (Moonshot)", - hint: "Moonshot web search", - envVars: ["KIMI_API_KEY", "MOONSHOT_API_KEY"], - placeholder: "sk-...", - signupUrl: "https://platform.moonshot.cn/", - docsUrl: "https://docs.openclaw.ai/tools/web", - autoDetectOrder: 40, - getCredentialValue: (searchConfig) => getScopedCredentialValue(searchConfig, "kimi"), - setCredentialValue: (searchConfigTarget, value) => - setScopedCredentialValue(searchConfigTarget, "kimi", value), - }), - }, - { - pluginId: "perplexity", - provider: createPluginBackedWebSearchProvider({ - id: "perplexity", - label: "Perplexity Search", - hint: "Structured results · domain/country/language/time filters", - envVars: ["PERPLEXITY_API_KEY", "OPENROUTER_API_KEY"], - placeholder: "pplx-...", - signupUrl: "https://www.perplexity.ai/settings/api", - docsUrl: "https://docs.openclaw.ai/perplexity", - autoDetectOrder: 50, - getCredentialValue: (searchConfig) => getScopedCredentialValue(searchConfig, "perplexity"), - setCredentialValue: (searchConfigTarget, value) => - setScopedCredentialValue(searchConfigTarget, "perplexity", value), - }), - }, - { - pluginId: "firecrawl", - provider: createFirecrawlWebSearchProvider(), - }, -] as const; +const BUNDLED_WEB_SEARCH_PLUGINS: readonly RegistrablePlugin[] = [ + bravePlugin, + firecrawlPlugin, + googlePlugin, + moonshotPlugin, + perplexityPlugin, + xaiPlugin, +]; -export function resolvePluginWebSearchProviders(params: { - config?: PluginLoadOptions["config"]; - workspaceDir?: string; - env?: PluginLoadOptions["env"]; - bundledAllowlistCompat?: boolean; -}): PluginWebSearchProviderEntry[] { - const allowlistCompat = params.bundledAllowlistCompat - ? withBundledPluginAllowlistCompat({ - config: params.config, - pluginIds: BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS, - }) - : params.config; - const config = withBundledPluginEnablementCompat({ - config: allowlistCompat, - pluginIds: BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS, - }); - const normalizedPlugins = normalizePluginsConfig(config?.plugins); - - return sortWebSearchProviders( - BUNDLED_WEB_SEARCH_PROVIDER_REGISTRY.filter( - ({ pluginId }) => - resolveEffectiveEnableState({ - id: pluginId, - origin: "bundled", - config: normalizedPlugins, - rootConfig: config, - }).enabled, - ).map((entry) => ({ - ...entry.provider, - pluginId: entry.pluginId, - })), - ); -} +const BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS = BUNDLED_WEB_SEARCH_PLUGINS.map( + (plugin) => plugin.id, +); function sortWebSearchProviders( providers: PluginWebSearchProviderEntry[], @@ -157,18 +46,95 @@ function sortWebSearchProviders( }); } +function mapWebSearchProviderEntries( + entries: PluginWebSearchProviderRegistration[], +): PluginWebSearchProviderEntry[] { + return sortWebSearchProviders( + entries.map((entry) => ({ + ...entry.provider, + pluginId: entry.pluginId, + })), + ); +} + +function normalizeWebSearchPluginConfig(params: { + config?: PluginLoadOptions["config"]; + bundledAllowlistCompat?: boolean; +}): PluginLoadOptions["config"] { + const allowlistCompat = params.bundledAllowlistCompat + ? withBundledPluginAllowlistCompat({ + config: params.config, + pluginIds: BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS, + }) + : params.config; + return withBundledPluginEnablementCompat({ + config: allowlistCompat, + pluginIds: BUNDLED_WEB_SEARCH_ALLOWLIST_COMPAT_PLUGIN_IDS, + }); +} + +function captureBundledWebSearchProviders( + plugin: RegistrablePlugin, +): PluginWebSearchProviderRegistration[] { + const providers: WebSearchProviderPlugin[] = []; + const api = { + registerProvider() {}, + registerSpeechProvider() {}, + registerMediaUnderstandingProvider() {}, + registerWebSearchProvider(provider: WebSearchProviderPlugin) { + providers.push(provider); + }, + registerTool() {}, + }; + plugin.register(api as unknown as OpenClawPluginApi); + return providers.map((provider) => ({ + pluginId: plugin.id, + pluginName: plugin.name, + provider, + source: "bundled", + })); +} + +function resolveBundledWebSearchRegistrations(params: { + config?: PluginLoadOptions["config"]; + bundledAllowlistCompat?: boolean; +}): PluginWebSearchProviderRegistration[] { + const config = normalizeWebSearchPluginConfig(params); + if (config?.plugins?.enabled === false) { + return []; + } + const allowlist = config?.plugins?.allow + ? new Set(config.plugins.allow.map((entry) => entry.trim()).filter(Boolean)) + : null; + return BUNDLED_WEB_SEARCH_PLUGINS.flatMap((plugin) => { + if (allowlist && !allowlist.has(plugin.id)) { + return []; + } + if (config?.plugins?.entries?.[plugin.id]?.enabled === false) { + return []; + } + return captureBundledWebSearchProviders(plugin); + }); +} + +export function resolvePluginWebSearchProviders(params: { + config?: PluginLoadOptions["config"]; + workspaceDir?: string; + env?: PluginLoadOptions["env"]; + bundledAllowlistCompat?: boolean; +}): PluginWebSearchProviderEntry[] { + return mapWebSearchProviderEntries(resolveBundledWebSearchRegistrations(params)); +} + export function resolveRuntimeWebSearchProviders(params: { config?: PluginLoadOptions["config"]; + workspaceDir?: string; + env?: PluginLoadOptions["env"]; bundledAllowlistCompat?: boolean; }): PluginWebSearchProviderEntry[] { const runtimeProviders = getActivePluginRegistry()?.webSearchProviders ?? []; if (runtimeProviders.length > 0) { - return sortWebSearchProviders( - runtimeProviders.map((entry) => ({ - ...entry.provider, - pluginId: entry.pluginId, - })), - ); + return mapWebSearchProviderEntries(runtimeProviders); } return resolvePluginWebSearchProviders(params); } From 50c3321d2e758dc1516bc6f31fea860f1de8927f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 21:59:39 -0700 Subject: [PATCH 021/187] feat(media): route image tool through media providers --- extensions/anthropic/index.ts | 2 + .../anthropic/media-understanding-provider.ts | 2 + .../google/media-understanding-provider.ts | 2 + extensions/minimax/index.ts | 6 + .../minimax/media-understanding-provider.ts | 3 + extensions/mistral/index.ts | 2 + extensions/moonshot/index.ts | 2 + .../moonshot/media-understanding-provider.ts | 8 +- extensions/openai/index.ts | 2 + .../openai/media-understanding-provider.ts | 2 + extensions/zai/index.ts | 2 + .../zai/media-understanding-provider.ts | 2 + src/agents/tools/image-tool.test.ts | 13 +- src/agents/tools/image-tool.ts | 133 ++++++------- .../providers/image.test.ts | 20 +- src/media-understanding/providers/image.ts | 188 ++++++++++++++++-- src/media-understanding/providers/index.ts | 33 ++- src/media-understanding/runner.ts | 3 +- src/media-understanding/runtime.ts | 2 +- src/media-understanding/types.ts | 25 +++ src/plugin-sdk/media-understanding.ts | 5 +- .../contracts/registry.contract.test.ts | 31 +++ 22 files changed, 382 insertions(+), 106 deletions(-) diff --git a/extensions/anthropic/index.ts b/extensions/anthropic/index.ts index 25cb604dbcb..4cad353908b 100644 --- a/extensions/anthropic/index.ts +++ b/extensions/anthropic/index.ts @@ -28,6 +28,7 @@ import { } from "openclaw/plugin-sdk/provider-auth"; import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; import { fetchClaudeUsage } from "openclaw/plugin-sdk/provider-usage"; +import { anthropicMediaUnderstandingProvider } from "./media-understanding-provider.js"; const PROVIDER_ID = "anthropic"; const DEFAULT_ANTHROPIC_MODEL = "anthropic/claude-sonnet-4-6"; @@ -396,6 +397,7 @@ const anthropicPlugin = { profileId: ctx.profileId, }), }); + api.registerMediaUnderstandingProvider(anthropicMediaUnderstandingProvider); }, }; diff --git a/extensions/anthropic/media-understanding-provider.ts b/extensions/anthropic/media-understanding-provider.ts index 5b1f0711705..68a95c93546 100644 --- a/extensions/anthropic/media-understanding-provider.ts +++ b/extensions/anthropic/media-understanding-provider.ts @@ -1,5 +1,6 @@ import { describeImageWithModel, + describeImagesWithModel, type MediaUnderstandingProvider, } from "openclaw/plugin-sdk/media-understanding"; @@ -7,4 +8,5 @@ export const anthropicMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "anthropic", capabilities: ["image"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, }; diff --git a/extensions/google/media-understanding-provider.ts b/extensions/google/media-understanding-provider.ts index a64f26ca6c8..97b008ee578 100644 --- a/extensions/google/media-understanding-provider.ts +++ b/extensions/google/media-understanding-provider.ts @@ -2,6 +2,7 @@ import { normalizeGoogleModelId, parseGeminiAuth } from "openclaw/plugin-sdk/goo import { assertOkOrThrowHttpError, describeImageWithModel, + describeImagesWithModel, normalizeBaseUrl, postJsonRequest, type AudioTranscriptionRequest, @@ -142,6 +143,7 @@ export const googleMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "google", capabilities: ["image", "audio", "video"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, transcribeAudio: transcribeGeminiAudio, describeVideo: describeGeminiVideo, }; diff --git a/extensions/minimax/index.ts b/extensions/minimax/index.ts index 30894be556d..1ebf7382d52 100644 --- a/extensions/minimax/index.ts +++ b/extensions/minimax/index.ts @@ -13,6 +13,10 @@ import { listProfilesForProvider, } from "openclaw/plugin-sdk/provider-auth"; import { fetchMinimaxUsage } from "openclaw/plugin-sdk/provider-usage"; +import { + minimaxMediaUnderstandingProvider, + minimaxPortalMediaUnderstandingProvider, +} from "./media-understanding-provider.js"; import { loginMiniMaxPortalOAuth, type MiniMaxRegion } from "./oauth.js"; import { applyMinimaxApiConfig, applyMinimaxApiConfigCn } from "./onboard.js"; import { buildMinimaxPortalProvider, buildMinimaxProvider } from "./provider-catalog.js"; @@ -273,6 +277,8 @@ const minimaxPlugin = { ], isModernModelRef: ({ modelId }) => isModernMiniMaxModel(modelId), }); + api.registerMediaUnderstandingProvider(minimaxMediaUnderstandingProvider); + api.registerMediaUnderstandingProvider(minimaxPortalMediaUnderstandingProvider); }, }; diff --git a/extensions/minimax/media-understanding-provider.ts b/extensions/minimax/media-understanding-provider.ts index 2bda4f4d193..4501a96dee9 100644 --- a/extensions/minimax/media-understanding-provider.ts +++ b/extensions/minimax/media-understanding-provider.ts @@ -1,5 +1,6 @@ import { describeImageWithModel, + describeImagesWithModel, type MediaUnderstandingProvider, } from "openclaw/plugin-sdk/media-understanding"; @@ -7,10 +8,12 @@ export const minimaxMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "minimax", capabilities: ["image"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, }; export const minimaxPortalMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "minimax-portal", capabilities: ["image"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, }; diff --git a/extensions/mistral/index.ts b/extensions/mistral/index.ts index 72b3b6a60ac..5a15c50a857 100644 --- a/extensions/mistral/index.ts +++ b/extensions/mistral/index.ts @@ -1,5 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { mistralMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyMistralConfig, MISTRAL_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "mistral"; @@ -50,6 +51,7 @@ const mistralPlugin = { ], }, }); + api.registerMediaUnderstandingProvider(mistralMediaUnderstandingProvider); }, }; diff --git a/extensions/moonshot/index.ts b/extensions/moonshot/index.ts index e8d7ecedb0c..80bd7af6763 100644 --- a/extensions/moonshot/index.ts +++ b/extensions/moonshot/index.ts @@ -9,6 +9,7 @@ import { getScopedCredentialValue, setScopedCredentialValue, } from "openclaw/plugin-sdk/provider-web-search"; +import { moonshotMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyMoonshotConfig, applyMoonshotConfigCn, @@ -98,6 +99,7 @@ const moonshotPlugin = { return createMoonshotThinkingWrapper(ctx.streamFn, thinkingType); }, }); + api.registerMediaUnderstandingProvider(moonshotMediaUnderstandingProvider); api.registerWebSearchProvider( createPluginBackedWebSearchProvider({ id: "kimi", diff --git a/extensions/moonshot/media-understanding-provider.ts b/extensions/moonshot/media-understanding-provider.ts index 5814ee96e22..6c652ae58d3 100644 --- a/extensions/moonshot/media-understanding-provider.ts +++ b/extensions/moonshot/media-understanding-provider.ts @@ -1,11 +1,12 @@ import { - assertOkOrThrowHttpError, describeImageWithModel, - normalizeBaseUrl, - postJsonRequest, + describeImagesWithModel, type MediaUnderstandingProvider, type VideoDescriptionRequest, type VideoDescriptionResult, + assertOkOrThrowHttpError, + normalizeBaseUrl, + postJsonRequest, } from "openclaw/plugin-sdk/media-understanding"; export const DEFAULT_MOONSHOT_VIDEO_BASE_URL = "https://api.moonshot.ai/v1"; @@ -116,5 +117,6 @@ export const moonshotMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "moonshot", capabilities: ["image", "video"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, describeVideo: describeMoonshotVideo, }; diff --git a/extensions/openai/index.ts b/extensions/openai/index.ts index 831e49acdd8..d22b7275691 100644 --- a/extensions/openai/index.ts +++ b/extensions/openai/index.ts @@ -1,5 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { buildOpenAISpeechProvider } from "openclaw/plugin-sdk/speech"; +import { openaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { buildOpenAICodexProviderPlugin } from "./openai-codex-provider.js"; import { buildOpenAIProvider } from "./openai-provider.js"; @@ -12,6 +13,7 @@ const openAIPlugin = { api.registerProvider(buildOpenAIProvider()); api.registerProvider(buildOpenAICodexProviderPlugin()); api.registerSpeechProvider(buildOpenAISpeechProvider()); + api.registerMediaUnderstandingProvider(openaiMediaUnderstandingProvider); }, }; diff --git a/extensions/openai/media-understanding-provider.ts b/extensions/openai/media-understanding-provider.ts index dcb0a731a91..9fb66df20dc 100644 --- a/extensions/openai/media-understanding-provider.ts +++ b/extensions/openai/media-understanding-provider.ts @@ -1,5 +1,6 @@ import { describeImageWithModel, + describeImagesWithModel, transcribeOpenAiCompatibleAudio, type AudioTranscriptionRequest, type MediaUnderstandingProvider, @@ -20,5 +21,6 @@ export const openaiMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "openai", capabilities: ["image", "audio"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, transcribeAudio: transcribeOpenAiAudio, }; diff --git a/extensions/zai/index.ts b/extensions/zai/index.ts index 0faef49c4fb..109bf5144a1 100644 --- a/extensions/zai/index.ts +++ b/extensions/zai/index.ts @@ -25,6 +25,7 @@ import { DEFAULT_CONTEXT_TOKENS, normalizeModelCompat } from "openclaw/plugin-sd import { createZaiToolStreamWrapper } from "openclaw/plugin-sdk/provider-stream"; import { fetchZaiUsage } from "openclaw/plugin-sdk/provider-usage"; import { detectZaiEndpoint, type ZaiEndpointId } from "./detect.js"; +import { zaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyZaiConfig, applyZaiProviderConfig, ZAI_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "zai"; @@ -333,6 +334,7 @@ const zaiPlugin = { fetchUsageSnapshot: async (ctx) => await fetchZaiUsage(ctx.token, ctx.timeoutMs, ctx.fetchFn), isCacheTtlEligible: () => true, }); + api.registerMediaUnderstandingProvider(zaiMediaUnderstandingProvider); }, }; diff --git a/extensions/zai/media-understanding-provider.ts b/extensions/zai/media-understanding-provider.ts index 08f8c186d4d..bd571230b2d 100644 --- a/extensions/zai/media-understanding-provider.ts +++ b/extensions/zai/media-understanding-provider.ts @@ -1,5 +1,6 @@ import { describeImageWithModel, + describeImagesWithModel, type MediaUnderstandingProvider, } from "openclaw/plugin-sdk/media-understanding"; @@ -7,4 +8,5 @@ export const zaiMediaUnderstandingProvider: MediaUnderstandingProvider = { id: "zai", capabilities: ["image"], describeImage: describeImageWithModel, + describeImages: describeImagesWithModel, }; diff --git a/src/agents/tools/image-tool.test.ts b/src/agents/tools/image-tool.test.ts index bcec7f32de7..c58a7f9aa1a 100644 --- a/src/agents/tools/image-tool.test.ts +++ b/src/agents/tools/image-tool.test.ts @@ -32,6 +32,7 @@ async function withTempAgentDir(run: (agentDir: string) => Promise): Promi const ONE_PIXEL_PNG_B64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/woAAn8B9FD5fHAAAAAASUVORK5CYII="; const ONE_PIXEL_GIF_B64 = "R0lGODlhAQABAIABAP///wAAACwAAAAAAQABAAACAkQBADs="; +const ONE_PIXEL_JPEG_B64 = "QUJDRA=="; async function withTempWorkspacePng( cb: (args: { workspaceDir: string; imagePath: string }) => Promise, @@ -736,10 +737,10 @@ describe("image tool MiniMax VLM routing", () => { const res = await tool.execute("t1", { prompt: "Compare these images.", - images: [`data:image/png;base64,${pngB64}`, `data:image/gif;base64,${ONE_PIXEL_GIF_B64}`], + images: [`data:image/png;base64,${pngB64}`, `data:image/jpeg;base64,${ONE_PIXEL_JPEG_B64}`], }); - expect(fetch).toHaveBeenCalledTimes(1); + expect(fetch).toHaveBeenCalledTimes(2); const details = res.details as | { images?: Array<{ image: string }>; @@ -756,12 +757,12 @@ describe("image tool MiniMax VLM routing", () => { image: `data:image/png;base64,${pngB64}`, images: [ `data:image/png;base64,${pngB64}`, - `data:image/gif;base64,${ONE_PIXEL_GIF_B64}`, - `data:image/gif;base64,${ONE_PIXEL_GIF_B64}`, + `data:image/jpeg;base64,${ONE_PIXEL_JPEG_B64}`, + `data:image/jpeg;base64,${ONE_PIXEL_JPEG_B64}`, ], }); - expect(fetch).toHaveBeenCalledTimes(1); + expect(fetch).toHaveBeenCalledTimes(2); const dedupedDetails = deduped.details as | { images?: Array<{ image: string }>; @@ -776,7 +777,7 @@ describe("image tool MiniMax VLM routing", () => { maxImages: 1, }); - expect(fetch).toHaveBeenCalledTimes(1); + expect(fetch).toHaveBeenCalledTimes(2); expect(tooMany.details).toMatchObject({ error: "too_many_images", count: 2, diff --git a/src/agents/tools/image-tool.ts b/src/agents/tools/image-tool.ts index 402ee0b3eda..8dd471b8a7d 100644 --- a/src/agents/tools/image-tool.ts +++ b/src/agents/tools/image-tool.ts @@ -1,9 +1,10 @@ -import { type Context, complete } from "@mariozechner/pi-ai"; import { Type } from "@sinclair/typebox"; import type { OpenClawConfig } from "../../config/config.js"; +import { getMediaUnderstandingProvider } from "../../media-understanding/providers/index.js"; +import { buildProviderRegistry } from "../../media-understanding/runner.js"; import { loadWebMedia } from "../../plugin-sdk/web-media.js"; import { resolveUserPath } from "../../utils.js"; -import { isMinimaxVlmModel, isMinimaxVlmProvider, minimaxUnderstandImage } from "../minimax-vlm.js"; +import { isMinimaxVlmProvider } from "../minimax-vlm.js"; import { coerceImageAssistantText, coerceImageModelConfig, @@ -14,17 +15,12 @@ import { import { applyImageModelConfigDefaults, buildTextToolResult, - resolveModelFromRegistry, resolveMediaToolLocalRoots, - resolveModelRuntimeApiKey, resolvePromptAndModelOverride, } from "./media-tool-shared.js"; import { hasAuthForProvider, resolveDefaultModelRef } from "./model-config.helpers.js"; import { createSandboxBridgeReadFile, - discoverAuthStorage, - discoverModels, - ensureOpenClawModelsJson, resolveSandboxedBridgeMediaPath, runWithImageModelFallback, type AnyAgentTool, @@ -168,27 +164,6 @@ function pickMaxBytes(cfg?: OpenClawConfig, maxBytesMb?: number): number | undef return undefined; } -function buildImageContext( - prompt: string, - images: Array<{ base64: string; mimeType: string }>, -): Context { - const content: Array< - { type: "text"; text: string } | { type: "image"; data: string; mimeType: string } - > = [{ type: "text", text: prompt }]; - for (const img of images) { - content.push({ type: "image", data: img.base64, mimeType: img.mimeType }); - } - return { - messages: [ - { - role: "user", - content, - timestamp: Date.now(), - }, - ], - }; -} - type ImageSandboxConfig = { root: string; bridge: SandboxFsBridge; @@ -200,7 +175,7 @@ async function runImagePrompt(params: { imageModelConfig: ImageModelConfig; modelOverride?: string; prompt: string; - images: Array<{ base64: string; mimeType: string }>; + images: Array<{ buffer: Buffer; mimeType: string }>; }): Promise<{ text: string; provider: string; @@ -208,50 +183,75 @@ async function runImagePrompt(params: { attempts: Array<{ provider: string; model: string; error: string }>; }> { const effectiveCfg = applyImageModelConfigDefaults(params.cfg, params.imageModelConfig); - - await ensureOpenClawModelsJson(effectiveCfg, params.agentDir); - const authStorage = discoverAuthStorage(params.agentDir); - const modelRegistry = discoverModels(authStorage, params.agentDir); + const providerCfg: OpenClawConfig = effectiveCfg ?? {}; + const providerRegistry = buildProviderRegistry(undefined, providerCfg); const result = await runWithImageModelFallback({ cfg: effectiveCfg, modelOverride: params.modelOverride, run: async (provider, modelId) => { - const model = resolveModelFromRegistry({ modelRegistry, provider, modelId }); - if (!model.input?.includes("image")) { - throw new Error(`Model does not support images: ${provider}/${modelId}`); + const imageProvider = getMediaUnderstandingProvider(provider, providerRegistry); + if (!imageProvider) { + throw new Error(`No media-understanding provider registered for ${provider}`); } - const apiKey = await resolveModelRuntimeApiKey({ - model, - cfg: effectiveCfg, - agentDir: params.agentDir, - authStorage, - }); - - // MiniMax VLM only supports a single image; use the first one. - if (isMinimaxVlmModel(model.provider, model.id)) { - const first = params.images[0]; - const imageDataUrl = `data:${first.mimeType};base64,${first.base64}`; - const text = await minimaxUnderstandImage({ - apiKey, + if (params.images.length > 1 && imageProvider.describeImages) { + const described = await imageProvider.describeImages({ + images: params.images.map((image, index) => ({ + buffer: image.buffer, + fileName: `image-${index + 1}`, + mime: image.mimeType, + })), + provider, + model: modelId, prompt: params.prompt, - imageDataUrl, - modelBaseUrl: model.baseUrl, + maxTokens: resolveImageToolMaxTokens(undefined), + timeoutMs: 30_000, + cfg: providerCfg, + agentDir: params.agentDir, }); - return { text, provider: model.provider, model: model.id }; + return { text: described.text, provider, model: described.model ?? modelId }; + } + if (!imageProvider.describeImage) { + throw new Error(`Provider does not support image analysis: ${provider}`); + } + if (params.images.length === 1) { + const image = params.images[0]; + const described = await imageProvider.describeImage({ + buffer: image.buffer, + fileName: "image-1", + mime: image.mimeType, + provider, + model: modelId, + prompt: params.prompt, + maxTokens: resolveImageToolMaxTokens(undefined), + timeoutMs: 30_000, + cfg: providerCfg, + agentDir: params.agentDir, + }); + return { text: described.text, provider, model: described.model ?? modelId }; } - const context = buildImageContext(params.prompt, params.images); - const message = await complete(model, context, { - apiKey, - maxTokens: resolveImageToolMaxTokens(model.maxTokens), - }); - const text = coerceImageAssistantText({ - message, - provider: model.provider, - model: model.id, - }); - return { text, provider: model.provider, model: model.id }; + const parts: string[] = []; + for (const [index, image] of params.images.entries()) { + const described = await imageProvider.describeImage({ + buffer: image.buffer, + fileName: `image-${index + 1}`, + mime: image.mimeType, + provider, + model: modelId, + prompt: `${params.prompt}\n\nDescribe image ${index + 1} of ${params.images.length}.`, + maxTokens: resolveImageToolMaxTokens(undefined), + timeoutMs: 30_000, + cfg: providerCfg, + agentDir: params.agentDir, + }); + parts.push(`Image ${index + 1}:\n${described.text.trim()}`); + } + return { + text: parts.join("\n\n").trim(), + provider, + model: modelId, + }; }, }); @@ -383,7 +383,7 @@ export function createImageTool(options?: { // MARK: - Load and resolve each image const loadedImages: Array<{ - base64: string; + buffer: Buffer; mimeType: string; resolvedImage: string; rewrittenFrom?: string; @@ -469,9 +469,8 @@ export function createImageTool(options?: { ("contentType" in media && media.contentType) || ("mimeType" in media && media.mimeType) || "image/png"; - const base64 = media.buffer.toString("base64"); loadedImages.push({ - base64, + buffer: media.buffer, mimeType, resolvedImage, ...(resolvedPathInfo.rewrittenFrom @@ -487,7 +486,7 @@ export function createImageTool(options?: { imageModelConfig, modelOverride, prompt: promptRaw, - images: loadedImages.map((img) => ({ base64: img.base64, mimeType: img.mimeType })), + images: loadedImages.map((img) => ({ buffer: img.buffer, mimeType: img.mimeType })), }); const imageDetails = diff --git a/src/media-understanding/providers/image.test.ts b/src/media-understanding/providers/image.test.ts index 51c8739f43a..d52c6590eef 100644 --- a/src/media-understanding/providers/image.test.ts +++ b/src/media-understanding/providers/image.test.ts @@ -8,9 +8,15 @@ const getApiKeyForModelMock = vi.fn(async () => ({ source: "test", mode: "oauth", })); +const resolveApiKeyForProviderMock = vi.fn(async () => ({ + apiKey: "oauth-test", // pragma: allowlist secret + source: "test", + mode: "oauth", +})); const requireApiKeyMock = vi.fn((auth: { apiKey?: string }) => auth.apiKey ?? ""); const setRuntimeApiKeyMock = vi.fn(); const discoverModelsMock = vi.fn(); +let imageImportSeq = 0; vi.mock("@mariozechner/pi-ai", async (importOriginal) => { const actual = await importOriginal(); @@ -34,6 +40,7 @@ vi.mock("../../agents/models-config.js", () => ({ vi.mock("../../agents/model-auth.js", () => ({ getApiKeyForModel: getApiKeyForModelMock, + resolveApiKeyForProvider: resolveApiKeyForProviderMock, requireApiKey: requireApiKeyMock, })); @@ -44,6 +51,11 @@ vi.mock("../../agents/pi-model-discovery-runtime.js", () => ({ discoverModels: discoverModelsMock, })); +async function importImageModule() { + imageImportSeq += 1; + return await import(/* @vite-ignore */ `./image.js?case=${imageImportSeq}`); +} + describe("describeImageWithModel", () => { beforeEach(() => { vi.clearAllMocks(); @@ -59,7 +71,7 @@ describe("describeImageWithModel", () => { }); it("routes minimax-portal image models through the MiniMax VLM endpoint", async () => { - const { describeImageWithModel } = await import("./image.js"); + const { describeImageWithModel } = await importImageModule(); const result = await describeImageWithModel({ cfg: {}, @@ -109,7 +121,7 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "generic ok" }], }); - const { describeImageWithModel } = await import("./image.js"); + const { describeImageWithModel } = await importImageModule(); const result = await describeImageWithModel({ cfg: {}, @@ -153,7 +165,7 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "flash ok" }], }); - const { describeImageWithModel } = await import("./image.js"); + const { describeImageWithModel } = await importImageModule(); const result = await describeImageWithModel({ cfg: {}, @@ -203,7 +215,7 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "flash lite ok" }], }); - const { describeImageWithModel } = await import("./image.js"); + const { describeImageWithModel } = await importImageModule(); const result = await describeImageWithModel({ cfg: {}, diff --git a/src/media-understanding/providers/image.ts b/src/media-understanding/providers/image.ts index 1511a7c9bb9..9d7dc67949b 100644 --- a/src/media-understanding/providers/image.ts +++ b/src/media-understanding/providers/image.ts @@ -1,11 +1,20 @@ import type { Api, Context, Model } from "@mariozechner/pi-ai"; import { complete } from "@mariozechner/pi-ai"; import { isMinimaxVlmModel, minimaxUnderstandImage } from "../../agents/minimax-vlm.js"; -import { getApiKeyForModel, requireApiKey } from "../../agents/model-auth.js"; +import { + getApiKeyForModel, + requireApiKey, + resolveApiKeyForProvider, +} from "../../agents/model-auth.js"; import { normalizeModelRef } from "../../agents/model-selection.js"; import { ensureOpenClawModelsJson } from "../../agents/models-config.js"; import { coerceImageAssistantText } from "../../agents/tools/image-tool.helpers.js"; -import type { ImageDescriptionRequest, ImageDescriptionResult } from "../types.js"; +import type { + ImageDescriptionRequest, + ImageDescriptionResult, + ImagesDescriptionRequest, + ImagesDescriptionResult, +} from "../types.js"; let piModelDiscoveryRuntimePromise: Promise< typeof import("../../agents/pi-model-discovery-runtime.js") @@ -16,14 +25,29 @@ function loadPiModelDiscoveryRuntime() { return piModelDiscoveryRuntimePromise; } -export async function describeImageWithModel( - params: ImageDescriptionRequest, -): Promise { +function resolveImageToolMaxTokens(modelMaxTokens: number | undefined, requestedMaxTokens = 4096) { + if ( + typeof modelMaxTokens !== "number" || + !Number.isFinite(modelMaxTokens) || + modelMaxTokens <= 0 + ) { + return requestedMaxTokens; + } + return Math.min(requestedMaxTokens, modelMaxTokens); +} + +async function resolveImageRuntime(params: { + cfg: ImageDescriptionRequest["cfg"]; + agentDir: string; + provider: string; + model: string; + profile?: string; + preferredProfile?: string; +}): Promise<{ apiKey: string; model: Model }> { await ensureOpenClawModelsJson(params.cfg, params.agentDir); const { discoverAuthStorage, discoverModels } = await loadPiModelDiscoveryRuntime(); const authStorage = discoverAuthStorage(params.agentDir); const modelRegistry = discoverModels(authStorage, params.agentDir); - // Keep direct media config entries compatible with deprecated provider model aliases. const resolvedRef = normalizeModelRef(params.provider, params.model); const model = modelRegistry.find(resolvedRef.provider, resolvedRef.model) as Model | null; if (!model) { @@ -41,33 +65,132 @@ export async function describeImageWithModel( }); const apiKey = requireApiKey(apiKeyInfo, model.provider); authStorage.setRuntimeApiKey(model.provider, apiKey); + return { apiKey, model }; +} - const base64 = params.buffer.toString("base64"); - if (isMinimaxVlmModel(model.provider, model.id)) { - const text = await minimaxUnderstandImage({ - apiKey, - prompt: params.prompt ?? "Describe the image.", - imageDataUrl: `data:${params.mime ?? "image/jpeg"};base64,${base64}`, - modelBaseUrl: model.baseUrl, - }); - return { text, model: model.id }; - } - - const context: Context = { +function buildImageContext( + prompt: string, + images: Array<{ buffer: Buffer; mime?: string }>, +): Context { + return { messages: [ { role: "user", content: [ - { type: "text", text: params.prompt ?? "Describe the image." }, - { type: "image", data: base64, mimeType: params.mime ?? "image/jpeg" }, + { type: "text", text: prompt }, + ...images.map((image) => ({ + type: "image" as const, + data: image.buffer.toString("base64"), + mimeType: image.mime ?? "image/jpeg", + })), ], timestamp: Date.now(), }, ], }; +} + +async function describeImagesWithMinimax(params: { + apiKey: string; + modelId: string; + modelBaseUrl?: string; + prompt: string; + images: Array<{ buffer: Buffer; mime?: string }>; +}): Promise { + const responses: string[] = []; + for (const [index, image] of params.images.entries()) { + const prompt = + params.images.length > 1 + ? `${params.prompt}\n\nDescribe image ${index + 1} of ${params.images.length} independently.` + : params.prompt; + const text = await minimaxUnderstandImage({ + apiKey: params.apiKey, + prompt, + imageDataUrl: `data:${image.mime ?? "image/jpeg"};base64,${image.buffer.toString("base64")}`, + modelBaseUrl: params.modelBaseUrl, + }); + responses.push(params.images.length > 1 ? `Image ${index + 1}:\n${text.trim()}` : text.trim()); + } + return { + text: responses.join("\n\n").trim(), + model: params.modelId, + }; +} + +function isUnknownModelError(err: unknown): boolean { + return err instanceof Error && /^Unknown model:/i.test(err.message); +} + +function resolveConfiguredProviderBaseUrl( + cfg: ImageDescriptionRequest["cfg"], + provider: string, +): string | undefined { + const direct = cfg.models?.providers?.[provider]; + if (typeof direct?.baseUrl === "string" && direct.baseUrl.trim()) { + return direct.baseUrl.trim(); + } + return undefined; +} + +async function resolveMinimaxVlmFallbackRuntime(params: { + cfg: ImageDescriptionRequest["cfg"]; + agentDir: string; + provider: string; + profile?: string; + preferredProfile?: string; +}): Promise<{ apiKey: string; modelBaseUrl?: string }> { + const auth = await resolveApiKeyForProvider({ + provider: params.provider, + cfg: params.cfg, + profileId: params.profile, + preferredProfile: params.preferredProfile, + agentDir: params.agentDir, + }); + return { + apiKey: requireApiKey(auth, params.provider), + modelBaseUrl: resolveConfiguredProviderBaseUrl(params.cfg, params.provider), + }; +} + +export async function describeImagesWithModel( + params: ImagesDescriptionRequest, +): Promise { + const prompt = params.prompt ?? "Describe the image."; + let apiKey: string; + let model: Model | undefined; + + try { + const resolved = await resolveImageRuntime(params); + apiKey = resolved.apiKey; + model = resolved.model; + } catch (err) { + if (!isMinimaxVlmModel(params.provider, params.model) || !isUnknownModelError(err)) { + throw err; + } + const fallback = await resolveMinimaxVlmFallbackRuntime(params); + return await describeImagesWithMinimax({ + apiKey: fallback.apiKey, + modelId: params.model, + modelBaseUrl: fallback.modelBaseUrl, + prompt, + images: params.images, + }); + } + + if (isMinimaxVlmModel(model.provider, model.id)) { + return await describeImagesWithMinimax({ + apiKey, + modelId: model.id, + modelBaseUrl: model.baseUrl, + prompt, + images: params.images, + }); + } + + const context = buildImageContext(prompt, params.images); const message = await complete(model, context, { apiKey, - maxTokens: params.maxTokens ?? 512, + maxTokens: resolveImageToolMaxTokens(model.maxTokens, params.maxTokens ?? 512), }); const text = coerceImageAssistantText({ message, @@ -76,3 +199,26 @@ export async function describeImageWithModel( }); return { text, model: model.id }; } + +export async function describeImageWithModel( + params: ImageDescriptionRequest, +): Promise { + return await describeImagesWithModel({ + images: [ + { + buffer: params.buffer, + fileName: params.fileName, + mime: params.mime, + }, + ], + model: params.model, + provider: params.provider, + prompt: params.prompt, + maxTokens: params.maxTokens, + timeoutMs: params.timeoutMs, + profile: params.profile, + preferredProfile: params.preferredProfile, + agentDir: params.agentDir, + cfg: params.cfg, + }); +} diff --git a/src/media-understanding/providers/index.ts b/src/media-understanding/providers/index.ts index 67a45fc2019..32d1d6bcf9a 100644 --- a/src/media-understanding/providers/index.ts +++ b/src/media-understanding/providers/index.ts @@ -1,10 +1,33 @@ +import { anthropicMediaUnderstandingProvider } from "../../../extensions/anthropic/media-understanding-provider.js"; +import { googleMediaUnderstandingProvider } from "../../../extensions/google/media-understanding-provider.js"; +import { + minimaxMediaUnderstandingProvider, + minimaxPortalMediaUnderstandingProvider, +} from "../../../extensions/minimax/media-understanding-provider.js"; +import { mistralMediaUnderstandingProvider } from "../../../extensions/mistral/media-understanding-provider.js"; +import { moonshotMediaUnderstandingProvider } from "../../../extensions/moonshot/media-understanding-provider.js"; +import { openaiMediaUnderstandingProvider } from "../../../extensions/openai/media-understanding-provider.js"; +import { zaiMediaUnderstandingProvider } from "../../../extensions/zai/media-understanding-provider.js"; import { normalizeProviderId } from "../../agents/model-selection.js"; +import type { OpenClawConfig } from "../../config/config.js"; +import { loadOpenClawPlugins } from "../../plugins/loader.js"; import { getActivePluginRegistry } from "../../plugins/runtime.js"; import type { MediaUnderstandingProvider } from "../types.js"; import { deepgramProvider } from "./deepgram/index.js"; import { groqProvider } from "./groq/index.js"; -const PROVIDERS: MediaUnderstandingProvider[] = [groqProvider, deepgramProvider]; +const PROVIDERS: MediaUnderstandingProvider[] = [ + groqProvider, + deepgramProvider, + anthropicMediaUnderstandingProvider, + googleMediaUnderstandingProvider, + minimaxMediaUnderstandingProvider, + minimaxPortalMediaUnderstandingProvider, + mistralMediaUnderstandingProvider, + moonshotMediaUnderstandingProvider, + openaiMediaUnderstandingProvider, + zaiMediaUnderstandingProvider, +]; function mergeProviderIntoRegistry( registry: Map, @@ -32,12 +55,18 @@ export function normalizeMediaProviderId(id: string): string { export function buildMediaUnderstandingRegistry( overrides?: Record, + cfg?: OpenClawConfig, ): Map { const registry = new Map(); for (const provider of PROVIDERS) { mergeProviderIntoRegistry(registry, provider); } - for (const entry of getActivePluginRegistry()?.mediaUnderstandingProviders ?? []) { + const active = getActivePluginRegistry(); + const pluginRegistry = + (active?.mediaUnderstandingProviders?.length ?? 0) > 0 || !cfg + ? active + : loadOpenClawPlugins({ config: cfg }); + for (const entry of pluginRegistry?.mediaUnderstandingProviders ?? []) { mergeProviderIntoRegistry(registry, entry.provider); } if (overrides) { diff --git a/src/media-understanding/runner.ts b/src/media-understanding/runner.ts index a04cc6420fa..807edb45c22 100644 --- a/src/media-understanding/runner.ts +++ b/src/media-understanding/runner.ts @@ -75,8 +75,9 @@ export type RunCapabilityResult = { export function buildProviderRegistry( overrides?: Record, + cfg?: OpenClawConfig, ): ProviderRegistry { - return buildMediaUnderstandingRegistry(overrides); + return buildMediaUnderstandingRegistry(overrides, cfg); } export function normalizeMediaAttachments(ctx: MsgContext): MediaAttachment[] { diff --git a/src/media-understanding/runtime.ts b/src/media-understanding/runtime.ts index e9351921dac..043baf81f91 100644 --- a/src/media-understanding/runtime.ts +++ b/src/media-understanding/runtime.ts @@ -48,7 +48,7 @@ export async function runMediaUnderstandingFile( return { text: undefined }; } - const providerRegistry = buildProviderRegistry(); + const providerRegistry = buildProviderRegistry(undefined, params.cfg); const cache = createMediaAttachmentCache(attachments, { localPathRoots: [path.dirname(params.filePath)], }); diff --git a/src/media-understanding/types.ts b/src/media-understanding/types.ts index 60c425626de..36c467e105f 100644 --- a/src/media-understanding/types.ts +++ b/src/media-understanding/types.ts @@ -90,6 +90,25 @@ export type ImageDescriptionRequest = { buffer: Buffer; fileName: string; mime?: string; + prompt?: string; + maxTokens?: number; + timeoutMs: number; + profile?: string; + preferredProfile?: string; + agentDir: string; + cfg: import("../config/config.js").OpenClawConfig; + model: string; + provider: string; +}; + +export type ImagesDescriptionInput = { + buffer: Buffer; + fileName: string; + mime?: string; +}; + +export type ImagesDescriptionRequest = { + images: ImagesDescriptionInput[]; model: string; provider: string; prompt?: string; @@ -106,10 +125,16 @@ export type ImageDescriptionResult = { model?: string; }; +export type ImagesDescriptionResult = { + text: string; + model?: string; +}; + export type MediaUnderstandingProvider = { id: string; capabilities?: MediaUnderstandingCapability[]; transcribeAudio?: (req: AudioTranscriptionRequest) => Promise; describeVideo?: (req: VideoDescriptionRequest) => Promise; describeImage?: (req: ImageDescriptionRequest) => Promise; + describeImages?: (req: ImagesDescriptionRequest) => Promise; }; diff --git a/src/plugin-sdk/media-understanding.ts b/src/plugin-sdk/media-understanding.ts index 052736afc3d..0d14685dbdf 100644 --- a/src/plugin-sdk/media-understanding.ts +++ b/src/plugin-sdk/media-understanding.ts @@ -5,12 +5,15 @@ export type { AudioTranscriptionResult, ImageDescriptionRequest, ImageDescriptionResult, + ImagesDescriptionInput, + ImagesDescriptionRequest, + ImagesDescriptionResult, MediaUnderstandingProvider, VideoDescriptionRequest, VideoDescriptionResult, } from "../media-understanding/types.js"; -export { describeImageWithModel } from "../media-understanding/providers/image.js"; +export { describeImageWithModel, describeImagesWithModel } from "../media-understanding/providers/image.js"; export { transcribeOpenAiCompatibleAudio } from "../media-understanding/providers/openai-compatible-audio.js"; export { assertOkOrThrowHttpError, diff --git a/src/plugins/contracts/registry.contract.test.ts b/src/plugins/contracts/registry.contract.test.ts index 06430449808..0f6d588ea1a 100644 --- a/src/plugins/contracts/registry.contract.test.ts +++ b/src/plugins/contracts/registry.contract.test.ts @@ -43,6 +43,16 @@ function findMediaUnderstandingProviderIdsForPlugin(pluginId: string) { .toSorted((left, right) => left.localeCompare(right)); } +function findMediaUnderstandingProviderForPlugin(pluginId: string) { + const entry = mediaUnderstandingProviderContractRegistry.find( + (candidate) => candidate.pluginId === pluginId, + ); + if (!entry) { + throw new Error(`media-understanding provider contract missing for ${pluginId}`); + } + return entry.provider; +} + function findRegistrationForPlugin(pluginId: string) { const entry = pluginRegistrationContractRegistry.find( (candidate) => candidate.pluginId === pluginId, @@ -141,4 +151,25 @@ describe("plugin contract registry", () => { expect(findSpeechProviderForPlugin("elevenlabs").listVoices).toEqual(expect.any(Function)); expect(findSpeechProviderForPlugin("microsoft").listVoices).toEqual(expect.any(Function)); }); + + it("keeps bundled multi-image support explicit", () => { + expect(findMediaUnderstandingProviderForPlugin("anthropic").describeImages).toEqual( + expect.any(Function), + ); + expect(findMediaUnderstandingProviderForPlugin("google").describeImages).toEqual( + expect.any(Function), + ); + expect(findMediaUnderstandingProviderForPlugin("minimax").describeImages).toEqual( + expect.any(Function), + ); + expect(findMediaUnderstandingProviderForPlugin("moonshot").describeImages).toEqual( + expect.any(Function), + ); + expect(findMediaUnderstandingProviderForPlugin("openai").describeImages).toEqual( + expect.any(Function), + ); + expect(findMediaUnderstandingProviderForPlugin("zai").describeImages).toEqual( + expect.any(Function), + ); + }); }); From da34f81ce23744c2a69e37ab585e2cc95b6adf9b Mon Sep 17 00:00:00 2001 From: Josh Avant <830519+joshavant@users.noreply.github.com> Date: Tue, 17 Mar 2026 00:01:34 -0500 Subject: [PATCH 022/187] fix(secrets): scope message SecretRef resolution and harden doctor/status paths (#48728) * fix(secrets): scope message runtime resolution and harden doctor/status * docs: align message/doctor/status SecretRef behavior notes * test(cli): accept scoped targetIds wiring in secret-resolution coverage * fix(secrets): keep scoped allowedPaths isolation and tighten coverage gate * fix(secrets): avoid default-account coercion in scoped target selection * test(doctor): cover inactive telegram secretref inspect path * docs Signed-off-by: joshavant <830519+joshavant@users.noreply.github.com> * changelog Signed-off-by: joshavant <830519+joshavant@users.noreply.github.com> --------- Signed-off-by: joshavant <830519+joshavant@users.noreply.github.com> --- CHANGELOG.md | 1 + docs/channels/discord.md | 2 +- docs/cli/doctor.md | 2 + docs/cli/message.md | 10 +++ docs/cli/status.md | 1 + src/agents/tools/discord-actions-messaging.ts | 74 +++++++++------- src/agents/tools/discord-actions.test.ts | 53 +++++++++-- src/agents/tools/message-tool.test.ts | 71 ++++++++++++++- src/agents/tools/message-tool.ts | 39 +++++--- src/channels/plugins/message-actions.test.ts | 41 ++++++++- src/channels/plugins/message-actions.ts | 88 +++++++++++++++++-- src/cli/command-secret-gateway.test.ts | 39 ++++++++ src/cli/command-secret-gateway.ts | 8 ++ ...command-secret-resolution.coverage.test.ts | 9 +- src/cli/command-secret-targets.test.ts | 80 +++++++++++++++++ src/cli/command-secret-targets.ts | 66 +++++++++++++- src/cli/message-secret-scope.test.ts | 56 ++++++++++++ src/cli/message-secret-scope.ts | 83 +++++++++++++++++ src/commands/doctor-config-flow.test.ts | 55 ++++++++++++ src/commands/doctor-config-flow.ts | 17 +++- src/commands/message.test.ts | 7 ++ src/commands/message.ts | 17 +++- src/commands/status-all.ts | 21 +++-- src/commands/status-all/diagnosis.ts | 12 +++ src/commands/status-all/report-lines.test.ts | 6 ++ src/infra/outbound/channel-selection.test.ts | 20 +++++ src/infra/outbound/channel-selection.ts | 52 ++++++++++- 27 files changed, 854 insertions(+), 76 deletions(-) create mode 100644 src/cli/message-secret-scope.test.ts create mode 100644 src/cli/message-secret-scope.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ff37ae11c0..042332d3844 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,6 +31,7 @@ Docs: https://docs.openclaw.ai - Browser/existing-session: support `browser.profiles..userDataDir` so Chrome DevTools MCP can attach to Brave, Edge, and other Chromium-based browsers through their own user data directories. (#48170) Thanks @velvet-shark. - Skills/prompt budget: preserve all registered skills via a compact catalog fallback before dropping entries when the full prompt format exceeds `maxSkillsPromptChars`. (#47553) Thanks @snese. - Plugins/bundles: make enabled bundle MCP servers expose runnable tools in embedded Pi, and default relative bundle MCP launches to the bundle root so marketplace bundles like Context7 work through Pi instead of stopping at config import. +- Scope message SecretRef resolution and harden doctor/status paths. (#48728) Thanks @joshavant. ### Breaking diff --git a/docs/channels/discord.md b/docs/channels/discord.md index e179417e9b8..2b2266c4c83 100644 --- a/docs/channels/discord.md +++ b/docs/channels/discord.md @@ -168,7 +168,7 @@ openclaw pairing approve discord Token resolution is account-aware. Config token values win over env fallback. `DISCORD_BOT_TOKEN` is only used for the default account. -For advanced outbound calls (message tool/channel actions), an explicit per-call `token` is used for that call. Account policy/retry settings still come from the selected account in the active runtime snapshot. +For advanced outbound calls (message tool/channel actions), an explicit per-call `token` is used for that call. This applies to send and read/probe-style actions (for example read/search/fetch/thread/pins/permissions). Account policy/retry settings still come from the selected account in the active runtime snapshot. ## Recommended: Set up a guild workspace diff --git a/docs/cli/doctor.md b/docs/cli/doctor.md index 4718135ee68..d5429b5b01c 100644 --- a/docs/cli/doctor.md +++ b/docs/cli/doctor.md @@ -32,6 +32,8 @@ Notes: - Doctor includes a memory-search readiness check and can recommend `openclaw configure --section model` when embedding credentials are missing. - If sandbox mode is enabled but Docker is unavailable, doctor reports a high-signal warning with remediation (`install Docker` or `openclaw config set agents.defaults.sandbox.mode off`). - If `gateway.auth.token`/`gateway.auth.password` are SecretRef-managed and unavailable in the current command path, doctor reports a read-only warning and does not write plaintext fallback credentials. +- If channel SecretRef inspection fails in a fix path, doctor continues and reports a warning instead of exiting early. +- Telegram `allowFrom` username auto-resolution (`doctor --fix`) requires a resolvable Telegram token in the current command path. If token inspection is unavailable, doctor reports a warning and skips auto-resolution for that pass. ## macOS: `launchctl` env overrides diff --git a/docs/cli/message.md b/docs/cli/message.md index 1633554f316..665d0e74bd2 100644 --- a/docs/cli/message.md +++ b/docs/cli/message.md @@ -50,6 +50,16 @@ Name lookup: - `--dry-run` - `--verbose` +## SecretRef behavior + +- `openclaw message` resolves supported channel SecretRefs before running the selected action. +- Resolution is scoped to the active action target when possible: + - channel-scoped when `--channel` is set (or inferred from prefixed targets like `discord:...`) + - account-scoped when `--account` is set (channel globals + selected account surfaces) + - when `--account` is omitted, OpenClaw does not force a `default` account SecretRef scope +- Unresolved SecretRefs on unrelated channels do not block a targeted message action. +- If the selected channel/account SecretRef is unresolved, the command fails closed for that action. + ## Actions ### Core diff --git a/docs/cli/status.md b/docs/cli/status.md index 770bf6ab50d..3f0f5bb5bf8 100644 --- a/docs/cli/status.md +++ b/docs/cli/status.md @@ -27,3 +27,4 @@ Notes: - Read-only status surfaces (`status`, `status --json`, `status --all`) resolve supported SecretRefs for their targeted config paths when possible. - If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as “configured token unavailable in this command path”, and JSON output includes `secretDiagnostics`. - When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient “secret unavailable” channel markers from the final output. +- `status --all` includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation. diff --git a/src/agents/tools/discord-actions-messaging.ts b/src/agents/tools/discord-actions-messaging.ts index 20fdfcc6a02..bad969ede80 100644 --- a/src/agents/tools/discord-actions-messaging.ts +++ b/src/agents/tools/discord-actions-messaging.ts @@ -182,8 +182,8 @@ export async function handleDiscordMessagingAction( } const channelId = resolveChannelId(); const permissions = accountId - ? await fetchChannelPermissionsDiscord(channelId, { accountId }) - : await fetchChannelPermissionsDiscord(channelId); + ? await fetchChannelPermissionsDiscord(channelId, { ...cfgOptions, accountId }) + : await fetchChannelPermissionsDiscord(channelId, cfgOptions); return jsonResult({ ok: true, permissions }); } case "fetchMessage": { @@ -206,8 +206,8 @@ export async function handleDiscordMessagingAction( ); } const message = accountId - ? await fetchMessageDiscord(channelId, messageId, { accountId }) - : await fetchMessageDiscord(channelId, messageId); + ? await fetchMessageDiscord(channelId, messageId, { ...cfgOptions, accountId }) + : await fetchMessageDiscord(channelId, messageId, cfgOptions); return jsonResult({ ok: true, message: normalizeMessage(message), @@ -228,8 +228,8 @@ export async function handleDiscordMessagingAction( around: readStringParam(params, "around"), }; const messages = accountId - ? await readMessagesDiscord(channelId, query, { accountId }) - : await readMessagesDiscord(channelId, query); + ? await readMessagesDiscord(channelId, query, { ...cfgOptions, accountId }) + : await readMessagesDiscord(channelId, query, cfgOptions); return jsonResult({ ok: true, messages: messages.map((message) => normalizeMessage(message)), @@ -338,8 +338,8 @@ export async function handleDiscordMessagingAction( required: true, }); const message = accountId - ? await editMessageDiscord(channelId, messageId, { content }, { accountId }) - : await editMessageDiscord(channelId, messageId, { content }); + ? await editMessageDiscord(channelId, messageId, { content }, { ...cfgOptions, accountId }) + : await editMessageDiscord(channelId, messageId, { content }, cfgOptions); return jsonResult({ ok: true, message }); } case "deleteMessage": { @@ -351,9 +351,9 @@ export async function handleDiscordMessagingAction( required: true, }); if (accountId) { - await deleteMessageDiscord(channelId, messageId, { accountId }); + await deleteMessageDiscord(channelId, messageId, { ...cfgOptions, accountId }); } else { - await deleteMessageDiscord(channelId, messageId); + await deleteMessageDiscord(channelId, messageId, cfgOptions); } return jsonResult({ ok: true }); } @@ -375,8 +375,8 @@ export async function handleDiscordMessagingAction( appliedTags: appliedTags ?? undefined, }; const thread = accountId - ? await createThreadDiscord(channelId, payload, { accountId }) - : await createThreadDiscord(channelId, payload); + ? await createThreadDiscord(channelId, payload, { ...cfgOptions, accountId }) + : await createThreadDiscord(channelId, payload, cfgOptions); return jsonResult({ ok: true, thread }); } case "threadList": { @@ -399,15 +399,18 @@ export async function handleDiscordMessagingAction( before, limit, }, - { accountId }, + { ...cfgOptions, accountId }, ) - : await listThreadsDiscord({ - guildId, - channelId, - includeArchived, - before, - limit, - }); + : await listThreadsDiscord( + { + guildId, + channelId, + includeArchived, + before, + limit, + }, + cfgOptions, + ); return jsonResult({ ok: true, threads }); } case "threadReply": { @@ -438,9 +441,9 @@ export async function handleDiscordMessagingAction( required: true, }); if (accountId) { - await pinMessageDiscord(channelId, messageId, { accountId }); + await pinMessageDiscord(channelId, messageId, { ...cfgOptions, accountId }); } else { - await pinMessageDiscord(channelId, messageId); + await pinMessageDiscord(channelId, messageId, cfgOptions); } return jsonResult({ ok: true }); } @@ -453,9 +456,9 @@ export async function handleDiscordMessagingAction( required: true, }); if (accountId) { - await unpinMessageDiscord(channelId, messageId, { accountId }); + await unpinMessageDiscord(channelId, messageId, { ...cfgOptions, accountId }); } else { - await unpinMessageDiscord(channelId, messageId); + await unpinMessageDiscord(channelId, messageId, cfgOptions); } return jsonResult({ ok: true }); } @@ -465,8 +468,8 @@ export async function handleDiscordMessagingAction( } const channelId = resolveChannelId(); const pins = accountId - ? await listPinsDiscord(channelId, { accountId }) - : await listPinsDiscord(channelId); + ? await listPinsDiscord(channelId, { ...cfgOptions, accountId }) + : await listPinsDiscord(channelId, cfgOptions); return jsonResult({ ok: true, pins: pins.map((pin) => normalizeMessage(pin)) }); } case "searchMessages": { @@ -495,15 +498,18 @@ export async function handleDiscordMessagingAction( authorIds: authorIdList.length ? authorIdList : undefined, limit, }, - { accountId }, + { ...cfgOptions, accountId }, ) - : await searchMessagesDiscord({ - guildId, - content, - channelIds: channelIdList.length ? channelIdList : undefined, - authorIds: authorIdList.length ? authorIdList : undefined, - limit, - }); + : await searchMessagesDiscord( + { + guildId, + content, + channelIds: channelIdList.length ? channelIdList : undefined, + authorIds: authorIdList.length ? authorIdList : undefined, + limit, + }, + cfgOptions, + ); if (!results || typeof results !== "object") { return jsonResult({ ok: true, results }); } diff --git a/src/agents/tools/discord-actions.test.ts b/src/agents/tools/discord-actions.test.ts index ab2d71caf23..c03cb2fdafa 100644 --- a/src/agents/tools/discord-actions.test.ts +++ b/src/agents/tools/discord-actions.test.ts @@ -211,6 +211,24 @@ describe("handleDiscordMessagingAction", () => { expect(payload.messages[0].timestampUtc).toBe(new Date(expectedMs).toISOString()); }); + it("threads provided cfg into readMessages calls", async () => { + const cfg = { + channels: { + discord: { + token: "token", + }, + }, + } as OpenClawConfig; + await handleDiscordMessagingAction( + "readMessages", + { channelId: "C1" }, + enableAllActions, + {}, + cfg, + ); + expect(readMessagesDiscord).toHaveBeenCalledWith("C1", expect.any(Object), { cfg }); + }); + it("adds normalized timestamps to fetchMessage payloads", async () => { fetchMessageDiscord.mockResolvedValueOnce({ id: "1", @@ -229,6 +247,24 @@ describe("handleDiscordMessagingAction", () => { expect(payload.message?.timestampUtc).toBe(new Date(expectedMs).toISOString()); }); + it("threads provided cfg into fetchMessage calls", async () => { + const cfg = { + channels: { + discord: { + token: "token", + }, + }, + } as OpenClawConfig; + await handleDiscordMessagingAction( + "fetchMessage", + { guildId: "G1", channelId: "C1", messageId: "M1" }, + enableAllActions, + {}, + cfg, + ); + expect(fetchMessageDiscord).toHaveBeenCalledWith("C1", "M1", { cfg }); + }); + it("adds normalized timestamps to listPins payloads", async () => { listPinsDiscord.mockResolvedValueOnce([{ id: "1", timestamp: "2026-01-15T12:00:00.000Z" }]); @@ -338,12 +374,17 @@ describe("handleDiscordMessagingAction", () => { }, enableAllActions, ); - expect(createThreadDiscord).toHaveBeenCalledWith("C1", { - name: "Forum thread", - messageId: undefined, - autoArchiveMinutes: undefined, - content: "Initial forum post body", - }); + expect(createThreadDiscord).toHaveBeenCalledWith( + "C1", + { + name: "Forum thread", + messageId: undefined, + autoArchiveMinutes: undefined, + content: "Initial forum post body", + appliedTags: undefined, + }, + {}, + ); }); }); diff --git a/src/agents/tools/message-tool.test.ts b/src/agents/tools/message-tool.test.ts index a148494c8de..88062eacaa7 100644 --- a/src/agents/tools/message-tool.test.ts +++ b/src/agents/tools/message-tool.test.ts @@ -1,4 +1,4 @@ -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { ChannelMessageCapability } from "../../channels/plugins/message-capabilities.js"; import type { ChannelMessageActionName, ChannelPlugin } from "../../channels/plugins/types.js"; import type { MessageActionRunResult } from "../../infra/outbound/message-action-runner.js"; @@ -8,6 +8,11 @@ import { createMessageTool } from "./message-tool.js"; const mocks = vi.hoisted(() => ({ runMessageAction: vi.fn(), + loadConfig: vi.fn(() => ({})), + resolveCommandSecretRefsViaGateway: vi.fn(async ({ config }: { config: unknown }) => ({ + resolvedConfig: config, + diagnostics: [], + })), })); vi.mock("../../infra/outbound/message-action-runner.js", async () => { @@ -20,6 +25,18 @@ vi.mock("../../infra/outbound/message-action-runner.js", async () => { }; }); +vi.mock("../../config/config.js", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + loadConfig: mocks.loadConfig, + }; +}); + +vi.mock("../../cli/command-secret-gateway.js", () => ({ + resolveCommandSecretRefsViaGateway: mocks.resolveCommandSecretRefsViaGateway, +})); + function mockSendResult(overrides: { channel?: string; to?: string } = {}) { mocks.runMessageAction.mockClear(); mocks.runMessageAction.mockResolvedValue({ @@ -41,6 +58,15 @@ function getActionEnum(properties: Record) { return (properties.action as { enum?: string[] } | undefined)?.enum ?? []; } +beforeEach(() => { + mocks.runMessageAction.mockReset(); + mocks.loadConfig.mockReset().mockReturnValue({}); + mocks.resolveCommandSecretRefsViaGateway.mockReset().mockImplementation(async ({ config }) => ({ + resolvedConfig: config, + diagnostics: [], + })); +}); + function createChannelPlugin(params: { id: string; label: string; @@ -101,6 +127,49 @@ async function executeSend(params: { | undefined; } +describe("message tool secret scoping", () => { + it("scopes command-time secret resolution to the selected channel/account", async () => { + mockSendResult({ channel: "discord", to: "discord:123" }); + mocks.loadConfig.mockReturnValue({ + channels: { + discord: { + token: { source: "env", provider: "default", id: "DISCORD_TOKEN" }, + accounts: { + ops: { token: { source: "env", provider: "default", id: "DISCORD_OPS_TOKEN" } }, + chat: { token: { source: "env", provider: "default", id: "DISCORD_CHAT_TOKEN" } }, + }, + }, + slack: { + botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" }, + }, + }, + }); + + const tool = createMessageTool({ + currentChannelProvider: "discord", + agentAccountId: "ops", + }); + + await tool.execute("1", { + action: "send", + target: "channel:123", + message: "hi", + }); + + const secretResolveCall = mocks.resolveCommandSecretRefsViaGateway.mock.calls[0]?.[0] as { + targetIds?: Set; + allowedPaths?: Set; + }; + expect(secretResolveCall.targetIds).toBeInstanceOf(Set); + expect( + [...(secretResolveCall.targetIds ?? [])].every((id) => id.startsWith("channels.discord.")), + ).toBe(true); + expect(secretResolveCall.allowedPaths).toEqual( + new Set(["channels.discord.token", "channels.discord.accounts.ops.token"]), + ); + }); +}); + describe("message tool agent routing", () => { it("derives agentId from the session key", async () => { mockSendResult(); diff --git a/src/agents/tools/message-tool.ts b/src/agents/tools/message-tool.ts index 0e6c846e75d..1dcaf04e1f0 100644 --- a/src/agents/tools/message-tool.ts +++ b/src/agents/tools/message-tool.ts @@ -12,7 +12,8 @@ import { type ChannelMessageActionName, } from "../../channels/plugins/types.js"; import { resolveCommandSecretRefsViaGateway } from "../../cli/command-secret-gateway.js"; -import { getChannelsCommandSecretTargetIds } from "../../cli/command-secret-targets.js"; +import { getScopedChannelsCommandSecretTargets } from "../../cli/command-secret-targets.js"; +import { resolveMessageSecretScope } from "../../cli/message-secret-scope.js"; import type { OpenClawConfig } from "../../config/config.js"; import { loadConfig } from "../../config/config.js"; import { GATEWAY_CLIENT_IDS, GATEWAY_CLIENT_MODES } from "../../gateway/protocol/client-info.js"; @@ -820,19 +821,35 @@ export function createMessageTool(options?: MessageToolOptions): AnyAgentTool { } } - const cfg = options?.config - ? options.config - : ( - await resolveCommandSecretRefsViaGateway({ - config: loadConfig(), - commandName: "tools.message", - targetIds: getChannelsCommandSecretTargetIds(), - mode: "enforce_resolved", - }) - ).resolvedConfig; const action = readStringParam(params, "action", { required: true, }) as ChannelMessageActionName; + let cfg = options?.config; + if (!cfg) { + const loadedRaw = loadConfig(); + const scope = resolveMessageSecretScope({ + channel: params.channel, + target: params.target, + targets: params.targets, + fallbackChannel: options?.currentChannelProvider, + accountId: params.accountId, + fallbackAccountId: agentAccountId, + }); + const scopedTargets = getScopedChannelsCommandSecretTargets({ + config: loadedRaw, + channel: scope.channel, + accountId: scope.accountId, + }); + cfg = ( + await resolveCommandSecretRefsViaGateway({ + config: loadedRaw, + commandName: "tools.message", + targetIds: scopedTargets.targetIds, + ...(scopedTargets.allowedPaths ? { allowedPaths: scopedTargets.allowedPaths } : {}), + mode: "enforce_resolved", + }) + ).resolvedConfig; + } const requireExplicitTarget = options?.requireExplicitTarget === true; if (requireExplicitTarget && actionNeedsExplicitTarget(action)) { const explicitTarget = diff --git a/src/channels/plugins/message-actions.test.ts b/src/channels/plugins/message-actions.test.ts index 92af406e2f1..17fdf8fe193 100644 --- a/src/channels/plugins/message-actions.test.ts +++ b/src/channels/plugins/message-actions.test.ts @@ -1,13 +1,16 @@ -import { afterEach, describe, expect, it } from "vitest"; +import { afterEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; import { setActivePluginRegistry } from "../../plugins/runtime.js"; +import { defaultRuntime } from "../../runtime.js"; import { createChannelTestPluginBase, createTestRegistry, } from "../../test-utils/channel-plugins.js"; import { + __testing, channelSupportsMessageCapability, channelSupportsMessageCapabilityForChannel, + listChannelMessageActions, listChannelMessageCapabilities, listChannelMessageCapabilitiesForChannel, } from "./message-actions.js"; @@ -56,8 +59,12 @@ function activateMessageActionTestRegistry() { } describe("message action capability checks", () => { + const errorSpy = vi.spyOn(defaultRuntime, "error").mockImplementation(() => undefined); + afterEach(() => { setActivePluginRegistry(emptyRegistry); + __testing.resetLoggedMessageActionErrors(); + errorSpy.mockClear(); }); it("aggregates capabilities across plugins", () => { @@ -122,4 +129,36 @@ describe("message action capability checks", () => { false, ); }); + + it("skips crashing action/capability discovery paths and logs once", () => { + const crashingPlugin: ChannelPlugin = { + ...createChannelTestPluginBase({ + id: "discord", + label: "Discord", + capabilities: { chatTypes: ["direct", "group"] }, + config: { + listAccountIds: () => ["default"], + }, + }), + actions: { + listActions: () => { + throw new Error("boom"); + }, + getCapabilities: () => { + throw new Error("boom"); + }, + }, + }; + setActivePluginRegistry( + createTestRegistry([{ pluginId: "discord", source: "test", plugin: crashingPlugin }]), + ); + + expect(listChannelMessageActions({} as OpenClawConfig)).toEqual(["send", "broadcast"]); + expect(listChannelMessageCapabilities({} as OpenClawConfig)).toEqual([]); + expect(errorSpy).toHaveBeenCalledTimes(2); + + expect(listChannelMessageActions({} as OpenClawConfig)).toEqual(["send", "broadcast"]); + expect(listChannelMessageCapabilities({} as OpenClawConfig)).toEqual([]); + expect(errorSpy).toHaveBeenCalledTimes(2); + }); }); diff --git a/src/channels/plugins/message-actions.ts b/src/channels/plugins/message-actions.ts index 506f2204493..07d08171582 100644 --- a/src/channels/plugins/message-actions.ts +++ b/src/channels/plugins/message-actions.ts @@ -1,5 +1,6 @@ import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { OpenClawConfig } from "../../config/config.js"; +import { defaultRuntime } from "../../runtime.js"; import { getChannelPlugin, listChannelPlugins } from "./index.js"; import type { ChannelMessageCapability } from "./message-capabilities.js"; import type { ChannelMessageActionContext, ChannelMessageActionName } from "./types.js"; @@ -16,13 +17,54 @@ function requiresTrustedRequesterSender(ctx: ChannelMessageActionContext): boole ); } +const loggedMessageActionErrors = new Set(); + +function logMessageActionError(params: { + pluginId: string; + operation: "listActions" | "getCapabilities"; + error: unknown; +}) { + const message = params.error instanceof Error ? params.error.message : String(params.error); + const key = `${params.pluginId}:${params.operation}:${message}`; + if (loggedMessageActionErrors.has(key)) { + return; + } + loggedMessageActionErrors.add(key); + const stack = params.error instanceof Error && params.error.stack ? params.error.stack : null; + defaultRuntime.error?.( + `[message-actions] ${params.pluginId}.actions.${params.operation} failed: ${stack ?? message}`, + ); +} + +function runListActionsSafely(params: { + pluginId: string; + cfg: OpenClawConfig; + listActions: NonNullable; +}): ChannelMessageActionName[] { + try { + const listed = params.listActions({ cfg: params.cfg }); + return Array.isArray(listed) ? listed : []; + } catch (error) { + logMessageActionError({ + pluginId: params.pluginId, + operation: "listActions", + error, + }); + return []; + } +} + export function listChannelMessageActions(cfg: OpenClawConfig): ChannelMessageActionName[] { const actions = new Set(["send", "broadcast"]); for (const plugin of listChannelPlugins()) { - const list = plugin.actions?.listActions?.({ cfg }); - if (!list) { + if (!plugin.actions?.listActions) { continue; } + const list = runListActionsSafely({ + pluginId: plugin.id, + cfg, + listActions: plugin.actions.listActions, + }); for (const action of list) { actions.add(action); } @@ -30,11 +72,21 @@ export function listChannelMessageActions(cfg: OpenClawConfig): ChannelMessageAc return Array.from(actions); } -function listCapabilities( - actions: ChannelActions, - cfg: OpenClawConfig, -): readonly ChannelMessageCapability[] { - return actions.getCapabilities?.({ cfg }) ?? []; +function listCapabilities(params: { + pluginId: string; + actions: ChannelActions; + cfg: OpenClawConfig; +}): readonly ChannelMessageCapability[] { + try { + return params.actions.getCapabilities?.({ cfg: params.cfg }) ?? []; + } catch (error) { + logMessageActionError({ + pluginId: params.pluginId, + operation: "getCapabilities", + error, + }); + return []; + } } export function listChannelMessageCapabilities(cfg: OpenClawConfig): ChannelMessageCapability[] { @@ -43,7 +95,11 @@ export function listChannelMessageCapabilities(cfg: OpenClawConfig): ChannelMess if (!plugin.actions) { continue; } - for (const capability of listCapabilities(plugin.actions, cfg)) { + for (const capability of listCapabilities({ + pluginId: plugin.id, + actions: plugin.actions, + cfg, + })) { capabilities.add(capability); } } @@ -58,7 +114,15 @@ export function listChannelMessageCapabilitiesForChannel(params: { return []; } const plugin = getChannelPlugin(params.channel as Parameters[0]); - return plugin?.actions ? Array.from(listCapabilities(plugin.actions, params.cfg)) : []; + return plugin?.actions + ? Array.from( + listCapabilities({ + pluginId: plugin.id, + actions: plugin.actions, + cfg: params.cfg, + }), + ) + : []; } export function channelSupportsMessageCapability( @@ -95,3 +159,9 @@ export async function dispatchChannelMessageAction( } return await plugin.actions.handleAction(ctx); } + +export const __testing = { + resetLoggedMessageActionErrors() { + loggedMessageActionErrors.clear(); + }, +}; diff --git a/src/cli/command-secret-gateway.test.ts b/src/cli/command-secret-gateway.test.ts index c9de91d4257..6a2dff29582 100644 --- a/src/cli/command-secret-gateway.test.ts +++ b/src/cli/command-secret-gateway.test.ts @@ -155,6 +155,45 @@ describe("resolveCommandSecretRefsViaGateway", () => { expect(result.resolvedConfig.talk?.apiKey).toBe("sk-live"); }); + it("enforces unresolved checks only for allowed paths when provided", async () => { + callGateway.mockResolvedValueOnce({ + assignments: [ + { + path: "channels.discord.accounts.ops.token", + pathSegments: ["channels", "discord", "accounts", "ops", "token"], + value: "ops-token", + }, + ], + diagnostics: [], + }); + + const result = await resolveCommandSecretRefsViaGateway({ + config: { + channels: { + discord: { + accounts: { + ops: { + token: { source: "env", provider: "default", id: "DISCORD_OPS_TOKEN" }, + }, + chat: { + token: { source: "env", provider: "default", id: "DISCORD_CHAT_TOKEN" }, + }, + }, + }, + }, + } as OpenClawConfig, + commandName: "message", + targetIds: new Set(["channels.discord.accounts.*.token"]), + allowedPaths: new Set(["channels.discord.accounts.ops.token"]), + }); + + expect(result.resolvedConfig.channels?.discord?.accounts?.ops?.token).toBe("ops-token"); + expect(result.targetStatesByPath).toEqual({ + "channels.discord.accounts.ops.token": "resolved_gateway", + }); + expect(result.hadUnresolvedTargets).toBe(false); + }); + it("fails fast when gateway-backed resolution is unavailable", async () => { const envKey = "TALK_API_KEY_FAILFAST"; const priorValue = process.env[envKey]; diff --git a/src/cli/command-secret-gateway.ts b/src/cli/command-secret-gateway.ts index 8b2b73c9f0f..bab49155c94 100644 --- a/src/cli/command-secret-gateway.ts +++ b/src/cli/command-secret-gateway.ts @@ -120,10 +120,14 @@ function targetsRuntimeWebResolution(params: { function collectConfiguredTargetRefPaths(params: { config: OpenClawConfig; targetIds: Set; + allowedPaths?: ReadonlySet; }): Set { const defaults = params.config.secrets?.defaults; const configuredTargetRefPaths = new Set(); for (const target of discoverConfigSecretTargetsByIds(params.config, params.targetIds)) { + if (params.allowedPaths && !params.allowedPaths.has(target.path)) { + continue; + } const { ref } = resolveSecretInputRef({ value: target.value, refValue: target.refValue, @@ -449,11 +453,13 @@ export async function resolveCommandSecretRefsViaGateway(params: { commandName: string; targetIds: Set; mode?: CommandSecretResolutionModeInput; + allowedPaths?: ReadonlySet; }): Promise { const mode = normalizeCommandSecretResolutionMode(params.mode); const configuredTargetRefPaths = collectConfiguredTargetRefPaths({ config: params.config, targetIds: params.targetIds, + allowedPaths: params.allowedPaths, }); if (configuredTargetRefPaths.size === 0) { return { @@ -498,6 +504,7 @@ export async function resolveCommandSecretRefsViaGateway(params: { targetIds: params.targetIds, preflightDiagnostics: preflight.diagnostics, mode, + allowedPaths: params.allowedPaths, }); const recoveredLocally = Object.values(fallback.targetStatesByPath).some( (state) => state === "resolved_local", @@ -556,6 +563,7 @@ export async function resolveCommandSecretRefsViaGateway(params: { resolvedConfig, targetIds: params.targetIds, inactiveRefPaths, + allowedPaths: params.allowedPaths, }); let diagnostics = dedupeDiagnostics(parsed.diagnostics); const targetStatesByPath = buildTargetStatesByPath({ diff --git a/src/cli/command-secret-resolution.coverage.test.ts b/src/cli/command-secret-resolution.coverage.test.ts index 5508c39792f..fea0fb35eec 100644 --- a/src/cli/command-secret-resolution.coverage.test.ts +++ b/src/cli/command-secret-resolution.coverage.test.ts @@ -14,6 +14,13 @@ const SECRET_TARGET_CALLSITES = [ "src/commands/status.scan.ts", ] as const; +function hasSupportedTargetIdsWiring(source: string): boolean { + return ( + /targetIds:\s*get[A-Za-z0-9_]+\(\)/m.test(source) || + /targetIds:\s*scopedTargets\.targetIds/m.test(source) + ); +} + describe("command secret resolution coverage", () => { it.each(SECRET_TARGET_CALLSITES)( "routes target-id command path through shared gateway resolver: %s", @@ -21,7 +28,7 @@ describe("command secret resolution coverage", () => { const absolutePath = path.join(process.cwd(), relativePath); const source = await fs.readFile(absolutePath, "utf8"); expect(source).toContain("resolveCommandSecretRefsViaGateway"); - expect(source).toContain("targetIds: get"); + expect(hasSupportedTargetIdsWiring(source)).toBe(true); expect(source).toContain("resolveCommandSecretRefsViaGateway({"); }, ); diff --git a/src/cli/command-secret-targets.test.ts b/src/cli/command-secret-targets.test.ts index 22a23b36055..5f6a98b70bc 100644 --- a/src/cli/command-secret-targets.test.ts +++ b/src/cli/command-secret-targets.test.ts @@ -2,6 +2,7 @@ import { describe, expect, it } from "vitest"; import { getAgentRuntimeCommandSecretTargetIds, getMemoryCommandSecretTargetIds, + getScopedChannelsCommandSecretTargets, getSecurityAuditCommandSecretTargetIds, } from "./command-secret-targets.js"; @@ -31,4 +32,83 @@ describe("command secret target ids", () => { expect(ids.has("gateway.remote.token")).toBe(true); expect(ids.has("gateway.remote.password")).toBe(true); }); + + it("scopes channel targets to the requested channel", () => { + const scoped = getScopedChannelsCommandSecretTargets({ + config: {} as never, + channel: "discord", + }); + + expect(scoped.targetIds.size).toBeGreaterThan(0); + expect([...scoped.targetIds].every((id) => id.startsWith("channels.discord."))).toBe(true); + expect([...scoped.targetIds].some((id) => id.startsWith("channels.telegram."))).toBe(false); + }); + + it("does not coerce missing accountId to default when channel is scoped", () => { + const scoped = getScopedChannelsCommandSecretTargets({ + config: { + channels: { + discord: { + defaultAccount: "ops", + accounts: { + ops: { + token: { source: "env", provider: "default", id: "DISCORD_OPS" }, + }, + }, + }, + }, + } as never, + channel: "discord", + }); + + expect(scoped.allowedPaths).toBeUndefined(); + expect(scoped.targetIds.size).toBeGreaterThan(0); + expect([...scoped.targetIds].every((id) => id.startsWith("channels.discord."))).toBe(true); + }); + + it("scopes allowed paths to channel globals + selected account", () => { + const scoped = getScopedChannelsCommandSecretTargets({ + config: { + channels: { + discord: { + token: { source: "env", provider: "default", id: "DISCORD_DEFAULT" }, + accounts: { + ops: { + token: { source: "env", provider: "default", id: "DISCORD_OPS" }, + }, + chat: { + token: { source: "env", provider: "default", id: "DISCORD_CHAT" }, + }, + }, + }, + }, + } as never, + channel: "discord", + accountId: "ops", + }); + + expect(scoped.allowedPaths).toBeDefined(); + expect(scoped.allowedPaths?.has("channels.discord.token")).toBe(true); + expect(scoped.allowedPaths?.has("channels.discord.accounts.ops.token")).toBe(true); + expect(scoped.allowedPaths?.has("channels.discord.accounts.chat.token")).toBe(false); + }); + + it("keeps account-scoped allowedPaths as an empty set when scoped target paths are absent", () => { + const scoped = getScopedChannelsCommandSecretTargets({ + config: { + channels: { + discord: { + accounts: { + ops: { enabled: true }, + }, + }, + }, + } as never, + channel: "custom-plugin-channel-without-secret-targets", + accountId: "ops", + }); + + expect(scoped.allowedPaths).toBeDefined(); + expect(scoped.allowedPaths?.size).toBe(0); + }); }); diff --git a/src/cli/command-secret-targets.ts b/src/cli/command-secret-targets.ts index d6dde83cd19..89284892f34 100644 --- a/src/cli/command-secret-targets.ts +++ b/src/cli/command-secret-targets.ts @@ -1,4 +1,9 @@ -import { listSecretTargetRegistryEntries } from "../secrets/target-registry.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { normalizeOptionalAccountId } from "../routing/session-key.js"; +import { + discoverConfigSecretTargetsByIds, + listSecretTargetRegistryEntries, +} from "../secrets/target-registry.js"; function idsByPrefix(prefixes: readonly string[]): string[] { return listSecretTargetRegistryEntries() @@ -37,6 +42,65 @@ function toTargetIdSet(values: readonly string[]): Set { return new Set(values); } +function normalizeScopedChannelId(value?: string | null): string | undefined { + const trimmed = value?.trim(); + return trimmed ? trimmed : undefined; +} + +function selectChannelTargetIds(channel?: string): Set { + if (!channel) { + return toTargetIdSet(COMMAND_SECRET_TARGETS.channels); + } + return toTargetIdSet( + COMMAND_SECRET_TARGETS.channels.filter((id) => id.startsWith(`channels.${channel}.`)), + ); +} + +function pathTargetsScopedChannelAccount(params: { + pathSegments: readonly string[]; + channel: string; + accountId: string; +}): boolean { + const [root, channelId, accountRoot, accountId] = params.pathSegments; + if (root !== "channels" || channelId !== params.channel) { + return false; + } + if (accountRoot !== "accounts") { + return true; + } + return accountId === params.accountId; +} + +export function getScopedChannelsCommandSecretTargets(params: { + config: OpenClawConfig; + channel?: string | null; + accountId?: string | null; +}): { + targetIds: Set; + allowedPaths?: Set; +} { + const channel = normalizeScopedChannelId(params.channel); + const targetIds = selectChannelTargetIds(channel); + const normalizedAccountId = normalizeOptionalAccountId(params.accountId); + if (!channel || !normalizedAccountId) { + return { targetIds }; + } + + const allowedPaths = new Set(); + for (const target of discoverConfigSecretTargetsByIds(params.config, targetIds)) { + if ( + pathTargetsScopedChannelAccount({ + pathSegments: target.pathSegments, + channel, + accountId: normalizedAccountId, + }) + ) { + allowedPaths.add(target.path); + } + } + return { targetIds, allowedPaths }; +} + export function getMemoryCommandSecretTargetIds(): Set { return toTargetIdSet(COMMAND_SECRET_TARGETS.memory); } diff --git a/src/cli/message-secret-scope.test.ts b/src/cli/message-secret-scope.test.ts new file mode 100644 index 00000000000..9e243f48b7c --- /dev/null +++ b/src/cli/message-secret-scope.test.ts @@ -0,0 +1,56 @@ +import { describe, expect, it } from "vitest"; +import { resolveMessageSecretScope } from "./message-secret-scope.js"; + +describe("resolveMessageSecretScope", () => { + it("prefers explicit channel/account inputs", () => { + expect( + resolveMessageSecretScope({ + channel: "Discord", + accountId: "Ops", + }), + ).toEqual({ + channel: "discord", + accountId: "ops", + }); + }); + + it("infers channel from a prefixed target", () => { + expect( + resolveMessageSecretScope({ + target: "telegram:12345", + }), + ).toEqual({ + channel: "telegram", + }); + }); + + it("infers a shared channel from target arrays", () => { + expect( + resolveMessageSecretScope({ + targets: ["discord:one", "discord:two"], + }), + ).toEqual({ + channel: "discord", + }); + }); + + it("does not infer a channel when target arrays mix channels", () => { + expect( + resolveMessageSecretScope({ + targets: ["discord:one", "slack:two"], + }), + ).toEqual({}); + }); + + it("uses fallback channel/account when direct inputs are missing", () => { + expect( + resolveMessageSecretScope({ + fallbackChannel: "Signal", + fallbackAccountId: "Chat", + }), + ).toEqual({ + channel: "signal", + accountId: "chat", + }); + }); +}); diff --git a/src/cli/message-secret-scope.ts b/src/cli/message-secret-scope.ts new file mode 100644 index 00000000000..5dd72655ec6 --- /dev/null +++ b/src/cli/message-secret-scope.ts @@ -0,0 +1,83 @@ +import { normalizeAccountId } from "../routing/session-key.js"; +import { isDeliverableMessageChannel, normalizeMessageChannel } from "../utils/message-channel.js"; + +function resolveScopedChannelCandidate(value: unknown): string | undefined { + if (typeof value !== "string") { + return undefined; + } + const normalized = normalizeMessageChannel(value); + if (!normalized || !isDeliverableMessageChannel(normalized)) { + return undefined; + } + return normalized; +} + +function resolveChannelFromTargetValue(target: unknown): string | undefined { + if (typeof target !== "string") { + return undefined; + } + const trimmed = target.trim(); + if (!trimmed) { + return undefined; + } + const separator = trimmed.indexOf(":"); + if (separator <= 0) { + return undefined; + } + return resolveScopedChannelCandidate(trimmed.slice(0, separator)); +} + +function resolveChannelFromTargets(targets: unknown): string | undefined { + if (!Array.isArray(targets)) { + return undefined; + } + const seen = new Set(); + for (const target of targets) { + const channel = resolveChannelFromTargetValue(target); + if (channel) { + seen.add(channel); + } + } + if (seen.size !== 1) { + return undefined; + } + return [...seen][0]; +} + +function resolveScopedAccountId(value: unknown): string | undefined { + if (typeof value !== "string") { + return undefined; + } + const trimmed = value.trim(); + if (!trimmed) { + return undefined; + } + return normalizeAccountId(trimmed); +} + +export function resolveMessageSecretScope(params: { + channel?: unknown; + target?: unknown; + targets?: unknown; + fallbackChannel?: string | null; + accountId?: unknown; + fallbackAccountId?: string | null; +}): { + channel?: string; + accountId?: string; +} { + const channel = + resolveScopedChannelCandidate(params.channel) ?? + resolveChannelFromTargetValue(params.target) ?? + resolveChannelFromTargets(params.targets) ?? + resolveScopedChannelCandidate(params.fallbackChannel); + + const accountId = + resolveScopedAccountId(params.accountId) ?? + resolveScopedAccountId(params.fallbackAccountId ?? undefined); + + return { + ...(channel ? { channel } : {}), + ...(accountId ? { accountId } : {}), + }; +} diff --git a/src/commands/doctor-config-flow.test.ts b/src/commands/doctor-config-flow.test.ts index a1b204b5990..39e7b9d00fe 100644 --- a/src/commands/doctor-config-flow.test.ts +++ b/src/commands/doctor-config-flow.test.ts @@ -387,6 +387,61 @@ describe("doctor config flow", () => { } }); + it("warns and continues when Telegram account inspection hits inactive SecretRef surfaces", async () => { + const noteSpy = vi.spyOn(noteModule, "note").mockImplementation(() => {}); + const fetchSpy = vi.fn(); + vi.stubGlobal("fetch", fetchSpy); + try { + const result = await runDoctorConfigWithInput({ + repair: true, + config: { + secrets: { + providers: { + default: { source: "env" }, + }, + }, + channels: { + telegram: { + accounts: { + inactive: { + enabled: false, + botToken: { source: "env", provider: "default", id: "TELEGRAM_BOT_TOKEN" }, + allowFrom: ["@testuser"], + }, + }, + }, + }, + }, + run: loadAndMaybeMigrateDoctorConfig, + }); + + const cfg = result.cfg as { + channels?: { + telegram?: { + accounts?: Record; + }; + }; + }; + expect(cfg.channels?.telegram?.accounts?.inactive?.allowFrom).toEqual(["@testuser"]); + expect(fetchSpy).not.toHaveBeenCalled(); + expect( + noteSpy.mock.calls.some((call) => + String(call[0]).includes("Telegram account inactive: failed to inspect bot token"), + ), + ).toBe(true); + expect( + noteSpy.mock.calls.some((call) => + String(call[0]).includes( + "Telegram allowFrom contains @username entries, but no Telegram bot token is configured", + ), + ), + ).toBe(true); + } finally { + noteSpy.mockRestore(); + vi.unstubAllGlobals(); + } + }); + it("converts numeric discord ids to strings on repair", async () => { await withTempHome(async (home) => { const configDir = path.join(home, ".openclaw"); diff --git a/src/commands/doctor-config-flow.ts b/src/commands/doctor-config-flow.ts index 912869f390b..ae755423987 100644 --- a/src/commands/doctor-config-flow.ts +++ b/src/commands/doctor-config-flow.ts @@ -40,6 +40,7 @@ import { normalizeAccountId, normalizeOptionalAccountId, } from "../routing/session-key.js"; +import { describeUnknownError } from "../secrets/shared.js"; import { isDiscordMutableAllowEntry, isGoogleChatMutableAllowEntry, @@ -334,10 +335,23 @@ async function maybeRepairTelegramAllowFromUsernames(cfg: OpenClawConfig): Promi const inspected = inspectTelegramAccount({ cfg, accountId }); return inspected.enabled && inspected.tokenStatus === "configured_unavailable"; }); + const tokenResolutionWarnings: string[] = []; const tokens = Array.from( new Set( listTelegramAccountIds(resolvedConfig) - .map((accountId) => resolveTelegramAccount({ cfg: resolvedConfig, accountId })) + .map((accountId) => { + try { + return resolveTelegramAccount({ cfg: resolvedConfig, accountId }); + } catch (error) { + tokenResolutionWarnings.push( + `- Telegram account ${accountId}: failed to inspect bot token (${describeUnknownError(error)}).`, + ); + return null; + } + }) + .filter((account): account is NonNullable> => + Boolean(account), + ) .map((account) => (account.tokenSource === "none" ? "" : account.token)) .map((token) => token.trim()) .filter(Boolean), @@ -348,6 +362,7 @@ async function maybeRepairTelegramAllowFromUsernames(cfg: OpenClawConfig): Promi return { config: cfg, changes: [ + ...tokenResolutionWarnings, hasConfiguredUnavailableToken ? `- Telegram allowFrom contains @username entries, but configured Telegram bot credentials are unavailable in this command path; cannot auto-resolve (start the gateway or make the secret source available, then rerun doctor --fix).` : `- Telegram allowFrom contains @username entries, but no Telegram bot token is configured; cannot auto-resolve (run setup or replace with numeric sender IDs).`, diff --git a/src/commands/message.test.ts b/src/commands/message.test.ts index adbe4ae7850..182946ba7ad 100644 --- a/src/commands/message.test.ts +++ b/src/commands/message.test.ts @@ -301,6 +301,13 @@ describe("messageCommand", () => { commandName: "message", }), ); + const secretResolveCall = resolveCommandSecretRefsViaGateway.mock.calls[0]?.[0] as { + targetIds?: Set; + }; + expect(secretResolveCall.targetIds).toBeInstanceOf(Set); + expect( + [...(secretResolveCall.targetIds ?? [])].every((id) => id.startsWith("channels.telegram.")), + ).toBe(true); expect(handleTelegramAction).toHaveBeenCalledWith( expect.objectContaining({ action: "send", to: "123456", accountId: undefined }), resolvedConfig, diff --git a/src/commands/message.ts b/src/commands/message.ts index 76e622e2cf3..52540e8916d 100644 --- a/src/commands/message.ts +++ b/src/commands/message.ts @@ -3,7 +3,8 @@ import { type ChannelMessageActionName, } from "../channels/plugins/types.js"; import { resolveCommandSecretRefsViaGateway } from "../cli/command-secret-gateway.js"; -import { getChannelsCommandSecretTargetIds } from "../cli/command-secret-targets.js"; +import { getScopedChannelsCommandSecretTargets } from "../cli/command-secret-targets.js"; +import { resolveMessageSecretScope } from "../cli/message-secret-scope.js"; import { createOutboundSendDeps, type CliDeps } from "../cli/outbound-send-deps.js"; import { withProgress } from "../cli/progress.js"; import { loadConfig } from "../config/config.js"; @@ -19,10 +20,22 @@ export async function messageCommand( runtime: RuntimeEnv, ) { const loadedRaw = loadConfig(); + const scope = resolveMessageSecretScope({ + channel: opts.channel, + target: opts.target, + targets: opts.targets, + accountId: opts.accountId, + }); + const scopedTargets = getScopedChannelsCommandSecretTargets({ + config: loadedRaw, + channel: scope.channel, + accountId: scope.accountId, + }); const { resolvedConfig: cfg, diagnostics } = await resolveCommandSecretRefsViaGateway({ config: loadedRaw, commandName: "message", - targetIds: getChannelsCommandSecretTargetIds(), + targetIds: scopedTargets.targetIds, + ...(scopedTargets.allowedPaths ? { allowedPaths: scopedTargets.allowedPaths } : {}), }); for (const entry of diagnostics) { runtime.log(`[secrets] ${entry}`); diff --git a/src/commands/status-all.ts b/src/commands/status-all.ts index b643c30ff33..3ef91457a50 100644 --- a/src/commands/status-all.ts +++ b/src/commands/status-all.ts @@ -44,12 +44,13 @@ export async function statusAllCommand( await withProgress({ label: "Scanning status --all…", total: 11 }, async (progress) => { progress.setLabel("Loading config…"); const loadedRaw = await readBestEffortConfig(); - const { resolvedConfig: cfg } = await resolveCommandSecretRefsViaGateway({ - config: loadedRaw, - commandName: "status --all", - targetIds: getStatusCommandSecretTargetIds(), - mode: "read_only_status", - }); + const { resolvedConfig: cfg, diagnostics: secretDiagnostics } = + await resolveCommandSecretRefsViaGateway({ + config: loadedRaw, + commandName: "status --all", + targetIds: getStatusCommandSecretTargetIds(), + mode: "read_only_status", + }); const osSummary = resolveOsSummary(); const snap = await readConfigFileSnapshot().catch(() => null); progress.tick(); @@ -328,6 +329,13 @@ export async function statusAllCommand( Item: "Agents", Value: `${agentStatus.agents.length} total · ${agentStatus.bootstrapPendingCount} bootstrapping · ${aliveAgents} active · ${agentStatus.totalSessions} sessions`, }, + { + Item: "Secrets", + Value: + secretDiagnostics.length > 0 + ? `${secretDiagnostics.length} diagnostic${secretDiagnostics.length === 1 ? "" : "s"}` + : "none", + }, ]; const lines = await buildStatusAllReportLines({ @@ -343,6 +351,7 @@ export async function statusAllCommand( diagnosis: { snap, remoteUrlMissing, + secretDiagnostics, sentinel, lastErr, port, diff --git a/src/commands/status-all/diagnosis.ts b/src/commands/status-all/diagnosis.ts index 59140e49b44..5b866413021 100644 --- a/src/commands/status-all/diagnosis.ts +++ b/src/commands/status-all/diagnosis.ts @@ -50,6 +50,7 @@ export async function appendStatusAllDiagnosis(params: { connectionDetailsForReport: string; snap: ConfigSnapshotLike | null; remoteUrlMissing: boolean; + secretDiagnostics: string[]; sentinel: { payload?: RestartSentinelPayload | null } | null; lastErr: string | null; port: number; @@ -104,6 +105,17 @@ export async function appendStatusAllDiagnosis(params: { lines.push(` ${muted("Fix: set gateway.remote.url, or set gateway.mode=local.")}`); } + emitCheck( + `Secret diagnostics (${params.secretDiagnostics.length})`, + params.secretDiagnostics.length === 0 ? "ok" : "warn", + ); + for (const diagnostic of params.secretDiagnostics.slice(0, 10)) { + lines.push(` - ${muted(redactSecrets(diagnostic))}`); + } + if (params.secretDiagnostics.length > 10) { + lines.push(` ${muted(`… +${params.secretDiagnostics.length - 10} more`)}`); + } + if (params.sentinel?.payload) { emitCheck("Restart sentinel present", "warn"); lines.push( diff --git a/src/commands/status-all/report-lines.test.ts b/src/commands/status-all/report-lines.test.ts index 5769bc0d41d..0a71665224c 100644 --- a/src/commands/status-all/report-lines.test.ts +++ b/src/commands/status-all/report-lines.test.ts @@ -46,6 +46,7 @@ describe("buildStatusAllReportLines", () => { diagnosis: { snap: null, remoteUrlMissing: false, + secretDiagnostics: [], sentinel: null, lastErr: null, port: 18789, @@ -70,5 +71,10 @@ describe("buildStatusAllReportLines", () => { expect(output).toContain("Bootstrap file"); expect(output).toContain("PRESENT"); expect(output).toContain("ABSENT"); + expect(diagnosisSpy).toHaveBeenCalledWith( + expect.objectContaining({ + secretDiagnostics: [], + }), + ); }); }); diff --git a/src/infra/outbound/channel-selection.test.ts b/src/infra/outbound/channel-selection.test.ts index 9448b919312..5f3ac319628 100644 --- a/src/infra/outbound/channel-selection.test.ts +++ b/src/infra/outbound/channel-selection.test.ts @@ -1,4 +1,5 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; +import { defaultRuntime } from "../../runtime.js"; const mocks = vi.hoisted(() => ({ listChannelPlugins: vi.fn(), @@ -14,6 +15,7 @@ vi.mock("./channel-resolution.js", () => ({ })); import { + __testing, listConfiguredMessageChannels, resolveMessageChannelSelection, } from "./channel-selection.js"; @@ -38,6 +40,8 @@ function makePlugin(params: { } describe("listConfiguredMessageChannels", () => { + const errorSpy = vi.spyOn(defaultRuntime, "error").mockImplementation(() => undefined); + beforeEach(() => { mocks.listChannelPlugins.mockReset(); mocks.listChannelPlugins.mockReturnValue([]); @@ -45,6 +49,8 @@ describe("listConfiguredMessageChannels", () => { mocks.resolveOutboundChannelPlugin.mockImplementation(({ channel }: { channel: string }) => ({ id: channel, })); + __testing.resetLoggedChannelSelectionErrors(); + errorSpy.mockClear(); }); it("skips unknown plugin ids and plugins without accounts", async () => { @@ -93,6 +99,20 @@ describe("listConfiguredMessageChannels", () => { await expect(listConfiguredMessageChannels({} as never)).resolves.toEqual([]); }); + + it("skips plugin accounts whose resolveAccount throws", async () => { + mocks.listChannelPlugins.mockReturnValue([ + makePlugin({ + id: "discord", + resolveAccount: () => { + throw new Error("boom"); + }, + }), + ]); + + await expect(listConfiguredMessageChannels({} as never)).resolves.toEqual([]); + expect(errorSpy).toHaveBeenCalledTimes(1); + }); }); describe("resolveMessageChannelSelection", () => { diff --git a/src/infra/outbound/channel-selection.ts b/src/infra/outbound/channel-selection.ts index 024fc2273f6..0e87a8e4950 100644 --- a/src/infra/outbound/channel-selection.ts +++ b/src/infra/outbound/channel-selection.ts @@ -1,6 +1,7 @@ import { listChannelPlugins } from "../../channels/plugins/index.js"; import type { ChannelPlugin } from "../../channels/plugins/types.js"; import type { OpenClawConfig } from "../../config/config.js"; +import { defaultRuntime } from "../../runtime.js"; import { listDeliverableMessageChannels, type DeliverableMessageChannel, @@ -59,6 +60,25 @@ function isAccountEnabled(account: unknown): boolean { return enabled !== false; } +const loggedChannelSelectionErrors = new Set(); + +function logChannelSelectionError(params: { + pluginId: string; + accountId: string; + operation: "resolveAccount" | "isConfigured"; + error: unknown; +}) { + const message = params.error instanceof Error ? params.error.message : String(params.error); + const key = `${params.pluginId}:${params.accountId}:${params.operation}:${message}`; + if (loggedChannelSelectionErrors.has(key)) { + return; + } + loggedChannelSelectionErrors.add(key); + defaultRuntime.error?.( + `[channel-selection] ${params.pluginId}(${params.accountId}) ${params.operation} failed: ${message}`, + ); +} + async function isPluginConfigured(plugin: ChannelPlugin, cfg: OpenClawConfig): Promise { const accountIds = plugin.config.listAccountIds(cfg); if (accountIds.length === 0) { @@ -66,7 +86,18 @@ async function isPluginConfigured(plugin: ChannelPlugin, cfg: OpenClawConfig): P } for (const accountId of accountIds) { - const account = plugin.config.resolveAccount(cfg, accountId); + let account: unknown; + try { + account = plugin.config.resolveAccount(cfg, accountId); + } catch (error) { + logChannelSelectionError({ + pluginId: plugin.id, + accountId, + operation: "resolveAccount", + error, + }); + continue; + } const enabled = plugin.config.isEnabled ? plugin.config.isEnabled(account, cfg) : isAccountEnabled(account); @@ -76,7 +107,18 @@ async function isPluginConfigured(plugin: ChannelPlugin, cfg: OpenClawConfig): P if (!plugin.config.isConfigured) { return true; } - const configured = await plugin.config.isConfigured(account, cfg); + let configured = false; + try { + configured = await plugin.config.isConfigured(account, cfg); + } catch (error) { + logChannelSelectionError({ + pluginId: plugin.id, + accountId, + operation: "isConfigured", + error, + }); + continue; + } if (configured) { return true; } @@ -162,3 +204,9 @@ export async function resolveMessageChannelSelection(params: { `Channel is required when multiple channels are configured: ${configured.join(", ")}`, ); } + +export const __testing = { + resetLoggedChannelSelectionErrors() { + loggedChannelSelectionErrors.clear(); + }, +}; From 880bc969f90ba8c0a4f8f6b5ef52f6e9b5728638 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:11:35 -0700 Subject: [PATCH 023/187] refactor: move plugin sdk setup helpers out of commands --- src/commands/ollama-setup.ts | 532 +---------------- src/commands/self-hosted-provider-setup.ts | 305 +--------- src/commands/signal-install.ts | 303 +--------- src/commands/vllm-setup.ts | 43 +- src/commands/zai-endpoint-detect.ts | 180 +----- src/plugin-sdk-internal/setup.ts | 2 + src/plugin-sdk/agent-runtime.ts | 1 + src/plugin-sdk/index.ts | 10 +- src/plugin-sdk/ollama-setup.ts | 2 +- src/plugin-sdk/provider-setup.ts | 6 +- src/plugin-sdk/self-hosted-provider-setup.ts | 2 +- src/plugin-sdk/setup.ts | 4 +- src/plugin-sdk/zai.ts | 2 +- .../contracts/auth-choice.contract.test.ts | 3 +- src/plugins/provider-ollama-setup.ts | 535 ++++++++++++++++++ src/plugins/provider-self-hosted-setup.ts | 304 ++++++++++ src/plugins/provider-vllm-setup.ts | 42 ++ src/plugins/provider-zai-endpoint.ts | 179 ++++++ src/plugins/setup-binary.ts | 36 ++ src/plugins/setup-browser.ts | 112 ++++ src/plugins/signal-cli-install.ts | 302 ++++++++++ 21 files changed, 1532 insertions(+), 1373 deletions(-) create mode 100644 src/plugins/provider-ollama-setup.ts create mode 100644 src/plugins/provider-self-hosted-setup.ts create mode 100644 src/plugins/provider-vllm-setup.ts create mode 100644 src/plugins/provider-zai-endpoint.ts create mode 100644 src/plugins/setup-binary.ts create mode 100644 src/plugins/setup-browser.ts create mode 100644 src/plugins/signal-cli-install.ts diff --git a/src/commands/ollama-setup.ts b/src/commands/ollama-setup.ts index 31499d3f0a6..9be1fcf6c31 100644 --- a/src/commands/ollama-setup.ts +++ b/src/commands/ollama-setup.ts @@ -1,531 +1 @@ -import { upsertAuthProfileWithLock } from "../agents/auth-profiles/upsert-with-lock.js"; -import { OLLAMA_DEFAULT_BASE_URL } from "../agents/ollama-defaults.js"; -import { - buildOllamaModelDefinition, - enrichOllamaModelsWithContext, - fetchOllamaModels, - resolveOllamaApiBase, - type OllamaModelWithContext, -} from "../agents/ollama-models.js"; -import type { OpenClawConfig } from "../config/config.js"; -import { applyAgentDefaultModelPrimary } from "../plugins/provider-onboarding-config.js"; -import type { RuntimeEnv } from "../runtime.js"; -import { WizardCancelledError, type WizardPrompter } from "../wizard/prompts.js"; -import { isRemoteEnvironment } from "./oauth-env.js"; -import { openUrl } from "./onboard-helpers.js"; -import type { OnboardMode, OnboardOptions } from "./onboard-types.js"; - -export { OLLAMA_DEFAULT_BASE_URL } from "../agents/ollama-defaults.js"; -export const OLLAMA_DEFAULT_MODEL = "glm-4.7-flash"; - -const OLLAMA_SUGGESTED_MODELS_LOCAL = ["glm-4.7-flash"]; -const OLLAMA_SUGGESTED_MODELS_CLOUD = ["kimi-k2.5:cloud", "minimax-m2.5:cloud", "glm-5:cloud"]; - -function normalizeOllamaModelName(value: string | undefined): string | undefined { - const trimmed = value?.trim(); - if (!trimmed) { - return undefined; - } - if (trimmed.toLowerCase().startsWith("ollama/")) { - const withoutPrefix = trimmed.slice("ollama/".length).trim(); - return withoutPrefix || undefined; - } - return trimmed; -} - -function isOllamaCloudModel(modelName: string | undefined): boolean { - return Boolean(modelName?.trim().toLowerCase().endsWith(":cloud")); -} - -function formatOllamaPullStatus(status: string): { text: string; hidePercent: boolean } { - const trimmed = status.trim(); - const partStatusMatch = trimmed.match(/^([a-z-]+)\s+(?:sha256:)?[a-f0-9]{8,}$/i); - if (partStatusMatch) { - return { text: `${partStatusMatch[1]} part`, hidePercent: false }; - } - if (/^verifying\b.*\bdigest\b/i.test(trimmed)) { - return { text: "verifying digest", hidePercent: true }; - } - return { text: trimmed, hidePercent: false }; -} - -type OllamaCloudAuthResult = { - signedIn: boolean; - signinUrl?: string; -}; - -/** Check if the user is signed in to Ollama cloud via /api/me. */ -async function checkOllamaCloudAuth(baseUrl: string): Promise { - try { - const apiBase = resolveOllamaApiBase(baseUrl); - const response = await fetch(`${apiBase}/api/me`, { - method: "POST", - signal: AbortSignal.timeout(5000), - }); - if (response.status === 401) { - // 401 body contains { error, signin_url } - const data = (await response.json()) as { signin_url?: string }; - return { signedIn: false, signinUrl: data.signin_url }; - } - if (!response.ok) { - return { signedIn: false }; - } - return { signedIn: true }; - } catch { - // /api/me not supported or unreachable — fail closed so cloud mode - // doesn't silently skip auth; the caller handles the fallback. - return { signedIn: false }; - } -} - -type OllamaPullChunk = { - status?: string; - total?: number; - completed?: number; - error?: string; -}; - -type OllamaPullFailureKind = "http" | "no-body" | "chunk-error" | "network"; -type OllamaPullResult = - | { ok: true } - | { - ok: false; - kind: OllamaPullFailureKind; - message: string; - }; - -async function pullOllamaModelCore(params: { - baseUrl: string; - modelName: string; - onStatus?: (status: string, percent: number | null) => void; -}): Promise { - const { onStatus } = params; - const baseUrl = resolveOllamaApiBase(params.baseUrl); - const modelName = normalizeOllamaModelName(params.modelName) ?? params.modelName.trim(); - try { - const response = await fetch(`${baseUrl}/api/pull`, { - method: "POST", - headers: { "Content-Type": "application/json" }, - body: JSON.stringify({ name: modelName }), - }); - if (!response.ok) { - return { - ok: false, - kind: "http", - message: `Failed to download ${modelName} (HTTP ${response.status})`, - }; - } - if (!response.body) { - return { - ok: false, - kind: "no-body", - message: `Failed to download ${modelName} (no response body)`, - }; - } - - const reader = response.body.getReader(); - const decoder = new TextDecoder(); - let buffer = ""; - const layers = new Map(); - - const parseLine = (line: string): OllamaPullResult => { - const trimmed = line.trim(); - if (!trimmed) { - return { ok: true }; - } - try { - const chunk = JSON.parse(trimmed) as OllamaPullChunk; - if (chunk.error) { - return { - ok: false, - kind: "chunk-error", - message: `Download failed: ${chunk.error}`, - }; - } - if (!chunk.status) { - return { ok: true }; - } - if (chunk.total && chunk.completed !== undefined) { - layers.set(chunk.status, { total: chunk.total, completed: chunk.completed }); - let totalSum = 0; - let completedSum = 0; - for (const layer of layers.values()) { - totalSum += layer.total; - completedSum += layer.completed; - } - const percent = totalSum > 0 ? Math.round((completedSum / totalSum) * 100) : null; - onStatus?.(chunk.status, percent); - } else { - onStatus?.(chunk.status, null); - } - } catch { - // Ignore malformed lines from streaming output. - } - return { ok: true }; - }; - - for (;;) { - const { done, value } = await reader.read(); - if (done) { - break; - } - buffer += decoder.decode(value, { stream: true }); - const lines = buffer.split("\n"); - buffer = lines.pop() ?? ""; - for (const line of lines) { - const parsed = parseLine(line); - if (!parsed.ok) { - return parsed; - } - } - } - - const trailing = buffer.trim(); - if (trailing) { - const parsed = parseLine(trailing); - if (!parsed.ok) { - return parsed; - } - } - - return { ok: true }; - } catch (err) { - const reason = err instanceof Error ? err.message : String(err); - return { - ok: false, - kind: "network", - message: `Failed to download ${modelName}: ${reason}`, - }; - } -} - -/** Pull a model from Ollama, streaming progress updates. */ -async function pullOllamaModel( - baseUrl: string, - modelName: string, - prompter: WizardPrompter, -): Promise { - const spinner = prompter.progress(`Downloading ${modelName}...`); - const result = await pullOllamaModelCore({ - baseUrl, - modelName, - onStatus: (status, percent) => { - const displayStatus = formatOllamaPullStatus(status); - if (displayStatus.hidePercent) { - spinner.update(`Downloading ${modelName} - ${displayStatus.text}`); - } else { - spinner.update(`Downloading ${modelName} - ${displayStatus.text} - ${percent ?? 0}%`); - } - }, - }); - if (!result.ok) { - spinner.stop(result.message); - return false; - } - spinner.stop(`Downloaded ${modelName}`); - return true; -} - -async function pullOllamaModelNonInteractive( - baseUrl: string, - modelName: string, - runtime: RuntimeEnv, -): Promise { - runtime.log(`Downloading ${modelName}...`); - const result = await pullOllamaModelCore({ baseUrl, modelName }); - if (!result.ok) { - runtime.error(result.message); - return false; - } - runtime.log(`Downloaded ${modelName}`); - return true; -} - -function buildOllamaModelsConfig( - modelNames: string[], - discoveredModelsByName?: Map, -) { - return modelNames.map((name) => - buildOllamaModelDefinition(name, discoveredModelsByName?.get(name)?.contextWindow), - ); -} - -function applyOllamaProviderConfig( - cfg: OpenClawConfig, - baseUrl: string, - modelNames: string[], - discoveredModelsByName?: Map, -): OpenClawConfig { - return { - ...cfg, - models: { - ...cfg.models, - mode: cfg.models?.mode ?? "merge", - providers: { - ...cfg.models?.providers, - ollama: { - baseUrl, - api: "ollama", - apiKey: "OLLAMA_API_KEY", // pragma: allowlist secret - models: buildOllamaModelsConfig(modelNames, discoveredModelsByName), - }, - }, - }, - }; -} - -async function storeOllamaCredential(agentDir?: string): Promise { - await upsertAuthProfileWithLock({ - profileId: "ollama:default", - credential: { type: "api_key", provider: "ollama", key: "ollama-local" }, - agentDir, - }); -} - -/** - * Interactive: prompt for base URL, discover models, configure provider. - * Model selection is handled by the standard model picker downstream. - */ -export async function promptAndConfigureOllama(params: { - cfg: OpenClawConfig; - prompter: WizardPrompter; -}): Promise<{ config: OpenClawConfig; defaultModelId: string }> { - const { prompter } = params; - - // 1. Prompt base URL - const baseUrlRaw = await prompter.text({ - message: "Ollama base URL", - initialValue: OLLAMA_DEFAULT_BASE_URL, - placeholder: OLLAMA_DEFAULT_BASE_URL, - validate: (value) => (value?.trim() ? undefined : "Required"), - }); - const configuredBaseUrl = String(baseUrlRaw ?? "") - .trim() - .replace(/\/+$/, ""); - const baseUrl = resolveOllamaApiBase(configuredBaseUrl); - - // 2. Check reachability - const { reachable, models } = await fetchOllamaModels(baseUrl); - - if (!reachable) { - await prompter.note( - [ - `Ollama could not be reached at ${baseUrl}.`, - "Download it at https://ollama.com/download", - "", - "Start Ollama and re-run setup.", - ].join("\n"), - "Ollama", - ); - throw new WizardCancelledError("Ollama not reachable"); - } - - const enrichedModels = await enrichOllamaModelsWithContext(baseUrl, models.slice(0, 50)); - const discoveredModelsByName = new Map(enrichedModels.map((model) => [model.name, model])); - const modelNames = models.map((m) => m.name); - - // 3. Mode selection - const mode = (await prompter.select({ - message: "Ollama mode", - options: [ - { value: "remote", label: "Cloud + Local", hint: "Ollama cloud models + local models" }, - { value: "local", label: "Local", hint: "Local models only" }, - ], - })) as OnboardMode; - - // 4. Cloud auth — check /api/me upfront for remote (cloud+local) mode - let cloudAuthVerified = false; - if (mode === "remote") { - const authResult = await checkOllamaCloudAuth(baseUrl); - if (!authResult.signedIn) { - if (authResult.signinUrl) { - if (!isRemoteEnvironment()) { - await openUrl(authResult.signinUrl); - } - await prompter.note( - ["Sign in to Ollama Cloud:", authResult.signinUrl].join("\n"), - "Ollama Cloud", - ); - const confirmed = await prompter.confirm({ - message: "Have you signed in?", - }); - if (!confirmed) { - throw new WizardCancelledError("Ollama cloud sign-in cancelled"); - } - // Re-check after user claims sign-in - const recheck = await checkOllamaCloudAuth(baseUrl); - if (!recheck.signedIn) { - throw new WizardCancelledError("Ollama cloud sign-in required"); - } - cloudAuthVerified = true; - } else { - // No signin URL available (older server, unreachable /api/me, or custom gateway). - await prompter.note( - [ - "Could not verify Ollama Cloud authentication.", - "Cloud models may not work until you sign in at https://ollama.com.", - ].join("\n"), - "Ollama Cloud", - ); - const continueAnyway = await prompter.confirm({ - message: "Continue without cloud auth?", - }); - if (!continueAnyway) { - throw new WizardCancelledError("Ollama cloud auth could not be verified"); - } - // Cloud auth unverified — fall back to local defaults so the model - // picker doesn't steer toward cloud models that may fail. - } - } else { - cloudAuthVerified = true; - } - } - - // 5. Model ordering — suggested models first. - // Use cloud defaults only when auth was actually verified; otherwise fall - // back to local defaults so the user isn't steered toward cloud models - // that may fail at runtime. - const suggestedModels = - mode === "local" || !cloudAuthVerified - ? OLLAMA_SUGGESTED_MODELS_LOCAL - : OLLAMA_SUGGESTED_MODELS_CLOUD; - const orderedModelNames = [ - ...suggestedModels, - ...modelNames.filter((name) => !suggestedModels.includes(name)), - ]; - - const defaultModelId = suggestedModels[0] ?? OLLAMA_DEFAULT_MODEL; - const config = applyOllamaProviderConfig( - params.cfg, - baseUrl, - orderedModelNames, - discoveredModelsByName, - ); - return { config, defaultModelId }; -} - -/** Non-interactive: auto-discover models and configure provider. */ -export async function configureOllamaNonInteractive(params: { - nextConfig: OpenClawConfig; - opts: OnboardOptions; - runtime: RuntimeEnv; -}): Promise { - const { opts, runtime } = params; - const configuredBaseUrl = (opts.customBaseUrl?.trim() || OLLAMA_DEFAULT_BASE_URL).replace( - /\/+$/, - "", - ); - const baseUrl = resolveOllamaApiBase(configuredBaseUrl); - - const { reachable, models } = await fetchOllamaModels(baseUrl); - const explicitModel = normalizeOllamaModelName(opts.customModelId); - - if (!reachable) { - runtime.error( - [ - `Ollama could not be reached at ${baseUrl}.`, - "Download it at https://ollama.com/download", - ].join("\n"), - ); - runtime.exit(1); - return params.nextConfig; - } - - await storeOllamaCredential(); - - const enrichedModels = await enrichOllamaModelsWithContext(baseUrl, models.slice(0, 50)); - const discoveredModelsByName = new Map(enrichedModels.map((model) => [model.name, model])); - const modelNames = models.map((m) => m.name); - - // Apply local suggested model ordering. - const suggestedModels = OLLAMA_SUGGESTED_MODELS_LOCAL; - const orderedModelNames = [ - ...suggestedModels, - ...modelNames.filter((name) => !suggestedModels.includes(name)), - ]; - - const requestedDefaultModelId = explicitModel ?? suggestedModels[0]; - let pulledRequestedModel = false; - const availableModelNames = new Set(modelNames); - const requestedCloudModel = isOllamaCloudModel(requestedDefaultModelId); - - if (requestedCloudModel) { - availableModelNames.add(requestedDefaultModelId); - } - - // Pull if model not in discovered list and Ollama is reachable - if (!requestedCloudModel && !modelNames.includes(requestedDefaultModelId)) { - pulledRequestedModel = await pullOllamaModelNonInteractive( - baseUrl, - requestedDefaultModelId, - runtime, - ); - if (pulledRequestedModel) { - availableModelNames.add(requestedDefaultModelId); - } - } - - let allModelNames = orderedModelNames; - let defaultModelId = requestedDefaultModelId; - if ( - (pulledRequestedModel || requestedCloudModel) && - !allModelNames.includes(requestedDefaultModelId) - ) { - allModelNames = [...allModelNames, requestedDefaultModelId]; - } - if (!availableModelNames.has(requestedDefaultModelId)) { - if (availableModelNames.size > 0) { - const firstAvailableModel = - allModelNames.find((name) => availableModelNames.has(name)) ?? - Array.from(availableModelNames)[0]; - defaultModelId = firstAvailableModel; - runtime.log( - `Ollama model ${requestedDefaultModelId} was not available; using ${defaultModelId} instead.`, - ); - } else { - runtime.error( - [ - `No Ollama models are available at ${baseUrl}.`, - "Pull a model first, then re-run setup.", - ].join("\n"), - ); - runtime.exit(1); - return params.nextConfig; - } - } - - const config = applyOllamaProviderConfig( - params.nextConfig, - baseUrl, - allModelNames, - discoveredModelsByName, - ); - const modelRef = `ollama/${defaultModelId}`; - runtime.log(`Default Ollama model: ${defaultModelId}`); - return applyAgentDefaultModelPrimary(config, modelRef); -} - -/** Pull the configured default Ollama model if it isn't already available locally. */ -export async function ensureOllamaModelPulled(params: { - config: OpenClawConfig; - prompter: WizardPrompter; -}): Promise { - const modelCfg = params.config.agents?.defaults?.model; - const modelId = typeof modelCfg === "string" ? modelCfg : modelCfg?.primary; - if (!modelId?.startsWith("ollama/")) { - return; - } - const baseUrl = params.config.models?.providers?.ollama?.baseUrl ?? OLLAMA_DEFAULT_BASE_URL; - const modelName = modelId.slice("ollama/".length); - if (isOllamaCloudModel(modelName)) { - return; - } - const { models } = await fetchOllamaModels(baseUrl); - if (models.some((m) => m.name === modelName)) { - return; - } - const pulled = await pullOllamaModel(baseUrl, modelName, params.prompter); - if (!pulled) { - throw new WizardCancelledError("Failed to download selected Ollama model"); - } -} +export * from "../plugins/provider-ollama-setup.js"; diff --git a/src/commands/self-hosted-provider-setup.ts b/src/commands/self-hosted-provider-setup.ts index 2b1e0a3027b..8d4e85fa8ff 100644 --- a/src/commands/self-hosted-provider-setup.ts +++ b/src/commands/self-hosted-provider-setup.ts @@ -1,304 +1 @@ -import type { ApiKeyCredential, AuthProfileCredential } from "../agents/auth-profiles/types.js"; -import { upsertAuthProfileWithLock } from "../agents/auth-profiles/upsert-with-lock.js"; -import { - SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, - SELF_HOSTED_DEFAULT_COST, - SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../agents/self-hosted-provider-defaults.js"; -import type { OpenClawConfig } from "../config/config.js"; -import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; -import type { - ProviderDiscoveryContext, - ProviderAuthResult, - ProviderAuthMethodNonInteractiveContext, - ProviderNonInteractiveApiKeyResult, -} from "../plugins/types.js"; -import { normalizeOptionalSecretInput } from "../utils/normalize-secret-input.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; - -export { - SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, - SELF_HOSTED_DEFAULT_COST, - SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../agents/self-hosted-provider-defaults.js"; - -export function applyProviderDefaultModel(cfg: OpenClawConfig, modelRef: string): OpenClawConfig { - const existingModel = cfg.agents?.defaults?.model; - const fallbacks = - existingModel && typeof existingModel === "object" && "fallbacks" in existingModel - ? (existingModel as { fallbacks?: string[] }).fallbacks - : undefined; - - return { - ...cfg, - agents: { - ...cfg.agents, - defaults: { - ...cfg.agents?.defaults, - model: { - ...(fallbacks ? { fallbacks } : undefined), - primary: modelRef, - }, - }, - }, - }; -} - -function buildOpenAICompatibleSelfHostedProviderConfig(params: { - cfg: OpenClawConfig; - providerId: string; - baseUrl: string; - providerApiKey: string; - modelId: string; - input?: Array<"text" | "image">; - reasoning?: boolean; - contextWindow?: number; - maxTokens?: number; -}): { config: OpenClawConfig; modelId: string; modelRef: string; profileId: string } { - const modelRef = `${params.providerId}/${params.modelId}`; - const profileId = `${params.providerId}:default`; - return { - config: { - ...params.cfg, - models: { - ...params.cfg.models, - mode: params.cfg.models?.mode ?? "merge", - providers: { - ...params.cfg.models?.providers, - [params.providerId]: { - baseUrl: params.baseUrl, - api: "openai-completions", - apiKey: params.providerApiKey, - models: [ - { - id: params.modelId, - name: params.modelId, - reasoning: params.reasoning ?? false, - input: params.input ?? ["text"], - cost: SELF_HOSTED_DEFAULT_COST, - contextWindow: params.contextWindow ?? SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, - maxTokens: params.maxTokens ?? SELF_HOSTED_DEFAULT_MAX_TOKENS, - }, - ], - }, - }, - }, - }, - modelId: params.modelId, - modelRef, - profileId, - }; -} - -type OpenAICompatibleSelfHostedProviderSetupParams = { - cfg: OpenClawConfig; - prompter: WizardPrompter; - providerId: string; - providerLabel: string; - defaultBaseUrl: string; - defaultApiKeyEnvVar: string; - modelPlaceholder: string; - input?: Array<"text" | "image">; - reasoning?: boolean; - contextWindow?: number; - maxTokens?: number; -}; - -type OpenAICompatibleSelfHostedProviderPromptResult = { - config: OpenClawConfig; - credential: AuthProfileCredential; - modelId: string; - modelRef: string; - profileId: string; -}; - -function buildSelfHostedProviderAuthResult( - result: OpenAICompatibleSelfHostedProviderPromptResult, -): ProviderAuthResult { - return { - profiles: [ - { - profileId: result.profileId, - credential: result.credential, - }, - ], - configPatch: result.config, - defaultModel: result.modelRef, - }; -} - -export async function promptAndConfigureOpenAICompatibleSelfHostedProvider( - params: OpenAICompatibleSelfHostedProviderSetupParams, -): Promise { - const baseUrlRaw = await params.prompter.text({ - message: `${params.providerLabel} base URL`, - initialValue: params.defaultBaseUrl, - placeholder: params.defaultBaseUrl, - validate: (value) => (value?.trim() ? undefined : "Required"), - }); - const apiKeyRaw = await params.prompter.text({ - message: `${params.providerLabel} API key`, - placeholder: "sk-... (or any non-empty string)", - validate: (value) => (value?.trim() ? undefined : "Required"), - }); - const modelIdRaw = await params.prompter.text({ - message: `${params.providerLabel} model`, - placeholder: params.modelPlaceholder, - validate: (value) => (value?.trim() ? undefined : "Required"), - }); - - const baseUrl = String(baseUrlRaw ?? "") - .trim() - .replace(/\/+$/, ""); - const apiKey = String(apiKeyRaw ?? "").trim(); - const modelId = String(modelIdRaw ?? "").trim(); - const credential: AuthProfileCredential = { - type: "api_key", - provider: params.providerId, - key: apiKey, - }; - const configured = buildOpenAICompatibleSelfHostedProviderConfig({ - cfg: params.cfg, - providerId: params.providerId, - baseUrl, - providerApiKey: params.defaultApiKeyEnvVar, - modelId, - input: params.input, - reasoning: params.reasoning, - contextWindow: params.contextWindow, - maxTokens: params.maxTokens, - }); - - return { - config: configured.config, - credential, - modelId: configured.modelId, - modelRef: configured.modelRef, - profileId: configured.profileId, - }; -} - -export async function promptAndConfigureOpenAICompatibleSelfHostedProviderAuth( - params: OpenAICompatibleSelfHostedProviderSetupParams, -): Promise { - const result = await promptAndConfigureOpenAICompatibleSelfHostedProvider(params); - return buildSelfHostedProviderAuthResult(result); -} - -export async function discoverOpenAICompatibleSelfHostedProvider< - T extends Record, ->(params: { - ctx: ProviderDiscoveryContext; - providerId: string; - buildProvider: (params: { apiKey?: string }) => Promise; -}): Promise<{ provider: T & { apiKey: string } } | null> { - if (params.ctx.config.models?.providers?.[params.providerId]) { - return null; - } - const { apiKey, discoveryApiKey } = params.ctx.resolveProviderApiKey(params.providerId); - if (!apiKey) { - return null; - } - return { - provider: { - ...(await params.buildProvider({ apiKey: discoveryApiKey })), - apiKey, - }, - }; -} - -function buildMissingNonInteractiveModelIdMessage(params: { - authChoice: string; - providerLabel: string; - modelPlaceholder: string; -}): string { - return [ - `Missing --custom-model-id for --auth-choice ${params.authChoice}.`, - `Pass the ${params.providerLabel} model id to use, for example ${params.modelPlaceholder}.`, - ].join("\n"); -} - -function buildSelfHostedProviderCredential(params: { - ctx: ProviderAuthMethodNonInteractiveContext; - providerId: string; - resolved: ProviderNonInteractiveApiKeyResult; -}): ApiKeyCredential | null { - return params.ctx.toApiKeyCredential({ - provider: params.providerId, - resolved: params.resolved, - }); -} - -export async function configureOpenAICompatibleSelfHostedProviderNonInteractive(params: { - ctx: ProviderAuthMethodNonInteractiveContext; - providerId: string; - providerLabel: string; - defaultBaseUrl: string; - defaultApiKeyEnvVar: string; - modelPlaceholder: string; - input?: Array<"text" | "image">; - reasoning?: boolean; - contextWindow?: number; - maxTokens?: number; -}): Promise { - const baseUrl = ( - normalizeOptionalSecretInput(params.ctx.opts.customBaseUrl) ?? params.defaultBaseUrl - ).replace(/\/+$/, ""); - const modelId = normalizeOptionalSecretInput(params.ctx.opts.customModelId); - if (!modelId) { - params.ctx.runtime.error( - buildMissingNonInteractiveModelIdMessage({ - authChoice: params.ctx.authChoice, - providerLabel: params.providerLabel, - modelPlaceholder: params.modelPlaceholder, - }), - ); - params.ctx.runtime.exit(1); - return null; - } - - const resolved = await params.ctx.resolveApiKey({ - provider: params.providerId, - flagValue: normalizeOptionalSecretInput(params.ctx.opts.customApiKey), - flagName: "--custom-api-key", - envVar: params.defaultApiKeyEnvVar, - envVarName: params.defaultApiKeyEnvVar, - }); - if (!resolved) { - return null; - } - - const credential = buildSelfHostedProviderCredential({ - ctx: params.ctx, - providerId: params.providerId, - resolved, - }); - if (!credential) { - return null; - } - - const configured = buildOpenAICompatibleSelfHostedProviderConfig({ - cfg: params.ctx.config, - providerId: params.providerId, - baseUrl, - providerApiKey: params.defaultApiKeyEnvVar, - modelId, - input: params.input, - reasoning: params.reasoning, - contextWindow: params.contextWindow, - maxTokens: params.maxTokens, - }); - await upsertAuthProfileWithLock({ - profileId: configured.profileId, - credential, - agentDir: params.ctx.agentDir, - }); - - const withProfile = applyAuthProfileConfig(configured.config, { - profileId: configured.profileId, - provider: params.providerId, - mode: "api_key", - }); - params.ctx.runtime.log(`Default ${params.providerLabel} model: ${modelId}`); - return applyProviderDefaultModel(withProfile, configured.modelRef); -} +export * from "../plugins/provider-self-hosted-setup.js"; diff --git a/src/commands/signal-install.ts b/src/commands/signal-install.ts index a5c73392b4b..0a329ecdde0 100644 --- a/src/commands/signal-install.ts +++ b/src/commands/signal-install.ts @@ -1,302 +1 @@ -import { createWriteStream } from "node:fs"; -import fs from "node:fs/promises"; -import { request } from "node:https"; -import os from "node:os"; -import path from "node:path"; -import { pipeline } from "node:stream/promises"; -import { extractArchive } from "../infra/archive.js"; -import { resolveBrewExecutable } from "../infra/brew.js"; -import { runCommandWithTimeout } from "../process/exec.js"; -import type { RuntimeEnv } from "../runtime.js"; -import { CONFIG_DIR } from "../utils.js"; - -export type ReleaseAsset = { - name?: string; - browser_download_url?: string; -}; - -export type NamedAsset = { - name: string; - browser_download_url: string; -}; - -type ReleaseResponse = { - tag_name?: string; - assets?: ReleaseAsset[]; -}; - -export type SignalInstallResult = { - ok: boolean; - cliPath?: string; - version?: string; - error?: string; -}; - -/** @internal Exported for testing. */ -export async function extractSignalCliArchive( - archivePath: string, - installRoot: string, - timeoutMs: number, -): Promise { - await extractArchive({ archivePath, destDir: installRoot, timeoutMs }); -} - -/** @internal Exported for testing. */ -export function looksLikeArchive(name: string): boolean { - return name.endsWith(".tar.gz") || name.endsWith(".tgz") || name.endsWith(".zip"); -} - -/** - * Pick a native release asset from the official GitHub releases. - * - * The official signal-cli releases only publish native (GraalVM) binaries for - * x86-64 Linux. On architectures where no native asset is available this - * returns `undefined` so the caller can fall back to a different install - * strategy (e.g. Homebrew). - */ -/** @internal Exported for testing. */ -export function pickAsset( - assets: ReleaseAsset[], - platform: NodeJS.Platform, - arch: string, -): NamedAsset | undefined { - const withName = assets.filter((asset): asset is NamedAsset => - Boolean(asset.name && asset.browser_download_url), - ); - - // Archives only, excluding signature files (.asc) - const archives = withName.filter((a) => looksLikeArchive(a.name.toLowerCase())); - - const byName = (pattern: RegExp) => - archives.find((asset) => pattern.test(asset.name.toLowerCase())); - - if (platform === "linux") { - // The official "Linux-native" asset is an x86-64 GraalVM binary. - // On non-x64 architectures it will fail with "Exec format error", - // so only select it when the host architecture matches. - if (arch === "x64") { - return byName(/linux-native/) || byName(/linux/) || archives[0]; - } - // No native release for this arch — caller should fall back. - return undefined; - } - - if (platform === "darwin") { - return byName(/macos|osx|darwin/) || archives[0]; - } - - if (platform === "win32") { - return byName(/windows|win/) || archives[0]; - } - - return archives[0]; -} - -async function downloadToFile(url: string, dest: string, maxRedirects = 5): Promise { - await new Promise((resolve, reject) => { - const req = request(url, (res) => { - if (res.statusCode && res.statusCode >= 300 && res.statusCode < 400) { - const location = res.headers.location; - if (!location || maxRedirects <= 0) { - reject(new Error("Redirect loop or missing Location header")); - return; - } - const redirectUrl = new URL(location, url).href; - resolve(downloadToFile(redirectUrl, dest, maxRedirects - 1)); - return; - } - if (!res.statusCode || res.statusCode >= 400) { - reject(new Error(`HTTP ${res.statusCode ?? "?"} downloading file`)); - return; - } - const out = createWriteStream(dest); - pipeline(res, out).then(resolve).catch(reject); - }); - req.on("error", reject); - req.end(); - }); -} - -async function findSignalCliBinary(root: string): Promise { - const candidates: string[] = []; - const enqueue = async (dir: string, depth: number) => { - if (depth > 3) { - return; - } - const entries = await fs.readdir(dir, { withFileTypes: true }).catch(() => []); - for (const entry of entries) { - const full = path.join(dir, entry.name); - if (entry.isDirectory()) { - await enqueue(full, depth + 1); - } else if (entry.isFile() && entry.name === "signal-cli") { - candidates.push(full); - } - } - }; - await enqueue(root, 0); - return candidates[0] ?? null; -} - -// --------------------------------------------------------------------------- -// Brew-based install (used on architectures without an official native build) -// --------------------------------------------------------------------------- - -async function resolveBrewSignalCliPath(brewExe: string): Promise { - try { - const result = await runCommandWithTimeout([brewExe, "--prefix", "signal-cli"], { - timeoutMs: 10_000, - }); - if (result.code === 0 && result.stdout.trim()) { - const prefix = result.stdout.trim(); - // Homebrew installs the wrapper script at /bin/signal-cli - const candidate = path.join(prefix, "bin", "signal-cli"); - try { - await fs.access(candidate); - return candidate; - } catch { - // Fall back to searching the prefix - return findSignalCliBinary(prefix); - } - } - } catch { - // ignore - } - return null; -} - -async function installSignalCliViaBrew(runtime: RuntimeEnv): Promise { - const brewExe = resolveBrewExecutable(); - if (!brewExe) { - return { - ok: false, - error: - `No native signal-cli build is available for ${process.arch}. ` + - "Install Homebrew (https://brew.sh) and try again, or install signal-cli manually.", - }; - } - - runtime.log(`Installing signal-cli via Homebrew (${brewExe})…`); - const result = await runCommandWithTimeout([brewExe, "install", "signal-cli"], { - timeoutMs: 15 * 60_000, // brew builds from source; can take a while - }); - - if (result.code !== 0) { - return { - ok: false, - error: `brew install signal-cli failed (exit ${result.code}): ${result.stderr.trim().slice(0, 200)}`, - }; - } - - const cliPath = await resolveBrewSignalCliPath(brewExe); - if (!cliPath) { - return { - ok: false, - error: "brew install succeeded but signal-cli binary was not found.", - }; - } - - // Extract version from the installed binary. - let version: string | undefined; - try { - const vResult = await runCommandWithTimeout([cliPath, "--version"], { - timeoutMs: 10_000, - }); - // Output is typically "signal-cli 0.13.24" - version = vResult.stdout.trim().replace(/^signal-cli\s+/, "") || undefined; - } catch { - // non-critical; leave version undefined - } - - return { ok: true, cliPath, version }; -} - -// --------------------------------------------------------------------------- -// Direct download install (used when an official native asset is available) -// --------------------------------------------------------------------------- - -async function installSignalCliFromRelease(runtime: RuntimeEnv): Promise { - const apiUrl = "https://api.github.com/repos/AsamK/signal-cli/releases/latest"; - const response = await fetch(apiUrl, { - headers: { - "User-Agent": "openclaw", - Accept: "application/vnd.github+json", - }, - }); - - if (!response.ok) { - return { - ok: false, - error: `Failed to fetch release info (${response.status})`, - }; - } - - const payload = (await response.json()) as ReleaseResponse; - const version = payload.tag_name?.replace(/^v/, "") ?? "unknown"; - const assets = payload.assets ?? []; - const asset = pickAsset(assets, process.platform, process.arch); - - if (!asset) { - return { - ok: false, - error: "No compatible release asset found for this platform.", - }; - } - - const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-signal-")); - const archivePath = path.join(tmpDir, asset.name); - - runtime.log(`Downloading signal-cli ${version} (${asset.name})…`); - await downloadToFile(asset.browser_download_url, archivePath); - - const installRoot = path.join(CONFIG_DIR, "tools", "signal-cli", version); - await fs.mkdir(installRoot, { recursive: true }); - - if (!looksLikeArchive(asset.name.toLowerCase())) { - return { ok: false, error: `Unsupported archive type: ${asset.name}` }; - } - try { - await extractSignalCliArchive(archivePath, installRoot, 60_000); - } catch (err) { - const message = err instanceof Error ? err.message : String(err); - return { - ok: false, - error: `Failed to extract ${asset.name}: ${message}`, - }; - } - - const cliPath = await findSignalCliBinary(installRoot); - if (!cliPath) { - return { - ok: false, - error: `signal-cli binary not found after extracting ${asset.name}`, - }; - } - - await fs.chmod(cliPath, 0o755).catch(() => {}); - - return { ok: true, cliPath, version }; -} - -// --------------------------------------------------------------------------- -// Public entry point -// --------------------------------------------------------------------------- - -export async function installSignalCli(runtime: RuntimeEnv): Promise { - if (process.platform === "win32") { - return { - ok: false, - error: "Signal CLI auto-install is not supported on Windows yet.", - }; - } - - // The official signal-cli GitHub releases only ship a native binary for - // x86-64 Linux. On other architectures (arm64, armv7, etc.) we delegate - // to Homebrew which builds from source and bundles the JRE automatically. - const hasNativeRelease = process.platform !== "linux" || process.arch === "x64"; - - if (hasNativeRelease) { - return installSignalCliFromRelease(runtime); - } - - return installSignalCliViaBrew(runtime); -} +export * from "../plugins/signal-cli-install.js"; diff --git a/src/commands/vllm-setup.ts b/src/commands/vllm-setup.ts index 4c44587c06e..57d9ce0d3e9 100644 --- a/src/commands/vllm-setup.ts +++ b/src/commands/vllm-setup.ts @@ -1,42 +1 @@ -import { - VLLM_DEFAULT_API_KEY_ENV_VAR, - VLLM_DEFAULT_BASE_URL, - VLLM_MODEL_PLACEHOLDER, - VLLM_PROVIDER_LABEL, -} from "../agents/vllm-defaults.js"; -import type { OpenClawConfig } from "../config/config.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; -import { - applyProviderDefaultModel, - SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, - SELF_HOSTED_DEFAULT_COST, - SELF_HOSTED_DEFAULT_MAX_TOKENS, - promptAndConfigureOpenAICompatibleSelfHostedProvider, -} from "./self-hosted-provider-setup.js"; - -export { VLLM_DEFAULT_BASE_URL } from "../agents/vllm-defaults.js"; -export const VLLM_DEFAULT_CONTEXT_WINDOW = SELF_HOSTED_DEFAULT_CONTEXT_WINDOW; -export const VLLM_DEFAULT_MAX_TOKENS = SELF_HOSTED_DEFAULT_MAX_TOKENS; -export const VLLM_DEFAULT_COST = SELF_HOSTED_DEFAULT_COST; - -export async function promptAndConfigureVllm(params: { - cfg: OpenClawConfig; - prompter: WizardPrompter; -}): Promise<{ config: OpenClawConfig; modelId: string; modelRef: string }> { - const result = await promptAndConfigureOpenAICompatibleSelfHostedProvider({ - cfg: params.cfg, - prompter: params.prompter, - providerId: "vllm", - providerLabel: VLLM_PROVIDER_LABEL, - defaultBaseUrl: VLLM_DEFAULT_BASE_URL, - defaultApiKeyEnvVar: VLLM_DEFAULT_API_KEY_ENV_VAR, - modelPlaceholder: VLLM_MODEL_PLACEHOLDER, - }); - return { - config: result.config, - modelId: result.modelId, - modelRef: result.modelRef, - }; -} - -export { applyProviderDefaultModel as applyVllmDefaultModel }; +export * from "../plugins/provider-vllm-setup.js"; diff --git a/src/commands/zai-endpoint-detect.ts b/src/commands/zai-endpoint-detect.ts index 4426b1065fe..a3a53e1f5eb 100644 --- a/src/commands/zai-endpoint-detect.ts +++ b/src/commands/zai-endpoint-detect.ts @@ -1,179 +1 @@ -import { - ZAI_CN_BASE_URL, - ZAI_CODING_CN_BASE_URL, - ZAI_CODING_GLOBAL_BASE_URL, - ZAI_GLOBAL_BASE_URL, -} from "../../extensions/zai/model-definitions.js"; -import { fetchWithTimeout } from "../utils/fetch-timeout.js"; - -export type ZaiEndpointId = "global" | "cn" | "coding-global" | "coding-cn"; - -export type ZaiDetectedEndpoint = { - endpoint: ZaiEndpointId; - /** Provider baseUrl to store in config. */ - baseUrl: string; - /** Recommended default model id for that endpoint. */ - modelId: string; - /** Human-readable note explaining the choice. */ - note: string; -}; - -type ProbeResult = - | { ok: true } - | { - ok: false; - status?: number; - errorCode?: string; - errorMessage?: string; - }; - -async function probeZaiChatCompletions(params: { - baseUrl: string; - apiKey: string; - modelId: string; - timeoutMs: number; - fetchFn?: typeof fetch; -}): Promise { - try { - const res = await fetchWithTimeout( - `${params.baseUrl}/chat/completions`, - { - method: "POST", - headers: { - authorization: `Bearer ${params.apiKey}`, - "content-type": "application/json", - }, - body: JSON.stringify({ - model: params.modelId, - stream: false, - max_tokens: 1, - messages: [{ role: "user", content: "ping" }], - }), - }, - params.timeoutMs, - params.fetchFn, - ); - - if (res.ok) { - return { ok: true }; - } - - let errorCode: string | undefined; - let errorMessage: string | undefined; - try { - const json = (await res.json()) as { - error?: { code?: unknown; message?: unknown }; - msg?: unknown; - message?: unknown; - }; - const code = json?.error?.code; - const msg = json?.error?.message ?? json?.msg ?? json?.message; - if (typeof code === "string") { - errorCode = code; - } else if (typeof code === "number") { - errorCode = String(code); - } - if (typeof msg === "string") { - errorMessage = msg; - } - } catch { - // ignore - } - - return { ok: false, status: res.status, errorCode, errorMessage }; - } catch { - return { ok: false }; - } -} - -export async function detectZaiEndpoint(params: { - apiKey: string; - endpoint?: ZaiEndpointId; - timeoutMs?: number; - fetchFn?: typeof fetch; -}): Promise { - // Never auto-probe in vitest; it would create flaky network behavior. - if (process.env.VITEST && !params.fetchFn) { - return null; - } - - const timeoutMs = params.timeoutMs ?? 5_000; - const probeCandidates = (() => { - const general = [ - { - endpoint: "global" as const, - baseUrl: ZAI_GLOBAL_BASE_URL, - modelId: "glm-5", - note: "Verified GLM-5 on global endpoint.", - }, - { - endpoint: "cn" as const, - baseUrl: ZAI_CN_BASE_URL, - modelId: "glm-5", - note: "Verified GLM-5 on cn endpoint.", - }, - ]; - const codingGlm5 = [ - { - endpoint: "coding-global" as const, - baseUrl: ZAI_CODING_GLOBAL_BASE_URL, - modelId: "glm-5", - note: "Verified GLM-5 on coding-global endpoint.", - }, - { - endpoint: "coding-cn" as const, - baseUrl: ZAI_CODING_CN_BASE_URL, - modelId: "glm-5", - note: "Verified GLM-5 on coding-cn endpoint.", - }, - ]; - const codingFallback = [ - { - endpoint: "coding-global" as const, - baseUrl: ZAI_CODING_GLOBAL_BASE_URL, - modelId: "glm-4.7", - note: "Coding Plan endpoint verified, but this key/plan does not expose GLM-5 there. Defaulting to GLM-4.7.", - }, - { - endpoint: "coding-cn" as const, - baseUrl: ZAI_CODING_CN_BASE_URL, - modelId: "glm-4.7", - note: "Coding Plan CN endpoint verified, but this key/plan does not expose GLM-5 there. Defaulting to GLM-4.7.", - }, - ]; - - switch (params.endpoint) { - case "global": - return general.filter((candidate) => candidate.endpoint === "global"); - case "cn": - return general.filter((candidate) => candidate.endpoint === "cn"); - case "coding-global": - return [ - ...codingGlm5.filter((candidate) => candidate.endpoint === "coding-global"), - ...codingFallback.filter((candidate) => candidate.endpoint === "coding-global"), - ]; - case "coding-cn": - return [ - ...codingGlm5.filter((candidate) => candidate.endpoint === "coding-cn"), - ...codingFallback.filter((candidate) => candidate.endpoint === "coding-cn"), - ]; - default: - return [...general, ...codingGlm5, ...codingFallback]; - } - })(); - - for (const candidate of probeCandidates) { - const result = await probeZaiChatCompletions({ - baseUrl: candidate.baseUrl, - apiKey: params.apiKey, - modelId: candidate.modelId, - timeoutMs, - fetchFn: params.fetchFn, - }); - if (result.ok) { - return candidate; - } - } - - return null; -} +export * from "../plugins/provider-zai-endpoint.js"; diff --git a/src/plugin-sdk-internal/setup.ts b/src/plugin-sdk-internal/setup.ts index d012e201bd8..f6643637e7e 100644 --- a/src/plugin-sdk-internal/setup.ts +++ b/src/plugin-sdk-internal/setup.ts @@ -30,6 +30,8 @@ export { setSetupChannelEnabled, splitSetupEntries, } from "../channels/plugins/setup-wizard-helpers.js"; +export { detectBinary } from "../plugins/setup-binary.js"; +export { installSignalCli } from "../plugins/signal-cli-install.js"; export { formatCliCommand } from "../cli/command-format.js"; export { formatDocsLink } from "../terminal/links.js"; export { hasConfiguredSecretInput } from "../config/types.secrets.js"; diff --git a/src/plugin-sdk/agent-runtime.ts b/src/plugin-sdk/agent-runtime.ts index 4eddbd51a29..d9a704df27e 100644 --- a/src/plugin-sdk/agent-runtime.ts +++ b/src/plugin-sdk/agent-runtime.ts @@ -24,5 +24,6 @@ export * from "../agents/tools/web-shared.js"; export * from "../agents/tools/discord-actions-moderation-shared.js"; export * from "../agents/tools/web-fetch-utils.js"; export * from "../agents/vllm-defaults.js"; +// Intentional public runtime surface: channel plugins use ingress agent helpers directly. export * from "../commands/agent.js"; export * from "../tts/tts.js"; diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index c5ba9d90541..50949a31a89 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -425,8 +425,8 @@ export { resolveRuntimeEnv, resolveRuntimeEnvWithUnavailableExit, } from "./runtime.js"; -export { detectBinary } from "../commands/onboard-helpers.js"; -export { installSignalCli } from "../commands/signal-install.js"; +export { detectBinary } from "../plugins/setup-binary.js"; +export { installSignalCli } from "../plugins/signal-cli-install.js"; export { chunkTextForOutbound } from "./text-chunking.js"; export { resolveTextChunkLimit } from "../auto-reply/chunk.js"; export { readBooleanParam } from "./boolean-param.js"; @@ -798,21 +798,21 @@ export { SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, SELF_HOSTED_DEFAULT_COST, SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../commands/self-hosted-provider-setup.ts"; +} from "../plugins/provider-self-hosted-setup.js"; export { OLLAMA_DEFAULT_BASE_URL, OLLAMA_DEFAULT_MODEL, configureOllamaNonInteractive, ensureOllamaModelPulled, promptAndConfigureOllama, -} from "../commands/ollama-setup.ts"; +} from "../plugins/provider-ollama-setup.js"; export { VLLM_DEFAULT_BASE_URL, VLLM_DEFAULT_CONTEXT_WINDOW, VLLM_DEFAULT_COST, VLLM_DEFAULT_MAX_TOKENS, promptAndConfigureVllm, -} from "../commands/vllm-setup.ts"; +} from "../plugins/provider-vllm-setup.js"; export { buildOllamaProvider, buildSglangProvider, diff --git a/src/plugin-sdk/ollama-setup.ts b/src/plugin-sdk/ollama-setup.ts index fa8c9032dda..2ddad898bb7 100644 --- a/src/plugin-sdk/ollama-setup.ts +++ b/src/plugin-sdk/ollama-setup.ts @@ -12,6 +12,6 @@ export { configureOllamaNonInteractive, ensureOllamaModelPulled, promptAndConfigureOllama, -} from "../commands/ollama-setup.ts"; +} from "../plugins/provider-ollama-setup.js"; export { buildOllamaProvider } from "../agents/models-config.providers.discovery.js"; diff --git a/src/plugin-sdk/provider-setup.ts b/src/plugin-sdk/provider-setup.ts index 4489c8ae34d..57f1a94e3bd 100644 --- a/src/plugin-sdk/provider-setup.ts +++ b/src/plugin-sdk/provider-setup.ts @@ -15,21 +15,21 @@ export { SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, SELF_HOSTED_DEFAULT_COST, SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../commands/self-hosted-provider-setup.ts"; +} from "../plugins/provider-self-hosted-setup.js"; export { OLLAMA_DEFAULT_BASE_URL, OLLAMA_DEFAULT_MODEL, configureOllamaNonInteractive, ensureOllamaModelPulled, promptAndConfigureOllama, -} from "../commands/ollama-setup.ts"; +} from "../plugins/provider-ollama-setup.js"; export { VLLM_DEFAULT_BASE_URL, VLLM_DEFAULT_CONTEXT_WINDOW, VLLM_DEFAULT_COST, VLLM_DEFAULT_MAX_TOKENS, promptAndConfigureVllm, -} from "../commands/vllm-setup.ts"; +} from "../plugins/provider-vllm-setup.js"; export { buildOllamaProvider, buildSglangProvider, diff --git a/src/plugin-sdk/self-hosted-provider-setup.ts b/src/plugin-sdk/self-hosted-provider-setup.ts index 60be2852a2d..47fe7d6588f 100644 --- a/src/plugin-sdk/self-hosted-provider-setup.ts +++ b/src/plugin-sdk/self-hosted-provider-setup.ts @@ -15,7 +15,7 @@ export { SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, SELF_HOSTED_DEFAULT_COST, SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../commands/self-hosted-provider-setup.ts"; +} from "../plugins/provider-self-hosted-setup.js"; export { buildSglangProvider, diff --git a/src/plugin-sdk/setup.ts b/src/plugin-sdk/setup.ts index b890045a5f8..61785569d07 100644 --- a/src/plugin-sdk/setup.ts +++ b/src/plugin-sdk/setup.ts @@ -12,8 +12,8 @@ export type { ChannelSetupWizard } from "../channels/plugins/setup-wizard.js"; export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; export { formatCliCommand } from "../cli/command-format.js"; -export { detectBinary } from "../commands/onboard-helpers.js"; -export { installSignalCli } from "../commands/signal-install.js"; +export { detectBinary } from "../plugins/setup-binary.js"; +export { installSignalCli } from "../plugins/signal-cli-install.js"; export { formatDocsLink } from "../terminal/links.js"; export { hasConfiguredSecretInput, normalizeSecretInputString } from "../config/types.secrets.js"; export { normalizeE164, pathExists } from "../utils.js"; diff --git a/src/plugin-sdk/zai.ts b/src/plugin-sdk/zai.ts index 6981a0994bf..87a745ee7d0 100644 --- a/src/plugin-sdk/zai.ts +++ b/src/plugin-sdk/zai.ts @@ -4,4 +4,4 @@ export { detectZaiEndpoint, type ZaiDetectedEndpoint, type ZaiEndpointId, -} from "../commands/zai-endpoint-detect.js"; +} from "../plugins/provider-zai-endpoint.js"; diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index f6af2bed48e..b33ef2740e8 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,7 +1,6 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; import { applyAuthChoiceLoadedPluginProvider } from "../../commands/auth-choice.apply.plugin-provider.js"; -import type { AuthChoice } from "../../commands/onboard-types.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, @@ -129,7 +128,7 @@ describe("provider auth-choice contract", () => { { authChoice: "minimax-global-oauth" as const, expectedProvider: "minimax-portal" }, { authChoice: "modelstudio-api-key" as const, expectedProvider: "modelstudio" }, { authChoice: "ollama" as const, expectedProvider: "ollama" }, - { authChoice: "unknown" as AuthChoice, expectedProvider: undefined }, + { authChoice: "unknown", expectedProvider: undefined }, ] as const; for (const scenario of scenarios) { diff --git a/src/plugins/provider-ollama-setup.ts b/src/plugins/provider-ollama-setup.ts new file mode 100644 index 00000000000..ac3fd5d1fc7 --- /dev/null +++ b/src/plugins/provider-ollama-setup.ts @@ -0,0 +1,535 @@ +import { upsertAuthProfileWithLock } from "../agents/auth-profiles/upsert-with-lock.js"; +import { OLLAMA_DEFAULT_BASE_URL } from "../agents/ollama-defaults.js"; +import { + buildOllamaModelDefinition, + enrichOllamaModelsWithContext, + fetchOllamaModels, + resolveOllamaApiBase, + type OllamaModelWithContext, +} from "../agents/ollama-models.js"; +import type { OpenClawConfig } from "../config/config.js"; +import type { RuntimeEnv } from "../runtime.js"; +import { WizardCancelledError, type WizardPrompter } from "../wizard/prompts.js"; +import { applyAgentDefaultModelPrimary } from "./provider-onboarding-config.js"; +import { isRemoteEnvironment, openUrl } from "./setup-browser.js"; +import type { ProviderAuthOptionBag } from "./types.js"; + +export { OLLAMA_DEFAULT_BASE_URL } from "../agents/ollama-defaults.js"; +export const OLLAMA_DEFAULT_MODEL = "glm-4.7-flash"; + +const OLLAMA_SUGGESTED_MODELS_LOCAL = ["glm-4.7-flash"]; +const OLLAMA_SUGGESTED_MODELS_CLOUD = ["kimi-k2.5:cloud", "minimax-m2.5:cloud", "glm-5:cloud"]; +type OllamaMode = "remote" | "local"; +type OllamaSetupOptions = ProviderAuthOptionBag & { + customBaseUrl?: string; + customModelId?: string; +}; + +function normalizeOllamaModelName(value: string | undefined): string | undefined { + const trimmed = value?.trim(); + if (!trimmed) { + return undefined; + } + if (trimmed.toLowerCase().startsWith("ollama/")) { + const withoutPrefix = trimmed.slice("ollama/".length).trim(); + return withoutPrefix || undefined; + } + return trimmed; +} + +function isOllamaCloudModel(modelName: string | undefined): boolean { + return Boolean(modelName?.trim().toLowerCase().endsWith(":cloud")); +} + +function formatOllamaPullStatus(status: string): { text: string; hidePercent: boolean } { + const trimmed = status.trim(); + const partStatusMatch = trimmed.match(/^([a-z-]+)\s+(?:sha256:)?[a-f0-9]{8,}$/i); + if (partStatusMatch) { + return { text: `${partStatusMatch[1]} part`, hidePercent: false }; + } + if (/^verifying\b.*\bdigest\b/i.test(trimmed)) { + return { text: "verifying digest", hidePercent: true }; + } + return { text: trimmed, hidePercent: false }; +} + +type OllamaCloudAuthResult = { + signedIn: boolean; + signinUrl?: string; +}; + +/** Check if the user is signed in to Ollama cloud via /api/me. */ +async function checkOllamaCloudAuth(baseUrl: string): Promise { + try { + const apiBase = resolveOllamaApiBase(baseUrl); + const response = await fetch(`${apiBase}/api/me`, { + method: "POST", + signal: AbortSignal.timeout(5000), + }); + if (response.status === 401) { + // 401 body contains { error, signin_url } + const data = (await response.json()) as { signin_url?: string }; + return { signedIn: false, signinUrl: data.signin_url }; + } + if (!response.ok) { + return { signedIn: false }; + } + return { signedIn: true }; + } catch { + // /api/me not supported or unreachable — fail closed so cloud mode + // doesn't silently skip auth; the caller handles the fallback. + return { signedIn: false }; + } +} + +type OllamaPullChunk = { + status?: string; + total?: number; + completed?: number; + error?: string; +}; + +type OllamaPullFailureKind = "http" | "no-body" | "chunk-error" | "network"; +type OllamaPullResult = + | { ok: true } + | { + ok: false; + kind: OllamaPullFailureKind; + message: string; + }; + +async function pullOllamaModelCore(params: { + baseUrl: string; + modelName: string; + onStatus?: (status: string, percent: number | null) => void; +}): Promise { + const { onStatus } = params; + const baseUrl = resolveOllamaApiBase(params.baseUrl); + const modelName = normalizeOllamaModelName(params.modelName) ?? params.modelName.trim(); + try { + const response = await fetch(`${baseUrl}/api/pull`, { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ name: modelName }), + }); + if (!response.ok) { + return { + ok: false, + kind: "http", + message: `Failed to download ${modelName} (HTTP ${response.status})`, + }; + } + if (!response.body) { + return { + ok: false, + kind: "no-body", + message: `Failed to download ${modelName} (no response body)`, + }; + } + + const reader = response.body.getReader(); + const decoder = new TextDecoder(); + let buffer = ""; + const layers = new Map(); + + const parseLine = (line: string): OllamaPullResult => { + const trimmed = line.trim(); + if (!trimmed) { + return { ok: true }; + } + try { + const chunk = JSON.parse(trimmed) as OllamaPullChunk; + if (chunk.error) { + return { + ok: false, + kind: "chunk-error", + message: `Download failed: ${chunk.error}`, + }; + } + if (!chunk.status) { + return { ok: true }; + } + if (chunk.total && chunk.completed !== undefined) { + layers.set(chunk.status, { total: chunk.total, completed: chunk.completed }); + let totalSum = 0; + let completedSum = 0; + for (const layer of layers.values()) { + totalSum += layer.total; + completedSum += layer.completed; + } + const percent = totalSum > 0 ? Math.round((completedSum / totalSum) * 100) : null; + onStatus?.(chunk.status, percent); + } else { + onStatus?.(chunk.status, null); + } + } catch { + // Ignore malformed lines from streaming output. + } + return { ok: true }; + }; + + for (;;) { + const { done, value } = await reader.read(); + if (done) { + break; + } + buffer += decoder.decode(value, { stream: true }); + const lines = buffer.split("\n"); + buffer = lines.pop() ?? ""; + for (const line of lines) { + const parsed = parseLine(line); + if (!parsed.ok) { + return parsed; + } + } + } + + const trailing = buffer.trim(); + if (trailing) { + const parsed = parseLine(trailing); + if (!parsed.ok) { + return parsed; + } + } + + return { ok: true }; + } catch (err) { + const reason = err instanceof Error ? err.message : String(err); + return { + ok: false, + kind: "network", + message: `Failed to download ${modelName}: ${reason}`, + }; + } +} + +/** Pull a model from Ollama, streaming progress updates. */ +async function pullOllamaModel( + baseUrl: string, + modelName: string, + prompter: WizardPrompter, +): Promise { + const spinner = prompter.progress(`Downloading ${modelName}...`); + const result = await pullOllamaModelCore({ + baseUrl, + modelName, + onStatus: (status, percent) => { + const displayStatus = formatOllamaPullStatus(status); + if (displayStatus.hidePercent) { + spinner.update(`Downloading ${modelName} - ${displayStatus.text}`); + } else { + spinner.update(`Downloading ${modelName} - ${displayStatus.text} - ${percent ?? 0}%`); + } + }, + }); + if (!result.ok) { + spinner.stop(result.message); + return false; + } + spinner.stop(`Downloaded ${modelName}`); + return true; +} + +async function pullOllamaModelNonInteractive( + baseUrl: string, + modelName: string, + runtime: RuntimeEnv, +): Promise { + runtime.log(`Downloading ${modelName}...`); + const result = await pullOllamaModelCore({ baseUrl, modelName }); + if (!result.ok) { + runtime.error(result.message); + return false; + } + runtime.log(`Downloaded ${modelName}`); + return true; +} + +function buildOllamaModelsConfig( + modelNames: string[], + discoveredModelsByName?: Map, +) { + return modelNames.map((name) => + buildOllamaModelDefinition(name, discoveredModelsByName?.get(name)?.contextWindow), + ); +} + +function applyOllamaProviderConfig( + cfg: OpenClawConfig, + baseUrl: string, + modelNames: string[], + discoveredModelsByName?: Map, +): OpenClawConfig { + return { + ...cfg, + models: { + ...cfg.models, + mode: cfg.models?.mode ?? "merge", + providers: { + ...cfg.models?.providers, + ollama: { + baseUrl, + api: "ollama", + apiKey: "OLLAMA_API_KEY", // pragma: allowlist secret + models: buildOllamaModelsConfig(modelNames, discoveredModelsByName), + }, + }, + }, + }; +} + +async function storeOllamaCredential(agentDir?: string): Promise { + await upsertAuthProfileWithLock({ + profileId: "ollama:default", + credential: { type: "api_key", provider: "ollama", key: "ollama-local" }, + agentDir, + }); +} + +/** + * Interactive: prompt for base URL, discover models, configure provider. + * Model selection is handled by the standard model picker downstream. + */ +export async function promptAndConfigureOllama(params: { + cfg: OpenClawConfig; + prompter: WizardPrompter; +}): Promise<{ config: OpenClawConfig; defaultModelId: string }> { + const { prompter } = params; + + // 1. Prompt base URL + const baseUrlRaw = await prompter.text({ + message: "Ollama base URL", + initialValue: OLLAMA_DEFAULT_BASE_URL, + placeholder: OLLAMA_DEFAULT_BASE_URL, + validate: (value) => (value?.trim() ? undefined : "Required"), + }); + const configuredBaseUrl = String(baseUrlRaw ?? "") + .trim() + .replace(/\/+$/, ""); + const baseUrl = resolveOllamaApiBase(configuredBaseUrl); + + // 2. Check reachability + const { reachable, models } = await fetchOllamaModels(baseUrl); + + if (!reachable) { + await prompter.note( + [ + `Ollama could not be reached at ${baseUrl}.`, + "Download it at https://ollama.com/download", + "", + "Start Ollama and re-run setup.", + ].join("\n"), + "Ollama", + ); + throw new WizardCancelledError("Ollama not reachable"); + } + + const enrichedModels = await enrichOllamaModelsWithContext(baseUrl, models.slice(0, 50)); + const discoveredModelsByName = new Map(enrichedModels.map((model) => [model.name, model])); + const modelNames = models.map((m) => m.name); + + // 3. Mode selection + const mode = (await prompter.select({ + message: "Ollama mode", + options: [ + { value: "remote", label: "Cloud + Local", hint: "Ollama cloud models + local models" }, + { value: "local", label: "Local", hint: "Local models only" }, + ], + })) as OllamaMode; + + // 4. Cloud auth — check /api/me upfront for remote (cloud+local) mode + let cloudAuthVerified = false; + if (mode === "remote") { + const authResult = await checkOllamaCloudAuth(baseUrl); + if (!authResult.signedIn) { + if (authResult.signinUrl) { + if (!isRemoteEnvironment()) { + await openUrl(authResult.signinUrl); + } + await prompter.note( + ["Sign in to Ollama Cloud:", authResult.signinUrl].join("\n"), + "Ollama Cloud", + ); + const confirmed = await prompter.confirm({ + message: "Have you signed in?", + }); + if (!confirmed) { + throw new WizardCancelledError("Ollama cloud sign-in cancelled"); + } + // Re-check after user claims sign-in + const recheck = await checkOllamaCloudAuth(baseUrl); + if (!recheck.signedIn) { + throw new WizardCancelledError("Ollama cloud sign-in required"); + } + cloudAuthVerified = true; + } else { + // No signin URL available (older server, unreachable /api/me, or custom gateway). + await prompter.note( + [ + "Could not verify Ollama Cloud authentication.", + "Cloud models may not work until you sign in at https://ollama.com.", + ].join("\n"), + "Ollama Cloud", + ); + const continueAnyway = await prompter.confirm({ + message: "Continue without cloud auth?", + }); + if (!continueAnyway) { + throw new WizardCancelledError("Ollama cloud auth could not be verified"); + } + // Cloud auth unverified — fall back to local defaults so the model + // picker doesn't steer toward cloud models that may fail. + } + } else { + cloudAuthVerified = true; + } + } + + // 5. Model ordering — suggested models first. + // Use cloud defaults only when auth was actually verified; otherwise fall + // back to local defaults so the user isn't steered toward cloud models + // that may fail at runtime. + const suggestedModels = + mode === "local" || !cloudAuthVerified + ? OLLAMA_SUGGESTED_MODELS_LOCAL + : OLLAMA_SUGGESTED_MODELS_CLOUD; + const orderedModelNames = [ + ...suggestedModels, + ...modelNames.filter((name) => !suggestedModels.includes(name)), + ]; + + const defaultModelId = suggestedModels[0] ?? OLLAMA_DEFAULT_MODEL; + const config = applyOllamaProviderConfig( + params.cfg, + baseUrl, + orderedModelNames, + discoveredModelsByName, + ); + return { config, defaultModelId }; +} + +/** Non-interactive: auto-discover models and configure provider. */ +export async function configureOllamaNonInteractive(params: { + nextConfig: OpenClawConfig; + opts: OllamaSetupOptions; + runtime: RuntimeEnv; +}): Promise { + const { opts, runtime } = params; + const configuredBaseUrl = (opts.customBaseUrl?.trim() || OLLAMA_DEFAULT_BASE_URL).replace( + /\/+$/, + "", + ); + const baseUrl = resolveOllamaApiBase(configuredBaseUrl); + + const { reachable, models } = await fetchOllamaModels(baseUrl); + const explicitModel = normalizeOllamaModelName(opts.customModelId); + + if (!reachable) { + runtime.error( + [ + `Ollama could not be reached at ${baseUrl}.`, + "Download it at https://ollama.com/download", + ].join("\n"), + ); + runtime.exit(1); + return params.nextConfig; + } + + await storeOllamaCredential(); + + const enrichedModels = await enrichOllamaModelsWithContext(baseUrl, models.slice(0, 50)); + const discoveredModelsByName = new Map(enrichedModels.map((model) => [model.name, model])); + const modelNames = models.map((m) => m.name); + + // Apply local suggested model ordering. + const suggestedModels = OLLAMA_SUGGESTED_MODELS_LOCAL; + const orderedModelNames = [ + ...suggestedModels, + ...modelNames.filter((name) => !suggestedModels.includes(name)), + ]; + + const requestedDefaultModelId = explicitModel ?? suggestedModels[0]; + let pulledRequestedModel = false; + const availableModelNames = new Set(modelNames); + const requestedCloudModel = isOllamaCloudModel(requestedDefaultModelId); + + if (requestedCloudModel) { + availableModelNames.add(requestedDefaultModelId); + } + + // Pull if model not in discovered list and Ollama is reachable + if (!requestedCloudModel && !modelNames.includes(requestedDefaultModelId)) { + pulledRequestedModel = await pullOllamaModelNonInteractive( + baseUrl, + requestedDefaultModelId, + runtime, + ); + if (pulledRequestedModel) { + availableModelNames.add(requestedDefaultModelId); + } + } + + let allModelNames = orderedModelNames; + let defaultModelId = requestedDefaultModelId; + if ( + (pulledRequestedModel || requestedCloudModel) && + !allModelNames.includes(requestedDefaultModelId) + ) { + allModelNames = [...allModelNames, requestedDefaultModelId]; + } + if (!availableModelNames.has(requestedDefaultModelId)) { + if (availableModelNames.size > 0) { + const firstAvailableModel = + allModelNames.find((name) => availableModelNames.has(name)) ?? + Array.from(availableModelNames)[0]; + defaultModelId = firstAvailableModel; + runtime.log( + `Ollama model ${requestedDefaultModelId} was not available; using ${defaultModelId} instead.`, + ); + } else { + runtime.error( + [ + `No Ollama models are available at ${baseUrl}.`, + "Pull a model first, then re-run setup.", + ].join("\n"), + ); + runtime.exit(1); + return params.nextConfig; + } + } + + const config = applyOllamaProviderConfig( + params.nextConfig, + baseUrl, + allModelNames, + discoveredModelsByName, + ); + const modelRef = `ollama/${defaultModelId}`; + runtime.log(`Default Ollama model: ${defaultModelId}`); + return applyAgentDefaultModelPrimary(config, modelRef); +} + +/** Pull the configured default Ollama model if it isn't already available locally. */ +export async function ensureOllamaModelPulled(params: { + config: OpenClawConfig; + prompter: WizardPrompter; +}): Promise { + const modelCfg = params.config.agents?.defaults?.model; + const modelId = typeof modelCfg === "string" ? modelCfg : modelCfg?.primary; + if (!modelId?.startsWith("ollama/")) { + return; + } + const baseUrl = params.config.models?.providers?.ollama?.baseUrl ?? OLLAMA_DEFAULT_BASE_URL; + const modelName = modelId.slice("ollama/".length); + if (isOllamaCloudModel(modelName)) { + return; + } + const { models } = await fetchOllamaModels(baseUrl); + if (models.some((m) => m.name === modelName)) { + return; + } + const pulled = await pullOllamaModel(baseUrl, modelName, params.prompter); + if (!pulled) { + throw new WizardCancelledError("Failed to download selected Ollama model"); + } +} diff --git a/src/plugins/provider-self-hosted-setup.ts b/src/plugins/provider-self-hosted-setup.ts new file mode 100644 index 00000000000..db7223ed987 --- /dev/null +++ b/src/plugins/provider-self-hosted-setup.ts @@ -0,0 +1,304 @@ +import type { ApiKeyCredential, AuthProfileCredential } from "../agents/auth-profiles/types.js"; +import { upsertAuthProfileWithLock } from "../agents/auth-profiles/upsert-with-lock.js"; +import { + SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, + SELF_HOSTED_DEFAULT_COST, + SELF_HOSTED_DEFAULT_MAX_TOKENS, +} from "../agents/self-hosted-provider-defaults.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { normalizeOptionalSecretInput } from "../utils/normalize-secret-input.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; +import { applyAuthProfileConfig } from "./provider-auth-helpers.js"; +import type { + ProviderDiscoveryContext, + ProviderAuthResult, + ProviderAuthMethodNonInteractiveContext, + ProviderNonInteractiveApiKeyResult, +} from "./types.js"; + +export { + SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, + SELF_HOSTED_DEFAULT_COST, + SELF_HOSTED_DEFAULT_MAX_TOKENS, +} from "../agents/self-hosted-provider-defaults.js"; + +export function applyProviderDefaultModel(cfg: OpenClawConfig, modelRef: string): OpenClawConfig { + const existingModel = cfg.agents?.defaults?.model; + const fallbacks = + existingModel && typeof existingModel === "object" && "fallbacks" in existingModel + ? (existingModel as { fallbacks?: string[] }).fallbacks + : undefined; + + return { + ...cfg, + agents: { + ...cfg.agents, + defaults: { + ...cfg.agents?.defaults, + model: { + ...(fallbacks ? { fallbacks } : undefined), + primary: modelRef, + }, + }, + }, + }; +} + +function buildOpenAICompatibleSelfHostedProviderConfig(params: { + cfg: OpenClawConfig; + providerId: string; + baseUrl: string; + providerApiKey: string; + modelId: string; + input?: Array<"text" | "image">; + reasoning?: boolean; + contextWindow?: number; + maxTokens?: number; +}): { config: OpenClawConfig; modelId: string; modelRef: string; profileId: string } { + const modelRef = `${params.providerId}/${params.modelId}`; + const profileId = `${params.providerId}:default`; + return { + config: { + ...params.cfg, + models: { + ...params.cfg.models, + mode: params.cfg.models?.mode ?? "merge", + providers: { + ...params.cfg.models?.providers, + [params.providerId]: { + baseUrl: params.baseUrl, + api: "openai-completions", + apiKey: params.providerApiKey, + models: [ + { + id: params.modelId, + name: params.modelId, + reasoning: params.reasoning ?? false, + input: params.input ?? ["text"], + cost: SELF_HOSTED_DEFAULT_COST, + contextWindow: params.contextWindow ?? SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, + maxTokens: params.maxTokens ?? SELF_HOSTED_DEFAULT_MAX_TOKENS, + }, + ], + }, + }, + }, + }, + modelId: params.modelId, + modelRef, + profileId, + }; +} + +type OpenAICompatibleSelfHostedProviderSetupParams = { + cfg: OpenClawConfig; + prompter: WizardPrompter; + providerId: string; + providerLabel: string; + defaultBaseUrl: string; + defaultApiKeyEnvVar: string; + modelPlaceholder: string; + input?: Array<"text" | "image">; + reasoning?: boolean; + contextWindow?: number; + maxTokens?: number; +}; + +type OpenAICompatibleSelfHostedProviderPromptResult = { + config: OpenClawConfig; + credential: AuthProfileCredential; + modelId: string; + modelRef: string; + profileId: string; +}; + +function buildSelfHostedProviderAuthResult( + result: OpenAICompatibleSelfHostedProviderPromptResult, +): ProviderAuthResult { + return { + profiles: [ + { + profileId: result.profileId, + credential: result.credential, + }, + ], + configPatch: result.config, + defaultModel: result.modelRef, + }; +} + +export async function promptAndConfigureOpenAICompatibleSelfHostedProvider( + params: OpenAICompatibleSelfHostedProviderSetupParams, +): Promise { + const baseUrlRaw = await params.prompter.text({ + message: `${params.providerLabel} base URL`, + initialValue: params.defaultBaseUrl, + placeholder: params.defaultBaseUrl, + validate: (value) => (value?.trim() ? undefined : "Required"), + }); + const apiKeyRaw = await params.prompter.text({ + message: `${params.providerLabel} API key`, + placeholder: "sk-... (or any non-empty string)", + validate: (value) => (value?.trim() ? undefined : "Required"), + }); + const modelIdRaw = await params.prompter.text({ + message: `${params.providerLabel} model`, + placeholder: params.modelPlaceholder, + validate: (value) => (value?.trim() ? undefined : "Required"), + }); + + const baseUrl = String(baseUrlRaw ?? "") + .trim() + .replace(/\/+$/, ""); + const apiKey = String(apiKeyRaw ?? "").trim(); + const modelId = String(modelIdRaw ?? "").trim(); + const credential: AuthProfileCredential = { + type: "api_key", + provider: params.providerId, + key: apiKey, + }; + const configured = buildOpenAICompatibleSelfHostedProviderConfig({ + cfg: params.cfg, + providerId: params.providerId, + baseUrl, + providerApiKey: params.defaultApiKeyEnvVar, + modelId, + input: params.input, + reasoning: params.reasoning, + contextWindow: params.contextWindow, + maxTokens: params.maxTokens, + }); + + return { + config: configured.config, + credential, + modelId: configured.modelId, + modelRef: configured.modelRef, + profileId: configured.profileId, + }; +} + +export async function promptAndConfigureOpenAICompatibleSelfHostedProviderAuth( + params: OpenAICompatibleSelfHostedProviderSetupParams, +): Promise { + const result = await promptAndConfigureOpenAICompatibleSelfHostedProvider(params); + return buildSelfHostedProviderAuthResult(result); +} + +export async function discoverOpenAICompatibleSelfHostedProvider< + T extends Record, +>(params: { + ctx: ProviderDiscoveryContext; + providerId: string; + buildProvider: (params: { apiKey?: string }) => Promise; +}): Promise<{ provider: T & { apiKey: string } } | null> { + if (params.ctx.config.models?.providers?.[params.providerId]) { + return null; + } + const { apiKey, discoveryApiKey } = params.ctx.resolveProviderApiKey(params.providerId); + if (!apiKey) { + return null; + } + return { + provider: { + ...(await params.buildProvider({ apiKey: discoveryApiKey })), + apiKey, + }, + }; +} + +function buildMissingNonInteractiveModelIdMessage(params: { + authChoice: string; + providerLabel: string; + modelPlaceholder: string; +}): string { + return [ + `Missing --custom-model-id for --auth-choice ${params.authChoice}.`, + `Pass the ${params.providerLabel} model id to use, for example ${params.modelPlaceholder}.`, + ].join("\n"); +} + +function buildSelfHostedProviderCredential(params: { + ctx: ProviderAuthMethodNonInteractiveContext; + providerId: string; + resolved: ProviderNonInteractiveApiKeyResult; +}): ApiKeyCredential | null { + return params.ctx.toApiKeyCredential({ + provider: params.providerId, + resolved: params.resolved, + }); +} + +export async function configureOpenAICompatibleSelfHostedProviderNonInteractive(params: { + ctx: ProviderAuthMethodNonInteractiveContext; + providerId: string; + providerLabel: string; + defaultBaseUrl: string; + defaultApiKeyEnvVar: string; + modelPlaceholder: string; + input?: Array<"text" | "image">; + reasoning?: boolean; + contextWindow?: number; + maxTokens?: number; +}): Promise { + const baseUrl = ( + normalizeOptionalSecretInput(params.ctx.opts.customBaseUrl) ?? params.defaultBaseUrl + ).replace(/\/+$/, ""); + const modelId = normalizeOptionalSecretInput(params.ctx.opts.customModelId); + if (!modelId) { + params.ctx.runtime.error( + buildMissingNonInteractiveModelIdMessage({ + authChoice: params.ctx.authChoice, + providerLabel: params.providerLabel, + modelPlaceholder: params.modelPlaceholder, + }), + ); + params.ctx.runtime.exit(1); + return null; + } + + const resolved = await params.ctx.resolveApiKey({ + provider: params.providerId, + flagValue: normalizeOptionalSecretInput(params.ctx.opts.customApiKey), + flagName: "--custom-api-key", + envVar: params.defaultApiKeyEnvVar, + envVarName: params.defaultApiKeyEnvVar, + }); + if (!resolved) { + return null; + } + + const credential = buildSelfHostedProviderCredential({ + ctx: params.ctx, + providerId: params.providerId, + resolved, + }); + if (!credential) { + return null; + } + + const configured = buildOpenAICompatibleSelfHostedProviderConfig({ + cfg: params.ctx.config, + providerId: params.providerId, + baseUrl, + providerApiKey: params.defaultApiKeyEnvVar, + modelId, + input: params.input, + reasoning: params.reasoning, + contextWindow: params.contextWindow, + maxTokens: params.maxTokens, + }); + await upsertAuthProfileWithLock({ + profileId: configured.profileId, + credential, + agentDir: params.ctx.agentDir, + }); + + const withProfile = applyAuthProfileConfig(configured.config, { + profileId: configured.profileId, + provider: params.providerId, + mode: "api_key", + }); + params.ctx.runtime.log(`Default ${params.providerLabel} model: ${modelId}`); + return applyProviderDefaultModel(withProfile, configured.modelRef); +} diff --git a/src/plugins/provider-vllm-setup.ts b/src/plugins/provider-vllm-setup.ts new file mode 100644 index 00000000000..01f291abbe5 --- /dev/null +++ b/src/plugins/provider-vllm-setup.ts @@ -0,0 +1,42 @@ +import { + VLLM_DEFAULT_API_KEY_ENV_VAR, + VLLM_DEFAULT_BASE_URL, + VLLM_MODEL_PLACEHOLDER, + VLLM_PROVIDER_LABEL, +} from "../agents/vllm-defaults.js"; +import type { OpenClawConfig } from "../config/config.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; +import { + applyProviderDefaultModel, + SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, + SELF_HOSTED_DEFAULT_COST, + SELF_HOSTED_DEFAULT_MAX_TOKENS, + promptAndConfigureOpenAICompatibleSelfHostedProvider, +} from "./provider-self-hosted-setup.js"; + +export { VLLM_DEFAULT_BASE_URL } from "../agents/vllm-defaults.js"; +export const VLLM_DEFAULT_CONTEXT_WINDOW = SELF_HOSTED_DEFAULT_CONTEXT_WINDOW; +export const VLLM_DEFAULT_MAX_TOKENS = SELF_HOSTED_DEFAULT_MAX_TOKENS; +export const VLLM_DEFAULT_COST = SELF_HOSTED_DEFAULT_COST; + +export async function promptAndConfigureVllm(params: { + cfg: OpenClawConfig; + prompter: WizardPrompter; +}): Promise<{ config: OpenClawConfig; modelId: string; modelRef: string }> { + const result = await promptAndConfigureOpenAICompatibleSelfHostedProvider({ + cfg: params.cfg, + prompter: params.prompter, + providerId: "vllm", + providerLabel: VLLM_PROVIDER_LABEL, + defaultBaseUrl: VLLM_DEFAULT_BASE_URL, + defaultApiKeyEnvVar: VLLM_DEFAULT_API_KEY_ENV_VAR, + modelPlaceholder: VLLM_MODEL_PLACEHOLDER, + }); + return { + config: result.config, + modelId: result.modelId, + modelRef: result.modelRef, + }; +} + +export { applyProviderDefaultModel as applyVllmDefaultModel }; diff --git a/src/plugins/provider-zai-endpoint.ts b/src/plugins/provider-zai-endpoint.ts new file mode 100644 index 00000000000..4426b1065fe --- /dev/null +++ b/src/plugins/provider-zai-endpoint.ts @@ -0,0 +1,179 @@ +import { + ZAI_CN_BASE_URL, + ZAI_CODING_CN_BASE_URL, + ZAI_CODING_GLOBAL_BASE_URL, + ZAI_GLOBAL_BASE_URL, +} from "../../extensions/zai/model-definitions.js"; +import { fetchWithTimeout } from "../utils/fetch-timeout.js"; + +export type ZaiEndpointId = "global" | "cn" | "coding-global" | "coding-cn"; + +export type ZaiDetectedEndpoint = { + endpoint: ZaiEndpointId; + /** Provider baseUrl to store in config. */ + baseUrl: string; + /** Recommended default model id for that endpoint. */ + modelId: string; + /** Human-readable note explaining the choice. */ + note: string; +}; + +type ProbeResult = + | { ok: true } + | { + ok: false; + status?: number; + errorCode?: string; + errorMessage?: string; + }; + +async function probeZaiChatCompletions(params: { + baseUrl: string; + apiKey: string; + modelId: string; + timeoutMs: number; + fetchFn?: typeof fetch; +}): Promise { + try { + const res = await fetchWithTimeout( + `${params.baseUrl}/chat/completions`, + { + method: "POST", + headers: { + authorization: `Bearer ${params.apiKey}`, + "content-type": "application/json", + }, + body: JSON.stringify({ + model: params.modelId, + stream: false, + max_tokens: 1, + messages: [{ role: "user", content: "ping" }], + }), + }, + params.timeoutMs, + params.fetchFn, + ); + + if (res.ok) { + return { ok: true }; + } + + let errorCode: string | undefined; + let errorMessage: string | undefined; + try { + const json = (await res.json()) as { + error?: { code?: unknown; message?: unknown }; + msg?: unknown; + message?: unknown; + }; + const code = json?.error?.code; + const msg = json?.error?.message ?? json?.msg ?? json?.message; + if (typeof code === "string") { + errorCode = code; + } else if (typeof code === "number") { + errorCode = String(code); + } + if (typeof msg === "string") { + errorMessage = msg; + } + } catch { + // ignore + } + + return { ok: false, status: res.status, errorCode, errorMessage }; + } catch { + return { ok: false }; + } +} + +export async function detectZaiEndpoint(params: { + apiKey: string; + endpoint?: ZaiEndpointId; + timeoutMs?: number; + fetchFn?: typeof fetch; +}): Promise { + // Never auto-probe in vitest; it would create flaky network behavior. + if (process.env.VITEST && !params.fetchFn) { + return null; + } + + const timeoutMs = params.timeoutMs ?? 5_000; + const probeCandidates = (() => { + const general = [ + { + endpoint: "global" as const, + baseUrl: ZAI_GLOBAL_BASE_URL, + modelId: "glm-5", + note: "Verified GLM-5 on global endpoint.", + }, + { + endpoint: "cn" as const, + baseUrl: ZAI_CN_BASE_URL, + modelId: "glm-5", + note: "Verified GLM-5 on cn endpoint.", + }, + ]; + const codingGlm5 = [ + { + endpoint: "coding-global" as const, + baseUrl: ZAI_CODING_GLOBAL_BASE_URL, + modelId: "glm-5", + note: "Verified GLM-5 on coding-global endpoint.", + }, + { + endpoint: "coding-cn" as const, + baseUrl: ZAI_CODING_CN_BASE_URL, + modelId: "glm-5", + note: "Verified GLM-5 on coding-cn endpoint.", + }, + ]; + const codingFallback = [ + { + endpoint: "coding-global" as const, + baseUrl: ZAI_CODING_GLOBAL_BASE_URL, + modelId: "glm-4.7", + note: "Coding Plan endpoint verified, but this key/plan does not expose GLM-5 there. Defaulting to GLM-4.7.", + }, + { + endpoint: "coding-cn" as const, + baseUrl: ZAI_CODING_CN_BASE_URL, + modelId: "glm-4.7", + note: "Coding Plan CN endpoint verified, but this key/plan does not expose GLM-5 there. Defaulting to GLM-4.7.", + }, + ]; + + switch (params.endpoint) { + case "global": + return general.filter((candidate) => candidate.endpoint === "global"); + case "cn": + return general.filter((candidate) => candidate.endpoint === "cn"); + case "coding-global": + return [ + ...codingGlm5.filter((candidate) => candidate.endpoint === "coding-global"), + ...codingFallback.filter((candidate) => candidate.endpoint === "coding-global"), + ]; + case "coding-cn": + return [ + ...codingGlm5.filter((candidate) => candidate.endpoint === "coding-cn"), + ...codingFallback.filter((candidate) => candidate.endpoint === "coding-cn"), + ]; + default: + return [...general, ...codingGlm5, ...codingFallback]; + } + })(); + + for (const candidate of probeCandidates) { + const result = await probeZaiChatCompletions({ + baseUrl: candidate.baseUrl, + apiKey: params.apiKey, + modelId: candidate.modelId, + timeoutMs, + fetchFn: params.fetchFn, + }); + if (result.ok) { + return candidate; + } + } + + return null; +} diff --git a/src/plugins/setup-binary.ts b/src/plugins/setup-binary.ts new file mode 100644 index 00000000000..c1e534c2944 --- /dev/null +++ b/src/plugins/setup-binary.ts @@ -0,0 +1,36 @@ +import fs from "node:fs/promises"; +import path from "node:path"; +import { isSafeExecutableValue } from "../infra/exec-safety.js"; +import { runCommandWithTimeout } from "../process/exec.js"; +import { resolveUserPath } from "../utils.js"; + +export async function detectBinary(name: string): Promise { + if (!name?.trim()) { + return false; + } + if (!isSafeExecutableValue(name)) { + return false; + } + const resolved = name.startsWith("~") ? resolveUserPath(name) : name; + if ( + path.isAbsolute(resolved) || + resolved.startsWith(".") || + resolved.includes("/") || + resolved.includes("\\") + ) { + try { + await fs.access(resolved); + return true; + } catch { + return false; + } + } + + const command = process.platform === "win32" ? ["where", name] : ["/usr/bin/env", "which", name]; + try { + const result = await runCommandWithTimeout(command, { timeoutMs: 2000 }); + return result.code === 0 && result.stdout.trim().length > 0; + } catch { + return false; + } +} diff --git a/src/plugins/setup-browser.ts b/src/plugins/setup-browser.ts new file mode 100644 index 00000000000..eca0ab486bd --- /dev/null +++ b/src/plugins/setup-browser.ts @@ -0,0 +1,112 @@ +import { isWSL, isWSLEnv } from "../infra/wsl.js"; +import { runCommandWithTimeout } from "../process/exec.js"; +import { detectBinary } from "./setup-binary.js"; + +function shouldSkipBrowserOpenInTests(): boolean { + if (process.env.VITEST) { + return true; + } + return process.env.NODE_ENV === "test"; +} + +type BrowserOpenCommand = { + argv: string[] | null; + command?: string; + quoteUrl?: boolean; +}; + +async function resolveBrowserOpenCommand(): Promise { + const platform = process.platform; + const hasDisplay = Boolean(process.env.DISPLAY || process.env.WAYLAND_DISPLAY); + const isSsh = + Boolean(process.env.SSH_CLIENT) || + Boolean(process.env.SSH_TTY) || + Boolean(process.env.SSH_CONNECTION); + + if (isSsh && !hasDisplay && platform !== "win32") { + return { argv: null }; + } + + if (platform === "win32") { + return { + argv: ["cmd", "/c", "start", ""], + command: "cmd", + quoteUrl: true, + }; + } + + if (platform === "darwin") { + const hasOpen = await detectBinary("open"); + return hasOpen ? { argv: ["open"], command: "open" } : { argv: null }; + } + + if (platform === "linux") { + const wsl = await isWSL(); + if (!hasDisplay && !wsl) { + return { argv: null }; + } + if (wsl) { + const hasWslview = await detectBinary("wslview"); + if (hasWslview) { + return { argv: ["wslview"], command: "wslview" }; + } + if (!hasDisplay) { + return { argv: null }; + } + } + const hasXdgOpen = await detectBinary("xdg-open"); + return hasXdgOpen ? { argv: ["xdg-open"], command: "xdg-open" } : { argv: null }; + } + + return { argv: null }; +} + +export function isRemoteEnvironment(): boolean { + if (process.env.SSH_CLIENT || process.env.SSH_TTY || process.env.SSH_CONNECTION) { + return true; + } + + if (process.env.REMOTE_CONTAINERS || process.env.CODESPACES) { + return true; + } + + if ( + process.platform === "linux" && + !process.env.DISPLAY && + !process.env.WAYLAND_DISPLAY && + !isWSLEnv() + ) { + return true; + } + + return false; +} + +export async function openUrl(url: string): Promise { + if (shouldSkipBrowserOpenInTests()) { + return false; + } + const resolved = await resolveBrowserOpenCommand(); + if (!resolved.argv) { + return false; + } + const quoteUrl = resolved.quoteUrl === true; + const command = [...resolved.argv]; + if (quoteUrl) { + if (command.at(-1) === "") { + command[command.length - 1] = '""'; + } + command.push(`"${url}"`); + } else { + command.push(url); + } + try { + await runCommandWithTimeout(command, { + timeoutMs: 5_000, + windowsVerbatimArguments: quoteUrl, + }); + return true; + } catch { + return false; + } +} diff --git a/src/plugins/signal-cli-install.ts b/src/plugins/signal-cli-install.ts new file mode 100644 index 00000000000..a5c73392b4b --- /dev/null +++ b/src/plugins/signal-cli-install.ts @@ -0,0 +1,302 @@ +import { createWriteStream } from "node:fs"; +import fs from "node:fs/promises"; +import { request } from "node:https"; +import os from "node:os"; +import path from "node:path"; +import { pipeline } from "node:stream/promises"; +import { extractArchive } from "../infra/archive.js"; +import { resolveBrewExecutable } from "../infra/brew.js"; +import { runCommandWithTimeout } from "../process/exec.js"; +import type { RuntimeEnv } from "../runtime.js"; +import { CONFIG_DIR } from "../utils.js"; + +export type ReleaseAsset = { + name?: string; + browser_download_url?: string; +}; + +export type NamedAsset = { + name: string; + browser_download_url: string; +}; + +type ReleaseResponse = { + tag_name?: string; + assets?: ReleaseAsset[]; +}; + +export type SignalInstallResult = { + ok: boolean; + cliPath?: string; + version?: string; + error?: string; +}; + +/** @internal Exported for testing. */ +export async function extractSignalCliArchive( + archivePath: string, + installRoot: string, + timeoutMs: number, +): Promise { + await extractArchive({ archivePath, destDir: installRoot, timeoutMs }); +} + +/** @internal Exported for testing. */ +export function looksLikeArchive(name: string): boolean { + return name.endsWith(".tar.gz") || name.endsWith(".tgz") || name.endsWith(".zip"); +} + +/** + * Pick a native release asset from the official GitHub releases. + * + * The official signal-cli releases only publish native (GraalVM) binaries for + * x86-64 Linux. On architectures where no native asset is available this + * returns `undefined` so the caller can fall back to a different install + * strategy (e.g. Homebrew). + */ +/** @internal Exported for testing. */ +export function pickAsset( + assets: ReleaseAsset[], + platform: NodeJS.Platform, + arch: string, +): NamedAsset | undefined { + const withName = assets.filter((asset): asset is NamedAsset => + Boolean(asset.name && asset.browser_download_url), + ); + + // Archives only, excluding signature files (.asc) + const archives = withName.filter((a) => looksLikeArchive(a.name.toLowerCase())); + + const byName = (pattern: RegExp) => + archives.find((asset) => pattern.test(asset.name.toLowerCase())); + + if (platform === "linux") { + // The official "Linux-native" asset is an x86-64 GraalVM binary. + // On non-x64 architectures it will fail with "Exec format error", + // so only select it when the host architecture matches. + if (arch === "x64") { + return byName(/linux-native/) || byName(/linux/) || archives[0]; + } + // No native release for this arch — caller should fall back. + return undefined; + } + + if (platform === "darwin") { + return byName(/macos|osx|darwin/) || archives[0]; + } + + if (platform === "win32") { + return byName(/windows|win/) || archives[0]; + } + + return archives[0]; +} + +async function downloadToFile(url: string, dest: string, maxRedirects = 5): Promise { + await new Promise((resolve, reject) => { + const req = request(url, (res) => { + if (res.statusCode && res.statusCode >= 300 && res.statusCode < 400) { + const location = res.headers.location; + if (!location || maxRedirects <= 0) { + reject(new Error("Redirect loop or missing Location header")); + return; + } + const redirectUrl = new URL(location, url).href; + resolve(downloadToFile(redirectUrl, dest, maxRedirects - 1)); + return; + } + if (!res.statusCode || res.statusCode >= 400) { + reject(new Error(`HTTP ${res.statusCode ?? "?"} downloading file`)); + return; + } + const out = createWriteStream(dest); + pipeline(res, out).then(resolve).catch(reject); + }); + req.on("error", reject); + req.end(); + }); +} + +async function findSignalCliBinary(root: string): Promise { + const candidates: string[] = []; + const enqueue = async (dir: string, depth: number) => { + if (depth > 3) { + return; + } + const entries = await fs.readdir(dir, { withFileTypes: true }).catch(() => []); + for (const entry of entries) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + await enqueue(full, depth + 1); + } else if (entry.isFile() && entry.name === "signal-cli") { + candidates.push(full); + } + } + }; + await enqueue(root, 0); + return candidates[0] ?? null; +} + +// --------------------------------------------------------------------------- +// Brew-based install (used on architectures without an official native build) +// --------------------------------------------------------------------------- + +async function resolveBrewSignalCliPath(brewExe: string): Promise { + try { + const result = await runCommandWithTimeout([brewExe, "--prefix", "signal-cli"], { + timeoutMs: 10_000, + }); + if (result.code === 0 && result.stdout.trim()) { + const prefix = result.stdout.trim(); + // Homebrew installs the wrapper script at /bin/signal-cli + const candidate = path.join(prefix, "bin", "signal-cli"); + try { + await fs.access(candidate); + return candidate; + } catch { + // Fall back to searching the prefix + return findSignalCliBinary(prefix); + } + } + } catch { + // ignore + } + return null; +} + +async function installSignalCliViaBrew(runtime: RuntimeEnv): Promise { + const brewExe = resolveBrewExecutable(); + if (!brewExe) { + return { + ok: false, + error: + `No native signal-cli build is available for ${process.arch}. ` + + "Install Homebrew (https://brew.sh) and try again, or install signal-cli manually.", + }; + } + + runtime.log(`Installing signal-cli via Homebrew (${brewExe})…`); + const result = await runCommandWithTimeout([brewExe, "install", "signal-cli"], { + timeoutMs: 15 * 60_000, // brew builds from source; can take a while + }); + + if (result.code !== 0) { + return { + ok: false, + error: `brew install signal-cli failed (exit ${result.code}): ${result.stderr.trim().slice(0, 200)}`, + }; + } + + const cliPath = await resolveBrewSignalCliPath(brewExe); + if (!cliPath) { + return { + ok: false, + error: "brew install succeeded but signal-cli binary was not found.", + }; + } + + // Extract version from the installed binary. + let version: string | undefined; + try { + const vResult = await runCommandWithTimeout([cliPath, "--version"], { + timeoutMs: 10_000, + }); + // Output is typically "signal-cli 0.13.24" + version = vResult.stdout.trim().replace(/^signal-cli\s+/, "") || undefined; + } catch { + // non-critical; leave version undefined + } + + return { ok: true, cliPath, version }; +} + +// --------------------------------------------------------------------------- +// Direct download install (used when an official native asset is available) +// --------------------------------------------------------------------------- + +async function installSignalCliFromRelease(runtime: RuntimeEnv): Promise { + const apiUrl = "https://api.github.com/repos/AsamK/signal-cli/releases/latest"; + const response = await fetch(apiUrl, { + headers: { + "User-Agent": "openclaw", + Accept: "application/vnd.github+json", + }, + }); + + if (!response.ok) { + return { + ok: false, + error: `Failed to fetch release info (${response.status})`, + }; + } + + const payload = (await response.json()) as ReleaseResponse; + const version = payload.tag_name?.replace(/^v/, "") ?? "unknown"; + const assets = payload.assets ?? []; + const asset = pickAsset(assets, process.platform, process.arch); + + if (!asset) { + return { + ok: false, + error: "No compatible release asset found for this platform.", + }; + } + + const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-signal-")); + const archivePath = path.join(tmpDir, asset.name); + + runtime.log(`Downloading signal-cli ${version} (${asset.name})…`); + await downloadToFile(asset.browser_download_url, archivePath); + + const installRoot = path.join(CONFIG_DIR, "tools", "signal-cli", version); + await fs.mkdir(installRoot, { recursive: true }); + + if (!looksLikeArchive(asset.name.toLowerCase())) { + return { ok: false, error: `Unsupported archive type: ${asset.name}` }; + } + try { + await extractSignalCliArchive(archivePath, installRoot, 60_000); + } catch (err) { + const message = err instanceof Error ? err.message : String(err); + return { + ok: false, + error: `Failed to extract ${asset.name}: ${message}`, + }; + } + + const cliPath = await findSignalCliBinary(installRoot); + if (!cliPath) { + return { + ok: false, + error: `signal-cli binary not found after extracting ${asset.name}`, + }; + } + + await fs.chmod(cliPath, 0o755).catch(() => {}); + + return { ok: true, cliPath, version }; +} + +// --------------------------------------------------------------------------- +// Public entry point +// --------------------------------------------------------------------------- + +export async function installSignalCli(runtime: RuntimeEnv): Promise { + if (process.platform === "win32") { + return { + ok: false, + error: "Signal CLI auto-install is not supported on Windows yet.", + }; + } + + // The official signal-cli GitHub releases only ship a native binary for + // x86-64 Linux. On other architectures (arm64, armv7, etc.) we delegate + // to Homebrew which builds from source and bundles the JRE automatically. + const hasNativeRelease = process.platform !== "linux" || process.arch === "x64"; + + if (hasNativeRelease) { + return installSignalCliFromRelease(runtime); + } + + return installSignalCliViaBrew(runtime); +} From 7f042758b05ce3b4946a128f4d3b1a717515ac56 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:12:23 -0700 Subject: [PATCH 024/187] Sandbox: decouple built-in channel ids --- src/agents/sandbox/constants.ts | 2 +- src/channels/ids.ts | 18 ++++++++++++++++++ src/channels/registry.ts | 21 +++------------------ 3 files changed, 22 insertions(+), 19 deletions(-) create mode 100644 src/channels/ids.ts diff --git a/src/agents/sandbox/constants.ts b/src/agents/sandbox/constants.ts index 8e906eb9432..80915b3bfce 100644 --- a/src/agents/sandbox/constants.ts +++ b/src/agents/sandbox/constants.ts @@ -1,5 +1,5 @@ import path from "node:path"; -import { CHANNEL_IDS } from "../../channels/registry.js"; +import { CHANNEL_IDS } from "../../channels/ids.js"; import { STATE_DIR } from "../../config/paths.js"; export const DEFAULT_SANDBOX_WORKSPACE_ROOT = path.join(STATE_DIR, "sandboxes"); diff --git a/src/channels/ids.ts b/src/channels/ids.ts new file mode 100644 index 00000000000..cddfe667250 --- /dev/null +++ b/src/channels/ids.ts @@ -0,0 +1,18 @@ +// Keep built-in channel IDs in a leaf module so shared config/sandbox code can +// reference them without importing channel registry helpers that may pull in +// plugin runtime state. +export const CHAT_CHANNEL_ORDER = [ + "telegram", + "whatsapp", + "discord", + "irc", + "googlechat", + "slack", + "signal", + "imessage", + "line", +] as const; + +export type ChatChannelId = (typeof CHAT_CHANNEL_ORDER)[number]; + +export const CHANNEL_IDS = [...CHAT_CHANNEL_ORDER] as const; diff --git a/src/channels/registry.ts b/src/channels/registry.ts index 16ba6514397..5e552e04a0e 100644 --- a/src/channels/registry.ts +++ b/src/channels/registry.ts @@ -1,24 +1,9 @@ import { requireActivePluginRegistry } from "../plugins/runtime.js"; +import { CHANNEL_IDS, CHAT_CHANNEL_ORDER, type ChatChannelId } from "./ids.js"; import type { ChannelMeta } from "./plugins/types.js"; import type { ChannelId } from "./plugins/types.js"; - -// Channel docking: add new core channels here (order + meta + aliases), then -// register the plugin in its extension entrypoint and keep protocol IDs in sync. -export const CHAT_CHANNEL_ORDER = [ - "telegram", - "whatsapp", - "discord", - "irc", - "googlechat", - "slack", - "signal", - "imessage", - "line", -] as const; - -export type ChatChannelId = (typeof CHAT_CHANNEL_ORDER)[number]; - -export const CHANNEL_IDS = [...CHAT_CHANNEL_ORDER] as const; +export { CHANNEL_IDS, CHAT_CHANNEL_ORDER } from "./ids.js"; +export type { ChatChannelId } from "./ids.js"; export type ChatChannelMeta = ChannelMeta; From d20363bcc9749f371e82e7646957e0d5ae925e60 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:17:07 +0000 Subject: [PATCH 025/187] refactor(channels): remove dead shared plugin duplicates --- extensions/slack/src/plugin-shared.ts | 53 ------------------- extensions/telegram/src/plugin-shared.ts | 65 ------------------------ 2 files changed, 118 deletions(-) delete mode 100644 extensions/slack/src/plugin-shared.ts delete mode 100644 extensions/telegram/src/plugin-shared.ts diff --git a/extensions/slack/src/plugin-shared.ts b/extensions/slack/src/plugin-shared.ts deleted file mode 100644 index 0a5eb6ea3ec..00000000000 --- a/extensions/slack/src/plugin-shared.ts +++ /dev/null @@ -1,53 +0,0 @@ -import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; -import { - createScopedAccountConfigAccessors, - createScopedChannelConfigBase, -} from "openclaw/plugin-sdk/channel-config-helpers"; -import type { OpenClawConfig } from "openclaw/plugin-sdk/slack"; -import { inspectSlackAccount } from "./account-inspect.js"; -import { - listSlackAccountIds, - resolveDefaultSlackAccountId, - resolveSlackAccount, - type ResolvedSlackAccount, -} from "./accounts.js"; -import { createSlackSetupWizardProxy } from "./setup-core.js"; - -async function loadSlackChannelRuntime() { - return await import("./channel.runtime.js"); -} - -export function isSlackAccountConfigured(account: ResolvedSlackAccount): boolean { - const mode = account.config.mode ?? "socket"; - const hasBotToken = Boolean(account.botToken?.trim()); - if (!hasBotToken) { - return false; - } - if (mode === "http") { - return Boolean(account.config.signingSecret?.trim()); - } - return Boolean(account.appToken?.trim()); -} - -export const isSlackPluginAccountConfigured = isSlackAccountConfigured; - -export const slackConfigAccessors = createScopedAccountConfigAccessors({ - resolveAccount: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId?: string | null }) => - resolveSlackAccount({ cfg, accountId }), - resolveAllowFrom: (account: ResolvedSlackAccount) => account.dm?.allowFrom, - formatAllowFrom: (allowFrom) => formatAllowFromLowercase({ allowFrom }), - resolveDefaultTo: (account: ResolvedSlackAccount) => account.config.defaultTo, -}); - -export const slackConfigBase = createScopedChannelConfigBase({ - sectionKey: "slack", - listAccountIds: listSlackAccountIds, - resolveAccount: (cfg, accountId) => resolveSlackAccount({ cfg, accountId }), - inspectAccount: (cfg, accountId) => inspectSlackAccount({ cfg, accountId }), - defaultAccountId: resolveDefaultSlackAccountId, - clearBaseFields: ["botToken", "appToken", "name"], -}); - -export const slackSetupWizard = createSlackSetupWizardProxy(async () => ({ - slackSetupWizard: (await loadSlackChannelRuntime()).slackSetupWizard, -})); diff --git a/extensions/telegram/src/plugin-shared.ts b/extensions/telegram/src/plugin-shared.ts deleted file mode 100644 index 12562f0da61..00000000000 --- a/extensions/telegram/src/plugin-shared.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; -import { - createScopedAccountConfigAccessors, - createScopedChannelConfigBase, -} from "openclaw/plugin-sdk/channel-config-helpers"; -import { normalizeAccountId, type OpenClawConfig } from "openclaw/plugin-sdk/telegram"; -import { inspectTelegramAccount } from "./account-inspect.js"; -import { - listTelegramAccountIds, - resolveDefaultTelegramAccountId, - resolveTelegramAccount, - type ResolvedTelegramAccount, -} from "./accounts.js"; - -export function findTelegramTokenOwnerAccountId(params: { - cfg: OpenClawConfig; - accountId: string; -}): string | null { - const normalizedAccountId = normalizeAccountId(params.accountId); - const tokenOwners = new Map(); - for (const id of listTelegramAccountIds(params.cfg)) { - const account = inspectTelegramAccount({ cfg: params.cfg, accountId: id }); - const token = (account.token ?? "").trim(); - if (!token) { - continue; - } - const ownerAccountId = tokenOwners.get(token); - if (!ownerAccountId) { - tokenOwners.set(token, account.accountId); - continue; - } - if (account.accountId === normalizedAccountId) { - return ownerAccountId; - } - } - return null; -} - -export function formatDuplicateTelegramTokenReason(params: { - accountId: string; - ownerAccountId: string; -}): string { - return ( - `Duplicate Telegram bot token: account "${params.accountId}" shares a token with ` + - `account "${params.ownerAccountId}". Keep one owner account per bot token.` - ); -} - -export const telegramConfigAccessors = createScopedAccountConfigAccessors({ - resolveAccount: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId?: string | null }) => - resolveTelegramAccount({ cfg, accountId }), - resolveAllowFrom: (account: ResolvedTelegramAccount) => account.config.allowFrom, - formatAllowFrom: (allowFrom) => - formatAllowFromLowercase({ allowFrom, stripPrefixRe: /^(telegram|tg):/i }), - resolveDefaultTo: (account: ResolvedTelegramAccount) => account.config.defaultTo, -}); - -export const telegramConfigBase = createScopedChannelConfigBase({ - sectionKey: "telegram", - listAccountIds: listTelegramAccountIds, - resolveAccount: (cfg, accountId) => resolveTelegramAccount({ cfg, accountId }), - inspectAccount: (cfg, accountId) => inspectTelegramAccount({ cfg, accountId }), - defaultAccountId: resolveDefaultTelegramAccountId, - clearBaseFields: ["botToken", "tokenFile", "name"], -}); From dd85ff4da75a5f047a2fa85ff8ac4b1178a42fe0 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:18:35 +0000 Subject: [PATCH 026/187] refactor(tlon): share setup wizard base --- extensions/tlon/src/channel.ts | 100 ++++------------------- extensions/tlon/src/setup-core.ts | 116 ++++++++++++++++++++++++++- extensions/tlon/src/setup-surface.ts | 103 +++--------------------- 3 files changed, 144 insertions(+), 175 deletions(-) diff --git a/extensions/tlon/src/channel.ts b/extensions/tlon/src/channel.ts index 4442279a727..fa7c702354d 100644 --- a/extensions/tlon/src/channel.ts +++ b/extensions/tlon/src/channel.ts @@ -1,7 +1,11 @@ import type { ChannelPlugin, OpenClawConfig } from "openclaw/plugin-sdk/tlon"; import { tlonChannelConfigSchema } from "./config-schema.js"; -import { tlonSetupAdapter } from "./setup-core.js"; -import { applyTlonSetupConfig } from "./setup-core.js"; +import { + applyTlonSetupConfig, + createTlonSetupWizardBase, + resolveTlonSetupConfigured, + tlonSetupAdapter, +} from "./setup-core.js"; import { formatTargetHint, normalizeShip, parseTlonTarget } from "./targets.js"; import { resolveTlonAccount, listTlonAccountIds } from "./types.js"; import { validateUrbitBaseUrl } from "./urbit/base-url.js"; @@ -15,91 +19,21 @@ async function loadTlonChannelRuntime() { return tlonChannelRuntimePromise; } -const tlonSetupWizardProxy = { - channel: "tlon", - status: { - configuredLabel: "configured", - unconfiguredLabel: "needs setup", - configuredHint: "configured", - unconfiguredHint: "urbit messenger", - configuredScore: 1, - unconfiguredScore: 4, - resolveConfigured: async ({ cfg }) => - await (await loadTlonChannelRuntime()).tlonSetupWizard.status.resolveConfigured({ cfg }), - resolveStatusLines: async ({ cfg, configured }) => - (await ( - await loadTlonChannelRuntime() - ).tlonSetupWizard.status.resolveStatusLines?.({ - cfg, - configured, - })) ?? [], - }, - introNote: { - title: "Tlon setup", - lines: [ - "You need your Urbit ship URL and login code.", - "Example URL: https://your-ship-host", - "Example ship: ~sampel-palnet", - "If your ship URL is on a private network (LAN/localhost), you must explicitly allow it during setup.", - "Docs: https://docs.openclaw.ai/channels/tlon", - ], - }, - credentials: [], - textInputs: [ - { - inputKey: "ship", - message: "Ship name", - placeholder: "~sampel-palnet", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).ship ?? undefined, - validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), - normalizeValue: ({ value }) => normalizeShip(String(value).trim()), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { ship: value }, - }), - }, - { - inputKey: "url", - message: "Ship URL", - placeholder: "https://your-ship-host", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).url ?? undefined, - validate: ({ value }) => { - const next = validateUrbitBaseUrl(String(value ?? "")); - if (!next.ok) { - return next.error; - } - return undefined; - }, - normalizeValue: ({ value }) => String(value).trim(), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { url: value }, - }), - }, - { - inputKey: "code", - message: "Login code", - placeholder: "lidlut-tabwed-pillex-ridrup", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).code ?? undefined, - validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), - normalizeValue: ({ value }) => String(value).trim(), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { code: value }, - }), - }, - ], +const tlonSetupWizardProxy = createTlonSetupWizardBase({ + resolveConfigured: async ({ cfg }) => + await (await loadTlonChannelRuntime()).tlonSetupWizard.status.resolveConfigured({ cfg }), + resolveStatusLines: async ({ cfg, configured }) => + (await ( + await loadTlonChannelRuntime() + ).tlonSetupWizard.status.resolveStatusLines?.({ + cfg, + configured, + })) ?? [], finalize: async (params) => await ( await loadTlonChannelRuntime() ).tlonSetupWizard.finalize!(params), -} satisfies NonNullable; +}) satisfies NonNullable; export const tlonPlugin: ChannelPlugin = { id: TLON_CHANNEL_ID, diff --git a/extensions/tlon/src/setup-core.ts b/extensions/tlon/src/setup-core.ts index 846af4f08a3..8d54e37444a 100644 --- a/extensions/tlon/src/setup-core.ts +++ b/extensions/tlon/src/setup-core.ts @@ -1,14 +1,19 @@ import { DEFAULT_ACCOUNT_ID, + formatDocsLink, normalizeAccountId, patchScopedAccountConfig, prepareScopedSetupConfig, type ChannelSetupAdapter, type ChannelSetupInput, + type ChannelSetupWizard, type OpenClawConfig, + type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import { buildTlonAccountFields } from "./account-fields.js"; -import { resolveTlonAccount } from "./types.js"; +import { normalizeShip } from "./targets.js"; +import { listTlonAccountIds, resolveTlonAccount, type TlonResolvedAccount } from "./types.js"; +import { validateUrbitBaseUrl } from "./urbit/base-url.js"; const channel = "tlon" as const; @@ -23,6 +28,115 @@ export type TlonSetupInput = ChannelSetupInput & { ownerShip?: string; }; +function isConfigured(account: TlonResolvedAccount): boolean { + return Boolean(account.ship && account.url && account.code); +} + +type TlonSetupWizardBaseParams = { + resolveConfigured: (params: { cfg: OpenClawConfig }) => boolean | Promise; + resolveStatusLines?: (params: { + cfg: OpenClawConfig; + configured: boolean; + }) => string[] | Promise; + finalize: (params: { + cfg: OpenClawConfig; + accountId: string; + prompter: WizardPrompter; + options?: Record; + }) => Promise<{ cfg: OpenClawConfig }>; +}; + +export function createTlonSetupWizardBase(params: TlonSetupWizardBaseParams): ChannelSetupWizard { + return { + channel, + status: { + configuredLabel: "configured", + unconfiguredLabel: "needs setup", + configuredHint: "configured", + unconfiguredHint: "urbit messenger", + configuredScore: 1, + unconfiguredScore: 4, + resolveConfigured: ({ cfg }) => params.resolveConfigured({ cfg }), + resolveStatusLines: ({ cfg, configured }) => + params.resolveStatusLines?.({ cfg, configured }) ?? [], + }, + introNote: { + title: "Tlon setup", + lines: [ + "You need your Urbit ship URL and login code.", + "Example URL: https://your-ship-host", + "Example ship: ~sampel-palnet", + "If your ship URL is on a private network (LAN/localhost), you must explicitly allow it during setup.", + `Docs: ${formatDocsLink("/channels/tlon", "channels/tlon")}`, + ], + }, + credentials: [], + textInputs: [ + { + inputKey: "ship", + message: "Ship name", + placeholder: "~sampel-palnet", + currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).ship ?? undefined, + validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), + normalizeValue: ({ value }) => normalizeShip(String(value).trim()), + applySet: async ({ cfg, accountId, value }) => + applyTlonSetupConfig({ + cfg, + accountId, + input: { ship: value }, + }), + }, + { + inputKey: "url", + message: "Ship URL", + placeholder: "https://your-ship-host", + currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).url ?? undefined, + validate: ({ value }) => { + const next = validateUrbitBaseUrl(String(value ?? "")); + if (!next.ok) { + return next.error; + } + return undefined; + }, + normalizeValue: ({ value }) => String(value).trim(), + applySet: async ({ cfg, accountId, value }) => + applyTlonSetupConfig({ + cfg, + accountId, + input: { url: value }, + }), + }, + { + inputKey: "code", + message: "Login code", + placeholder: "lidlut-tabwed-pillex-ridrup", + currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).code ?? undefined, + validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), + normalizeValue: ({ value }) => String(value).trim(), + applySet: async ({ cfg, accountId, value }) => + applyTlonSetupConfig({ + cfg, + accountId, + input: { code: value }, + }), + }, + ], + finalize: params.finalize, + }; +} + +export async function resolveTlonSetupConfigured(cfg: OpenClawConfig): Promise { + const accountIds = listTlonAccountIds(cfg); + return accountIds.length > 0 + ? accountIds.some((accountId) => isConfigured(resolveTlonAccount(cfg, accountId))) + : isConfigured(resolveTlonAccount(cfg, DEFAULT_ACCOUNT_ID)); +} + +export async function resolveTlonSetupStatusLines(cfg: OpenClawConfig): Promise { + const configured = await resolveTlonSetupConfigured(cfg); + return [`Tlon: ${configured ? "configured" : "needs setup"}`]; +} + export function applyTlonSetupConfig(params: { cfg: OpenClawConfig; accountId: string; diff --git a/extensions/tlon/src/setup-surface.ts b/extensions/tlon/src/setup-surface.ts index e3c1b43f0c1..bf4ce6fbf2e 100644 --- a/extensions/tlon/src/setup-surface.ts +++ b/extensions/tlon/src/setup-surface.ts @@ -1,9 +1,12 @@ +import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/setup"; import { - DEFAULT_ACCOUNT_ID, - formatDocsLink, - type ChannelSetupWizard, -} from "openclaw/plugin-sdk/setup"; -import { applyTlonSetupConfig, type TlonSetupInput, tlonSetupAdapter } from "./setup-core.js"; + applyTlonSetupConfig, + createTlonSetupWizardBase, + resolveTlonSetupConfigured, + resolveTlonSetupStatusLines, + type TlonSetupInput, + tlonSetupAdapter, +} from "./setup-core.js"; import { normalizeShip } from "./targets.js"; import { listTlonAccountIds, resolveTlonAccount, type TlonResolvedAccount } from "./types.js"; import { isBlockedUrbitHostname, validateUrbitBaseUrl } from "./urbit/base-url.js"; @@ -23,91 +26,9 @@ function parseList(value: string): string[] { export { tlonSetupAdapter } from "./setup-core.js"; -export const tlonSetupWizard: ChannelSetupWizard = { - channel, - status: { - configuredLabel: "configured", - unconfiguredLabel: "needs setup", - configuredHint: "configured", - unconfiguredHint: "urbit messenger", - configuredScore: 1, - unconfiguredScore: 4, - resolveConfigured: ({ cfg }) => { - const accountIds = listTlonAccountIds(cfg); - return accountIds.length > 0 - ? accountIds.some((accountId) => isConfigured(resolveTlonAccount(cfg, accountId))) - : isConfigured(resolveTlonAccount(cfg, DEFAULT_ACCOUNT_ID)); - }, - resolveStatusLines: ({ cfg }) => { - const accountIds = listTlonAccountIds(cfg); - const configured = - accountIds.length > 0 - ? accountIds.some((accountId) => isConfigured(resolveTlonAccount(cfg, accountId))) - : isConfigured(resolveTlonAccount(cfg, DEFAULT_ACCOUNT_ID)); - return [`Tlon: ${configured ? "configured" : "needs setup"}`]; - }, - }, - introNote: { - title: "Tlon setup", - lines: [ - "You need your Urbit ship URL and login code.", - "Example URL: https://your-ship-host", - "Example ship: ~sampel-palnet", - "If your ship URL is on a private network (LAN/localhost), you must explicitly allow it during setup.", - `Docs: ${formatDocsLink("/channels/tlon", "channels/tlon")}`, - ], - }, - credentials: [], - textInputs: [ - { - inputKey: "ship", - message: "Ship name", - placeholder: "~sampel-palnet", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).ship ?? undefined, - validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), - normalizeValue: ({ value }) => normalizeShip(String(value).trim()), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { ship: value }, - }), - }, - { - inputKey: "url", - message: "Ship URL", - placeholder: "https://your-ship-host", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).url ?? undefined, - validate: ({ value }) => { - const next = validateUrbitBaseUrl(String(value ?? "")); - if (!next.ok) { - return next.error; - } - return undefined; - }, - normalizeValue: ({ value }) => String(value).trim(), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { url: value }, - }), - }, - { - inputKey: "code", - message: "Login code", - placeholder: "lidlut-tabwed-pillex-ridrup", - currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).code ?? undefined, - validate: ({ value }) => (String(value ?? "").trim() ? undefined : "Required"), - normalizeValue: ({ value }) => String(value).trim(), - applySet: async ({ cfg, accountId, value }) => - applyTlonSetupConfig({ - cfg, - accountId, - input: { code: value }, - }), - }, - ], +export const tlonSetupWizard = createTlonSetupWizardBase({ + resolveConfigured: async ({ cfg }) => await resolveTlonSetupConfigured(cfg), + resolveStatusLines: async ({ cfg }) => await resolveTlonSetupStatusLines(cfg), finalize: async ({ cfg, accountId, prompter }) => { let next = cfg; const resolved = resolveTlonAccount(next, accountId); @@ -183,4 +104,4 @@ export const tlonSetupWizard: ChannelSetupWizard = { return { cfg: next }; }, -}; +}); From ed06d21013f2128639a32bbf1b9d345877177a37 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:20:13 +0000 Subject: [PATCH 027/187] refactor(providers): share template model cloning --- extensions/google/provider-models.ts | 28 +---------- extensions/openai/shared.ts | 50 ++----------------- src/plugins/provider-model-helpers.test.ts | 56 ++++++++++++++++++++++ src/plugins/provider-model-helpers.ts | 28 +++++++++++ 4 files changed, 90 insertions(+), 72 deletions(-) create mode 100644 src/plugins/provider-model-helpers.test.ts create mode 100644 src/plugins/provider-model-helpers.ts diff --git a/extensions/google/provider-models.ts b/extensions/google/provider-models.ts index eddda4a9f9a..ddb0446c2b9 100644 --- a/extensions/google/provider-models.ts +++ b/extensions/google/provider-models.ts @@ -1,39 +1,14 @@ +import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; const GEMINI_3_1_PRO_PREFIX = "gemini-3.1-pro"; const GEMINI_3_1_FLASH_PREFIX = "gemini-3.1-flash"; const GEMINI_3_1_PRO_TEMPLATE_IDS = ["gemini-3-pro-preview"] as const; const GEMINI_3_1_FLASH_TEMPLATE_IDS = ["gemini-3-flash-preview"] as const; -function cloneFirstTemplateModel(params: { - providerId: string; - modelId: string; - templateIds: readonly string[]; - ctx: ProviderResolveDynamicModelContext; -}): ProviderRuntimeModel | undefined { - const trimmedModelId = params.modelId.trim(); - for (const templateId of [...new Set(params.templateIds)].filter(Boolean)) { - const template = params.ctx.modelRegistry.find( - params.providerId, - templateId, - ) as ProviderRuntimeModel | null; - if (!template) { - continue; - } - return normalizeModelCompat({ - ...template, - id: trimmedModelId, - name: trimmedModelId, - reasoning: true, - } as ProviderRuntimeModel); - } - return undefined; -} - export function resolveGoogle31ForwardCompatModel(params: { providerId: string; ctx: ProviderResolveDynamicModelContext; @@ -55,6 +30,7 @@ export function resolveGoogle31ForwardCompatModel(params: { modelId: trimmed, templateIds, ctx: params.ctx, + patch: { reasoning: true }, }); } diff --git a/extensions/openai/shared.ts b/extensions/openai/shared.ts index 2b67454fc07..673a6bdeb24 100644 --- a/extensions/openai/shared.ts +++ b/extensions/openai/shared.ts @@ -1,8 +1,5 @@ -import type { - ProviderResolveDynamicModelContext, - ProviderRuntimeModel, -} from "openclaw/plugin-sdk/core"; -import { normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; +import { findCatalogTemplate } from "../../src/plugins/provider-catalog.js"; +import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; export const OPENAI_API_BASE_URL = "https://api.openai.com/v1"; @@ -22,44 +19,5 @@ export function isOpenAIApiBaseUrl(baseUrl?: string): boolean { return /^https?:\/\/api\.openai\.com(?:\/v1)?\/?$/i.test(trimmed); } -export function cloneFirstTemplateModel(params: { - providerId: string; - modelId: string; - templateIds: readonly string[]; - ctx: ProviderResolveDynamicModelContext; - patch?: Partial; -}): ProviderRuntimeModel | undefined { - const trimmedModelId = params.modelId.trim(); - for (const templateId of [...new Set(params.templateIds)].filter(Boolean)) { - const template = params.ctx.modelRegistry.find( - params.providerId, - templateId, - ) as ProviderRuntimeModel | null; - if (!template) { - continue; - } - return normalizeModelCompat({ - ...template, - id: trimmedModelId, - name: trimmedModelId, - ...params.patch, - } as ProviderRuntimeModel); - } - return undefined; -} - -export function findCatalogTemplate(params: { - entries: ReadonlyArray<{ provider: string; id: string }>; - providerId: string; - templateIds: readonly string[]; -}) { - return params.templateIds - .map((templateId) => - params.entries.find( - (entry) => - entry.provider.toLowerCase() === params.providerId.toLowerCase() && - entry.id.toLowerCase() === templateId.toLowerCase(), - ), - ) - .find((entry) => entry !== undefined); -} +export { cloneFirstTemplateModel }; +export { findCatalogTemplate }; diff --git a/src/plugins/provider-model-helpers.test.ts b/src/plugins/provider-model-helpers.test.ts new file mode 100644 index 00000000000..905195775fe --- /dev/null +++ b/src/plugins/provider-model-helpers.test.ts @@ -0,0 +1,56 @@ +import type { ModelRegistry } from "@mariozechner/pi-coding-agent"; +import { describe, expect, it } from "vitest"; +import { cloneFirstTemplateModel } from "./provider-model-helpers.js"; +import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel } from "./types.js"; + +function createContext(models: ProviderRuntimeModel[]): ProviderResolveDynamicModelContext { + return { + provider: "test-provider", + modelId: "next-model", + modelRegistry: { + find(providerId: string, modelId: string) { + return ( + models.find((model) => model.provider === providerId && model.id === modelId) ?? null + ); + }, + } as ModelRegistry, + }; +} + +describe("cloneFirstTemplateModel", () => { + it("clones the first matching template and applies patches", () => { + const model = cloneFirstTemplateModel({ + providerId: "test-provider", + modelId: " next-model ", + templateIds: ["missing", "template-a", "template-b"], + ctx: createContext([ + { + id: "template-a", + name: "Template A", + provider: "test-provider", + api: "openai-completions", + } as ProviderRuntimeModel, + ]), + patch: { reasoning: true }, + }); + + expect(model).toMatchObject({ + id: "next-model", + name: "next-model", + provider: "test-provider", + api: "openai-completions", + reasoning: true, + }); + }); + + it("returns undefined when no template exists", () => { + const model = cloneFirstTemplateModel({ + providerId: "test-provider", + modelId: "next-model", + templateIds: ["missing"], + ctx: createContext([]), + }); + + expect(model).toBeUndefined(); + }); +}); diff --git a/src/plugins/provider-model-helpers.ts b/src/plugins/provider-model-helpers.ts new file mode 100644 index 00000000000..8ffd8d18be7 --- /dev/null +++ b/src/plugins/provider-model-helpers.ts @@ -0,0 +1,28 @@ +import { normalizeModelCompat } from "../agents/model-compat.js"; +import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel } from "./types.js"; + +export function cloneFirstTemplateModel(params: { + providerId: string; + modelId: string; + templateIds: readonly string[]; + ctx: ProviderResolveDynamicModelContext; + patch?: Partial; +}): ProviderRuntimeModel | undefined { + const trimmedModelId = params.modelId.trim(); + for (const templateId of [...new Set(params.templateIds)].filter(Boolean)) { + const template = params.ctx.modelRegistry.find( + params.providerId, + templateId, + ) as ProviderRuntimeModel | null; + if (!template) { + continue; + } + return normalizeModelCompat({ + ...template, + id: trimmedModelId, + name: trimmedModelId, + ...params.patch, + } as ProviderRuntimeModel); + } + return undefined; +} From 966b8656d2d497fa35b0c2e2d7cad128cd0b7e67 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:21:19 +0000 Subject: [PATCH 028/187] refactor(tlon): share outbound target resolution --- extensions/tlon/src/channel.runtime.ts | 21 +++++++------------- extensions/tlon/src/channel.ts | 21 +++++++------------- extensions/tlon/src/targets.test.ts | 27 ++++++++++++++++++++++++++ extensions/tlon/src/targets.ts | 14 +++++++++++++ 4 files changed, 55 insertions(+), 28 deletions(-) create mode 100644 extensions/tlon/src/targets.test.ts diff --git a/extensions/tlon/src/channel.runtime.ts b/extensions/tlon/src/channel.runtime.ts index f9f11e4620c..525359a2a4e 100644 --- a/extensions/tlon/src/channel.runtime.ts +++ b/extensions/tlon/src/channel.runtime.ts @@ -7,7 +7,12 @@ import type { } from "openclaw/plugin-sdk/tlon"; import { monitorTlonProvider } from "./monitor/index.js"; import { tlonSetupWizard } from "./setup-surface.js"; -import { formatTargetHint, normalizeShip, parseTlonTarget } from "./targets.js"; +import { + formatTargetHint, + normalizeShip, + parseTlonTarget, + resolveTlonOutboundTarget, +} from "./targets.js"; import { resolveTlonAccount } from "./types.js"; import { authenticate } from "./urbit/auth.js"; import { ssrfPolicyFromAllowPrivateNetwork } from "./urbit/context.js"; @@ -131,19 +136,7 @@ async function withHttpPokeAccountApi( export const tlonRuntimeOutbound: ChannelOutboundAdapter = { deliveryMode: "direct", textChunkLimit: 10000, - resolveTarget: ({ to }) => { - const parsed = parseTlonTarget(to ?? ""); - if (!parsed) { - return { - ok: false, - error: new Error(`Invalid Tlon target. Use ${formatTargetHint()}`), - }; - } - if (parsed.kind === "dm") { - return { ok: true, to: parsed.ship }; - } - return { ok: true, to: parsed.nest }; - }, + resolveTarget: ({ to }) => resolveTlonOutboundTarget(to), sendText: async ({ cfg, to, text, accountId, replyToId, threadId }) => { const { account, parsed } = resolveOutboundContext({ cfg, accountId, to }); return withHttpPokeAccountApi(account, async (api) => { diff --git a/extensions/tlon/src/channel.ts b/extensions/tlon/src/channel.ts index fa7c702354d..5f754201ac1 100644 --- a/extensions/tlon/src/channel.ts +++ b/extensions/tlon/src/channel.ts @@ -6,7 +6,12 @@ import { resolveTlonSetupConfigured, tlonSetupAdapter, } from "./setup-core.js"; -import { formatTargetHint, normalizeShip, parseTlonTarget } from "./targets.js"; +import { + formatTargetHint, + normalizeShip, + parseTlonTarget, + resolveTlonOutboundTarget, +} from "./targets.js"; import { resolveTlonAccount, listTlonAccountIds } from "./types.js"; import { validateUrbitBaseUrl } from "./urbit/base-url.js"; @@ -151,19 +156,7 @@ export const tlonPlugin: ChannelPlugin = { outbound: { deliveryMode: "direct", textChunkLimit: 10000, - resolveTarget: ({ to }) => { - const parsed = parseTlonTarget(to ?? ""); - if (!parsed) { - return { - ok: false, - error: new Error(`Invalid Tlon target. Use ${formatTargetHint()}`), - }; - } - if (parsed.kind === "dm") { - return { ok: true, to: parsed.ship }; - } - return { ok: true, to: parsed.nest }; - }, + resolveTarget: ({ to }) => resolveTlonOutboundTarget(to), sendText: async (params) => await ( await loadTlonChannelRuntime() diff --git a/extensions/tlon/src/targets.test.ts b/extensions/tlon/src/targets.test.ts new file mode 100644 index 00000000000..3ac4d010f38 --- /dev/null +++ b/extensions/tlon/src/targets.test.ts @@ -0,0 +1,27 @@ +import { describe, expect, it } from "vitest"; +import { resolveTlonOutboundTarget } from "./targets.js"; + +describe("resolveTlonOutboundTarget", () => { + it("resolves dm targets to normalized ships", () => { + expect(resolveTlonOutboundTarget("dm/sampel-palnet")).toEqual({ + ok: true, + to: "~sampel-palnet", + }); + }); + + it("resolves group targets to canonical chat nests", () => { + expect(resolveTlonOutboundTarget("group:host-ship/general")).toEqual({ + ok: true, + to: "chat/~host-ship/general", + }); + }); + + it("returns a helpful error for invalid targets", () => { + const resolved = resolveTlonOutboundTarget("group:bad-target"); + expect(resolved.ok).toBe(false); + if (resolved.ok) { + throw new Error("expected invalid target"); + } + expect(resolved.error.message).toMatch(/invalid tlon target/i); + }); +}); diff --git a/extensions/tlon/src/targets.ts b/extensions/tlon/src/targets.ts index bacc6d576c0..b8aa17e5e8c 100644 --- a/extensions/tlon/src/targets.ts +++ b/extensions/tlon/src/targets.ts @@ -84,6 +84,20 @@ export function parseTlonTarget(raw?: string | null): TlonTarget | null { return null; } +export function resolveTlonOutboundTarget(to?: string | null) { + const parsed = parseTlonTarget(to ?? ""); + if (!parsed) { + return { + ok: false as const, + error: new Error(`Invalid Tlon target. Use ${formatTargetHint()}`), + }; + } + if (parsed.kind === "dm") { + return { ok: true as const, to: parsed.ship }; + } + return { ok: true as const, to: parsed.nest }; +} + export function formatTargetHint(): string { return "dm/~sampel-palnet | ~sampel-palnet | chat/~host-ship/channel | group:~host-ship/channel"; } From 10660fe47dc0222a247058b355d4a201e69f4c28 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:24:01 +0000 Subject: [PATCH 029/187] refactor(channels): share legacy dm allowlist paths --- extensions/discord/src/channel.ts | 14 +++++--------- extensions/slack/src/channel.ts | 14 +++++--------- src/plugin-sdk/allowlist-config-edit.ts | 10 ++++++++++ src/plugin-sdk/index.ts | 5 ++++- 4 files changed, 24 insertions(+), 19 deletions(-) diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index d12813e66a6..a9db3a7937f 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -1,5 +1,8 @@ import { Separator, TextDisplay } from "@buape/carbon"; -import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; +import { + buildAccountScopedAllowlistConfigEditor, + resolveLegacyDmAllowlistConfigPaths, +} from "openclaw/plugin-sdk/allowlist-config-edit"; import { buildAccountScopedDmSecurityPolicy, collectOpenGroupPolicyConfiguredRouteWarnings, @@ -347,14 +350,7 @@ export const discordPlugin: ChannelPlugin = { channelId: "discord", normalize: ({ cfg, accountId, values }) => discordConfigAccessors.formatAllowFrom!({ cfg, accountId, allowFrom: values }), - resolvePaths: (scope) => - scope === "dm" - ? { - readPaths: [["allowFrom"], ["dm", "allowFrom"]], - writePath: ["allowFrom"], - cleanupPaths: [["dm", "allowFrom"]], - } - : null, + resolvePaths: resolveLegacyDmAllowlistConfigPaths, }), }, security: { diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 3dfb195be86..4890ab88eaa 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -1,4 +1,7 @@ -import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; +import { + buildAccountScopedAllowlistConfigEditor, + resolveLegacyDmAllowlistConfigPaths, +} from "openclaw/plugin-sdk/allowlist-config-edit"; import { buildAccountScopedDmSecurityPolicy, collectOpenGroupPolicyConfiguredRouteWarnings, @@ -410,14 +413,7 @@ export const slackPlugin: ChannelPlugin = { channelId: "slack", normalize: ({ cfg, accountId, values }) => slackConfigAccessors.formatAllowFrom!({ cfg, accountId, allowFrom: values }), - resolvePaths: (scope) => - scope === "dm" - ? { - readPaths: [["allowFrom"], ["dm", "allowFrom"]], - writePath: ["allowFrom"], - cleanupPaths: [["dm", "allowFrom"]], - } - : null, + resolvePaths: resolveLegacyDmAllowlistConfigPaths, }), }, security: { diff --git a/src/plugin-sdk/allowlist-config-edit.ts b/src/plugin-sdk/allowlist-config-edit.ts index c9f2a92e3be..e92e4cb8551 100644 --- a/src/plugin-sdk/allowlist-config-edit.ts +++ b/src/plugin-sdk/allowlist-config-edit.ts @@ -11,6 +11,16 @@ type AllowlistConfigPaths = { cleanupPaths?: string[][]; }; +const LEGACY_DM_ALLOWLIST_CONFIG_PATHS: AllowlistConfigPaths = { + readPaths: [["allowFrom"], ["dm", "allowFrom"]], + writePath: ["allowFrom"], + cleanupPaths: [["dm", "allowFrom"]], +}; + +export function resolveLegacyDmAllowlistConfigPaths(scope: "dm" | "group") { + return scope === "dm" ? LEGACY_DM_ALLOWLIST_CONFIG_PATHS : null; +} + function resolveAccountScopedWriteTarget( parsed: Record, channelId: ChannelId, diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index 50949a31a89..acfca49d6ab 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -270,7 +270,10 @@ export { buildChannelSendResult } from "./channel-send-result.js"; export type { ChannelSendRawResult } from "./channel-send-result.js"; export { createPluginRuntimeStore } from "./runtime-store.js"; export { createScopedChannelConfigBase } from "./channel-config-helpers.js"; -export { buildAccountScopedAllowlistConfigEditor } from "./allowlist-config-edit.js"; +export { + buildAccountScopedAllowlistConfigEditor, + resolveLegacyDmAllowlistConfigPaths, +} from "./allowlist-config-edit.js"; export { AllowFromEntrySchema, AllowFromListSchema, From b0dd757ec8a4ae90815a54bd963aaf0f7465e98b Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:28:42 +0000 Subject: [PATCH 030/187] refactor(discord): share monitor provider test harness --- .../src/monitor/provider.registry.test.ts | 340 +------------- .../src/monitor/provider.test-support.ts | 426 ++++++++++++++++++ .../discord/src/monitor/provider.test.ts | 394 +--------------- 3 files changed, 454 insertions(+), 706 deletions(-) create mode 100644 extensions/discord/src/monitor/provider.test-support.ts diff --git a/extensions/discord/src/monitor/provider.registry.test.ts b/extensions/discord/src/monitor/provider.registry.test.ts index bffe979973b..2187c851f69 100644 --- a/extensions/discord/src/monitor/provider.registry.test.ts +++ b/extensions/discord/src/monitor/provider.registry.test.ts @@ -1,339 +1,21 @@ -import { beforeEach, describe, expect, it, vi } from "vitest"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; +import { beforeEach, describe, expect, it } from "vitest"; import { clearPluginCommands, registerPluginCommand } from "../../../../src/plugins/commands.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; +import { + baseConfig, + baseRuntime, + getProviderMonitorTestMocks, + resetDiscordProviderMonitorMocks, +} from "./provider.test-support.js"; -type NativeCommandSpecMock = { - name: string; - description: string; - acceptsArgs: boolean; -}; - -function baseDiscordAccountConfig() { - return { - commands: { native: true, nativeSkills: false }, - voice: { enabled: false }, - agentComponents: { enabled: false }, - execApprovals: { enabled: false }, - }; -} - -const { - clientConstructorOptionsMock, - clientFetchUserMock, - clientHandleDeployRequestMock, - createDiscordAutoPresenceControllerMock, - createDiscordMessageHandlerMock, - createDiscordNativeCommandMock, - createNoopThreadBindingManagerMock, - createThreadBindingManagerMock, - getAcpSessionStatusMock, - listNativeCommandSpecsForConfigMock, - listSkillCommandsForAgentsMock, - monitorLifecycleMock, - reconcileAcpThreadBindingsOnStartupMock, - resolveDiscordAccountMock, - resolveDiscordAllowlistConfigMock, - resolveNativeCommandsEnabledMock, - resolveNativeSkillsEnabledMock, -} = vi.hoisted(() => ({ - clientConstructorOptionsMock: vi.fn(), - clientFetchUserMock: vi.fn(async (_target: string) => ({ id: "bot-1" })), - clientHandleDeployRequestMock: vi.fn(async () => undefined), - createDiscordAutoPresenceControllerMock: vi.fn(() => ({ - enabled: false, - start: vi.fn(), - stop: vi.fn(), - refresh: vi.fn(), - runNow: vi.fn(), - })), - createDiscordMessageHandlerMock: vi.fn(() => - Object.assign( - vi.fn(async () => undefined), - { - deactivate: vi.fn(), - }, - ), - ), - createDiscordNativeCommandMock: vi.fn((params: { command: { name: string } }) => ({ - name: params.command.name, - })), - createNoopThreadBindingManagerMock: vi.fn(() => ({ stop: vi.fn() })), - createThreadBindingManagerMock: vi.fn(() => ({ stop: vi.fn() })), - getAcpSessionStatusMock: vi.fn( - async (_params: { cfg: OpenClawConfig; sessionKey: string; signal?: AbortSignal }) => ({ - state: "idle", - }), - ), - listNativeCommandSpecsForConfigMock: vi.fn<() => NativeCommandSpecMock[]>(() => [ - { name: "status", description: "Status", acceptsArgs: false }, - ]), - listSkillCommandsForAgentsMock: vi.fn(() => []), - monitorLifecycleMock: vi.fn(async (params: { threadBindings: { stop: () => void } }) => { - params.threadBindings.stop(); - }), - reconcileAcpThreadBindingsOnStartupMock: vi.fn(() => ({ - checked: 0, - removed: 0, - staleSessionKeys: [], - })), - resolveDiscordAccountMock: vi.fn(() => ({ - accountId: "default", - token: "cfg-token", - config: baseDiscordAccountConfig(), - })), - resolveDiscordAllowlistConfigMock: vi.fn(async () => ({ - guildEntries: undefined, - allowFrom: undefined, - })), - resolveNativeCommandsEnabledMock: vi.fn(() => true), - resolveNativeSkillsEnabledMock: vi.fn(() => false), -})); - -vi.mock("@buape/carbon", () => { - class ReadyListener {} - class RateLimitError extends Error { - status = 429; - retryAfter = 0; - scope: string | null = null; - bucket: string | null = null; - } - class Client { - listeners: unknown[]; - rest: { put: ReturnType }; - constructor(options: unknown, handlers: { listeners?: unknown[] }) { - clientConstructorOptionsMock(options); - this.listeners = handlers.listeners ?? []; - this.rest = { put: vi.fn(async () => undefined) }; - } - async handleDeployRequest() { - return await clientHandleDeployRequestMock(); - } - async fetchUser(target: string) { - return await clientFetchUserMock(target); - } - getPlugin() { - return undefined; - } - } - return { Client, RateLimitError, ReadyListener }; -}); - -vi.mock("@buape/carbon/gateway", () => ({ - GatewayCloseCodes: { DisallowedIntents: 4014 }, -})); - -vi.mock("@buape/carbon/voice", () => ({ - VoicePlugin: class VoicePlugin {}, -})); - -vi.mock("../../../../src/acp/control-plane/manager.js", () => ({ - getAcpSessionManager: () => ({ - getSessionStatus: getAcpSessionStatusMock, - }), -})); - -vi.mock("../../../../src/auto-reply/chunk.js", () => ({ - resolveTextChunkLimit: () => 2000, -})); - -vi.mock("../../../../src/auto-reply/commands-registry.js", () => ({ - listNativeCommandSpecsForConfig: listNativeCommandSpecsForConfigMock, -})); - -vi.mock("../../../../src/auto-reply/skill-commands.js", () => ({ - listSkillCommandsForAgents: listSkillCommandsForAgentsMock, -})); - -vi.mock("../../../../src/config/commands.js", () => ({ - isNativeCommandsExplicitlyDisabled: () => false, - resolveNativeCommandsEnabled: resolveNativeCommandsEnabledMock, - resolveNativeSkillsEnabled: resolveNativeSkillsEnabledMock, -})); - -vi.mock("../../../../src/config/config.js", () => ({ - loadConfig: () => ({}), -})); - -vi.mock("../../../../src/globals.js", () => ({ - danger: (value: string) => value, - isVerbose: () => false, - logVerbose: vi.fn(), - shouldLogVerbose: () => false, - warn: (value: string) => value, -})); - -vi.mock("../../../../src/infra/errors.js", () => ({ - formatErrorMessage: (error: unknown) => String(error), -})); - -vi.mock("../../../../src/infra/retry-policy.js", () => ({ - createDiscordRetryRunner: () => async (run: () => Promise) => run(), -})); - -vi.mock("../../../../src/logging/subsystem.js", () => ({ - createSubsystemLogger: () => { - const logger = { - child: vi.fn(() => logger), - info: vi.fn(), - error: vi.fn(), - warn: vi.fn(), - debug: vi.fn(), - }; - return logger; - }, -})); - -vi.mock("../../../../src/runtime.js", () => ({ - createNonExitingRuntime: () => ({ log: vi.fn(), error: vi.fn(), exit: vi.fn() }), -})); - -vi.mock("../accounts.js", () => ({ - resolveDiscordAccount: resolveDiscordAccountMock, -})); - -vi.mock("../probe.js", () => ({ - fetchDiscordApplicationId: async () => "app-1", -})); - -vi.mock("../token.js", () => ({ - normalizeDiscordToken: (value?: string) => value, -})); - -vi.mock("../voice/command.js", () => ({ - createDiscordVoiceCommand: () => ({ name: "voice-command" }), -})); - -vi.mock("./agent-components.js", () => ({ - createAgentComponentButton: () => ({ id: "btn" }), - createAgentSelectMenu: () => ({ id: "menu" }), - createDiscordComponentButton: () => ({ id: "btn2" }), - createDiscordComponentChannelSelect: () => ({ id: "channel" }), - createDiscordComponentMentionableSelect: () => ({ id: "mentionable" }), - createDiscordComponentModal: () => ({ id: "modal" }), - createDiscordComponentRoleSelect: () => ({ id: "role" }), - createDiscordComponentStringSelect: () => ({ id: "string" }), - createDiscordComponentUserSelect: () => ({ id: "user" }), -})); - -vi.mock("./auto-presence.js", () => ({ - createDiscordAutoPresenceController: createDiscordAutoPresenceControllerMock, -})); - -vi.mock("./commands.js", () => ({ - resolveDiscordSlashCommandConfig: () => ({ ephemeral: false }), -})); - -vi.mock("./exec-approvals.js", () => ({ - createExecApprovalButton: () => ({ id: "exec-approval" }), - DiscordExecApprovalHandler: class DiscordExecApprovalHandler { - async start() { - return undefined; - } - async stop() { - return undefined; - } - }, -})); - -vi.mock("./gateway-plugin.js", () => ({ - createDiscordGatewayPlugin: () => ({ id: "gateway-plugin" }), -})); - -vi.mock("./listeners.js", () => ({ - DiscordMessageListener: class DiscordMessageListener {}, - DiscordPresenceListener: class DiscordPresenceListener {}, - DiscordReactionListener: class DiscordReactionListener {}, - DiscordReactionRemoveListener: class DiscordReactionRemoveListener {}, - DiscordThreadUpdateListener: class DiscordThreadUpdateListener {}, - registerDiscordListener: vi.fn(), -})); - -vi.mock("./message-handler.js", () => ({ - createDiscordMessageHandler: createDiscordMessageHandlerMock, -})); - -vi.mock("./native-command.js", () => ({ - createDiscordCommandArgFallbackButton: () => ({ id: "arg-fallback" }), - createDiscordModelPickerFallbackButton: () => ({ id: "model-fallback-btn" }), - createDiscordModelPickerFallbackSelect: () => ({ id: "model-fallback-select" }), - createDiscordNativeCommand: createDiscordNativeCommandMock, -})); - -vi.mock("./presence.js", () => ({ - resolveDiscordPresenceUpdate: () => undefined, -})); - -vi.mock("./provider.allowlist.js", () => ({ - resolveDiscordAllowlistConfig: resolveDiscordAllowlistConfigMock, -})); - -vi.mock("./provider.lifecycle.js", () => ({ - runDiscordGatewayLifecycle: monitorLifecycleMock, -})); - -vi.mock("./rest-fetch.js", () => ({ - resolveDiscordRestFetch: () => async () => undefined, -})); - -vi.mock("./thread-bindings.js", () => ({ - createNoopThreadBindingManager: createNoopThreadBindingManagerMock, - createThreadBindingManager: createThreadBindingManagerMock, - reconcileAcpThreadBindingsOnStartup: reconcileAcpThreadBindingsOnStartupMock, -})); +const { createDiscordNativeCommandMock, clientHandleDeployRequestMock, monitorLifecycleMock } = + getProviderMonitorTestMocks(); describe("monitorDiscordProvider real plugin registry", () => { - const baseRuntime = (): RuntimeEnv => ({ - log: vi.fn(), - error: vi.fn(), - exit: vi.fn(), - }); - - const baseConfig = (): OpenClawConfig => - ({ - channels: { - discord: { - accounts: { - default: {}, - }, - }, - }, - }) as OpenClawConfig; - beforeEach(() => { clearPluginCommands(); - clientConstructorOptionsMock.mockClear(); - clientFetchUserMock.mockClear().mockResolvedValue({ id: "bot-1" }); - clientHandleDeployRequestMock.mockClear().mockResolvedValue(undefined); - createDiscordAutoPresenceControllerMock.mockClear(); - createDiscordMessageHandlerMock.mockClear(); - createDiscordNativeCommandMock.mockClear(); - createNoopThreadBindingManagerMock.mockClear(); - createThreadBindingManagerMock.mockClear(); - getAcpSessionStatusMock.mockClear().mockResolvedValue({ state: "idle" }); - listNativeCommandSpecsForConfigMock - .mockClear() - .mockReturnValue([{ name: "status", description: "Status", acceptsArgs: false }]); - listSkillCommandsForAgentsMock.mockClear().mockReturnValue([]); - monitorLifecycleMock.mockClear().mockImplementation(async (params) => { - params.threadBindings.stop(); + resetDiscordProviderMonitorMocks({ + nativeCommands: [{ name: "status", description: "Status", acceptsArgs: false }], }); - reconcileAcpThreadBindingsOnStartupMock.mockClear().mockReturnValue({ - checked: 0, - removed: 0, - staleSessionKeys: [], - }); - resolveDiscordAccountMock.mockClear().mockReturnValue({ - accountId: "default", - token: "cfg-token", - config: baseDiscordAccountConfig(), - }); - resolveDiscordAllowlistConfigMock.mockClear().mockResolvedValue({ - guildEntries: undefined, - allowFrom: undefined, - }); - resolveNativeCommandsEnabledMock.mockClear().mockReturnValue(true); - resolveNativeSkillsEnabledMock.mockClear().mockReturnValue(false); }); it("registers plugin commands from the real registry as native Discord commands", async () => { diff --git a/extensions/discord/src/monitor/provider.test-support.ts b/extensions/discord/src/monitor/provider.test-support.ts new file mode 100644 index 00000000000..932c1952fcc --- /dev/null +++ b/extensions/discord/src/monitor/provider.test-support.ts @@ -0,0 +1,426 @@ +import { expect, vi } from "vitest"; +import type { OpenClawConfig } from "../../../../src/config/config.js"; +import type { RuntimeEnv } from "../../../../src/runtime.js"; + +export type NativeCommandSpecMock = { + name: string; + description: string; + acceptsArgs: boolean; +}; + +export type PluginCommandSpecMock = { + name: string; + description: string; + acceptsArgs: boolean; +}; + +export function baseDiscordAccountConfig() { + return { + commands: { native: true, nativeSkills: false }, + voice: { enabled: false }, + agentComponents: { enabled: false }, + execApprovals: { enabled: false }, + }; +} + +const providerMonitorTestMocks = vi.hoisted(() => { + const createdBindingManagers: Array<{ stop: ReturnType }> = []; + const isVerboseMock = vi.fn(() => false); + const shouldLogVerboseMock = vi.fn(() => false); + + return { + clientHandleDeployRequestMock: vi.fn(async () => undefined), + clientFetchUserMock: vi.fn(async (_target: string) => ({ id: "bot-1" })), + clientGetPluginMock: vi.fn<(_name: string) => unknown>(() => undefined), + clientConstructorOptionsMock: vi.fn(), + createDiscordAutoPresenceControllerMock: vi.fn(() => ({ + enabled: false, + start: vi.fn(), + stop: vi.fn(), + refresh: vi.fn(), + runNow: vi.fn(), + })), + createDiscordNativeCommandMock: vi.fn((params?: { command?: { name?: string } }) => ({ + name: params?.command?.name ?? "mock-command", + })), + createDiscordMessageHandlerMock: vi.fn(() => + Object.assign( + vi.fn(async () => undefined), + { + deactivate: vi.fn(), + }, + ), + ), + createNoopThreadBindingManagerMock: vi.fn(() => { + const manager = { stop: vi.fn() }; + createdBindingManagers.push(manager); + return manager; + }), + createThreadBindingManagerMock: vi.fn(() => { + const manager = { stop: vi.fn() }; + createdBindingManagers.push(manager); + return manager; + }), + reconcileAcpThreadBindingsOnStartupMock: vi.fn(() => ({ + checked: 0, + removed: 0, + staleSessionKeys: [], + })), + createdBindingManagers, + getAcpSessionStatusMock: vi.fn( + async (_params: { cfg: OpenClawConfig; sessionKey: string; signal?: AbortSignal }) => ({ + state: "idle", + }), + ), + getPluginCommandSpecsMock: vi.fn<() => PluginCommandSpecMock[]>(() => []), + listNativeCommandSpecsForConfigMock: vi.fn<() => NativeCommandSpecMock[]>(() => [ + { name: "cmd", description: "built-in", acceptsArgs: false }, + ]), + listSkillCommandsForAgentsMock: vi.fn(() => []), + monitorLifecycleMock: vi.fn(async (params: { threadBindings: { stop: () => void } }) => { + params.threadBindings.stop(); + }), + resolveDiscordAccountMock: vi.fn(() => ({ + accountId: "default", + token: "cfg-token", + config: baseDiscordAccountConfig(), + })), + resolveDiscordAllowlistConfigMock: vi.fn(async () => ({ + guildEntries: undefined, + allowFrom: undefined, + })), + resolveNativeCommandsEnabledMock: vi.fn(() => true), + resolveNativeSkillsEnabledMock: vi.fn(() => false), + isVerboseMock, + shouldLogVerboseMock, + voiceRuntimeModuleLoadedMock: vi.fn(), + }; +}); + +const { + clientHandleDeployRequestMock, + clientFetchUserMock, + clientGetPluginMock, + clientConstructorOptionsMock, + createDiscordAutoPresenceControllerMock, + createDiscordNativeCommandMock, + createDiscordMessageHandlerMock, + createNoopThreadBindingManagerMock, + createThreadBindingManagerMock, + reconcileAcpThreadBindingsOnStartupMock, + createdBindingManagers, + getAcpSessionStatusMock, + getPluginCommandSpecsMock, + listNativeCommandSpecsForConfigMock, + listSkillCommandsForAgentsMock, + monitorLifecycleMock, + resolveDiscordAccountMock, + resolveDiscordAllowlistConfigMock, + resolveNativeCommandsEnabledMock, + resolveNativeSkillsEnabledMock, + isVerboseMock, + shouldLogVerboseMock, + voiceRuntimeModuleLoadedMock, +} = providerMonitorTestMocks; + +export function getProviderMonitorTestMocks() { + return providerMonitorTestMocks; +} + +export function mockResolvedDiscordAccountConfig(overrides: Record) { + resolveDiscordAccountMock.mockImplementation(() => ({ + accountId: "default", + token: "cfg-token", + config: { + ...baseDiscordAccountConfig(), + ...overrides, + }, + })); +} + +export function getFirstDiscordMessageHandlerParams() { + expect(createDiscordMessageHandlerMock).toHaveBeenCalledTimes(1); + const firstCall = createDiscordMessageHandlerMock.mock.calls.at(0) as [T] | undefined; + return firstCall?.[0]; +} + +export function resetDiscordProviderMonitorMocks(params?: { + nativeCommands?: NativeCommandSpecMock[]; +}) { + clientHandleDeployRequestMock.mockClear().mockResolvedValue(undefined); + clientFetchUserMock.mockClear().mockResolvedValue({ id: "bot-1" }); + clientGetPluginMock.mockClear().mockReturnValue(undefined); + clientConstructorOptionsMock.mockClear(); + createDiscordAutoPresenceControllerMock.mockClear().mockImplementation(() => ({ + enabled: false, + start: vi.fn(), + stop: vi.fn(), + refresh: vi.fn(), + runNow: vi.fn(), + })); + createDiscordNativeCommandMock.mockClear().mockImplementation((input) => ({ + name: input?.command?.name ?? "mock-command", + })); + createDiscordMessageHandlerMock.mockClear().mockImplementation(() => + Object.assign( + vi.fn(async () => undefined), + { + deactivate: vi.fn(), + }, + ), + ); + createNoopThreadBindingManagerMock.mockClear(); + createThreadBindingManagerMock.mockClear(); + reconcileAcpThreadBindingsOnStartupMock.mockClear().mockReturnValue({ + checked: 0, + removed: 0, + staleSessionKeys: [], + }); + createdBindingManagers.length = 0; + getAcpSessionStatusMock.mockClear().mockResolvedValue({ state: "idle" }); + getPluginCommandSpecsMock.mockClear().mockReturnValue([]); + listNativeCommandSpecsForConfigMock + .mockClear() + .mockReturnValue( + params?.nativeCommands ?? [{ name: "cmd", description: "built-in", acceptsArgs: false }], + ); + listSkillCommandsForAgentsMock.mockClear().mockReturnValue([]); + monitorLifecycleMock.mockClear().mockImplementation(async (monitorParams) => { + monitorParams.threadBindings.stop(); + }); + resolveDiscordAccountMock.mockClear().mockReturnValue({ + accountId: "default", + token: "cfg-token", + config: baseDiscordAccountConfig(), + }); + resolveDiscordAllowlistConfigMock.mockClear().mockResolvedValue({ + guildEntries: undefined, + allowFrom: undefined, + }); + resolveNativeCommandsEnabledMock.mockClear().mockReturnValue(true); + resolveNativeSkillsEnabledMock.mockClear().mockReturnValue(false); + isVerboseMock.mockClear().mockReturnValue(false); + shouldLogVerboseMock.mockClear().mockReturnValue(false); + voiceRuntimeModuleLoadedMock.mockClear(); +} + +export const baseRuntime = (): RuntimeEnv => ({ + log: vi.fn(), + error: vi.fn(), + exit: vi.fn(), +}); + +export const baseConfig = (): OpenClawConfig => + ({ + channels: { + discord: { + accounts: { + default: {}, + }, + }, + }, + }) as OpenClawConfig; + +vi.mock("@buape/carbon", () => { + class ReadyListener {} + class RateLimitError extends Error { + status = 429; + discordCode?: number; + retryAfter: number; + scope: string | null; + bucket: string | null; + constructor( + response: Response, + body: { message: string; retry_after: number; global: boolean }, + ) { + super(body.message); + this.retryAfter = body.retry_after; + this.scope = body.global ? "global" : response.headers.get("X-RateLimit-Scope"); + this.bucket = response.headers.get("X-RateLimit-Bucket"); + } + } + class Client { + listeners: unknown[]; + rest: { put: ReturnType }; + options: unknown; + constructor(options: unknown, handlers: { listeners?: unknown[] }) { + this.options = options; + this.listeners = handlers.listeners ?? []; + this.rest = { put: vi.fn(async () => undefined) }; + clientConstructorOptionsMock(options); + } + async handleDeployRequest() { + return await clientHandleDeployRequestMock(); + } + async fetchUser(target: string) { + return await clientFetchUserMock(target); + } + getPlugin(name: string) { + return clientGetPluginMock(name); + } + } + return { Client, RateLimitError, ReadyListener }; +}); + +vi.mock("@buape/carbon/gateway", () => ({ + GatewayCloseCodes: { DisallowedIntents: 4014 }, +})); + +vi.mock("@buape/carbon/voice", () => ({ + VoicePlugin: class VoicePlugin {}, +})); + +vi.mock("../../../../src/acp/control-plane/manager.js", () => ({ + getAcpSessionManager: () => ({ + getSessionStatus: getAcpSessionStatusMock, + }), +})); + +vi.mock("../../../../src/auto-reply/chunk.js", () => ({ + resolveTextChunkLimit: () => 2000, +})); + +vi.mock("../../../../src/auto-reply/commands-registry.js", () => ({ + listNativeCommandSpecsForConfig: listNativeCommandSpecsForConfigMock, +})); + +vi.mock("../../../../src/auto-reply/skill-commands.js", () => ({ + listSkillCommandsForAgents: listSkillCommandsForAgentsMock, +})); + +vi.mock("../../../../src/config/commands.js", () => ({ + isNativeCommandsExplicitlyDisabled: () => false, + resolveNativeCommandsEnabled: resolveNativeCommandsEnabledMock, + resolveNativeSkillsEnabled: resolveNativeSkillsEnabledMock, +})); + +vi.mock("../../../../src/config/config.js", () => ({ + loadConfig: () => ({}), +})); + +vi.mock("../../../../src/globals.js", () => ({ + danger: (value: string) => value, + isVerbose: isVerboseMock, + logVerbose: vi.fn(), + shouldLogVerbose: shouldLogVerboseMock, + warn: (value: string) => value, +})); + +vi.mock("../../../../src/infra/errors.js", () => ({ + formatErrorMessage: (error: unknown) => String(error), +})); + +vi.mock("../../../../src/infra/retry-policy.js", () => ({ + createDiscordRetryRunner: () => async (run: () => Promise) => run(), +})); + +vi.mock("../../../../src/logging/subsystem.js", () => ({ + createSubsystemLogger: () => { + const logger = { + child: vi.fn(() => logger), + info: vi.fn(), + error: vi.fn(), + warn: vi.fn(), + debug: vi.fn(), + }; + return logger; + }, +})); + +vi.mock("../../../../src/runtime.js", () => ({ + createNonExitingRuntime: () => ({ log: vi.fn(), error: vi.fn(), exit: vi.fn() }), +})); + +vi.mock("../accounts.js", () => ({ + resolveDiscordAccount: resolveDiscordAccountMock, +})); + +vi.mock("../probe.js", () => ({ + fetchDiscordApplicationId: async () => "app-1", +})); + +vi.mock("../token.js", () => ({ + normalizeDiscordToken: (value?: string) => value, +})); + +vi.mock("../voice/command.js", () => ({ + createDiscordVoiceCommand: () => ({ name: "voice-command" }), +})); + +vi.mock("./agent-components.js", () => ({ + createAgentComponentButton: () => ({ id: "btn" }), + createAgentSelectMenu: () => ({ id: "menu" }), + createDiscordComponentButton: () => ({ id: "btn2" }), + createDiscordComponentChannelSelect: () => ({ id: "channel" }), + createDiscordComponentMentionableSelect: () => ({ id: "mentionable" }), + createDiscordComponentModal: () => ({ id: "modal" }), + createDiscordComponentRoleSelect: () => ({ id: "role" }), + createDiscordComponentStringSelect: () => ({ id: "string" }), + createDiscordComponentUserSelect: () => ({ id: "user" }), +})); + +vi.mock("./auto-presence.js", () => ({ + createDiscordAutoPresenceController: createDiscordAutoPresenceControllerMock, +})); + +vi.mock("./commands.js", () => ({ + resolveDiscordSlashCommandConfig: () => ({ ephemeral: false }), +})); + +vi.mock("./exec-approvals.js", () => ({ + createExecApprovalButton: () => ({ id: "exec-approval" }), + DiscordExecApprovalHandler: class DiscordExecApprovalHandler { + async start() { + return undefined; + } + async stop() { + return undefined; + } + }, +})); + +vi.mock("./gateway-plugin.js", () => ({ + createDiscordGatewayPlugin: () => ({ id: "gateway-plugin" }), +})); + +vi.mock("./listeners.js", () => ({ + DiscordMessageListener: class DiscordMessageListener {}, + DiscordPresenceListener: class DiscordPresenceListener {}, + DiscordReactionListener: class DiscordReactionListener {}, + DiscordReactionRemoveListener: class DiscordReactionRemoveListener {}, + DiscordThreadUpdateListener: class DiscordThreadUpdateListener {}, + registerDiscordListener: vi.fn(), +})); + +vi.mock("./message-handler.js", () => ({ + createDiscordMessageHandler: createDiscordMessageHandlerMock, +})); + +vi.mock("./native-command.js", () => ({ + createDiscordCommandArgFallbackButton: () => ({ id: "arg-fallback" }), + createDiscordModelPickerFallbackButton: () => ({ id: "model-fallback-btn" }), + createDiscordModelPickerFallbackSelect: () => ({ id: "model-fallback-select" }), + createDiscordNativeCommand: createDiscordNativeCommandMock, +})); + +vi.mock("./presence.js", () => ({ + resolveDiscordPresenceUpdate: () => undefined, +})); + +vi.mock("./provider.allowlist.js", () => ({ + resolveDiscordAllowlistConfig: resolveDiscordAllowlistConfigMock, +})); + +vi.mock("./provider.lifecycle.js", () => ({ + runDiscordGatewayLifecycle: monitorLifecycleMock, +})); + +vi.mock("./rest-fetch.js", () => ({ + resolveDiscordRestFetch: () => async () => undefined, +})); + +vi.mock("./thread-bindings.js", () => ({ + createNoopThreadBindingManager: createNoopThreadBindingManagerMock, + createThreadBindingManager: createThreadBindingManagerMock, + reconcileAcpThreadBindingsOnStartup: reconcileAcpThreadBindingsOnStartupMock, +})); diff --git a/extensions/discord/src/monitor/provider.test.ts b/extensions/discord/src/monitor/provider.test.ts index f00baf73ff8..14177aec001 100644 --- a/extensions/discord/src/monitor/provider.test.ts +++ b/extensions/discord/src/monitor/provider.test.ts @@ -2,262 +2,45 @@ import { EventEmitter } from "node:events"; import { beforeEach, describe, expect, it, vi } from "vitest"; import { AcpRuntimeError } from "../../../../src/acp/runtime/errors.js"; import type { OpenClawConfig } from "../../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; - -type NativeCommandSpecMock = { - name: string; - description: string; - acceptsArgs: boolean; -}; - -type PluginCommandSpecMock = { - name: string; - description: string; - acceptsArgs: boolean; -}; - -function baseDiscordAccountConfig() { - return { - commands: { native: true, nativeSkills: false }, - voice: { enabled: false }, - agentComponents: { enabled: false }, - execApprovals: { enabled: false }, - }; -} +import { + baseConfig, + baseRuntime, + getFirstDiscordMessageHandlerParams, + getProviderMonitorTestMocks, + mockResolvedDiscordAccountConfig, + resetDiscordProviderMonitorMocks, +} from "./provider.test-support.js"; const { - clientHandleDeployRequestMock, + clientConstructorOptionsMock, clientFetchUserMock, clientGetPluginMock, - clientConstructorOptionsMock, + clientHandleDeployRequestMock, createDiscordAutoPresenceControllerMock, - createDiscordNativeCommandMock, createDiscordMessageHandlerMock, + createDiscordNativeCommandMock, + createdBindingManagers, createNoopThreadBindingManagerMock, createThreadBindingManagerMock, - reconcileAcpThreadBindingsOnStartupMock, - createdBindingManagers, getAcpSessionStatusMock, getPluginCommandSpecsMock, + isVerboseMock, listNativeCommandSpecsForConfigMock, listSkillCommandsForAgentsMock, monitorLifecycleMock, - resolveDiscordAccountMock, + reconcileAcpThreadBindingsOnStartupMock, resolveDiscordAllowlistConfigMock, + resolveDiscordAccountMock, resolveNativeCommandsEnabledMock, resolveNativeSkillsEnabledMock, - isVerboseMock, shouldLogVerboseMock, voiceRuntimeModuleLoadedMock, -} = vi.hoisted(() => { - const createdBindingManagers: Array<{ stop: ReturnType }> = []; - const isVerboseMock = vi.fn(() => false); - const shouldLogVerboseMock = vi.fn(() => false); - return { - clientHandleDeployRequestMock: vi.fn(async () => undefined), - clientConstructorOptionsMock: vi.fn(), - createDiscordAutoPresenceControllerMock: vi.fn(() => ({ - enabled: false, - start: vi.fn(), - stop: vi.fn(), - refresh: vi.fn(), - runNow: vi.fn(), - })), - clientFetchUserMock: vi.fn(async (_target: string) => ({ id: "bot-1" })), - clientGetPluginMock: vi.fn<(_name: string) => unknown>(() => undefined), - createDiscordNativeCommandMock: vi.fn(() => ({ name: "mock-command" })), - createDiscordMessageHandlerMock: vi.fn(() => - Object.assign( - vi.fn(async () => undefined), - { - deactivate: vi.fn(), - }, - ), - ), - createNoopThreadBindingManagerMock: vi.fn(() => { - const manager = { stop: vi.fn() }; - createdBindingManagers.push(manager); - return manager; - }), - createThreadBindingManagerMock: vi.fn(() => { - const manager = { stop: vi.fn() }; - createdBindingManagers.push(manager); - return manager; - }), - reconcileAcpThreadBindingsOnStartupMock: vi.fn(() => ({ - checked: 0, - removed: 0, - staleSessionKeys: [], - })), - createdBindingManagers, - getAcpSessionStatusMock: vi.fn( - async (_params: { cfg: OpenClawConfig; sessionKey: string; signal?: AbortSignal }) => ({ - state: "idle", - }), - ), - getPluginCommandSpecsMock: vi.fn<() => PluginCommandSpecMock[]>(() => []), - listNativeCommandSpecsForConfigMock: vi.fn<() => NativeCommandSpecMock[]>(() => [ - { name: "cmd", description: "built-in", acceptsArgs: false }, - ]), - listSkillCommandsForAgentsMock: vi.fn(() => []), - monitorLifecycleMock: vi.fn(async (params: { threadBindings: { stop: () => void } }) => { - params.threadBindings.stop(); - }), - resolveDiscordAccountMock: vi.fn(() => ({ - accountId: "default", - token: "cfg-token", - config: baseDiscordAccountConfig(), - })), - resolveDiscordAllowlistConfigMock: vi.fn(async () => ({ - guildEntries: undefined, - allowFrom: undefined, - })), - resolveNativeCommandsEnabledMock: vi.fn(() => true), - resolveNativeSkillsEnabledMock: vi.fn(() => false), - isVerboseMock, - shouldLogVerboseMock, - voiceRuntimeModuleLoadedMock: vi.fn(), - }; -}); - -function mockResolvedDiscordAccountConfig(overrides: Record) { - resolveDiscordAccountMock.mockImplementation(() => ({ - accountId: "default", - token: "cfg-token", - config: { - ...baseDiscordAccountConfig(), - ...overrides, - }, - })); -} - -function getFirstDiscordMessageHandlerParams() { - expect(createDiscordMessageHandlerMock).toHaveBeenCalledTimes(1); - const firstCall = createDiscordMessageHandlerMock.mock.calls.at(0) as [T] | undefined; - return firstCall?.[0]; -} - -vi.mock("@buape/carbon", () => { - class ReadyListener {} - class RateLimitError extends Error { - status = 429; - discordCode?: number; - retryAfter: number; - scope: string | null; - bucket: string | null; - constructor( - response: Response, - body: { message: string; retry_after: number; global: boolean }, - ) { - super(body.message); - this.retryAfter = body.retry_after; - this.scope = body.global ? "global" : response.headers.get("X-RateLimit-Scope"); - this.bucket = response.headers.get("X-RateLimit-Bucket"); - } - } - class Client { - listeners: unknown[]; - rest: { put: ReturnType }; - options: unknown; - constructor(options: unknown, handlers: { listeners?: unknown[] }) { - this.options = options; - this.listeners = handlers.listeners ?? []; - this.rest = { put: vi.fn(async () => undefined) }; - clientConstructorOptionsMock(options); - } - async handleDeployRequest() { - return await clientHandleDeployRequestMock(); - } - async fetchUser(target: string) { - return await clientFetchUserMock(target); - } - getPlugin(name: string) { - return clientGetPluginMock(name); - } - } - return { Client, RateLimitError, ReadyListener }; -}); - -vi.mock("@buape/carbon/gateway", () => ({ - GatewayCloseCodes: { DisallowedIntents: 4014 }, -})); - -vi.mock("@buape/carbon/voice", () => ({ - VoicePlugin: class VoicePlugin {}, -})); - -vi.mock("../../../../src/auto-reply/chunk.js", () => ({ - resolveTextChunkLimit: () => 2000, -})); - -vi.mock("../../../../src/acp/control-plane/manager.js", () => ({ - getAcpSessionManager: () => ({ - getSessionStatus: getAcpSessionStatusMock, - }), -})); - -vi.mock("../../../../src/auto-reply/commands-registry.js", () => ({ - listNativeCommandSpecsForConfig: listNativeCommandSpecsForConfigMock, -})); - -vi.mock("../../../../src/auto-reply/skill-commands.js", () => ({ - listSkillCommandsForAgents: listSkillCommandsForAgentsMock, -})); - -vi.mock("../../../../src/config/commands.js", () => ({ - isNativeCommandsExplicitlyDisabled: () => false, - resolveNativeCommandsEnabled: resolveNativeCommandsEnabledMock, - resolveNativeSkillsEnabled: resolveNativeSkillsEnabledMock, -})); - -vi.mock("../../../../src/config/config.js", () => ({ - loadConfig: () => ({}), -})); - -vi.mock("../../../../src/globals.js", () => ({ - danger: (v: string) => v, - isVerbose: isVerboseMock, - logVerbose: vi.fn(), - shouldLogVerbose: shouldLogVerboseMock, - warn: (v: string) => v, -})); - -vi.mock("../../../../src/infra/errors.js", () => ({ - formatErrorMessage: (err: unknown) => String(err), -})); - -vi.mock("../../../../src/infra/retry-policy.js", () => ({ - createDiscordRetryRunner: () => async (run: () => Promise) => run(), -})); - -vi.mock("../../../../src/logging/subsystem.js", () => ({ - createSubsystemLogger: () => ({ info: vi.fn(), error: vi.fn() }), -})); +} = getProviderMonitorTestMocks(); vi.mock("../../../../src/plugins/commands.js", () => ({ getPluginCommandSpecs: getPluginCommandSpecsMock, })); -vi.mock("../../../../src/runtime.js", () => ({ - createNonExitingRuntime: () => ({ log: vi.fn(), error: vi.fn(), exit: vi.fn() }), -})); - -vi.mock("../accounts.js", () => ({ - resolveDiscordAccount: resolveDiscordAccountMock, -})); - -vi.mock("../probe.js", () => ({ - fetchDiscordApplicationId: async () => "app-1", -})); - -vi.mock("../token.js", () => ({ - normalizeDiscordToken: (value?: string) => value, -})); - -vi.mock("../voice/command.js", () => ({ - createDiscordVoiceCommand: () => ({ name: "voice-command" }), -})); - vi.mock("../voice/manager.runtime.js", () => { voiceRuntimeModuleLoadedMock(); return { @@ -266,84 +49,6 @@ vi.mock("../voice/manager.runtime.js", () => { }; }); -vi.mock("./agent-components.js", () => ({ - createAgentComponentButton: () => ({ id: "btn" }), - createAgentSelectMenu: () => ({ id: "menu" }), - createDiscordComponentButton: () => ({ id: "btn2" }), - createDiscordComponentChannelSelect: () => ({ id: "channel" }), - createDiscordComponentMentionableSelect: () => ({ id: "mentionable" }), - createDiscordComponentModal: () => ({ id: "modal" }), - createDiscordComponentRoleSelect: () => ({ id: "role" }), - createDiscordComponentStringSelect: () => ({ id: "string" }), - createDiscordComponentUserSelect: () => ({ id: "user" }), -})); - -vi.mock("./commands.js", () => ({ - resolveDiscordSlashCommandConfig: () => ({ ephemeral: false }), -})); - -vi.mock("./exec-approvals.js", () => ({ - createExecApprovalButton: () => ({ id: "exec-approval" }), - DiscordExecApprovalHandler: class DiscordExecApprovalHandler { - async start() { - return undefined; - } - async stop() { - return undefined; - } - }, -})); - -vi.mock("./gateway-plugin.js", () => ({ - createDiscordGatewayPlugin: () => ({ id: "gateway-plugin" }), -})); - -vi.mock("./listeners.js", () => ({ - DiscordMessageListener: class DiscordMessageListener {}, - DiscordPresenceListener: class DiscordPresenceListener {}, - DiscordReactionListener: class DiscordReactionListener {}, - DiscordReactionRemoveListener: class DiscordReactionRemoveListener {}, - DiscordThreadUpdateListener: class DiscordThreadUpdateListener {}, - registerDiscordListener: vi.fn(), -})); - -vi.mock("./message-handler.js", () => ({ - createDiscordMessageHandler: createDiscordMessageHandlerMock, -})); - -vi.mock("./native-command.js", () => ({ - createDiscordCommandArgFallbackButton: () => ({ id: "arg-fallback" }), - createDiscordModelPickerFallbackButton: () => ({ id: "model-fallback-btn" }), - createDiscordModelPickerFallbackSelect: () => ({ id: "model-fallback-select" }), - createDiscordNativeCommand: createDiscordNativeCommandMock, -})); - -vi.mock("./presence.js", () => ({ - resolveDiscordPresenceUpdate: () => undefined, -})); - -vi.mock("./auto-presence.js", () => ({ - createDiscordAutoPresenceController: createDiscordAutoPresenceControllerMock, -})); - -vi.mock("./provider.allowlist.js", () => ({ - resolveDiscordAllowlistConfig: resolveDiscordAllowlistConfigMock, -})); - -vi.mock("./provider.lifecycle.js", () => ({ - runDiscordGatewayLifecycle: monitorLifecycleMock, -})); - -vi.mock("./rest-fetch.js", () => ({ - resolveDiscordRestFetch: () => async () => undefined, -})); - -vi.mock("./thread-bindings.js", () => ({ - createNoopThreadBindingManager: createNoopThreadBindingManagerMock, - createThreadBindingManager: createThreadBindingManagerMock, - reconcileAcpThreadBindingsOnStartup: reconcileAcpThreadBindingsOnStartupMock, -})); - describe("monitorDiscordProvider", () => { type ReconcileHealthProbeParams = { cfg: OpenClawConfig; @@ -360,25 +65,6 @@ describe("monitorDiscordProvider", () => { ) => Promise<{ status: string; reason?: string }>; }; - const baseRuntime = (): RuntimeEnv => { - return { - log: vi.fn(), - error: vi.fn(), - exit: vi.fn(), - }; - }; - - const baseConfig = (): OpenClawConfig => - ({ - channels: { - discord: { - accounts: { - default: {}, - }, - }, - }, - }) as OpenClawConfig; - const getConstructedEventQueue = (): { listenerTimeout?: number } | undefined => { expect(clientConstructorOptionsMock).toHaveBeenCalledTimes(1); const opts = clientConstructorOptionsMock.mock.calls[0]?.[0] as { @@ -398,53 +84,7 @@ describe("monitorDiscordProvider", () => { }; beforeEach(() => { - clientHandleDeployRequestMock.mockClear().mockResolvedValue(undefined); - clientConstructorOptionsMock.mockClear(); - createDiscordAutoPresenceControllerMock.mockClear().mockImplementation(() => ({ - enabled: false, - start: vi.fn(), - stop: vi.fn(), - refresh: vi.fn(), - runNow: vi.fn(), - })); - createDiscordMessageHandlerMock.mockClear().mockImplementation(() => - Object.assign( - vi.fn(async () => undefined), - { - deactivate: vi.fn(), - }, - ), - ); - clientFetchUserMock.mockClear().mockResolvedValue({ id: "bot-1" }); - clientGetPluginMock.mockClear().mockReturnValue(undefined); - createDiscordNativeCommandMock.mockClear().mockReturnValue({ name: "mock-command" }); - createNoopThreadBindingManagerMock.mockClear(); - createThreadBindingManagerMock.mockClear(); - reconcileAcpThreadBindingsOnStartupMock.mockClear().mockReturnValue({ - checked: 0, - removed: 0, - staleSessionKeys: [], - }); - getAcpSessionStatusMock.mockClear().mockResolvedValue({ state: "idle" }); - createdBindingManagers.length = 0; - getPluginCommandSpecsMock.mockClear().mockReturnValue([]); - listNativeCommandSpecsForConfigMock - .mockClear() - .mockReturnValue([{ name: "cmd", description: "built-in", acceptsArgs: false }]); - listSkillCommandsForAgentsMock.mockClear().mockReturnValue([]); - monitorLifecycleMock.mockClear().mockImplementation(async (params) => { - params.threadBindings.stop(); - }); - resolveDiscordAccountMock.mockClear(); - resolveDiscordAllowlistConfigMock.mockClear().mockResolvedValue({ - guildEntries: undefined, - allowFrom: undefined, - }); - resolveNativeCommandsEnabledMock.mockClear().mockReturnValue(true); - resolveNativeSkillsEnabledMock.mockClear().mockReturnValue(false); - isVerboseMock.mockClear().mockReturnValue(false); - shouldLogVerboseMock.mockClear().mockReturnValue(false); - voiceRuntimeModuleLoadedMock.mockClear(); + resetDiscordProviderMonitorMocks(); }); it("stops thread bindings when startup fails before lifecycle begins", async () => { From 06ae5e9d21ea2be50679b5ef8bd07a7dfbc3fb64 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:32:38 +0000 Subject: [PATCH 031/187] refactor(telegram): share native command test menu helpers --- .../bot-native-commands.menu-test-support.ts | 158 ++++++++++++++++++ .../src/bot-native-commands.registry.test.ts | 150 +++-------------- .../telegram/src/bot-native-commands.test.ts | 158 +++++------------- 3 files changed, 227 insertions(+), 239 deletions(-) create mode 100644 extensions/telegram/src/bot-native-commands.menu-test-support.ts diff --git a/extensions/telegram/src/bot-native-commands.menu-test-support.ts b/extensions/telegram/src/bot-native-commands.menu-test-support.ts new file mode 100644 index 00000000000..9af54d3d1bc --- /dev/null +++ b/extensions/telegram/src/bot-native-commands.menu-test-support.ts @@ -0,0 +1,158 @@ +import { expect, vi } from "vitest"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { TelegramAccountConfig } from "../../../src/config/types.js"; +import type { RuntimeEnv } from "../../../src/runtime.js"; + +type NativeCommandBot = { + api: { + setMyCommands: ReturnType; + sendMessage: ReturnType; + }; + command: ReturnType; +}; + +type RegisterTelegramNativeCommandsParams = { + bot: NativeCommandBot; + cfg: OpenClawConfig; + runtime: RuntimeEnv; + accountId: string; + telegramCfg: TelegramAccountConfig; + allowFrom: string[]; + groupAllowFrom: string[]; + replyToMode: string; + textLimit: number; + useAccessGroups: boolean; + nativeEnabled: boolean; + nativeSkillsEnabled: boolean; + nativeDisabledExplicit: boolean; + resolveGroupPolicy: () => { allowlistEnabled: boolean; allowed: boolean }; + resolveTelegramGroupConfig: () => { + groupConfig: undefined; + topicConfig: undefined; + }; + shouldSkipUpdate: () => boolean; + opts: { token: string }; +}; + +type RegisteredCommand = { + command: string; + description: string; +}; + +const skillCommandMocks = vi.hoisted(() => ({ + listSkillCommandsForAgents: vi.fn(() => []), +})); + +const deliveryMocks = vi.hoisted(() => ({ + deliverReplies: vi.fn(async () => ({ delivered: true })), +})); + +export const listSkillCommandsForAgents = skillCommandMocks.listSkillCommandsForAgents; +export const deliverReplies = deliveryMocks.deliverReplies; + +vi.mock("../../../src/auto-reply/skill-commands.js", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + listSkillCommandsForAgents, + }; +}); + +vi.mock("./bot/delivery.js", () => ({ + deliverReplies, +})); + +export async function waitForRegisteredCommands( + setMyCommands: ReturnType, +): Promise { + await vi.waitFor(() => { + expect(setMyCommands).toHaveBeenCalled(); + }); + return setMyCommands.mock.calls[0]?.[0] as RegisteredCommand[]; +} + +export function resetNativeCommandMenuMocks() { + listSkillCommandsForAgents.mockClear(); + listSkillCommandsForAgents.mockReturnValue([]); + deliverReplies.mockClear(); + deliverReplies.mockResolvedValue({ delivered: true }); +} + +export function createCommandBot() { + const commandHandlers = new Map Promise>(); + const sendMessage = vi.fn().mockResolvedValue(undefined); + const setMyCommands = vi.fn().mockResolvedValue(undefined); + const bot = { + api: { + setMyCommands, + sendMessage, + }, + command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { + commandHandlers.set(name, cb); + }), + } as unknown as RegisterTelegramNativeCommandsParams["bot"]; + return { bot, commandHandlers, sendMessage, setMyCommands }; +} + +export function createNativeCommandTestParams( + cfg: OpenClawConfig, + params: Partial = {}, +): RegisterTelegramNativeCommandsParams { + return { + bot: + params.bot ?? + ({ + api: { + setMyCommands: vi.fn().mockResolvedValue(undefined), + sendMessage: vi.fn().mockResolvedValue(undefined), + }, + command: vi.fn(), + } as unknown as RegisterTelegramNativeCommandsParams["bot"]), + cfg, + runtime: params.runtime ?? ({} as RuntimeEnv), + accountId: params.accountId ?? "default", + telegramCfg: params.telegramCfg ?? ({} as TelegramAccountConfig), + allowFrom: params.allowFrom ?? [], + groupAllowFrom: params.groupAllowFrom ?? [], + replyToMode: params.replyToMode ?? "off", + textLimit: params.textLimit ?? 4000, + useAccessGroups: params.useAccessGroups ?? false, + nativeEnabled: params.nativeEnabled ?? true, + nativeSkillsEnabled: params.nativeSkillsEnabled ?? true, + nativeDisabledExplicit: params.nativeDisabledExplicit ?? false, + resolveGroupPolicy: + params.resolveGroupPolicy ?? + (() => + ({ + allowlistEnabled: false, + allowed: true, + }) as ReturnType), + resolveTelegramGroupConfig: + params.resolveTelegramGroupConfig ?? + (() => ({ + groupConfig: undefined, + topicConfig: undefined, + })), + shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), + opts: params.opts ?? { token: "token" }, + }; +} + +export function createPrivateCommandContext(params?: { + match?: string; + messageId?: number; + date?: number; + chatId?: number; + userId?: number; + username?: string; +}) { + return { + match: params?.match ?? "", + message: { + message_id: params?.messageId ?? 1, + date: params?.date ?? Math.floor(Date.now() / 1000), + chat: { id: params?.chatId ?? 123, type: "private" as const }, + from: { id: params?.userId ?? 456, username: params?.username ?? "alice" }, + }, + }; +} diff --git a/extensions/telegram/src/bot-native-commands.registry.test.ts b/extensions/telegram/src/bot-native-commands.registry.test.ts index a6fb431c349..c1f9fc1d0a6 100644 --- a/extensions/telegram/src/bot-native-commands.registry.test.ts +++ b/extensions/telegram/src/bot-native-commands.registry.test.ts @@ -1,102 +1,20 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.js"; import { clearPluginCommands, registerPluginCommand } from "../../../src/plugins/commands.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; - -const { listSkillCommandsForAgents } = vi.hoisted(() => ({ - listSkillCommandsForAgents: vi.fn(() => []), -})); -const deliveryMocks = vi.hoisted(() => ({ - deliverReplies: vi.fn(async () => ({ delivered: true })), -})); - -vi.mock("../../../src/auto-reply/skill-commands.js", async (importOriginal) => { - const actual = await importOriginal(); - return { - ...actual, - listSkillCommandsForAgents, - }; -}); - -vi.mock("./bot/delivery.js", () => ({ - deliverReplies: deliveryMocks.deliverReplies, -})); +import { + createCommandBot, + createNativeCommandTestParams, + createPrivateCommandContext, + deliverReplies, + resetNativeCommandMenuMocks, + waitForRegisteredCommands, +} from "./bot-native-commands.menu-test-support.js"; describe("registerTelegramNativeCommands real plugin registry", () => { - type RegisteredCommand = { - command: string; - description: string; - }; - - function createCommandBot() { - const commandHandlers = new Map Promise>(); - const sendMessage = vi.fn().mockResolvedValue(undefined); - const setMyCommands = vi.fn().mockResolvedValue(undefined); - const bot = { - api: { - setMyCommands, - sendMessage, - }, - command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { - commandHandlers.set(name, cb); - }), - } as unknown as Parameters[0]["bot"]; - return { bot, commandHandlers, sendMessage, setMyCommands }; - } - - async function waitForRegisteredCommands( - setMyCommands: ReturnType, - ): Promise { - await vi.waitFor(() => { - expect(setMyCommands).toHaveBeenCalled(); - }); - return setMyCommands.mock.calls[0]?.[0] as RegisteredCommand[]; - } - - const buildParams = (cfg: OpenClawConfig, accountId = "default") => - ({ - bot: { - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as Parameters[0]["bot"], - cfg, - runtime: {} as RuntimeEnv, - accountId, - telegramCfg: {} as TelegramAccountConfig, - allowFrom: [], - groupAllowFrom: [], - replyToMode: "off", - textLimit: 4000, - useAccessGroups: false, - nativeEnabled: true, - nativeSkillsEnabled: true, - nativeDisabledExplicit: false, - resolveGroupPolicy: () => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType< - Parameters[0]["resolveGroupPolicy"] - >, - resolveTelegramGroupConfig: () => ({ - groupConfig: undefined, - topicConfig: undefined, - }), - shouldSkipUpdate: () => false, - opts: { token: "token" }, - }) satisfies Parameters[0]; - beforeEach(() => { clearPluginCommands(); - deliveryMocks.deliverReplies.mockClear(); - deliveryMocks.deliverReplies.mockResolvedValue({ delivered: true }); - listSkillCommandsForAgents.mockClear(); - listSkillCommandsForAgents.mockReturnValue([]); + resetNativeCommandMenuMocks(); }); afterEach(() => { @@ -117,7 +35,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { ).toEqual({ ok: true }); registerTelegramNativeCommands({ - ...buildParams({}), + ...createNativeCommandTestParams({}), bot, }); @@ -129,17 +47,9 @@ describe("registerTelegramNativeCommands real plugin registry", () => { const handler = commandHandlers.get("pair"); expect(handler).toBeTruthy(); - await handler?.({ - match: "now", - message: { - message_id: 1, - date: Math.floor(Date.now() / 1000), - chat: { id: 123, type: "private" }, - from: { id: 456, username: "alice" }, - }, - }); + await handler?.(createPrivateCommandContext({ match: "now" })); - expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( + expect(deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), @@ -165,7 +75,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { ).toEqual({ ok: true }); registerTelegramNativeCommands({ - ...buildParams({}), + ...createNativeCommandTestParams({}), bot, }); @@ -177,17 +87,9 @@ describe("registerTelegramNativeCommands real plugin registry", () => { const handler = commandHandlers.get("pair_device"); expect(handler).toBeTruthy(); - await handler?.({ - match: "now", - message: { - message_id: 2, - date: Math.floor(Date.now() / 1000), - chat: { id: 123, type: "private" }, - from: { id: 456, username: "alice" }, - }, - }); + await handler?.(createPrivateCommandContext({ match: "now", messageId: 2 })); - expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( + expect(deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), @@ -209,7 +111,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { ).toEqual({ ok: true }); registerTelegramNativeCommands({ - ...buildParams({}, "default"), + ...createNativeCommandTestParams({}, { accountId: "default" }), bot, nativeEnabled: false, }); @@ -232,7 +134,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { ).toEqual({ ok: true }); registerTelegramNativeCommands({ - ...buildParams({ + ...createNativeCommandTestParams({ commands: { allowFrom: { telegram: ["999"] } } as OpenClawConfig["commands"], }), bot, @@ -245,17 +147,17 @@ describe("registerTelegramNativeCommands real plugin registry", () => { const handler = commandHandlers.get("pair"); expect(handler).toBeTruthy(); - await handler?.({ - match: "now", - message: { - message_id: 10, + await handler?.( + createPrivateCommandContext({ + match: "now", + messageId: 10, date: 123456, - chat: { id: 123, type: "private" }, - from: { id: 111, username: "nope" }, - }, - }); + userId: 111, + username: "nope", + }), + ); - expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( + expect(deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), diff --git a/extensions/telegram/src/bot-native-commands.test.ts b/extensions/telegram/src/bot-native-commands.test.ts index bc843293fc5..6dba343524f 100644 --- a/extensions/telegram/src/bot-native-commands.test.ts +++ b/extensions/telegram/src/bot-native-commands.test.ts @@ -6,99 +6,38 @@ import { TELEGRAM_COMMAND_NAME_PATTERN } from "../../../src/config/telegram-cust import type { TelegramAccountConfig } from "../../../src/config/types.js"; import type { RuntimeEnv } from "../../../src/runtime.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; +import { + createCommandBot, + createNativeCommandTestParams, + createPrivateCommandContext, + deliverReplies, + listSkillCommandsForAgents, + resetNativeCommandMenuMocks, + waitForRegisteredCommands, +} from "./bot-native-commands.menu-test-support.js"; -const { listSkillCommandsForAgents } = vi.hoisted(() => ({ - listSkillCommandsForAgents: vi.fn(() => []), -})); const pluginCommandMocks = vi.hoisted(() => ({ getPluginCommandSpecs: vi.fn(() => []), matchPluginCommand: vi.fn(() => null), executePluginCommand: vi.fn(async () => ({ text: "ok" })), })); -const deliveryMocks = vi.hoisted(() => ({ - deliverReplies: vi.fn(async () => ({ delivered: true })), -})); - -vi.mock("../../../src/auto-reply/skill-commands.js", async (importOriginal) => { - const actual = await importOriginal(); - return { - ...actual, - listSkillCommandsForAgents, - }; -}); vi.mock("../../../src/plugins/commands.js", () => ({ getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, matchPluginCommand: pluginCommandMocks.matchPluginCommand, executePluginCommand: pluginCommandMocks.executePluginCommand, })); -vi.mock("./bot/delivery.js", () => ({ - deliverReplies: deliveryMocks.deliverReplies, -})); describe("registerTelegramNativeCommands", () => { - type RegisteredCommand = { - command: string; - description: string; - }; - - async function waitForRegisteredCommands( - setMyCommands: ReturnType, - ): Promise { - await vi.waitFor(() => { - expect(setMyCommands).toHaveBeenCalled(); - }); - return setMyCommands.mock.calls[0]?.[0] as RegisteredCommand[]; - } - beforeEach(() => { - listSkillCommandsForAgents.mockClear(); - listSkillCommandsForAgents.mockReturnValue([]); + resetNativeCommandMenuMocks(); pluginCommandMocks.getPluginCommandSpecs.mockClear(); pluginCommandMocks.getPluginCommandSpecs.mockReturnValue([]); pluginCommandMocks.matchPluginCommand.mockClear(); pluginCommandMocks.matchPluginCommand.mockReturnValue(null); pluginCommandMocks.executePluginCommand.mockClear(); pluginCommandMocks.executePluginCommand.mockResolvedValue({ text: "ok" }); - deliveryMocks.deliverReplies.mockClear(); - deliveryMocks.deliverReplies.mockResolvedValue({ delivered: true }); }); - const buildParams = (cfg: OpenClawConfig, accountId = "default") => - ({ - bot: { - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as Parameters[0]["bot"], - cfg, - runtime: {} as RuntimeEnv, - accountId, - telegramCfg: {} as TelegramAccountConfig, - allowFrom: [], - groupAllowFrom: [], - replyToMode: "off", - textLimit: 4000, - useAccessGroups: false, - nativeEnabled: true, - nativeSkillsEnabled: true, - nativeDisabledExplicit: false, - resolveGroupPolicy: () => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType< - Parameters[0]["resolveGroupPolicy"] - >, - resolveTelegramGroupConfig: () => ({ - groupConfig: undefined, - topicConfig: undefined, - }), - shouldSkipUpdate: () => false, - opts: { token: "token" }, - }) satisfies Parameters[0]; - it("scopes skill commands when account binding exists", () => { const cfg: OpenClawConfig = { agents: { @@ -112,7 +51,7 @@ describe("registerTelegramNativeCommands", () => { ], }; - registerTelegramNativeCommands(buildParams(cfg, "bot-a")); + registerTelegramNativeCommands(createNativeCommandTestParams(cfg, { accountId: "bot-a" })); expect(listSkillCommandsForAgents).toHaveBeenCalledWith({ cfg, @@ -127,7 +66,7 @@ describe("registerTelegramNativeCommands", () => { }, }; - registerTelegramNativeCommands(buildParams(cfg, "bot-a")); + registerTelegramNativeCommands(createNativeCommandTestParams(cfg, { accountId: "bot-a" })); expect(listSkillCommandsForAgents).toHaveBeenCalledWith({ cfg, @@ -147,7 +86,7 @@ describe("registerTelegramNativeCommands", () => { const runtimeLog = vi.fn(); registerTelegramNativeCommands({ - ...buildParams(cfg), + ...createNativeCommandTestParams(cfg), bot: { api: { setMyCommands, @@ -174,7 +113,7 @@ describe("registerTelegramNativeCommands", () => { const command = vi.fn(); registerTelegramNativeCommands({ - ...buildParams({}), + ...createNativeCommandTestParams({}), bot: { api: { setMyCommands, @@ -202,7 +141,7 @@ describe("registerTelegramNativeCommands", () => { ] as never); registerTelegramNativeCommands({ - ...buildParams({}), + ...createNativeCommandTestParams({}), bot: { api: { setMyCommands, @@ -259,31 +198,24 @@ describe("registerTelegramNativeCommands", () => { } as never); registerTelegramNativeCommands({ - ...buildParams(cfg), - bot: { - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage, - }, - command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { - commandHandlers.set(name, cb); - }), - } as unknown as Parameters[0]["bot"], + ...createNativeCommandTestParams(cfg, { + bot: { + api: { + setMyCommands: vi.fn().mockResolvedValue(undefined), + sendMessage, + }, + command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { + commandHandlers.set(name, cb); + }), + } as unknown as Parameters[0]["bot"], + }), }); const handler = commandHandlers.get("plug"); expect(handler).toBeTruthy(); - await handler?.({ - match: "", - message: { - message_id: 1, - date: Math.floor(Date.now() / 1000), - chat: { id: 123, type: "private" }, - from: { id: 456, username: "alice" }, - }, - }); + await handler?.(createPrivateCommandContext()); - expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( + expect(deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ mediaLocalRoots: expect.arrayContaining([path.join(STATE_DIR, "workspace-work")]), }), @@ -310,32 +242,28 @@ describe("registerTelegramNativeCommands", () => { } as never); registerTelegramNativeCommands({ - ...buildParams({}), - bot: { - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), + ...createNativeCommandTestParams( + {}, + { + bot: { + api: { + setMyCommands: vi.fn().mockResolvedValue(undefined), + sendMessage: vi.fn().mockResolvedValue(undefined), + }, + command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { + commandHandlers.set(name, cb); + }), + } as unknown as Parameters[0]["bot"], }, - command: vi.fn((name: string, cb: (ctx: unknown) => Promise) => { - commandHandlers.set(name, cb); - }), - } as unknown as Parameters[0]["bot"], + ), telegramCfg: { silentErrorReplies: true } as TelegramAccountConfig, }); const handler = commandHandlers.get("plug"); expect(handler).toBeTruthy(); - await handler?.({ - match: "", - message: { - message_id: 1, - date: Math.floor(Date.now() / 1000), - chat: { id: 123, type: "private" }, - from: { id: 456, username: "alice" }, - }, - }); + await handler?.(createPrivateCommandContext()); - expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( + expect(deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ silent: true, replies: [expect.objectContaining({ isError: true })], From 63d82a6299d8eaab5bd2121945b27bb5eec1f3d6 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:33:41 +0000 Subject: [PATCH 032/187] refactor(telegram): reuse menu helpers in skill allowlist test --- ...t-native-commands.skills-allowlist.test.ts | 67 ++++++------------- 1 file changed, 19 insertions(+), 48 deletions(-) diff --git a/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts b/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts index c026392f9f9..d15db967767 100644 --- a/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts +++ b/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts @@ -4,26 +4,24 @@ import path from "node:path"; import { afterEach, describe, expect, it, vi } from "vitest"; import { writeSkill } from "../../../src/agents/skills.e2e-test-helpers.js"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; +import { + createNativeCommandTestParams, + resetNativeCommandMenuMocks, + waitForRegisteredCommands, +} from "./bot-native-commands.menu-test-support.js"; const pluginCommandMocks = vi.hoisted(() => ({ getPluginCommandSpecs: vi.fn(() => []), matchPluginCommand: vi.fn(() => null), executePluginCommand: vi.fn(async () => ({ text: "ok" })), })); -const deliveryMocks = vi.hoisted(() => ({ - deliverReplies: vi.fn(async () => ({ delivered: true })), -})); vi.mock("../../../src/plugins/commands.js", () => ({ getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, matchPluginCommand: pluginCommandMocks.matchPluginCommand, executePluginCommand: pluginCommandMocks.executePluginCommand, })); -vi.mock("./bot/delivery.js", () => ({ - deliverReplies: deliveryMocks.deliverReplies, -})); const tempDirs: string[] = []; @@ -35,10 +33,10 @@ async function makeWorkspace(prefix: string) { describe("registerTelegramNativeCommands skill allowlist integration", () => { afterEach(async () => { + resetNativeCommandMenuMocks(); pluginCommandMocks.getPluginCommandSpecs.mockClear().mockReturnValue([]); pluginCommandMocks.matchPluginCommand.mockClear().mockReturnValue(null); pluginCommandMocks.executePluginCommand.mockClear().mockResolvedValue({ text: "ok" }); - deliveryMocks.deliverReplies.mockClear().mockResolvedValue({ delivered: true }); await Promise.all( tempDirs .splice(0, tempDirs.length) @@ -76,49 +74,22 @@ describe("registerTelegramNativeCommands skill allowlist integration", () => { }; registerTelegramNativeCommands({ - bot: { - api: { - setMyCommands, - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as Parameters[0]["bot"], - cfg, - runtime: { log: vi.fn() } as unknown as Parameters< - typeof registerTelegramNativeCommands - >[0]["runtime"], - accountId: "bot-a", - telegramCfg: {} as TelegramAccountConfig, - allowFrom: [], - groupAllowFrom: [], - replyToMode: "off", - textLimit: 4000, - useAccessGroups: false, - nativeEnabled: true, - nativeSkillsEnabled: true, - nativeDisabledExplicit: false, - resolveGroupPolicy: () => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType< - Parameters[0]["resolveGroupPolicy"] - >, - resolveTelegramGroupConfig: () => ({ - groupConfig: undefined, - topicConfig: undefined, + ...createNativeCommandTestParams(cfg, { + bot: { + api: { + setMyCommands, + sendMessage: vi.fn().mockResolvedValue(undefined), + }, + command: vi.fn(), + } as unknown as Parameters[0]["bot"], + runtime: { log: vi.fn() } as unknown as Parameters< + typeof registerTelegramNativeCommands + >[0]["runtime"], + accountId: "bot-a", }), - shouldSkipUpdate: () => false, - opts: { token: "token" }, }); - await vi.waitFor(() => { - expect(setMyCommands).toHaveBeenCalled(); - }); - const registeredCommands = setMyCommands.mock.calls[0]?.[0] as Array<{ - command: string; - description: string; - }>; + const registeredCommands = await waitForRegisteredCommands(setMyCommands); expect(registeredCommands.some((entry) => entry.command === "alpha_skill")).toBe(true); expect(registeredCommands.some((entry) => entry.command === "beta_skill")).toBe(false); From 5ce2ed3bd274fa32983b55638bcc7fa6a19a7b02 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:36:18 +0000 Subject: [PATCH 033/187] refactor(telegram): share native command test fixtures --- ...ot-native-commands.fixture-test-support.ts | 128 ++++++++++++++++++ .../bot-native-commands.menu-test-support.ts | 96 ++----------- .../bot-native-commands.session-meta.test.ts | 119 +++------------- .../src/bot-native-commands.test-helpers.ts | 50 +------ 4 files changed, 166 insertions(+), 227 deletions(-) create mode 100644 extensions/telegram/src/bot-native-commands.fixture-test-support.ts diff --git a/extensions/telegram/src/bot-native-commands.fixture-test-support.ts b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts new file mode 100644 index 00000000000..ab2439d65ec --- /dev/null +++ b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts @@ -0,0 +1,128 @@ +import { vi } from "vitest"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { TelegramAccountConfig } from "../../../src/config/types.js"; +import type { RuntimeEnv } from "../../../src/runtime.js"; + +export type NativeCommandTestParams = { + bot: { + api: { + setMyCommands: ReturnType; + sendMessage: ReturnType; + }; + command: ReturnType; + }; + cfg: OpenClawConfig; + runtime: RuntimeEnv; + accountId: string; + telegramCfg: TelegramAccountConfig; + allowFrom: string[]; + groupAllowFrom: string[]; + replyToMode: string; + textLimit: number; + useAccessGroups: boolean; + nativeEnabled: boolean; + nativeSkillsEnabled: boolean; + nativeDisabledExplicit: boolean; + resolveGroupPolicy: () => { allowlistEnabled: boolean; allowed: boolean }; + resolveTelegramGroupConfig: () => { + groupConfig: undefined; + topicConfig: undefined; + }; + shouldSkipUpdate: () => boolean; + opts: { token: string }; +}; + +export function createDeferred() { + let resolve!: (value: T | PromiseLike) => void; + const promise = new Promise((res) => { + resolve = res; + }); + return { promise, resolve }; +} + +export function createNativeCommandTestParams( + params: Partial = {}, +): NativeCommandTestParams { + const log = vi.fn(); + return { + bot: + params.bot ?? + ({ + api: { + setMyCommands: vi.fn().mockResolvedValue(undefined), + sendMessage: vi.fn().mockResolvedValue(undefined), + }, + command: vi.fn(), + } as NativeCommandTestParams["bot"]), + cfg: params.cfg ?? ({} as OpenClawConfig), + runtime: params.runtime ?? ({ log } as RuntimeEnv), + accountId: params.accountId ?? "default", + telegramCfg: params.telegramCfg ?? ({} as TelegramAccountConfig), + allowFrom: params.allowFrom ?? [], + groupAllowFrom: params.groupAllowFrom ?? [], + replyToMode: params.replyToMode ?? "off", + textLimit: params.textLimit ?? 4000, + useAccessGroups: params.useAccessGroups ?? false, + nativeEnabled: params.nativeEnabled ?? true, + nativeSkillsEnabled: params.nativeSkillsEnabled ?? false, + nativeDisabledExplicit: params.nativeDisabledExplicit ?? false, + resolveGroupPolicy: + params.resolveGroupPolicy ?? + (() => + ({ + allowlistEnabled: false, + allowed: true, + }) as ReturnType), + resolveTelegramGroupConfig: + params.resolveTelegramGroupConfig ?? + (() => ({ groupConfig: undefined, topicConfig: undefined })), + shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), + opts: params.opts ?? { token: "token" }, + }; +} + +export function createTelegramPrivateCommandContext(params?: { + match?: string; + messageId?: number; + date?: number; + chatId?: number; + userId?: number; + username?: string; +}) { + return { + match: params?.match ?? "", + message: { + message_id: params?.messageId ?? 1, + date: params?.date ?? Math.floor(Date.now() / 1000), + chat: { id: params?.chatId ?? 100, type: "private" as const }, + from: { id: params?.userId ?? 200, username: params?.username ?? "bob" }, + }, + }; +} + +export function createTelegramTopicCommandContext(params?: { + match?: string; + messageId?: number; + date?: number; + chatId?: number; + title?: string; + threadId?: number; + userId?: number; + username?: string; +}) { + return { + match: params?.match ?? "", + message: { + message_id: params?.messageId ?? 2, + date: params?.date ?? Math.floor(Date.now() / 1000), + chat: { + id: params?.chatId ?? -1001234567890, + type: "supergroup" as const, + title: params?.title ?? "OpenClaw", + is_forum: true, + }, + message_thread_id: params?.threadId ?? 42, + from: { id: params?.userId ?? 200, username: params?.username ?? "bob" }, + }, + }; +} diff --git a/extensions/telegram/src/bot-native-commands.menu-test-support.ts b/extensions/telegram/src/bot-native-commands.menu-test-support.ts index 9af54d3d1bc..241c50ac6be 100644 --- a/extensions/telegram/src/bot-native-commands.menu-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.menu-test-support.ts @@ -1,38 +1,11 @@ import { expect, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.js"; import type { RuntimeEnv } from "../../../src/runtime.js"; - -type NativeCommandBot = { - api: { - setMyCommands: ReturnType; - sendMessage: ReturnType; - }; - command: ReturnType; -}; - -type RegisterTelegramNativeCommandsParams = { - bot: NativeCommandBot; - cfg: OpenClawConfig; - runtime: RuntimeEnv; - accountId: string; - telegramCfg: TelegramAccountConfig; - allowFrom: string[]; - groupAllowFrom: string[]; - replyToMode: string; - textLimit: number; - useAccessGroups: boolean; - nativeEnabled: boolean; - nativeSkillsEnabled: boolean; - nativeDisabledExplicit: boolean; - resolveGroupPolicy: () => { allowlistEnabled: boolean; allowed: boolean }; - resolveTelegramGroupConfig: () => { - groupConfig: undefined; - topicConfig: undefined; - }; - shouldSkipUpdate: () => boolean; - opts: { token: string }; -}; +import { + createNativeCommandTestParams as createBaseNativeCommandTestParams, + createTelegramPrivateCommandContext, + type NativeCommandTestParams as RegisterTelegramNativeCommandsParams, +} from "./bot-native-commands.fixture-test-support.js"; type RegisteredCommand = { command: string; @@ -98,61 +71,12 @@ export function createNativeCommandTestParams( cfg: OpenClawConfig, params: Partial = {}, ): RegisterTelegramNativeCommandsParams { - return { - bot: - params.bot ?? - ({ - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as RegisterTelegramNativeCommandsParams["bot"]), + return createBaseNativeCommandTestParams({ cfg, runtime: params.runtime ?? ({} as RuntimeEnv), - accountId: params.accountId ?? "default", - telegramCfg: params.telegramCfg ?? ({} as TelegramAccountConfig), - allowFrom: params.allowFrom ?? [], - groupAllowFrom: params.groupAllowFrom ?? [], - replyToMode: params.replyToMode ?? "off", - textLimit: params.textLimit ?? 4000, - useAccessGroups: params.useAccessGroups ?? false, - nativeEnabled: params.nativeEnabled ?? true, - nativeSkillsEnabled: params.nativeSkillsEnabled ?? true, - nativeDisabledExplicit: params.nativeDisabledExplicit ?? false, - resolveGroupPolicy: - params.resolveGroupPolicy ?? - (() => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType), - resolveTelegramGroupConfig: - params.resolveTelegramGroupConfig ?? - (() => ({ - groupConfig: undefined, - topicConfig: undefined, - })), - shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), - opts: params.opts ?? { token: "token" }, - }; + nativeSkillsEnabled: true, + ...params, + }); } -export function createPrivateCommandContext(params?: { - match?: string; - messageId?: number; - date?: number; - chatId?: number; - userId?: number; - username?: string; -}) { - return { - match: params?.match ?? "", - message: { - message_id: params?.messageId ?? 1, - date: params?.date ?? Math.floor(Date.now() / 1000), - chat: { id: params?.chatId ?? 123, type: "private" as const }, - from: { id: params?.userId ?? 456, username: params?.username ?? "alice" }, - }, - }; -} +export { createTelegramPrivateCommandContext as createPrivateCommandContext }; diff --git a/extensions/telegram/src/bot-native-commands.session-meta.test.ts b/extensions/telegram/src/bot-native-commands.session-meta.test.ts index 6160afccf01..0a75b12fc1a 100644 --- a/extensions/telegram/src/bot-native-commands.session-meta.test.ts +++ b/extensions/telegram/src/bot-native-commands.session-meta.test.ts @@ -1,12 +1,17 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; +import { + createDeferred, + createNativeCommandTestParams, + createTelegramPrivateCommandContext, + createTelegramTopicCommandContext, + type NativeCommandTestParams, +} from "./bot-native-commands.fixture-test-support.js"; import { registerTelegramNativeCommands, type RegisterTelegramHandlerParams, } from "./bot-native-commands.js"; -type RegisterTelegramNativeCommandsParams = Parameters[0]; - // All mocks scoped to this file only — does not affect bot-native-commands.test.ts type ResolveConfiguredAcpBindingRecordFn = @@ -101,93 +106,13 @@ vi.mock("./bot/delivery.js", () => ({ deliverReplies: deliveryMocks.deliverReplies, })); -function createDeferred() { - let resolve!: (value: T | PromiseLike) => void; - const promise = new Promise((res) => { - resolve = res; - }); - return { promise, resolve }; -} - -function createNativeCommandTestParams( - params: Partial = {}, -): RegisterTelegramNativeCommandsParams { - const log = vi.fn(); - return { - bot: - params.bot ?? - ({ - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as RegisterTelegramNativeCommandsParams["bot"]), - cfg: params.cfg ?? ({} as OpenClawConfig), - runtime: - params.runtime ?? ({ log } as unknown as RegisterTelegramNativeCommandsParams["runtime"]), - accountId: params.accountId ?? "default", - telegramCfg: params.telegramCfg ?? ({} as RegisterTelegramNativeCommandsParams["telegramCfg"]), - allowFrom: params.allowFrom ?? [], - groupAllowFrom: params.groupAllowFrom ?? [], - replyToMode: params.replyToMode ?? "off", - textLimit: params.textLimit ?? 4000, - useAccessGroups: params.useAccessGroups ?? false, - nativeEnabled: params.nativeEnabled ?? true, - nativeSkillsEnabled: params.nativeSkillsEnabled ?? false, - nativeDisabledExplicit: params.nativeDisabledExplicit ?? false, - resolveGroupPolicy: - params.resolveGroupPolicy ?? - (() => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType), - resolveTelegramGroupConfig: - params.resolveTelegramGroupConfig ?? - (() => ({ groupConfig: undefined, topicConfig: undefined })), - shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), - opts: params.opts ?? { token: "token" }, - }; -} - type TelegramCommandHandler = (ctx: unknown) => Promise; -function buildStatusCommandContext() { - return { - match: "", - message: { - message_id: 1, - date: Math.floor(Date.now() / 1000), - chat: { id: 100, type: "private" as const }, - from: { id: 200, username: "bob" }, - }, - }; -} - -function buildStatusTopicCommandContext() { - return { - match: "", - message: { - message_id: 2, - date: Math.floor(Date.now() / 1000), - chat: { - id: -1001234567890, - type: "supergroup" as const, - title: "OpenClaw", - is_forum: true, - }, - message_thread_id: 42, - from: { id: 200, username: "bob" }, - }, - }; -} - function registerAndResolveStatusHandler(params: { cfg: OpenClawConfig; allowFrom?: string[]; groupAllowFrom?: string[]; - telegramCfg?: RegisterTelegramNativeCommandsParams["telegramCfg"]; + telegramCfg?: NativeCommandTestParams["telegramCfg"]; resolveTelegramGroupConfig?: RegisterTelegramHandlerParams["resolveTelegramGroupConfig"]; }): { handler: TelegramCommandHandler; @@ -211,7 +136,7 @@ function registerAndResolveCommandHandlerBase(params: { allowFrom: string[]; groupAllowFrom: string[]; useAccessGroups: boolean; - telegramCfg?: RegisterTelegramNativeCommandsParams["telegramCfg"]; + telegramCfg?: NativeCommandTestParams["telegramCfg"]; resolveTelegramGroupConfig?: RegisterTelegramHandlerParams["resolveTelegramGroupConfig"]; }): { handler: TelegramCommandHandler; @@ -238,7 +163,7 @@ function registerAndResolveCommandHandlerBase(params: { command: vi.fn((name: string, cb: TelegramCommandHandler) => { commandHandlers.set(name, cb); }), - } as unknown as Parameters[0]["bot"], + } as unknown as NativeCommandTestParams["bot"], cfg, allowFrom, groupAllowFrom, @@ -259,7 +184,7 @@ function registerAndResolveCommandHandler(params: { allowFrom?: string[]; groupAllowFrom?: string[]; useAccessGroups?: boolean; - telegramCfg?: RegisterTelegramNativeCommandsParams["telegramCfg"]; + telegramCfg?: NativeCommandTestParams["telegramCfg"]; resolveTelegramGroupConfig?: RegisterTelegramHandlerParams["resolveTelegramGroupConfig"]; }): { handler: TelegramCommandHandler; @@ -344,7 +269,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { it("calls recordSessionMetaFromInbound after a native slash command", async () => { const cfg: OpenClawConfig = {}; const { handler } = registerAndResolveStatusHandler({ cfg }); - await handler(buildStatusCommandContext()); + await handler(createTelegramPrivateCommandContext()); expect(sessionMocks.recordSessionMetaFromInbound).toHaveBeenCalledTimes(1); const call = ( @@ -363,7 +288,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { const cfg: OpenClawConfig = {}; const { handler } = registerAndResolveStatusHandler({ cfg }); - const runPromise = handler(buildStatusCommandContext()); + const runPromise = handler(createTelegramPrivateCommandContext()); await vi.waitFor(() => { expect(sessionMocks.recordSessionMetaFromInbound).toHaveBeenCalledTimes(1); @@ -402,7 +327,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { }, }, }); - await handler(buildStatusCommandContext()); + await handler(createTelegramPrivateCommandContext()); const deliveredCall = deliveryMocks.deliverReplies.mock.calls[0]?.[0] as | DeliverRepliesParams @@ -446,7 +371,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { }, }, }); - await handler(buildStatusCommandContext()); + await handler(createTelegramPrivateCommandContext()); expect(deliveryMocks.deliverReplies).not.toHaveBeenCalled(); }); @@ -463,7 +388,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { cfg: {}, telegramCfg: { silentErrorReplies: true }, }); - await handler(buildStatusCommandContext()); + await handler(createTelegramPrivateCommandContext()); const deliveredCall = deliveryMocks.deliverReplies.mock.calls[0]?.[0] as | DeliverRepliesParams @@ -491,7 +416,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { allowFrom: ["200"], groupAllowFrom: ["200"], }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); expect(persistentBindingMocks.resolveConfiguredAcpBindingRecord).toHaveBeenCalledTimes(1); expect(persistentBindingMocks.ensureConfiguredAcpBindingSession).toHaveBeenCalledTimes(1); @@ -519,7 +444,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { topicConfig: { agentId: "zu" }, }), }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); const dispatchCall = ( replyMocks.dispatchReplyWithBufferedBlockDispatcher.mock.calls as unknown as Array< @@ -542,7 +467,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { allowFrom: ["200"], groupAllowFrom: ["200"], }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); expect(sessionBindingMocks.resolveByConversation).toHaveBeenCalledWith({ channel: "telegram", @@ -577,7 +502,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { allowFrom: ["200"], groupAllowFrom: ["200"], }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); expect(replyMocks.dispatchReplyWithBufferedBlockDispatcher).not.toHaveBeenCalled(); expect(sendMessage).toHaveBeenCalledWith( @@ -604,7 +529,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { groupAllowFrom: [], useAccessGroups: true, }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); expectUnauthorizedNewCommandBlocked(sendMessage); }); @@ -619,7 +544,7 @@ describe("registerTelegramNativeCommands — session metadata", () => { groupAllowFrom: [], useAccessGroups: true, }); - await handler(buildStatusTopicCommandContext()); + await handler(createTelegramTopicCommandContext()); expectUnauthorizedNewCommandBlocked(sendMessage); }); diff --git a/extensions/telegram/src/bot-native-commands.test-helpers.ts b/extensions/telegram/src/bot-native-commands.test-helpers.ts index a39bdd23da6..f443040b17d 100644 --- a/extensions/telegram/src/bot-native-commands.test-helpers.ts +++ b/extensions/telegram/src/bot-native-commands.test-helpers.ts @@ -4,9 +4,12 @@ import type { TelegramAccountConfig } from "openclaw/plugin-sdk/config-runtime"; import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { vi } from "vitest"; +import { + createNativeCommandTestParams, + type NativeCommandTestParams, +} from "./bot-native-commands.fixture-test-support.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; -type RegisterTelegramNativeCommandsParams = Parameters[0]; type GetPluginCommandSpecsFn = typeof import("openclaw/plugin-sdk/plugin-runtime").getPluginCommandSpecs; type MatchPluginCommandFn = typeof import("openclaw/plugin-sdk/plugin-runtime").matchPluginCommand; @@ -89,48 +92,7 @@ vi.mock("./bot/delivery.js", () => ({ deliverReplies: deliveryMocks.deliverRepli vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ readChannelAllowFromStore: vi.fn(async () => []), })); - -export function createNativeCommandTestParams( - params: Partial = {}, -): RegisterTelegramNativeCommandsParams { - const log = vi.fn(); - return { - bot: - params.bot ?? - ({ - api: { - setMyCommands: vi.fn().mockResolvedValue(undefined), - sendMessage: vi.fn().mockResolvedValue(undefined), - }, - command: vi.fn(), - } as unknown as RegisterTelegramNativeCommandsParams["bot"]), - cfg: params.cfg ?? ({} as OpenClawConfig), - runtime: - params.runtime ?? ({ log } as unknown as RegisterTelegramNativeCommandsParams["runtime"]), - accountId: params.accountId ?? "default", - telegramCfg: params.telegramCfg ?? ({} as RegisterTelegramNativeCommandsParams["telegramCfg"]), - allowFrom: params.allowFrom ?? [], - groupAllowFrom: params.groupAllowFrom ?? [], - replyToMode: params.replyToMode ?? "off", - textLimit: params.textLimit ?? 4000, - useAccessGroups: params.useAccessGroups ?? false, - nativeEnabled: params.nativeEnabled ?? true, - nativeSkillsEnabled: params.nativeSkillsEnabled ?? false, - nativeDisabledExplicit: params.nativeDisabledExplicit ?? false, - resolveGroupPolicy: - params.resolveGroupPolicy ?? - (() => - ({ - allowlistEnabled: false, - allowed: true, - }) as ReturnType), - resolveTelegramGroupConfig: - params.resolveTelegramGroupConfig ?? - (() => ({ groupConfig: undefined, topicConfig: undefined })), - shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), - opts: params.opts ?? { token: "token" }, - }; -} +export { createNativeCommandTestParams }; export function createNativeCommandsHarness(params?: { cfg?: OpenClawConfig; @@ -158,7 +120,7 @@ export function createNativeCommandsHarness(params?: { } as const; registerTelegramNativeCommands({ - bot: bot as unknown as Parameters[0]["bot"], + bot: bot as unknown as NativeCommandTestParams["bot"], cfg: params?.cfg ?? ({} as OpenClawConfig), runtime: params?.runtime ?? ({ log } as unknown as RuntimeEnv), accountId: "default", From 7ab074631b5328385226ec50535b219fca7a6d69 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:38:07 +0000 Subject: [PATCH 034/187] refactor(setup): share allowlist wizard proxies --- extensions/discord/src/setup-core.ts | 12 +++++ extensions/slack/src/setup-core.ts | 11 ++++ src/channels/plugins/setup-wizard-proxy.ts | 61 ++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 src/channels/plugins/setup-wizard-proxy.ts diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 7cdf9aa2434..f9a9d95df4b 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -1,3 +1,5 @@ +import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; +import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { applyAccountNameToChannelSection, @@ -347,3 +349,13 @@ export function createDiscordSetupWizardProxy( disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } +export function createDiscordSetupWizardProxy( + loadWizard: () => Promise<{ discordSetupWizard: ChannelSetupWizard }>, +) { + return createAllowlistSetupWizardProxy({ + loadWizard: async () => (await loadWizard()).discordSetupWizard, + createBase: createDiscordSetupWizardBase, + fallbackResolvedGroupAllowlist: (entries) => + entries.map((input) => ({ input, resolved: false })), + }); +} diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 8fc53239c81..0b4c63c8b70 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,3 +1,5 @@ +import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; +import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, @@ -390,3 +392,12 @@ export function createSlackSetupWizardProxy( disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; } +export function createSlackSetupWizardProxy( + loadWizard: () => Promise<{ slackSetupWizard: ChannelSetupWizard }>, +) { + return createAllowlistSetupWizardProxy({ + loadWizard: async () => (await loadWizard()).slackSetupWizard, + createBase: createSlackSetupWizardBase, + fallbackResolvedGroupAllowlist: (entries) => entries, + }); +} diff --git a/src/channels/plugins/setup-wizard-proxy.ts b/src/channels/plugins/setup-wizard-proxy.ts new file mode 100644 index 00000000000..195254374cb --- /dev/null +++ b/src/channels/plugins/setup-wizard-proxy.ts @@ -0,0 +1,61 @@ +import type { OpenClawConfig } from "../../config/config.js"; +import type { ChannelSetupDmPolicy } from "./setup-wizard-types.js"; +import type { ChannelSetupWizard } from "./setup-wizard.js"; + +type PromptAllowFromParams = Parameters>[0]; +type ResolveAllowFromEntriesParams = Parameters< + NonNullable["resolveEntries"] +>[0]; +type ResolveAllowFromEntriesResult = Awaited< + ReturnType["resolveEntries"]> +>; +type ResolveGroupAllowlistParams = Parameters< + NonNullable["resolveAllowlist"]> +>[0]; + +export function createAllowlistSetupWizardProxy(params: { + loadWizard: () => Promise; + createBase: (handlers: { + promptAllowFrom: (params: PromptAllowFromParams) => Promise; + resolveAllowFromEntries: ( + params: ResolveAllowFromEntriesParams, + ) => Promise; + resolveGroupAllowlist: (params: ResolveGroupAllowlistParams) => Promise; + }) => ChannelSetupWizard; + fallbackResolvedGroupAllowlist: (entries: string[]) => TGroupResolved; +}) { + return params.createBase({ + promptAllowFrom: async ({ cfg, prompter, accountId }) => { + const wizard = await params.loadWizard(); + if (!wizard.dmPolicy?.promptAllowFrom) { + return cfg; + } + return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); + }, + resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => { + const wizard = await params.loadWizard(); + if (!wizard.allowFrom) { + return entries.map((input) => ({ input, resolved: false, id: null })); + } + return await wizard.allowFrom.resolveEntries({ + cfg, + accountId, + credentialValues, + entries, + }); + }, + resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { + const wizard = await params.loadWizard(); + if (!wizard.groupAccess?.resolveAllowlist) { + return params.fallbackResolvedGroupAllowlist(entries); + } + return (await wizard.groupAccess.resolveAllowlist({ + cfg, + accountId, + credentialValues, + entries, + prompter, + })) as TGroupResolved; + }, + }); +} From 23deb3da98a9c20b2799d0ce712f9f724fc95b2a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:41:39 +0000 Subject: [PATCH 035/187] refactor(discord): share native command plugin test setup --- .../native-command.plugin-dispatch.test.ts | 165 ++++++++---------- 1 file changed, 77 insertions(+), 88 deletions(-) diff --git a/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts b/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts index dc81bc72e00..4541ee3ab9d 100644 --- a/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts +++ b/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts @@ -80,6 +80,71 @@ function createStatusCommand(cfg: OpenClawConfig) { }); } +function createPluginCommand(params: { cfg: OpenClawConfig; name: string }) { + return createDiscordNativeCommand({ + command: { + name: params.name, + description: "Pair", + acceptsArgs: true, + } satisfies NativeCommandSpec, + cfg: params.cfg, + discordConfig: params.cfg.channels?.discord ?? {}, + accountId: "default", + sessionPrefix: "discord:slash", + ephemeralDefault: true, + threadBindings: createNoopThreadBindingManager("default"), + }); +} + +function registerPairPlugin(params?: { discordNativeName?: string }) { + expect( + registerPluginCommand("demo-plugin", { + name: "pair", + ...(params?.discordNativeName + ? { + nativeNames: { + telegram: "pair_device", + discord: params.discordNativeName, + }, + } + : {}), + description: "Pair device", + acceptsArgs: true, + requireAuth: false, + handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), + }), + ).toEqual({ ok: true }); +} + +async function expectPairCommandReply(params: { + cfg: OpenClawConfig; + commandName: string; + interaction: MockCommandInteraction; +}) { + const command = createPluginCommand({ + cfg: params.cfg, + name: params.commandName, + }); + const dispatchSpy = vi + .spyOn(dispatcherModule, "dispatchReplyWithDispatcher") + .mockResolvedValue({} as never); + + await (command as { run: (interaction: unknown) => Promise }).run( + Object.assign(params.interaction, { + options: { + getString: () => "now", + getBoolean: () => null, + getFocused: () => "", + }, + }) as unknown, + ); + + expect(dispatchSpy).not.toHaveBeenCalled(); + expect(params.interaction.reply).toHaveBeenCalledWith( + expect.objectContaining({ content: "paired:now" }), + ); +} + function setConfiguredBinding(channelId: string, boundSessionKey: string) { persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockReturnValue({ spec: { @@ -166,102 +231,26 @@ describe("Discord native plugin command dispatch", () => { it("executes plugin commands from the real registry through the native Discord command path", async () => { const cfg = createConfig(); - const commandSpec: NativeCommandSpec = { - name: "pair", - description: "Pair", - acceptsArgs: true, - }; - const command = createDiscordNativeCommand({ - command: commandSpec, - cfg, - discordConfig: cfg.channels?.discord ?? {}, - accountId: "default", - sessionPrefix: "discord:slash", - ephemeralDefault: true, - threadBindings: createNoopThreadBindingManager("default"), - }); const interaction = createInteraction(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); - - const dispatchSpy = vi - .spyOn(dispatcherModule, "dispatchReplyWithDispatcher") - .mockResolvedValue({} as never); - - await (command as { run: (interaction: unknown) => Promise }).run( - Object.assign(interaction, { - options: { - getString: () => "now", - getBoolean: () => null, - getFocused: () => "", - }, - }) as unknown, - ); - - expect(dispatchSpy).not.toHaveBeenCalled(); - expect(interaction.reply).toHaveBeenCalledWith( - expect.objectContaining({ content: "paired:now" }), - ); + registerPairPlugin(); + await expectPairCommandReply({ + cfg, + commandName: "pair", + interaction, + }); }); it("round-trips Discord native aliases through the real plugin registry", async () => { const cfg = createConfig(); - const commandSpec: NativeCommandSpec = { - name: "pairdiscord", - description: "Pair", - acceptsArgs: true, - }; - const command = createDiscordNativeCommand({ - command: commandSpec, - cfg, - discordConfig: cfg.channels?.discord ?? {}, - accountId: "default", - sessionPrefix: "discord:slash", - ephemeralDefault: true, - threadBindings: createNoopThreadBindingManager("default"), - }); const interaction = createInteraction(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - nativeNames: { - telegram: "pair_device", - discord: "pairdiscord", - }, - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); - - const dispatchSpy = vi - .spyOn(dispatcherModule, "dispatchReplyWithDispatcher") - .mockResolvedValue({} as never); - - await (command as { run: (interaction: unknown) => Promise }).run( - Object.assign(interaction, { - options: { - getString: () => "now", - getBoolean: () => null, - getFocused: () => "", - }, - }) as unknown, - ); - - expect(dispatchSpy).not.toHaveBeenCalled(); - expect(interaction.reply).toHaveBeenCalledWith( - expect.objectContaining({ content: "paired:now" }), - ); + registerPairPlugin({ discordNativeName: "pairdiscord" }); + await expectPairCommandReply({ + cfg, + commandName: "pairdiscord", + interaction, + }); }); it("blocks unauthorized Discord senders before requireAuth:false plugin commands execute", async () => { From 1dc3104dbf8fec8726f141f04f1f3f5a34b61052 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:48:37 +0000 Subject: [PATCH 036/187] fix(channels): restore shared module imports --- extensions/slack/src/channel.setup.ts | 8 ++------ extensions/slack/src/channel.ts | 8 ++------ extensions/telegram/src/channel.setup.ts | 8 ++++---- extensions/telegram/src/channel.ts | 12 ++++++------ 4 files changed, 14 insertions(+), 22 deletions(-) diff --git a/extensions/slack/src/channel.setup.ts b/extensions/slack/src/channel.setup.ts index 0eaf3053aa2..2fbaac93ab6 100644 --- a/extensions/slack/src/channel.setup.ts +++ b/extensions/slack/src/channel.setup.ts @@ -6,13 +6,9 @@ import { } from "openclaw/plugin-sdk/slack"; import { type ResolvedSlackAccount } from "./accounts.js"; import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; -import { - isSlackPluginAccountConfigured, - slackConfigAccessors, - slackConfigBase, - slackSetupWizard, -} from "./plugin-shared.js"; import { slackSetupAdapter } from "./setup-core.js"; +import { slackSetupWizard } from "./setup-surface.js"; +import { isSlackPluginAccountConfigured, slackConfigAccessors, slackConfigBase } from "./shared.js"; export const slackSetupPlugin: ChannelPlugin = { id: "slack", diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 4890ab88eaa..cdddeadebfe 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -44,17 +44,13 @@ import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; import { handleSlackMessageAction } from "./message-action-dispatch.js"; import { extractSlackToolSend, listSlackMessageActions } from "./message-actions.js"; import { normalizeAllowListLower } from "./monitor/allow-list.js"; -import { - isSlackPluginAccountConfigured, - slackConfigAccessors, - slackConfigBase, - slackSetupWizard, -} from "./plugin-shared.js"; import type { SlackProbe } from "./probe.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; import { getSlackRuntime } from "./runtime.js"; import { fetchSlackScopes } from "./scopes.js"; import { slackSetupAdapter } from "./setup-core.js"; +import { slackSetupWizard } from "./setup-surface.js"; +import { isSlackPluginAccountConfigured, slackConfigAccessors, slackConfigBase } from "./shared.js"; import { parseSlackTarget } from "./targets.js"; import { buildSlackThreadingToolContext } from "./threading-tool-context.js"; diff --git a/extensions/telegram/src/channel.setup.ts b/extensions/telegram/src/channel.setup.ts index 1da52dbe885..09b41cddb0f 100644 --- a/extensions/telegram/src/channel.setup.ts +++ b/extensions/telegram/src/channel.setup.ts @@ -5,15 +5,15 @@ import { type ChannelPlugin, } from "openclaw/plugin-sdk/telegram"; import { type ResolvedTelegramAccount } from "./accounts.js"; +import type { TelegramProbe } from "./probe.js"; +import { telegramSetupAdapter } from "./setup-core.js"; +import { telegramSetupWizard } from "./setup-surface.js"; import { findTelegramTokenOwnerAccountId, formatDuplicateTelegramTokenReason, telegramConfigAccessors, telegramConfigBase, -} from "./plugin-shared.js"; -import type { TelegramProbe } from "./probe.js"; -import { telegramSetupAdapter } from "./setup-core.js"; -import { telegramSetupWizard } from "./setup-surface.js"; +} from "./shared.js"; export const telegramSetupPlugin: ChannelPlugin = { id: "telegram", diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index e157ea34ba7..0054aaba6de 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -48,17 +48,17 @@ import { monitorTelegramProvider } from "./monitor.js"; import { looksLikeTelegramTargetId, normalizeTelegramMessagingTarget } from "./normalize.js"; import { sendTelegramPayloadMessages } from "./outbound-adapter.js"; import { parseTelegramReplyToMessageId, parseTelegramThreadId } from "./outbound-params.js"; -import { - findTelegramTokenOwnerAccountId, - formatDuplicateTelegramTokenReason, - telegramConfigAccessors, - telegramConfigBase, -} from "./plugin-shared.js"; import { probeTelegram, type TelegramProbe } from "./probe.js"; import { getTelegramRuntime } from "./runtime.js"; import { sendTypingTelegram } from "./send.js"; import { telegramSetupAdapter } from "./setup-core.js"; import { telegramSetupWizard } from "./setup-surface.js"; +import { + findTelegramTokenOwnerAccountId, + formatDuplicateTelegramTokenReason, + telegramConfigAccessors, + telegramConfigBase, +} from "./shared.js"; import { collectTelegramStatusIssues } from "./status-issues.js"; import { parseTelegramTarget } from "./targets.js"; From 503932919fc1075075dc6252a60234c1031d1f08 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:48:44 +0000 Subject: [PATCH 037/187] refactor(sandbox): share fs bridge path helpers --- src/agents/sandbox/remote-fs-bridge.ts | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/src/agents/sandbox/remote-fs-bridge.ts b/src/agents/sandbox/remote-fs-bridge.ts index ef70e928eac..878bdacc3c3 100644 --- a/src/agents/sandbox/remote-fs-bridge.ts +++ b/src/agents/sandbox/remote-fs-bridge.ts @@ -1,7 +1,12 @@ import path from "node:path"; +import { isPathInside } from "../../infra/path-guards.js"; import type { SandboxBackendCommandParams, SandboxBackendCommandResult } from "./backend.js"; import { SANDBOX_PINNED_MUTATION_PYTHON } from "./fs-bridge-mutation-helper.js"; import type { SandboxFsBridge, SandboxFsStat, SandboxResolvedPath } from "./fs-bridge.js"; +import { + isPathInsideContainerRoot, + normalizeContainerPath as normalizeSandboxContainerPath, +} from "./path-utils.js"; import type { SandboxContext } from "./types.js"; type ResolvedRemotePath = SandboxResolvedPath & { @@ -496,23 +501,10 @@ class RemoteShellSandboxFsBridge implements SandboxFsBridge { } function normalizeContainerPath(value: string): string { - const normalized = path.posix.normalize(value.trim() || "/"); + const normalized = normalizeSandboxContainerPath(value.trim() || "/"); return normalized.startsWith("/") ? normalized : `/${normalized}`; } -function isPathInsideContainerRoot(root: string, candidate: string): boolean { - const normalizedRoot = normalizeContainerPath(root); - const normalizedCandidate = normalizeContainerPath(candidate); - return ( - normalizedCandidate === normalizedRoot || normalizedCandidate.startsWith(`${normalizedRoot}/`) - ); -} - -function isPathInside(root: string, candidate: string): boolean { - const relative = path.relative(root, candidate); - return relative === "" || (!relative.startsWith("..") && !path.isAbsolute(relative)); -} - function toPosixRelative(root: string, candidate: string): string { return path.relative(root, candidate).split(path.sep).filter(Boolean).join(path.posix.sep); } From 7e9c46d7dd7f8a0070c99e1ab089091903d8cb17 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:50:59 +0000 Subject: [PATCH 038/187] refactor(whatsapp): share plugin base config --- extensions/whatsapp/src/channel.setup.ts | 151 +-------------------- extensions/whatsapp/src/channel.ts | 163 +++-------------------- extensions/whatsapp/src/plugin-shared.ts | 51 ------- extensions/whatsapp/src/shared.ts | 8 ++ 4 files changed, 30 insertions(+), 343 deletions(-) delete mode 100644 extensions/whatsapp/src/plugin-shared.ts diff --git a/extensions/whatsapp/src/channel.setup.ts b/extensions/whatsapp/src/channel.setup.ts index 6cf2a75d1ce..ebe4deb5789 100644 --- a/extensions/whatsapp/src/channel.setup.ts +++ b/extensions/whatsapp/src/channel.setup.ts @@ -1,150 +1,13 @@ -import { - buildAccountScopedDmSecurityPolicy, - buildChannelConfigSchema, - collectAllowlistProviderGroupPolicyWarnings, - collectOpenGroupPolicyRouteAllowlistWarnings, - DEFAULT_ACCOUNT_ID, - formatWhatsAppConfigAllowFromEntries, - getChatChannelMeta, - normalizeE164, - resolveWhatsAppConfigAllowFrom, - resolveWhatsAppConfigDefaultTo, - resolveWhatsAppGroupIntroHint, - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, - WhatsAppConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/whatsapp"; -import { - listWhatsAppAccountIds, - resolveDefaultWhatsAppAccountId, - resolveWhatsAppAccount, - type ResolvedWhatsAppAccount, -} from "./accounts.js"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/whatsapp"; +import { type ResolvedWhatsAppAccount } from "./accounts.js"; import { webAuthExists } from "./auth-store.js"; -import { whatsappSetupWizardProxy } from "./plugin-shared.js"; import { whatsappSetupAdapter } from "./setup-core.js"; +import { createWhatsAppPluginBase, whatsappSetupWizardProxy } from "./shared.js"; export const whatsappSetupPlugin: ChannelPlugin = { - id: "whatsapp", - meta: { - ...getChatChannelMeta("whatsapp"), - showConfigured: false, - quickstartAllowFrom: true, - forceAccountBinding: true, - preferSessionLookupForAnnounceTarget: true, - }, - setupWizard: whatsappSetupWizardProxy, - capabilities: { - chatTypes: ["direct", "group"], - polls: true, - reactions: true, - media: true, - }, - reload: { configPrefixes: ["web"], noopPrefixes: ["channels.whatsapp"] }, - gatewayMethods: ["web.login.start", "web.login.wait"], - configSchema: buildChannelConfigSchema(WhatsAppConfigSchema), - config: { - listAccountIds: (cfg) => listWhatsAppAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveWhatsAppAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultWhatsAppAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => { - const accountKey = accountId || DEFAULT_ACCOUNT_ID; - const accounts = { ...cfg.channels?.whatsapp?.accounts }; - const existing = accounts[accountKey] ?? {}; - return { - ...cfg, - channels: { - ...cfg.channels, - whatsapp: { - ...cfg.channels?.whatsapp, - accounts: { - ...accounts, - [accountKey]: { - ...existing, - enabled, - }, - }, - }, - }, - }; - }, - deleteAccount: ({ cfg, accountId }) => { - const accountKey = accountId || DEFAULT_ACCOUNT_ID; - const accounts = { ...cfg.channels?.whatsapp?.accounts }; - delete accounts[accountKey]; - return { - ...cfg, - channels: { - ...cfg.channels, - whatsapp: { - ...cfg.channels?.whatsapp, - accounts: Object.keys(accounts).length ? accounts : undefined, - }, - }, - }; - }, - isEnabled: (account, cfg) => account.enabled && cfg.web?.enabled !== false, - disabledReason: () => "disabled", + ...createWhatsAppPluginBase({ + setupWizard: whatsappSetupWizardProxy, + setup: whatsappSetupAdapter, isConfigured: async (account) => await webAuthExists(account.authDir), - unconfiguredReason: () => "not linked", - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: Boolean(account.authDir), - linked: Boolean(account.authDir), - dmPolicy: account.dmPolicy, - allowFrom: account.allowFrom, - }), - resolveAllowFrom: ({ cfg, accountId }) => resolveWhatsAppConfigAllowFrom({ cfg, accountId }), - formatAllowFrom: ({ allowFrom }) => formatWhatsAppConfigAllowFromEntries(allowFrom), - resolveDefaultTo: ({ cfg, accountId }) => resolveWhatsAppConfigDefaultTo({ cfg, accountId }), - }, - security: { - resolveDmPolicy: ({ cfg, accountId, account }) => - buildAccountScopedDmSecurityPolicy({ - cfg, - channelKey: "whatsapp", - accountId, - fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, - policy: account.dmPolicy, - allowFrom: account.allowFrom ?? [], - policyPathSuffix: "dmPolicy", - normalizeEntry: (raw) => normalizeE164(raw), - }), - collectWarnings: ({ account, cfg }) => { - const groupAllowlistConfigured = - Boolean(account.groups) && Object.keys(account.groups ?? {}).length > 0; - return collectAllowlistProviderGroupPolicyWarnings({ - cfg, - providerConfigPresent: cfg.channels?.whatsapp !== undefined, - configuredGroupPolicy: account.groupPolicy, - collect: (groupPolicy) => - collectOpenGroupPolicyRouteAllowlistWarnings({ - groupPolicy, - routeAllowlistConfigured: groupAllowlistConfigured, - restrictSenders: { - surface: "WhatsApp groups", - openScope: "any member in allowed groups", - groupPolicyPath: "channels.whatsapp.groupPolicy", - groupAllowFromPath: "channels.whatsapp.groupAllowFrom", - }, - noRouteAllowlist: { - surface: "WhatsApp groups", - routeAllowlistPath: "channels.whatsapp.groups", - routeScope: "group", - groupPolicyPath: "channels.whatsapp.groupPolicy", - groupAllowFromPath: "channels.whatsapp.groupAllowFrom", - }, - }), - }); - }, - }, - setup: whatsappSetupAdapter, - groups: { - resolveRequireMention: resolveWhatsAppGroupRequireMention, - resolveToolPolicy: resolveWhatsAppGroupToolPolicy, - resolveGroupIntroHint: resolveWhatsAppGroupIntroHint, - }, + }), }; diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index dda6215c27f..3bf9bba0c34 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -1,46 +1,30 @@ import { buildAccountScopedAllowlistConfigEditor } from "openclaw/plugin-sdk/allowlist-config-edit"; import { - buildAccountScopedDmSecurityPolicy, - buildChannelConfigSchema, - collectAllowlistProviderGroupPolicyWarnings, - collectOpenGroupPolicyRouteAllowlistWarnings, createActionGate, createWhatsAppOutboundBase, DEFAULT_ACCOUNT_ID, - getChatChannelMeta, listWhatsAppDirectoryGroupsFromConfig, listWhatsAppDirectoryPeersFromConfig, - normalizeE164, - formatWhatsAppConfigAllowFromEntries, readStringParam, resolveWhatsAppOutboundTarget, - resolveWhatsAppConfigAllowFrom, - resolveWhatsAppConfigDefaultTo, - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupIntroHint, - resolveWhatsAppGroupToolPolicy, resolveWhatsAppHeartbeatRecipients, resolveWhatsAppMentionStripRegexes, - WhatsAppConfigSchema, type ChannelMessageActionName, type ChannelPlugin, } from "openclaw/plugin-sdk/whatsapp"; import { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "openclaw/plugin-sdk/whatsapp"; // WhatsApp-specific imports from local extension code (moved from src/web/ and src/channels/plugins/) -import { - listWhatsAppAccountIds, - resolveDefaultWhatsAppAccountId, - resolveWhatsAppAccount, - type ResolvedWhatsAppAccount, -} from "./accounts.js"; +import { resolveWhatsAppAccount, type ResolvedWhatsAppAccount } from "./accounts.js"; import { looksLikeWhatsAppTargetId, normalizeWhatsAppMessagingTarget } from "./normalize.js"; -import { loadWhatsAppChannelRuntime, whatsappSetupWizardProxy } from "./plugin-shared.js"; import { getWhatsAppRuntime } from "./runtime.js"; import { whatsappSetupAdapter } from "./setup-core.js"; +import { + createWhatsAppPluginBase, + loadWhatsAppChannelRuntime, + whatsappSetupWizardProxy, + WHATSAPP_CHANNEL, +} from "./shared.js"; import { collectWhatsAppStatusIssues } from "./status-issues.js"; - -const meta = getChatChannelMeta("whatsapp"); - function normalizeWhatsAppPayloadText(text: string | undefined): string { return (text ?? "").replace(/^(?:[ \t]*\r?\n)+/, ""); } @@ -57,86 +41,16 @@ function parseWhatsAppExplicitTarget(raw: string) { } export const whatsappPlugin: ChannelPlugin = { - id: "whatsapp", - meta: { - ...meta, - showConfigured: false, - quickstartAllowFrom: true, - forceAccountBinding: true, - preferSessionLookupForAnnounceTarget: true, - }, - setupWizard: whatsappSetupWizardProxy, + ...createWhatsAppPluginBase({ + setupWizard: whatsappSetupWizardProxy, + setup: whatsappSetupAdapter, + isConfigured: async (account) => + await getWhatsAppRuntime().channel.whatsapp.webAuthExists(account.authDir), + }), agentTools: () => [getWhatsAppRuntime().channel.whatsapp.createLoginTool()], pairing: { idLabel: "whatsappSenderId", }, - capabilities: { - chatTypes: ["direct", "group"], - polls: true, - reactions: true, - media: true, - }, - reload: { configPrefixes: ["web"], noopPrefixes: ["channels.whatsapp"] }, - gatewayMethods: ["web.login.start", "web.login.wait"], - configSchema: buildChannelConfigSchema(WhatsAppConfigSchema), - config: { - listAccountIds: (cfg) => listWhatsAppAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveWhatsAppAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultWhatsAppAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => { - const accountKey = accountId || DEFAULT_ACCOUNT_ID; - const accounts = { ...cfg.channels?.whatsapp?.accounts }; - const existing = accounts[accountKey] ?? {}; - return { - ...cfg, - channels: { - ...cfg.channels, - whatsapp: { - ...cfg.channels?.whatsapp, - accounts: { - ...accounts, - [accountKey]: { - ...existing, - enabled, - }, - }, - }, - }, - }; - }, - deleteAccount: ({ cfg, accountId }) => { - const accountKey = accountId || DEFAULT_ACCOUNT_ID; - const accounts = { ...cfg.channels?.whatsapp?.accounts }; - delete accounts[accountKey]; - return { - ...cfg, - channels: { - ...cfg.channels, - whatsapp: { - ...cfg.channels?.whatsapp, - accounts: Object.keys(accounts).length ? accounts : undefined, - }, - }, - }; - }, - isEnabled: (account, cfg) => account.enabled && cfg.web?.enabled !== false, - disabledReason: () => "disabled", - isConfigured: async (account) => - await getWhatsAppRuntime().channel.whatsapp.webAuthExists(account.authDir), - unconfiguredReason: () => "not linked", - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: Boolean(account.authDir), - linked: Boolean(account.authDir), - dmPolicy: account.dmPolicy, - allowFrom: account.allowFrom, - }), - resolveAllowFrom: ({ cfg, accountId }) => resolveWhatsAppConfigAllowFrom({ cfg, accountId }), - formatAllowFrom: ({ allowFrom }) => formatWhatsAppConfigAllowFromEntries(allowFrom), - resolveDefaultTo: ({ cfg, accountId }) => resolveWhatsAppConfigDefaultTo({ cfg, accountId }), - }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { @@ -157,53 +71,6 @@ export const whatsappPlugin: ChannelPlugin = { }), }), }, - security: { - resolveDmPolicy: ({ cfg, accountId, account }) => { - return buildAccountScopedDmSecurityPolicy({ - cfg, - channelKey: "whatsapp", - accountId, - fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, - policy: account.dmPolicy, - allowFrom: account.allowFrom ?? [], - policyPathSuffix: "dmPolicy", - normalizeEntry: (raw) => normalizeE164(raw), - }); - }, - collectWarnings: ({ account, cfg }) => { - const groupAllowlistConfigured = - Boolean(account.groups) && Object.keys(account.groups ?? {}).length > 0; - return collectAllowlistProviderGroupPolicyWarnings({ - cfg, - providerConfigPresent: cfg.channels?.whatsapp !== undefined, - configuredGroupPolicy: account.groupPolicy, - collect: (groupPolicy) => - collectOpenGroupPolicyRouteAllowlistWarnings({ - groupPolicy, - routeAllowlistConfigured: groupAllowlistConfigured, - restrictSenders: { - surface: "WhatsApp groups", - openScope: "any member in allowed groups", - groupPolicyPath: "channels.whatsapp.groupPolicy", - groupAllowFromPath: "channels.whatsapp.groupAllowFrom", - }, - noRouteAllowlist: { - surface: "WhatsApp groups", - routeAllowlistPath: "channels.whatsapp.groups", - routeScope: "group", - groupPolicyPath: "channels.whatsapp.groupPolicy", - groupAllowFromPath: "channels.whatsapp.groupAllowFrom", - }, - }), - }); - }, - }, - setup: whatsappSetupAdapter, - groups: { - resolveRequireMention: resolveWhatsAppGroupRequireMention, - resolveToolPolicy: resolveWhatsAppGroupToolPolicy, - resolveGroupIntroHint: resolveWhatsAppGroupIntroHint, - }, mentions: { stripRegexes: ({ ctx }) => resolveWhatsAppMentionStripRegexes(ctx), }, @@ -256,7 +123,7 @@ export const whatsappPlugin: ChannelPlugin = { supportsAction: ({ action }) => action === "react", handleAction: async ({ action, params, cfg, accountId }) => { if (action !== "react") { - throw new Error(`Action ${action} is not supported for provider ${meta.id}.`); + throw new Error(`Action ${action} is not supported for provider ${WHATSAPP_CHANNEL}.`); } const messageId = readStringParam(params, "messageId", { required: true, @@ -297,7 +164,7 @@ export const whatsappPlugin: ChannelPlugin = { }, auth: { login: async ({ cfg, accountId, runtime, verbose }) => { - const resolvedAccountId = accountId?.trim() || resolveDefaultWhatsAppAccountId(cfg); + const resolvedAccountId = accountId?.trim() || whatsappPlugin.config.defaultAccountId(cfg); await ( await loadWhatsAppChannelRuntime() ).loginWeb(Boolean(verbose), undefined, runtime, resolvedAccountId); diff --git a/extensions/whatsapp/src/plugin-shared.ts b/extensions/whatsapp/src/plugin-shared.ts deleted file mode 100644 index fee78e620a4..00000000000 --- a/extensions/whatsapp/src/plugin-shared.ts +++ /dev/null @@ -1,51 +0,0 @@ -import type { ChannelPlugin } from "openclaw/plugin-sdk/whatsapp"; -import { type ResolvedWhatsAppAccount } from "./accounts.js"; - -export async function loadWhatsAppChannelRuntime() { - return await import("./channel.runtime.js"); -} - -export const whatsappSetupWizardProxy = { - channel: "whatsapp", - status: { - configuredLabel: "linked", - unconfiguredLabel: "not linked", - configuredHint: "linked", - unconfiguredHint: "not linked", - configuredScore: 5, - unconfiguredScore: 4, - resolveConfigured: async ({ cfg }) => - await ( - await loadWhatsAppChannelRuntime() - ).whatsappSetupWizard.status.resolveConfigured({ - cfg, - }), - resolveStatusLines: async ({ cfg, configured }) => - (await ( - await loadWhatsAppChannelRuntime() - ).whatsappSetupWizard.status.resolveStatusLines?.({ - cfg, - configured, - })) ?? [], - }, - resolveShouldPromptAccountIds: (params) => - (params.shouldPromptAccountIds || params.options?.promptWhatsAppAccountId) ?? false, - credentials: [], - finalize: async (params) => - await ( - await loadWhatsAppChannelRuntime() - ).whatsappSetupWizard.finalize!(params), - disable: (cfg) => ({ - ...cfg, - channels: { - ...cfg.channels, - whatsapp: { - ...cfg.channels?.whatsapp, - enabled: false, - }, - }, - }), - onAccountRecorded: (accountId, options) => { - options?.onWhatsAppAccountId?.(accountId); - }, -} satisfies NonNullable["setupWizard"]>; diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 3a8f7412e7e..43df9bd7e6a 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -24,6 +24,14 @@ import { export const WHATSAPP_CHANNEL = "whatsapp" as const; +export async function loadWhatsAppChannelRuntime() { + return await import("./channel.runtime.js"); +} + +export const whatsappSetupWizardProxy = createWhatsAppSetupWizardProxy(async () => ({ + whatsappSetupWizard: (await loadWhatsAppChannelRuntime()).whatsappSetupWizard, +})); + export function createWhatsAppSetupWizardProxy( loadWizard: () => Promise<{ whatsappSetupWizard: NonNullable["setupWizard"]>; From e820c255bc79308dd1098246bdbac54a9b16bfe7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:52:25 +0000 Subject: [PATCH 039/187] refactor(telegram): share plugin base config --- extensions/telegram/src/channel.setup.ts | 68 +++--------------------- extensions/telegram/src/channel.ts | 60 ++------------------- 2 files changed, 11 insertions(+), 117 deletions(-) diff --git a/extensions/telegram/src/channel.setup.ts b/extensions/telegram/src/channel.setup.ts index 09b41cddb0f..4879ef96c09 100644 --- a/extensions/telegram/src/channel.setup.ts +++ b/extensions/telegram/src/channel.setup.ts @@ -1,69 +1,13 @@ -import { - buildChannelConfigSchema, - getChatChannelMeta, - TelegramConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/telegram"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/telegram"; import { type ResolvedTelegramAccount } from "./accounts.js"; import type { TelegramProbe } from "./probe.js"; import { telegramSetupAdapter } from "./setup-core.js"; import { telegramSetupWizard } from "./setup-surface.js"; -import { - findTelegramTokenOwnerAccountId, - formatDuplicateTelegramTokenReason, - telegramConfigAccessors, - telegramConfigBase, -} from "./shared.js"; +import { createTelegramPluginBase } from "./shared.js"; export const telegramSetupPlugin: ChannelPlugin = { - id: "telegram", - meta: { - ...getChatChannelMeta("telegram"), - quickstartAllowFrom: true, - }, - setupWizard: telegramSetupWizard, - capabilities: { - chatTypes: ["direct", "group", "channel", "thread"], - reactions: true, - threads: true, - media: true, - polls: true, - nativeCommands: true, - blockStreaming: true, - }, - reload: { configPrefixes: ["channels.telegram"] }, - configSchema: buildChannelConfigSchema(TelegramConfigSchema), - config: { - ...telegramConfigBase, - isConfigured: (account, cfg) => { - if (!account.token?.trim()) { - return false; - } - return !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); - }, - unconfiguredReason: (account, cfg) => { - if (!account.token?.trim()) { - return "not configured"; - } - const ownerAccountId = findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); - if (!ownerAccountId) { - return "not configured"; - } - return formatDuplicateTelegramTokenReason({ - accountId: account.accountId, - ownerAccountId, - }); - }, - describeAccount: (account, cfg) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: - Boolean(account.token?.trim()) && - !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }), - tokenSource: account.tokenSource, - }), - ...telegramConfigAccessors, - }, - setup: telegramSetupAdapter, + ...createTelegramPluginBase({ + setupWizard: telegramSetupWizard, + setup: telegramSetupAdapter, + }), }; diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index 0054aaba6de..ebd8ddc2c24 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -15,11 +15,9 @@ import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-run import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; import { parseTelegramTopicConversation } from "openclaw/plugin-sdk/telegram"; import { - buildChannelConfigSchema, buildTokenChannelStatusSummary, clearAccountEntryFields, DEFAULT_ACCOUNT_ID, - getChatChannelMeta, listTelegramDirectoryGroupsFromConfig, listTelegramDirectoryPeersFromConfig, PAIRING_APPROVED_MESSAGE, @@ -27,7 +25,6 @@ import { resolveConfiguredFromCredentialStatuses, resolveTelegramGroupRequireMention, resolveTelegramGroupToolPolicy, - TelegramConfigSchema, type ChannelPlugin, type ChannelMessageActionAdapter, type OpenClawConfig, @@ -54,10 +51,10 @@ import { sendTypingTelegram } from "./send.js"; import { telegramSetupAdapter } from "./setup-core.js"; import { telegramSetupWizard } from "./setup-surface.js"; import { + createTelegramPluginBase, findTelegramTokenOwnerAccountId, formatDuplicateTelegramTokenReason, telegramConfigAccessors, - telegramConfigBase, } from "./shared.js"; import { collectTelegramStatusIssues } from "./status-issues.js"; import { parseTelegramTarget } from "./targets.js"; @@ -66,8 +63,6 @@ type TelegramSendFn = ReturnType< typeof getTelegramRuntime >["channel"]["telegram"]["sendMessageTelegram"]; -const meta = getChatChannelMeta("telegram"); - type TelegramSendOptions = NonNullable[2]>; function buildTelegramSendOptions(params: { @@ -324,12 +319,10 @@ function readTelegramAllowlistConfig(account: ResolvedTelegramAccount) { } export const telegramPlugin: ChannelPlugin = { - id: "telegram", - meta: { - ...meta, - quickstartAllowFrom: true, - }, - setupWizard: telegramSetupWizard, + ...createTelegramPluginBase({ + setupWizard: telegramSetupWizard, + setup: telegramSetupAdapter, + }), pairing: { idLabel: "telegramUserId", normalizeAllowEntry: (entry) => entry.replace(/^(telegram|tg):/i, ""), @@ -347,49 +340,6 @@ export const telegramPlugin: ChannelPlugin { - if (!account.token?.trim()) { - return false; - } - return !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); - }, - unconfiguredReason: (account, cfg) => { - if (!account.token?.trim()) { - return "not configured"; - } - const ownerAccountId = findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }); - if (!ownerAccountId) { - return "not configured"; - } - return formatDuplicateTelegramTokenReason({ - accountId: account.accountId, - ownerAccountId, - }); - }, - describeAccount: (account, cfg) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: - Boolean(account.token?.trim()) && - !findTelegramTokenOwnerAccountId({ cfg, accountId: account.accountId }), - tokenSource: account.tokenSource, - }), - ...telegramConfigAccessors, - }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => From 21bc5a90eced9596da7e7fee317b40c0318a5f51 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:55:00 +0000 Subject: [PATCH 040/187] fix(slack): restore setup wizard base export --- extensions/slack/src/setup-core.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 0b4c63c8b70..3da152d2f37 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,5 +1,3 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, @@ -22,6 +20,8 @@ import { type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "../../../src/terminal/links.js"; +import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; +import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { @@ -112,7 +112,7 @@ export const slackSetupAdapter: ChannelSetupAdapter = { }, }; -export function createSlackSetupWizardProxy( +export function createSlackSetupWizardBase( loadWizard: () => Promise<{ slackSetupWizard: ChannelSetupWizard }>, ) { const slackDmPolicy: ChannelSetupDmPolicy = { From f3da2920974634b2cf2c391ec93ef66c99609a13 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:55:07 +0000 Subject: [PATCH 041/187] refactor(slack): share plugin base config --- extensions/slack/src/channel.setup.ts | 57 +++----------------------- extensions/slack/src/channel.ts | 59 +++++---------------------- 2 files changed, 17 insertions(+), 99 deletions(-) diff --git a/extensions/slack/src/channel.setup.ts b/extensions/slack/src/channel.setup.ts index 2fbaac93ab6..854e1782315 100644 --- a/extensions/slack/src/channel.setup.ts +++ b/extensions/slack/src/channel.setup.ts @@ -1,57 +1,12 @@ -import { - buildChannelConfigSchema, - getChatChannelMeta, - SlackConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/slack"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/slack"; import { type ResolvedSlackAccount } from "./accounts.js"; -import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; import { slackSetupAdapter } from "./setup-core.js"; import { slackSetupWizard } from "./setup-surface.js"; -import { isSlackPluginAccountConfigured, slackConfigAccessors, slackConfigBase } from "./shared.js"; +import { createSlackPluginBase } from "./shared.js"; export const slackSetupPlugin: ChannelPlugin = { - id: "slack", - meta: { - ...getChatChannelMeta("slack"), - preferSessionLookupForAnnounceTarget: true, - }, - setupWizard: slackSetupWizard, - capabilities: { - chatTypes: ["direct", "channel", "thread"], - reactions: true, - threads: true, - media: true, - nativeCommands: true, - }, - agentPrompt: { - messageToolHints: ({ cfg, accountId }) => - isSlackInteractiveRepliesEnabled({ cfg, accountId }) - ? [ - "- Slack interactive replies: use `[[slack_buttons: Label:value, Other:other]]` to add action buttons that route clicks back as Slack interaction system events.", - "- Slack selects: use `[[slack_select: Placeholder | Label:value, Other:other]]` to add a static select menu that routes the chosen value back as a Slack interaction system event.", - ] - : [ - "- Slack interactive replies are disabled. If needed, ask to set `channels.slack.capabilities.interactiveReplies=true` (or the same under `channels.slack.accounts..capabilities`).", - ], - }, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.slack"] }, - configSchema: buildChannelConfigSchema(SlackConfigSchema), - config: { - ...slackConfigBase, - isConfigured: (account) => isSlackPluginAccountConfigured(account), - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: isSlackPluginAccountConfigured(account), - botTokenSource: account.botTokenSource, - appTokenSource: account.appTokenSource, - }), - ...slackConfigAccessors, - }, - setup: slackSetupAdapter, + ...createSlackPluginBase({ + setupWizard: slackSetupWizard, + setup: slackSetupAdapter, + }), }; diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index cdddeadebfe..66e640e1bcf 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -15,9 +15,7 @@ import { } from "openclaw/plugin-sdk/core"; import { buildComputedAccountStatusSnapshot, - buildChannelConfigSchema, DEFAULT_ACCOUNT_ID, - getChatChannelMeta, listSlackDirectoryGroupsFromConfig, listSlackDirectoryPeersFromConfig, looksLikeSlackTargetId, @@ -27,7 +25,6 @@ import { resolveConfiguredFromRequiredCredentialStatuses, resolveSlackGroupRequireMention, resolveSlackGroupToolPolicy, - SlackConfigSchema, type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/slack"; @@ -50,11 +47,15 @@ import { getSlackRuntime } from "./runtime.js"; import { fetchSlackScopes } from "./scopes.js"; import { slackSetupAdapter } from "./setup-core.js"; import { slackSetupWizard } from "./setup-surface.js"; -import { isSlackPluginAccountConfigured, slackConfigAccessors, slackConfigBase } from "./shared.js"; +import { + createSlackPluginBase, + isSlackPluginAccountConfigured, + slackConfigAccessors, + SLACK_CHANNEL, +} from "./shared.js"; import { parseSlackTarget } from "./targets.js"; import { buildSlackThreadingToolContext } from "./threading-tool-context.js"; -const meta = getChatChannelMeta("slack"); const SLACK_CHANNEL_TYPE_CACHE = new Map(); // Select the appropriate Slack token for read/write operations. @@ -329,12 +330,10 @@ async function resolveSlackAllowlistNames(params: { } export const slackPlugin: ChannelPlugin = { - id: "slack", - meta: { - ...meta, - preferSessionLookupForAnnounceTarget: true, - }, - setupWizard: slackSetupWizard, + ...createSlackPluginBase({ + setupWizard: slackSetupWizard, + setup: slackSetupAdapter, + }), pairing: { idLabel: "slackUserId", normalizeAllowEntry: (entry) => entry.replace(/^(slack|user):/i, ""), @@ -363,42 +362,6 @@ export const slackPlugin: ChannelPlugin = { } }, }, - capabilities: { - chatTypes: ["direct", "channel", "thread"], - reactions: true, - threads: true, - media: true, - nativeCommands: true, - }, - agentPrompt: { - messageToolHints: ({ cfg, accountId }) => - isSlackInteractiveRepliesEnabled({ cfg, accountId }) - ? [ - "- Slack interactive replies: use `[[slack_buttons: Label:value, Other:other]]` to add action buttons that route clicks back as Slack interaction system events.", - "- Slack selects: use `[[slack_select: Placeholder | Label:value, Other:other]]` to add a static select menu that routes the chosen value back as a Slack interaction system event.", - ] - : [ - "- Slack interactive replies are disabled. If needed, ask to set `channels.slack.capabilities.interactiveReplies=true` (or the same under `channels.slack.accounts..capabilities`).", - ], - }, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.slack"] }, - configSchema: buildChannelConfigSchema(SlackConfigSchema), - config: { - ...slackConfigBase, - isConfigured: (account) => isSlackPluginAccountConfigured(account), - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: isSlackPluginAccountConfigured(account), - botTokenSource: account.botTokenSource, - appTokenSource: account.appTokenSource, - }), - ...slackConfigAccessors, - }, allowlist: { supportsScope: ({ scope }) => scope === "dm", readConfig: ({ cfg, accountId }) => @@ -561,7 +524,7 @@ export const slackPlugin: ChannelPlugin = { extractToolSend: ({ args }) => extractSlackToolSend(args), handleAction: async (ctx) => await handleSlackMessageAction({ - providerId: meta.id, + providerId: SLACK_CHANNEL, ctx, includeReadThreadId: true, invoke: async (action, cfg, toolContext) => From 423f1e994e0c68fbe7e7e4e84175cc1b44dbe260 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:56:38 +0000 Subject: [PATCH 042/187] refactor(signal): share plugin base config --- extensions/signal/src/channel.setup.ts | 69 +++----------------------- extensions/signal/src/channel.ts | 62 +++-------------------- 2 files changed, 13 insertions(+), 118 deletions(-) diff --git a/extensions/signal/src/channel.setup.ts b/extensions/signal/src/channel.setup.ts index b81d10cc99d..f3f8ea9bef2 100644 --- a/extensions/signal/src/channel.setup.ts +++ b/extensions/signal/src/channel.setup.ts @@ -2,70 +2,16 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, - getChatChannelMeta, - normalizeE164, - setAccountEnabledInConfigSection, - SignalConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/signal"; -import { - listSignalAccountIds, - resolveDefaultSignalAccountId, - resolveSignalAccount, - type ResolvedSignalAccount, -} from "./accounts.js"; -import { signalConfigAccessors, signalSetupWizard } from "./plugin-shared.js"; +import { DEFAULT_ACCOUNT_ID, normalizeE164, type ChannelPlugin } from "openclaw/plugin-sdk/signal"; +import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; import { signalSetupAdapter } from "./setup-core.js"; +import { createSignalPluginBase, signalSetupWizard } from "./shared.js"; export const signalSetupPlugin: ChannelPlugin = { - id: "signal", - meta: { - ...getChatChannelMeta("signal"), - }, - setupWizard: signalSetupWizard, - capabilities: { - chatTypes: ["direct", "group"], - media: true, - reactions: true, - }, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.signal"] }, - configSchema: buildChannelConfigSchema(SignalConfigSchema), - config: { - listAccountIds: (cfg) => listSignalAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveSignalAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultSignalAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => - setAccountEnabledInConfigSection({ - cfg, - sectionKey: "signal", - accountId, - enabled, - allowTopLevel: true, - }), - deleteAccount: ({ cfg, accountId }) => - deleteAccountFromConfigSection({ - cfg, - sectionKey: "signal", - accountId, - clearBaseFields: ["account", "httpUrl", "httpHost", "httpPort", "cliPath", "name"], - }), - isConfigured: (account) => account.configured, - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: account.configured, - baseUrl: account.baseUrl, - }), - ...signalConfigAccessors, - }, + ...createSignalPluginBase({ + setupWizard: signalSetupWizard, + setup: signalSetupAdapter, + }), security: { resolveDmPolicy: ({ cfg, accountId, account }) => buildAccountScopedDmSecurityPolicy({ @@ -90,5 +36,4 @@ export const signalSetupPlugin: ChannelPlugin = { mentionGated: false, }), }, - setup: signalSetupAdapter, }; diff --git a/extensions/signal/src/channel.ts b/extensions/signal/src/channel.ts index aba60d3e29a..bd0085e9dfd 100644 --- a/extensions/signal/src/channel.ts +++ b/extensions/signal/src/channel.ts @@ -10,28 +10,18 @@ import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; import { buildBaseAccountStatusSnapshot, buildBaseChannelStatusSummary, - buildChannelConfigSchema, collectStatusIssuesFromLastError, createDefaultChannelRuntimeState, DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, - getChatChannelMeta, looksLikeSignalTargetId, normalizeE164, normalizeSignalMessagingTarget, PAIRING_APPROVED_MESSAGE, resolveChannelMediaMaxBytes, - setAccountEnabledInConfigSection, - SignalConfigSchema, type ChannelMessageActionAdapter, type ChannelPlugin, } from "openclaw/plugin-sdk/signal"; -import { - listSignalAccountIds, - resolveDefaultSignalAccountId, - resolveSignalAccount, - type ResolvedSignalAccount, -} from "./accounts.js"; +import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; import { markdownToSignalTextChunks } from "./format.js"; import { looksLikeUuid, @@ -39,10 +29,10 @@ import { resolveSignalRecipient, resolveSignalSender, } from "./identity.js"; -import { signalConfigAccessors, signalSetupWizard } from "./plugin-shared.js"; import type { SignalProbe } from "./probe.js"; import { getSignalRuntime } from "./runtime.js"; import { signalSetupAdapter } from "./setup-core.js"; +import { createSignalPluginBase, signalConfigAccessors, signalSetupWizard } from "./shared.js"; const signalMessageActions: ChannelMessageActionAdapter = { listActions: (ctx) => getSignalRuntime().channel.signal.messageActions?.listActions?.(ctx) ?? [], @@ -292,11 +282,10 @@ async function sendFormattedSignalMedia(ctx: { } export const signalPlugin: ChannelPlugin = { - id: "signal", - meta: { - ...getChatChannelMeta("signal"), - }, - setupWizard: signalSetupWizard, + ...createSignalPluginBase({ + setupWizard: signalSetupWizard, + setup: signalSetupAdapter, + }), pairing: { idLabel: "signalNumber", normalizeAllowEntry: (entry) => entry.replace(/^signal:/i, ""), @@ -304,46 +293,7 @@ export const signalPlugin: ChannelPlugin = { await getSignalRuntime().channel.signal.sendMessageSignal(id, PAIRING_APPROVED_MESSAGE); }, }, - capabilities: { - chatTypes: ["direct", "group"], - media: true, - reactions: true, - }, actions: signalMessageActions, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.signal"] }, - configSchema: buildChannelConfigSchema(SignalConfigSchema), - config: { - listAccountIds: (cfg) => listSignalAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveSignalAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultSignalAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => - setAccountEnabledInConfigSection({ - cfg, - sectionKey: "signal", - accountId, - enabled, - allowTopLevel: true, - }), - deleteAccount: ({ cfg, accountId }) => - deleteAccountFromConfigSection({ - cfg, - sectionKey: "signal", - accountId, - clearBaseFields: ["account", "httpUrl", "httpHost", "httpPort", "cliPath", "name"], - }), - isConfigured: (account) => account.configured, - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: account.configured, - baseUrl: account.baseUrl, - }), - ...signalConfigAccessors, - }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { From e36f16e750ef08d652dd692d137636672e8f80c9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:57:46 +0000 Subject: [PATCH 043/187] refactor(imessage): share plugin base config --- extensions/imessage/src/channel.setup.ts | 70 +++--------------------- extensions/imessage/src/channel.ts | 66 ++-------------------- 2 files changed, 13 insertions(+), 123 deletions(-) diff --git a/extensions/imessage/src/channel.setup.ts b/extensions/imessage/src/channel.setup.ts index 0590eba9356..df0750a4284 100644 --- a/extensions/imessage/src/channel.setup.ts +++ b/extensions/imessage/src/channel.setup.ts @@ -2,71 +2,16 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, - formatTrimmedAllowFromEntries, - getChatChannelMeta, - IMessageConfigSchema, - resolveIMessageConfigAllowFrom, - resolveIMessageConfigDefaultTo, - setAccountEnabledInConfigSection, - type ChannelPlugin, -} from "openclaw/plugin-sdk/imessage"; -import { - listIMessageAccountIds, - resolveDefaultIMessageAccountId, - resolveIMessageAccount, - type ResolvedIMessageAccount, -} from "./accounts.js"; -import { imessageSetupWizard } from "./plugin-shared.js"; +import { DEFAULT_ACCOUNT_ID, type ChannelPlugin } from "openclaw/plugin-sdk/imessage"; +import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; import { imessageSetupAdapter } from "./setup-core.js"; +import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; export const imessageSetupPlugin: ChannelPlugin = { - id: "imessage", - meta: { - ...getChatChannelMeta("imessage"), - aliases: ["imsg"], - showConfigured: false, - }, - setupWizard: imessageSetupWizard, - capabilities: { - chatTypes: ["direct", "group"], - media: true, - }, - reload: { configPrefixes: ["channels.imessage"] }, - configSchema: buildChannelConfigSchema(IMessageConfigSchema), - config: { - listAccountIds: (cfg) => listIMessageAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveIMessageAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultIMessageAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => - setAccountEnabledInConfigSection({ - cfg, - sectionKey: "imessage", - accountId, - enabled, - allowTopLevel: true, - }), - deleteAccount: ({ cfg, accountId }) => - deleteAccountFromConfigSection({ - cfg, - sectionKey: "imessage", - accountId, - clearBaseFields: ["cliPath", "dbPath", "service", "region", "name"], - }), - isConfigured: (account) => account.configured, - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: account.configured, - }), - resolveAllowFrom: ({ cfg, accountId }) => resolveIMessageConfigAllowFrom({ cfg, accountId }), - formatAllowFrom: ({ allowFrom }) => formatTrimmedAllowFromEntries(allowFrom), - resolveDefaultTo: ({ cfg, accountId }) => resolveIMessageConfigDefaultTo({ cfg, accountId }), - }, + ...createIMessagePluginBase({ + setupWizard: imessageSetupWizard, + setup: imessageSetupAdapter, + }), security: { resolveDmPolicy: ({ cfg, accountId, account }) => buildAccountScopedDmSecurityPolicy({ @@ -90,5 +35,4 @@ export const imessageSetupPlugin: ChannelPlugin = { mentionGated: false, }), }, - setup: imessageSetupAdapter, }; diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index 5e3d48817a0..bf7e6585d6c 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -6,38 +6,23 @@ import { import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; import { - buildChannelConfigSchema, collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, - formatTrimmedAllowFromEntries, - getChatChannelMeta, - IMessageConfigSchema, looksLikeIMessageTargetId, normalizeIMessageMessagingTarget, PAIRING_APPROVED_MESSAGE, resolveChannelMediaMaxBytes, - resolveIMessageConfigAllowFrom, - resolveIMessageConfigDefaultTo, resolveIMessageGroupRequireMention, resolveIMessageGroupToolPolicy, - setAccountEnabledInConfigSection, type ChannelPlugin, } from "openclaw/plugin-sdk/imessage"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; -import { - listIMessageAccountIds, - resolveDefaultIMessageAccountId, - resolveIMessageAccount, - type ResolvedIMessageAccount, -} from "./accounts.js"; -import { imessageSetupWizard } from "./plugin-shared.js"; +import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; import { getIMessageRuntime } from "./runtime.js"; import { imessageSetupAdapter } from "./setup-core.js"; +import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; import { normalizeIMessageHandle, parseIMessageTarget } from "./targets.js"; -const meta = getChatChannelMeta("imessage"); - type IMessageSendFn = ReturnType< typeof getIMessageRuntime >["channel"]["imessage"]["sendMessageIMessage"]; @@ -150,55 +135,16 @@ function resolveIMessageOutboundSessionRoute(params: { } export const imessagePlugin: ChannelPlugin = { - id: "imessage", - meta: { - ...meta, - aliases: ["imsg"], - showConfigured: false, - }, - setupWizard: imessageSetupWizard, + ...createIMessagePluginBase({ + setupWizard: imessageSetupWizard, + setup: imessageSetupAdapter, + }), pairing: { idLabel: "imessageSenderId", notifyApproval: async ({ id }) => { await getIMessageRuntime().channel.imessage.sendMessageIMessage(id, PAIRING_APPROVED_MESSAGE); }, }, - capabilities: { - chatTypes: ["direct", "group"], - media: true, - }, - reload: { configPrefixes: ["channels.imessage"] }, - configSchema: buildChannelConfigSchema(IMessageConfigSchema), - config: { - listAccountIds: (cfg) => listIMessageAccountIds(cfg), - resolveAccount: (cfg, accountId) => resolveIMessageAccount({ cfg, accountId }), - defaultAccountId: (cfg) => resolveDefaultIMessageAccountId(cfg), - setAccountEnabled: ({ cfg, accountId, enabled }) => - setAccountEnabledInConfigSection({ - cfg, - sectionKey: "imessage", - accountId, - enabled, - allowTopLevel: true, - }), - deleteAccount: ({ cfg, accountId }) => - deleteAccountFromConfigSection({ - cfg, - sectionKey: "imessage", - accountId, - clearBaseFields: ["cliPath", "dbPath", "service", "region", "name"], - }), - isConfigured: (account) => account.configured, - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: account.configured, - }), - resolveAllowFrom: ({ cfg, accountId }) => resolveIMessageConfigAllowFrom({ cfg, accountId }), - formatAllowFrom: ({ allowFrom }) => formatTrimmedAllowFromEntries(allowFrom), - resolveDefaultTo: ({ cfg, accountId }) => resolveIMessageConfigDefaultTo({ cfg, accountId }), - }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", readConfig: ({ cfg, accountId }) => { From 626e3015027c53de7e36c9defc3ab5699a45364b Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:58:55 +0000 Subject: [PATCH 044/187] refactor(channels): remove dead shared plugin duplicates --- extensions/imessage/src/plugin-shared.ts | 11 ---------- extensions/signal/src/plugin-shared.ts | 26 ------------------------ 2 files changed, 37 deletions(-) delete mode 100644 extensions/imessage/src/plugin-shared.ts delete mode 100644 extensions/signal/src/plugin-shared.ts diff --git a/extensions/imessage/src/plugin-shared.ts b/extensions/imessage/src/plugin-shared.ts deleted file mode 100644 index 415a152f56a..00000000000 --- a/extensions/imessage/src/plugin-shared.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type { ChannelPlugin } from "openclaw/plugin-sdk/imessage"; -import { type ResolvedIMessageAccount } from "./accounts.js"; -import { createIMessageSetupWizardProxy } from "./setup-core.js"; - -async function loadIMessageChannelRuntime() { - return await import("./channel.runtime.js"); -} - -export const imessageSetupWizard = createIMessageSetupWizardProxy(async () => ({ - imessageSetupWizard: (await loadIMessageChannelRuntime()).imessageSetupWizard, -})) satisfies NonNullable["setupWizard"]>; diff --git a/extensions/signal/src/plugin-shared.ts b/extensions/signal/src/plugin-shared.ts deleted file mode 100644 index 8755caf240f..00000000000 --- a/extensions/signal/src/plugin-shared.ts +++ /dev/null @@ -1,26 +0,0 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { createScopedAccountConfigAccessors } from "../../../src/plugin-sdk-internal/channel-config.js"; -import { normalizeE164 } from "../../../src/utils.js"; -import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; -import { createSignalSetupWizardProxy } from "./setup-core.js"; - -async function loadSignalChannelRuntime() { - return await import("./channel.runtime.js"); -} - -export const signalSetupWizard = createSignalSetupWizardProxy(async () => ({ - signalSetupWizard: (await loadSignalChannelRuntime()).signalSetupWizard, -})); - -export const signalConfigAccessors = createScopedAccountConfigAccessors({ - resolveAccount: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId?: string | null }) => - resolveSignalAccount({ cfg, accountId }), - resolveAllowFrom: (account: ResolvedSignalAccount) => account.config.allowFrom, - formatAllowFrom: (allowFrom) => - allowFrom - .map((entry) => String(entry).trim()) - .filter(Boolean) - .map((entry) => (entry === "*" ? "*" : normalizeE164(entry.replace(/^signal:/i, "")))) - .filter(Boolean), - resolveDefaultTo: (account: ResolvedSignalAccount) => account.config.defaultTo, -}); From a1a8b74e9a57ea80b1a2b0a2ae225a7a280c142c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:00:59 +0000 Subject: [PATCH 045/187] refactor(nextcloud-talk): share dm policy prompt --- extensions/nextcloud-talk/src/setup-core.ts | 2 +- .../nextcloud-talk/src/setup-surface.ts | 93 +------------------ 2 files changed, 4 insertions(+), 91 deletions(-) diff --git a/extensions/nextcloud-talk/src/setup-core.ts b/extensions/nextcloud-talk/src/setup-core.ts index 0b74753dcb6..4e976605b85 100644 --- a/extensions/nextcloud-talk/src/setup-core.ts +++ b/extensions/nextcloud-talk/src/setup-core.ts @@ -174,7 +174,7 @@ async function promptNextcloudTalkAllowFromForAccount(params: { }); } -const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { +export const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { label: "Nextcloud Talk", channel, policyKey: "channels.nextcloud-talk.dmPolicy", diff --git a/extensions/nextcloud-talk/src/setup-surface.ts b/extensions/nextcloud-talk/src/setup-surface.ts index ecb7b29084d..776a9a4fe3e 100644 --- a/extensions/nextcloud-talk/src/setup-surface.ts +++ b/extensions/nextcloud-talk/src/setup-surface.ts @@ -2,23 +2,13 @@ import type { ChannelSetupInput } from "openclaw/plugin-sdk/channel-runtime"; import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { hasConfiguredSecretInput } from "openclaw/plugin-sdk/config-runtime"; import { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/routing"; -import { - mergeAllowFromEntries, - resolveSetupAccountId, - setSetupChannelEnabled, - setTopLevelChannelDmPolicyWithAllowFrom, -} from "openclaw/plugin-sdk/setup"; -import type { ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "openclaw/plugin-sdk/setup"; -import type { WizardPrompter } from "openclaw/plugin-sdk/setup"; -import { - listNextcloudTalkAccountIds, - resolveDefaultNextcloudTalkAccountId, - resolveNextcloudTalkAccount, -} from "./accounts.js"; +import { listNextcloudTalkAccountIds, resolveNextcloudTalkAccount } from "./accounts.js"; import { clearNextcloudTalkAccountFields, + nextcloudTalkDmPolicy, nextcloudTalkSetupAdapter, normalizeNextcloudTalkBaseUrl, setNextcloudTalkAccountConfig, @@ -29,83 +19,6 @@ import type { CoreConfig, DmPolicy } from "./types.js"; const channel = "nextcloud-talk" as const; const CONFIGURE_API_FLAG = "__nextcloudTalkConfigureApiCredentials"; -function setNextcloudTalkDmPolicy(cfg: CoreConfig, dmPolicy: DmPolicy): CoreConfig { - return setTopLevelChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy, - }) as CoreConfig; -} - -async function promptNextcloudTalkAllowFrom(params: { - cfg: CoreConfig; - prompter: WizardPrompter; - accountId: string; -}): Promise { - const resolved = resolveNextcloudTalkAccount({ cfg: params.cfg, accountId: params.accountId }); - const existingAllowFrom = resolved.config.allowFrom ?? []; - await params.prompter.note( - [ - "1) Check the Nextcloud admin panel for user IDs", - "2) Or look at the webhook payload logs when someone messages", - "3) User IDs are typically lowercase usernames in Nextcloud", - `Docs: ${formatDocsLink("/channels/nextcloud-talk", "channels/nextcloud-talk")}`, - ].join("\n"), - "Nextcloud Talk user id", - ); - - let resolvedIds: string[] = []; - while (resolvedIds.length === 0) { - const entry = await params.prompter.text({ - message: "Nextcloud Talk allowFrom (user id)", - placeholder: "username", - initialValue: existingAllowFrom[0] ? String(existingAllowFrom[0]) : undefined, - validate: (value) => (String(value ?? "").trim() ? undefined : "Required"), - }); - resolvedIds = String(entry) - .split(/[\n,;]+/g) - .map((value) => value.trim().toLowerCase()) - .filter(Boolean); - if (resolvedIds.length === 0) { - await params.prompter.note("Please enter at least one valid user ID.", "Nextcloud Talk"); - } - } - - return setNextcloudTalkAccountConfig(params.cfg, params.accountId, { - dmPolicy: "allowlist", - allowFrom: mergeAllowFromEntries( - existingAllowFrom.map((value) => String(value).trim().toLowerCase()), - resolvedIds, - ), - }); -} - -async function promptNextcloudTalkAllowFromForAccount(params: { - cfg: OpenClawConfig; - prompter: WizardPrompter; - accountId?: string; -}): Promise { - const accountId = resolveSetupAccountId({ - accountId: params.accountId, - defaultAccountId: resolveDefaultNextcloudTalkAccountId(params.cfg as CoreConfig), - }); - return await promptNextcloudTalkAllowFrom({ - cfg: params.cfg as CoreConfig, - prompter: params.prompter, - accountId, - }); -} - -const nextcloudTalkDmPolicy: ChannelSetupDmPolicy = { - label: "Nextcloud Talk", - channel, - policyKey: "channels.nextcloud-talk.dmPolicy", - allowFromKey: "channels.nextcloud-talk.allowFrom", - getCurrent: (cfg) => cfg.channels?.["nextcloud-talk"]?.dmPolicy ?? "pairing", - setPolicy: (cfg, policy) => setNextcloudTalkDmPolicy(cfg as CoreConfig, policy as DmPolicy), - promptAllowFrom: promptNextcloudTalkAllowFromForAccount, -}; - export const nextcloudTalkSetupWizard: ChannelSetupWizard = { channel, stepOrder: "text-first", From ec89357547ec106238af8594ef1fe21c29ef6d44 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:03:10 +0000 Subject: [PATCH 046/187] refactor(signal): share setup wizard helpers --- extensions/signal/src/setup-core.ts | 141 ++++++++++++++----------- extensions/signal/src/setup-surface.ts | 112 +++----------------- 2 files changed, 93 insertions(+), 160 deletions(-) diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 9b487ead841..55d41ce458d 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -16,6 +16,7 @@ import type { ChannelSetupAdapter, ChannelSetupDmPolicy, ChannelSetupWizard, + ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { @@ -87,7 +88,7 @@ function buildSignalSetupPatch(input: { }; } -async function promptSignalAllowFrom(params: { +export async function promptSignalAllowFrom(params: { cfg: OpenClawConfig; prompter: WizardPrompter; accountId?: string; @@ -115,6 +116,77 @@ async function promptSignalAllowFrom(params: { }); } +export const signalDmPolicy: ChannelSetupDmPolicy = { + label: "Signal", + channel, + policyKey: "channels.signal.dmPolicy", + allowFromKey: "channels.signal.allowFrom", + getCurrent: (cfg: OpenClawConfig) => cfg.channels?.signal?.dmPolicy ?? "pairing", + setPolicy: (cfg: OpenClawConfig, policy) => + setChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptSignalAllowFrom, +}; + +function resolveSignalCliPath(params: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: Record; +}) { + return ( + (typeof params.credentialValues.cliPath === "string" + ? params.credentialValues.cliPath + : undefined) ?? + resolveSignalAccount({ cfg: params.cfg, accountId: params.accountId }).config.cliPath ?? + "signal-cli" + ); +} + +export function createSignalCliPathTextInput( + shouldPrompt: NonNullable, +): ChannelSetupWizardTextInput { + return { + inputKey: "cliPath", + message: "signal-cli path", + currentValue: ({ cfg, accountId, credentialValues }) => + resolveSignalCliPath({ cfg, accountId, credentialValues }), + initialValue: ({ cfg, accountId, credentialValues }) => + resolveSignalCliPath({ cfg, accountId, credentialValues }), + shouldPrompt, + confirmCurrentValue: false, + applyCurrentValue: true, + helpTitle: "Signal", + helpLines: [ + "signal-cli not found. Install it, then rerun this step or set channels.signal.cliPath.", + ], + }; +} + +export const signalNumberTextInput: ChannelSetupWizardTextInput = { + inputKey: "signalNumber", + message: "Signal bot number (E.164)", + currentValue: ({ cfg, accountId }) => + normalizeSignalAccountInput(resolveSignalAccount({ cfg, accountId }).config.account) ?? + undefined, + keepPrompt: (value) => `Signal account set (${value}). Keep it?`, + validate: ({ value }) => + normalizeSignalAccountInput(value) ? undefined : INVALID_SIGNAL_ACCOUNT_ERROR, + normalizeValue: ({ value }) => normalizeSignalAccountInput(value) ?? value, +}; + +export const signalCompletionNote = { + title: "Signal next steps", + lines: [ + 'Link device with: signal-cli link -n "OpenClaw"', + "Scan QR in Signal -> Linked Devices", + `Then run: ${formatCliCommand("openclaw gateway call channels.status --params '{\"probe\":true}'")}`, + `Docs: ${formatDocsLink("/signal", "signal")}`, + ], +}; + export const signalSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => @@ -187,21 +259,6 @@ export const signalSetupAdapter: ChannelSetupAdapter = { export function createSignalSetupWizardProxy( loadWizard: () => Promise<{ signalSetupWizard: ChannelSetupWizard }>, ) { - const signalDmPolicy: ChannelSetupDmPolicy = { - label: "Signal", - channel, - policyKey: "channels.signal.dmPolicy", - allowFromKey: "channels.signal.allowFrom", - getCurrent: (cfg: OpenClawConfig) => cfg.channels?.signal?.dmPolicy ?? "pairing", - setPolicy: (cfg: OpenClawConfig, policy) => - setChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptSignalAllowFrom, - }; - return { channel, status: { @@ -225,51 +282,15 @@ export function createSignalSetupWizardProxy( prepare: async (params) => await (await loadWizard()).signalSetupWizard.prepare?.(params), credentials: [], textInputs: [ - { - inputKey: "cliPath", - message: "signal-cli path", - currentValue: ({ cfg, accountId, credentialValues }) => - (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? - resolveSignalAccount({ cfg, accountId }).config.cliPath ?? - "signal-cli", - initialValue: ({ cfg, accountId, credentialValues }) => - (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? - resolveSignalAccount({ cfg, accountId }).config.cliPath ?? - "signal-cli", - shouldPrompt: async (params) => { - const input = (await loadWizard()).signalSetupWizard.textInputs?.find( - (entry) => entry.inputKey === "cliPath", - ); - return (await input?.shouldPrompt?.(params)) ?? false; - }, - confirmCurrentValue: false, - applyCurrentValue: true, - helpTitle: "Signal", - helpLines: [ - "signal-cli not found. Install it, then rerun this step or set channels.signal.cliPath.", - ], - }, - { - inputKey: "signalNumber", - message: "Signal bot number (E.164)", - currentValue: ({ cfg, accountId }) => - normalizeSignalAccountInput(resolveSignalAccount({ cfg, accountId }).config.account) ?? - undefined, - keepPrompt: (value) => `Signal account set (${value}). Keep it?`, - validate: ({ value }) => - normalizeSignalAccountInput(value) ? undefined : INVALID_SIGNAL_ACCOUNT_ERROR, - normalizeValue: ({ value }) => normalizeSignalAccountInput(value) ?? value, - }, + createSignalCliPathTextInput(async (params) => { + const input = (await loadWizard()).signalSetupWizard.textInputs?.find( + (entry) => entry.inputKey === "cliPath", + ); + return (await input?.shouldPrompt?.(params)) ?? false; + }), + signalNumberTextInput, ], - completionNote: { - title: "Signal next steps", - lines: [ - 'Link device with: signal-cli link -n "OpenClaw"', - "Scan QR in Signal -> Linked Devices", - `Then run: ${formatCliCommand("openclaw gateway call channels.status --params '{\"probe\":true}'")}`, - `Docs: ${formatDocsLink("/signal", "signal")}`, - ], - }, + completionNote: signalCompletionNote, dmPolicy: signalDmPolicy, disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 3e2f39cde2d..695e2c5cc8b 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,73 +1,19 @@ -import { formatCliCommand } from "../../../src/cli/command-format.js"; import { detectBinary } from "../../../src/commands/onboard-helpers.js"; import { installSignalCli } from "../../../src/commands/signal-install.js"; +import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; import { - DEFAULT_ACCOUNT_ID, - type OpenClawConfig, - promptParsedAllowFromForScopedChannel, - setChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, - type WizardPrompter, -} from "openclaw/plugin-sdk/setup"; -import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import { - listSignalAccountIds, - resolveDefaultSignalAccountId, - resolveSignalAccount, -} from "./accounts.js"; -import { + createSignalCliPathTextInput, normalizeSignalAccountInput, parseSignalAllowFromEntries, + signalCompletionNote, + signalDmPolicy, + signalNumberTextInput, signalSetupAdapter, } from "./setup-core.js"; const channel = "signal" as const; -const INVALID_SIGNAL_ACCOUNT_ERROR = - "Invalid E.164 phone number (must start with + and country code, e.g. +15555550123)"; - -async function promptSignalAllowFrom(params: { - cfg: OpenClawConfig; - prompter: WizardPrompter; - accountId?: string; -}): Promise { - return promptParsedAllowFromForScopedChannel({ - cfg: params.cfg, - channel, - accountId: params.accountId, - defaultAccountId: resolveDefaultSignalAccountId(params.cfg), - prompter: params.prompter, - noteTitle: "Signal allowlist", - noteLines: [ - "Allowlist Signal DMs by sender id.", - "Examples:", - "- +15555550123", - "- uuid:123e4567-e89b-12d3-a456-426614174000", - "Multiple entries: comma-separated.", - `Docs: ${formatDocsLink("/signal", "signal")}`, - ], - message: "Signal allowFrom (E.164 or uuid)", - placeholder: "+15555550123, uuid:123e4567-e89b-12d3-a456-426614174000", - parseEntries: parseSignalAllowFromEntries, - getExistingAllowFrom: ({ cfg, accountId }) => - resolveSignalAccount({ cfg, accountId }).config.allowFrom ?? [], - }); -} - -const signalDmPolicy: ChannelSetupDmPolicy = { - label: "Signal", - channel, - policyKey: "channels.signal.dmPolicy", - allowFromKey: "channels.signal.allowFrom", - getCurrent: (cfg) => cfg.channels?.signal?.dmPolicy ?? "pairing", - setPolicy: (cfg, policy) => - setChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptSignalAllowFrom, -}; export const signalSetupWizard: ChannelSetupWizard = { channel, @@ -136,46 +82,12 @@ export const signalSetupWizard: ChannelSetupWizard = { }, credentials: [], textInputs: [ - { - inputKey: "cliPath", - message: "signal-cli path", - currentValue: ({ cfg, accountId, credentialValues }) => - (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? - resolveSignalAccount({ cfg, accountId }).config.cliPath ?? - "signal-cli", - initialValue: ({ cfg, accountId, credentialValues }) => - (typeof credentialValues.cliPath === "string" ? credentialValues.cliPath : undefined) ?? - resolveSignalAccount({ cfg, accountId }).config.cliPath ?? - "signal-cli", - shouldPrompt: async ({ currentValue }) => !(await detectBinary(currentValue ?? "signal-cli")), - confirmCurrentValue: false, - applyCurrentValue: true, - helpTitle: "Signal", - helpLines: [ - "signal-cli not found. Install it, then rerun this step or set channels.signal.cliPath.", - ], - }, - { - inputKey: "signalNumber", - message: "Signal bot number (E.164)", - currentValue: ({ cfg, accountId }) => - normalizeSignalAccountInput(resolveSignalAccount({ cfg, accountId }).config.account) ?? - undefined, - keepPrompt: (value) => `Signal account set (${value}). Keep it?`, - validate: ({ value }) => - normalizeSignalAccountInput(value) ? undefined : INVALID_SIGNAL_ACCOUNT_ERROR, - normalizeValue: ({ value }) => normalizeSignalAccountInput(value) ?? value, - }, + createSignalCliPathTextInput(async ({ currentValue }) => { + return !(await detectBinary(currentValue ?? "signal-cli")); + }), + signalNumberTextInput, ], - completionNote: { - title: "Signal next steps", - lines: [ - 'Link device with: signal-cli link -n "OpenClaw"', - "Scan QR in Signal -> Linked Devices", - `Then run: ${formatCliCommand("openclaw gateway call channels.status --params '{\"probe\":true}'")}`, - `Docs: ${formatDocsLink("/signal", "signal")}`, - ], - }, + completionNote: signalCompletionNote, dmPolicy: signalDmPolicy, disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), }; From 6cbff9e7d39cfc29c8dd0f61f06d505ef35d6f98 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:04:19 +0000 Subject: [PATCH 047/187] refactor(imessage): share setup wizard helpers --- extensions/imessage/src/setup-core.ts | 99 +++++++++++++----------- extensions/imessage/src/setup-surface.ts | 97 ++++------------------- 2 files changed, 68 insertions(+), 128 deletions(-) diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index 2560c1cb919..bc99f521510 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -14,6 +14,7 @@ import type { ChannelSetupAdapter, ChannelSetupDmPolicy, ChannelSetupWizard, + ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { @@ -68,7 +69,7 @@ function buildIMessageSetupPatch(input: { }; } -async function promptIMessageAllowFrom(params: { +export async function promptIMessageAllowFrom(params: { cfg: OpenClawConfig; prompter: WizardPrompter; accountId?: string; @@ -98,6 +99,52 @@ async function promptIMessageAllowFrom(params: { }); } +export const imessageDmPolicy: ChannelSetupDmPolicy = { + label: "iMessage", + channel, + policyKey: "channels.imessage.dmPolicy", + allowFromKey: "channels.imessage.allowFrom", + getCurrent: (cfg: OpenClawConfig) => cfg.channels?.imessage?.dmPolicy ?? "pairing", + setPolicy: (cfg: OpenClawConfig, policy) => + setChannelDmPolicyWithAllowFrom({ + cfg, + channel, + dmPolicy: policy, + }), + promptAllowFrom: promptIMessageAllowFrom, +}; + +function resolveIMessageCliPath(params: { cfg: OpenClawConfig; accountId: string }) { + return resolveIMessageAccount(params).config.cliPath ?? "imsg"; +} + +export function createIMessageCliPathTextInput( + shouldPrompt: NonNullable, +): ChannelSetupWizardTextInput { + return { + inputKey: "cliPath", + message: "imsg CLI path", + initialValue: ({ cfg, accountId }) => resolveIMessageCliPath({ cfg, accountId }), + currentValue: ({ cfg, accountId }) => resolveIMessageCliPath({ cfg, accountId }), + shouldPrompt, + confirmCurrentValue: false, + applyCurrentValue: true, + helpTitle: "iMessage", + helpLines: ["imsg CLI path required to enable iMessage."], + }; +} + +export const imessageCompletionNote = { + title: "iMessage next steps", + lines: [ + "This is still a work in progress.", + "Ensure OpenClaw has Full Disk Access to Messages DB.", + "Grant Automation permission for Messages when prompted.", + "List chats with: imsg chats --limit 20", + `Docs: ${formatDocsLink("/imessage", "imessage")}`, + ], +}; + export const imessageSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => @@ -158,21 +205,6 @@ export const imessageSetupAdapter: ChannelSetupAdapter = { export function createIMessageSetupWizardProxy( loadWizard: () => Promise<{ imessageSetupWizard: ChannelSetupWizard }>, ) { - const imessageDmPolicy: ChannelSetupDmPolicy = { - label: "iMessage", - channel, - policyKey: "channels.imessage.dmPolicy", - allowFromKey: "channels.imessage.allowFrom", - getCurrent: (cfg: OpenClawConfig) => cfg.channels?.imessage?.dmPolicy ?? "pairing", - setPolicy: (cfg: OpenClawConfig, policy) => - setChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptIMessageAllowFrom, - }; - return { channel, status: { @@ -202,35 +234,14 @@ export function createIMessageSetupWizardProxy( }, credentials: [], textInputs: [ - { - inputKey: "cliPath", - message: "imsg CLI path", - initialValue: ({ cfg, accountId }) => - resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", - currentValue: ({ cfg, accountId }) => - resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", - shouldPrompt: async (params) => { - const input = (await loadWizard()).imessageSetupWizard.textInputs?.find( - (entry) => entry.inputKey === "cliPath", - ); - return (await input?.shouldPrompt?.(params)) ?? false; - }, - confirmCurrentValue: false, - applyCurrentValue: true, - helpTitle: "iMessage", - helpLines: ["imsg CLI path required to enable iMessage."], - }, + createIMessageCliPathTextInput(async (params) => { + const input = (await loadWizard()).imessageSetupWizard.textInputs?.find( + (entry) => entry.inputKey === "cliPath", + ); + return (await input?.shouldPrompt?.(params)) ?? false; + }), ], - completionNote: { - title: "iMessage next steps", - lines: [ - "This is still a work in progress.", - "Ensure OpenClaw has Full Disk Access to Messages DB.", - "Grant Automation permission for Messages when prompted.", - "List chats with: imsg chats --limit 20", - `Docs: ${formatDocsLink("/imessage", "imessage")}`, - ], - }, + completionNote: imessageCompletionNote, dmPolicy: imessageDmPolicy, disable: (cfg: OpenClawConfig) => setSetupChannelEnabled(cfg, channel, false), } satisfies ChannelSetupWizard; diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index 2d66c4ab6b2..b2ccdb3a1d6 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,69 +1,17 @@ import { detectBinary } from "../../../src/commands/onboard-helpers.js"; +import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { - DEFAULT_ACCOUNT_ID, - type OpenClawConfig, - parseSetupEntriesAllowingWildcard, - promptParsedAllowFromForScopedChannel, - setChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, - type WizardPrompter, -} from "openclaw/plugin-sdk/setup"; -import type { ChannelSetupDmPolicy, ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; -import { - listIMessageAccountIds, - resolveDefaultIMessageAccountId, - resolveIMessageAccount, -} from "./accounts.js"; -import { imessageSetupAdapter, parseIMessageAllowFromEntries } from "./setup-core.js"; + createIMessageCliPathTextInput, + imessageCompletionNote, + imessageDmPolicy, + imessageSetupAdapter, + parseIMessageAllowFromEntries, +} from "./setup-core.js"; const channel = "imessage" as const; -async function promptIMessageAllowFrom(params: { - cfg: OpenClawConfig; - prompter: WizardPrompter; - accountId?: string; -}): Promise { - return promptParsedAllowFromForScopedChannel({ - cfg: params.cfg, - channel, - accountId: params.accountId, - defaultAccountId: resolveDefaultIMessageAccountId(params.cfg), - prompter: params.prompter, - noteTitle: "iMessage allowlist", - noteLines: [ - "Allowlist iMessage DMs by handle or chat target.", - "Examples:", - "- +15555550123", - "- user@example.com", - "- chat_id:123", - "- chat_guid:... or chat_identifier:...", - "Multiple entries: comma-separated.", - `Docs: ${formatDocsLink("/imessage", "imessage")}`, - ], - message: "iMessage allowFrom (handle or chat_id)", - placeholder: "+15555550123, user@example.com, chat_id:123", - parseEntries: parseIMessageAllowFromEntries, - getExistingAllowFrom: ({ cfg, accountId }) => - resolveIMessageAccount({ cfg, accountId }).config.allowFrom ?? [], - }); -} - -const imessageDmPolicy: ChannelSetupDmPolicy = { - label: "iMessage", - channel, - policyKey: "channels.imessage.dmPolicy", - allowFromKey: "channels.imessage.allowFrom", - getCurrent: (cfg) => cfg.channels?.imessage?.dmPolicy ?? "pairing", - setPolicy: (cfg, policy) => - setChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptIMessageAllowFrom, -}; - export const imessageSetupWizard: ChannelSetupWizard = { channel, status: { @@ -103,30 +51,11 @@ export const imessageSetupWizard: ChannelSetupWizard = { }, credentials: [], textInputs: [ - { - inputKey: "cliPath", - message: "imsg CLI path", - initialValue: ({ cfg, accountId }) => - resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", - currentValue: ({ cfg, accountId }) => - resolveIMessageAccount({ cfg, accountId }).config.cliPath ?? "imsg", - shouldPrompt: async ({ currentValue }) => !(await detectBinary(currentValue ?? "imsg")), - confirmCurrentValue: false, - applyCurrentValue: true, - helpTitle: "iMessage", - helpLines: ["imsg CLI path required to enable iMessage."], - }, + createIMessageCliPathTextInput(async ({ currentValue }) => { + return !(await detectBinary(currentValue ?? "imsg")); + }), ], - completionNote: { - title: "iMessage next steps", - lines: [ - "This is still a work in progress.", - "Ensure OpenClaw has Full Disk Access to Messages DB.", - "Grant Automation permission for Messages when prompted.", - "List chats with: imsg chats --limit 20", - `Docs: ${formatDocsLink("/imessage", "imessage")}`, - ], - }, + completionNote: imessageCompletionNote, dmPolicy: imessageDmPolicy, disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), }; From d2445b5fcd68ba96654de3a05a633338a6b713ae Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:20:52 -0700 Subject: [PATCH 048/187] feat(plugins): share capability capture helpers --- src/media-understanding/providers/index.ts | 25 +--------- src/plugin-sdk/index.ts | 3 ++ src/plugin-sdk/media-understanding.ts | 5 +- src/plugins/captured-registration.ts | 58 ++++++++++++++++++++++ src/plugins/contracts/registry.ts | 2 +- src/plugins/web-search-providers.ts | 18 ++----- src/test-utils/plugin-registration.ts | 52 ++----------------- 7 files changed, 75 insertions(+), 88 deletions(-) create mode 100644 src/plugins/captured-registration.ts diff --git a/src/media-understanding/providers/index.ts b/src/media-understanding/providers/index.ts index 32d1d6bcf9a..521d55caee1 100644 --- a/src/media-understanding/providers/index.ts +++ b/src/media-understanding/providers/index.ts @@ -1,13 +1,3 @@ -import { anthropicMediaUnderstandingProvider } from "../../../extensions/anthropic/media-understanding-provider.js"; -import { googleMediaUnderstandingProvider } from "../../../extensions/google/media-understanding-provider.js"; -import { - minimaxMediaUnderstandingProvider, - minimaxPortalMediaUnderstandingProvider, -} from "../../../extensions/minimax/media-understanding-provider.js"; -import { mistralMediaUnderstandingProvider } from "../../../extensions/mistral/media-understanding-provider.js"; -import { moonshotMediaUnderstandingProvider } from "../../../extensions/moonshot/media-understanding-provider.js"; -import { openaiMediaUnderstandingProvider } from "../../../extensions/openai/media-understanding-provider.js"; -import { zaiMediaUnderstandingProvider } from "../../../extensions/zai/media-understanding-provider.js"; import { normalizeProviderId } from "../../agents/model-selection.js"; import type { OpenClawConfig } from "../../config/config.js"; import { loadOpenClawPlugins } from "../../plugins/loader.js"; @@ -16,18 +6,7 @@ import type { MediaUnderstandingProvider } from "../types.js"; import { deepgramProvider } from "./deepgram/index.js"; import { groqProvider } from "./groq/index.js"; -const PROVIDERS: MediaUnderstandingProvider[] = [ - groqProvider, - deepgramProvider, - anthropicMediaUnderstandingProvider, - googleMediaUnderstandingProvider, - minimaxMediaUnderstandingProvider, - minimaxPortalMediaUnderstandingProvider, - mistralMediaUnderstandingProvider, - moonshotMediaUnderstandingProvider, - openaiMediaUnderstandingProvider, - zaiMediaUnderstandingProvider, -]; +const PROVIDERS: MediaUnderstandingProvider[] = [groqProvider, deepgramProvider]; function mergeProviderIntoRegistry( registry: Map, @@ -63,7 +42,7 @@ export function buildMediaUnderstandingRegistry( } const active = getActivePluginRegistry(); const pluginRegistry = - (active?.mediaUnderstandingProviders?.length ?? 0) > 0 || !cfg + (active?.mediaUnderstandingProviders?.length ?? 0) > 0 ? active : loadOpenClawPlugins({ config: cfg }); for (const entry of pluginRegistry?.mediaUnderstandingProviders ?? []) { diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index acfca49d6ab..1e926c098ab 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -183,14 +183,17 @@ export type { OpenClawConfig } from "../config/config.js"; /** @deprecated Use OpenClawConfig instead */ export type { OpenClawConfig as ClawdbotConfig } from "../config/config.js"; export { isDangerousNameMatchingEnabled } from "../config/dangerous-name-matching.js"; +export * from "./speech.js"; export type { FileLockHandle, FileLockOptions } from "./file-lock.js"; export { acquireFileLock, withFileLock } from "./file-lock.js"; +export * from "./media-understanding.js"; export { mapAllowlistResolutionInputs, mapBasicAllowlistResolutionEntries, type BasicAllowlistResolutionEntry, } from "./allowlist-resolution.js"; +export * from "./provider-web-search.js"; export { resolveRequestUrl } from "./request-url.js"; export { buildDiscordSendMediaOptions, diff --git a/src/plugin-sdk/media-understanding.ts b/src/plugin-sdk/media-understanding.ts index 0d14685dbdf..a9f10cd8d58 100644 --- a/src/plugin-sdk/media-understanding.ts +++ b/src/plugin-sdk/media-understanding.ts @@ -13,7 +13,10 @@ export type { VideoDescriptionResult, } from "../media-understanding/types.js"; -export { describeImageWithModel, describeImagesWithModel } from "../media-understanding/providers/image.js"; +export { + describeImageWithModel, + describeImagesWithModel, +} from "../media-understanding/providers/image.js"; export { transcribeOpenAiCompatibleAudio } from "../media-understanding/providers/openai-compatible-audio.js"; export { assertOkOrThrowHttpError, diff --git a/src/plugins/captured-registration.ts b/src/plugins/captured-registration.ts new file mode 100644 index 00000000000..dd5ba78a9c4 --- /dev/null +++ b/src/plugins/captured-registration.ts @@ -0,0 +1,58 @@ +import type { + AnyAgentTool, + MediaUnderstandingProviderPlugin, + OpenClawPluginApi, + ProviderPlugin, + SpeechProviderPlugin, + WebSearchProviderPlugin, +} from "./types.js"; + +export type CapturedPluginRegistration = { + api: OpenClawPluginApi; + providers: ProviderPlugin[]; + speechProviders: SpeechProviderPlugin[]; + mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[]; + webSearchProviders: WebSearchProviderPlugin[]; + tools: AnyAgentTool[]; +}; + +export function createCapturedPluginRegistration(): CapturedPluginRegistration { + const providers: ProviderPlugin[] = []; + const speechProviders: SpeechProviderPlugin[] = []; + const mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[] = []; + const webSearchProviders: WebSearchProviderPlugin[] = []; + const tools: AnyAgentTool[] = []; + + return { + providers, + speechProviders, + mediaUnderstandingProviders, + webSearchProviders, + tools, + api: { + registerProvider(provider: ProviderPlugin) { + providers.push(provider); + }, + registerSpeechProvider(provider: SpeechProviderPlugin) { + speechProviders.push(provider); + }, + registerMediaUnderstandingProvider(provider: MediaUnderstandingProviderPlugin) { + mediaUnderstandingProviders.push(provider); + }, + registerWebSearchProvider(provider: WebSearchProviderPlugin) { + webSearchProviders.push(provider); + }, + registerTool(tool: AnyAgentTool) { + tools.push(tool); + }, + } as OpenClawPluginApi, + }; +} + +export function capturePluginRegistration(params: { + register(api: OpenClawPluginApi): void; +}): CapturedPluginRegistration { + const captured = createCapturedPluginRegistration(); + params.register(captured.api); + return captured; +} diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index 3c5cc8935c9..cd58bf41de2 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -34,7 +34,7 @@ import volcenginePlugin from "../../../extensions/volcengine/index.js"; import xaiPlugin from "../../../extensions/xai/index.js"; import xiaomiPlugin from "../../../extensions/xiaomi/index.js"; import zaiPlugin from "../../../extensions/zai/index.js"; -import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; +import { createCapturedPluginRegistration } from "../captured-registration.js"; import type { MediaUnderstandingProviderPlugin, ProviderPlugin, diff --git a/src/plugins/web-search-providers.ts b/src/plugins/web-search-providers.ts index 9ecdef1fd3c..585ed0bd36c 100644 --- a/src/plugins/web-search-providers.ts +++ b/src/plugins/web-search-providers.ts @@ -8,11 +8,11 @@ import { withBundledPluginAllowlistCompat, withBundledPluginEnablementCompat, } from "./bundled-compat.js"; +import { capturePluginRegistration } from "./captured-registration.js"; import type { PluginLoadOptions } from "./loader.js"; import type { PluginWebSearchProviderRegistration } from "./registry.js"; import { getActivePluginRegistry } from "./runtime.js"; -import type { OpenClawPluginApi, WebSearchProviderPlugin } from "./types.js"; -import type { PluginWebSearchProviderEntry } from "./types.js"; +import type { OpenClawPluginApi, PluginWebSearchProviderEntry } from "./types.js"; type RegistrablePlugin = { id: string; @@ -76,18 +76,8 @@ function normalizeWebSearchPluginConfig(params: { function captureBundledWebSearchProviders( plugin: RegistrablePlugin, ): PluginWebSearchProviderRegistration[] { - const providers: WebSearchProviderPlugin[] = []; - const api = { - registerProvider() {}, - registerSpeechProvider() {}, - registerMediaUnderstandingProvider() {}, - registerWebSearchProvider(provider: WebSearchProviderPlugin) { - providers.push(provider); - }, - registerTool() {}, - }; - plugin.register(api as unknown as OpenClawPluginApi); - return providers.map((provider) => ({ + const captured = capturePluginRegistration(plugin); + return captured.webSearchProviders.map((provider) => ({ pluginId: plugin.id, pluginName: plugin.name, provider, diff --git a/src/test-utils/plugin-registration.ts b/src/test-utils/plugin-registration.ts index de8e5422ccf..5251f82c051 100644 --- a/src/test-utils/plugin-registration.ts +++ b/src/test-utils/plugin-registration.ts @@ -1,53 +1,7 @@ -import type { - AnyAgentTool, - MediaUnderstandingProviderPlugin, - OpenClawPluginApi, - ProviderPlugin, - SpeechProviderPlugin, - WebSearchProviderPlugin, -} from "../plugins/types.js"; +import { createCapturedPluginRegistration } from "../plugins/captured-registration.js"; +import type { OpenClawPluginApi, ProviderPlugin } from "../plugins/types.js"; -export type CapturedPluginRegistration = { - api: OpenClawPluginApi; - providers: ProviderPlugin[]; - speechProviders: SpeechProviderPlugin[]; - mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[]; - webSearchProviders: WebSearchProviderPlugin[]; - tools: AnyAgentTool[]; -}; - -export function createCapturedPluginRegistration(): CapturedPluginRegistration { - const providers: ProviderPlugin[] = []; - const speechProviders: SpeechProviderPlugin[] = []; - const mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[] = []; - const webSearchProviders: WebSearchProviderPlugin[] = []; - const tools: AnyAgentTool[] = []; - - return { - providers, - speechProviders, - mediaUnderstandingProviders, - webSearchProviders, - tools, - api: { - registerProvider(provider: ProviderPlugin) { - providers.push(provider); - }, - registerSpeechProvider(provider: SpeechProviderPlugin) { - speechProviders.push(provider); - }, - registerMediaUnderstandingProvider(provider: MediaUnderstandingProviderPlugin) { - mediaUnderstandingProviders.push(provider); - }, - registerWebSearchProvider(provider: WebSearchProviderPlugin) { - webSearchProviders.push(provider); - }, - registerTool(tool: AnyAgentTool) { - tools.push(tool); - }, - } as OpenClawPluginApi, - }; -} +export { createCapturedPluginRegistration }; export function registerSingleProviderPlugin(params: { register(api: OpenClawPluginApi): void; From dbe77d0425ff93957eaeede03a8883b40340c0f0 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:21:03 -0700 Subject: [PATCH 049/187] fix(agents): restore embedded pi and websocket typings --- src/agents/openai-ws-connection.test.ts | 8 +- src/agents/openai-ws-connection.ts | 9 +- .../pi-embedded-runner.bundle-mcp.e2e.test.ts | 4 +- src/agents/pi-project-settings.bundle.test.ts | 363 +++++++++--------- src/agents/pi-project-settings.ts | 5 +- src/cli/mcp-cli.ts | 1 + 6 files changed, 204 insertions(+), 186 deletions(-) diff --git a/src/agents/openai-ws-connection.test.ts b/src/agents/openai-ws-connection.test.ts index 4f3f2d4e706..c1f6c077184 100644 --- a/src/agents/openai-ws-connection.test.ts +++ b/src/agents/openai-ws-connection.test.ts @@ -6,6 +6,7 @@ */ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import type { ClientOptions } from "ws"; import type { ClientEvent, OpenAIWebSocketEvent, @@ -34,12 +35,12 @@ const { MockWebSocket } = vi.hoisted(() => { readyState: number = MockWebSocket.CONNECTING; url: string; - options: Record; + options: ClientOptions | undefined; sentMessages: string[] = []; private _listeners: Map = new Map(); - constructor(url: string, options?: Record) { + constructor(url: string, options?: ClientOptions) { this.url = url; this.options = options ?? {}; MockWebSocket.lastInstance = this; @@ -167,8 +168,7 @@ function buildManager(opts?: ConstructorParameters - new MockWebSocket(url, options as Record) as never, + socketFactory: (url, options) => new MockWebSocket(url, options) as never, ...opts, }); } diff --git a/src/agents/openai-ws-connection.ts b/src/agents/openai-ws-connection.ts index 1765eb00172..028311ddacb 100644 --- a/src/agents/openai-ws-connection.ts +++ b/src/agents/openai-ws-connection.ts @@ -14,7 +14,7 @@ */ import { EventEmitter } from "node:events"; -import WebSocket from "ws"; +import WebSocket, { type ClientOptions } from "ws"; import { resolveProviderAttributionHeaders } from "./provider-attribution.js"; // ───────────────────────────────────────────────────────────────────────────── @@ -268,7 +268,7 @@ export interface OpenAIWebSocketManagerOptions { /** Custom backoff delays in ms (default: [1000, 2000, 4000, 8000, 16000]) */ backoffDelaysMs?: readonly number[]; /** Custom socket factory for tests. */ - socketFactory?: (url: string, options: ConstructorParameters[1]) => WebSocket; + socketFactory?: (url: string, options: ClientOptions) => WebSocket; } type InternalEvents = { @@ -308,10 +308,7 @@ export class OpenAIWebSocketManager extends EventEmitter { private readonly wsUrl: string; private readonly maxRetries: number; private readonly backoffDelaysMs: readonly number[]; - private readonly socketFactory: ( - url: string, - options: ConstructorParameters[1], - ) => WebSocket; + private readonly socketFactory: (url: string, options: ClientOptions) => WebSocket; constructor(options: OpenAIWebSocketManagerOptions = {}) { super(); diff --git a/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts index 2eac44e922b..61b37f37f63 100644 --- a/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts +++ b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts @@ -175,9 +175,9 @@ vi.mock("@mariozechner/pi-ai", async () => { const sawBundleResult = toolResultText.some((text) => text.includes("FROM-BUNDLE")); if (!sawBundleResult) { stream.push({ - type: "done", + type: "error", reason: "error", - message: { + error: { role: "assistant" as const, content: [], stopReason: "error" as const, diff --git a/src/agents/pi-project-settings.bundle.test.ts b/src/agents/pi-project-settings.bundle.test.ts index 5859e18ac6e..8c104f74282 100644 --- a/src/agents/pi-project-settings.bundle.test.ts +++ b/src/agents/pi-project-settings.bundle.test.ts @@ -1,205 +1,222 @@ import fs from "node:fs/promises"; import path from "node:path"; -import { afterEach, describe, expect, it, vi } from "vitest"; -import type { PluginManifestRegistry } from "../plugins/manifest-registry.js"; +import { afterEach, describe, expect, it } from "vitest"; +import { clearPluginManifestRegistryCache } from "../plugins/manifest-registry.js"; +import { captureEnv } from "../test-utils/env.js"; import { createTrackedTempDirs } from "../test-utils/tracked-temp-dirs.js"; - -const hoisted = vi.hoisted(() => ({ - loadPluginManifestRegistry: vi.fn(), -})); - -vi.mock("../plugins/manifest-registry.js", () => ({ - loadPluginManifestRegistry: (...args: unknown[]) => hoisted.loadPluginManifestRegistry(...args), -})); - -const { loadEnabledBundlePiSettingsSnapshot } = await import("./pi-project-settings.js"); +import { loadEnabledBundlePiSettingsSnapshot } from "./pi-project-settings.js"; const tempDirs = createTrackedTempDirs(); -function buildRegistry(params: { - pluginRoot: string; - settingsFiles?: string[]; -}): PluginManifestRegistry { - return { - diagnostics: [], - plugins: [ - { - id: "claude-bundle", - name: "Claude Bundle", - format: "bundle", - bundleFormat: "claude", - bundleCapabilities: ["settings"], - channels: [], - providers: [], - skills: [], - settingsFiles: params.settingsFiles ?? ["settings.json"], - hooks: [], - origin: "workspace", - rootDir: params.pluginRoot, - source: params.pluginRoot, - manifestPath: path.join(params.pluginRoot, ".claude-plugin", "plugin.json"), - }, - ], - }; +async function createHomeAndWorkspace() { + const homeDir = await tempDirs.make("openclaw-bundle-home-"); + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + return { homeDir, workspaceDir }; +} + +async function createClaudeBundlePlugin(params: { + homeDir: string; + pluginId: string; + pluginJson?: Record; + settingsJson?: Record; + mcpJson?: Record; +}) { + const pluginRoot = path.join(params.homeDir, ".openclaw", "extensions", params.pluginId); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + `${JSON.stringify({ name: params.pluginId, ...params.pluginJson }, null, 2)}\n`, + "utf-8", + ); + if (params.settingsJson) { + await fs.writeFile( + path.join(pluginRoot, "settings.json"), + `${JSON.stringify(params.settingsJson, null, 2)}\n`, + "utf-8", + ); + } + if (params.mcpJson) { + await fs.mkdir(path.join(pluginRoot, "servers"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + `${JSON.stringify(params.mcpJson, null, 2)}\n`, + "utf-8", + ); + } + return pluginRoot; } afterEach(async () => { - hoisted.loadPluginManifestRegistry.mockReset(); + clearPluginManifestRegistryCache(); await tempDirs.cleanup(); }); describe("loadEnabledBundlePiSettingsSnapshot", () => { it("loads sanitized settings from enabled bundle plugins", async () => { - const workspaceDir = await tempDirs.make("openclaw-workspace-"); - const pluginRoot = await tempDirs.make("openclaw-bundle-"); - await fs.writeFile( - path.join(pluginRoot, "settings.json"), - JSON.stringify({ - hideThinkingBlock: true, - shellPath: "/tmp/blocked-shell", - compaction: { keepRecentTokens: 64_000 }, - }), - "utf-8", - ); - hoisted.loadPluginManifestRegistry.mockReturnValue(buildRegistry({ pluginRoot })); + const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); + try { + const { homeDir, workspaceDir } = await createHomeAndWorkspace(); + process.env.HOME = homeDir; + process.env.USERPROFILE = homeDir; + delete process.env.OPENCLAW_HOME; + delete process.env.OPENCLAW_STATE_DIR; - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: true }, - }, + await createClaudeBundlePlugin({ + homeDir, + pluginId: "claude-bundle", + settingsJson: { + hideThinkingBlock: true, + shellPath: "/tmp/blocked-shell", + compaction: { keepRecentTokens: 64_000 }, }, - }, - }); + }); - expect(snapshot.hideThinkingBlock).toBe(true); - expect(snapshot.shellPath).toBeUndefined(); - expect(snapshot.compaction?.keepRecentTokens).toBe(64_000); - }); - - it("loads enabled bundle MCP servers into the Pi settings snapshot", async () => { - const workspaceDir = await tempDirs.make("openclaw-workspace-"); - const pluginRoot = await tempDirs.make("openclaw-bundle-"); - await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.mkdir(path.join(pluginRoot, "servers"), { recursive: true }); - await fs.writeFile( - path.join(pluginRoot, ".claude-plugin", "plugin.json"), - JSON.stringify({ - name: "claude-bundle", - }), - "utf-8", - ); - await fs.writeFile( - path.join(pluginRoot, ".mcp.json"), - JSON.stringify({ - mcpServers: { - bundleProbe: { - command: "node", - args: ["./servers/probe.mjs"], - }, - }, - }), - "utf-8", - ); - hoisted.loadPluginManifestRegistry.mockReturnValue( - buildRegistry({ pluginRoot, settingsFiles: [] }), - ); - - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: true }, - }, - }, - }, - }); - - expect(snapshot.mcpServers).toEqual({ - bundleProbe: { - command: "node", - args: [path.join(pluginRoot, "servers", "probe.mjs")], - cwd: pluginRoot, - }, - }); - }); - - it("lets top-level MCP config override bundle MCP defaults", async () => { - const workspaceDir = await tempDirs.make("openclaw-workspace-"); - const pluginRoot = await tempDirs.make("openclaw-bundle-"); - await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.writeFile( - path.join(pluginRoot, ".claude-plugin", "plugin.json"), - JSON.stringify({ - name: "claude-bundle", - }), - "utf-8", - ); - await fs.writeFile( - path.join(pluginRoot, ".mcp.json"), - JSON.stringify({ - mcpServers: { - sharedServer: { - command: "node", - args: ["./servers/bundle.mjs"], - }, - }, - }), - "utf-8", - ); - hoisted.loadPluginManifestRegistry.mockReturnValue( - buildRegistry({ pluginRoot, settingsFiles: [] }), - ); - - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - mcp: { - servers: { - sharedServer: { - url: "https://example.com/mcp", + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: true }, }, }, }, - plugins: { - entries: { - "claude-bundle": { enabled: true }, + }); + + expect(snapshot.hideThinkingBlock).toBe(true); + expect(snapshot.shellPath).toBeUndefined(); + expect(snapshot.compaction?.keepRecentTokens).toBe(64_000); + } finally { + env.restore(); + } + }); + + it("loads enabled bundle MCP servers into the Pi settings snapshot", async () => { + const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); + try { + const { homeDir, workspaceDir } = await createHomeAndWorkspace(); + process.env.HOME = homeDir; + process.env.USERPROFILE = homeDir; + delete process.env.OPENCLAW_HOME; + delete process.env.OPENCLAW_STATE_DIR; + + const pluginRoot = await createClaudeBundlePlugin({ + homeDir, + pluginId: "claude-bundle", + mcpJson: { + mcpServers: { + bundleProbe: { + command: "node", + args: ["./servers/probe.mjs"], + }, }, }, - }, - }); + }); - expect(snapshot.mcpServers).toEqual({ - sharedServer: { - url: "https://example.com/mcp", - }, - }); + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: true }, + }, + }, + }, + }); + const resolvedPluginRoot = await fs.realpath(pluginRoot); + + expect(snapshot.mcpServers).toEqual({ + bundleProbe: { + command: "node", + args: [path.join(resolvedPluginRoot, "servers", "probe.mjs")], + cwd: resolvedPluginRoot, + }, + }); + } finally { + env.restore(); + } + }); + + it("lets top-level MCP config override bundle MCP defaults", async () => { + const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); + try { + const { homeDir, workspaceDir } = await createHomeAndWorkspace(); + process.env.HOME = homeDir; + process.env.USERPROFILE = homeDir; + delete process.env.OPENCLAW_HOME; + delete process.env.OPENCLAW_STATE_DIR; + + await createClaudeBundlePlugin({ + homeDir, + pluginId: "claude-bundle", + mcpJson: { + mcpServers: { + sharedServer: { + command: "node", + args: ["./servers/bundle.mjs"], + }, + }, + }, + }); + + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + mcp: { + servers: { + sharedServer: { + url: "https://example.com/mcp", + }, + }, + }, + plugins: { + entries: { + "claude-bundle": { enabled: true }, + }, + }, + }, + }); + + expect(snapshot.mcpServers).toEqual({ + sharedServer: { + url: "https://example.com/mcp", + }, + }); + } finally { + env.restore(); + } }); it("ignores disabled bundle plugins", async () => { - const workspaceDir = await tempDirs.make("openclaw-workspace-"); - const pluginRoot = await tempDirs.make("openclaw-bundle-"); - await fs.writeFile( - path.join(pluginRoot, "settings.json"), - JSON.stringify({ hideThinkingBlock: true }), - "utf-8", - ); - hoisted.loadPluginManifestRegistry.mockReturnValue(buildRegistry({ pluginRoot })); + const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); + try { + const { homeDir, workspaceDir } = await createHomeAndWorkspace(); + process.env.HOME = homeDir; + process.env.USERPROFILE = homeDir; + delete process.env.OPENCLAW_HOME; + delete process.env.OPENCLAW_STATE_DIR; - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: false }, + await createClaudeBundlePlugin({ + homeDir, + pluginId: "claude-bundle", + settingsJson: { + hideThinkingBlock: true, + }, + }); + + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: false }, + }, }, }, - }, - }); + }); - expect(snapshot).toEqual({}); + expect(snapshot).toEqual({}); + } finally { + env.restore(); + } }); }); diff --git a/src/agents/pi-project-settings.ts b/src/agents/pi-project-settings.ts index fd66a6ee393..9732e8088a9 100644 --- a/src/agents/pi-project-settings.ts +++ b/src/agents/pi-project-settings.ts @@ -5,6 +5,7 @@ import type { OpenClawConfig } from "../config/config.js"; import { applyMergePatch } from "../config/merge-patch.js"; import { openBoundaryFileSync } from "../infra/boundary-file-read.js"; import { createSubsystemLogger } from "../logging/subsystem.js"; +import type { BundleMcpServerConfig } from "../plugins/bundle-mcp.js"; import { normalizePluginsConfig, resolveEffectiveEnableState } from "../plugins/config-state.js"; import { loadPluginManifestRegistry } from "../plugins/manifest-registry.js"; import { isRecord } from "../utils.js"; @@ -18,7 +19,9 @@ export const SANITIZED_PROJECT_PI_KEYS = ["shellPath", "shellCommandPrefix"] as export type EmbeddedPiProjectSettingsPolicy = "trusted" | "sanitize" | "ignore"; -type PiSettingsSnapshot = ReturnType; +type PiSettingsSnapshot = ReturnType & { + mcpServers?: Record; +}; function sanitizePiSettingsSnapshot(settings: PiSettingsSnapshot): PiSettingsSnapshot { const sanitized = { ...settings }; diff --git a/src/cli/mcp-cli.ts b/src/cli/mcp-cli.ts index 62831ee827d..aaeba39bb34 100644 --- a/src/cli/mcp-cli.ts +++ b/src/cli/mcp-cli.ts @@ -10,6 +10,7 @@ import { defaultRuntime } from "../runtime.js"; function fail(message: string): never { defaultRuntime.error(message); defaultRuntime.exit(1); + throw new Error("unreachable"); } function printJson(value: unknown): void { From 2bbf33a9ec4b15446878f840c34092f2af324f08 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:21:11 -0700 Subject: [PATCH 050/187] docs(plugins): add multi-capability ownership example --- docs/tools/plugin.md | 70 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 48acd41e202..da07776d8ce 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -169,6 +169,76 @@ For example, TTS follows this shape: That same pattern should be preferred for future capabilities. +### Multi-capability company plugin example + +A company plugin should feel cohesive from the outside. If OpenClaw has shared +contracts for models, speech, media understanding, and web search, a vendor can +own all of its surfaces in one place: + +```ts +import type { OpenClawPluginDefinition } from "openclaw/plugin-sdk"; +import { + buildOpenAISpeechProvider, + createPluginBackedWebSearchProvider, + describeImageWithModel, + transcribeOpenAiCompatibleAudio, +} from "openclaw/plugin-sdk"; + +const plugin: OpenClawPluginDefinition = { + id: "exampleai", + name: "ExampleAI", + register(api) { + api.registerProvider({ + id: "exampleai", + // auth/model catalog/runtime hooks + }); + + api.registerSpeechProvider( + buildOpenAISpeechProvider({ + id: "exampleai", + // vendor speech config + }), + ); + + api.registerMediaUnderstandingProvider({ + id: "exampleai", + capabilities: ["image", "audio", "video"], + async describeImage(req) { + return describeImageWithModel({ + provider: "exampleai", + model: req.model, + input: req.input, + }); + }, + async transcribeAudio(req) { + return transcribeOpenAiCompatibleAudio({ + provider: "exampleai", + model: req.model, + input: req.input, + }); + }, + }); + + api.registerWebSearchProvider( + createPluginBackedWebSearchProvider({ + id: "exampleai-search", + // credential + fetch logic + }), + ); + }, +}; + +export default plugin; +``` + +What matters is not the exact helper names. The shape matters: + +- one plugin owns the vendor surface +- core still owns the capability contracts +- channels and feature plugins consume `api.runtime.*` helpers, not vendor code +- contract tests can assert that the plugin registered the capabilities it + claims to own + ### Capability example: video understanding OpenClaw already treats image/audio/video understanding as one shared From 223ae42c79b2eccb890b16e433a1d16929f894c7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:22:15 -0700 Subject: [PATCH 051/187] fix(feishu): harden webhook signature compare --- CHANGELOG.md | 1 + extensions/feishu/src/monitor.transport.ts | 11 +++++++- .../feishu/src/monitor.webhook-e2e.test.ts | 28 +++++++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 042332d3844..c6070c789fd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -72,6 +72,7 @@ Docs: https://docs.openclaw.ai - Feishu/actions: expand the runtime action surface with message read/edit, explicit thread replies, pinning, and operator-facing chat/member inspection so Feishu can operate more of the workspace directly. (#47968) Thanks @Takhoffman. - Feishu/topic threads: fetch full thread context, including prior bot replies, when starting a topic-thread session so follow-up turns in Feishu topics keep the right conversation state. (#45254) Thanks @Coobiw. - Feishu/media: keep native image, file, audio, and video/media handling aligned across outbound sends, inbound downloads, thread replies, directory/action aliases, and capability docs so unsupported areas are explicit instead of implied. (#47968) Thanks @Takhoffman. +- Feishu/webhooks: harden signed webhook verification to use constant-time signature comparison and keep malformed short signatures fail-closed in webhook E2E coverage. - WhatsApp/reconnect: restore the append recency filter in the extension inbox monitor and handle protobuf `Long` timestamps correctly, so fresh post-reconnect append messages are processed while stale history sync stays suppressed. (#42588) Thanks @MonkeyLeeT. - WhatsApp/login: wait for pending creds writes before reopening after Baileys `515` pairing restarts in both QR login and `channels login` flows, and keep the restart coverage pinned to the real wrapped error shape plus per-account creds queues. (#27910) Thanks @asyncjason. - Telegram/message send: forward `--force-document` through the `sendPayload` path as well as `sendMedia`, so Telegram payload sends with `channelData` keep uploading images as documents instead of silently falling back to compressed photo sends. (#47119) Thanks @thepagent. diff --git a/extensions/feishu/src/monitor.transport.ts b/extensions/feishu/src/monitor.transport.ts index d619f3cddb3..caab5468378 100644 --- a/extensions/feishu/src/monitor.transport.ts +++ b/extensions/feishu/src/monitor.transport.ts @@ -32,6 +32,15 @@ function isFeishuWebhookPayload(value: unknown): value is Record, @@ -63,7 +72,7 @@ function isFeishuWebhookSignatureValid(params: { .createHash("sha256") .update(timestamp + nonce + encryptKey + JSON.stringify(params.payload)) .digest("hex"); - return computedSignature === signature; + return timingSafeEqualString(computedSignature, signature); } function respondText(res: http.ServerResponse, statusCode: number, body: string): void { diff --git a/extensions/feishu/src/monitor.webhook-e2e.test.ts b/extensions/feishu/src/monitor.webhook-e2e.test.ts index a11957e3393..33035a735f6 100644 --- a/extensions/feishu/src/monitor.webhook-e2e.test.ts +++ b/extensions/feishu/src/monitor.webhook-e2e.test.ts @@ -114,6 +114,34 @@ describe("Feishu webhook signed-request e2e", () => { ); }); + it("rejects malformed short signatures with 401", async () => { + probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" }); + + await withRunningWebhookMonitor( + { + accountId: "short-signature", + path: "/hook-e2e-short-signature", + verificationToken: "verify_token", + encryptKey: "encrypt_key", + }, + monitorFeishuProvider, + async (url) => { + const payload = { type: "url_verification", challenge: "challenge-token" }; + const headers = signFeishuPayload({ encryptKey: "encrypt_key", payload }); + headers["x-lark-signature"] = headers["x-lark-signature"].slice(0, 12); + + const response = await fetch(url, { + method: "POST", + headers, + body: JSON.stringify(payload), + }); + + expect(response.status).toBe(401); + expect(await response.text()).toBe("Invalid signature"); + }, + ); + }); + it("returns 400 for invalid json before invoking the sdk", async () => { probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" }); From 0bf11c1d69fbcfdaba564d5e6d88ee2210be7501 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:18:19 -0700 Subject: [PATCH 052/187] Tests: guard channel setup import seams --- extensions/discord/src/plugin-shared.ts | 2 +- extensions/discord/src/shared.ts | 10 +- extensions/imessage/src/shared.ts | 16 ++- extensions/signal/src/shared.ts | 14 +- extensions/slack/src/shared.ts | 20 ++- extensions/telegram/src/shared.ts | 14 +- extensions/whatsapp/src/shared.ts | 20 +-- .../channel-import-guardrails.test.ts | 131 ++++++++++++++++++ 8 files changed, 178 insertions(+), 49 deletions(-) create mode 100644 src/plugin-sdk/channel-import-guardrails.test.ts diff --git a/extensions/discord/src/plugin-shared.ts b/extensions/discord/src/plugin-shared.ts index f67e04d1a51..d14f8050d30 100644 --- a/extensions/discord/src/plugin-shared.ts +++ b/extensions/discord/src/plugin-shared.ts @@ -3,7 +3,7 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import type { OpenClawConfig } from "openclaw/plugin-sdk/discord"; +import type { OpenClawConfig } from "../../../src/config/config.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/discord/src/shared.ts b/extensions/discord/src/shared.ts index 6a691252052..651e6d987f3 100644 --- a/extensions/discord/src/shared.ts +++ b/extensions/discord/src/shared.ts @@ -3,12 +3,10 @@ import { createScopedAccountConfigAccessors, formatAllowFromLowercase, } from "openclaw/plugin-sdk/compat"; -import { - buildChannelConfigSchema, - DiscordConfigSchema, - getChatChannelMeta, - type ChannelPlugin, -} from "openclaw/plugin-sdk/discord"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { DiscordConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index c4c62f20494..446e76ff39a 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -3,17 +3,19 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/compat"; import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, formatTrimmedAllowFromEntries, - getChatChannelMeta, - IMessageConfigSchema, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, +} from "../../../src/plugin-sdk/channel-config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { + deleteAccountFromConfigSection, setAccountEnabledInConfigSection, - type ChannelPlugin, -} from "openclaw/plugin-sdk/imessage"; +} from "../../../src/channels/plugins/config-helpers.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/signal/src/shared.ts b/extensions/signal/src/shared.ts index 7c914f7ddf2..b1c1982f157 100644 --- a/extensions/signal/src/shared.ts +++ b/extensions/signal/src/shared.ts @@ -4,15 +4,15 @@ import { createScopedAccountConfigAccessors, } from "openclaw/plugin-sdk/compat"; import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, - getChatChannelMeta, - normalizeE164, setAccountEnabledInConfigSection, - SignalConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/signal"; +} from "../../../src/channels/plugins/config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { SignalConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { normalizeE164 } from "../../../src/utils.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/slack/src/shared.ts b/extensions/slack/src/shared.ts index d818eaab196..4471e851097 100644 --- a/extensions/slack/src/shared.ts +++ b/extensions/slack/src/shared.ts @@ -3,18 +3,14 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - formatDocsLink, - hasConfiguredSecretInput, - patchChannelConfigForAccount, - type OpenClawConfig, -} from "openclaw/plugin-sdk/setup"; -import { - buildChannelConfigSchema, - getChatChannelMeta, - SlackConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/slack"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { patchChannelConfigForAccount } from "../../../src/channels/plugins/setup-wizard-helpers.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; +import { SlackConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/shared.ts b/extensions/telegram/src/shared.ts index a1c7945520d..3dec7b28ef5 100644 --- a/extensions/telegram/src/shared.ts +++ b/extensions/telegram/src/shared.ts @@ -3,14 +3,12 @@ import { createScopedAccountConfigAccessors, formatAllowFromLowercase, } from "openclaw/plugin-sdk/compat"; -import { - buildChannelConfigSchema, - getChatChannelMeta, - normalizeAccountId, - TelegramConfigSchema, - type ChannelPlugin, - type OpenClawConfig, -} from "openclaw/plugin-sdk/telegram"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import { TelegramConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { normalizeAccountId } from "../../../src/routing/session-key.js"; import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 43df9bd7e6a..2cdfbd3cf8e 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -1,20 +1,24 @@ import { buildAccountScopedDmSecurityPolicy, - buildChannelConfigSchema, collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, - DEFAULT_ACCOUNT_ID, +} from "openclaw/plugin-sdk/compat"; +import { formatWhatsAppConfigAllowFromEntries, - getChatChannelMeta, - normalizeE164, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, - resolveWhatsAppGroupIntroHint, +} from "../../../src/plugin-sdk/channel-config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { resolveWhatsAppGroupRequireMention, resolveWhatsAppGroupToolPolicy, - WhatsAppConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/whatsapp"; +} from "../../../src/channels/plugins/group-mentions.js"; +import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { normalizeE164 } from "../../../src/utils.js"; import { listWhatsAppAccountIds, resolveDefaultWhatsAppAccountId, diff --git a/src/plugin-sdk/channel-import-guardrails.test.ts b/src/plugin-sdk/channel-import-guardrails.test.ts new file mode 100644 index 00000000000..51905b66b02 --- /dev/null +++ b/src/plugin-sdk/channel-import-guardrails.test.ts @@ -0,0 +1,131 @@ +import { readFileSync } from "node:fs"; +import { dirname, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { describe, expect, it } from "vitest"; + +const ROOT_DIR = resolve(dirname(fileURLToPath(import.meta.url)), ".."); + +type GuardedSource = { + path: string; + forbiddenPatterns: RegExp[]; +}; + +const SAME_CHANNEL_SDK_GUARDS: GuardedSource[] = [ + { + path: "extensions/discord/src/plugin-shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/discord/, /plugin-sdk-internal\/discord/], + }, + { + path: "extensions/discord/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/discord/, /plugin-sdk-internal\/discord/], + }, + { + path: "extensions/slack/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/slack/, /plugin-sdk-internal\/slack/], + }, + { + path: "extensions/telegram/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/telegram/, /plugin-sdk-internal\/telegram/], + }, + { + path: "extensions/imessage/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/imessage/, /plugin-sdk-internal\/imessage/], + }, + { + path: "extensions/whatsapp/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/whatsapp/, /plugin-sdk-internal\/whatsapp/], + }, + { + path: "extensions/signal/src/shared.ts", + forbiddenPatterns: [/openclaw\/plugin-sdk\/signal/, /plugin-sdk-internal\/signal/], + }, +]; + +const SETUP_BARREL_GUARDS: GuardedSource[] = [ + { + path: "extensions/signal/src/setup-core.ts", + forbiddenPatterns: [/\bformatCliCommand\b/, /\bformatDocsLink\b/], + }, + { + path: "extensions/signal/src/setup-surface.ts", + forbiddenPatterns: [ + /\bdetectBinary\b/, + /\binstallSignalCli\b/, + /\bformatCliCommand\b/, + /\bformatDocsLink\b/, + ], + }, + { + path: "extensions/slack/src/setup-core.ts", + forbiddenPatterns: [/\bformatDocsLink\b/], + }, + { + path: "extensions/slack/src/setup-surface.ts", + forbiddenPatterns: [/\bformatDocsLink\b/], + }, + { + path: "extensions/discord/src/setup-core.ts", + forbiddenPatterns: [/\bformatDocsLink\b/], + }, + { + path: "extensions/discord/src/setup-surface.ts", + forbiddenPatterns: [/\bformatDocsLink\b/], + }, + { + path: "extensions/imessage/src/setup-core.ts", + forbiddenPatterns: [/\bformatDocsLink\b/], + }, + { + path: "extensions/imessage/src/setup-surface.ts", + forbiddenPatterns: [/\bdetectBinary\b/, /\bformatDocsLink\b/], + }, + { + path: "extensions/telegram/src/setup-core.ts", + forbiddenPatterns: [/\bformatCliCommand\b/, /\bformatDocsLink\b/], + }, + { + path: "extensions/whatsapp/src/setup-surface.ts", + forbiddenPatterns: [/\bformatCliCommand\b/, /\bformatDocsLink\b/], + }, +]; + +function readSource(path: string): string { + return readFileSync(resolve(ROOT_DIR, "..", path), "utf8"); +} + +function readSetupBarrelImportBlock(path: string): string { + const lines = readSource(path).split("\n"); + const targetLineIndex = lines.findIndex((line) => + /from\s*"[^"]*plugin-sdk(?:-internal)?\/setup(?:\.js)?";/.test(line), + ); + if (targetLineIndex === -1) { + return ""; + } + let startLineIndex = targetLineIndex; + while (startLineIndex >= 0 && !lines[startLineIndex].includes("import")) { + startLineIndex -= 1; + } + return lines.slice(startLineIndex, targetLineIndex + 1).join("\n"); +} + +describe("channel import guardrails", () => { + it("keeps channel helper modules off their own SDK barrels", () => { + for (const source of SAME_CHANNEL_SDK_GUARDS) { + const text = readSource(source.path); + for (const pattern of source.forbiddenPatterns) { + expect(text, `${source.path} should not match ${pattern}`).not.toMatch(pattern); + } + } + }); + + it("keeps setup barrels limited to setup primitives", () => { + for (const source of SETUP_BARREL_GUARDS) { + const importBlock = readSetupBarrelImportBlock(source.path); + for (const pattern of source.forbiddenPatterns) { + expect(importBlock, `${source.path} setup import should not match ${pattern}`).not.toMatch( + pattern, + ); + } + } + }); +}); From 6c866b8543beb3ef9ed058b017d008734dd0e9ea Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:26:55 -0700 Subject: [PATCH 053/187] Tests: centralize contract coverage follow-ups (#48751) * Plugins: harden global contract coverage * Channels: tighten global contract coverage * Channels: centralize inbound contract coverage * Channels: move inbound contract helpers into core * Tests: rename local inbound context checks * Tests: stabilize contract runner profile * Tests: split scoped contract lanes * Channels: move inbound dispatch testkit into contracts * Plugins: share provider contract registry helpers * Plugins: reuse provider contract registry helpers --- CONTRIBUTING.md | 1 + ...> message-handler.inbound-context.test.ts} | 4 +- ... => event-handler.inbound-context.test.ts} | 2 +- .../event-handler.mention-gating.test.ts | 2 +- ...> process-message.inbound-context.test.ts} | 2 +- package.json | 4 +- .../contracts/directory.contract.test.ts | 4 +- .../contracts}/dispatch-inbound-capture.ts | 0 .../contracts}/inbound-contract-capture.ts | 4 +- .../inbound-contract-dispatch-mock.ts | 2 +- .../contracts/inbound.contract.test.ts | 299 ++++++++++ .../inbound.discord.contract.test.ts | 24 - .../contracts/inbound.signal.contract.test.ts | 73 --- .../contracts/inbound.slack.contract.test.ts | 54 -- .../inbound.telegram.contract.test.ts | 60 -- .../inbound.whatsapp.contract.test.ts | 111 ---- .../contracts/registry.contract.test.ts | 71 ++- src/channels/plugins/contracts/registry.ts | 516 +++++++++++------- .../session-binding.contract.test.ts | 159 +----- src/channels/plugins/contracts/suites.ts | 28 +- .../contracts/auth-choice.contract.test.ts | 44 +- .../contracts/catalog.contract.test.ts | 25 +- src/plugins/contracts/loader.contract.test.ts | 9 +- .../contracts/registry.contract.test.ts | 41 ++ src/plugins/contracts/registry.ts | 31 ++ .../contracts/runtime.contract.test.ts | 51 +- src/plugins/contracts/wizard.contract.test.ts | 27 +- 27 files changed, 855 insertions(+), 793 deletions(-) rename extensions/discord/src/monitor/{message-handler.inbound-contract.test.ts => message-handler.inbound-context.test.ts} (91%) rename extensions/signal/src/monitor/{event-handler.inbound-contract.test.ts => event-handler.inbound-context.test.ts} (99%) rename extensions/whatsapp/src/auto-reply/monitor/{process-message.inbound-contract.test.ts => process-message.inbound-context.test.ts} (99%) rename {test/helpers => src/channels/plugins/contracts}/dispatch-inbound-capture.ts (100%) rename {test/helpers => src/channels/plugins/contracts}/inbound-contract-capture.ts (76%) rename {test/helpers => src/channels/plugins/contracts}/inbound-contract-dispatch-mock.ts (82%) create mode 100644 src/channels/plugins/contracts/inbound.contract.test.ts delete mode 100644 src/channels/plugins/contracts/inbound.discord.contract.test.ts delete mode 100644 src/channels/plugins/contracts/inbound.signal.contract.test.ts delete mode 100644 src/channels/plugins/contracts/inbound.slack.contract.test.ts delete mode 100644 src/channels/plugins/contracts/inbound.telegram.contract.test.ts delete mode 100644 src/channels/plugins/contracts/inbound.whatsapp.contract.test.ts diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0327a8ad62..14a9b3c8bcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,6 +93,7 @@ Welcome to the lobster tank! 🦞 - `pnpm test:extension ` - `pnpm test:extension --list` to see valid extension ids - If you changed shared plugin or channel surfaces, run `pnpm test:contracts` + - For targeted shared-surface work, use `pnpm test:contracts:channels` or `pnpm test:contracts:plugins` - If you changed broader runtime behavior, still run the relevant wider lanes (`pnpm test:extensions`, `pnpm test:channels`, or `pnpm test`) before asking for review - If you have access to Codex, run `codex review --base origin/main` locally before opening or updating your PR. Treat this as the current highest standard of AI review, even if GitHub Codex review also runs. - Ensure CI checks pass diff --git a/extensions/discord/src/monitor/message-handler.inbound-contract.test.ts b/extensions/discord/src/monitor/message-handler.inbound-context.test.ts similarity index 91% rename from extensions/discord/src/monitor/message-handler.inbound-contract.test.ts rename to extensions/discord/src/monitor/message-handler.inbound-context.test.ts index 6421d24a61a..6eb378e7bbb 100644 --- a/extensions/discord/src/monitor/message-handler.inbound-contract.test.ts +++ b/extensions/discord/src/monitor/message-handler.inbound-context.test.ts @@ -1,6 +1,6 @@ import { describe, expect, it } from "vitest"; +import { inboundCtxCapture as capture } from "../../../../src/channels/plugins/contracts/inbound-contract-dispatch-mock.js"; import { expectChannelInboundContextContract as expectInboundContextContract } from "../../../../src/channels/plugins/contracts/suites.js"; -import { inboundCtxCapture as capture } from "../../../../test/helpers/inbound-contract-dispatch-mock.js"; import type { DiscordMessagePreflightContext } from "./message-handler.preflight.js"; import { processDiscordMessage } from "./message-handler.process.js"; import { @@ -8,7 +8,7 @@ import { createDiscordDirectMessageContextOverrides, } from "./message-handler.test-harness.js"; -describe("discord processDiscordMessage inbound contract", () => { +describe("discord processDiscordMessage inbound context", () => { it("passes a finalized MsgContext to dispatchInboundMessage", async () => { capture.ctx = undefined; const messageCtx = await createBaseDiscordMessageContext({ diff --git a/extensions/signal/src/monitor/event-handler.inbound-contract.test.ts b/extensions/signal/src/monitor/event-handler.inbound-context.test.ts similarity index 99% rename from extensions/signal/src/monitor/event-handler.inbound-contract.test.ts rename to extensions/signal/src/monitor/event-handler.inbound-context.test.ts index 9a6cfc0e90e..3aafda7fe3d 100644 --- a/extensions/signal/src/monitor/event-handler.inbound-contract.test.ts +++ b/extensions/signal/src/monitor/event-handler.inbound-context.test.ts @@ -49,7 +49,7 @@ vi.mock("../../../../src/pairing/pairing-store.js", () => ({ upsertChannelPairingRequest: vi.fn(), })); -describe("signal createSignalEventHandler inbound contract", () => { +describe("signal createSignalEventHandler inbound context", () => { beforeEach(() => { capture.ctx = undefined; sendTypingMock.mockReset().mockResolvedValue(true); diff --git a/extensions/signal/src/monitor/event-handler.mention-gating.test.ts b/extensions/signal/src/monitor/event-handler.mention-gating.test.ts index 05836c43975..60222d4a7ab 100644 --- a/extensions/signal/src/monitor/event-handler.mention-gating.test.ts +++ b/extensions/signal/src/monitor/event-handler.mention-gating.test.ts @@ -1,7 +1,7 @@ import { describe, expect, it, vi } from "vitest"; import type { MsgContext } from "../../../../src/auto-reply/templating.js"; +import { buildDispatchInboundCaptureMock } from "../../../../src/channels/plugins/contracts/dispatch-inbound-capture.js"; import type { OpenClawConfig } from "../../../../src/config/types.js"; -import { buildDispatchInboundCaptureMock } from "../../../../test/helpers/dispatch-inbound-capture.js"; import { createBaseSignalEventHandlerDeps, createSignalReceiveEvent, diff --git a/extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-contract.test.ts b/extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-context.test.ts similarity index 99% rename from extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-contract.test.ts rename to extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-context.test.ts index 566c8a76e1e..c6db2affda3 100644 --- a/extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-contract.test.ts +++ b/extensions/whatsapp/src/auto-reply/monitor/process-message.inbound-context.test.ts @@ -109,7 +109,7 @@ vi.mock("../deliver-reply.js", () => ({ import { updateLastRouteInBackground } from "./last-route.js"; import { processMessage } from "./process-message.js"; -describe("web processMessage inbound contract", () => { +describe("web processMessage inbound context", () => { beforeEach(async () => { capturedCtx = undefined; capturedDispatchParams = undefined; diff --git a/package.json b/package.json index afbcb632ed0..c22a05548cd 100644 --- a/package.json +++ b/package.json @@ -488,7 +488,9 @@ "test:all": "pnpm lint && pnpm build && pnpm test && pnpm test:e2e && pnpm test:live && pnpm test:docker:all", "test:auth:compat": "vitest run --config vitest.gateway.config.ts src/gateway/server.auth.compat-baseline.test.ts src/gateway/client.test.ts src/gateway/reconnect-gating.test.ts src/gateway/protocol/connect-error-details.test.ts", "test:channels": "vitest run --config vitest.channels.config.ts", - "test:contracts": "pnpm test -- src/channels/plugins/contracts src/plugins/contracts", + "test:contracts": "pnpm test:contracts:channels && pnpm test:contracts:plugins", + "test:contracts:channels": "OPENCLAW_TEST_PROFILE=low pnpm test -- src/channels/plugins/contracts", + "test:contracts:plugins": "OPENCLAW_TEST_PROFILE=low pnpm test -- src/plugins/contracts", "test:coverage": "vitest run --config vitest.unit.config.ts --coverage", "test:docker:all": "pnpm test:docker:live-models && pnpm test:docker:live-gateway && pnpm test:docker:onboard && pnpm test:docker:gateway-network && pnpm test:docker:qr && pnpm test:docker:doctor-switch && pnpm test:docker:plugins && pnpm test:docker:cleanup", "test:docker:cleanup": "bash scripts/test-cleanup-docker.sh", diff --git a/src/channels/plugins/contracts/directory.contract.test.ts b/src/channels/plugins/contracts/directory.contract.test.ts index 97969adc35b..d664f003531 100644 --- a/src/channels/plugins/contracts/directory.contract.test.ts +++ b/src/channels/plugins/contracts/directory.contract.test.ts @@ -6,7 +6,9 @@ for (const entry of directoryContractRegistry) { describe(`${entry.id} directory contract`, () => { installChannelDirectoryContractSuite({ plugin: entry.plugin, - invokeLookups: entry.invokeLookups, + coverage: entry.coverage, + cfg: entry.cfg, + accountId: entry.accountId, }); }); } diff --git a/test/helpers/dispatch-inbound-capture.ts b/src/channels/plugins/contracts/dispatch-inbound-capture.ts similarity index 100% rename from test/helpers/dispatch-inbound-capture.ts rename to src/channels/plugins/contracts/dispatch-inbound-capture.ts diff --git a/test/helpers/inbound-contract-capture.ts b/src/channels/plugins/contracts/inbound-contract-capture.ts similarity index 76% rename from test/helpers/inbound-contract-capture.ts rename to src/channels/plugins/contracts/inbound-contract-capture.ts index ccc61d010f5..b74164c7a79 100644 --- a/test/helpers/inbound-contract-capture.ts +++ b/src/channels/plugins/contracts/inbound-contract-capture.ts @@ -1,4 +1,4 @@ -import type { MsgContext } from "../../src/auto-reply/templating.js"; +import type { MsgContext } from "../../../auto-reply/templating.js"; import { buildDispatchInboundCaptureMock } from "./dispatch-inbound-capture.js"; export type InboundContextCapture = { @@ -13,7 +13,7 @@ export async function buildDispatchInboundContextCapture( importOriginal: >() => Promise, capture: InboundContextCapture, ) { - const actual = await importOriginal(); + const actual = await importOriginal(); return buildDispatchInboundCaptureMock(actual, (ctx) => { capture.ctx = ctx as MsgContext; }); diff --git a/test/helpers/inbound-contract-dispatch-mock.ts b/src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts similarity index 82% rename from test/helpers/inbound-contract-dispatch-mock.ts rename to src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts index 6193ae245c1..05698d628c5 100644 --- a/test/helpers/inbound-contract-dispatch-mock.ts +++ b/src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts @@ -4,6 +4,6 @@ import { buildDispatchInboundContextCapture } from "./inbound-contract-capture.j export const inboundCtxCapture = createInboundContextCapture(); -vi.mock("../../src/auto-reply/dispatch.js", async (importOriginal) => { +vi.mock("../../../auto-reply/dispatch.js", async (importOriginal) => { return await buildDispatchInboundContextCapture(importOriginal, inboundCtxCapture); }); diff --git a/src/channels/plugins/contracts/inbound.contract.test.ts b/src/channels/plugins/contracts/inbound.contract.test.ts new file mode 100644 index 00000000000..e90e5090e6b --- /dev/null +++ b/src/channels/plugins/contracts/inbound.contract.test.ts @@ -0,0 +1,299 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import type { ResolvedSlackAccount } from "../../../../extensions/slack/src/accounts.js"; +import { prepareSlackMessage } from "../../../../extensions/slack/src/monitor/message-handler/prepare.js"; +import { createInboundSlackTestContext } from "../../../../extensions/slack/src/monitor/message-handler/prepare.test-helpers.js"; +import type { SlackMessageEvent } from "../../../../extensions/slack/src/types.js"; +import type { MsgContext } from "../../../auto-reply/templating.js"; +import type { OpenClawConfig } from "../../../config/config.js"; +import { inboundCtxCapture } from "./inbound-contract-dispatch-mock.js"; +import { expectChannelInboundContextContract } from "./suites.js"; + +const signalCapture = vi.hoisted(() => ({ ctx: undefined as MsgContext | undefined })); +const bufferedReplyCapture = vi.hoisted(() => ({ + ctx: undefined as MsgContext | undefined, +})); +const dispatchInboundMessageMock = vi.hoisted(() => + vi.fn( + async (params: { + ctx: MsgContext; + replyOptions?: { onReplyStart?: () => void | Promise }; + }) => { + signalCapture.ctx = params.ctx; + await Promise.resolve(params.replyOptions?.onReplyStart?.()); + return { queuedFinal: false, counts: { tool: 0, block: 0, final: 0 } }; + }, + ), +); + +vi.mock("../../../auto-reply/dispatch.js", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + dispatchInboundMessage: dispatchInboundMessageMock, + dispatchInboundMessageWithDispatcher: dispatchInboundMessageMock, + dispatchInboundMessageWithBufferedDispatcher: dispatchInboundMessageMock, + }; +}); + +vi.mock("../../../auto-reply/reply/provider-dispatcher.js", () => ({ + dispatchReplyWithBufferedBlockDispatcher: vi.fn(async (params: { ctx: MsgContext }) => { + bufferedReplyCapture.ctx = params.ctx; + return { queuedFinal: false }; + }), +})); + +vi.mock("../../../../extensions/signal/src/send.js", () => ({ + sendMessageSignal: vi.fn(), + sendTypingSignal: vi.fn(async () => true), + sendReadReceiptSignal: vi.fn(async () => true), +})); + +vi.mock("../../../pairing/pairing-store.js", () => ({ + readChannelAllowFromStore: vi.fn().mockResolvedValue([]), + upsertChannelPairingRequest: vi.fn(), +})); + +vi.mock("../../../../extensions/whatsapp/src/auto-reply/monitor/last-route.js", () => ({ + trackBackgroundTask: (tasks: Set>, task: Promise) => { + tasks.add(task); + void task.finally(() => { + tasks.delete(task); + }); + }, + updateLastRouteInBackground: vi.fn(), +})); + +vi.mock("../../../../extensions/whatsapp/src/auto-reply/deliver-reply.js", () => ({ + deliverWebReply: vi.fn(async () => {}), +})); + +const { processDiscordMessage } = + await import("../../../../extensions/discord/src/monitor/message-handler.process.js"); +const { createBaseDiscordMessageContext, createDiscordDirectMessageContextOverrides } = + await import("../../../../extensions/discord/src/monitor/message-handler.test-harness.js"); +const { createSignalEventHandler } = + await import("../../../../extensions/signal/src/monitor/event-handler.js"); +const { createBaseSignalEventHandlerDeps, createSignalReceiveEvent } = + await import("../../../../extensions/signal/src/monitor/event-handler.test-harness.js"); +const { processMessage } = + await import("../../../../extensions/whatsapp/src/auto-reply/monitor/process-message.js"); + +function createSlackAccount(config: ResolvedSlackAccount["config"] = {}): ResolvedSlackAccount { + return { + accountId: "default", + enabled: true, + botTokenSource: "config", + appTokenSource: "config", + userTokenSource: "none", + config, + replyToMode: config.replyToMode, + replyToModeByChatType: config.replyToModeByChatType, + dm: config.dm, + }; +} + +function createSlackMessage(overrides: Partial): SlackMessageEvent { + return { + channel: "D123", + channel_type: "im", + user: "U1", + text: "hi", + ts: "1.000", + ...overrides, + } as SlackMessageEvent; +} + +function makeWhatsAppProcessArgs(sessionStorePath: string) { + return { + // oxlint-disable-next-line typescript/no-explicit-any + cfg: { messages: {}, session: { store: sessionStorePath } } as any, + // oxlint-disable-next-line typescript/no-explicit-any + msg: { + id: "msg1", + from: "123@g.us", + to: "+15550001111", + chatType: "group", + body: "hi", + senderName: "Alice", + senderJid: "alice@s.whatsapp.net", + senderE164: "+15550002222", + groupSubject: "Test Group", + groupParticipants: [], + } as unknown as Record, + route: { + agentId: "main", + accountId: "default", + sessionKey: "agent:main:whatsapp:group:123", + // oxlint-disable-next-line typescript/no-explicit-any + } as any, + groupHistoryKey: "123@g.us", + groupHistories: new Map(), + groupMemberNames: new Map(), + connectionId: "conn", + verbose: false, + maxMediaBytes: 1, + // oxlint-disable-next-line typescript/no-explicit-any + replyResolver: (async () => undefined) as any, + // oxlint-disable-next-line typescript/no-explicit-any + replyLogger: { info: () => {}, warn: () => {}, error: () => {}, debug: () => {} } as any, + backgroundTasks: new Set>(), + rememberSentText: () => {}, + echoHas: () => false, + echoForget: () => {}, + buildCombinedEchoKey: () => "echo", + groupHistory: [], + // oxlint-disable-next-line typescript/no-explicit-any + } as any; +} + +async function removeDirEventually(dir: string) { + for (let attempt = 0; attempt < 3; attempt += 1) { + try { + await fs.rm(dir, { recursive: true, force: true }); + return; + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ENOTEMPTY" || attempt === 2) { + throw error; + } + await new Promise((resolve) => setTimeout(resolve, 25)); + } + } +} + +describe("channel inbound contract", () => { + let whatsappSessionDir = ""; + + beforeEach(() => { + inboundCtxCapture.ctx = undefined; + signalCapture.ctx = undefined; + bufferedReplyCapture.ctx = undefined; + dispatchInboundMessageMock.mockClear(); + }); + + afterEach(async () => { + if (whatsappSessionDir) { + await removeDirEventually(whatsappSessionDir); + whatsappSessionDir = ""; + } + }); + + it("keeps Discord inbound context finalized", async () => { + const messageCtx = await createBaseDiscordMessageContext({ + cfg: { messages: {} }, + ackReactionScope: "direct", + ...createDiscordDirectMessageContextOverrides(), + }); + + await processDiscordMessage(messageCtx); + + expect(inboundCtxCapture.ctx).toBeTruthy(); + expectChannelInboundContextContract(inboundCtxCapture.ctx!); + }); + + it("keeps Signal inbound context finalized", async () => { + const handler = createSignalEventHandler( + createBaseSignalEventHandlerDeps({ + // oxlint-disable-next-line typescript/no-explicit-any + cfg: { messages: { inbound: { debounceMs: 0 } } } as any, + historyLimit: 0, + }), + ); + + await handler( + createSignalReceiveEvent({ + dataMessage: { + message: "hi", + attachments: [], + groupInfo: { groupId: "g1", groupName: "Test Group" }, + }, + }), + ); + + expect(signalCapture.ctx).toBeTruthy(); + expectChannelInboundContextContract(signalCapture.ctx!); + }); + + it("keeps Slack inbound context finalized", async () => { + const ctx = createInboundSlackTestContext({ + cfg: { + channels: { slack: { enabled: true } }, + } as OpenClawConfig, + }); + // oxlint-disable-next-line typescript/no-explicit-any + ctx.resolveUserName = async () => ({ name: "Alice" }) as any; + + const prepared = await prepareSlackMessage({ + ctx, + account: createSlackAccount(), + message: createSlackMessage({}), + opts: { source: "message" }, + }); + + expect(prepared).toBeTruthy(); + expectChannelInboundContextContract(prepared!.ctxPayload); + }); + + it("keeps Telegram inbound context finalized", async () => { + const { getLoadConfigMock, getOnHandler, onSpy, sendMessageSpy } = + await import("../../../../extensions/telegram/src/bot.create-telegram-bot.test-harness.js"); + const { resetInboundDedupe } = await import("../../../auto-reply/reply/inbound-dedupe.js"); + + resetInboundDedupe(); + onSpy.mockReset(); + sendMessageSpy.mockReset(); + sendMessageSpy.mockResolvedValue({ message_id: 77 }); + getLoadConfigMock().mockReset(); + getLoadConfigMock().mockReturnValue({ + agents: { + defaults: { + envelopeTimezone: "utc", + }, + }, + channels: { + telegram: { + groupPolicy: "open", + groups: { "*": { requireMention: false } }, + }, + }, + } satisfies OpenClawConfig); + + const { createTelegramBot } = await import("../../../../extensions/telegram/src/bot.js"); + + createTelegramBot({ token: "tok" }); + const handler = getOnHandler("message") as (ctx: Record) => Promise; + + await handler({ + message: { + chat: { id: 42, type: "group", title: "Ops" }, + text: "hello", + date: 1736380800, + message_id: 2, + from: { + id: 99, + first_name: "Ada", + last_name: "Lovelace", + username: "ada", + }, + }, + me: { username: "openclaw_bot" }, + getFile: async () => ({ download: async () => new Uint8Array() }), + }); + + const payload = bufferedReplyCapture.ctx; + expect(payload).toBeTruthy(); + expectChannelInboundContextContract(payload!); + }); + + it("keeps WhatsApp inbound context finalized", async () => { + whatsappSessionDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-whatsapp-contract-")); + const sessionStorePath = path.join(whatsappSessionDir, "sessions.json"); + + await processMessage(makeWhatsAppProcessArgs(sessionStorePath)); + + expect(bufferedReplyCapture.ctx).toBeTruthy(); + expectChannelInboundContextContract(bufferedReplyCapture.ctx!); + }); +}); diff --git a/src/channels/plugins/contracts/inbound.discord.contract.test.ts b/src/channels/plugins/contracts/inbound.discord.contract.test.ts deleted file mode 100644 index 6b168f7d244..00000000000 --- a/src/channels/plugins/contracts/inbound.discord.contract.test.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { describe, expect, it } from "vitest"; -import { inboundCtxCapture } from "../../../../test/helpers/inbound-contract-dispatch-mock.js"; -import { expectChannelInboundContextContract } from "./suites.js"; - -const { processDiscordMessage } = - await import("../../../../extensions/discord/src/monitor/message-handler.process.js"); -const { createBaseDiscordMessageContext, createDiscordDirectMessageContextOverrides } = - await import("../../../../extensions/discord/src/monitor/message-handler.test-harness.js"); - -describe("discord inbound contract", () => { - it("keeps inbound context finalized", async () => { - inboundCtxCapture.ctx = undefined; - const messageCtx = await createBaseDiscordMessageContext({ - cfg: { messages: {} }, - ackReactionScope: "direct", - ...createDiscordDirectMessageContextOverrides(), - }); - - await processDiscordMessage(messageCtx); - - expect(inboundCtxCapture.ctx).toBeTruthy(); - expectChannelInboundContextContract(inboundCtxCapture.ctx!); - }); -}); diff --git a/src/channels/plugins/contracts/inbound.signal.contract.test.ts b/src/channels/plugins/contracts/inbound.signal.contract.test.ts deleted file mode 100644 index abec31c0174..00000000000 --- a/src/channels/plugins/contracts/inbound.signal.contract.test.ts +++ /dev/null @@ -1,73 +0,0 @@ -import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createSignalEventHandler } from "../../../../extensions/signal/src/monitor/event-handler.js"; -import { - createBaseSignalEventHandlerDeps, - createSignalReceiveEvent, -} from "../../../../extensions/signal/src/monitor/event-handler.test-harness.js"; -import type { MsgContext } from "../../../auto-reply/templating.js"; -import { expectChannelInboundContextContract } from "./suites.js"; - -const capture = vi.hoisted(() => ({ ctx: undefined as MsgContext | undefined })); -const dispatchInboundMessageMock = vi.hoisted(() => - vi.fn( - async (params: { - ctx: MsgContext; - replyOptions?: { onReplyStart?: () => void | Promise }; - }) => { - capture.ctx = params.ctx; - await Promise.resolve(params.replyOptions?.onReplyStart?.()); - return { queuedFinal: false, counts: { tool: 0, block: 0, final: 0 } }; - }, - ), -); - -vi.mock("../../../auto-reply/dispatch.js", async (importOriginal) => { - const actual = await importOriginal(); - return { - ...actual, - dispatchInboundMessage: dispatchInboundMessageMock, - dispatchInboundMessageWithDispatcher: dispatchInboundMessageMock, - dispatchInboundMessageWithBufferedDispatcher: dispatchInboundMessageMock, - }; -}); - -vi.mock("../../../../extensions/signal/src/send.js", () => ({ - sendMessageSignal: vi.fn(), - sendTypingSignal: vi.fn(async () => true), - sendReadReceiptSignal: vi.fn(async () => true), -})); - -vi.mock("../../../pairing/pairing-store.js", () => ({ - readChannelAllowFromStore: vi.fn().mockResolvedValue([]), - upsertChannelPairingRequest: vi.fn(), -})); - -describe("signal inbound contract", () => { - beforeEach(() => { - capture.ctx = undefined; - dispatchInboundMessageMock.mockClear(); - }); - - it("keeps inbound context finalized", async () => { - const handler = createSignalEventHandler( - createBaseSignalEventHandlerDeps({ - // oxlint-disable-next-line typescript/no-explicit-any - cfg: { messages: { inbound: { debounceMs: 0 } } } as any, - historyLimit: 0, - }), - ); - - await handler( - createSignalReceiveEvent({ - dataMessage: { - message: "hi", - attachments: [], - groupInfo: { groupId: "g1", groupName: "Test Group" }, - }, - }), - ); - - expect(capture.ctx).toBeTruthy(); - expectChannelInboundContextContract(capture.ctx!); - }); -}); diff --git a/src/channels/plugins/contracts/inbound.slack.contract.test.ts b/src/channels/plugins/contracts/inbound.slack.contract.test.ts deleted file mode 100644 index e013bed3b4f..00000000000 --- a/src/channels/plugins/contracts/inbound.slack.contract.test.ts +++ /dev/null @@ -1,54 +0,0 @@ -import { describe, expect, it } from "vitest"; -import type { ResolvedSlackAccount } from "../../../../extensions/slack/src/accounts.js"; -import { prepareSlackMessage } from "../../../../extensions/slack/src/monitor/message-handler/prepare.js"; -import { createInboundSlackTestContext } from "../../../../extensions/slack/src/monitor/message-handler/prepare.test-helpers.js"; -import type { SlackMessageEvent } from "../../../../extensions/slack/src/types.js"; -import type { OpenClawConfig } from "../../../config/config.js"; -import { expectChannelInboundContextContract } from "./suites.js"; - -function createSlackAccount(config: ResolvedSlackAccount["config"] = {}): ResolvedSlackAccount { - return { - accountId: "default", - enabled: true, - botTokenSource: "config", - appTokenSource: "config", - userTokenSource: "none", - config, - replyToMode: config.replyToMode, - replyToModeByChatType: config.replyToModeByChatType, - dm: config.dm, - }; -} - -function createSlackMessage(overrides: Partial): SlackMessageEvent { - return { - channel: "D123", - channel_type: "im", - user: "U1", - text: "hi", - ts: "1.000", - ...overrides, - } as SlackMessageEvent; -} - -describe("slack inbound contract", () => { - it("keeps inbound context finalized", async () => { - const ctx = createInboundSlackTestContext({ - cfg: { - channels: { slack: { enabled: true } }, - } as OpenClawConfig, - }); - // oxlint-disable-next-line typescript/no-explicit-any - ctx.resolveUserName = async () => ({ name: "Alice" }) as any; - - const prepared = await prepareSlackMessage({ - ctx, - account: createSlackAccount(), - message: createSlackMessage({}), - opts: { source: "message" }, - }); - - expect(prepared).toBeTruthy(); - expectChannelInboundContextContract(prepared!.ctxPayload); - }); -}); diff --git a/src/channels/plugins/contracts/inbound.telegram.contract.test.ts b/src/channels/plugins/contracts/inbound.telegram.contract.test.ts deleted file mode 100644 index a872964bd53..00000000000 --- a/src/channels/plugins/contracts/inbound.telegram.contract.test.ts +++ /dev/null @@ -1,60 +0,0 @@ -import { beforeEach, describe, expect, it } from "vitest"; -import { - getLoadConfigMock, - getOnHandler, - onSpy, - replySpy, -} from "../../../../extensions/telegram/src/bot.create-telegram-bot.test-harness.js"; -import type { MsgContext } from "../../../auto-reply/templating.js"; -import type { OpenClawConfig } from "../../../config/config.js"; -import { expectChannelInboundContextContract } from "./suites.js"; - -const { createTelegramBot } = await import("../../../../extensions/telegram/src/bot.js"); - -describe("telegram inbound contract", () => { - const loadConfig = getLoadConfigMock(); - - beforeEach(() => { - onSpy.mockClear(); - replySpy.mockClear(); - loadConfig.mockReturnValue({ - agents: { - defaults: { - envelopeTimezone: "utc", - }, - }, - channels: { - telegram: { - groupPolicy: "open", - groups: { "*": { requireMention: false } }, - }, - }, - } satisfies OpenClawConfig); - }); - - it("keeps inbound context finalized", async () => { - createTelegramBot({ token: "tok" }); - const handler = getOnHandler("message") as (ctx: Record) => Promise; - - await handler({ - message: { - chat: { id: 42, type: "group", title: "Ops" }, - text: "hello", - date: 1736380800, - message_id: 2, - from: { - id: 99, - first_name: "Ada", - last_name: "Lovelace", - username: "ada", - }, - }, - me: { username: "openclaw_bot" }, - getFile: async () => ({ download: async () => new Uint8Array() }), - }); - - const payload = replySpy.mock.calls[0]?.[0] as MsgContext | undefined; - expect(payload).toBeTruthy(); - expectChannelInboundContextContract(payload!); - }); -}); diff --git a/src/channels/plugins/contracts/inbound.whatsapp.contract.test.ts b/src/channels/plugins/contracts/inbound.whatsapp.contract.test.ts deleted file mode 100644 index 108131226aa..00000000000 --- a/src/channels/plugins/contracts/inbound.whatsapp.contract.test.ts +++ /dev/null @@ -1,111 +0,0 @@ -import fs from "node:fs/promises"; -import os from "node:os"; -import path from "node:path"; -import { afterEach, describe, expect, it, vi } from "vitest"; -import { processMessage } from "../../../../extensions/whatsapp/src/auto-reply/monitor/process-message.js"; -import type { MsgContext } from "../../../auto-reply/templating.js"; -import { expectChannelInboundContextContract } from "./suites.js"; - -const capture = vi.hoisted(() => ({ - ctx: undefined as MsgContext | undefined, -})); - -vi.mock("../../../auto-reply/reply/provider-dispatcher.js", () => ({ - dispatchReplyWithBufferedBlockDispatcher: vi.fn(async (params: { ctx: MsgContext }) => { - capture.ctx = params.ctx; - return { queuedFinal: false }; - }), -})); - -vi.mock("../../../../extensions/whatsapp/src/auto-reply/monitor/last-route.js", () => ({ - trackBackgroundTask: (tasks: Set>, task: Promise) => { - tasks.add(task); - void task.finally(() => { - tasks.delete(task); - }); - }, - updateLastRouteInBackground: vi.fn(), -})); - -vi.mock("../../../../extensions/whatsapp/src/auto-reply/deliver-reply.js", () => ({ - deliverWebReply: vi.fn(async () => {}), -})); - -function makeProcessArgs(sessionStorePath: string) { - return { - // oxlint-disable-next-line typescript/no-explicit-any - cfg: { messages: {}, session: { store: sessionStorePath } } as any, - // oxlint-disable-next-line typescript/no-explicit-any - msg: { - id: "msg1", - from: "123@g.us", - to: "+15550001111", - chatType: "group", - body: "hi", - senderName: "Alice", - senderJid: "alice@s.whatsapp.net", - senderE164: "+15550002222", - groupSubject: "Test Group", - groupParticipants: [], - } as unknown as Record, - route: { - agentId: "main", - accountId: "default", - sessionKey: "agent:main:whatsapp:group:123", - // oxlint-disable-next-line typescript/no-explicit-any - } as any, - groupHistoryKey: "123@g.us", - groupHistories: new Map(), - groupMemberNames: new Map(), - connectionId: "conn", - verbose: false, - maxMediaBytes: 1, - // oxlint-disable-next-line typescript/no-explicit-any - replyResolver: (async () => undefined) as any, - // oxlint-disable-next-line typescript/no-explicit-any - replyLogger: { info: () => {}, warn: () => {}, error: () => {}, debug: () => {} } as any, - backgroundTasks: new Set>(), - rememberSentText: () => {}, - echoHas: () => false, - echoForget: () => {}, - buildCombinedEchoKey: () => "echo", - groupHistory: [], - // oxlint-disable-next-line typescript/no-explicit-any - } as any; -} - -async function removeDirEventually(dir: string) { - for (let attempt = 0; attempt < 3; attempt += 1) { - try { - await fs.rm(dir, { recursive: true, force: true }); - return; - } catch (error) { - if ((error as NodeJS.ErrnoException).code !== "ENOTEMPTY" || attempt === 2) { - throw error; - } - await new Promise((resolve) => setTimeout(resolve, 25)); - } - } -} - -describe("whatsapp inbound contract", () => { - let sessionDir = ""; - - afterEach(async () => { - capture.ctx = undefined; - if (sessionDir) { - await removeDirEventually(sessionDir); - sessionDir = ""; - } - }); - - it("keeps inbound context finalized", async () => { - sessionDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-whatsapp-contract-")); - const sessionStorePath = path.join(sessionDir, "sessions.json"); - - await processMessage(makeProcessArgs(sessionStorePath)); - - expect(capture.ctx).toBeTruthy(); - expectChannelInboundContextContract(capture.ctx!); - }); -}); diff --git a/src/channels/plugins/contracts/registry.contract.test.ts b/src/channels/plugins/contracts/registry.contract.test.ts index a379792253a..64b5bc6c369 100644 --- a/src/channels/plugins/contracts/registry.contract.test.ts +++ b/src/channels/plugins/contracts/registry.contract.test.ts @@ -1,25 +1,48 @@ +import fs from "node:fs"; +import path from "node:path"; import { describe, expect, it } from "vitest"; import { actionContractRegistry, + channelPluginSurfaceKeys, directoryContractRegistry, pluginContractRegistry, + sessionBindingContractRegistry, setupContractRegistry, statusContractRegistry, surfaceContractRegistry, threadingContractRegistry, - type ChannelPluginSurface, } from "./registry.js"; -const orderedSurfaceKeys = [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", -] as const satisfies readonly ChannelPluginSurface[]; +function listFilesRecursively(dir: string): string[] { + const entries = fs.readdirSync(dir, { withFileTypes: true }); + const files: string[] = []; + for (const entry of entries) { + const fullPath = path.join(dir, entry.name); + if (entry.isDirectory()) { + files.push(...listFilesRecursively(fullPath)); + continue; + } + files.push(fullPath); + } + return files; +} + +function discoverSessionBindingChannels() { + const extensionsDir = path.resolve(import.meta.dirname, "../../../../extensions"); + const channels = new Set(); + for (const filePath of listFilesRecursively(extensionsDir)) { + if (!filePath.endsWith(".ts") || filePath.endsWith(".test.ts")) { + continue; + } + const source = fs.readFileSync(filePath, "utf8"); + for (const match of source.matchAll( + /registerSessionBindingAdapter\(\{[\s\S]*?channel:\s*"([^"]+)"/g, + )) { + channels.add(match[1]); + } + } + return [...channels].toSorted(); +} describe("channel contract registry", () => { it("does not duplicate channel plugin ids", () => { @@ -35,7 +58,7 @@ describe("channel contract registry", () => { it("declares the actual owned channel plugin surfaces explicitly", () => { for (const entry of surfaceContractRegistry) { - const actual = orderedSurfaceKeys.filter((surface) => Boolean(entry.plugin[surface])); + const actual = channelPluginSurfaceKeys.filter((surface) => Boolean(entry.plugin[surface])); expect([...entry.surfaces].toSorted()).toEqual(actual.toSorted()); } }); @@ -84,7 +107,7 @@ describe("channel contract registry", () => { } }); - it("only installs deep directory coverage for plugins that declare directory", () => { + it("covers every declared directory surface with an explicit contract level", () => { const directorySurfaceIds = new Set( surfaceContractRegistry .filter((entry) => entry.surfaces.includes("directory")) @@ -93,5 +116,27 @@ describe("channel contract registry", () => { for (const entry of directoryContractRegistry) { expect(directorySurfaceIds.has(entry.id)).toBe(true); } + expect(directoryContractRegistry.map((entry) => entry.id).toSorted()).toEqual( + [...directorySurfaceIds].toSorted(), + ); + }); + + it("only installs lookup directory coverage for plugins that declare directory", () => { + const directorySurfaceIds = new Set( + surfaceContractRegistry + .filter((entry) => entry.surfaces.includes("directory")) + .map((entry) => entry.id), + ); + for (const entry of directoryContractRegistry.filter( + (candidate) => candidate.coverage === "lookups", + )) { + expect(directorySurfaceIds.has(entry.id)).toBe(true); + } + }); + + it("keeps session binding coverage aligned with registered session binding adapters", () => { + expect(sessionBindingContractRegistry.map((entry) => entry.id).toSorted()).toEqual( + discoverSessionBindingChannels(), + ); }); }); diff --git a/src/channels/plugins/contracts/registry.ts b/src/channels/plugins/contracts/registry.ts index 617aa9c2221..4e87f1cfedd 100644 --- a/src/channels/plugins/contracts/registry.ts +++ b/src/channels/plugins/contracts/registry.ts @@ -1,11 +1,27 @@ import { expect, vi } from "vitest"; +import { + __testing as discordThreadBindingTesting, + createThreadBindingManager as createDiscordThreadBindingManager, +} from "../../../../extensions/discord/src/monitor/thread-bindings.manager.js"; +import { createFeishuThreadBindingManager } from "../../../../extensions/feishu/src/thread-bindings.js"; +import { setMatrixRuntime } from "../../../../extensions/matrix/src/runtime.js"; +import { createTelegramThreadBindingManager } from "../../../../extensions/telegram/src/thread-bindings.js"; import type { OpenClawConfig } from "../../../config/config.js"; +import { + getSessionBindingService, + type SessionBindingCapabilities, + type SessionBindingRecord, +} from "../../../infra/outbound/session-binding-service.js"; import { resolveDefaultLineAccountId, resolveLineAccount, listLineAccountIds, } from "../../../line/accounts.js"; -import { bundledChannelRuntimeSetters, requireBundledChannelPlugin } from "../bundled.js"; +import { + bundledChannelPlugins, + bundledChannelRuntimeSetters, + requireBundledChannelPlugin, +} from "../bundled.js"; import type { ChannelPlugin } from "../types.js"; type PluginContractEntry = { @@ -57,6 +73,17 @@ type StatusContractEntry = { }>; }; +export const channelPluginSurfaceKeys = [ + "actions", + "setup", + "status", + "outbound", + "messaging", + "threading", + "directory", + "gateway", +] as const; + export type ChannelPluginSurface = | "actions" | "setup" @@ -92,7 +119,18 @@ type ThreadingContractEntry = { type DirectoryContractEntry = { id: string; plugin: Pick; - invokeLookups: boolean; + coverage: "lookups" | "presence"; + cfg?: OpenClawConfig; + accountId?: string; +}; + +type SessionBindingContractEntry = { + id: string; + expectedCapabilities: SessionBindingCapabilities; + getCapabilities: () => SessionBindingCapabilities; + bindAndResolve: () => Promise; + unbindAndVerify: (binding: SessionBindingRecord) => Promise; + cleanup: () => Promise | void; }; const telegramListActionsMock = vi.fn(); @@ -133,28 +171,18 @@ bundledChannelRuntimeSetters.setLineRuntime({ }, } as never); -export const pluginContractRegistry: PluginContractEntry[] = [ - { id: "bluebubbles", plugin: requireBundledChannelPlugin("bluebubbles") }, - { id: "discord", plugin: requireBundledChannelPlugin("discord") }, - { id: "feishu", plugin: requireBundledChannelPlugin("feishu") }, - { id: "googlechat", plugin: requireBundledChannelPlugin("googlechat") }, - { id: "imessage", plugin: requireBundledChannelPlugin("imessage") }, - { id: "irc", plugin: requireBundledChannelPlugin("irc") }, - { id: "line", plugin: requireBundledChannelPlugin("line") }, - { id: "matrix", plugin: requireBundledChannelPlugin("matrix") }, - { id: "mattermost", plugin: requireBundledChannelPlugin("mattermost") }, - { id: "msteams", plugin: requireBundledChannelPlugin("msteams") }, - { id: "nextcloud-talk", plugin: requireBundledChannelPlugin("nextcloud-talk") }, - { id: "nostr", plugin: requireBundledChannelPlugin("nostr") }, - { id: "signal", plugin: requireBundledChannelPlugin("signal") }, - { id: "slack", plugin: requireBundledChannelPlugin("slack") }, - { id: "synology-chat", plugin: requireBundledChannelPlugin("synology-chat") }, - { id: "telegram", plugin: requireBundledChannelPlugin("telegram") }, - { id: "tlon", plugin: requireBundledChannelPlugin("tlon") }, - { id: "whatsapp", plugin: requireBundledChannelPlugin("whatsapp") }, - { id: "zalo", plugin: requireBundledChannelPlugin("zalo") }, - { id: "zalouser", plugin: requireBundledChannelPlugin("zalouser") }, -]; +setMatrixRuntime({ + state: { + resolveStateDir: (_env, homeDir) => (homeDir ?? (() => "/tmp"))(), + }, +} as never); + +export const pluginContractRegistry: PluginContractEntry[] = bundledChannelPlugins.map( + (plugin) => ({ + id: plugin.id, + plugin, + }), +); export const actionContractRegistry: ActionsContractEntry[] = [ { @@ -500,189 +528,13 @@ export const statusContractRegistry: StatusContractEntry[] = [ }, ]; -export const surfaceContractRegistry: SurfaceContractEntry[] = [ - { - id: "bluebubbles", - plugin: requireBundledChannelPlugin("bluebubbles"), - surfaces: ["actions", "setup", "status", "outbound", "messaging", "threading", "gateway"], - }, - { - id: "discord", - plugin: requireBundledChannelPlugin("discord"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "feishu", - plugin: requireBundledChannelPlugin("feishu"), - surfaces: ["actions", "setup", "status", "outbound", "messaging", "directory", "gateway"], - }, - { - id: "googlechat", - plugin: requireBundledChannelPlugin("googlechat"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "imessage", - plugin: requireBundledChannelPlugin("imessage"), - surfaces: ["setup", "status", "outbound", "messaging", "gateway"], - }, - { - id: "irc", - plugin: requireBundledChannelPlugin("irc"), - surfaces: ["setup", "status", "outbound", "messaging", "directory", "gateway"], - }, - { - id: "line", - plugin: requireBundledChannelPlugin("line"), - surfaces: ["setup", "status", "outbound", "messaging", "directory", "gateway"], - }, - { - id: "matrix", - plugin: requireBundledChannelPlugin("matrix"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "mattermost", - plugin: requireBundledChannelPlugin("mattermost"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "msteams", - plugin: requireBundledChannelPlugin("msteams"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "nextcloud-talk", - plugin: requireBundledChannelPlugin("nextcloud-talk"), - surfaces: ["setup", "status", "outbound", "messaging", "gateway"], - }, - { - id: "nostr", - plugin: requireBundledChannelPlugin("nostr"), - surfaces: ["setup", "status", "outbound", "messaging", "gateway"], - }, - { - id: "signal", - plugin: requireBundledChannelPlugin("signal"), - surfaces: ["actions", "setup", "status", "outbound", "messaging", "gateway"], - }, - { - id: "slack", - plugin: requireBundledChannelPlugin("slack"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "synology-chat", - plugin: requireBundledChannelPlugin("synology-chat"), - surfaces: ["setup", "outbound", "messaging", "directory", "gateway"], - }, - { - id: "telegram", - plugin: requireBundledChannelPlugin("telegram"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "tlon", - plugin: requireBundledChannelPlugin("tlon"), - surfaces: ["setup", "status", "outbound", "messaging", "gateway"], - }, - { - id: "whatsapp", - plugin: requireBundledChannelPlugin("whatsapp"), - surfaces: ["actions", "setup", "status", "outbound", "messaging", "directory", "gateway"], - }, - { - id: "zalo", - plugin: requireBundledChannelPlugin("zalo"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, - { - id: "zalouser", - plugin: requireBundledChannelPlugin("zalouser"), - surfaces: [ - "actions", - "setup", - "status", - "outbound", - "messaging", - "threading", - "directory", - "gateway", - ], - }, -]; +export const surfaceContractRegistry: SurfaceContractEntry[] = bundledChannelPlugins.map( + (plugin) => ({ + id: plugin.id, + plugin, + surfaces: channelPluginSurfaceKeys.filter((surface) => Boolean(plugin[surface])), + }), +); export const threadingContractRegistry: ThreadingContractEntry[] = surfaceContractRegistry .filter((entry) => entry.surfaces.includes("threading")) @@ -691,12 +543,258 @@ export const threadingContractRegistry: ThreadingContractEntry[] = surfaceContra plugin: entry.plugin, })); -const directoryShapeOnlyIds = new Set(["matrix", "whatsapp", "zalouser"]); +const directoryPresenceOnlyIds = new Set(["whatsapp", "zalouser"]); +const matrixDirectoryCfg = { + channels: { + matrix: { + enabled: true, + homeserver: "https://matrix.example.com", + userId: "@lobster:example.com", + accessToken: "matrix-access-token", + dm: { + allowFrom: ["matrix:@alice:example.com"], + }, + groupAllowFrom: ["matrix:@team:example.com"], + groups: { + "!room:example.com": { + users: ["matrix:@alice:example.com"], + }, + }, + }, + }, +} as OpenClawConfig; export const directoryContractRegistry: DirectoryContractEntry[] = surfaceContractRegistry .filter((entry) => entry.surfaces.includes("directory")) .map((entry) => ({ id: entry.id, plugin: entry.plugin, - invokeLookups: !directoryShapeOnlyIds.has(entry.id), + coverage: directoryPresenceOnlyIds.has(entry.id) ? "presence" : "lookups", + ...(entry.id === "matrix" ? { cfg: matrixDirectoryCfg } : {}), })); + +const baseSessionBindingCfg = { + session: { mainKey: "main", scope: "per-sender" }, +} satisfies OpenClawConfig; + +export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ + { + id: "discord", + expectedCapabilities: { + adapterAvailable: true, + bindSupported: true, + unbindSupported: true, + placements: ["current", "child"], + }, + getCapabilities: () => { + createDiscordThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + return getSessionBindingService().getCapabilities({ + channel: "discord", + accountId: "default", + }); + }, + bindAndResolve: async () => { + createDiscordThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + const service = getSessionBindingService(); + const binding = await service.bind({ + targetSessionKey: "agent:discord:child:thread-1", + targetKind: "subagent", + conversation: { + channel: "discord", + accountId: "default", + conversationId: "channel:123456789012345678", + }, + placement: "current", + metadata: { + label: "codex-discord", + }, + }); + expect( + service.resolveByConversation({ + channel: "discord", + accountId: "default", + conversationId: "channel:123456789012345678", + }), + )?.toMatchObject({ + targetSessionKey: "agent:discord:child:thread-1", + }); + return binding; + }, + unbindAndVerify: async (binding) => { + const service = getSessionBindingService(); + const removed = await service.unbind({ + bindingId: binding.bindingId, + reason: "contract-test", + }); + expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); + expect(service.resolveByConversation(binding.conversation)).toBeNull(); + }, + cleanup: async () => { + const manager = createDiscordThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + manager.stop(); + discordThreadBindingTesting.resetThreadBindingsForTests(); + expect( + getSessionBindingService().resolveByConversation({ + channel: "discord", + accountId: "default", + conversationId: "channel:123456789012345678", + }), + ).toBeNull(); + }, + }, + { + id: "feishu", + expectedCapabilities: { + adapterAvailable: true, + bindSupported: true, + unbindSupported: true, + placements: ["current"], + }, + getCapabilities: () => { + createFeishuThreadBindingManager({ cfg: baseSessionBindingCfg, accountId: "default" }); + return getSessionBindingService().getCapabilities({ + channel: "feishu", + accountId: "default", + }); + }, + bindAndResolve: async () => { + createFeishuThreadBindingManager({ cfg: baseSessionBindingCfg, accountId: "default" }); + const service = getSessionBindingService(); + const binding = await service.bind({ + targetSessionKey: "agent:codex:acp:binding:feishu:default:abc123", + targetKind: "session", + conversation: { + channel: "feishu", + accountId: "default", + conversationId: "oc_group_chat:topic:om_topic_root", + parentConversationId: "oc_group_chat", + }, + placement: "current", + metadata: { + agentId: "codex", + label: "codex-main", + }, + }); + expect( + service.resolveByConversation({ + channel: "feishu", + accountId: "default", + conversationId: "oc_group_chat:topic:om_topic_root", + }), + )?.toMatchObject({ + targetSessionKey: "agent:codex:acp:binding:feishu:default:abc123", + }); + return binding; + }, + unbindAndVerify: async (binding) => { + const service = getSessionBindingService(); + const removed = await service.unbind({ + bindingId: binding.bindingId, + reason: "contract-test", + }); + expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); + expect(service.resolveByConversation(binding.conversation)).toBeNull(); + }, + cleanup: async () => { + const manager = createFeishuThreadBindingManager({ + cfg: baseSessionBindingCfg, + accountId: "default", + }); + manager.stop(); + expect( + getSessionBindingService().resolveByConversation({ + channel: "feishu", + accountId: "default", + conversationId: "oc_group_chat:topic:om_topic_root", + }), + ).toBeNull(); + }, + }, + { + id: "telegram", + expectedCapabilities: { + adapterAvailable: true, + bindSupported: true, + unbindSupported: true, + placements: ["current"], + }, + getCapabilities: () => { + createTelegramThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + return getSessionBindingService().getCapabilities({ + channel: "telegram", + accountId: "default", + }); + }, + bindAndResolve: async () => { + createTelegramThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + const service = getSessionBindingService(); + const binding = await service.bind({ + targetSessionKey: "agent:main:subagent:child-1", + targetKind: "subagent", + conversation: { + channel: "telegram", + accountId: "default", + conversationId: "-100200300:topic:77", + }, + placement: "current", + metadata: { + boundBy: "user-1", + }, + }); + expect( + service.resolveByConversation({ + channel: "telegram", + accountId: "default", + conversationId: "-100200300:topic:77", + }), + )?.toMatchObject({ + targetSessionKey: "agent:main:subagent:child-1", + }); + return binding; + }, + unbindAndVerify: async (binding) => { + const service = getSessionBindingService(); + const removed = await service.unbind({ + bindingId: binding.bindingId, + reason: "contract-test", + }); + expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); + expect(service.resolveByConversation(binding.conversation)).toBeNull(); + }, + cleanup: async () => { + const manager = createTelegramThreadBindingManager({ + accountId: "default", + persist: false, + enableSweeper: false, + }); + manager.stop(); + expect( + getSessionBindingService().resolveByConversation({ + channel: "telegram", + accountId: "default", + conversationId: "-100200300:topic:77", + }), + ).toBeNull(); + }, + }, +]; diff --git a/src/channels/plugins/contracts/session-binding.contract.test.ts b/src/channels/plugins/contracts/session-binding.contract.test.ts index a21632c4515..b8201569cde 100644 --- a/src/channels/plugins/contracts/session-binding.contract.test.ts +++ b/src/channels/plugins/contracts/session-binding.contract.test.ts @@ -1,151 +1,26 @@ -import { beforeEach, describe, expect } from "vitest"; -import { - __testing as feishuThreadBindingTesting, - createFeishuThreadBindingManager, -} from "../../../../extensions/feishu/src/thread-bindings.js"; -import { - __testing as telegramThreadBindingTesting, - createTelegramThreadBindingManager, -} from "../../../../extensions/telegram/src/thread-bindings.js"; -import type { OpenClawConfig } from "../../../config/config.js"; -import { - __testing as sessionBindingTesting, - getSessionBindingService, -} from "../../../infra/outbound/session-binding-service.js"; +import { beforeEach, describe } from "vitest"; +import { __testing as discordThreadBindingTesting } from "../../../../extensions/discord/src/monitor/thread-bindings.manager.js"; +import { __testing as feishuThreadBindingTesting } from "../../../../extensions/feishu/src/thread-bindings.js"; +import { __testing as telegramThreadBindingTesting } from "../../../../extensions/telegram/src/thread-bindings.js"; +import { __testing as sessionBindingTesting } from "../../../infra/outbound/session-binding-service.js"; +import { sessionBindingContractRegistry } from "./registry.js"; import { installSessionBindingContractSuite } from "./suites.js"; -const baseCfg = { - session: { mainKey: "main", scope: "per-sender" }, -} satisfies OpenClawConfig; - beforeEach(() => { sessionBindingTesting.resetSessionBindingAdaptersForTests(); + discordThreadBindingTesting.resetThreadBindingsForTests(); feishuThreadBindingTesting.resetFeishuThreadBindingsForTests(); telegramThreadBindingTesting.resetTelegramThreadBindingsForTests(); }); -describe("feishu session binding contract", () => { - installSessionBindingContractSuite({ - expectedCapabilities: { - adapterAvailable: true, - bindSupported: true, - unbindSupported: true, - placements: ["current"], - }, - getCapabilities: () => { - createFeishuThreadBindingManager({ cfg: baseCfg, accountId: "default" }); - return getSessionBindingService().getCapabilities({ - channel: "feishu", - accountId: "default", - }); - }, - bindAndResolve: async () => { - createFeishuThreadBindingManager({ cfg: baseCfg, accountId: "default" }); - const service = getSessionBindingService(); - const binding = await service.bind({ - targetSessionKey: "agent:codex:acp:binding:feishu:default:abc123", - targetKind: "session", - conversation: { - channel: "feishu", - accountId: "default", - conversationId: "oc_group_chat:topic:om_topic_root", - parentConversationId: "oc_group_chat", - }, - placement: "current", - metadata: { - agentId: "codex", - label: "codex-main", - }, - }); - expect( - service.resolveByConversation({ - channel: "feishu", - accountId: "default", - conversationId: "oc_group_chat:topic:om_topic_root", - }), - )?.toMatchObject({ - targetSessionKey: "agent:codex:acp:binding:feishu:default:abc123", - }); - return binding; - }, - cleanup: async () => { - const manager = createFeishuThreadBindingManager({ cfg: baseCfg, accountId: "default" }); - manager.stop(); - expect( - getSessionBindingService().resolveByConversation({ - channel: "feishu", - accountId: "default", - conversationId: "oc_group_chat:topic:om_topic_root", - }), - ).toBeNull(); - }, +for (const entry of sessionBindingContractRegistry) { + describe(`${entry.id} session binding contract`, () => { + installSessionBindingContractSuite({ + expectedCapabilities: entry.expectedCapabilities, + getCapabilities: entry.getCapabilities, + bindAndResolve: entry.bindAndResolve, + unbindAndVerify: entry.unbindAndVerify, + cleanup: entry.cleanup, + }); }); -}); - -describe("telegram session binding contract", () => { - installSessionBindingContractSuite({ - expectedCapabilities: { - adapterAvailable: true, - bindSupported: true, - unbindSupported: true, - placements: ["current"], - }, - getCapabilities: () => { - createTelegramThreadBindingManager({ - accountId: "default", - persist: false, - enableSweeper: false, - }); - return getSessionBindingService().getCapabilities({ - channel: "telegram", - accountId: "default", - }); - }, - bindAndResolve: async () => { - createTelegramThreadBindingManager({ - accountId: "default", - persist: false, - enableSweeper: false, - }); - const service = getSessionBindingService(); - const binding = await service.bind({ - targetSessionKey: "agent:main:subagent:child-1", - targetKind: "subagent", - conversation: { - channel: "telegram", - accountId: "default", - conversationId: "-100200300:topic:77", - }, - placement: "current", - metadata: { - boundBy: "user-1", - }, - }); - expect( - service.resolveByConversation({ - channel: "telegram", - accountId: "default", - conversationId: "-100200300:topic:77", - }), - )?.toMatchObject({ - targetSessionKey: "agent:main:subagent:child-1", - }); - return binding; - }, - cleanup: async () => { - const manager = createTelegramThreadBindingManager({ - accountId: "default", - persist: false, - enableSweeper: false, - }); - manager.stop(); - expect( - getSessionBindingService().resolveByConversation({ - channel: "telegram", - accountId: "default", - conversationId: "-100200300:topic:77", - }), - ).toBeNull(); - }, - }); -}); +} diff --git a/src/channels/plugins/contracts/suites.ts b/src/channels/plugins/contracts/suites.ts index 461be379261..cc442b5ef20 100644 --- a/src/channels/plugins/contracts/suites.ts +++ b/src/channels/plugins/contracts/suites.ts @@ -393,18 +393,20 @@ export function installChannelThreadingContractSuite(params: { export function installChannelDirectoryContractSuite(params: { plugin: Pick; - invokeLookups?: boolean; + coverage?: "lookups" | "presence"; + cfg?: OpenClawConfig; + accountId?: string; }) { it("exposes the base directory contract", async () => { const directory = params.plugin.directory; expect(directory).toBeDefined(); - if (params.invokeLookups === false) { + if (params.coverage === "presence") { return; } const self = await directory?.self?.({ - cfg: {} as OpenClawConfig, - accountId: "default", + cfg: params.cfg ?? ({} as OpenClawConfig), + accountId: params.accountId ?? "default", runtime: contractRuntime, }); if (self) { @@ -413,8 +415,8 @@ export function installChannelDirectoryContractSuite(params: { const peers = (await directory?.listPeers?.({ - cfg: {} as OpenClawConfig, - accountId: "default", + cfg: params.cfg ?? ({} as OpenClawConfig), + accountId: params.accountId ?? "default", query: "", limit: 5, runtime: contractRuntime, @@ -426,8 +428,8 @@ export function installChannelDirectoryContractSuite(params: { const groups = (await directory?.listGroups?.({ - cfg: {} as OpenClawConfig, - accountId: "default", + cfg: params.cfg ?? ({} as OpenClawConfig), + accountId: params.accountId ?? "default", query: "", limit: 5, runtime: contractRuntime, @@ -439,8 +441,8 @@ export function installChannelDirectoryContractSuite(params: { if (directory?.listGroupMembers && groups[0]?.id) { const members = await directory.listGroupMembers({ - cfg: {} as OpenClawConfig, - accountId: "default", + cfg: params.cfg ?? ({} as OpenClawConfig), + accountId: params.accountId ?? "default", groupId: groups[0].id, limit: 5, runtime: contractRuntime, @@ -456,6 +458,7 @@ export function installChannelDirectoryContractSuite(params: { export function installSessionBindingContractSuite(params: { getCapabilities: () => SessionBindingCapabilities; bindAndResolve: () => Promise; + unbindAndVerify: (binding: SessionBindingRecord) => Promise; cleanup: () => Promise | void; expectedCapabilities: SessionBindingCapabilities; }) { @@ -477,6 +480,11 @@ export function installSessionBindingContractSuite(params: { expect(typeof binding.boundAt).toBe("number"); }); + it("unbinds a registered binding through the shared service", async () => { + const binding = await params.bindAndResolve(); + await params.unbindAndVerify(binding); + }); + it("cleans up registered bindings", async () => { await params.cleanup(); }); diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index b33ef2740e8..631df701933 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -10,8 +10,9 @@ import { setupAuthTestEnv, } from "../../commands/test-wizard-helpers.js"; import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; +import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; -import { providerContractRegistry } from "./registry.js"; +import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; type ResolvePluginProviders = typeof import("../../commands/auth-choice.apply.plugin-provider.runtime.js").resolvePluginProviders; @@ -101,11 +102,7 @@ describe("provider auth-choice contract", () => { beforeEach(() => { resolvePreferredProviderPluginProvidersMock.mockReset(); - resolvePreferredProviderPluginProvidersMock.mockReturnValue([ - ...new Map( - providerContractRegistry.map((entry) => [entry.provider.id, entry.provider]), - ).values(), - ]); + resolvePreferredProviderPluginProvidersMock.mockReturnValue(uniqueProviderContractProviders); }); afterEach(async () => { @@ -121,21 +118,34 @@ describe("provider auth-choice contract", () => { activeStateDir = null; }); - it("maps plugin-backed auth choices through the shared preferred-provider resolver", async () => { - const scenarios = [ - { authChoice: "github-copilot" as const, expectedProvider: "github-copilot" }, - { authChoice: "qwen-portal" as const, expectedProvider: "qwen-portal" }, - { authChoice: "minimax-global-oauth" as const, expectedProvider: "minimax-portal" }, - { authChoice: "modelstudio-api-key" as const, expectedProvider: "modelstudio" }, - { authChoice: "ollama" as const, expectedProvider: "ollama" }, - { authChoice: "unknown", expectedProvider: undefined }, - ] as const; + it("maps provider-plugin choices through the shared preferred-provider fallback resolver", async () => { + const pluginFallbackScenarios = [ + "github-copilot", + "qwen-portal", + "minimax-portal", + "modelstudio", + "ollama", + ].map((providerId) => { + const provider = requireProviderContractProvider(providerId); + return { + authChoice: buildProviderPluginMethodChoice(provider.id, provider.auth[0]?.id ?? "default"), + expectedProvider: provider.id, + }; + }); - for (const scenario of scenarios) { + for (const scenario of pluginFallbackScenarios) { + resolvePreferredProviderPluginProvidersMock.mockClear(); await expect( - resolvePreferredProviderForAuthChoice({ choice: scenario.authChoice }), + resolvePreferredProviderForAuthChoice({ choice: scenario.authChoice as AuthChoice }), ).resolves.toBe(scenario.expectedProvider); + expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); } + + resolvePreferredProviderPluginProvidersMock.mockClear(); + await expect( + resolvePreferredProviderForAuthChoice({ choice: "unknown" as AuthChoice }), + ).resolves.toBe(undefined); + expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); }); it("applies qwen portal auth choices through the shared plugin-provider path", async () => { diff --git a/src/plugins/contracts/catalog.contract.test.ts b/src/plugins/contracts/catalog.contract.test.ts index 16a93d30dbe..dcfe0c86f6a 100644 --- a/src/plugins/contracts/catalog.contract.test.ts +++ b/src/plugins/contracts/catalog.contract.test.ts @@ -1,13 +1,9 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { providerContractRegistry } from "./registry.js"; - -function uniqueProviders() { - return [ - ...new Map( - providerContractRegistry.map((entry) => [entry.provider.id, entry.provider]), - ).values(), - ]; -} +import { + providerContractPluginIds, + resolveProviderContractProvidersForPluginIds, + uniqueProviderContractProviders, +} from "./registry.js"; const resolvePluginProvidersMock = vi.fn(); const resolveOwningPluginIdsForProviderMock = vi.fn(); @@ -30,12 +26,10 @@ const { describe("provider catalog contract", () => { beforeEach(() => { - const providers = uniqueProviders(); - const providerIds = [...new Set(providerContractRegistry.map((entry) => entry.pluginId))]; resetProviderRuntimeHookCacheForTest(); resolveOwningPluginIdsForProviderMock.mockReset(); - resolveOwningPluginIdsForProviderMock.mockReturnValue(providerIds); + resolveOwningPluginIdsForProviderMock.mockReturnValue(providerContractPluginIds); resolveNonBundledProviderPluginIdsMock.mockReset(); resolveNonBundledProviderPluginIdsMock.mockReturnValue([]); @@ -44,12 +38,9 @@ describe("provider catalog contract", () => { resolvePluginProvidersMock.mockImplementation((params?: { onlyPluginIds?: string[] }) => { const onlyPluginIds = params?.onlyPluginIds; if (!onlyPluginIds || onlyPluginIds.length === 0) { - return providers; + return uniqueProviderContractProviders; } - const allowed = new Set(onlyPluginIds); - return providerContractRegistry - .filter((entry) => allowed.has(entry.pluginId)) - .map((entry) => entry.provider); + return resolveProviderContractProvidersForPluginIds(onlyPluginIds); }); }); diff --git a/src/plugins/contracts/loader.contract.test.ts b/src/plugins/contracts/loader.contract.test.ts index 740366394a6..aa7cf2ed1bc 100644 --- a/src/plugins/contracts/loader.contract.test.ts +++ b/src/plugins/contracts/loader.contract.test.ts @@ -2,7 +2,10 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { withBundledPluginAllowlistCompat } from "../bundled-compat.js"; import { __testing as providerTesting } from "../providers.js"; import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; -import { providerContractRegistry, webSearchProviderContractRegistry } from "./registry.js"; +import { + providerContractPluginIds, + webSearchProviderContractRegistry, +} from "./registry.js"; function uniqueSortedPluginIds(values: string[]) { return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); @@ -19,7 +22,7 @@ describe("plugin loader contract", () => { it("keeps bundled provider compatibility wired to the provider registry", () => { const providerPluginIds = uniqueSortedPluginIds( - providerContractRegistry.map((entry) => normalizeProviderContractPluginId(entry.pluginId)), + providerContractPluginIds.map(normalizeProviderContractPluginId), ); const compatPluginIds = providerTesting.resolveBundledProviderCompatPluginIds({ config: { @@ -46,7 +49,7 @@ describe("plugin loader contract", () => { it("keeps vitest bundled provider enablement wired to the provider registry", () => { const providerPluginIds = uniqueSortedPluginIds( - providerContractRegistry.map((entry) => normalizeProviderContractPluginId(entry.pluginId)), + providerContractPluginIds.map(normalizeProviderContractPluginId), ); const compatConfig = providerTesting.withBundledProviderVitestCompat({ config: undefined, diff --git a/src/plugins/contracts/registry.contract.test.ts b/src/plugins/contracts/registry.contract.test.ts index 0f6d588ea1a..f7b89c2296e 100644 --- a/src/plugins/contracts/registry.contract.test.ts +++ b/src/plugins/contracts/registry.contract.test.ts @@ -1,7 +1,10 @@ import { describe, expect, it } from "vitest"; +import { loadPluginManifestRegistry } from "../manifest-registry.js"; +import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; import { mediaUnderstandingProviderContractRegistry, pluginRegistrationContractRegistry, + providerContractPluginIds, providerContractRegistry, speechProviderContractRegistry, webSearchProviderContractRegistry, @@ -84,6 +87,27 @@ describe("plugin contract registry", () => { expect(ids).toEqual([...new Set(ids)]); }); + it("covers every bundled provider plugin discovered from manifests", () => { + const bundledProviderPluginIds = loadPluginManifestRegistry({}) + .plugins.filter((plugin) => plugin.origin === "bundled" && plugin.providers.length > 0) + .map((plugin) => plugin.id) + .toSorted((left, right) => left.localeCompare(right)); + + expect(providerContractPluginIds).toEqual(bundledProviderPluginIds); + }); + + it("covers every bundled web search plugin from the shared resolver", () => { + const bundledWebSearchPluginIds = resolvePluginWebSearchProviders({}) + .map((provider) => provider.pluginId) + .toSorted((left, right) => left.localeCompare(right)); + + expect( + [...new Set(webSearchProviderContractRegistry.map((entry) => entry.pluginId))].toSorted( + (left, right) => left.localeCompare(right), + ), + ).toEqual(bundledWebSearchPluginIds); + }); + it("keeps multi-provider plugin ownership explicit", () => { expect(findProviderIdsForPlugin("google")).toEqual(["google", "google-gemini-cli"]); expect(findProviderIdsForPlugin("minimax")).toEqual(["minimax", "minimax-portal"]); @@ -146,6 +170,23 @@ describe("plugin contract registry", () => { }); }); + it("tracks every provider, speech, media, or web search plugin in the registration registry", () => { + const expectedPluginIds = [ + ...new Set([ + ...providerContractRegistry.map((entry) => entry.pluginId), + ...speechProviderContractRegistry.map((entry) => entry.pluginId), + ...mediaUnderstandingProviderContractRegistry.map((entry) => entry.pluginId), + ...webSearchProviderContractRegistry.map((entry) => entry.pluginId), + ]), + ].toSorted((left, right) => left.localeCompare(right)); + + expect( + pluginRegistrationContractRegistry + .map((entry) => entry.pluginId) + .toSorted((left, right) => left.localeCompare(right)), + ).toEqual(expectedPluginIds); + }); + it("keeps bundled speech voice-list support explicit", () => { expect(findSpeechProviderForPlugin("openai").listVoices).toEqual(expect.any(Function)); expect(findSpeechProviderForPlugin("elevenlabs").listVoices).toEqual(expect.any(Function)); diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index cd58bf41de2..8247b8b273d 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -1,3 +1,4 @@ +import amazonBedrockPlugin from "../../../extensions/amazon-bedrock/index.js"; import anthropicPlugin from "../../../extensions/anthropic/index.js"; import bravePlugin from "../../../extensions/brave/index.js"; import byteplusPlugin from "../../../extensions/byteplus/index.js"; @@ -72,6 +73,7 @@ type PluginRegistrationContractEntry = { }; const bundledProviderPlugins: RegistrablePlugin[] = [ + amazonBedrockPlugin, anthropicPlugin, byteplusPlugin, cloudflareAiGatewayPlugin, @@ -150,6 +152,35 @@ export const providerContractRegistry: ProviderContractEntry[] = buildCapability select: (captured) => captured.providers, }); +export const uniqueProviderContractProviders: ProviderPlugin[] = [ + ...new Map(providerContractRegistry.map((entry) => [entry.provider.id, entry.provider])).values(), +]; + +export const providerContractPluginIds = [ + ...new Set(providerContractRegistry.map((entry) => entry.pluginId)), +].toSorted((left, right) => left.localeCompare(right)); + +export function requireProviderContractProvider(providerId: string): ProviderPlugin { + const provider = uniqueProviderContractProviders.find((entry) => entry.id === providerId); + if (!provider) { + throw new Error(`provider contract entry missing for ${providerId}`); + } + return provider; +} + +export function resolveProviderContractProvidersForPluginIds( + pluginIds: readonly string[], +): ProviderPlugin[] { + const allowed = new Set(pluginIds); + return [ + ...new Map( + providerContractRegistry + .filter((entry) => allowed.has(entry.pluginId)) + .map((entry) => [entry.provider.id, entry.provider]), + ).values(), + ]; +} + export const webSearchProviderContractRegistry: WebSearchProviderContractEntry[] = bundledWebSearchPlugins.flatMap((plugin) => { const captured = captureRegistrations(plugin); diff --git a/src/plugins/contracts/runtime.contract.test.ts b/src/plugins/contracts/runtime.contract.test.ts index ee8503d88bf..073ad01c960 100644 --- a/src/plugins/contracts/runtime.contract.test.ts +++ b/src/plugins/contracts/runtime.contract.test.ts @@ -1,6 +1,7 @@ import { describe, expect, it, vi } from "vitest"; import { createProviderUsageFetch, makeResponse } from "../../test-utils/provider-usage-fetch.js"; import type { ProviderRuntimeModel } from "../types.js"; +import { requireProviderContractProvider } from "./registry.js"; const getOAuthApiKeyMock = vi.hoisted(() => vi.fn()); const refreshQwenPortalCredentialsMock = vi.hoisted(() => vi.fn()); @@ -17,16 +18,6 @@ vi.mock("../../providers/qwen-portal-oauth.js", () => ({ refreshQwenPortalCredentials: refreshQwenPortalCredentialsMock, })); -const { providerContractRegistry } = await import("./registry.js"); - -function requireProvider(providerId: string) { - const entry = providerContractRegistry.find((candidate) => candidate.provider.id === providerId); - if (!entry) { - throw new Error(`provider contract entry missing for ${providerId}`); - } - return entry.provider; -} - function createModel(overrides: Partial & Pick) { return { id: overrides.id, @@ -45,7 +36,7 @@ function createModel(overrides: Partial & Pick { describe("anthropic", () => { it("owns anthropic 4.6 forward-compat resolution", () => { - const provider = requireProvider("anthropic"); + const provider = requireProviderContractProvider("anthropic"); const model = provider.resolveDynamicModel?.({ provider: "anthropic", modelId: "claude-sonnet-4.6-20260219", @@ -71,7 +62,7 @@ describe("provider runtime contract", () => { }); it("owns usage auth resolution", async () => { - const provider = requireProvider("anthropic"); + const provider = requireProviderContractProvider("anthropic"); await expect( provider.resolveUsageAuth?.({ config: {} as never, @@ -88,7 +79,7 @@ describe("provider runtime contract", () => { }); it("owns auth doctor hint generation", () => { - const provider = requireProvider("anthropic"); + const provider = requireProviderContractProvider("anthropic"); const hint = provider.buildAuthDoctorHint?.({ provider: "anthropic", profileId: "anthropic:default", @@ -121,7 +112,7 @@ describe("provider runtime contract", () => { }); it("owns usage snapshot fetching", async () => { - const provider = requireProvider("anthropic"); + const provider = requireProviderContractProvider("anthropic"); const mockFetch = createProviderUsageFetch(async (url) => { if (url.includes("api.anthropic.com/api/oauth/usage")) { return makeResponse(200, { @@ -154,7 +145,7 @@ describe("provider runtime contract", () => { describe("github-copilot", () => { it("owns Copilot-specific forward-compat fallbacks", () => { - const provider = requireProvider("github-copilot"); + const provider = requireProviderContractProvider("github-copilot"); const model = provider.resolveDynamicModel?.({ provider: "github-copilot", modelId: "gpt-5.3-codex", @@ -181,7 +172,7 @@ describe("provider runtime contract", () => { describe("google", () => { it("owns google direct gemini 3.1 forward-compat resolution", () => { - const provider = requireProvider("google"); + const provider = requireProviderContractProvider("google"); const model = provider.resolveDynamicModel?.({ provider: "google", modelId: "gemini-3.1-pro-preview", @@ -213,7 +204,7 @@ describe("provider runtime contract", () => { describe("google-gemini-cli", () => { it("owns gemini cli 3.1 forward-compat resolution", () => { - const provider = requireProvider("google-gemini-cli"); + const provider = requireProviderContractProvider("google-gemini-cli"); const model = provider.resolveDynamicModel?.({ provider: "google-gemini-cli", modelId: "gemini-3.1-pro-preview", @@ -241,7 +232,7 @@ describe("provider runtime contract", () => { }); it("owns usage-token parsing", async () => { - const provider = requireProvider("google-gemini-cli"); + const provider = requireProviderContractProvider("google-gemini-cli"); await expect( provider.resolveUsageAuth?.({ config: {} as never, @@ -260,7 +251,7 @@ describe("provider runtime contract", () => { }); it("owns OAuth auth-profile formatting", () => { - const provider = requireProvider("google-gemini-cli"); + const provider = requireProviderContractProvider("google-gemini-cli"); expect( provider.formatApiKey?.({ @@ -275,7 +266,7 @@ describe("provider runtime contract", () => { }); it("owns usage snapshot fetching", async () => { - const provider = requireProvider("google-gemini-cli"); + const provider = requireProviderContractProvider("google-gemini-cli"); const mockFetch = createProviderUsageFetch(async (url) => { if (url.includes("cloudcode-pa.googleapis.com/v1internal:retrieveUserQuota")) { return makeResponse(200, { @@ -309,7 +300,7 @@ describe("provider runtime contract", () => { describe("openai", () => { it("owns openai gpt-5.4 forward-compat resolution", () => { - const provider = requireProvider("openai"); + const provider = requireProviderContractProvider("openai"); const model = provider.resolveDynamicModel?.({ provider: "openai", modelId: "gpt-5.4-pro", @@ -337,7 +328,7 @@ describe("provider runtime contract", () => { }); it("owns direct openai transport normalization", () => { - const provider = requireProvider("openai"); + const provider = requireProviderContractProvider("openai"); expect( provider.normalizeResolvedModel?.({ provider: "openai", @@ -360,7 +351,7 @@ describe("provider runtime contract", () => { describe("openai-codex", () => { it("owns refresh fallback for accountId extraction failures", async () => { - const provider = requireProvider("openai-codex"); + const provider = requireProviderContractProvider("openai-codex"); const credential = { type: "oauth" as const, provider: "openai-codex", @@ -376,7 +367,7 @@ describe("provider runtime contract", () => { }); it("owns forward-compat codex models", () => { - const provider = requireProvider("openai-codex"); + const provider = requireProviderContractProvider("openai-codex"); const model = provider.resolveDynamicModel?.({ provider: "openai-codex", modelId: "gpt-5.4", @@ -403,7 +394,7 @@ describe("provider runtime contract", () => { }); it("owns codex transport defaults", () => { - const provider = requireProvider("openai-codex"); + const provider = requireProviderContractProvider("openai-codex"); expect( provider.prepareExtraParams?.({ provider: "openai-codex", @@ -417,7 +408,7 @@ describe("provider runtime contract", () => { }); it("owns usage snapshot fetching", async () => { - const provider = requireProvider("openai-codex"); + const provider = requireProviderContractProvider("openai-codex"); const mockFetch = createProviderUsageFetch(async (url) => { if (url.includes("chatgpt.com/backend-api/wham/usage")) { return makeResponse(200, { @@ -455,7 +446,7 @@ describe("provider runtime contract", () => { describe("qwen-portal", () => { it("owns OAuth refresh", async () => { - const provider = requireProvider("qwen-portal"); + const provider = requireProviderContractProvider("qwen-portal"); const credential = { type: "oauth" as const, provider: "qwen-portal", @@ -478,7 +469,7 @@ describe("provider runtime contract", () => { describe("zai", () => { it("owns glm-5 forward-compat resolution", () => { - const provider = requireProvider("zai"); + const provider = requireProviderContractProvider("zai"); const model = provider.resolveDynamicModel?.({ provider: "zai", modelId: "glm-5", @@ -507,7 +498,7 @@ describe("provider runtime contract", () => { }); it("owns usage auth resolution", async () => { - const provider = requireProvider("zai"); + const provider = requireProviderContractProvider("zai"); await expect( provider.resolveUsageAuth?.({ config: {} as never, @@ -524,7 +515,7 @@ describe("provider runtime contract", () => { }); it("owns usage snapshot fetching", async () => { - const provider = requireProvider("zai"); + const provider = requireProviderContractProvider("zai"); const mockFetch = createProviderUsageFetch(async (url) => { if (url.includes("api.z.ai/api/monitor/usage/quota/limit")) { return makeResponse(200, { diff --git a/src/plugins/contracts/wizard.contract.test.ts b/src/plugins/contracts/wizard.contract.test.ts index 4ebcedb17d9..9af9d21d411 100644 --- a/src/plugins/contracts/wizard.contract.test.ts +++ b/src/plugins/contracts/wizard.contract.test.ts @@ -1,14 +1,6 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import type { ProviderPlugin } from "../types.js"; -import { providerContractRegistry } from "./registry.js"; - -function uniqueProviders(): ProviderPlugin[] { - return [ - ...new Map( - providerContractRegistry.map((entry) => [entry.provider.id, entry.provider]), - ).values(), - ]; -} +import { providerContractPluginIds, uniqueProviderContractProviders } from "./registry.js"; const resolvePluginProvidersMock = vi.fn(); @@ -81,18 +73,16 @@ function resolveExpectedModelPickerValues(providers: ProviderPlugin[]) { describe("provider wizard contract", () => { beforeEach(() => { - const providers = uniqueProviders(); resolvePluginProvidersMock.mockReset(); - resolvePluginProvidersMock.mockReturnValue(providers); + resolvePluginProvidersMock.mockReturnValue(uniqueProviderContractProviders); }); it("exposes every registered provider setup choice through the shared wizard layer", () => { - const providers = uniqueProviders(); const options = resolveProviderWizardOptions({ config: { plugins: { enabled: true, - allow: [...new Set(providerContractRegistry.map((entry) => entry.pluginId))], + allow: providerContractPluginIds, slots: { memory: "none", }, @@ -103,18 +93,16 @@ describe("provider wizard contract", () => { expect( options.map((option) => option.value).toSorted((left, right) => left.localeCompare(right)), - ).toEqual(resolveExpectedWizardChoiceValues(providers)); + ).toEqual(resolveExpectedWizardChoiceValues(uniqueProviderContractProviders)); expect(options.map((option) => option.value)).toEqual([ ...new Set(options.map((option) => option.value)), ]); }); it("round-trips every shared wizard choice back to its provider and auth method", () => { - const providers = uniqueProviders(); - for (const option of resolveProviderWizardOptions({ config: {}, env: process.env })) { const resolved = resolveProviderPluginChoice({ - providers, + providers: uniqueProviderContractProviders, choice: option.value, }); expect(resolved).not.toBeNull(); @@ -124,15 +112,14 @@ describe("provider wizard contract", () => { }); it("exposes every registered model-picker entry through the shared wizard layer", () => { - const providers = uniqueProviders(); const entries = resolveProviderModelPickerEntries({ config: {}, env: process.env }); expect( entries.map((entry) => entry.value).toSorted((left, right) => left.localeCompare(right)), - ).toEqual(resolveExpectedModelPickerValues(providers)); + ).toEqual(resolveExpectedModelPickerValues(uniqueProviderContractProviders)); for (const entry of entries) { const resolved = resolveProviderPluginChoice({ - providers, + providers: uniqueProviderContractProviders, choice: entry.value, }); expect(resolved).not.toBeNull(); From dd9fce1686f66977275565c17a7c9c21409da6cd Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:30:26 -0700 Subject: [PATCH 054/187] Tests: restore Telegram native command harness mocks --- .../src/bot-native-commands.menu-test-support.ts | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/extensions/telegram/src/bot-native-commands.menu-test-support.ts b/extensions/telegram/src/bot-native-commands.menu-test-support.ts index 241c50ac6be..94a6f9824df 100644 --- a/extensions/telegram/src/bot-native-commands.menu-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.menu-test-support.ts @@ -23,8 +23,8 @@ const deliveryMocks = vi.hoisted(() => ({ export const listSkillCommandsForAgents = skillCommandMocks.listSkillCommandsForAgents; export const deliverReplies = deliveryMocks.deliverReplies; -vi.mock("../../../src/auto-reply/skill-commands.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/reply-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, listSkillCommandsForAgents, @@ -79,4 +79,8 @@ export function createNativeCommandTestParams( }); } -export { createTelegramPrivateCommandContext as createPrivateCommandContext }; +export function createPrivateCommandContext( + params?: Parameters[0], +) { + return createTelegramPrivateCommandContext(params); +} From 049bb37c6296d6524e6ce041b7ae2d762608c134 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:33:28 -0700 Subject: [PATCH 055/187] iMessage: lazy-load channel runtime paths --- extensions/imessage/src/channel.runtime.ts | 83 +++++++++++++++++++++- extensions/imessage/src/channel.ts | 72 ++++--------------- 2 files changed, 94 insertions(+), 61 deletions(-) diff --git a/extensions/imessage/src/channel.runtime.ts b/extensions/imessage/src/channel.runtime.ts index 81229e49ff9..99ce9f617a2 100644 --- a/extensions/imessage/src/channel.runtime.ts +++ b/extensions/imessage/src/channel.runtime.ts @@ -1 +1,82 @@ -export { imessageSetupWizard } from "./setup-surface.js"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { + PAIRING_APPROVED_MESSAGE, + resolveChannelMediaMaxBytes, +} from "openclaw/plugin-sdk/imessage"; +import type { ResolvedIMessageAccount } from "./accounts.js"; +import { monitorIMessageProvider } from "./monitor.js"; +import { probeIMessage } from "./probe.js"; +import { getIMessageRuntime } from "./runtime.js"; +import { imessageSetupWizard } from "./setup-surface.js"; + +type IMessageSendFn = ReturnType< + typeof getIMessageRuntime +>["channel"]["imessage"]["sendMessageIMessage"]; + +export async function sendIMessageOutbound(params: { + cfg: Parameters[0]["cfg"]; + to: string; + text: string; + mediaUrl?: string; + mediaLocalRoots?: readonly string[]; + accountId?: string; + deps?: { [channelId: string]: unknown }; + replyToId?: string; +}) { + const send = + resolveOutboundSendDep(params.deps, "imessage") ?? + getIMessageRuntime().channel.imessage.sendMessageIMessage; + const maxBytes = resolveChannelMediaMaxBytes({ + cfg: params.cfg, + resolveChannelLimitMb: ({ cfg, accountId }) => + cfg.channels?.imessage?.accounts?.[accountId]?.mediaMaxMb ?? + cfg.channels?.imessage?.mediaMaxMb, + accountId: params.accountId, + }); + return await send(params.to, params.text, { + config: params.cfg, + ...(params.mediaUrl ? { mediaUrl: params.mediaUrl } : {}), + ...(params.mediaLocalRoots?.length ? { mediaLocalRoots: params.mediaLocalRoots } : {}), + maxBytes, + accountId: params.accountId ?? undefined, + replyToId: params.replyToId ?? undefined, + }); +} + +export async function notifyIMessageApproval(id: string): Promise { + await getIMessageRuntime().channel.imessage.sendMessageIMessage(id, PAIRING_APPROVED_MESSAGE); +} + +export async function probeIMessageAccount(timeoutMs?: number) { + return await probeIMessage(timeoutMs); +} + +export async function startIMessageGatewayAccount( + ctx: Parameters< + NonNullable< + NonNullable< + import("openclaw/plugin-sdk/imessage").ChannelPlugin["gateway"] + >["startAccount"] + > + >[0], +) { + const account = ctx.account; + const cliPath = account.config.cliPath?.trim() || "imsg"; + const dbPath = account.config.dbPath?.trim(); + ctx.setStatus({ + accountId: account.accountId, + cliPath, + dbPath: dbPath ?? null, + }); + ctx.log?.info?.( + `[${account.accountId}] starting provider (${cliPath}${dbPath ? ` db=${dbPath}` : ""})`, + ); + return await monitorIMessageProvider({ + accountId: account.accountId, + config: ctx.cfg, + runtime: ctx.runtime, + abortSignal: ctx.abortSignal, + }); +} + +export { imessageSetupWizard }; diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index bf7e6585d6c..49e8c289fae 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -3,15 +3,13 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; import { collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, + formatTrimmedAllowFromEntries, looksLikeIMessageTargetId, normalizeIMessageMessagingTarget, - PAIRING_APPROVED_MESSAGE, - resolveChannelMediaMaxBytes, resolveIMessageGroupRequireMention, resolveIMessageGroupToolPolicy, type ChannelPlugin, @@ -23,38 +21,11 @@ import { imessageSetupAdapter } from "./setup-core.js"; import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; import { normalizeIMessageHandle, parseIMessageTarget } from "./targets.js"; -type IMessageSendFn = ReturnType< - typeof getIMessageRuntime ->["channel"]["imessage"]["sendMessageIMessage"]; +let imessageChannelRuntimePromise: Promise | null = null; -async function sendIMessageOutbound(params: { - cfg: Parameters[0]["cfg"]; - to: string; - text: string; - mediaUrl?: string; - mediaLocalRoots?: readonly string[]; - accountId?: string; - deps?: { [channelId: string]: unknown }; - replyToId?: string; -}) { - const send = - resolveOutboundSendDep(params.deps, "imessage") ?? - getIMessageRuntime().channel.imessage.sendMessageIMessage; - const maxBytes = resolveChannelMediaMaxBytes({ - cfg: params.cfg, - resolveChannelLimitMb: ({ cfg, accountId }) => - cfg.channels?.imessage?.accounts?.[accountId]?.mediaMaxMb ?? - cfg.channels?.imessage?.mediaMaxMb, - accountId: params.accountId, - }); - return await send(params.to, params.text, { - config: params.cfg, - ...(params.mediaUrl ? { mediaUrl: params.mediaUrl } : {}), - ...(params.mediaLocalRoots?.length ? { mediaLocalRoots: params.mediaLocalRoots } : {}), - maxBytes, - accountId: params.accountId ?? undefined, - replyToId: params.replyToId ?? undefined, - }); +async function loadIMessageChannelRuntime() { + imessageChannelRuntimePromise ??= import("./channel.runtime.js"); + return imessageChannelRuntimePromise; } function buildIMessageBaseSessionKey(params: { @@ -141,9 +112,8 @@ export const imessagePlugin: ChannelPlugin = { }), pairing: { idLabel: "imessageSenderId", - notifyApproval: async ({ id }) => { - await getIMessageRuntime().channel.imessage.sendMessageIMessage(id, PAIRING_APPROVED_MESSAGE); - }, + notifyApproval: async ({ id }) => + await (await loadIMessageChannelRuntime()).notifyIMessageApproval(id), }, allowlist: { supportsScope: ({ scope }) => scope === "dm" || scope === "group" || scope === "all", @@ -202,14 +172,13 @@ export const imessagePlugin: ChannelPlugin = { hint: "", }, }, - setup: imessageSetupAdapter, outbound: { deliveryMode: "direct", chunker: (text, limit) => getIMessageRuntime().channel.text.chunkText(text, limit), chunkerMode: "text", textChunkLimit: 4000, sendText: async ({ cfg, to, text, accountId, deps, replyToId }) => { - const result = await sendIMessageOutbound({ + const result = await (await loadIMessageChannelRuntime()).sendIMessageOutbound({ cfg, to, text, @@ -220,7 +189,7 @@ export const imessagePlugin: ChannelPlugin = { return { channel: "imessage", ...result }; }, sendMedia: async ({ cfg, to, text, mediaUrl, mediaLocalRoots, accountId, deps, replyToId }) => { - const result = await sendIMessageOutbound({ + const result = await (await loadIMessageChannelRuntime()).sendIMessageOutbound({ cfg, to, text, @@ -250,7 +219,7 @@ export const imessagePlugin: ChannelPlugin = { dbPath: snapshot.dbPath ?? null, }), probeAccount: async ({ timeoutMs }) => - getIMessageRuntime().channel.imessage.probeIMessage(timeoutMs), + await (await loadIMessageChannelRuntime()).probeIMessageAccount(timeoutMs), buildAccountSnapshot: ({ account, runtime, probe }) => ({ accountId: account.accountId, name: account.name, @@ -269,24 +238,7 @@ export const imessagePlugin: ChannelPlugin = { resolveAccountState: ({ enabled }) => (enabled ? "enabled" : "disabled"), }, gateway: { - startAccount: async (ctx) => { - const account = ctx.account; - const cliPath = account.config.cliPath?.trim() || "imsg"; - const dbPath = account.config.dbPath?.trim(); - ctx.setStatus({ - accountId: account.accountId, - cliPath, - dbPath: dbPath ?? null, - }); - ctx.log?.info( - `[${account.accountId}] starting provider (${cliPath}${dbPath ? ` db=${dbPath}` : ""})`, - ); - return getIMessageRuntime().channel.imessage.monitorIMessageProvider({ - accountId: account.accountId, - config: ctx.cfg, - runtime: ctx.runtime, - abortSignal: ctx.abortSignal, - }); - }, + startAccount: async (ctx) => + await (await loadIMessageChannelRuntime()).startIMessageGatewayAccount(ctx), }, }; From 0bc9c065f269068459fbb14cb5d548d4ec0d7bae Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:40:26 -0700 Subject: [PATCH 056/187] refactor: move provider auth-choice helpers into plugins --- ...th-choice.apply.plugin-provider.runtime.ts | 6 +- .../auth-choice.apply.plugin-provider.test.ts | 13 +- .../auth-choice.apply.plugin-provider.ts | 296 +---------------- src/commands/auth-choice.apply.ts | 2 +- .../auth-choice.preferred-provider.ts | 48 +-- src/commands/model-picker.runtime.ts | 2 +- .../auth-choice.plugin-providers.test.ts | 2 +- .../local/auth-choice.plugin-providers.ts | 2 +- src/commands/provider-auth-helpers.ts | 83 +---- src/commands/test-wizard-helpers.ts | 93 +----- .../contracts/auth-choice.contract.test.ts | 16 +- src/plugins/contracts/auth.contract.test.ts | 6 +- src/plugins/provider-auth-choice-helpers.ts | 82 +++++ .../provider-auth-choice-preference.ts | 53 +++ src/plugins/provider-auth-choice.runtime.ts | 2 + src/plugins/provider-auth-choice.ts | 309 ++++++++++++++++++ test/helpers/auth-wizard.ts | 92 ++++++ 17 files changed, 563 insertions(+), 544 deletions(-) create mode 100644 src/plugins/provider-auth-choice-helpers.ts create mode 100644 src/plugins/provider-auth-choice-preference.ts create mode 100644 src/plugins/provider-auth-choice.runtime.ts create mode 100644 src/plugins/provider-auth-choice.ts create mode 100644 test/helpers/auth-wizard.ts diff --git a/src/commands/auth-choice.apply.plugin-provider.runtime.ts b/src/commands/auth-choice.apply.plugin-provider.runtime.ts index 9fb990318ad..c1a54580ca7 100644 --- a/src/commands/auth-choice.apply.plugin-provider.runtime.ts +++ b/src/commands/auth-choice.apply.plugin-provider.runtime.ts @@ -1,5 +1 @@ -export { - resolveProviderPluginChoice, - runProviderModelSelectedHook, -} from "../plugins/provider-wizard.js"; -export { resolvePluginProviders } from "../plugins/providers.js"; +export * from "../plugins/provider-auth-choice.runtime.js"; diff --git a/src/commands/auth-choice.apply.plugin-provider.test.ts b/src/commands/auth-choice.apply.plugin-provider.test.ts index 1e731fde48f..40de6a48994 100644 --- a/src/commands/auth-choice.apply.plugin-provider.test.ts +++ b/src/commands/auth-choice.apply.plugin-provider.test.ts @@ -13,7 +13,7 @@ const resolveProviderPluginChoice = vi.hoisted(() => vi.fn<() => { provider: ProviderPlugin; method: ProviderAuthMethod } | null>(), ); const runProviderModelSelectedHook = vi.hoisted(() => vi.fn(async () => {})); -vi.mock("./auth-choice.apply.plugin-provider.runtime.js", () => ({ +vi.mock("../plugins/provider-auth-choice.runtime.js", () => ({ resolvePluginProviders, resolveProviderPluginChoice, runProviderModelSelectedHook, @@ -49,20 +49,17 @@ vi.mock("../plugins/provider-auth-helpers.js", () => ({ })); const isRemoteEnvironment = vi.hoisted(() => vi.fn(() => false)); -vi.mock("./oauth-env.js", () => ({ +const openUrl = vi.hoisted(() => vi.fn(async () => {})); +vi.mock("../plugins/setup-browser.js", () => ({ isRemoteEnvironment, + openUrl, })); const createVpsAwareOAuthHandlers = vi.hoisted(() => vi.fn()); -vi.mock("./oauth-flow.js", () => ({ +vi.mock("../plugins/provider-oauth-flow.js", () => ({ createVpsAwareOAuthHandlers, })); -const openUrl = vi.hoisted(() => vi.fn(async () => {})); -vi.mock("./onboard-helpers.js", () => ({ - openUrl, -})); - function buildProvider(): ProviderPlugin { return { id: "ollama", diff --git a/src/commands/auth-choice.apply.plugin-provider.ts b/src/commands/auth-choice.apply.plugin-provider.ts index ce459020039..aa0f17e4e2f 100644 --- a/src/commands/auth-choice.apply.plugin-provider.ts +++ b/src/commands/auth-choice.apply.plugin-provider.ts @@ -1,295 +1 @@ -import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; -import { - resolveDefaultAgentId, - resolveAgentDir, - resolveAgentWorkspaceDir, -} from "../agents/agent-scope.js"; -import { upsertAuthProfile } from "../agents/auth-profiles.js"; -import { resolveDefaultAgentWorkspaceDir } from "../agents/workspace.js"; -import { enablePluginInConfig } from "../plugins/enable.js"; -import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; -import type { ProviderAuthMethod, ProviderAuthOptionBag } from "../plugins/types.js"; -import type { ApplyAuthChoiceParams, ApplyAuthChoiceResult } from "./auth-choice.apply.js"; -import { isRemoteEnvironment } from "./oauth-env.js"; -import { createVpsAwareOAuthHandlers } from "./oauth-flow.js"; -import { openUrl } from "./onboard-helpers.js"; -import type { OnboardOptions } from "./onboard-types.js"; -import { - applyDefaultModel, - mergeConfigPatch, - pickAuthMethod, - resolveProviderMatch, -} from "./provider-auth-helpers.js"; - -export type PluginProviderAuthChoiceOptions = { - authChoice: string; - pluginId: string; - providerId: string; - methodId?: string; - label: string; -}; - -function restoreConfiguredPrimaryModel( - nextConfig: ApplyAuthChoiceParams["config"], - originalConfig: ApplyAuthChoiceParams["config"], -): ApplyAuthChoiceParams["config"] { - const originalModel = originalConfig.agents?.defaults?.model; - const nextAgents = nextConfig.agents; - const nextDefaults = nextAgents?.defaults; - if (!nextDefaults) { - return nextConfig; - } - if (originalModel !== undefined) { - return { - ...nextConfig, - agents: { - ...nextAgents, - defaults: { - ...nextDefaults, - model: originalModel, - }, - }, - }; - } - const { model: _model, ...restDefaults } = nextDefaults; - return { - ...nextConfig, - agents: { - ...nextAgents, - defaults: restDefaults, - }, - }; -} - -async function loadPluginProviderRuntime() { - return import("./auth-choice.apply.plugin-provider.runtime.js"); -} - -export async function runProviderPluginAuthMethod(params: { - config: ApplyAuthChoiceParams["config"]; - runtime: ApplyAuthChoiceParams["runtime"]; - prompter: ApplyAuthChoiceParams["prompter"]; - method: ProviderAuthMethod; - agentDir?: string; - agentId?: string; - workspaceDir?: string; - emitNotes?: boolean; - secretInputMode?: OnboardOptions["secretInputMode"]; - allowSecretRefPrompt?: boolean; - opts?: Partial; -}): Promise<{ config: ApplyAuthChoiceParams["config"]; defaultModel?: string }> { - const agentId = params.agentId ?? resolveDefaultAgentId(params.config); - const defaultAgentId = resolveDefaultAgentId(params.config); - const agentDir = - params.agentDir ?? - (agentId === defaultAgentId - ? resolveOpenClawAgentDir() - : resolveAgentDir(params.config, agentId)); - const workspaceDir = - params.workspaceDir ?? - resolveAgentWorkspaceDir(params.config, agentId) ?? - resolveDefaultAgentWorkspaceDir(); - - const isRemote = isRemoteEnvironment(); - const result = await params.method.run({ - config: params.config, - agentDir, - workspaceDir, - prompter: params.prompter, - runtime: params.runtime, - opts: params.opts as ProviderAuthOptionBag | undefined, - secretInputMode: params.secretInputMode, - allowSecretRefPrompt: params.allowSecretRefPrompt, - isRemote, - openUrl: async (url) => { - await openUrl(url); - }, - oauth: { - createVpsAwareHandlers: (opts) => createVpsAwareOAuthHandlers(opts), - }, - }); - - let nextConfig = params.config; - if (result.configPatch) { - nextConfig = mergeConfigPatch(nextConfig, result.configPatch); - } - - for (const profile of result.profiles) { - upsertAuthProfile({ - profileId: profile.profileId, - credential: profile.credential, - agentDir, - }); - - nextConfig = applyAuthProfileConfig(nextConfig, { - profileId: profile.profileId, - provider: profile.credential.provider, - mode: profile.credential.type === "token" ? "token" : profile.credential.type, - ...("email" in profile.credential && profile.credential.email - ? { email: profile.credential.email } - : {}), - }); - } - - if (params.emitNotes !== false && result.notes && result.notes.length > 0) { - await params.prompter.note(result.notes.join("\n"), "Provider notes"); - } - - return { - config: nextConfig, - defaultModel: result.defaultModel, - }; -} - -export async function applyAuthChoiceLoadedPluginProvider( - params: ApplyAuthChoiceParams, -): Promise { - const agentId = params.agentId ?? resolveDefaultAgentId(params.config); - const workspaceDir = - resolveAgentWorkspaceDir(params.config, agentId) ?? resolveDefaultAgentWorkspaceDir(); - const { resolvePluginProviders, resolveProviderPluginChoice, runProviderModelSelectedHook } = - await loadPluginProviderRuntime(); - const providers = resolvePluginProviders({ - config: params.config, - workspaceDir, - bundledProviderAllowlistCompat: true, - bundledProviderVitestCompat: true, - }); - const resolved = resolveProviderPluginChoice({ - providers, - choice: params.authChoice, - }); - if (!resolved) { - return null; - } - - const applied = await runProviderPluginAuthMethod({ - config: params.config, - runtime: params.runtime, - prompter: params.prompter, - method: resolved.method, - agentDir: params.agentDir, - agentId: params.agentId, - workspaceDir, - secretInputMode: params.opts?.secretInputMode, - allowSecretRefPrompt: false, - opts: params.opts as ProviderAuthOptionBag | undefined, - }); - - let nextConfig = applied.config; - let agentModelOverride: string | undefined; - if (applied.defaultModel) { - if (params.setDefaultModel) { - nextConfig = applyDefaultModel(nextConfig, applied.defaultModel); - await runProviderModelSelectedHook({ - config: nextConfig, - model: applied.defaultModel, - prompter: params.prompter, - agentDir: params.agentDir, - workspaceDir, - }); - await params.prompter.note( - `Default model set to ${applied.defaultModel}`, - "Model configured", - ); - return { config: nextConfig }; - } - nextConfig = restoreConfiguredPrimaryModel(nextConfig, params.config); - agentModelOverride = applied.defaultModel; - } - - return { config: nextConfig, agentModelOverride }; -} - -export async function applyAuthChoicePluginProvider( - params: ApplyAuthChoiceParams, - options: PluginProviderAuthChoiceOptions, -): Promise { - if (params.authChoice !== options.authChoice) { - return null; - } - - const enableResult = enablePluginInConfig(params.config, options.pluginId); - let nextConfig = enableResult.config; - if (!enableResult.enabled) { - await params.prompter.note( - `${options.label} plugin is disabled (${enableResult.reason ?? "blocked"}).`, - options.label, - ); - return { config: nextConfig }; - } - - const agentId = params.agentId ?? resolveDefaultAgentId(nextConfig); - const defaultAgentId = resolveDefaultAgentId(nextConfig); - const agentDir = - params.agentDir ?? - (agentId === defaultAgentId ? resolveOpenClawAgentDir() : resolveAgentDir(nextConfig, agentId)); - const workspaceDir = - resolveAgentWorkspaceDir(nextConfig, agentId) ?? resolveDefaultAgentWorkspaceDir(); - - const { resolvePluginProviders, runProviderModelSelectedHook } = - await loadPluginProviderRuntime(); - const providers = resolvePluginProviders({ - config: nextConfig, - workspaceDir, - bundledProviderAllowlistCompat: true, - bundledProviderVitestCompat: true, - }); - const provider = resolveProviderMatch(providers, options.providerId); - if (!provider) { - await params.prompter.note( - `${options.label} auth plugin is not available. Enable it and re-run onboarding.`, - options.label, - ); - return { config: nextConfig }; - } - - const method = pickAuthMethod(provider, options.methodId) ?? provider.auth[0]; - if (!method) { - await params.prompter.note(`${options.label} auth method missing.`, options.label); - return { config: nextConfig }; - } - - const applied = await runProviderPluginAuthMethod({ - config: nextConfig, - runtime: params.runtime, - prompter: params.prompter, - method, - agentDir, - agentId, - workspaceDir, - secretInputMode: params.opts?.secretInputMode, - allowSecretRefPrompt: false, - opts: params.opts as ProviderAuthOptionBag | undefined, - }); - nextConfig = applied.config; - - let agentModelOverride: string | undefined; - if (applied.defaultModel) { - if (params.setDefaultModel) { - nextConfig = applyDefaultModel(nextConfig, applied.defaultModel); - await runProviderModelSelectedHook({ - config: nextConfig, - model: applied.defaultModel, - prompter: params.prompter, - agentDir, - workspaceDir, - }); - await params.prompter.note( - `Default model set to ${applied.defaultModel}`, - "Model configured", - ); - } else { - nextConfig = restoreConfiguredPrimaryModel(nextConfig, params.config); - } - if (!params.setDefaultModel && params.agentId) { - agentModelOverride = applied.defaultModel; - await params.prompter.note( - `Default model set to ${applied.defaultModel} for agent "${params.agentId}".`, - "Model configured", - ); - } - } - - return { config: nextConfig, agentModelOverride }; -} +export * from "../plugins/provider-auth-choice.js"; diff --git a/src/commands/auth-choice.apply.ts b/src/commands/auth-choice.apply.ts index cf96b8f8905..a2b8f31c206 100644 --- a/src/commands/auth-choice.apply.ts +++ b/src/commands/auth-choice.apply.ts @@ -1,11 +1,11 @@ import type { OpenClawConfig } from "../config/config.js"; +import { applyAuthChoiceLoadedPluginProvider } from "../plugins/provider-auth-choice.js"; import type { RuntimeEnv } from "../runtime.js"; import type { WizardPrompter } from "../wizard/prompts.js"; import { normalizeLegacyOnboardAuthChoice } from "./auth-choice-legacy.js"; import { applyAuthChoiceApiProviders } from "./auth-choice.apply.api-providers.js"; import { normalizeApiKeyTokenProviderAuthChoice } from "./auth-choice.apply.api-providers.js"; import { applyAuthChoiceOAuth } from "./auth-choice.apply.oauth.js"; -import { applyAuthChoiceLoadedPluginProvider } from "./auth-choice.apply.plugin-provider.js"; import type { AuthChoice, OnboardOptions } from "./onboard-types.js"; export type ApplyAuthChoiceParams = { diff --git a/src/commands/auth-choice.preferred-provider.ts b/src/commands/auth-choice.preferred-provider.ts index 7cab79d2215..7b8189414cf 100644 --- a/src/commands/auth-choice.preferred-provider.ts +++ b/src/commands/auth-choice.preferred-provider.ts @@ -1,47 +1 @@ -import type { OpenClawConfig } from "../config/config.js"; -import { resolveManifestProviderAuthChoice } from "../plugins/provider-auth-choices.js"; -import { normalizeLegacyOnboardAuthChoice } from "./auth-choice-legacy.js"; -import type { AuthChoice } from "./onboard-types.js"; - -const PREFERRED_PROVIDER_BY_AUTH_CHOICE: Partial> = { - chutes: "chutes", - "litellm-api-key": "litellm", - "custom-api-key": "custom", -}; - -export async function resolvePreferredProviderForAuthChoice(params: { - choice: AuthChoice; - config?: OpenClawConfig; - workspaceDir?: string; - env?: NodeJS.ProcessEnv; -}): Promise { - const choice = normalizeLegacyOnboardAuthChoice(params.choice) ?? params.choice; - const manifestResolved = resolveManifestProviderAuthChoice(choice, params); - if (manifestResolved) { - return manifestResolved.providerId; - } - const [{ resolveProviderPluginChoice }, { resolvePluginProviders }] = await Promise.all([ - import("../plugins/provider-wizard.js"), - import("../plugins/providers.js"), - ]); - const providers = resolvePluginProviders({ - config: params.config, - workspaceDir: params.workspaceDir, - env: params.env, - bundledProviderAllowlistCompat: true, - bundledProviderVitestCompat: true, - }); - const pluginResolved = resolveProviderPluginChoice({ - providers, - choice, - }); - if (pluginResolved) { - return pluginResolved.provider.id; - } - - const preferred = PREFERRED_PROVIDER_BY_AUTH_CHOICE[choice]; - if (preferred) { - return preferred; - } - return undefined; -} +export * from "../plugins/provider-auth-choice-preference.js"; diff --git a/src/commands/model-picker.runtime.ts b/src/commands/model-picker.runtime.ts index 74c4f68c605..3d033fa3e80 100644 --- a/src/commands/model-picker.runtime.ts +++ b/src/commands/model-picker.runtime.ts @@ -4,4 +4,4 @@ export { runProviderModelSelectedHook, } from "../plugins/provider-wizard.js"; export { resolvePluginProviders } from "../plugins/providers.js"; -export { runProviderPluginAuthMethod } from "./auth-choice.apply.plugin-provider.js"; +export { runProviderPluginAuthMethod } from "../plugins/provider-auth-choice.js"; diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts index f993091dd49..3ccee9bbfd3 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts @@ -3,7 +3,7 @@ import type { OpenClawConfig } from "../../../config/config.js"; import { applyNonInteractivePluginProviderChoice } from "./auth-choice.plugin-providers.js"; const resolvePreferredProviderForAuthChoice = vi.hoisted(() => vi.fn(async () => undefined)); -vi.mock("../../auth-choice.preferred-provider.js", () => ({ +vi.mock("../../../plugins/provider-auth-choice-preference.js", () => ({ resolvePreferredProviderForAuthChoice, })); diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts index 54f25857441..b7a369e4674 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts @@ -7,13 +7,13 @@ import type { ApiKeyCredential } from "../../../agents/auth-profiles/types.js"; import { resolveDefaultAgentWorkspaceDir } from "../../../agents/workspace.js"; import type { OpenClawConfig } from "../../../config/config.js"; import { enablePluginInConfig } from "../../../plugins/enable.js"; +import { resolvePreferredProviderForAuthChoice } from "../../../plugins/provider-auth-choice-preference.js"; import type { ProviderAuthOptionBag, ProviderNonInteractiveApiKeyCredentialParams, ProviderResolveNonInteractiveApiKeyParams, } from "../../../plugins/types.js"; import type { RuntimeEnv } from "../../../runtime.js"; -import { resolvePreferredProviderForAuthChoice } from "../../auth-choice.preferred-provider.js"; import type { OnboardOptions } from "../../onboard-types.js"; const PROVIDER_PLUGIN_CHOICE_PREFIX = "provider-plugin:"; diff --git a/src/commands/provider-auth-helpers.ts b/src/commands/provider-auth-helpers.ts index f36c1c3de73..a9fabf9f1bd 100644 --- a/src/commands/provider-auth-helpers.ts +++ b/src/commands/provider-auth-helpers.ts @@ -1,82 +1 @@ -import { normalizeProviderId } from "../agents/model-selection.js"; -import type { OpenClawConfig } from "../config/config.js"; -import type { ProviderAuthMethod, ProviderPlugin } from "../plugins/types.js"; - -export function resolveProviderMatch( - providers: ProviderPlugin[], - rawProvider?: string, -): ProviderPlugin | null { - const raw = rawProvider?.trim(); - if (!raw) { - return null; - } - const normalized = normalizeProviderId(raw); - return ( - providers.find((provider) => normalizeProviderId(provider.id) === normalized) ?? - providers.find( - (provider) => - provider.aliases?.some((alias) => normalizeProviderId(alias) === normalized) ?? false, - ) ?? - null - ); -} - -export function pickAuthMethod( - provider: ProviderPlugin, - rawMethod?: string, -): ProviderAuthMethod | null { - const raw = rawMethod?.trim(); - if (!raw) { - return null; - } - const normalized = raw.toLowerCase(); - return ( - provider.auth.find((method) => method.id.toLowerCase() === normalized) ?? - provider.auth.find((method) => method.label.toLowerCase() === normalized) ?? - null - ); -} - -function isPlainRecord(value: unknown): value is Record { - return Boolean(value && typeof value === "object" && !Array.isArray(value)); -} - -export function mergeConfigPatch(base: T, patch: unknown): T { - if (!isPlainRecord(base) || !isPlainRecord(patch)) { - return patch as T; - } - - const next: Record = { ...base }; - for (const [key, value] of Object.entries(patch)) { - const existing = next[key]; - if (isPlainRecord(existing) && isPlainRecord(value)) { - next[key] = mergeConfigPatch(existing, value); - } else { - next[key] = value; - } - } - return next as T; -} - -export function applyDefaultModel(cfg: OpenClawConfig, model: string): OpenClawConfig { - const models = { ...cfg.agents?.defaults?.models }; - models[model] = models[model] ?? {}; - - const existingModel = cfg.agents?.defaults?.model; - return { - ...cfg, - agents: { - ...cfg.agents, - defaults: { - ...cfg.agents?.defaults, - models, - model: { - ...(existingModel && typeof existingModel === "object" && "fallbacks" in existingModel - ? { fallbacks: (existingModel as { fallbacks?: string[] }).fallbacks } - : undefined), - primary: model, - }, - }, - }, - }; -} +export * from "../plugins/provider-auth-choice-helpers.js"; diff --git a/src/commands/test-wizard-helpers.ts b/src/commands/test-wizard-helpers.ts index 078cd5ef87c..77d6eaa0754 100644 --- a/src/commands/test-wizard-helpers.ts +++ b/src/commands/test-wizard-helpers.ts @@ -1,92 +1 @@ -import fs from "node:fs/promises"; -import path from "node:path"; -import { vi } from "vitest"; -import type { RuntimeEnv } from "../runtime.js"; -import { makeTempWorkspace } from "../test-helpers/workspace.js"; -import { captureEnv } from "../test-utils/env.js"; -import type { WizardPrompter } from "../wizard/prompts.js"; - -export const noopAsync = async () => {}; -export const noop = () => {}; - -export function createExitThrowingRuntime(): RuntimeEnv { - return { - log: vi.fn(), - error: vi.fn(), - exit: vi.fn((code: number) => { - throw new Error(`exit:${code}`); - }), - }; -} - -export function createWizardPrompter( - overrides: Partial, - options?: { defaultSelect?: string }, -): WizardPrompter { - return { - intro: vi.fn(noopAsync), - outro: vi.fn(noopAsync), - note: vi.fn(noopAsync), - select: vi.fn(async () => (options?.defaultSelect ?? "") as never), - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as unknown as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: noop, stop: noop })), - ...overrides, - }; -} - -export async function setupAuthTestEnv( - prefix = "openclaw-auth-", - options?: { agentSubdir?: string }, -): Promise<{ - stateDir: string; - agentDir: string; -}> { - const stateDir = await makeTempWorkspace(prefix); - const agentDir = path.join(stateDir, options?.agentSubdir ?? "agent"); - process.env.OPENCLAW_STATE_DIR = stateDir; - process.env.OPENCLAW_AGENT_DIR = agentDir; - process.env.PI_CODING_AGENT_DIR = agentDir; - await fs.mkdir(agentDir, { recursive: true }); - return { stateDir, agentDir }; -} - -export type AuthTestLifecycle = { - setStateDir: (stateDir: string) => void; - cleanup: () => Promise; -}; - -export function createAuthTestLifecycle(envKeys: string[]): AuthTestLifecycle { - const envSnapshot = captureEnv(envKeys); - let stateDir: string | null = null; - return { - setStateDir(nextStateDir: string) { - stateDir = nextStateDir; - }, - async cleanup() { - if (stateDir) { - await fs.rm(stateDir, { recursive: true, force: true }); - stateDir = null; - } - envSnapshot.restore(); - }, - }; -} - -export function requireOpenClawAgentDir(): string { - const agentDir = process.env.OPENCLAW_AGENT_DIR; - if (!agentDir) { - throw new Error("OPENCLAW_AGENT_DIR not set"); - } - return agentDir; -} - -export function authProfilePathForAgent(agentDir: string): string { - return path.join(agentDir, "auth-profiles.json"); -} - -export async function readAuthProfilesForAgent(agentDir: string): Promise { - const raw = await fs.readFile(authProfilePathForAgent(agentDir), "utf8"); - return JSON.parse(raw) as T; -} +export * from "../../test/helpers/auth-wizard.js"; diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index 631df701933..7f3f6535e54 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,6 +1,4 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; -import { applyAuthChoiceLoadedPluginProvider } from "../../commands/auth-choice.apply.plugin-provider.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, @@ -8,18 +6,20 @@ import { readAuthProfilesForAgent, requireOpenClawAgentDir, setupAuthTestEnv, -} from "../../commands/test-wizard-helpers.js"; +} from "../../../test/helpers/auth-wizard.js"; +import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; +import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; type ResolvePluginProviders = - typeof import("../../commands/auth-choice.apply.plugin-provider.runtime.js").resolvePluginProviders; + typeof import("../../plugins/provider-auth-choice.runtime.js").resolvePluginProviders; type ResolveProviderPluginChoice = - typeof import("../../commands/auth-choice.apply.plugin-provider.runtime.js").resolveProviderPluginChoice; + typeof import("../../plugins/provider-auth-choice.runtime.js").resolveProviderPluginChoice; type RunProviderModelSelectedHook = - typeof import("../../commands/auth-choice.apply.plugin-provider.runtime.js").runProviderModelSelectedHook; + typeof import("../../plugins/provider-auth-choice.runtime.js").runProviderModelSelectedHook; const loginQwenPortalOAuthMock = vi.hoisted(() => vi.fn()); const githubCopilotLoginCommandMock = vi.hoisted(() => vi.fn()); @@ -38,7 +38,7 @@ vi.mock("../../providers/github-copilot-auth.js", () => ({ githubCopilotLoginCommand: githubCopilotLoginCommandMock, })); -vi.mock("../../commands/auth-choice.apply.plugin-provider.runtime.js", () => ({ +vi.mock("../../plugins/provider-auth-choice.runtime.js", () => ({ resolvePluginProviders: resolvePluginProvidersMock, resolveProviderPluginChoice: resolveProviderPluginChoiceMock, runProviderModelSelectedHook: runProviderModelSelectedHookMock, @@ -54,7 +54,7 @@ vi.mock("../../plugins/providers.js", async () => { }); const { resolvePreferredProviderForAuthChoice } = - await import("../../commands/auth-choice.preferred-provider.js"); + await import("../../plugins/provider-auth-choice-preference.js"); type StoredAuthProfile = { type?: string; diff --git a/src/plugins/contracts/auth.contract.test.ts b/src/plugins/contracts/auth.contract.test.ts index cca85917c59..1b8c809f9df 100644 --- a/src/plugins/contracts/auth.contract.test.ts +++ b/src/plugins/contracts/auth.contract.test.ts @@ -14,19 +14,19 @@ import type { import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; type LoginOpenAICodexOAuth = - (typeof import("../../commands/openai-codex-oauth.js"))["loginOpenAICodexOAuth"]; + (typeof import("../../plugins/provider-openai-codex-oauth.js"))["loginOpenAICodexOAuth"]; type LoginQwenPortalOAuth = (typeof import("../../../extensions/qwen-portal-auth/oauth.js"))["loginQwenPortalOAuth"]; type GithubCopilotLoginCommand = (typeof import("../../providers/github-copilot-auth.js"))["githubCopilotLoginCommand"]; type CreateVpsAwareHandlers = - (typeof import("../../commands/oauth-flow.js"))["createVpsAwareOAuthHandlers"]; + (typeof import("../../plugins/provider-oauth-flow.js"))["createVpsAwareOAuthHandlers"]; const loginOpenAICodexOAuthMock = vi.hoisted(() => vi.fn()); const loginQwenPortalOAuthMock = vi.hoisted(() => vi.fn()); const githubCopilotLoginCommandMock = vi.hoisted(() => vi.fn()); -vi.mock("../../commands/openai-codex-oauth.js", () => ({ +vi.mock("../../plugins/provider-openai-codex-oauth.js", () => ({ loginOpenAICodexOAuth: loginOpenAICodexOAuthMock, })); diff --git a/src/plugins/provider-auth-choice-helpers.ts b/src/plugins/provider-auth-choice-helpers.ts new file mode 100644 index 00000000000..d9ce7a57db8 --- /dev/null +++ b/src/plugins/provider-auth-choice-helpers.ts @@ -0,0 +1,82 @@ +import { normalizeProviderId } from "../agents/model-selection.js"; +import type { OpenClawConfig } from "../config/config.js"; +import type { ProviderAuthMethod, ProviderPlugin } from "./types.js"; + +export function resolveProviderMatch( + providers: ProviderPlugin[], + rawProvider?: string, +): ProviderPlugin | null { + const raw = rawProvider?.trim(); + if (!raw) { + return null; + } + const normalized = normalizeProviderId(raw); + return ( + providers.find((provider) => normalizeProviderId(provider.id) === normalized) ?? + providers.find( + (provider) => + provider.aliases?.some((alias) => normalizeProviderId(alias) === normalized) ?? false, + ) ?? + null + ); +} + +export function pickAuthMethod( + provider: ProviderPlugin, + rawMethod?: string, +): ProviderAuthMethod | null { + const raw = rawMethod?.trim(); + if (!raw) { + return null; + } + const normalized = raw.toLowerCase(); + return ( + provider.auth.find((method) => method.id.toLowerCase() === normalized) ?? + provider.auth.find((method) => method.label.toLowerCase() === normalized) ?? + null + ); +} + +function isPlainRecord(value: unknown): value is Record { + return Boolean(value && typeof value === "object" && !Array.isArray(value)); +} + +export function mergeConfigPatch(base: T, patch: unknown): T { + if (!isPlainRecord(base) || !isPlainRecord(patch)) { + return patch as T; + } + + const next: Record = { ...base }; + for (const [key, value] of Object.entries(patch)) { + const existing = next[key]; + if (isPlainRecord(existing) && isPlainRecord(value)) { + next[key] = mergeConfigPatch(existing, value); + } else { + next[key] = value; + } + } + return next as T; +} + +export function applyDefaultModel(cfg: OpenClawConfig, model: string): OpenClawConfig { + const models = { ...cfg.agents?.defaults?.models }; + models[model] = models[model] ?? {}; + + const existingModel = cfg.agents?.defaults?.model; + return { + ...cfg, + agents: { + ...cfg.agents, + defaults: { + ...cfg.agents?.defaults, + models, + model: { + ...(existingModel && typeof existingModel === "object" && "fallbacks" in existingModel + ? { fallbacks: (existingModel as { fallbacks?: string[] }).fallbacks } + : undefined), + primary: model, + }, + }, + }, + }; +} diff --git a/src/plugins/provider-auth-choice-preference.ts b/src/plugins/provider-auth-choice-preference.ts new file mode 100644 index 00000000000..dfd247f1e31 --- /dev/null +++ b/src/plugins/provider-auth-choice-preference.ts @@ -0,0 +1,53 @@ +import type { OpenClawConfig } from "../config/config.js"; +import { resolveManifestProviderAuthChoice } from "./provider-auth-choices.js"; + +const PREFERRED_PROVIDER_BY_AUTH_CHOICE: Partial> = { + chutes: "chutes", + "litellm-api-key": "litellm", + "custom-api-key": "custom", +}; + +function normalizeLegacyAuthChoice(choice: string): string { + if (choice === "oauth") { + return "setup-token"; + } + if (choice === "claude-cli") { + return "setup-token"; + } + if (choice === "codex-cli") { + return "openai-codex"; + } + return choice; +} + +export async function resolvePreferredProviderForAuthChoice(params: { + choice: string; + config?: OpenClawConfig; + workspaceDir?: string; + env?: NodeJS.ProcessEnv; +}): Promise { + const choice = normalizeLegacyAuthChoice(params.choice) ?? params.choice; + const manifestResolved = resolveManifestProviderAuthChoice(choice, params); + if (manifestResolved) { + return manifestResolved.providerId; + } + + const { resolveProviderPluginChoice, resolvePluginProviders } = + await import("./provider-auth-choice.runtime.js"); + const providers = resolvePluginProviders({ + config: params.config, + workspaceDir: params.workspaceDir, + env: params.env, + bundledProviderAllowlistCompat: true, + bundledProviderVitestCompat: true, + }); + const pluginResolved = resolveProviderPluginChoice({ + providers, + choice, + }); + if (pluginResolved) { + return pluginResolved.provider.id; + } + + return PREFERRED_PROVIDER_BY_AUTH_CHOICE[choice]; +} diff --git a/src/plugins/provider-auth-choice.runtime.ts b/src/plugins/provider-auth-choice.runtime.ts new file mode 100644 index 00000000000..7c83aa6da3a --- /dev/null +++ b/src/plugins/provider-auth-choice.runtime.ts @@ -0,0 +1,2 @@ +export { resolveProviderPluginChoice, runProviderModelSelectedHook } from "./provider-wizard.js"; +export { resolvePluginProviders } from "./providers.js"; diff --git a/src/plugins/provider-auth-choice.ts b/src/plugins/provider-auth-choice.ts new file mode 100644 index 00000000000..940a26b20d1 --- /dev/null +++ b/src/plugins/provider-auth-choice.ts @@ -0,0 +1,309 @@ +import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; +import { + resolveDefaultAgentId, + resolveAgentDir, + resolveAgentWorkspaceDir, +} from "../agents/agent-scope.js"; +import { upsertAuthProfile } from "../agents/auth-profiles.js"; +import { resolveDefaultAgentWorkspaceDir } from "../agents/workspace.js"; +import type { OpenClawConfig } from "../config/config.js"; +import type { RuntimeEnv } from "../runtime.js"; +import type { WizardPrompter } from "../wizard/prompts.js"; +import { enablePluginInConfig } from "./enable.js"; +import { + applyDefaultModel, + mergeConfigPatch, + pickAuthMethod, + resolveProviderMatch, +} from "./provider-auth-choice-helpers.js"; +import { applyAuthProfileConfig } from "./provider-auth-helpers.js"; +import { createVpsAwareOAuthHandlers } from "./provider-oauth-flow.js"; +import { isRemoteEnvironment, openUrl } from "./setup-browser.js"; +import type { ProviderAuthMethod, ProviderAuthOptionBag, ProviderPlugin } from "./types.js"; + +export type ApplyProviderAuthChoiceParams = { + authChoice: string; + config: OpenClawConfig; + prompter: WizardPrompter; + runtime: RuntimeEnv; + agentDir?: string; + setDefaultModel: boolean; + agentId?: string; + opts?: Partial; +}; + +export type ApplyProviderAuthChoiceResult = { + config: OpenClawConfig; + agentModelOverride?: string; +}; + +export type PluginProviderAuthChoiceOptions = { + authChoice: string; + pluginId: string; + providerId: string; + methodId?: string; + label: string; +}; + +function restoreConfiguredPrimaryModel( + nextConfig: OpenClawConfig, + originalConfig: OpenClawConfig, +): OpenClawConfig { + const originalModel = originalConfig.agents?.defaults?.model; + const nextAgents = nextConfig.agents; + const nextDefaults = nextAgents?.defaults; + if (!nextDefaults) { + return nextConfig; + } + if (originalModel !== undefined) { + return { + ...nextConfig, + agents: { + ...nextAgents, + defaults: { + ...nextDefaults, + model: originalModel, + }, + }, + }; + } + const { model: _model, ...restDefaults } = nextDefaults; + return { + ...nextConfig, + agents: { + ...nextAgents, + defaults: restDefaults, + }, + }; +} + +async function loadPluginProviderRuntime() { + return import("./provider-auth-choice.runtime.js"); +} + +export async function runProviderPluginAuthMethod(params: { + config: OpenClawConfig; + runtime: RuntimeEnv; + prompter: WizardPrompter; + method: ProviderAuthMethod; + agentDir?: string; + agentId?: string; + workspaceDir?: string; + emitNotes?: boolean; + secretInputMode?: ProviderAuthOptionBag["secretInputMode"]; + allowSecretRefPrompt?: boolean; + opts?: Partial; +}): Promise<{ config: OpenClawConfig; defaultModel?: string }> { + const agentId = params.agentId ?? resolveDefaultAgentId(params.config); + const defaultAgentId = resolveDefaultAgentId(params.config); + const agentDir = + params.agentDir ?? + (agentId === defaultAgentId + ? resolveOpenClawAgentDir() + : resolveAgentDir(params.config, agentId)); + const workspaceDir = + params.workspaceDir ?? + resolveAgentWorkspaceDir(params.config, agentId) ?? + resolveDefaultAgentWorkspaceDir(); + + const result = await params.method.run({ + config: params.config, + agentDir, + workspaceDir, + prompter: params.prompter, + runtime: params.runtime, + opts: params.opts, + secretInputMode: params.secretInputMode, + allowSecretRefPrompt: params.allowSecretRefPrompt, + isRemote: isRemoteEnvironment(), + openUrl: async (url) => { + await openUrl(url); + }, + oauth: { + createVpsAwareHandlers: (opts) => createVpsAwareOAuthHandlers(opts), + }, + }); + + let nextConfig = params.config; + if (result.configPatch) { + nextConfig = mergeConfigPatch(nextConfig, result.configPatch); + } + + for (const profile of result.profiles) { + upsertAuthProfile({ + profileId: profile.profileId, + credential: profile.credential, + agentDir, + }); + + nextConfig = applyAuthProfileConfig(nextConfig, { + profileId: profile.profileId, + provider: profile.credential.provider, + mode: profile.credential.type === "token" ? "token" : profile.credential.type, + ...("email" in profile.credential && profile.credential.email + ? { email: profile.credential.email } + : {}), + }); + } + + if (params.emitNotes !== false && result.notes && result.notes.length > 0) { + await params.prompter.note(result.notes.join("\n"), "Provider notes"); + } + + return { + config: nextConfig, + defaultModel: result.defaultModel, + }; +} + +export async function applyAuthChoiceLoadedPluginProvider( + params: ApplyProviderAuthChoiceParams, +): Promise { + const agentId = params.agentId ?? resolveDefaultAgentId(params.config); + const workspaceDir = + resolveAgentWorkspaceDir(params.config, agentId) ?? resolveDefaultAgentWorkspaceDir(); + const { resolvePluginProviders, resolveProviderPluginChoice, runProviderModelSelectedHook } = + await loadPluginProviderRuntime(); + const providers = resolvePluginProviders({ + config: params.config, + workspaceDir, + bundledProviderAllowlistCompat: true, + bundledProviderVitestCompat: true, + }); + const resolved = resolveProviderPluginChoice({ + providers, + choice: params.authChoice, + }); + if (!resolved) { + return null; + } + + const applied = await runProviderPluginAuthMethod({ + config: params.config, + runtime: params.runtime, + prompter: params.prompter, + method: resolved.method, + agentDir: params.agentDir, + agentId: params.agentId, + workspaceDir, + secretInputMode: params.opts?.secretInputMode, + allowSecretRefPrompt: false, + opts: params.opts, + }); + + let nextConfig = applied.config; + let agentModelOverride: string | undefined; + if (applied.defaultModel) { + if (params.setDefaultModel) { + nextConfig = applyDefaultModel(nextConfig, applied.defaultModel); + await runProviderModelSelectedHook({ + config: nextConfig, + model: applied.defaultModel, + prompter: params.prompter, + agentDir: params.agentDir, + workspaceDir, + }); + await params.prompter.note( + `Default model set to ${applied.defaultModel}`, + "Model configured", + ); + return { config: nextConfig }; + } + nextConfig = restoreConfiguredPrimaryModel(nextConfig, params.config); + agentModelOverride = applied.defaultModel; + } + + return { config: nextConfig, agentModelOverride }; +} + +export async function applyAuthChoicePluginProvider( + params: ApplyProviderAuthChoiceParams, + options: PluginProviderAuthChoiceOptions, +): Promise { + if (params.authChoice !== options.authChoice) { + return null; + } + + const enableResult = enablePluginInConfig(params.config, options.pluginId); + let nextConfig = enableResult.config; + if (!enableResult.enabled) { + await params.prompter.note( + `${options.label} plugin is disabled (${enableResult.reason ?? "blocked"}).`, + options.label, + ); + return { config: nextConfig }; + } + + const agentId = params.agentId ?? resolveDefaultAgentId(nextConfig); + const defaultAgentId = resolveDefaultAgentId(nextConfig); + const agentDir = + params.agentDir ?? + (agentId === defaultAgentId ? resolveOpenClawAgentDir() : resolveAgentDir(nextConfig, agentId)); + const workspaceDir = + resolveAgentWorkspaceDir(nextConfig, agentId) ?? resolveDefaultAgentWorkspaceDir(); + + const { resolvePluginProviders, runProviderModelSelectedHook } = + await loadPluginProviderRuntime(); + const providers = resolvePluginProviders({ + config: nextConfig, + workspaceDir, + bundledProviderAllowlistCompat: true, + bundledProviderVitestCompat: true, + }); + const provider = resolveProviderMatch(providers, options.providerId); + if (!provider) { + await params.prompter.note( + `${options.label} auth plugin is not available. Enable it and re-run onboarding.`, + options.label, + ); + return { config: nextConfig }; + } + + const method = pickAuthMethod(provider, options.methodId) ?? provider.auth[0]; + if (!method) { + await params.prompter.note(`${options.label} auth method missing.`, options.label); + return { config: nextConfig }; + } + + const applied = await runProviderPluginAuthMethod({ + config: nextConfig, + runtime: params.runtime, + prompter: params.prompter, + method, + agentDir, + agentId, + workspaceDir, + secretInputMode: params.opts?.secretInputMode, + allowSecretRefPrompt: false, + opts: params.opts, + }); + + nextConfig = applied.config; + if (applied.defaultModel) { + if (params.setDefaultModel) { + nextConfig = applyDefaultModel(nextConfig, applied.defaultModel); + await runProviderModelSelectedHook({ + config: nextConfig, + model: applied.defaultModel, + prompter: params.prompter, + agentDir, + workspaceDir, + }); + await params.prompter.note( + `Default model set to ${applied.defaultModel}`, + "Model configured", + ); + return { config: nextConfig }; + } + if (params.agentId) { + await params.prompter.note( + `Default model set to ${applied.defaultModel} for agent "${params.agentId}".`, + "Model configured", + ); + } + nextConfig = restoreConfiguredPrimaryModel(nextConfig, params.config); + return { config: nextConfig, agentModelOverride: applied.defaultModel }; + } + + return { config: nextConfig }; +} diff --git a/test/helpers/auth-wizard.ts b/test/helpers/auth-wizard.ts new file mode 100644 index 00000000000..a9e409aa25a --- /dev/null +++ b/test/helpers/auth-wizard.ts @@ -0,0 +1,92 @@ +import fs from "node:fs/promises"; +import path from "node:path"; +import { vi } from "vitest"; +import type { RuntimeEnv } from "../../src/runtime.js"; +import { makeTempWorkspace } from "../../src/test-helpers/workspace.js"; +import { captureEnv } from "../../src/test-utils/env.js"; +import type { WizardPrompter } from "../../src/wizard/prompts.js"; + +export const noopAsync = async () => {}; +export const noop = () => {}; + +export function createExitThrowingRuntime(): RuntimeEnv { + return { + log: vi.fn(), + error: vi.fn(), + exit: vi.fn((code: number) => { + throw new Error(`exit:${code}`); + }), + }; +} + +export function createWizardPrompter( + overrides: Partial, + options?: { defaultSelect?: string }, +): WizardPrompter { + return { + intro: vi.fn(noopAsync), + outro: vi.fn(noopAsync), + note: vi.fn(noopAsync), + select: vi.fn(async () => (options?.defaultSelect ?? "") as never), + multiselect: vi.fn(async () => []), + text: vi.fn(async () => "") as unknown as WizardPrompter["text"], + confirm: vi.fn(async () => false), + progress: vi.fn(() => ({ update: noop, stop: noop })), + ...overrides, + }; +} + +export async function setupAuthTestEnv( + prefix = "openclaw-auth-", + options?: { agentSubdir?: string }, +): Promise<{ + stateDir: string; + agentDir: string; +}> { + const stateDir = await makeTempWorkspace(prefix); + const agentDir = path.join(stateDir, options?.agentSubdir ?? "agent"); + process.env.OPENCLAW_STATE_DIR = stateDir; + process.env.OPENCLAW_AGENT_DIR = agentDir; + process.env.PI_CODING_AGENT_DIR = agentDir; + await fs.mkdir(agentDir, { recursive: true }); + return { stateDir, agentDir }; +} + +export type AuthTestLifecycle = { + setStateDir: (stateDir: string) => void; + cleanup: () => Promise; +}; + +export function createAuthTestLifecycle(envKeys: string[]): AuthTestLifecycle { + const envSnapshot = captureEnv(envKeys); + let stateDir: string | null = null; + return { + setStateDir(nextStateDir: string) { + stateDir = nextStateDir; + }, + async cleanup() { + if (stateDir) { + await fs.rm(stateDir, { recursive: true, force: true }); + stateDir = null; + } + envSnapshot.restore(); + }, + }; +} + +export function requireOpenClawAgentDir(): string { + const agentDir = process.env.OPENCLAW_AGENT_DIR; + if (!agentDir) { + throw new Error("OPENCLAW_AGENT_DIR not set"); + } + return agentDir; +} + +export function authProfilePathForAgent(agentDir: string): string { + return path.join(agentDir, "auth-profiles.json"); +} + +export async function readAuthProfilesForAgent(agentDir: string): Promise { + const raw = await fs.readFile(authProfilePathForAgent(agentDir), "utf8"); + return JSON.parse(raw) as T; +} From ac4aead8a73f18125a38b890fdd9d82d52fe7140 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:39:28 -0700 Subject: [PATCH 057/187] Tests: order Telegram native command mocks before import From 61ccc5bedec974b77d3307baed10cb5b4b256354 Mon Sep 17 00:00:00 2001 From: Josh Lehman Date: Mon, 16 Mar 2026 22:43:21 -0700 Subject: [PATCH 058/187] chore: fix formatting drift in extension sources (#48758) --- extensions/discord/src/account-inspect.ts | 2 +- extensions/discord/src/setup-core.ts | 4 ++-- extensions/google/provider-models.ts | 2 +- extensions/imessage/src/channel.ts | 8 ++++++-- extensions/imessage/src/setup-surface.ts | 2 +- extensions/imessage/src/shared.ts | 16 ++++++++-------- extensions/signal/src/setup-core.ts | 2 +- extensions/signal/src/setup-surface.ts | 4 ++-- extensions/slack/src/setup-core.ts | 2 +- extensions/telegram/src/setup-core.ts | 2 +- extensions/whatsapp/src/setup-surface.ts | 4 ++-- extensions/whatsapp/src/shared.ts | 18 +++++++++--------- src/plugins/contracts/loader.contract.test.ts | 5 +---- 13 files changed, 36 insertions(+), 35 deletions(-) diff --git a/extensions/discord/src/account-inspect.ts b/extensions/discord/src/account-inspect.ts index 3109a0f9bde..c10b9a78811 100644 --- a/extensions/discord/src/account-inspect.ts +++ b/extensions/discord/src/account-inspect.ts @@ -1,8 +1,8 @@ -import type { DiscordAccountConfig } from "../../../src/config/types.js"; import { hasConfiguredSecretInput, normalizeSecretInputString, } from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordAccountConfig } from "../../../src/config/types.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index f9a9d95df4b..9d8952bb053 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -1,5 +1,3 @@ -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { applyAccountNameToChannelSection, @@ -19,6 +17,8 @@ import { type ChannelSetupDmPolicy, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; +import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; diff --git a/extensions/google/provider-models.ts b/extensions/google/provider-models.ts index ddb0446c2b9..546a8b11575 100644 --- a/extensions/google/provider-models.ts +++ b/extensions/google/provider-models.ts @@ -1,8 +1,8 @@ -import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; +import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; const GEMINI_3_1_PRO_PREFIX = "gemini-3.1-pro"; const GEMINI_3_1_FLASH_PREFIX = "gemini-3.1-flash"; diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index 49e8c289fae..4df6e6bf9d3 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -178,7 +178,9 @@ export const imessagePlugin: ChannelPlugin = { chunkerMode: "text", textChunkLimit: 4000, sendText: async ({ cfg, to, text, accountId, deps, replyToId }) => { - const result = await (await loadIMessageChannelRuntime()).sendIMessageOutbound({ + const result = await ( + await loadIMessageChannelRuntime() + ).sendIMessageOutbound({ cfg, to, text, @@ -189,7 +191,9 @@ export const imessagePlugin: ChannelPlugin = { return { channel: "imessage", ...result }; }, sendMedia: async ({ cfg, to, text, mediaUrl, mediaLocalRoots, accountId, deps, replyToId }) => { - const result = await (await loadIMessageChannelRuntime()).sendIMessageOutbound({ + const result = await ( + await loadIMessageChannelRuntime() + ).sendIMessageOutbound({ cfg, to, text, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index b2ccdb3a1d6..c24630dc805 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,6 +1,6 @@ -import { detectBinary } from "../../../src/commands/onboard-helpers.js"; import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { detectBinary } from "../../../src/commands/onboard-helpers.js"; import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { createIMessageCliPathTextInput, diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 446e76ff39a..90e5c2dfe3a 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -2,19 +2,19 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/compat"; +import { + deleteAccountFromConfigSection, + setAccountEnabledInConfigSection, +} from "../../../src/channels/plugins/config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { formatTrimmedAllowFromEntries, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, } from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { - deleteAccountFromConfigSection, - setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { listIMessageAccountIds, diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 55d41ce458d..3952a55f861 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,4 +1,3 @@ -import { formatCliCommand } from "../../../src/cli/command-format.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, @@ -18,6 +17,7 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 695e2c5cc8b..c8329d5ba52 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,7 +1,7 @@ -import { detectBinary } from "../../../src/commands/onboard-helpers.js"; -import { installSignalCli } from "../../../src/commands/signal-install.js"; import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { detectBinary } from "../../../src/commands/onboard-helpers.js"; +import { installSignalCli } from "../../../src/commands/signal-install.js"; import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; import { createSignalCliPathTextInput, diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 3da152d2f37..8a8f48a4bdb 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -19,9 +19,9 @@ import { type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 896b3b98f04..f2b5fc04d77 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,4 +1,3 @@ -import { formatCliCommand } from "../../../src/cli/command-format.js"; import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, @@ -11,6 +10,7 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index be314af285d..faafe856de1 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -1,6 +1,4 @@ import path from "node:path"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import type { DmPolicy } from "../../../src/config/types.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, @@ -12,6 +10,8 @@ import { type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import type { DmPolicy } from "../../../src/config/types.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 2cdfbd3cf8e..6819f70866c 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -3,20 +3,20 @@ import { collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, } from "openclaw/plugin-sdk/compat"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupToolPolicy, +} from "../../../src/channels/plugins/group-mentions.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; import { formatWhatsAppConfigAllowFromEntries, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, } from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, -} from "../../../src/channels/plugins/group-mentions.js"; -import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { normalizeE164 } from "../../../src/utils.js"; import { diff --git a/src/plugins/contracts/loader.contract.test.ts b/src/plugins/contracts/loader.contract.test.ts index aa7cf2ed1bc..cdac689af52 100644 --- a/src/plugins/contracts/loader.contract.test.ts +++ b/src/plugins/contracts/loader.contract.test.ts @@ -2,10 +2,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { withBundledPluginAllowlistCompat } from "../bundled-compat.js"; import { __testing as providerTesting } from "../providers.js"; import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; -import { - providerContractPluginIds, - webSearchProviderContractRegistry, -} from "./registry.js"; +import { providerContractPluginIds, webSearchProviderContractRegistry } from "./registry.js"; function uniqueSortedPluginIds(values: string[]) { return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); From 64c69c3fc963ea9e59b4387b105353ae72a4b8bd Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:45:44 -0700 Subject: [PATCH 059/187] Tests: dedupe contract helper plumbing (#48760) * Plugins: share contract test helpers * Channels: collapse inbound contract testkit --- .../message-handler.inbound-context.test.ts | 2 +- .../event-handler.mention-gating.test.ts | 2 +- .../contracts/dispatch-inbound-capture.ts | 18 --------- .../contracts/inbound-contract-capture.ts | 20 ---------- .../inbound-contract-dispatch-mock.ts | 9 ----- .../plugins/contracts/inbound-testkit.ts | 39 +++++++++++++++++++ .../contracts/inbound.contract.test.ts | 2 +- .../contracts/auth-choice.contract.test.ts | 21 +--------- src/plugins/contracts/auth.contract.test.ts | 19 +-------- .../contracts/discovery.contract.test.ts | 19 +-------- src/plugins/contracts/loader.contract.test.ts | 31 +++++---------- src/plugins/contracts/registry.ts | 4 ++ src/plugins/contracts/testkit.ts | 26 +++++++++++++ 13 files changed, 85 insertions(+), 127 deletions(-) delete mode 100644 src/channels/plugins/contracts/dispatch-inbound-capture.ts delete mode 100644 src/channels/plugins/contracts/inbound-contract-capture.ts delete mode 100644 src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts create mode 100644 src/channels/plugins/contracts/inbound-testkit.ts create mode 100644 src/plugins/contracts/testkit.ts diff --git a/extensions/discord/src/monitor/message-handler.inbound-context.test.ts b/extensions/discord/src/monitor/message-handler.inbound-context.test.ts index 6eb378e7bbb..29d49887d36 100644 --- a/extensions/discord/src/monitor/message-handler.inbound-context.test.ts +++ b/extensions/discord/src/monitor/message-handler.inbound-context.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { inboundCtxCapture as capture } from "../../../../src/channels/plugins/contracts/inbound-contract-dispatch-mock.js"; +import { inboundCtxCapture as capture } from "../../../../src/channels/plugins/contracts/inbound-testkit.js"; import { expectChannelInboundContextContract as expectInboundContextContract } from "../../../../src/channels/plugins/contracts/suites.js"; import type { DiscordMessagePreflightContext } from "./message-handler.preflight.js"; import { processDiscordMessage } from "./message-handler.process.js"; diff --git a/extensions/signal/src/monitor/event-handler.mention-gating.test.ts b/extensions/signal/src/monitor/event-handler.mention-gating.test.ts index 60222d4a7ab..ffcdb5baba6 100644 --- a/extensions/signal/src/monitor/event-handler.mention-gating.test.ts +++ b/extensions/signal/src/monitor/event-handler.mention-gating.test.ts @@ -1,6 +1,6 @@ import { describe, expect, it, vi } from "vitest"; import type { MsgContext } from "../../../../src/auto-reply/templating.js"; -import { buildDispatchInboundCaptureMock } from "../../../../src/channels/plugins/contracts/dispatch-inbound-capture.js"; +import { buildDispatchInboundCaptureMock } from "../../../../src/channels/plugins/contracts/inbound-testkit.js"; import type { OpenClawConfig } from "../../../../src/config/types.js"; import { createBaseSignalEventHandlerDeps, diff --git a/src/channels/plugins/contracts/dispatch-inbound-capture.ts b/src/channels/plugins/contracts/dispatch-inbound-capture.ts deleted file mode 100644 index cd7b0bd5fdb..00000000000 --- a/src/channels/plugins/contracts/dispatch-inbound-capture.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { vi } from "vitest"; - -export function buildDispatchInboundCaptureMock>( - actual: T, - setCtx: (ctx: unknown) => void, -) { - const dispatchInboundMessage = vi.fn(async (params: { ctx: unknown }) => { - setCtx(params.ctx); - return { queuedFinal: false, counts: { tool: 0, block: 0, final: 0 } }; - }); - - return { - ...actual, - dispatchInboundMessage, - dispatchInboundMessageWithDispatcher: dispatchInboundMessage, - dispatchInboundMessageWithBufferedDispatcher: dispatchInboundMessage, - }; -} diff --git a/src/channels/plugins/contracts/inbound-contract-capture.ts b/src/channels/plugins/contracts/inbound-contract-capture.ts deleted file mode 100644 index b74164c7a79..00000000000 --- a/src/channels/plugins/contracts/inbound-contract-capture.ts +++ /dev/null @@ -1,20 +0,0 @@ -import type { MsgContext } from "../../../auto-reply/templating.js"; -import { buildDispatchInboundCaptureMock } from "./dispatch-inbound-capture.js"; - -export type InboundContextCapture = { - ctx: MsgContext | undefined; -}; - -export function createInboundContextCapture(): InboundContextCapture { - return { ctx: undefined }; -} - -export async function buildDispatchInboundContextCapture( - importOriginal: >() => Promise, - capture: InboundContextCapture, -) { - const actual = await importOriginal(); - return buildDispatchInboundCaptureMock(actual, (ctx) => { - capture.ctx = ctx as MsgContext; - }); -} diff --git a/src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts b/src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts deleted file mode 100644 index 05698d628c5..00000000000 --- a/src/channels/plugins/contracts/inbound-contract-dispatch-mock.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { vi } from "vitest"; -import { createInboundContextCapture } from "./inbound-contract-capture.js"; -import { buildDispatchInboundContextCapture } from "./inbound-contract-capture.js"; - -export const inboundCtxCapture = createInboundContextCapture(); - -vi.mock("../../../auto-reply/dispatch.js", async (importOriginal) => { - return await buildDispatchInboundContextCapture(importOriginal, inboundCtxCapture); -}); diff --git a/src/channels/plugins/contracts/inbound-testkit.ts b/src/channels/plugins/contracts/inbound-testkit.ts new file mode 100644 index 00000000000..b3241572f56 --- /dev/null +++ b/src/channels/plugins/contracts/inbound-testkit.ts @@ -0,0 +1,39 @@ +import { vi } from "vitest"; +import type { MsgContext } from "../../../auto-reply/templating.js"; + +export type InboundContextCapture = { + ctx: MsgContext | undefined; +}; + +export function createInboundContextCapture(): InboundContextCapture { + return { ctx: undefined }; +} + +export function buildDispatchInboundCaptureMock>( + actual: T, + setCtx: (ctx: unknown) => void, +) { + const dispatchInboundMessage = vi.fn(async (params: { ctx: unknown }) => { + setCtx(params.ctx); + return { queuedFinal: false, counts: { tool: 0, block: 0, final: 0 } }; + }); + + return { + ...actual, + dispatchInboundMessage, + dispatchInboundMessageWithDispatcher: dispatchInboundMessage, + dispatchInboundMessageWithBufferedDispatcher: dispatchInboundMessage, + }; +} + +export async function buildDispatchInboundContextCapture( + importOriginal: >() => Promise, + capture: InboundContextCapture, +) { + const actual = await importOriginal(); + return buildDispatchInboundCaptureMock(actual, (ctx) => { + capture.ctx = ctx as MsgContext; + }); +} + +export const inboundCtxCapture = createInboundContextCapture(); diff --git a/src/channels/plugins/contracts/inbound.contract.test.ts b/src/channels/plugins/contracts/inbound.contract.test.ts index e90e5090e6b..eadb1913544 100644 --- a/src/channels/plugins/contracts/inbound.contract.test.ts +++ b/src/channels/plugins/contracts/inbound.contract.test.ts @@ -8,7 +8,7 @@ import { createInboundSlackTestContext } from "../../../../extensions/slack/src/ import type { SlackMessageEvent } from "../../../../extensions/slack/src/types.js"; import type { MsgContext } from "../../../auto-reply/templating.js"; import type { OpenClawConfig } from "../../../config/config.js"; -import { inboundCtxCapture } from "./inbound-contract-dispatch-mock.js"; +import { inboundCtxCapture } from "./inbound-testkit.js"; import { expectChannelInboundContextContract } from "./suites.js"; const signalCapture = vi.hoisted(() => ({ ctx: undefined as MsgContext | undefined })); diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index 7f3f6535e54..fc301051065 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -6,13 +6,12 @@ import { readAuthProfilesForAgent, requireOpenClawAgentDir, setupAuthTestEnv, -} from "../../../test/helpers/auth-wizard.js"; +} from "../../commands/test-wizard-helpers.js"; import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; -import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; -import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; +import { registerProviders, requireProvider } from "./testkit.js"; type ResolvePluginProviders = typeof import("../../plugins/provider-auth-choice.runtime.js").resolvePluginProviders; @@ -67,22 +66,6 @@ type StoredAuthProfile = { const qwenPortalPlugin = (await import("../../../extensions/qwen-portal-auth/index.js")).default; -function registerProviders(...plugins: Array<{ register(api: OpenClawPluginApi): void }>) { - const captured = createCapturedPluginRegistration(); - for (const plugin of plugins) { - plugin.register(captured.api); - } - return captured.providers; -} - -function requireProvider(providers: ProviderPlugin[], providerId: string) { - const provider = providers.find((entry) => entry.id === providerId); - if (!provider) { - throw new Error(`provider ${providerId} missing`); - } - return provider; -} - describe("provider auth-choice contract", () => { const lifecycle = createAuthTestLifecycle([ "OPENCLAW_STATE_DIR", diff --git a/src/plugins/contracts/auth.contract.test.ts b/src/plugins/contracts/auth.contract.test.ts index 1b8c809f9df..4842bef5e76 100644 --- a/src/plugins/contracts/auth.contract.test.ts +++ b/src/plugins/contracts/auth.contract.test.ts @@ -4,14 +4,13 @@ import { replaceRuntimeAuthProfileStoreSnapshots, } from "../../agents/auth-profiles/store.js"; import { createNonExitingRuntime } from "../../runtime.js"; -import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; import type { WizardMultiSelectParams, WizardPrompter, WizardProgress, WizardSelectParams, } from "../../wizard/prompts.js"; -import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; +import { registerProviders, requireProvider } from "./testkit.js"; type LoginOpenAICodexOAuth = (typeof import("../../plugins/provider-openai-codex-oauth.js"))["loginOpenAICodexOAuth"]; @@ -78,22 +77,6 @@ function buildAuthContext() { }; } -function registerProviders(...plugins: Array<{ register(api: OpenClawPluginApi): void }>) { - const captured = createCapturedPluginRegistration(); - for (const plugin of plugins) { - plugin.register(captured.api); - } - return captured.providers; -} - -function requireProvider(providers: ProviderPlugin[], providerId: string) { - const provider = providers.find((entry) => entry.id === providerId); - if (!provider) { - throw new Error(`provider ${providerId} missing`); - } - return provider; -} - describe("provider auth contract", () => { afterEach(() => { loginOpenAICodexOAuthMock.mockReset(); diff --git a/src/plugins/contracts/discovery.contract.test.ts b/src/plugins/contracts/discovery.contract.test.ts index 072e657616e..0a334a619a1 100644 --- a/src/plugins/contracts/discovery.contract.test.ts +++ b/src/plugins/contracts/discovery.contract.test.ts @@ -5,9 +5,8 @@ import { } from "../../agents/auth-profiles/store.js"; import { QWEN_OAUTH_MARKER } from "../../agents/model-auth-markers.js"; import type { ModelDefinitionConfig } from "../../config/types.models.js"; -import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; import { runProviderCatalog } from "../provider-discovery.js"; -import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; +import { registerProviders, requireProvider } from "./testkit.js"; const resolveCopilotApiTokenMock = vi.hoisted(() => vi.fn()); const buildOllamaProviderMock = vi.hoisted(() => vi.fn()); @@ -60,22 +59,6 @@ const cloudflareAiGatewayPlugin = ( await import("../../../extensions/cloudflare-ai-gateway/index.js") ).default; -function registerProviders(...plugins: Array<{ register(api: OpenClawPluginApi): void }>) { - const captured = createCapturedPluginRegistration(); - for (const plugin of plugins) { - plugin.register(captured.api); - } - return captured.providers; -} - -function requireProvider(providers: ProviderPlugin[], providerId: string) { - const provider = providers.find((entry) => entry.id === providerId); - if (!provider) { - throw new Error(`provider ${providerId} missing`); - } - return provider; -} - function createModelConfig(id: string, name = id): ModelDefinitionConfig { return { id, diff --git a/src/plugins/contracts/loader.contract.test.ts b/src/plugins/contracts/loader.contract.test.ts index cdac689af52..dde3ef19c19 100644 --- a/src/plugins/contracts/loader.contract.test.ts +++ b/src/plugins/contracts/loader.contract.test.ts @@ -2,15 +2,8 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { withBundledPluginAllowlistCompat } from "../bundled-compat.js"; import { __testing as providerTesting } from "../providers.js"; import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; -import { providerContractPluginIds, webSearchProviderContractRegistry } from "./registry.js"; - -function uniqueSortedPluginIds(values: string[]) { - return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); -} - -function normalizeProviderContractPluginId(pluginId: string) { - return pluginId === "kimi-coding" ? "kimi" : pluginId; -} +import { providerContractCompatPluginIds, webSearchProviderContractRegistry } from "./registry.js"; +import { uniqueSortedStrings } from "./testkit.js"; describe("plugin loader contract", () => { beforeEach(() => { @@ -18,9 +11,7 @@ describe("plugin loader contract", () => { }); it("keeps bundled provider compatibility wired to the provider registry", () => { - const providerPluginIds = uniqueSortedPluginIds( - providerContractPluginIds.map(normalizeProviderContractPluginId), - ); + const providerPluginIds = uniqueSortedStrings(providerContractCompatPluginIds); const compatPluginIds = providerTesting.resolveBundledProviderCompatPluginIds({ config: { plugins: { @@ -38,16 +29,12 @@ describe("plugin loader contract", () => { pluginIds: compatPluginIds, }); - expect(uniqueSortedPluginIds(compatPluginIds)).toEqual( - expect.arrayContaining(providerPluginIds), - ); + expect(uniqueSortedStrings(compatPluginIds)).toEqual(expect.arrayContaining(providerPluginIds)); expect(compatConfig?.plugins?.allow).toEqual(expect.arrayContaining(providerPluginIds)); }); it("keeps vitest bundled provider enablement wired to the provider registry", () => { - const providerPluginIds = uniqueSortedPluginIds( - providerContractPluginIds.map(normalizeProviderContractPluginId), - ); + const providerPluginIds = uniqueSortedStrings(providerContractCompatPluginIds); const compatConfig = providerTesting.withBundledProviderVitestCompat({ config: undefined, pluginIds: providerPluginIds, @@ -61,19 +48,19 @@ describe("plugin loader contract", () => { }); it("keeps bundled web search loading scoped to the web search registry", () => { - const webSearchPluginIds = uniqueSortedPluginIds( + const webSearchPluginIds = uniqueSortedStrings( webSearchProviderContractRegistry.map((entry) => entry.pluginId), ); const providers = resolvePluginWebSearchProviders({}); - expect(uniqueSortedPluginIds(providers.map((provider) => provider.pluginId))).toEqual( + expect(uniqueSortedStrings(providers.map((provider) => provider.pluginId))).toEqual( webSearchPluginIds, ); }); it("keeps bundled web search allowlist compatibility wired to the web search registry", () => { - const webSearchPluginIds = uniqueSortedPluginIds( + const webSearchPluginIds = uniqueSortedStrings( webSearchProviderContractRegistry.map((entry) => entry.pluginId), ); @@ -86,7 +73,7 @@ describe("plugin loader contract", () => { }, }); - expect(uniqueSortedPluginIds(providers.map((provider) => provider.pluginId))).toEqual( + expect(uniqueSortedStrings(providers.map((provider) => provider.pluginId))).toEqual( webSearchPluginIds, ); }); diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index 8247b8b273d..8ab7422c1e2 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -160,6 +160,10 @@ export const providerContractPluginIds = [ ...new Set(providerContractRegistry.map((entry) => entry.pluginId)), ].toSorted((left, right) => left.localeCompare(right)); +export const providerContractCompatPluginIds = providerContractPluginIds.map((pluginId) => + pluginId === "kimi-coding" ? "kimi" : pluginId, +); + export function requireProviderContractProvider(providerId: string): ProviderPlugin { const provider = uniqueProviderContractProviders.find((entry) => entry.id === providerId); if (!provider) { diff --git a/src/plugins/contracts/testkit.ts b/src/plugins/contracts/testkit.ts new file mode 100644 index 00000000000..e3f98c70759 --- /dev/null +++ b/src/plugins/contracts/testkit.ts @@ -0,0 +1,26 @@ +import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; +import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; + +type RegistrablePlugin = { + register(api: OpenClawPluginApi): void; +}; + +export function registerProviders(...plugins: RegistrablePlugin[]) { + const captured = createCapturedPluginRegistration(); + for (const plugin of plugins) { + plugin.register(captured.api); + } + return captured.providers; +} + +export function requireProvider(providers: ProviderPlugin[], providerId: string) { + const provider = providers.find((entry) => entry.id === providerId); + if (!provider) { + throw new Error(`provider ${providerId} missing`); + } + return provider; +} + +export function uniqueSortedStrings(values: readonly string[]) { + return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); +} From 357ce71988ff1b0c4a16d95da9847bbde9b37160 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:50:40 -0700 Subject: [PATCH 060/187] Tests: share provider registration helpers (#48767) --- src/commands/auth-choice.test.ts | 10 +++------- src/plugins/contracts/testkit.ts | 26 ++++---------------------- src/test-utils/plugin-registration.ts | 20 ++++++++++++++++++++ 3 files changed, 27 insertions(+), 29 deletions(-) diff --git a/src/commands/auth-choice.test.ts b/src/commands/auth-choice.test.ts index a394bf00528..7b16ad47341 100644 --- a/src/commands/auth-choice.test.ts +++ b/src/commands/auth-choice.test.ts @@ -32,7 +32,7 @@ import { ZAI_CODING_GLOBAL_BASE_URL, } from "../plugins/provider-model-definitions.js"; import type { ProviderPlugin } from "../plugins/types.js"; -import { createCapturedPluginRegistration } from "../test-utils/plugin-registration.js"; +import { registerProviderPlugins } from "../test-utils/plugin-registration.js"; import type { WizardPrompter } from "../wizard/prompts.js"; import { applyAuthChoice, resolvePreferredProviderForAuthChoice } from "./auth-choice.js"; import { GOOGLE_GEMINI_DEFAULT_MODEL } from "./google-gemini-model-default.js"; @@ -82,8 +82,7 @@ type StoredAuthProfile = { }; function createDefaultProviderPlugins() { - const captured = createCapturedPluginRegistration(); - for (const plugin of [ + return registerProviderPlugins( anthropicPlugin, cloudflareAiGatewayPlugin, googlePlugin, @@ -106,10 +105,7 @@ function createDefaultProviderPlugins() { xaiPlugin, xiaomiPlugin, zaiPlugin, - ]) { - plugin.register(captured.api); - } - return captured.providers; + ); } describe("applyAuthChoice", () => { diff --git a/src/plugins/contracts/testkit.ts b/src/plugins/contracts/testkit.ts index e3f98c70759..32f36c502b9 100644 --- a/src/plugins/contracts/testkit.ts +++ b/src/plugins/contracts/testkit.ts @@ -1,25 +1,7 @@ -import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; -import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; - -type RegistrablePlugin = { - register(api: OpenClawPluginApi): void; -}; - -export function registerProviders(...plugins: RegistrablePlugin[]) { - const captured = createCapturedPluginRegistration(); - for (const plugin of plugins) { - plugin.register(captured.api); - } - return captured.providers; -} - -export function requireProvider(providers: ProviderPlugin[], providerId: string) { - const provider = providers.find((entry) => entry.id === providerId); - if (!provider) { - throw new Error(`provider ${providerId} missing`); - } - return provider; -} +export { + registerProviderPlugins as registerProviders, + requireRegisteredProvider as requireProvider, +} from "../../test-utils/plugin-registration.js"; export function uniqueSortedStrings(values: readonly string[]) { return [...new Set(values)].toSorted((left, right) => left.localeCompare(right)); diff --git a/src/test-utils/plugin-registration.ts b/src/test-utils/plugin-registration.ts index 5251f82c051..e773e6848df 100644 --- a/src/test-utils/plugin-registration.ts +++ b/src/test-utils/plugin-registration.ts @@ -3,6 +3,10 @@ import type { OpenClawPluginApi, ProviderPlugin } from "../plugins/types.js"; export { createCapturedPluginRegistration }; +type RegistrablePlugin = { + register(api: OpenClawPluginApi): void; +}; + export function registerSingleProviderPlugin(params: { register(api: OpenClawPluginApi): void; }): ProviderPlugin { @@ -14,3 +18,19 @@ export function registerSingleProviderPlugin(params: { } return provider; } + +export function registerProviderPlugins(...plugins: RegistrablePlugin[]): ProviderPlugin[] { + const captured = createCapturedPluginRegistration(); + for (const plugin of plugins) { + plugin.register(captured.api); + } + return captured.providers; +} + +export function requireRegisteredProvider(providers: ProviderPlugin[], providerId: string) { + const provider = providers.find((entry) => entry.id === providerId); + if (!provider) { + throw new Error(`provider ${providerId} missing`); + } + return provider; +} From f2bd76cd1a4b463799a452e24f470a0db87a44b2 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:32:25 -0700 Subject: [PATCH 061/187] refactor: finalize plugin sdk legacy boundary cleanup --- docs/tools/plugin.md | 16 +- extensions/bluebubbles/src/channel.ts | 8 +- extensions/bluebubbles/src/config-schema.ts | 2 +- extensions/bluebubbles/src/runtime.ts | 2 +- extensions/discord/src/channel.ts | 10 +- .../src/monitor/preflight-audio.runtime.ts | 1 + .../discord/src/monitor/preflight-audio.ts | 2 +- extensions/discord/src/shared.ts | 16 +- extensions/feishu/src/channel.ts | 8 +- extensions/feishu/src/directory.static.ts | 2 +- extensions/feishu/src/runtime.ts | 2 +- extensions/google/gemini-cli-provider.ts | 2 +- extensions/googlechat/src/channel.ts | 12 +- extensions/googlechat/src/runtime.ts | 2 +- extensions/imessage/src/channel.ts | 4 +- extensions/imessage/src/shared.ts | 2 +- extensions/irc/src/accounts.ts | 2 +- extensions/irc/src/channel.ts | 6 +- extensions/irc/src/runtime.ts | 2 +- extensions/line/src/channel.ts | 4 +- extensions/line/src/runtime.ts | 2 +- extensions/matrix/src/channel.ts | 8 +- extensions/matrix/src/config-schema.ts | 2 +- extensions/matrix/src/resolve-targets.ts | 2 +- extensions/matrix/src/runtime.ts | 2 +- extensions/mattermost/src/channel.ts | 6 +- extensions/mattermost/src/group-mentions.ts | 2 +- extensions/mattermost/src/runtime.ts | 2 +- extensions/msteams/src/channel.ts | 6 +- extensions/msteams/src/resolve-allowlist.ts | 2 +- extensions/msteams/src/runtime.ts | 2 +- extensions/nextcloud-talk/src/accounts.ts | 2 +- extensions/nextcloud-talk/src/channel.ts | 8 +- extensions/nextcloud-talk/src/runtime.ts | 2 +- extensions/nostr/src/config-schema.ts | 2 +- extensions/nostr/src/runtime.ts | 2 +- extensions/openai/openai-codex-provider.ts | 2 +- extensions/shared/passive-monitor.ts | 2 +- extensions/shared/runtime.ts | 2 +- extensions/signal/src/channel.ts | 2 +- extensions/signal/src/shared.ts | 4 +- extensions/slack/src/channel.ts | 2 +- extensions/synology-chat/src/runtime.ts | 2 +- .../telegram/src/bot-message-context.body.ts | 2 +- extensions/telegram/src/channel.ts | 6 +- .../src/media-understanding.runtime.ts | 1 + extensions/telegram/src/shared.ts | 20 +- extensions/telegram/src/sticker-cache.ts | 4 +- extensions/tlon/src/runtime.ts | 2 +- extensions/twitch/src/runtime.ts | 2 +- extensions/whatsapp/src/channel.ts | 29 +- extensions/whatsapp/src/shared.ts | 24 +- extensions/zalo/src/channel.runtime.ts | 2 +- extensions/zalo/src/channel.ts | 4 +- extensions/zalo/src/config-schema.ts | 2 +- extensions/zalo/src/runtime.ts | 2 +- extensions/zalo/src/token.ts | 2 +- extensions/zalouser/src/channel.ts | 8 +- extensions/zalouser/src/config-schema.ts | 2 +- extensions/zalouser/src/monitor.ts | 8 +- extensions/zalouser/src/runtime.ts | 2 +- package.json | 20 + ...-no-monolithic-plugin-sdk-entry-imports.ts | 24 +- scripts/lib/plugin-sdk-entrypoints.json | 5 + .../models-config.providers.moonshot.test.ts | 2 +- .../reply/elevated-allowlist-matcher.ts | 4 +- src/channels/registry.ts | 21 +- src/cli/deps.test.ts | 12 +- src/cli/deps.ts | 12 +- src/cli/send-runtime/discord.ts | 1 + src/cli/send-runtime/imessage.ts | 1 + src/cli/send-runtime/signal.ts | 1 + src/cli/send-runtime/slack.ts | 1 + src/cli/send-runtime/telegram.ts | 1 + src/cli/send-runtime/whatsapp.ts | 1 + src/commands/auth-choice.test.ts | 2 +- .../onboard-auth.config-core.kilocode.test.ts | 2 +- src/commands/onboard-auth.test.ts | 10 +- ...oard-non-interactive.provider-auth.test.ts | 2 +- src/plugin-sdk-internal/accounts.ts | 12 - src/plugin-sdk-internal/channel-config.ts | 17 - src/plugin-sdk-internal/core.ts | 14 - src/plugin-sdk-internal/discord.ts | 115 --- src/plugin-sdk-internal/imessage.ts | 46 - src/plugin-sdk-internal/setup.ts | 38 - src/plugin-sdk-internal/signal.ts | 39 - src/plugin-sdk-internal/slack.ts | 67 -- src/plugin-sdk-internal/telegram.ts | 120 --- src/plugin-sdk-internal/whatsapp.ts | 108 --- src/plugin-sdk/channel-config-schema.ts | 7 + src/plugin-sdk/channel-policy.ts | 19 + src/plugin-sdk/channel-runtime.ts | 1 + src/plugin-sdk/compat.ts | 29 +- src/plugin-sdk/core.ts | 37 +- src/plugin-sdk/directory-runtime.ts | 9 + src/plugin-sdk/index.test.ts | 61 +- src/plugin-sdk/index.ts | 798 +----------------- src/plugin-sdk/provider-auth.ts | 1 + src/plugin-sdk/provider-models.ts | 72 +- src/plugin-sdk/reply-history.ts | 14 + src/plugin-sdk/root-alias.cjs | 4 +- src/plugin-sdk/subpaths.test.ts | 20 +- 102 files changed, 418 insertions(+), 1647 deletions(-) create mode 100644 extensions/discord/src/monitor/preflight-audio.runtime.ts create mode 100644 extensions/telegram/src/media-understanding.runtime.ts create mode 100644 src/cli/send-runtime/discord.ts create mode 100644 src/cli/send-runtime/imessage.ts create mode 100644 src/cli/send-runtime/signal.ts create mode 100644 src/cli/send-runtime/slack.ts create mode 100644 src/cli/send-runtime/telegram.ts create mode 100644 src/cli/send-runtime/whatsapp.ts delete mode 100644 src/plugin-sdk-internal/accounts.ts delete mode 100644 src/plugin-sdk-internal/channel-config.ts delete mode 100644 src/plugin-sdk-internal/core.ts delete mode 100644 src/plugin-sdk-internal/discord.ts delete mode 100644 src/plugin-sdk-internal/imessage.ts delete mode 100644 src/plugin-sdk-internal/setup.ts delete mode 100644 src/plugin-sdk-internal/signal.ts delete mode 100644 src/plugin-sdk-internal/slack.ts delete mode 100644 src/plugin-sdk-internal/telegram.ts delete mode 100644 src/plugin-sdk-internal/whatsapp.ts create mode 100644 src/plugin-sdk/channel-config-schema.ts create mode 100644 src/plugin-sdk/channel-policy.ts create mode 100644 src/plugin-sdk/directory-runtime.ts create mode 100644 src/plugin-sdk/reply-history.ts diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index da07776d8ce..db074c011d9 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -920,8 +920,16 @@ Notes: Use SDK subpaths instead of the monolithic `openclaw/plugin-sdk` import when authoring plugins: -- `openclaw/plugin-sdk/core` for generic plugin APIs, provider auth types, and shared helpers such as routing/session utilities and logger-backed runtimes. -- `openclaw/plugin-sdk/compat` for bundled/internal plugin code that needs broader shared runtime helpers than `core`. +- `openclaw/plugin-sdk/core` for the smallest generic plugin-facing contract. +- Domain subpaths such as `openclaw/plugin-sdk/channel-config-helpers`, + `openclaw/plugin-sdk/channel-config-schema`, + `openclaw/plugin-sdk/channel-policy`, + `openclaw/plugin-sdk/reply-history`, + `openclaw/plugin-sdk/routing`, + `openclaw/plugin-sdk/runtime-store`, and + `openclaw/plugin-sdk/directory-runtime` for shared runtime/config helpers. +- `openclaw/plugin-sdk/compat` remains as a legacy migration surface for older + external plugins. Bundled plugins should not use it. - `openclaw/plugin-sdk/telegram` for Telegram channel plugin types and shared channel-facing helpers. Built-in Telegram implementation internals stay private to the bundled extension. - `openclaw/plugin-sdk/discord` for Discord channel plugin types and shared channel-facing helpers. Built-in Discord implementation internals stay private to the bundled extension. - `openclaw/plugin-sdk/slack` for Slack channel plugin types and shared channel-facing helpers. Built-in Slack implementation internals stay private to the bundled extension. @@ -982,8 +990,8 @@ Compatibility note: - `openclaw/plugin-sdk` remains supported for existing external plugins. - New and migrated bundled plugins should use channel or extension-specific - subpaths; use `core` for generic surfaces and `compat` only when broader - shared helpers are required. + subpaths; use `core` plus explicit domain subpaths for generic surfaces, and + treat `compat` as migration-only. ## Read-only channel inspection diff --git a/extensions/bluebubbles/src/channel.ts b/extensions/bluebubbles/src/channel.ts index 2fe2fc3f3fb..9550c1166ed 100644 --- a/extensions/bluebubbles/src/channel.ts +++ b/extensions/bluebubbles/src/channel.ts @@ -1,3 +1,4 @@ +import { formatNormalizedAllowFromEntries } from "openclaw/plugin-sdk/allow-from"; import type { ChannelAccountSnapshot, ChannelPlugin } from "openclaw/plugin-sdk/bluebubbles"; import { buildChannelConfigSchema, @@ -11,13 +12,12 @@ import { resolveBlueBubblesGroupToolPolicy, setAccountEnabledInConfigSection, } from "openclaw/plugin-sdk/bluebubbles"; +import { mapAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers"; +import { createAccountStatusSink } from "openclaw/plugin-sdk/channel-lifecycle"; import { buildAccountScopedDmSecurityPolicy, collectOpenGroupPolicyRestrictSendersWarnings, - createAccountStatusSink, - formatNormalizedAllowFromEntries, - mapAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { listBlueBubblesAccountIds, type ResolvedBlueBubblesAccount, diff --git a/extensions/bluebubbles/src/config-schema.ts b/extensions/bluebubbles/src/config-schema.ts index 76fe4523f16..da66869708e 100644 --- a/extensions/bluebubbles/src/config-schema.ts +++ b/extensions/bluebubbles/src/config-schema.ts @@ -4,7 +4,7 @@ import { buildCatchallMultiAccountChannelSchema, DmPolicySchema, GroupPolicySchema, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-schema"; import { z } from "zod"; import { buildSecretInputSchema, hasConfiguredSecretInput } from "./secret-input.js"; diff --git a/extensions/bluebubbles/src/runtime.ts b/extensions/bluebubbles/src/runtime.ts index ee91445d69b..eae7bb24a29 100644 --- a/extensions/bluebubbles/src/runtime.ts +++ b/extensions/bluebubbles/src/runtime.ts @@ -1,5 +1,5 @@ import type { PluginRuntime } from "openclaw/plugin-sdk/bluebubbles"; -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const runtimeStore = createPluginRuntimeStore("BlueBubbles runtime not initialized"); type LegacyRuntimeLogShape = { log?: (message: string) => void }; diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index a9db3a7937f..761ccb5f8b5 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -10,11 +10,6 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; -import { - buildAgentSessionKey, - resolveThreadSessionKeys, - type RoutePeer, -} from "openclaw/plugin-sdk/core"; import { buildComputedAccountStatusSnapshot, buildChannelConfigSchema, @@ -33,6 +28,11 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/discord"; +import { + buildAgentSessionKey, + resolveThreadSessionKeys, + type RoutePeer, +} from "openclaw/plugin-sdk/routing"; import { listDiscordAccountIds, resolveDiscordAccount, diff --git a/extensions/discord/src/monitor/preflight-audio.runtime.ts b/extensions/discord/src/monitor/preflight-audio.runtime.ts new file mode 100644 index 00000000000..5232d2ccb54 --- /dev/null +++ b/extensions/discord/src/monitor/preflight-audio.runtime.ts @@ -0,0 +1 @@ +export { transcribeFirstAudio } from "openclaw/plugin-sdk/media-runtime"; diff --git a/extensions/discord/src/monitor/preflight-audio.ts b/extensions/discord/src/monitor/preflight-audio.ts index f26fe5de9a9..97bbbdd273d 100644 --- a/extensions/discord/src/monitor/preflight-audio.ts +++ b/extensions/discord/src/monitor/preflight-audio.ts @@ -50,7 +50,7 @@ export async function resolveDiscordPreflightAudioMentionContext(params: { }; } try { - const { transcribeFirstAudio } = await import("openclaw/plugin-sdk/media-runtime"); + const { transcribeFirstAudio } = await import("./preflight-audio.runtime.js"); if (params.abortSignal?.aborted) { return { hasAudioAttachment, diff --git a/extensions/discord/src/shared.ts b/extensions/discord/src/shared.ts index 651e6d987f3..03174404bdb 100644 --- a/extensions/discord/src/shared.ts +++ b/extensions/discord/src/shared.ts @@ -1,12 +1,14 @@ -import { createScopedChannelConfigBase } from "openclaw/plugin-sdk/compat"; +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, - formatAllowFromLowercase, -} from "openclaw/plugin-sdk/compat"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { DiscordConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; + createScopedChannelConfigBase, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + buildChannelConfigSchema, + DiscordConfigSchema, + getChatChannelMeta, + type ChannelPlugin, +} from "openclaw/plugin-sdk/discord"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/feishu/src/channel.ts b/extensions/feishu/src/channel.ts index 5d47c55e16b..1964331e7e0 100644 --- a/extensions/feishu/src/channel.ts +++ b/extensions/feishu/src/channel.ts @@ -1,8 +1,6 @@ -import { - collectAllowlistProviderRestrictSendersWarnings, - formatAllowFromLowercase, - mapAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; +import { mapAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers"; +import { collectAllowlistProviderRestrictSendersWarnings } from "openclaw/plugin-sdk/channel-policy"; import type { ChannelMeta, ChannelPlugin, ClawdbotConfig } from "openclaw/plugin-sdk/feishu"; import { buildChannelConfigSchema, diff --git a/extensions/feishu/src/directory.static.ts b/extensions/feishu/src/directory.static.ts index b79e4e94f77..4adefe2ae0f 100644 --- a/extensions/feishu/src/directory.static.ts +++ b/extensions/feishu/src/directory.static.ts @@ -1,7 +1,7 @@ import { listDirectoryGroupEntriesFromMapKeysAndAllowFrom, listDirectoryUserEntriesFromAllowFromAndMapKeys, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/directory-runtime"; import type { ClawdbotConfig } from "openclaw/plugin-sdk/feishu"; import { resolveFeishuAccount } from "./accounts.js"; import { normalizeFeishuTarget } from "./targets.js"; diff --git a/extensions/feishu/src/runtime.ts b/extensions/feishu/src/runtime.ts index 2e174a59320..aad0a41c50a 100644 --- a/extensions/feishu/src/runtime.ts +++ b/extensions/feishu/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/feishu"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setFeishuRuntime, getRuntime: getFeishuRuntime } = createPluginRuntimeStore("Feishu runtime not initialized"); diff --git a/extensions/google/gemini-cli-provider.ts b/extensions/google/gemini-cli-provider.ts index 6db7561a10b..45b00c1be28 100644 --- a/extensions/google/gemini-cli-provider.ts +++ b/extensions/google/gemini-cli-provider.ts @@ -1,9 +1,9 @@ -import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/core"; import type { OpenClawPluginApi, ProviderAuthContext, ProviderFetchUsageSnapshotContext, } from "openclaw/plugin-sdk/core"; +import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/provider-auth"; import { fetchGeminiUsage } from "openclaw/plugin-sdk/provider-usage"; import { loginGeminiCliOAuth } from "./oauth.js"; import { isModernGoogleModel, resolveGoogle31ForwardCompatModel } from "./provider-models.js"; diff --git a/extensions/googlechat/src/channel.ts b/extensions/googlechat/src/channel.ts index bd06b33f8df..faa1b4e4930 100644 --- a/extensions/googlechat/src/channel.ts +++ b/extensions/googlechat/src/channel.ts @@ -1,11 +1,13 @@ -import { createScopedChannelConfigBase } from "openclaw/plugin-sdk/compat"; +import { formatNormalizedAllowFromEntries } from "openclaw/plugin-sdk/allow-from"; +import { + createScopedAccountConfigAccessors, + createScopedChannelConfigBase, + createScopedDmSecurityResolver, +} from "openclaw/plugin-sdk/channel-config-helpers"; import { buildOpenGroupPolicyConfigureRouteAllowlistWarning, collectAllowlistProviderGroupPolicyWarnings, - createScopedAccountConfigAccessors, - createScopedDmSecurityResolver, - formatNormalizedAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { buildComputedAccountStatusSnapshot, buildChannelConfigSchema, diff --git a/extensions/googlechat/src/runtime.ts b/extensions/googlechat/src/runtime.ts index 44731cba8ea..333a8911cbb 100644 --- a/extensions/googlechat/src/runtime.ts +++ b/extensions/googlechat/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/googlechat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setGoogleChatRuntime, getRuntime: getGoogleChatRuntime } = createPluginRuntimeStore("Google Chat runtime not initialized"); diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index 4df6e6bf9d3..f17a9645579 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -3,7 +3,8 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, @@ -14,6 +15,7 @@ import { resolveIMessageGroupToolPolicy, type ChannelPlugin, } from "openclaw/plugin-sdk/imessage"; +import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; import { getIMessageRuntime } from "./runtime.js"; diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 90e5c2dfe3a..1ede2ad412d 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -1,7 +1,7 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { deleteAccountFromConfigSection, setAccountEnabledInConfigSection, diff --git a/extensions/irc/src/accounts.ts b/extensions/irc/src/accounts.ts index 9367a7d2123..f1831b02d48 100644 --- a/extensions/irc/src/accounts.ts +++ b/extensions/irc/src/accounts.ts @@ -1,5 +1,5 @@ import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/account-id"; -import { tryReadSecretFileSync } from "openclaw/plugin-sdk/core"; +import { tryReadSecretFileSync } from "openclaw/plugin-sdk/infra-runtime"; import { createAccountListHelpers, normalizeResolvedSecretInputString, diff --git a/extensions/irc/src/channel.ts b/extensions/irc/src/channel.ts index ca53d53a93d..ed754933e68 100644 --- a/extensions/irc/src/channel.ts +++ b/extensions/irc/src/channel.ts @@ -1,10 +1,10 @@ +import { formatNormalizedAllowFromEntries } from "openclaw/plugin-sdk/allow-from"; +import { createScopedAccountConfigAccessors } from "openclaw/plugin-sdk/channel-config-helpers"; import { buildAccountScopedDmSecurityPolicy, buildOpenGroupPolicyWarning, collectAllowlistProviderGroupPolicyWarnings, - createScopedAccountConfigAccessors, - formatNormalizedAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { buildBaseAccountStatusSnapshot, buildBaseChannelStatusSummary, diff --git a/extensions/irc/src/runtime.ts b/extensions/irc/src/runtime.ts index e1d60a14652..32d479d13e9 100644 --- a/extensions/irc/src/runtime.ts +++ b/extensions/irc/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/irc"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setIrcRuntime, getRuntime: getIrcRuntime } = createPluginRuntimeStore("IRC runtime not initialized"); diff --git a/extensions/line/src/channel.ts b/extensions/line/src/channel.ts index b184ebe8482..ee3c9597eab 100644 --- a/extensions/line/src/channel.ts +++ b/extensions/line/src/channel.ts @@ -1,9 +1,9 @@ import { - collectAllowlistProviderRestrictSendersWarnings, createScopedAccountConfigAccessors, createScopedChannelConfigBase, createScopedDmSecurityResolver, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { collectAllowlistProviderRestrictSendersWarnings } from "openclaw/plugin-sdk/channel-policy"; import { buildChannelConfigSchema, buildComputedAccountStatusSnapshot, diff --git a/extensions/line/src/runtime.ts b/extensions/line/src/runtime.ts index 57307cbe64e..65dd4d5394b 100644 --- a/extensions/line/src/runtime.ts +++ b/extensions/line/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/line"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setLineRuntime, getRuntime: getLineRuntime } = createPluginRuntimeStore("LINE runtime not initialized - plugin not registered"); diff --git a/extensions/matrix/src/channel.ts b/extensions/matrix/src/channel.ts index 6b0380bc19e..d82d3eb2bdb 100644 --- a/extensions/matrix/src/channel.ts +++ b/extensions/matrix/src/channel.ts @@ -1,10 +1,12 @@ import { - buildOpenGroupPolicyWarning, - collectAllowlistProviderGroupPolicyWarnings, createScopedAccountConfigAccessors, createScopedChannelConfigBase, createScopedDmSecurityResolver, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + buildOpenGroupPolicyWarning, + collectAllowlistProviderGroupPolicyWarnings, +} from "openclaw/plugin-sdk/channel-policy"; import { buildChannelConfigSchema, buildProbeChannelStatusSummary, diff --git a/extensions/matrix/src/config-schema.ts b/extensions/matrix/src/config-schema.ts index a95d2fbda96..18d05d69336 100644 --- a/extensions/matrix/src/config-schema.ts +++ b/extensions/matrix/src/config-schema.ts @@ -3,7 +3,7 @@ import { buildNestedDmConfigSchema, DmPolicySchema, GroupPolicySchema, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-schema"; import { MarkdownConfigSchema, ToolPolicySchema } from "openclaw/plugin-sdk/matrix"; import { z } from "zod"; import { buildSecretInputSchema } from "./secret-input.js"; diff --git a/extensions/matrix/src/resolve-targets.ts b/extensions/matrix/src/resolve-targets.ts index 2c179492cb0..79b794e1806 100644 --- a/extensions/matrix/src/resolve-targets.ts +++ b/extensions/matrix/src/resolve-targets.ts @@ -1,4 +1,4 @@ -import { mapAllowlistResolutionInputs } from "openclaw/plugin-sdk/compat"; +import { mapAllowlistResolutionInputs } from "openclaw/plugin-sdk/allowlist-resolution"; import type { ChannelDirectoryEntry, ChannelResolveKind, diff --git a/extensions/matrix/src/runtime.ts b/extensions/matrix/src/runtime.ts index eefce7b910a..f57cd92a017 100644 --- a/extensions/matrix/src/runtime.ts +++ b/extensions/matrix/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/matrix"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setMatrixRuntime, getRuntime: getMatrixRuntime } = createPluginRuntimeStore("Matrix runtime not initialized"); diff --git a/extensions/mattermost/src/channel.ts b/extensions/mattermost/src/channel.ts index 4bf52904b3f..887a878c5e8 100644 --- a/extensions/mattermost/src/channel.ts +++ b/extensions/mattermost/src/channel.ts @@ -1,9 +1,9 @@ +import { formatNormalizedAllowFromEntries } from "openclaw/plugin-sdk/allow-from"; +import { createScopedAccountConfigAccessors } from "openclaw/plugin-sdk/channel-config-helpers"; import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, - createScopedAccountConfigAccessors, - formatNormalizedAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { buildComputedAccountStatusSnapshot, buildChannelConfigSchema, diff --git a/extensions/mattermost/src/group-mentions.ts b/extensions/mattermost/src/group-mentions.ts index 1ab85c15448..153edc2c84c 100644 --- a/extensions/mattermost/src/group-mentions.ts +++ b/extensions/mattermost/src/group-mentions.ts @@ -1,4 +1,4 @@ -import { resolveChannelGroupRequireMention } from "openclaw/plugin-sdk/compat"; +import { resolveChannelGroupRequireMention } from "openclaw/plugin-sdk/channel-policy"; import type { ChannelGroupContext } from "openclaw/plugin-sdk/mattermost"; import { resolveMattermostAccount } from "./mattermost/accounts.js"; diff --git a/extensions/mattermost/src/runtime.ts b/extensions/mattermost/src/runtime.ts index 1f112c8361f..b5ec1942973 100644 --- a/extensions/mattermost/src/runtime.ts +++ b/extensions/mattermost/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/mattermost"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setMattermostRuntime, getRuntime: getMattermostRuntime } = createPluginRuntimeStore("Mattermost runtime not initialized"); diff --git a/extensions/msteams/src/channel.ts b/extensions/msteams/src/channel.ts index c4d3f41054c..d61a377dd4d 100644 --- a/extensions/msteams/src/channel.ts +++ b/extensions/msteams/src/channel.ts @@ -1,7 +1,5 @@ -import { - collectAllowlistProviderRestrictSendersWarnings, - formatAllowFromLowercase, -} from "openclaw/plugin-sdk/compat"; +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; +import { collectAllowlistProviderRestrictSendersWarnings } from "openclaw/plugin-sdk/channel-policy"; import type { ChannelMessageActionName, ChannelPlugin, diff --git a/extensions/msteams/src/resolve-allowlist.ts b/extensions/msteams/src/resolve-allowlist.ts index 374cae2d965..3e28cf8a8cb 100644 --- a/extensions/msteams/src/resolve-allowlist.ts +++ b/extensions/msteams/src/resolve-allowlist.ts @@ -1,4 +1,4 @@ -import { mapAllowlistResolutionInputs } from "openclaw/plugin-sdk/compat"; +import { mapAllowlistResolutionInputs } from "openclaw/plugin-sdk/allowlist-resolution"; import { searchGraphUsers } from "./graph-users.js"; import { listChannelsForTeam, diff --git a/extensions/msteams/src/runtime.ts b/extensions/msteams/src/runtime.ts index f9d1dec5714..016d12e9b29 100644 --- a/extensions/msteams/src/runtime.ts +++ b/extensions/msteams/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/msteams"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setMSTeamsRuntime, getRuntime: getMSTeamsRuntime } = createPluginRuntimeStore("MSTeams runtime not initialized"); diff --git a/extensions/nextcloud-talk/src/accounts.ts b/extensions/nextcloud-talk/src/accounts.ts index 2cfba6fea44..1b9d2c16f93 100644 --- a/extensions/nextcloud-talk/src/accounts.ts +++ b/extensions/nextcloud-talk/src/accounts.ts @@ -1,4 +1,4 @@ -import { tryReadSecretFileSync } from "openclaw/plugin-sdk/core"; +import { tryReadSecretFileSync } from "openclaw/plugin-sdk/infra-runtime"; import { createAccountListHelpers, DEFAULT_ACCOUNT_ID, diff --git a/extensions/nextcloud-talk/src/channel.ts b/extensions/nextcloud-talk/src/channel.ts index 77ca7ed36f9..6101136a5e3 100644 --- a/extensions/nextcloud-talk/src/channel.ts +++ b/extensions/nextcloud-talk/src/channel.ts @@ -1,11 +1,11 @@ +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; +import { mapAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers"; +import { createAccountStatusSink } from "openclaw/plugin-sdk/channel-lifecycle"; import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, - createAccountStatusSink, - formatAllowFromLowercase, - mapAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { buildBaseChannelStatusSummary, buildChannelConfigSchema, diff --git a/extensions/nextcloud-talk/src/runtime.ts b/extensions/nextcloud-talk/src/runtime.ts index 4e539eb3687..facf3a0cc05 100644 --- a/extensions/nextcloud-talk/src/runtime.ts +++ b/extensions/nextcloud-talk/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/nextcloud-talk"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setNextcloudTalkRuntime, getRuntime: getNextcloudTalkRuntime } = createPluginRuntimeStore("Nextcloud Talk runtime not initialized"); diff --git a/extensions/nostr/src/config-schema.ts b/extensions/nostr/src/config-schema.ts index 25d928b4837..53346b0789d 100644 --- a/extensions/nostr/src/config-schema.ts +++ b/extensions/nostr/src/config-schema.ts @@ -1,4 +1,4 @@ -import { AllowFromListSchema, DmPolicySchema } from "openclaw/plugin-sdk/compat"; +import { AllowFromListSchema, DmPolicySchema } from "openclaw/plugin-sdk/channel-config-schema"; import { MarkdownConfigSchema, buildChannelConfigSchema } from "openclaw/plugin-sdk/nostr"; import { z } from "zod"; diff --git a/extensions/nostr/src/runtime.ts b/extensions/nostr/src/runtime.ts index 347079d9750..7c70d903712 100644 --- a/extensions/nostr/src/runtime.ts +++ b/extensions/nostr/src/runtime.ts @@ -1,5 +1,5 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; import type { PluginRuntime } from "openclaw/plugin-sdk/nostr"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; const { setRuntime: setNostrRuntime, getRuntime: getNostrRuntime } = createPluginRuntimeStore("Nostr runtime not initialized"); diff --git a/extensions/openai/openai-codex-provider.ts b/extensions/openai/openai-codex-provider.ts index 6ea59a2e7a7..02407d3879a 100644 --- a/extensions/openai/openai-codex-provider.ts +++ b/extensions/openai/openai-codex-provider.ts @@ -4,7 +4,7 @@ import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/core"; +import { buildOauthProviderAuthResult } from "openclaw/plugin-sdk/provider-auth"; import { CODEX_CLI_PROFILE_ID, ensureAuthProfileStore, diff --git a/extensions/shared/passive-monitor.ts b/extensions/shared/passive-monitor.ts index 0be48afd014..435f934b123 100644 --- a/extensions/shared/passive-monitor.ts +++ b/extensions/shared/passive-monitor.ts @@ -1,4 +1,4 @@ -import { runPassiveAccountLifecycle } from "openclaw/plugin-sdk/core"; +import { runPassiveAccountLifecycle } from "openclaw/plugin-sdk/channel-runtime"; type StoppableMonitor = { stop: () => void; diff --git a/extensions/shared/runtime.ts b/extensions/shared/runtime.ts index 2a75360aa20..a534fc57d4b 100644 --- a/extensions/shared/runtime.ts +++ b/extensions/shared/runtime.ts @@ -1,4 +1,4 @@ -import { createLoggerBackedRuntime } from "openclaw/plugin-sdk/core"; +import { createLoggerBackedRuntime } from "openclaw/plugin-sdk/runtime"; export function resolveLoggerBackedRuntime( runtime: TRuntime | undefined, diff --git a/extensions/signal/src/channel.ts b/extensions/signal/src/channel.ts index bd0085e9dfd..b86f0156a08 100644 --- a/extensions/signal/src/channel.ts +++ b/extensions/signal/src/channel.ts @@ -5,8 +5,8 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; -import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/core"; import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; +import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildBaseAccountStatusSnapshot, buildBaseChannelStatusSummary, diff --git a/extensions/signal/src/shared.ts b/extensions/signal/src/shared.ts index b1c1982f157..60dfd0ed010 100644 --- a/extensions/signal/src/shared.ts +++ b/extensions/signal/src/shared.ts @@ -1,8 +1,8 @@ +import { createScopedAccountConfigAccessors } from "openclaw/plugin-sdk/channel-config-helpers"; import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, - createScopedAccountConfigAccessors, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import { deleteAccountFromConfigSection, setAccountEnabledInConfigSection, diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 66e640e1bcf..a3b537b1f8e 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -12,7 +12,7 @@ import { buildAgentSessionKey, resolveThreadSessionKeys, type RoutePeer, -} from "openclaw/plugin-sdk/core"; +} from "openclaw/plugin-sdk/routing"; import { buildComputedAccountStatusSnapshot, DEFAULT_ACCOUNT_ID, diff --git a/extensions/synology-chat/src/runtime.ts b/extensions/synology-chat/src/runtime.ts index 2f9b401192c..68df66decc7 100644 --- a/extensions/synology-chat/src/runtime.ts +++ b/extensions/synology-chat/src/runtime.ts @@ -1,4 +1,4 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; import type { PluginRuntime } from "openclaw/plugin-sdk/synology-chat"; const { setRuntime: setSynologyRuntime, getRuntime: getSynologyRuntime } = diff --git a/extensions/telegram/src/bot-message-context.body.ts b/extensions/telegram/src/bot-message-context.body.ts index 5b4dc2f9cae..63e6aaa12dd 100644 --- a/extensions/telegram/src/bot-message-context.body.ts +++ b/extensions/telegram/src/bot-message-context.body.ts @@ -179,7 +179,7 @@ export async function resolveTelegramInboundBody(params: { if (needsPreflightTranscription) { try { - const { transcribeFirstAudio } = await import("openclaw/plugin-sdk/media-runtime"); + const { transcribeFirstAudio } = await import("./media-understanding.runtime.js"); const tempCtx: MsgContext = { MediaPaths: allMedia.length > 0 ? allMedia.map((m) => m.path) : undefined, MediaTypes: diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index ebd8ddc2c24..ddc21911800 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -6,13 +6,13 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { type OutboundSendDeps, resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; +import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; +import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; import { buildAgentSessionKey, resolveThreadSessionKeys, type RoutePeer, -} from "openclaw/plugin-sdk/core"; -import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; -import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; +} from "openclaw/plugin-sdk/routing"; import { parseTelegramTopicConversation } from "openclaw/plugin-sdk/telegram"; import { buildTokenChannelStatusSummary, diff --git a/extensions/telegram/src/media-understanding.runtime.ts b/extensions/telegram/src/media-understanding.runtime.ts new file mode 100644 index 00000000000..3d20203caa8 --- /dev/null +++ b/extensions/telegram/src/media-understanding.runtime.ts @@ -0,0 +1 @@ +export { describeImageWithModel, transcribeFirstAudio } from "openclaw/plugin-sdk/media-runtime"; diff --git a/extensions/telegram/src/shared.ts b/extensions/telegram/src/shared.ts index 3dec7b28ef5..644869dbc60 100644 --- a/extensions/telegram/src/shared.ts +++ b/extensions/telegram/src/shared.ts @@ -1,14 +1,16 @@ -import { createScopedChannelConfigBase } from "openclaw/plugin-sdk/compat"; +import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, - formatAllowFromLowercase, -} from "openclaw/plugin-sdk/compat"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { TelegramConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; + createScopedChannelConfigBase, +} from "openclaw/plugin-sdk/channel-config-helpers"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + normalizeAccountId, + TelegramConfigSchema, + type ChannelPlugin, + type OpenClawConfig, +} from "openclaw/plugin-sdk/telegram"; import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, diff --git a/extensions/telegram/src/sticker-cache.ts b/extensions/telegram/src/sticker-cache.ts index 18bfbbf4421..ea86bd8f1bf 100644 --- a/extensions/telegram/src/sticker-cache.ts +++ b/extensions/telegram/src/sticker-cache.ts @@ -143,10 +143,10 @@ export function getCacheStats(): { count: number; oldestAt?: string; newestAt?: const STICKER_DESCRIPTION_PROMPT = "Describe this sticker image in 1-2 sentences. Focus on what the sticker depicts (character, object, action, emotion). Be concise and objective."; -let imageRuntimePromise: Promise | null = null; +let imageRuntimePromise: Promise | null = null; function loadImageRuntime() { - imageRuntimePromise ??= import("openclaw/plugin-sdk/media-runtime"); + imageRuntimePromise ??= import("./media-understanding.runtime.js"); return imageRuntimePromise; } diff --git a/extensions/tlon/src/runtime.ts b/extensions/tlon/src/runtime.ts index 8df35088912..a07eb5cf648 100644 --- a/extensions/tlon/src/runtime.ts +++ b/extensions/tlon/src/runtime.ts @@ -1,4 +1,4 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; import type { PluginRuntime } from "openclaw/plugin-sdk/tlon"; const { setRuntime: setTlonRuntime, getRuntime: getTlonRuntime } = diff --git a/extensions/twitch/src/runtime.ts b/extensions/twitch/src/runtime.ts index 18deeb40c07..2b2806cfdb3 100644 --- a/extensions/twitch/src/runtime.ts +++ b/extensions/twitch/src/runtime.ts @@ -1,4 +1,4 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; import type { PluginRuntime } from "openclaw/plugin-sdk/twitch"; const { setRuntime: setTwitchRuntime, getRuntime: getTwitchRuntime } = diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 3bf9bba0c34..11ac323afec 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -3,6 +3,7 @@ import { createActionGate, createWhatsAppOutboundBase, DEFAULT_ACCOUNT_ID, + formatWhatsAppConfigAllowFromEntries, listWhatsAppDirectoryGroupsFromConfig, listWhatsAppDirectoryPeersFromConfig, readStringParam, @@ -25,6 +26,7 @@ import { WHATSAPP_CHANNEL, } from "./shared.js"; import { collectWhatsAppStatusIssues } from "./status-issues.js"; + function normalizeWhatsAppPayloadText(text: string | undefined): string { return (text ?? "").replace(/^(?:[ \t]*\r?\n)+/, ""); } @@ -165,9 +167,12 @@ export const whatsappPlugin: ChannelPlugin = { auth: { login: async ({ cfg, accountId, runtime, verbose }) => { const resolvedAccountId = accountId?.trim() || whatsappPlugin.config.defaultAccountId(cfg); - await ( - await loadWhatsAppChannelRuntime() - ).loginWeb(Boolean(verbose), undefined, runtime, resolvedAccountId); + await (await loadWhatsAppChannelRuntime()).loginWeb( + Boolean(verbose), + undefined, + runtime, + resolvedAccountId, + ); }, }, heartbeat: { @@ -176,9 +181,9 @@ export const whatsappPlugin: ChannelPlugin = { return { ok: false, reason: "whatsapp-disabled" }; } const account = resolveWhatsAppAccount({ cfg, accountId }); - const authExists = await ( - deps?.webAuthExists ?? (await loadWhatsAppChannelRuntime()).webAuthExists - )(account.authDir); + const authExists = await (deps?.webAuthExists ?? (await loadWhatsAppChannelRuntime()).webAuthExists)( + account.authDir, + ); if (!authExists) { return { ok: false, reason: "whatsapp-not-linked" }; } @@ -214,7 +219,9 @@ export const whatsappPlugin: ChannelPlugin = { ? await (await loadWhatsAppChannelRuntime()).webAuthExists(authDir) : false; const authAgeMs = - linked && authDir ? (await loadWhatsAppChannelRuntime()).getWebAuthAgeMs(authDir) : null; + linked && authDir + ? (await loadWhatsAppChannelRuntime()).getWebAuthAgeMs(authDir) + : null; const self = linked && authDir ? (await loadWhatsAppChannelRuntime()).readWebSelfId(authDir) @@ -281,9 +288,7 @@ export const whatsappPlugin: ChannelPlugin = { ); }, loginWithQrStart: async ({ accountId, force, timeoutMs, verbose }) => - await ( - await loadWhatsAppChannelRuntime() - ).startWebLoginWithQr({ + await (await loadWhatsAppChannelRuntime()).startWebLoginWithQr({ accountId, force, timeoutMs, @@ -292,9 +297,7 @@ export const whatsappPlugin: ChannelPlugin = { loginWithQrWait: async ({ accountId, timeoutMs }) => await (await loadWhatsAppChannelRuntime()).waitForWebLogin({ accountId, timeoutMs }), logoutAccount: async ({ account, runtime }) => { - const cleared = await ( - await loadWhatsAppChannelRuntime() - ).logoutWeb({ + const cleared = await (await loadWhatsAppChannelRuntime()).logoutWeb({ authDir: account.authDir, isLegacyAuthDir: account.isLegacyAuthDir, runtime, diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 6819f70866c..43df9bd7e6a 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -1,24 +1,20 @@ import { buildAccountScopedDmSecurityPolicy, + buildChannelConfigSchema, collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, -} from "openclaw/plugin-sdk/compat"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, -} from "../../../src/channels/plugins/group-mentions.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; -import { + DEFAULT_ACCOUNT_ID, formatWhatsAppConfigAllowFromEntries, + getChatChannelMeta, + normalizeE164, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, -} from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { normalizeE164 } from "../../../src/utils.js"; + resolveWhatsAppGroupIntroHint, + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupToolPolicy, + WhatsAppConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/whatsapp"; import { listWhatsAppAccountIds, resolveDefaultWhatsAppAccountId, diff --git a/extensions/zalo/src/channel.runtime.ts b/extensions/zalo/src/channel.runtime.ts index a376d52b94e..86ddc97dcf3 100644 --- a/extensions/zalo/src/channel.runtime.ts +++ b/extensions/zalo/src/channel.runtime.ts @@ -1,4 +1,4 @@ -import { createAccountStatusSink } from "openclaw/plugin-sdk/compat"; +import { createAccountStatusSink } from "openclaw/plugin-sdk/channel-lifecycle"; import { PAIRING_APPROVED_MESSAGE } from "openclaw/plugin-sdk/zalo"; import { probeZalo } from "./probe.js"; import { resolveZaloProxyFetch } from "./proxy.js"; diff --git a/extensions/zalo/src/channel.ts b/extensions/zalo/src/channel.ts index ed735bbd1c7..16e4560cd14 100644 --- a/extensions/zalo/src/channel.ts +++ b/extensions/zalo/src/channel.ts @@ -1,10 +1,10 @@ +import { mapAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers"; import { buildAccountScopedDmSecurityPolicy, buildOpenGroupPolicyRestrictSendersWarning, buildOpenGroupPolicyWarning, collectOpenProviderGroupPolicyWarnings, - mapAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-policy"; import type { ChannelAccountSnapshot, ChannelPlugin, diff --git a/extensions/zalo/src/config-schema.ts b/extensions/zalo/src/config-schema.ts index 253830eb858..d70e1441d9b 100644 --- a/extensions/zalo/src/config-schema.ts +++ b/extensions/zalo/src/config-schema.ts @@ -3,7 +3,7 @@ import { buildCatchallMultiAccountChannelSchema, DmPolicySchema, GroupPolicySchema, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-schema"; import { MarkdownConfigSchema } from "openclaw/plugin-sdk/zalo"; import { z } from "zod"; import { buildSecretInputSchema } from "./secret-input.js"; diff --git a/extensions/zalo/src/runtime.ts b/extensions/zalo/src/runtime.ts index 10f417b3c7f..f36309db5c5 100644 --- a/extensions/zalo/src/runtime.ts +++ b/extensions/zalo/src/runtime.ts @@ -1,4 +1,4 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; import type { PluginRuntime } from "openclaw/plugin-sdk/zalo"; const { setRuntime: setZaloRuntime, getRuntime: getZaloRuntime } = diff --git a/extensions/zalo/src/token.ts b/extensions/zalo/src/token.ts index 10a4aca6cd1..9e8eec34caa 100644 --- a/extensions/zalo/src/token.ts +++ b/extensions/zalo/src/token.ts @@ -1,5 +1,5 @@ import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/account-id"; -import { tryReadSecretFileSync } from "openclaw/plugin-sdk/core"; +import { tryReadSecretFileSync } from "openclaw/plugin-sdk/infra-runtime"; import type { BaseTokenResolution } from "openclaw/plugin-sdk/zalo"; import { normalizeResolvedSecretInputString, normalizeSecretInputString } from "./secret-input.js"; import type { ZaloConfig } from "./types.js"; diff --git a/extensions/zalouser/src/channel.ts b/extensions/zalouser/src/channel.ts index 7e79b186c3d..1fee83709ef 100644 --- a/extensions/zalouser/src/channel.ts +++ b/extensions/zalouser/src/channel.ts @@ -1,8 +1,6 @@ -import { - buildAccountScopedDmSecurityPolicy, - createAccountStatusSink, - mapAllowFromEntries, -} from "openclaw/plugin-sdk/compat"; +import { mapAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers"; +import { createAccountStatusSink } from "openclaw/plugin-sdk/channel-lifecycle"; +import { buildAccountScopedDmSecurityPolicy } from "openclaw/plugin-sdk/channel-policy"; import type { ChannelAccountSnapshot, ChannelDirectoryEntry, diff --git a/extensions/zalouser/src/config-schema.ts b/extensions/zalouser/src/config-schema.ts index 1ff115876c4..475ba16bca2 100644 --- a/extensions/zalouser/src/config-schema.ts +++ b/extensions/zalouser/src/config-schema.ts @@ -3,7 +3,7 @@ import { buildCatchallMultiAccountChannelSchema, DmPolicySchema, GroupPolicySchema, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/channel-config-schema"; import { MarkdownConfigSchema, ToolPolicySchema } from "openclaw/plugin-sdk/zalouser"; import { z } from "zod"; diff --git a/extensions/zalouser/src/monitor.ts b/extensions/zalouser/src/monitor.ts index b96ff8cdf0d..e4acdd61cb9 100644 --- a/extensions/zalouser/src/monitor.ts +++ b/extensions/zalouser/src/monitor.ts @@ -1,13 +1,15 @@ import { DM_GROUP_ACCESS_REASON, + resolveDmGroupAccessWithLists, +} from "openclaw/plugin-sdk/channel-policy"; +import { KeyedAsyncQueue } from "openclaw/plugin-sdk/keyed-async-queue"; +import { DEFAULT_GROUP_HISTORY_LIMIT, type HistoryEntry, - KeyedAsyncQueue, buildPendingHistoryContextFromMap, clearHistoryEntriesIfEnabled, recordPendingHistoryEntryIfEnabled, - resolveDmGroupAccessWithLists, -} from "openclaw/plugin-sdk/compat"; +} from "openclaw/plugin-sdk/reply-history"; import type { MarkdownTableMode, OpenClawConfig, diff --git a/extensions/zalouser/src/runtime.ts b/extensions/zalouser/src/runtime.ts index 44cf09edbc7..eaa93ec1b20 100644 --- a/extensions/zalouser/src/runtime.ts +++ b/extensions/zalouser/src/runtime.ts @@ -1,4 +1,4 @@ -import { createPluginRuntimeStore } from "openclaw/plugin-sdk/compat"; +import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store"; import type { PluginRuntime } from "openclaw/plugin-sdk/zalouser"; const { setRuntime: setZalouserRuntime, getRuntime: getZalouserRuntime } = diff --git a/package.json b/package.json index c22a05548cd..002dff9d4e5 100644 --- a/package.json +++ b/package.json @@ -310,6 +310,10 @@ "types": "./dist/plugin-sdk/allow-from.d.ts", "default": "./dist/plugin-sdk/allow-from.js" }, + "./plugin-sdk/allowlist-resolution": { + "types": "./dist/plugin-sdk/allowlist-resolution.d.ts", + "default": "./dist/plugin-sdk/allowlist-resolution.js" + }, "./plugin-sdk/allowlist-config-edit": { "types": "./dist/plugin-sdk/allowlist-config-edit.d.ts", "default": "./dist/plugin-sdk/allowlist-config-edit.js" @@ -322,10 +326,22 @@ "types": "./dist/plugin-sdk/channel-config-helpers.d.ts", "default": "./dist/plugin-sdk/channel-config-helpers.js" }, + "./plugin-sdk/channel-config-schema": { + "types": "./dist/plugin-sdk/channel-config-schema.d.ts", + "default": "./dist/plugin-sdk/channel-config-schema.js" + }, + "./plugin-sdk/channel-policy": { + "types": "./dist/plugin-sdk/channel-policy.d.ts", + "default": "./dist/plugin-sdk/channel-policy.js" + }, "./plugin-sdk/group-access": { "types": "./dist/plugin-sdk/group-access.d.ts", "default": "./dist/plugin-sdk/group-access.js" }, + "./plugin-sdk/directory-runtime": { + "types": "./dist/plugin-sdk/directory-runtime.d.ts", + "default": "./dist/plugin-sdk/directory-runtime.js" + }, "./plugin-sdk/json-store": { "types": "./dist/plugin-sdk/json-store.d.ts", "default": "./dist/plugin-sdk/json-store.js" @@ -362,6 +378,10 @@ "types": "./dist/plugin-sdk/provider-web-search.d.ts", "default": "./dist/plugin-sdk/provider-web-search.js" }, + "./plugin-sdk/reply-history": { + "types": "./dist/plugin-sdk/reply-history.d.ts", + "default": "./dist/plugin-sdk/reply-history.js" + }, "./plugin-sdk/media-understanding": { "types": "./dist/plugin-sdk/media-understanding.d.ts", "default": "./dist/plugin-sdk/media-understanding.js" diff --git a/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts b/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts index dacf30b5623..32c4646009a 100644 --- a/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts +++ b/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts @@ -5,14 +5,14 @@ import { discoverOpenClawPlugins } from "../src/plugins/discovery.js"; // Match exact monolithic-root specifier in any code path: // imports/exports, require/dynamic import, and test mocks (vi.mock/jest.mock). const ROOT_IMPORT_PATTERN = /["']openclaw\/plugin-sdk["']/; -const LEGACY_ROUTING_IMPORT_PATTERN = /["']openclaw\/plugin-sdk\/routing["']/; +const LEGACY_COMPAT_IMPORT_PATTERN = /["']openclaw\/plugin-sdk\/compat["']/; function hasMonolithicRootImport(content: string): boolean { return ROOT_IMPORT_PATTERN.test(content); } -function hasLegacyRoutingImport(content: string): boolean { - return LEGACY_ROUTING_IMPORT_PATTERN.test(content); +function hasLegacyCompatImport(content: string): boolean { + return LEGACY_COMPAT_IMPORT_PATTERN.test(content); } function isSourceFile(filePath: string): boolean { @@ -83,7 +83,7 @@ function main() { } const monolithicOffenders: string[] = []; - const legacyRoutingOffenders: string[] = []; + const legacyCompatOffenders: string[] = []; for (const entryFile of filesToCheck) { let content = ""; try { @@ -94,12 +94,12 @@ function main() { if (hasMonolithicRootImport(content)) { monolithicOffenders.push(entryFile); } - if (hasLegacyRoutingImport(content)) { - legacyRoutingOffenders.push(entryFile); + if (hasLegacyCompatImport(content)) { + legacyCompatOffenders.push(entryFile); } } - if (monolithicOffenders.length > 0 || legacyRoutingOffenders.length > 0) { + if (monolithicOffenders.length > 0 || legacyCompatOffenders.length > 0) { if (monolithicOffenders.length > 0) { console.error("Bundled plugin source files must not import monolithic openclaw/plugin-sdk."); for (const file of monolithicOffenders.toSorted()) { @@ -107,18 +107,18 @@ function main() { console.error(`- ${relative}`); } } - if (legacyRoutingOffenders.length > 0) { + if (legacyCompatOffenders.length > 0) { console.error( - "Bundled plugin source files must not import legacy openclaw/plugin-sdk/routing.", + "Bundled plugin source files must not import legacy openclaw/plugin-sdk/compat.", ); - for (const file of legacyRoutingOffenders.toSorted()) { + for (const file of legacyCompatOffenders.toSorted()) { const relative = path.relative(process.cwd(), file) || file; console.error(`- ${relative}`); } } - if (monolithicOffenders.length > 0 || legacyRoutingOffenders.length > 0) { + if (monolithicOffenders.length > 0 || legacyCompatOffenders.length > 0) { console.error( - "Use openclaw/plugin-sdk/ for channel plugins, /core for shared routing and startup surfaces, or /compat for broader internals.", + "Use openclaw/plugin-sdk/ or openclaw/plugin-sdk/ subpaths for bundled plugins; root and compat are legacy surfaces only.", ); } process.exit(1); diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index 50813e8dd66..ce8b623577f 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -67,10 +67,14 @@ "account-id", "account-resolution", "allow-from", + "allowlist-resolution", "allowlist-config-edit", "boolean-param", "channel-config-helpers", + "channel-config-schema", + "channel-policy", "group-access", + "directory-runtime", "json-store", "keyed-async-queue", "provider-auth", @@ -80,6 +84,7 @@ "provider-stream", "provider-usage", "provider-web-search", + "reply-history", "media-understanding", "google", "request-url", diff --git a/src/agents/models-config.providers.moonshot.test.ts b/src/agents/models-config.providers.moonshot.test.ts index b224d1c44d3..9a84439ff6f 100644 --- a/src/agents/models-config.providers.moonshot.test.ts +++ b/src/agents/models-config.providers.moonshot.test.ts @@ -5,7 +5,7 @@ import { describe, expect, it } from "vitest"; import { MOONSHOT_BASE_URL as MOONSHOT_AI_BASE_URL, MOONSHOT_CN_BASE_URL, -} from "../plugins/provider-model-definitions.js"; +} from "../plugin-sdk/provider-models.js"; import { captureEnv } from "../test-utils/env.js"; import { resolveImplicitProvidersForTest } from "./models-config.e2e-harness.js"; import { applyNativeStreamingUsageCompat } from "./models-config.providers.js"; diff --git a/src/auto-reply/reply/elevated-allowlist-matcher.ts b/src/auto-reply/reply/elevated-allowlist-matcher.ts index 7617b671391..58774b11b80 100644 --- a/src/auto-reply/reply/elevated-allowlist-matcher.ts +++ b/src/auto-reply/reply/elevated-allowlist-matcher.ts @@ -1,8 +1,8 @@ import { CHAT_CHANNEL_ORDER } from "../../channels/registry.js"; import { normalizeAtHashSlug } from "../../shared/string-normalization.js"; -import { INTERNAL_MESSAGE_CHANNEL } from "../../utils/message-channel.js"; export type ExplicitElevatedAllowField = "id" | "from" | "e164" | "name" | "username" | "tag"; +const INTERNAL_ALLOWLIST_CHANNEL = "webchat"; const EXPLICIT_ELEVATED_ALLOW_FIELDS = new Set([ "id", @@ -15,7 +15,7 @@ const EXPLICIT_ELEVATED_ALLOW_FIELDS = new Set([ const SENDER_PREFIXES = [ ...CHAT_CHANNEL_ORDER, - INTERNAL_MESSAGE_CHANNEL, + INTERNAL_ALLOWLIST_CHANNEL, "user", "group", "channel", diff --git a/src/channels/registry.ts b/src/channels/registry.ts index 5e552e04a0e..035b7f4651a 100644 --- a/src/channels/registry.ts +++ b/src/channels/registry.ts @@ -1,4 +1,3 @@ -import { requireActivePluginRegistry } from "../plugins/runtime.js"; import { CHANNEL_IDS, CHAT_CHANNEL_ORDER, type ChatChannelId } from "./ids.js"; import type { ChannelMeta } from "./plugins/types.js"; import type { ChannelId } from "./plugins/types.js"; @@ -8,6 +7,21 @@ export type { ChatChannelId } from "./ids.js"; export type ChatChannelMeta = ChannelMeta; const WEBSITE_URL = "https://openclaw.ai"; +const REGISTRY_STATE = Symbol.for("openclaw.pluginRegistryState"); + +type RegisteredChannelPluginEntry = { + plugin: { + id?: string | null; + meta?: { aliases?: string[] | null } | null; + }; +}; + +function listRegisteredChannelPluginEntries(): RegisteredChannelPluginEntry[] { + const globalState = globalThis as typeof globalThis & { + [REGISTRY_STATE]?: { registry?: { channels?: RegisteredChannelPluginEntry[] | null } | null }; + }; + return globalState[REGISTRY_STATE]?.registry?.channels ?? []; +} const CHAT_CHANNEL_META: Record = { telegram: { @@ -154,15 +168,14 @@ export function normalizeAnyChannelId(raw?: string | null): ChannelId | null { return null; } - const registry = requireActivePluginRegistry(); - const hit = registry.channels.find((entry) => { + const hit = listRegisteredChannelPluginEntries().find((entry) => { const id = String(entry.plugin.id ?? "") .trim() .toLowerCase(); if (id && id === key) { return true; } - return (entry.plugin.meta.aliases ?? []).some((alias) => alias.trim().toLowerCase() === key); + return (entry.plugin.meta?.aliases ?? []).some((alias) => alias.trim().toLowerCase() === key); }); return hit?.plugin.id ?? null; } diff --git a/src/cli/deps.test.ts b/src/cli/deps.test.ts index d13f2998987..8dbc8539cff 100644 --- a/src/cli/deps.test.ts +++ b/src/cli/deps.test.ts @@ -19,32 +19,32 @@ const sendFns = vi.hoisted(() => ({ imessage: vi.fn(async () => ({ messageId: "i1", chatId: "imessage:1" })), })); -vi.mock("../plugin-sdk-internal/whatsapp.js", () => { +vi.mock("./send-runtime/whatsapp.js", () => { moduleLoads.whatsapp(); return { sendMessageWhatsApp: sendFns.whatsapp }; }); -vi.mock("../plugin-sdk-internal/telegram.js", () => { +vi.mock("./send-runtime/telegram.js", () => { moduleLoads.telegram(); return { sendMessageTelegram: sendFns.telegram }; }); -vi.mock("../plugin-sdk-internal/discord.js", () => { +vi.mock("./send-runtime/discord.js", () => { moduleLoads.discord(); return { sendMessageDiscord: sendFns.discord }; }); -vi.mock("../plugin-sdk-internal/slack.js", () => { +vi.mock("./send-runtime/slack.js", () => { moduleLoads.slack(); return { sendMessageSlack: sendFns.slack }; }); -vi.mock("../plugin-sdk-internal/signal.js", () => { +vi.mock("./send-runtime/signal.js", () => { moduleLoads.signal(); return { sendMessageSignal: sendFns.signal }; }); -vi.mock("../plugin-sdk-internal/imessage.js", () => { +vi.mock("./send-runtime/imessage.js", () => { moduleLoads.imessage(); return { sendMessageIMessage: sendFns.imessage }; }); diff --git a/src/cli/deps.ts b/src/cli/deps.ts index 7ebfbf74f5b..908da8cd265 100644 --- a/src/cli/deps.ts +++ b/src/cli/deps.ts @@ -35,32 +35,32 @@ export function createDefaultDeps(): CliDeps { return { whatsapp: createLazySender( "whatsapp", - () => import("../plugin-sdk/whatsapp.js") as Promise>, + () => import("./send-runtime/whatsapp.js") as Promise>, "sendMessageWhatsApp", ), telegram: createLazySender( "telegram", - () => import("../plugin-sdk/telegram.js") as Promise>, + () => import("./send-runtime/telegram.js") as Promise>, "sendMessageTelegram", ), discord: createLazySender( "discord", - () => import("../plugin-sdk/discord.js") as Promise>, + () => import("./send-runtime/discord.js") as Promise>, "sendMessageDiscord", ), slack: createLazySender( "slack", - () => import("../plugin-sdk/slack.js") as Promise>, + () => import("./send-runtime/slack.js") as Promise>, "sendMessageSlack", ), signal: createLazySender( "signal", - () => import("../plugin-sdk/signal.js") as Promise>, + () => import("./send-runtime/signal.js") as Promise>, "sendMessageSignal", ), imessage: createLazySender( "imessage", - () => import("../plugin-sdk/imessage.js") as Promise>, + () => import("./send-runtime/imessage.js") as Promise>, "sendMessageIMessage", ), }; diff --git a/src/cli/send-runtime/discord.ts b/src/cli/send-runtime/discord.ts new file mode 100644 index 00000000000..9ec4cf97247 --- /dev/null +++ b/src/cli/send-runtime/discord.ts @@ -0,0 +1 @@ +export { sendMessageDiscord } from "../../plugin-sdk/discord.js"; diff --git a/src/cli/send-runtime/imessage.ts b/src/cli/send-runtime/imessage.ts new file mode 100644 index 00000000000..3208aa24e00 --- /dev/null +++ b/src/cli/send-runtime/imessage.ts @@ -0,0 +1 @@ +export { sendMessageIMessage } from "../../plugin-sdk/imessage.js"; diff --git a/src/cli/send-runtime/signal.ts b/src/cli/send-runtime/signal.ts new file mode 100644 index 00000000000..19a366168c8 --- /dev/null +++ b/src/cli/send-runtime/signal.ts @@ -0,0 +1 @@ +export { sendMessageSignal } from "../../plugin-sdk/signal.js"; diff --git a/src/cli/send-runtime/slack.ts b/src/cli/send-runtime/slack.ts new file mode 100644 index 00000000000..1f108ac0fdc --- /dev/null +++ b/src/cli/send-runtime/slack.ts @@ -0,0 +1 @@ +export { sendMessageSlack } from "../../plugin-sdk/slack.js"; diff --git a/src/cli/send-runtime/telegram.ts b/src/cli/send-runtime/telegram.ts new file mode 100644 index 00000000000..c0037ec1f0a --- /dev/null +++ b/src/cli/send-runtime/telegram.ts @@ -0,0 +1 @@ +export { sendMessageTelegram } from "../../plugin-sdk/telegram.js"; diff --git a/src/cli/send-runtime/whatsapp.ts b/src/cli/send-runtime/whatsapp.ts new file mode 100644 index 00000000000..00ec2f1ba09 --- /dev/null +++ b/src/cli/send-runtime/whatsapp.ts @@ -0,0 +1 @@ +export { sendMessageWhatsApp } from "../../plugin-sdk/whatsapp.js"; diff --git a/src/commands/auth-choice.test.ts b/src/commands/auth-choice.test.ts index 7b16ad47341..8d6316e9acb 100644 --- a/src/commands/auth-choice.test.ts +++ b/src/commands/auth-choice.test.ts @@ -30,7 +30,7 @@ import { MINIMAX_CN_API_BASE_URL, ZAI_CODING_CN_BASE_URL, ZAI_CODING_GLOBAL_BASE_URL, -} from "../plugins/provider-model-definitions.js"; +} from "../plugin-sdk/provider-models.js"; import type { ProviderPlugin } from "../plugins/types.js"; import { registerProviderPlugins } from "../test-utils/plugin-registration.js"; import type { WizardPrompter } from "../wizard/prompts.js"; diff --git a/src/commands/onboard-auth.config-core.kilocode.test.ts b/src/commands/onboard-auth.config-core.kilocode.test.ts index 511b5550890..b27acab133a 100644 --- a/src/commands/onboard-auth.config-core.kilocode.test.ts +++ b/src/commands/onboard-auth.config-core.kilocode.test.ts @@ -17,7 +17,7 @@ import { KILOCODE_DEFAULT_CONTEXT_WINDOW, KILOCODE_DEFAULT_MAX_TOKENS, KILOCODE_DEFAULT_COST, -} from "../plugins/provider-model-definitions.js"; +} from "../plugin-sdk/provider-models.js"; import { captureEnv } from "../test-utils/env.js"; const emptyCfg: OpenClawConfig = {}; diff --git a/src/commands/onboard-auth.test.ts b/src/commands/onboard-auth.test.ts index 2ad0339a3b2..969128d343e 100644 --- a/src/commands/onboard-auth.test.ts +++ b/src/commands/onboard-auth.test.ts @@ -42,17 +42,17 @@ import { resolveAgentModelPrimaryValue, } from "../config/model-input.js"; import type { ModelApi } from "../config/types.models.js"; +import { + MISTRAL_DEFAULT_MODEL_REF, + ZAI_CODING_CN_BASE_URL, + ZAI_GLOBAL_BASE_URL, +} from "../plugin-sdk/provider-models.js"; import { applyAuthProfileConfig } from "../plugins/provider-auth-helpers.js"; import { OPENROUTER_DEFAULT_MODEL_REF, setMinimaxApiKey, writeOAuthCredentials, } from "../plugins/provider-auth-storage.js"; -import { - MISTRAL_DEFAULT_MODEL_REF, - ZAI_CODING_CN_BASE_URL, - ZAI_GLOBAL_BASE_URL, -} from "../plugins/provider-model-definitions.js"; import { applyLitellmProviderConfig } from "./onboard-auth.config-litellm.js"; import { createAuthTestLifecycle, diff --git a/src/commands/onboard-non-interactive.provider-auth.test.ts b/src/commands/onboard-non-interactive.provider-auth.test.ts index 085d9d1f102..329314d1efd 100644 --- a/src/commands/onboard-non-interactive.provider-auth.test.ts +++ b/src/commands/onboard-non-interactive.provider-auth.test.ts @@ -8,7 +8,7 @@ import { ZAI_CODING_CN_BASE_URL, ZAI_CODING_GLOBAL_BASE_URL, ZAI_GLOBAL_BASE_URL, -} from "../plugins/provider-model-definitions.js"; +} from "../plugin-sdk/provider-models.js"; import { makeTempWorkspace } from "../test-helpers/workspace.js"; import { withEnvAsync } from "../test-utils/env.js"; import { diff --git a/src/plugin-sdk-internal/accounts.ts b/src/plugin-sdk-internal/accounts.ts deleted file mode 100644 index 71807c97c6e..00000000000 --- a/src/plugin-sdk-internal/accounts.ts +++ /dev/null @@ -1,12 +0,0 @@ -export type { OpenClawConfig } from "../config/config.js"; - -export { createAccountActionGate } from "../channels/plugins/account-action-gate.js"; -export { createAccountListHelpers } from "../channels/plugins/account-helpers.js"; -export { normalizeChatType } from "../channels/chat-type.js"; -export { - listConfiguredAccountIds, - resolveAccountWithDefaultFallback, -} from "../plugin-sdk/account-resolution.js"; -export { resolveAccountEntry } from "../routing/account-lookup.js"; -export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; -export { normalizeE164, pathExists, resolveUserPath } from "../utils.js"; diff --git a/src/plugin-sdk-internal/channel-config.ts b/src/plugin-sdk-internal/channel-config.ts deleted file mode 100644 index 64b62fb77b0..00000000000 --- a/src/plugin-sdk-internal/channel-config.ts +++ /dev/null @@ -1,17 +0,0 @@ -// Private bridge for bundled channel plugins. These config helpers are shared -// internally, but do not belong on the public compat surface. -export { buildAccountScopedAllowlistConfigEditor } from "../plugin-sdk/allowlist-config-edit.js"; -export { formatAllowFromLowercase } from "../plugin-sdk/allow-from.js"; -export { - createScopedAccountConfigAccessors, - createScopedChannelConfigBase, - createScopedDmSecurityResolver, -} from "../plugin-sdk/channel-config-helpers.js"; -export { - collectAllowlistProviderGroupPolicyWarnings, - collectAllowlistProviderRestrictSendersWarnings, - collectOpenGroupPolicyConfiguredRouteWarnings, - collectOpenGroupPolicyRouteAllowlistWarnings, - collectOpenProviderGroupPolicyWarnings, -} from "../channels/plugins/group-policy-warnings.js"; -export { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js"; diff --git a/src/plugin-sdk-internal/core.ts b/src/plugin-sdk-internal/core.ts deleted file mode 100644 index aa5ef23268d..00000000000 --- a/src/plugin-sdk-internal/core.ts +++ /dev/null @@ -1,14 +0,0 @@ -// Private bridge for bundled channel plugins. Keep public sdk/core slim for -// third-party plugins; bundled channels can reach shared runtime helpers here. -export type { - ChannelMessageActionContext, - OpenClawPluginApi, - PluginRuntime, -} from "../plugin-sdk/channel-plugin-common.js"; -export { createPluginRuntimeStore } from "../plugin-sdk/runtime-store.js"; -export { - buildAgentSessionKey, - type RoutePeer, - type RoutePeerKind, -} from "../routing/resolve-route.js"; -export { resolveThreadSessionKeys } from "../routing/session-key.js"; diff --git a/src/plugin-sdk-internal/discord.ts b/src/plugin-sdk-internal/discord.ts deleted file mode 100644 index b978b678e9d..00000000000 --- a/src/plugin-sdk-internal/discord.ts +++ /dev/null @@ -1,115 +0,0 @@ -export type { ChannelMessageActionAdapter } from "../channels/plugins/types.js"; -export type { OpenClawConfig } from "../config/config.js"; -export type { DiscordAccountConfig, DiscordActionConfig } from "../config/types.js"; -export type { InspectedDiscordAccount } from "../../extensions/discord/src/account-inspect.js"; -export type { ResolvedDiscordAccount } from "../../extensions/discord/src/accounts.js"; -export type { - DiscordSendComponents, - DiscordSendEmbeds, -} from "../../extensions/discord/src/send.shared.js"; -export * from "../plugin-sdk/channel-plugin-common.js"; - -export { - createDiscordActionGate, - listDiscordAccountIds, - resolveDefaultDiscordAccountId, - resolveDiscordAccount, -} from "../../extensions/discord/src/accounts.js"; -export { inspectDiscordAccount } from "../../extensions/discord/src/account-inspect.js"; -export { - projectCredentialSnapshotFields, - resolveConfiguredFromCredentialStatuses, -} from "../channels/account-snapshot-fields.js"; -export { - listDiscordDirectoryGroupsFromConfig, - listDiscordDirectoryPeersFromConfig, -} from "../channels/plugins/directory-config.js"; -export { - looksLikeDiscordTargetId, - normalizeDiscordMessagingTarget, - normalizeDiscordOutboundTarget, -} from "../../extensions/discord/src/normalize.js"; -export { collectDiscordAuditChannelIds } from "../../extensions/discord/src/audit.js"; -export { collectDiscordStatusIssues } from "../../extensions/discord/src/status-issues.js"; -export { - DISCORD_DEFAULT_INBOUND_WORKER_TIMEOUT_MS, - DISCORD_DEFAULT_LISTENER_TIMEOUT_MS, -} from "../../extensions/discord/src/monitor/timeouts.js"; -export { normalizeExplicitDiscordSessionKey } from "../../extensions/discord/src/session-key-normalization.js"; -export type { DiscordPluralKitConfig } from "../../extensions/discord/src/pluralkit.js"; - -export { - resolveDefaultGroupPolicy, - resolveOpenProviderRuntimeGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { - resolveDiscordGroupRequireMention, - resolveDiscordGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { discordSetupWizard } from "../../extensions/discord/src/plugin-shared.js"; -export { DiscordConfigSchema } from "../config/zod-schema.providers-core.js"; - -export { - autoBindSpawnedDiscordSubagent, - listThreadBindingsBySessionKey, - unbindThreadBindingsBySessionKey, -} from "../../extensions/discord/src/monitor/thread-bindings.js"; -export { getGateway } from "../../extensions/discord/src/monitor/gateway-registry.js"; -export { getPresence } from "../../extensions/discord/src/monitor/presence-cache.js"; -export { readDiscordComponentSpec } from "../../extensions/discord/src/components.js"; -export { resolveDiscordChannelId } from "../../extensions/discord/src/targets.js"; -export { - addRoleDiscord, - banMemberDiscord, - createChannelDiscord, - createScheduledEventDiscord, - createThreadDiscord, - deleteChannelDiscord, - deleteMessageDiscord, - editChannelDiscord, - editMessageDiscord, - fetchChannelInfoDiscord, - fetchChannelPermissionsDiscord, - fetchMemberInfoDiscord, - fetchMessageDiscord, - fetchReactionsDiscord, - fetchRoleInfoDiscord, - fetchVoiceStatusDiscord, - hasAnyGuildPermissionDiscord, - kickMemberDiscord, - listGuildChannelsDiscord, - listGuildEmojisDiscord, - listPinsDiscord, - listScheduledEventsDiscord, - listThreadsDiscord, - moveChannelDiscord, - pinMessageDiscord, - reactMessageDiscord, - readMessagesDiscord, - removeChannelPermissionDiscord, - removeOwnReactionsDiscord, - removeReactionDiscord, - removeRoleDiscord, - searchMessagesDiscord, - sendDiscordComponentMessage, - sendMessageDiscord, - sendPollDiscord, - sendStickerDiscord, - sendVoiceMessageDiscord, - setChannelPermissionDiscord, - timeoutMemberDiscord, - unpinMessageDiscord, - uploadEmojiDiscord, - uploadStickerDiscord, -} from "../../extensions/discord/src/send.js"; -export { discordMessageActions } from "../../extensions/discord/src/channel-actions.js"; -export type { - ThreadBindingManager, - ThreadBindingRecord, - ThreadBindingTargetKind, -} from "../../extensions/discord/src/monitor/thread-bindings.js"; - -export { - buildComputedAccountStatusSnapshot, - buildTokenChannelStatusSummary, -} from "../plugin-sdk/status-helpers.js"; diff --git a/src/plugin-sdk-internal/imessage.ts b/src/plugin-sdk-internal/imessage.ts deleted file mode 100644 index ec338483b98..00000000000 --- a/src/plugin-sdk-internal/imessage.ts +++ /dev/null @@ -1,46 +0,0 @@ -export type { ResolvedIMessageAccount } from "../../extensions/imessage/src/accounts.js"; -export type { IMessageAccountConfig } from "../config/types.js"; -export * from "../plugin-sdk/channel-plugin-common.js"; -export { - listIMessageAccountIds, - resolveDefaultIMessageAccountId, - resolveIMessageAccount, -} from "../../extensions/imessage/src/accounts.js"; -export { - formatTrimmedAllowFromEntries, - resolveIMessageConfigAllowFrom, - resolveIMessageConfigDefaultTo, -} from "../plugin-sdk/channel-config-helpers.js"; -export { isAllowedParsedChatSender } from "../plugin-sdk/allow-from.js"; -export { - looksLikeIMessageTargetId, - normalizeIMessageMessagingTarget, -} from "../channels/plugins/normalize/imessage.js"; -export { - createAllowedChatSenderMatcher, - parseChatAllowTargetPrefixes, - parseChatTargetPrefixesOrThrow, - resolveServicePrefixedChatTarget, - resolveServicePrefixedAllowTarget, - resolveServicePrefixedOrChatAllowTarget, - resolveServicePrefixedTarget, -} from "../../extensions/imessage/src/target-parsing-helpers.js"; -export type { - ChatSenderAllowParams, - ParsedChatTarget, -} from "../../extensions/imessage/src/target-parsing-helpers.js"; -export { sendMessageIMessage } from "../../extensions/imessage/src/send.js"; - -export { - resolveAllowlistProviderRuntimeGroupPolicy, - resolveDefaultGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { - resolveIMessageGroupRequireMention, - resolveIMessageGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { imessageSetupWizard } from "../../extensions/imessage/src/plugin-shared.js"; -export { IMessageConfigSchema } from "../config/zod-schema.providers-core.js"; - -export { resolveChannelMediaMaxBytes } from "../channels/plugins/media-limits.js"; -export { collectStatusIssuesFromLastError } from "../plugin-sdk/status-helpers.js"; diff --git a/src/plugin-sdk-internal/setup.ts b/src/plugin-sdk-internal/setup.ts deleted file mode 100644 index f6643637e7e..00000000000 --- a/src/plugin-sdk-internal/setup.ts +++ /dev/null @@ -1,38 +0,0 @@ -export type { OpenClawConfig } from "../config/config.js"; -export type { DmPolicy } from "../config/types.js"; -export type { WizardPrompter } from "../wizard/prompts.js"; -export type { ChannelSetupAdapter } from "../channels/plugins/types.adapters.js"; -export type { ChannelSetupDmPolicy } from "../channels/plugins/setup-wizard-types.js"; -export type { - ChannelSetupWizard, - ChannelSetupWizardAllowFromEntry, -} from "../channels/plugins/setup-wizard.js"; - -export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; -export { - applyAccountNameToChannelSection, - migrateBaseNameToDefaultAccount, -} from "../channels/plugins/setup-helpers.js"; -export { - normalizeAllowFromEntries, - noteChannelLookupFailure, - noteChannelLookupSummary, - parseMentionOrPrefixedId, - parseSetupEntriesAllowingWildcard, - patchChannelConfigForAccount, - promptLegacyChannelAllowFrom, - promptParsedAllowFromForScopedChannel, - promptResolvedAllowFrom, - resolveSetupAccountId, - setAccountGroupPolicyForChannel, - setChannelDmPolicyWithAllowFrom, - setLegacyChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, - splitSetupEntries, -} from "../channels/plugins/setup-wizard-helpers.js"; -export { detectBinary } from "../plugins/setup-binary.js"; -export { installSignalCli } from "../plugins/signal-cli-install.js"; -export { formatCliCommand } from "../cli/command-format.js"; -export { formatDocsLink } from "../terminal/links.js"; -export { hasConfiguredSecretInput } from "../config/types.secrets.js"; -export { normalizeE164, pathExists } from "../utils.js"; diff --git a/src/plugin-sdk-internal/signal.ts b/src/plugin-sdk-internal/signal.ts deleted file mode 100644 index 237298f9111..00000000000 --- a/src/plugin-sdk-internal/signal.ts +++ /dev/null @@ -1,39 +0,0 @@ -export type { ChannelMessageActionAdapter } from "../channels/plugins/types.js"; -export type { OpenClawConfig } from "../config/config.js"; -export type { ResolvedSignalAccount } from "../../extensions/signal/src/accounts.js"; -export type { SignalAccountConfig } from "../config/types.js"; -export * from "../plugin-sdk/channel-plugin-common.js"; -export { - listEnabledSignalAccounts, - listSignalAccountIds, - resolveDefaultSignalAccountId, - resolveSignalAccount, -} from "../../extensions/signal/src/accounts.js"; -export { resolveSignalReactionLevel } from "../../extensions/signal/src/reaction-level.js"; -export { - removeReactionSignal, - sendReactionSignal, -} from "../../extensions/signal/src/send-reactions.js"; -export { sendMessageSignal } from "../../extensions/signal/src/send.js"; -export { - looksLikeSignalTargetId, - normalizeSignalMessagingTarget, -} from "../channels/plugins/normalize/signal.js"; - -export { - resolveAllowlistProviderRuntimeGroupPolicy, - resolveDefaultGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { evaluateSenderGroupAccessForPolicy } from "../plugin-sdk/group-access.js"; -export { signalSetupWizard } from "../../extensions/signal/src/plugin-shared.js"; -export { SignalConfigSchema } from "../config/zod-schema.providers-core.js"; - -export { normalizeE164 } from "../utils.js"; -export { resolveChannelMediaMaxBytes } from "../channels/plugins/media-limits.js"; - -export { - buildBaseAccountStatusSnapshot, - buildBaseChannelStatusSummary, - collectStatusIssuesFromLastError, - createDefaultChannelRuntimeState, -} from "../plugin-sdk/status-helpers.js"; diff --git a/src/plugin-sdk-internal/slack.ts b/src/plugin-sdk-internal/slack.ts deleted file mode 100644 index c375010a9de..00000000000 --- a/src/plugin-sdk-internal/slack.ts +++ /dev/null @@ -1,67 +0,0 @@ -export type { OpenClawConfig } from "../config/config.js"; -export type { SlackAccountConfig } from "../config/types.slack.js"; -export type { InspectedSlackAccount } from "../../extensions/slack/src/account-inspect.js"; -export type { ResolvedSlackAccount } from "../../extensions/slack/src/accounts.js"; -export * from "../plugin-sdk/channel-plugin-common.js"; -export { - listEnabledSlackAccounts, - listSlackAccountIds, - resolveDefaultSlackAccountId, - resolveSlackAccount, - resolveSlackReplyToMode, -} from "../../extensions/slack/src/accounts.js"; -export { isSlackInteractiveRepliesEnabled } from "../../extensions/slack/src/interactive-replies.js"; -export { inspectSlackAccount } from "../../extensions/slack/src/account-inspect.js"; -export { - projectCredentialSnapshotFields, - resolveConfiguredFromCredentialStatuses, - resolveConfiguredFromRequiredCredentialStatuses, -} from "../channels/account-snapshot-fields.js"; -export { - listSlackDirectoryGroupsFromConfig, - listSlackDirectoryPeersFromConfig, -} from "../channels/plugins/directory-config.js"; -export { - looksLikeSlackTargetId, - normalizeSlackMessagingTarget, -} from "../channels/plugins/normalize/slack.js"; -export { parseSlackTarget, resolveSlackChannelId } from "../plugin-sdk/slack-targets.js"; -export { - extractSlackToolSend, - listSlackMessageActions, -} from "../../extensions/slack/src/message-actions.js"; -export { buildSlackThreadingToolContext } from "../../extensions/slack/src/threading-tool-context.js"; -export { parseSlackBlocksInput } from "../../extensions/slack/src/blocks-input.js"; -export { handleSlackHttpRequest } from "../../extensions/slack/src/http/index.js"; -export { sendMessageSlack } from "../../extensions/slack/src/send.js"; -export { - deleteSlackMessage, - downloadSlackFile, - editSlackMessage, - getSlackMemberInfo, - listSlackEmojis, - listSlackPins, - listSlackReactions, - pinSlackMessage, - reactSlackMessage, - readSlackMessages, - removeOwnSlackReactions, - removeSlackReaction, - sendSlackMessage, - unpinSlackMessage, -} from "../../extensions/slack/src/actions.js"; -export { recordSlackThreadParticipation } from "../../extensions/slack/src/sent-thread-cache.js"; -export { buildComputedAccountStatusSnapshot } from "../plugin-sdk/status-helpers.js"; - -export { - resolveDefaultGroupPolicy, - resolveOpenProviderRuntimeGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { - resolveSlackGroupRequireMention, - resolveSlackGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { slackSetupWizard } from "../../extensions/slack/src/plugin-shared.js"; -export { SlackConfigSchema } from "../config/zod-schema.providers-core.js"; - -export { handleSlackMessageAction } from "../plugin-sdk/slack-message-actions.js"; diff --git a/src/plugin-sdk-internal/telegram.ts b/src/plugin-sdk-internal/telegram.ts deleted file mode 100644 index d5dd45a96d6..00000000000 --- a/src/plugin-sdk-internal/telegram.ts +++ /dev/null @@ -1,120 +0,0 @@ -export type { - ChannelAccountSnapshot, - ChannelGatewayContext, - ChannelMessageActionAdapter, -} from "../channels/plugins/types.js"; -export type { ChannelPlugin } from "../channels/plugins/types.plugin.js"; -export type { OpenClawConfig } from "../config/config.js"; -export type { PluginRuntime } from "../plugins/runtime/types.js"; -export type { OpenClawPluginApi } from "../plugins/types.js"; -export type { - TelegramAccountConfig, - TelegramActionConfig, - TelegramNetworkConfig, -} from "../config/types.js"; -export type { InspectedTelegramAccount } from "../../extensions/telegram/src/account-inspect.js"; -export type { ResolvedTelegramAccount } from "../../extensions/telegram/src/accounts.js"; -export type { TelegramProbe } from "../../extensions/telegram/src/probe.js"; -export type { - TelegramButtonStyle, - TelegramInlineButtons, -} from "../../extensions/telegram/src/button-types.js"; - -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; - -export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; - -export { - applyAccountNameToChannelSection, - migrateBaseNameToDefaultAccount, -} from "../channels/plugins/setup-helpers.js"; -export { buildChannelConfigSchema } from "../channels/plugins/config-schema.js"; -export { - deleteAccountFromConfigSection, - clearAccountEntryFields, - setAccountEnabledInConfigSection, -} from "../channels/plugins/config-helpers.js"; -export { formatPairingApproveHint } from "../channels/plugins/helpers.js"; -export { PAIRING_APPROVED_MESSAGE } from "../channels/plugins/pairing-message.js"; - -export { getChatChannelMeta } from "../channels/registry.js"; - -export { - createTelegramActionGate, - listTelegramAccountIds, - resolveDefaultTelegramAccountId, - resolveTelegramPollActionGateState, - resolveTelegramAccount, -} from "../../extensions/telegram/src/accounts.js"; -export { inspectTelegramAccount } from "../../extensions/telegram/src/account-inspect.js"; -export { - projectCredentialSnapshotFields, - resolveConfiguredFromCredentialStatuses, -} from "../channels/account-snapshot-fields.js"; -export { - listTelegramDirectoryGroupsFromConfig, - listTelegramDirectoryPeersFromConfig, -} from "../channels/plugins/directory-config.js"; -export { - looksLikeTelegramTargetId, - normalizeTelegramMessagingTarget, -} from "../../extensions/telegram/src/normalize.js"; -export { - parseTelegramReplyToMessageId, - parseTelegramThreadId, -} from "../../extensions/telegram/src/outbound-params.js"; -export { - isNumericTelegramUserId, - normalizeTelegramAllowFromEntry, -} from "../../extensions/telegram/src/allow-from.js"; -export { fetchTelegramChatId } from "../../extensions/telegram/src/api-fetch.js"; -export { - resolveTelegramInlineButtonsScope, - resolveTelegramTargetChatType, -} from "../../extensions/telegram/src/inline-buttons.js"; -export { resolveTelegramReactionLevel } from "../../extensions/telegram/src/reaction-level.js"; -export { - createForumTopicTelegram, - deleteMessageTelegram, - editForumTopicTelegram, - editMessageTelegram, - reactMessageTelegram, - sendMessageTelegram, - sendPollTelegram, - sendStickerTelegram, -} from "../../extensions/telegram/src/send.js"; -export { getCacheStats, searchStickers } from "../../extensions/telegram/src/sticker-cache.js"; -export { resolveTelegramToken } from "../../extensions/telegram/src/token.js"; -export { telegramMessageActions } from "../../extensions/telegram/src/channel-actions.js"; -export { collectTelegramStatusIssues } from "../../extensions/telegram/src/status-issues.js"; -export { sendTelegramPayloadMessages } from "../../extensions/telegram/src/outbound-adapter.js"; -export { - buildBrowseProvidersButton, - buildModelsKeyboard, - buildProviderKeyboard, - calculateTotalPages, - getModelsPageSize, - type ProviderInfo, -} from "../../extensions/telegram/src/model-buttons.js"; -export { - isTelegramExecApprovalApprover, - isTelegramExecApprovalClientEnabled, -} from "../../extensions/telegram/src/exec-approvals.js"; -export type { StickerMetadata } from "../../extensions/telegram/src/bot/types.js"; - -export { - resolveAllowlistProviderRuntimeGroupPolicy, - resolveDefaultGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { readBooleanParam } from "../plugin-sdk/boolean-param.js"; -export { evaluateMatchedGroupAccessForPolicy } from "../plugin-sdk/group-access.js"; -export { extractToolSend } from "../plugin-sdk/tool-send.js"; -export { - resolveTelegramGroupRequireMention, - resolveTelegramGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { telegramSetupWizard } from "../../extensions/telegram/src/setup-surface.js"; -export { telegramSetupAdapter } from "../../extensions/telegram/src/setup-core.js"; -export { TelegramConfigSchema } from "../config/zod-schema.providers-core.js"; - -export { buildTokenChannelStatusSummary } from "../plugin-sdk/status-helpers.js"; diff --git a/src/plugin-sdk-internal/whatsapp.ts b/src/plugin-sdk-internal/whatsapp.ts deleted file mode 100644 index a1871198c70..00000000000 --- a/src/plugin-sdk-internal/whatsapp.ts +++ /dev/null @@ -1,108 +0,0 @@ -export type { ChannelMessageActionName } from "../channels/plugins/types.js"; -export type { ChannelPlugin } from "../channels/plugins/types.plugin.js"; -export type { OpenClawConfig } from "../config/config.js"; -export type { DmPolicy, GroupPolicy, WhatsAppAccountConfig } from "../config/types.js"; -export type { PluginRuntime } from "../plugins/runtime/types.js"; -export type { OpenClawPluginApi } from "../plugins/types.js"; - -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; - -export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; - -export { - applyAccountNameToChannelSection, - migrateBaseNameToDefaultAccount, -} from "../channels/plugins/setup-helpers.js"; -export { buildChannelConfigSchema } from "../channels/plugins/config-schema.js"; -export { formatPairingApproveHint } from "../channels/plugins/helpers.js"; - -export { getChatChannelMeta } from "../channels/registry.js"; -export { - formatWhatsAppConfigAllowFromEntries, - resolveWhatsAppConfigAllowFrom, - resolveWhatsAppConfigDefaultTo, -} from "../plugin-sdk/channel-config-helpers.js"; -export { - listWhatsAppDirectoryGroupsFromConfig, - listWhatsAppDirectoryPeersFromConfig, -} from "../channels/plugins/directory-config.js"; -export { - hasAnyWhatsAppAuth, - listEnabledWhatsAppAccounts, - resolveWhatsAppAccount, -} from "../../extensions/whatsapp/src/accounts.js"; -export { - WA_WEB_AUTH_DIR, - logWebSelfId, - logoutWeb, - pickWebChannel, - webAuthExists, -} from "../../extensions/whatsapp/src/auth-store.js"; -export { - DEFAULT_WEB_MEDIA_BYTES, - HEARTBEAT_PROMPT, - HEARTBEAT_TOKEN, - monitorWebChannel, - resolveHeartbeatRecipients, - runWebHeartbeatOnce, -} from "../../extensions/whatsapp/src/auto-reply.js"; -export type { - WebChannelStatus, - WebMonitorTuning, -} from "../../extensions/whatsapp/src/auto-reply.js"; -export { - extractMediaPlaceholder, - extractText, - monitorWebInbox, -} from "../../extensions/whatsapp/src/inbound.js"; -export type { - WebInboundMessage, - WebListenerCloseReason, -} from "../../extensions/whatsapp/src/inbound.js"; -export { loginWeb } from "../../extensions/whatsapp/src/login.js"; -export { - getDefaultLocalRoots, - loadWebMedia, - loadWebMediaRaw, - optimizeImageToJpeg, -} from "../../extensions/whatsapp/src/media.js"; -export { - sendMessageWhatsApp, - sendPollWhatsApp, - sendReactionWhatsApp, -} from "../../extensions/whatsapp/src/send.js"; -export { - createWaSocket, - formatError, - getStatusCode, - waitForWaConnection, -} from "../../extensions/whatsapp/src/session.js"; -export { createWhatsAppLoginTool } from "../../extensions/whatsapp/src/agent-tools-login.js"; -export { normalizeWhatsAppAllowFromEntries } from "../channels/plugins/normalize/whatsapp.js"; -export { - collectAllowlistProviderGroupPolicyWarnings, - collectOpenGroupPolicyRouteAllowlistWarnings, -} from "../channels/plugins/group-policy-warnings.js"; -export { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js"; -export { resolveWhatsAppOutboundTarget } from "../whatsapp/resolve-outbound-target.js"; - -export { - resolveAllowlistProviderRuntimeGroupPolicy, - resolveDefaultGroupPolicy, -} from "../config/runtime-group-policy.js"; -export { - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { - createWhatsAppOutboundBase, - resolveWhatsAppGroupIntroHint, - resolveWhatsAppMentionStripRegexes, -} from "../channels/plugins/whatsapp-shared.js"; -export { resolveWhatsAppHeartbeatRecipients } from "../channels/plugins/whatsapp-heartbeat.js"; -export { WhatsAppConfigSchema } from "../config/zod-schema.providers-whatsapp.js"; - -export { createActionGate, readStringParam } from "../agents/tools/common.js"; -export { createPluginRuntimeStore } from "../plugin-sdk/runtime-store.js"; - -export { normalizeE164 } from "../utils.js"; diff --git a/src/plugin-sdk/channel-config-schema.ts b/src/plugin-sdk/channel-config-schema.ts new file mode 100644 index 00000000000..bbf6191ae75 --- /dev/null +++ b/src/plugin-sdk/channel-config-schema.ts @@ -0,0 +1,7 @@ +/** Shared config-schema primitives for channel plugins with DM/group policy knobs. */ +export { + AllowFromListSchema, + buildCatchallMultiAccountChannelSchema, + buildNestedDmConfigSchema, +} from "../channels/plugins/config-schema.js"; +export { DmPolicySchema, GroupPolicySchema } from "../config/zod-schema.core.js"; diff --git a/src/plugin-sdk/channel-policy.ts b/src/plugin-sdk/channel-policy.ts new file mode 100644 index 00000000000..62538b68dd6 --- /dev/null +++ b/src/plugin-sdk/channel-policy.ts @@ -0,0 +1,19 @@ +/** Shared policy warnings and DM/group policy helpers for channel plugins. */ +export { + buildOpenGroupPolicyConfigureRouteAllowlistWarning, + buildOpenGroupPolicyRestrictSendersWarning, + buildOpenGroupPolicyWarning, + collectAllowlistProviderGroupPolicyWarnings, + collectAllowlistProviderRestrictSendersWarnings, + collectOpenGroupPolicyRestrictSendersWarnings, + collectOpenGroupPolicyRouteAllowlistWarnings, + collectOpenProviderGroupPolicyWarnings, +} from "../channels/plugins/group-policy-warnings.js"; +export { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js"; +export { resolveChannelGroupRequireMention } from "../config/group-policy.js"; +export { + DM_GROUP_ACCESS_REASON, + readStoreAllowFromForDmPolicy, + resolveDmGroupAccessWithLists, + resolveEffectiveAllowFromLists, +} from "../security/dm-policy-shared.js"; diff --git a/src/plugin-sdk/channel-runtime.ts b/src/plugin-sdk/channel-runtime.ts index 4fda751b6cb..fad81c36d59 100644 --- a/src/plugin-sdk/channel-runtime.ts +++ b/src/plugin-sdk/channel-runtime.ts @@ -42,6 +42,7 @@ export * from "../channels/plugins/status-issues/shared.js"; export * from "../channels/plugins/whatsapp-heartbeat.js"; export * from "../infra/outbound/send-deps.js"; export * from "../utils/message-channel.js"; +export * from "./channel-lifecycle.js"; export type { InteractiveButtonStyle, InteractiveReplyButton, diff --git a/src/plugin-sdk/compat.ts b/src/plugin-sdk/compat.ts index 8e893de15df..9f723eff1fa 100644 --- a/src/plugin-sdk/compat.ts +++ b/src/plugin-sdk/compat.ts @@ -1 +1,28 @@ -export * from "./index.js"; +// Legacy compat surface for external plugins that still depend on older +// broad plugin-sdk imports. Keep this file intentionally small. + +export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { resolveControlCommandGate } from "../channels/command-gating.js"; + +export { createAccountStatusSink } from "./channel-lifecycle.js"; +export { createPluginRuntimeStore } from "./runtime-store.js"; +export { KeyedAsyncQueue } from "./keyed-async-queue.js"; + +export { + createScopedAccountConfigAccessors, + createScopedChannelConfigBase, + createScopedDmSecurityResolver, + mapAllowFromEntries, +} from "./channel-config-helpers.js"; +export { formatAllowFromLowercase, formatNormalizedAllowFromEntries } from "./allow-from.js"; +export * from "./channel-config-schema.js"; +export * from "./channel-policy.js"; +export * from "./reply-history.js"; +export * from "./directory-runtime.js"; +export { mapAllowlistResolutionInputs } from "./allowlist-resolution.js"; + +export { + resolveBlueBubblesGroupRequireMention, + resolveBlueBubblesGroupToolPolicy, +} from "../channels/plugins/group-mentions.js"; +export { collectBlueBubblesStatusIssues } from "../channels/plugins/status-issues/bluebubbles.js"; diff --git a/src/plugin-sdk/core.ts b/src/plugin-sdk/core.ts index 13b075e3352..fda11949c4e 100644 --- a/src/plugin-sdk/core.ts +++ b/src/plugin-sdk/core.ts @@ -39,36 +39,9 @@ export type { UsageProviderId, UsageWindow, } from "../infra/provider-usage.types.js"; -export type { - ChannelMessageActionContext, - ChannelPlugin, - OpenClawPluginApi, - PluginRuntime, -} from "./channel-plugin-common.js"; +export type { ChannelMessageActionContext } from "../channels/plugins/types.js"; +export type { ChannelPlugin } from "../channels/plugins/types.plugin.js"; +export type { OpenClawPluginApi } from "../plugins/types.js"; +export type { PluginRuntime } from "../plugins/runtime/types.js"; -export { emptyPluginConfigSchema } from "./channel-plugin-common.js"; -export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; -export { - DEFAULT_SECRET_FILE_MAX_BYTES, - loadSecretFileSync, - readSecretFileSync, - tryReadSecretFileSync, -} from "../infra/secret-file.js"; -export type { SecretFileReadOptions, SecretFileReadResult } from "../infra/secret-file.js"; - -export { resolveGatewayBindUrl } from "../shared/gateway-bind-url.js"; -export type { GatewayBindUrlResult } from "../shared/gateway-bind-url.js"; - -export { resolveTailnetHostWithRunner } from "../shared/tailscale-status.js"; -export type { - TailscaleStatusCommandResult, - TailscaleStatusCommandRunner, -} from "../shared/tailscale-status.js"; -export { - buildAgentSessionKey, - type RoutePeer, - type RoutePeerKind, -} from "../routing/resolve-route.js"; -export { resolveThreadSessionKeys } from "../routing/session-key.js"; -export { runPassiveAccountLifecycle } from "./channel-lifecycle.js"; -export { createLoggerBackedRuntime } from "./runtime.js"; +export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; diff --git a/src/plugin-sdk/directory-runtime.ts b/src/plugin-sdk/directory-runtime.ts new file mode 100644 index 00000000000..afb0ca41822 --- /dev/null +++ b/src/plugin-sdk/directory-runtime.ts @@ -0,0 +1,9 @@ +/** Shared directory listing helpers for plugins that derive users/groups from config maps. */ +export { + applyDirectoryQueryAndLimit, + listDirectoryGroupEntriesFromMapKeys, + listDirectoryGroupEntriesFromMapKeysAndAllowFrom, + listDirectoryUserEntriesFromAllowFrom, + listDirectoryUserEntriesFromAllowFromAndMapKeys, + toDirectoryEntries, +} from "../channels/plugins/directory-config-helpers.js"; diff --git a/src/plugin-sdk/index.test.ts b/src/plugin-sdk/index.test.ts index 334f4831853..178c0e20b22 100644 --- a/src/plugin-sdk/index.test.ts +++ b/src/plugin-sdk/index.test.ts @@ -58,62 +58,11 @@ describe("plugin-sdk exports", () => { } }); - // Verify critical functions that extensions depend on are exported and callable. - // Regression guard for #27569 where isDangerousNameMatchingEnabled was missing - // from the compiled output, breaking mattermost/googlechat/msteams/irc plugins. - it("exports critical functions used by channel extensions", () => { - const requiredFunctions = [ - "isDangerousNameMatchingEnabled", - "createAccountListHelpers", - "buildAgentMediaPayload", - "createReplyPrefixOptions", - "createTypingCallbacks", - "logInboundDrop", - "logTypingFailure", - "buildPendingHistoryContextFromMap", - "clearHistoryEntriesIfEnabled", - "recordPendingHistoryEntryIfEnabled", - "resolveControlCommandGate", - "resolveDmGroupAccessWithLists", - "resolveAllowlistProviderRuntimeGroupPolicy", - "resolveDefaultGroupPolicy", - "resolveChannelMediaMaxBytes", - "warnMissingProviderGroupPolicyFallbackOnce", - "createDedupeCache", - "formatInboundFromLabel", - "resolveRuntimeGroupPolicy", - "emptyPluginConfigSchema", - "normalizePluginHttpPath", - "registerPluginHttpRoute", - "buildBaseAccountStatusSnapshot", - "buildBaseChannelStatusSummary", - "buildTokenChannelStatusSummary", - "collectStatusIssuesFromLastError", - "createDefaultChannelRuntimeState", - "resolveChannelEntryMatch", - "resolveChannelEntryMatchWithFallback", - "normalizeChannelSlug", - "buildChannelKeyCandidates", - ]; - - for (const key of requiredFunctions) { - expect(sdk).toHaveProperty(key); - expect(typeof (sdk as Record)[key]).toBe("function"); - } - }); - - // Verify critical constants that extensions depend on are exported. - it("exports critical constants used by channel extensions", () => { - const requiredConstants = [ - "DEFAULT_GROUP_HISTORY_LIMIT", - "DEFAULT_ACCOUNT_ID", - "SILENT_REPLY_TOKEN", - "PAIRING_APPROVED_MESSAGE", - ]; - - for (const key of requiredConstants) { - expect(sdk).toHaveProperty(key); - } + it("keeps the root runtime surface intentionally small", () => { + expect(typeof sdk.emptyPluginConfigSchema).toBe("function"); + expect(Object.prototype.hasOwnProperty.call(sdk, "resolveControlCommandGate")).toBe(false); + expect(Object.prototype.hasOwnProperty.call(sdk, "buildAgentSessionKey")).toBe(false); + expect(Object.prototype.hasOwnProperty.call(sdk, "isDangerousNameMatchingEnabled")).toBe(false); }); it("emits importable bundled subpath entries", { timeout: 240_000 }, async () => { diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index 1e926c098ab..20af3448e8f 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -1,829 +1,49 @@ -export { createAccountListHelpers } from "../channels/plugins/account-helpers.js"; -export { createAccountActionGate } from "../channels/plugins/account-action-gate.js"; -export { CHANNEL_MESSAGE_ACTION_NAMES } from "../channels/plugins/message-action-names.js"; -export { - BLUEBUBBLES_ACTIONS, - BLUEBUBBLES_ACTION_NAMES, - BLUEBUBBLES_GROUP_ACTIONS, -} from "../channels/plugins/bluebubbles-actions.js"; +// Shared root plugin-sdk surface. +// Keep this entry intentionally tiny. Channel/provider helpers belong on +// dedicated subpaths or, for legacy consumers, the compat surface. + export type { ChannelAccountSnapshot, - ChannelAccountState, ChannelAgentTool, ChannelAgentToolFactory, - ChannelAuthAdapter, ChannelCapabilities, - ChannelCommandAdapter, - ChannelConfigAdapter, - ChannelDirectoryAdapter, - ChannelDirectoryEntry, - ChannelDirectoryEntryKind, - ChannelElevatedAdapter, - ChannelGatewayAdapter, ChannelGatewayContext, - ChannelGroupAdapter, - ChannelGroupContext, - ChannelHeartbeatAdapter, - ChannelHeartbeatDeps, ChannelId, - ChannelLogSink, - ChannelLoginWithQrStartResult, - ChannelLoginWithQrWaitResult, - ChannelLogoutContext, - ChannelLogoutResult, - ChannelMentionAdapter, ChannelMessageActionAdapter, ChannelMessageActionContext, ChannelMessageActionName, - ChannelMessagingAdapter, - ChannelMeta, - ChannelOutboundAdapter, - ChannelOutboundContext, - ChannelOutboundTargetMode, - ChannelPairingAdapter, - ChannelPollContext, - ChannelPollResult, - ChannelResolveKind, - ChannelResolveResult, - ChannelResolverAdapter, - ChannelSecurityAdapter, - ChannelSecurityContext, - ChannelSecurityDmPolicy, - ChannelSetupAdapter, - ChannelSetupInput, - ChannelStatusAdapter, ChannelStatusIssue, - ChannelStreamingAdapter, - ChannelThreadingAdapter, - ChannelThreadingContext, - ChannelThreadingToolContext, - ChannelToolSend, - BaseProbeResult, - BaseTokenResolution, } from "../channels/plugins/types.js"; export type { ChannelConfigSchema, ChannelPlugin } from "../channels/plugins/types.plugin.js"; -export type { - ChannelSetupConfigureContext, - ChannelSetupDmPolicy, - ChannelSetupInteractiveContext, - ChannelSetupPlugin, - ChannelSetupResult, - ChannelSetupStatus, - ChannelSetupStatusContext, - ChannelSetupWizardAdapter, -} from "../channels/plugins/setup-wizard-types.js"; +export type { ChannelSetupAdapter, ChannelSetupInput } from "../channels/plugins/types.js"; export type { ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, - ChannelSetupWizardCredential, - ChannelSetupWizardCredentialState, - ChannelSetupWizardFinalize, - ChannelSetupWizardGroupAccess, - ChannelSetupWizardPrepare, - ChannelSetupWizardStatus, - ChannelSetupWizardTextInput, } from "../channels/plugins/setup-wizard.js"; -export type { - AcpRuntimeCapabilities, - AcpRuntimeControl, - AcpRuntimeDoctorReport, - AcpRuntime, - AcpRuntimeEnsureInput, - AcpRuntimeEvent, - AcpRuntimeHandle, - AcpRuntimePromptMode, - AcpSessionUpdateTag, - AcpRuntimeSessionMode, - AcpRuntimeStatus, - AcpRuntimeTurnInput, -} from "../acp/runtime/types.js"; -export type { AcpRuntimeBackend } from "../acp/runtime/registry.js"; -export { - getAcpRuntimeBackend, - registerAcpRuntimeBackend, - requireAcpRuntimeBackend, - unregisterAcpRuntimeBackend, -} from "../acp/runtime/registry.js"; -export { ACP_ERROR_CODES, AcpRuntimeError } from "../acp/runtime/errors.js"; -export type { AcpRuntimeErrorCode } from "../acp/runtime/errors.js"; export type { AnyAgentTool, MediaUnderstandingProviderPlugin, - OpenClawPluginConfigSchema, OpenClawPluginApi, - OpenClawPluginService, - OpenClawPluginServiceContext, - PluginHookInboundClaimContext, - PluginHookInboundClaimEvent, - PluginHookInboundClaimResult, - PluginInteractiveDiscordHandlerContext, - PluginInteractiveHandlerRegistration, - PluginInteractiveSlackHandlerContext, - PluginInteractiveTelegramHandlerContext, + OpenClawPluginConfigSchema, PluginLogger, ProviderAuthContext, - ProviderAuthDoctorHintContext, ProviderAuthResult, - ProviderAugmentModelCatalogContext, - ProviderBuiltInModelSuppressionContext, - ProviderBuiltInModelSuppressionResult, - ProviderBuildMissingAuthMessageContext, - ProviderCacheTtlEligibilityContext, - ProviderDefaultThinkingPolicyContext, - ProviderFetchUsageSnapshotContext, - ProviderModernModelPolicyContext, - ProviderPreparedRuntimeAuth, - ProviderResolvedUsageAuth, - ProviderPrepareExtraParamsContext, - ProviderPrepareDynamicModelContext, - ProviderPrepareRuntimeAuthContext, - ProviderResolveUsageAuthContext, - ProviderResolveDynamicModelContext, - ProviderNormalizeResolvedModelContext, ProviderRuntimeModel, SpeechProviderPlugin, - ProviderThinkingPolicyContext, - ProviderWrapStreamFnContext, } from "../plugins/types.js"; -export type { - ProviderUsageSnapshot, - UsageProviderId, - UsageWindow, -} from "../infra/provider-usage.types.js"; -export type { - ConversationRef, - SessionBindingBindInput, - SessionBindingCapabilities, - SessionBindingRecord, - SessionBindingService, - SessionBindingUnbindInput, -} from "../infra/outbound/session-binding-service.js"; -export type { - GatewayRequestHandler, - GatewayRequestHandlerOptions, - RespondFn, -} from "../gateway/server-methods/types.js"; export type { PluginRuntime, RuntimeLogger, SubagentRunParams, SubagentRunResult, - SubagentWaitParams, - SubagentWaitResult, - SubagentGetSessionMessagesParams, - SubagentGetSessionMessagesResult, - SubagentGetSessionParams, - SubagentGetSessionResult, - SubagentDeleteSessionParams, } from "../plugins/runtime/types.js"; -export { normalizePluginHttpPath } from "../plugins/http-path.js"; -export { registerPluginHttpRoute } from "../plugins/http-registry.js"; -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; export type { OpenClawConfig } from "../config/config.js"; /** @deprecated Use OpenClawConfig instead */ export type { OpenClawConfig as ClawdbotConfig } from "../config/config.js"; -export { isDangerousNameMatchingEnabled } from "../config/dangerous-name-matching.js"; -export * from "./speech.js"; - -export type { FileLockHandle, FileLockOptions } from "./file-lock.js"; -export { acquireFileLock, withFileLock } from "./file-lock.js"; -export * from "./media-understanding.js"; -export { - mapAllowlistResolutionInputs, - mapBasicAllowlistResolutionEntries, - type BasicAllowlistResolutionEntry, -} from "./allowlist-resolution.js"; -export * from "./provider-web-search.js"; -export { resolveRequestUrl } from "./request-url.js"; -export { - buildDiscordSendMediaOptions, - buildDiscordSendOptions, - tagDiscordChannelResult, -} from "./discord-send.js"; -export type { KeyedAsyncQueueHooks } from "./keyed-async-queue.js"; -export { enqueueKeyedTask, KeyedAsyncQueue } from "./keyed-async-queue.js"; -export { normalizeWebhookPath, resolveWebhookPath } from "./webhook-path.js"; -export { - registerWebhookTarget, - registerWebhookTargetWithPluginRoute, - rejectNonPostWebhookRequest, - resolveWebhookTargetWithAuthOrReject, - resolveWebhookTargetWithAuthOrRejectSync, - resolveSingleWebhookTarget, - resolveSingleWebhookTargetAsync, - resolveWebhookTargets, - withResolvedWebhookRequestPipeline, -} from "./webhook-targets.js"; -export type { - RegisterWebhookPluginRouteOptions, - RegisterWebhookTargetOptions, - WebhookTargetMatchResult, -} from "./webhook-targets.js"; -export { - applyBasicWebhookRequestGuards, - beginWebhookRequestPipelineOrReject, - createWebhookInFlightLimiter, - isJsonContentType, - readWebhookBodyOrReject, - readJsonWebhookBodyOrReject, - WEBHOOK_BODY_READ_DEFAULTS, - WEBHOOK_IN_FLIGHT_DEFAULTS, -} from "./webhook-request-guards.js"; -export type { WebhookBodyReadProfile, WebhookInFlightLimiter } from "./webhook-request-guards.js"; -export { - createAccountStatusSink, - keepHttpServerTaskAlive, - runPassiveAccountLifecycle, - waitUntilAbort, -} from "./channel-lifecycle.js"; -export type { AgentMediaPayload } from "./agent-media-payload.js"; -export { buildAgentMediaPayload } from "./agent-media-payload.js"; -export { - buildBaseAccountStatusSnapshot, - buildBaseChannelStatusSummary, - buildComputedAccountStatusSnapshot, - buildProbeChannelStatusSummary, - buildRuntimeAccountStatusSnapshot, - buildTokenChannelStatusSummary, - collectStatusIssuesFromLastError, - createDefaultChannelRuntimeState, -} from "./status-helpers.js"; -export { - normalizeAllowFromEntries, - noteChannelLookupFailure, - noteChannelLookupSummary, - parseMentionOrPrefixedId, - parseSetupEntriesAllowingWildcard, - patchChannelConfigForAccount, - promptLegacyChannelAllowFrom, - promptParsedAllowFromForScopedChannel, - promptResolvedAllowFrom, - resolveSetupAccountId, - setAccountGroupPolicyForChannel, - setChannelDmPolicyWithAllowFrom, - setLegacyChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, - splitSetupEntries, - promptSingleChannelSecretInput, - type SingleChannelSecretInputPromptResult, -} from "../channels/plugins/setup-wizard-helpers.js"; -export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; -export { formatResolvedUnresolvedNote } from "./resolution-notes.js"; -export { buildChannelSendResult } from "./channel-send-result.js"; -export type { ChannelSendRawResult } from "./channel-send-result.js"; -export { createPluginRuntimeStore } from "./runtime-store.js"; -export { createScopedChannelConfigBase } from "./channel-config-helpers.js"; -export { - buildAccountScopedAllowlistConfigEditor, - resolveLegacyDmAllowlistConfigPaths, -} from "./allowlist-config-edit.js"; -export { - AllowFromEntrySchema, - AllowFromListSchema, - buildNestedDmConfigSchema, - buildCatchallMultiAccountChannelSchema, -} from "../channels/plugins/config-schema.js"; -export { getChatChannelMeta } from "../channels/registry.js"; -export { - compileAllowlist, - resolveAllowlistCandidates, - resolveAllowlistMatchByCandidates, -} from "../channels/allowlist-match.js"; -export type { - BlockStreamingCoalesceConfig, - DmPolicy, - DmConfig, - GroupPolicy, - GroupToolPolicyConfig, - GroupToolPolicyBySenderConfig, - MarkdownConfig, - MarkdownTableMode, - GoogleChatAccountConfig, - GoogleChatConfig, - GoogleChatDmConfig, - GoogleChatGroupConfig, - GoogleChatActionConfig, - MSTeamsChannelConfig, - MSTeamsConfig, - MSTeamsReplyStyle, - MSTeamsTeamConfig, -} from "../config/types.js"; -export { - GROUP_POLICY_BLOCKED_LABEL, - resetMissingProviderGroupPolicyFallbackWarningsForTesting, - resolveAllowlistProviderRuntimeGroupPolicy, - resolveDefaultGroupPolicy, - resolveOpenProviderRuntimeGroupPolicy, - resolveRuntimeGroupPolicy, - type GroupPolicyDefaultsConfig, - type RuntimeGroupPolicyResolution, - type RuntimeGroupPolicyParams, - type ResolveProviderRuntimeGroupPolicyParams, - warnMissingProviderGroupPolicyFallbackOnce, -} from "../config/runtime-group-policy.js"; -export { - DiscordConfigSchema, - GoogleChatConfigSchema, - IMessageConfigSchema, - MSTeamsConfigSchema, - SignalConfigSchema, - SlackConfigSchema, - TelegramConfigSchema, -} from "../config/zod-schema.providers-core.js"; -export { WhatsAppConfigSchema } from "../config/zod-schema.providers-whatsapp.js"; -export { - BlockStreamingCoalesceSchema, - DmConfigSchema, - DmPolicySchema, - GroupPolicySchema, - MarkdownConfigSchema, - MarkdownTableModeSchema, - normalizeAllowFrom, - ReplyRuntimeConfigSchemaShape, - requireOpenAllowFrom, - SecretInputSchema, - TtsAutoSchema, - TtsConfigSchema, - TtsModeSchema, - TtsProviderSchema, -} from "../config/zod-schema.core.js"; -export { - assertSecretInputResolved, - hasConfiguredSecretInput, - isSecretRef, - normalizeResolvedSecretInputString, - normalizeSecretInputString, -} from "../config/types.secrets.js"; export type { SecretInput, SecretRef } from "../config/types.secrets.js"; -export { ToolPolicySchema } from "../config/zod-schema.agent-runtime.js"; export type { RuntimeEnv } from "../runtime.js"; -export type { WizardPrompter } from "../wizard/prompts.js"; -export { - DEFAULT_ACCOUNT_ID, - normalizeAccountId, - normalizeAgentId, - resolveThreadSessionKeys, -} from "../routing/session-key.js"; -export { buildAgentSessionKey, type RoutePeer } from "../routing/resolve-route.js"; -export { - formatAllowFromLowercase, - formatNormalizedAllowFromEntries, - isAllowedParsedChatSender, - isNormalizedSenderAllowed, -} from "./allow-from.js"; -export { - evaluateGroupRouteAccessForPolicy, - evaluateMatchedGroupAccessForPolicy, - evaluateSenderGroupAccess, - evaluateSenderGroupAccessForPolicy, - resolveSenderScopedGroupPolicy, - type GroupRouteAccessDecision, - type GroupRouteAccessReason, - type MatchedGroupAccessDecision, - type MatchedGroupAccessReason, - type SenderGroupAccessDecision, - type SenderGroupAccessReason, -} from "./group-access.js"; -export { - resolveDirectDmAuthorizationOutcome, - resolveSenderCommandAuthorization, - resolveSenderCommandAuthorizationWithRuntime, -} from "./command-auth.js"; -export type { CommandAuthorizationRuntime } from "./command-auth.js"; -export { createScopedPairingAccess } from "./pairing-access.js"; -export { - createInboundEnvelopeBuilder, - resolveInboundRouteEnvelopeBuilder, - resolveInboundRouteEnvelopeBuilderWithRuntime, -} from "./inbound-envelope.js"; -export { resolveInboundSessionEnvelopeContext } from "../channels/session-envelope.js"; -export { - listConfiguredAccountIds, - resolveAccountWithDefaultFallback, -} from "./account-resolution.js"; -export { resolveAccountEntry } from "../routing/account-lookup.js"; -export { issuePairingChallenge } from "../pairing/pairing-challenge.js"; -export { handleSlackMessageAction } from "./slack-message-actions.js"; -export { extractToolSend } from "./tool-send.js"; -export { - createNormalizedOutboundDeliverer, - formatTextWithAttachmentLinks, - isNumericTargetId, - normalizeOutboundReplyPayload, - resolveOutboundMediaUrls, - sendPayloadWithChunkedTextAndMedia, - sendMediaWithLeadingCaption, -} from "./reply-payload.js"; -export type { OutboundReplyPayload } from "./reply-payload.js"; -export { - buildInboundReplyDispatchBase, - dispatchInboundReplyWithBase, - dispatchReplyFromConfigWithSettledDispatcher, - recordInboundSessionAndDispatchReply, -} from "./inbound-reply-dispatch.js"; -export type { OutboundMediaLoadOptions } from "./outbound-media.js"; -export { loadOutboundMediaFromUrl } from "./outbound-media.js"; -export { resolveChannelAccountConfigBasePath } from "./config-paths.js"; -export { buildMediaPayload } from "../channels/plugins/media-payload.js"; -export type { MediaPayload, MediaPayloadInput } from "../channels/plugins/media-payload.js"; -export { - createLoggerBackedRuntime, - resolveRuntimeEnv, - resolveRuntimeEnvWithUnavailableExit, -} from "./runtime.js"; -export { detectBinary } from "../plugins/setup-binary.js"; -export { installSignalCli } from "../plugins/signal-cli-install.js"; -export { chunkTextForOutbound } from "./text-chunking.js"; -export { resolveTextChunkLimit } from "../auto-reply/chunk.js"; -export { readBooleanParam } from "./boolean-param.js"; -export { readJsonFileWithFallback, writeJsonFileAtomically } from "./json-store.js"; -export { generatePkceVerifierChallenge, toFormUrlEncoded } from "./oauth-utils.js"; -export { buildRandomTempFilePath, withTempDownloadPath } from "./temp-path.js"; -export { - applyWindowsSpawnProgramPolicy, - materializeWindowsSpawnProgram, - resolveWindowsExecutablePath, - resolveWindowsSpawnProgramCandidate, - resolveWindowsSpawnProgram, -} from "./windows-spawn.js"; -export type { - ResolveWindowsSpawnProgramCandidateParams, - ResolveWindowsSpawnProgramParams, - WindowsSpawnCandidateResolution, - WindowsSpawnInvocation, - WindowsSpawnProgramCandidate, - WindowsSpawnProgram, - WindowsSpawnResolution, -} from "./windows-spawn.js"; -export { resolvePreferredOpenClawTmpDir } from "../infra/tmp-openclaw-dir.js"; -export { - runPluginCommandWithTimeout, - type PluginCommandRunOptions, - type PluginCommandRunResult, -} from "./run-command.js"; -export { resolveGatewayBindUrl } from "../shared/gateway-bind-url.js"; -export type { GatewayBindUrlResult } from "../shared/gateway-bind-url.js"; -export { resolveTailnetHostWithRunner } from "../shared/tailscale-status.js"; -export type { - TailscaleStatusCommandResult, - TailscaleStatusCommandRunner, -} from "../shared/tailscale-status.js"; -export type { ChatType } from "../channels/chat-type.js"; -export { normalizeChatType } from "../channels/chat-type.js"; -/** @deprecated Use ChatType instead */ -export type { RoutePeerKind } from "../routing/resolve-route.js"; -export { resolveAckReaction } from "../agents/identity.js"; -export type { ReplyPayload } from "../auto-reply/types.js"; -export type { ChunkMode } from "../auto-reply/chunk.js"; -export { SILENT_REPLY_TOKEN, isSilentReplyText } from "../auto-reply/tokens.js"; -export { formatInboundFromLabel } from "../auto-reply/envelope.js"; -export { - createScopedAccountConfigAccessors, - formatTrimmedAllowFromEntries, - mapAllowFromEntries, - resolveOptionalConfigString, - createScopedDmSecurityResolver, - formatWhatsAppConfigAllowFromEntries, - resolveIMessageConfigAllowFrom, - resolveIMessageConfigDefaultTo, - resolveWhatsAppConfigAllowFrom, - resolveWhatsAppConfigDefaultTo, -} from "./channel-config-helpers.js"; -export { - approveDevicePairing, - listDevicePairing, - rejectDevicePairing, -} from "../infra/device-pairing.js"; -export { createDedupeCache } from "../infra/dedupe.js"; -export type { DedupeCache } from "../infra/dedupe.js"; -export { createPersistentDedupe } from "./persistent-dedupe.js"; -export type { - PersistentDedupe, - PersistentDedupeCheckOptions, - PersistentDedupeOptions, -} from "./persistent-dedupe.js"; -export { formatErrorMessage } from "../infra/errors.js"; -export { resolveFetch } from "../infra/fetch.js"; -export { - formatUtcTimestamp, - formatZonedTimestamp, - resolveTimezone, -} from "../infra/format-time/format-datetime.js"; -export { - DEFAULT_WEBHOOK_BODY_TIMEOUT_MS, - DEFAULT_WEBHOOK_MAX_BODY_BYTES, - RequestBodyLimitError, - installRequestBodyLimitGuard, - isRequestBodyLimitError, - readJsonBodyWithLimit, - readRequestBodyWithLimit, - requestBodyErrorToText, -} from "../infra/http-body.js"; -export { - WEBHOOK_ANOMALY_COUNTER_DEFAULTS, - WEBHOOK_ANOMALY_STATUS_CODES, - WEBHOOK_RATE_LIMIT_DEFAULTS, - createBoundedCounter, - createFixedWindowRateLimiter, - createWebhookAnomalyTracker, -} from "./webhook-memory-guards.js"; -export type { - BoundedCounter, - FixedWindowRateLimiter, - WebhookAnomalyTracker, -} from "./webhook-memory-guards.js"; - -export { fetchWithSsrFGuard } from "../infra/net/fetch-guard.js"; -export { - SsrFBlockedError, - isBlockedHostname, - isBlockedHostnameOrIp, - isPrivateIpAddress, -} from "../infra/net/ssrf.js"; -export type { LookupFn, SsrFPolicy } from "../infra/net/ssrf.js"; -export { - buildHostnameAllowlistPolicyFromSuffixAllowlist, - isHttpsUrlAllowedByHostnameSuffixAllowlist, - normalizeHostnameSuffixAllowlist, -} from "./ssrf-policy.js"; -export { fetchWithBearerAuthScopeFallback } from "./fetch-auth.js"; -export type { ScopeTokenProvider } from "./fetch-auth.js"; -export { rawDataToString } from "../infra/ws.js"; -export { isWSLSync, isWSL2Sync, isWSLEnv } from "../infra/wsl.js"; -export { isTruthyEnvValue } from "../infra/env.js"; -export { resolveChannelGroupRequireMention, resolveToolsBySender } from "../config/group-policy.js"; -export { - buildPendingHistoryContextFromMap, - clearHistoryEntries, - clearHistoryEntriesIfEnabled, - DEFAULT_GROUP_HISTORY_LIMIT, - evictOldHistoryKeys, - recordPendingHistoryEntry, - recordPendingHistoryEntryIfEnabled, -} from "../auto-reply/reply/history.js"; -export type { HistoryEntry } from "../auto-reply/reply/history.js"; -export { mergeAllowlist, summarizeMapping } from "../channels/allowlists/resolve-utils.js"; -export { - resolveMentionGating, - resolveMentionGatingWithBypass, -} from "../channels/mention-gating.js"; -export type { - AckReactionGateParams, - AckReactionScope, - WhatsAppAckReactionMode, -} from "../channels/ack-reactions.js"; -export { - removeAckReactionAfterReply, - shouldAckReaction, - shouldAckReactionForWhatsApp, -} from "../channels/ack-reactions.js"; -export { createTypingCallbacks } from "../channels/typing.js"; -export { createReplyPrefixContext, createReplyPrefixOptions } from "../channels/reply-prefix.js"; -export { logAckFailure, logInboundDrop, logTypingFailure } from "../channels/logging.js"; -export { resolveChannelMediaMaxBytes } from "../channels/plugins/media-limits.js"; -export type { NormalizedLocation } from "../channels/location.js"; -export { formatLocationText, toLocationContext } from "../channels/location.js"; -export { resolveControlCommandGate } from "../channels/command-gating.js"; -export { - resolveBlueBubblesGroupRequireMention, - resolveDiscordGroupRequireMention, - resolveGoogleChatGroupRequireMention, - resolveIMessageGroupRequireMention, - resolveSlackGroupRequireMention, - resolveTelegramGroupRequireMention, - resolveWhatsAppGroupRequireMention, - resolveBlueBubblesGroupToolPolicy, - resolveDiscordGroupToolPolicy, - resolveGoogleChatGroupToolPolicy, - resolveIMessageGroupToolPolicy, - resolveSlackGroupToolPolicy, - resolveTelegramGroupToolPolicy, - resolveWhatsAppGroupToolPolicy, -} from "../channels/plugins/group-mentions.js"; -export { recordInboundSession } from "../channels/session.js"; -export { - buildChannelKeyCandidates, - normalizeChannelSlug, - resolveChannelEntryMatch, - resolveChannelEntryMatchWithFallback, - resolveNestedAllowlistDecision, -} from "../channels/plugins/channel-config.js"; -export { - listDiscordDirectoryGroupsFromConfig, - listDiscordDirectoryPeersFromConfig, - listSlackDirectoryGroupsFromConfig, - listSlackDirectoryPeersFromConfig, - listTelegramDirectoryGroupsFromConfig, - listTelegramDirectoryPeersFromConfig, - listWhatsAppDirectoryGroupsFromConfig, - listWhatsAppDirectoryPeersFromConfig, -} from "../channels/plugins/directory-config.js"; -export type { AllowlistMatch } from "../channels/plugins/allowlist-match.js"; -export { - formatAllowlistMatchMeta, - resolveAllowlistMatchSimple, -} from "../channels/plugins/allowlist-match.js"; -export { optionalStringEnum, stringEnum } from "../agents/schema/typebox.js"; -export type { PollInput } from "../polls.js"; - -export { buildChannelConfigSchema } from "../channels/plugins/config-schema.js"; -export { - listDirectoryGroupEntriesFromMapKeys, - listDirectoryGroupEntriesFromMapKeysAndAllowFrom, - listDirectoryUserEntriesFromAllowFrom, - listDirectoryUserEntriesFromAllowFromAndMapKeys, -} from "../channels/plugins/directory-config-helpers.js"; -export { - clearAccountEntryFields, - deleteAccountFromConfigSection, - setAccountEnabledInConfigSection, -} from "../channels/plugins/config-helpers.js"; -export { - applyAccountNameToChannelSection, - applySetupAccountConfigPatch, - migrateBaseNameToDefaultAccount, - patchScopedAccountConfig, -} from "../channels/plugins/setup-helpers.js"; -export { - buildOpenGroupPolicyConfigureRouteAllowlistWarning, - buildOpenGroupPolicyNoRouteAllowlistWarning, - buildOpenGroupPolicyRestrictSendersWarning, - buildOpenGroupPolicyWarning, - collectAllowlistProviderGroupPolicyWarnings, - collectAllowlistProviderRestrictSendersWarnings, - collectOpenProviderGroupPolicyWarnings, - collectOpenGroupPolicyConfiguredRouteWarnings, - collectOpenGroupPolicyRestrictSendersWarnings, - collectOpenGroupPolicyRouteAllowlistWarnings, -} from "../channels/plugins/group-policy-warnings.js"; -export { - buildAccountScopedDmSecurityPolicy, - formatPairingApproveHint, -} from "../channels/plugins/helpers.js"; -export { PAIRING_APPROVED_MESSAGE } from "../channels/plugins/pairing-message.js"; - -export { - createActionGate, - jsonResult, - readNumberParam, - readReactionParams, - readStringParam, -} from "../agents/tools/common.js"; -export { formatDocsLink } from "../terminal/links.js"; -export { formatCliCommand } from "../cli/command-format.js"; -export { - DM_GROUP_ACCESS_REASON, - readStoreAllowFromForDmPolicy, - resolveDmAllowState, - resolveDmGroupAccessDecision, - resolveDmGroupAccessWithCommandGate, - resolveDmGroupAccessWithLists, - resolveEffectiveAllowFromLists, -} from "../security/dm-policy-shared.js"; -export type { DmGroupAccessReasonCode } from "../security/dm-policy-shared.js"; export type { HookEntry } from "../hooks/types.js"; -export { - clamp, - escapeRegExp, - isRecord, - normalizeE164, - pathExists, - resolveUserPath, - safeParseJson, - sleep, -} from "../utils.js"; -export { fetchWithTimeout } from "../utils/fetch-timeout.js"; -export { - DEFAULT_SECRET_FILE_MAX_BYTES, - loadSecretFileSync, - readSecretFileSync, - tryReadSecretFileSync, -} from "../infra/secret-file.js"; -export { stripAnsi } from "../terminal/ansi.js"; -export { missingTargetError } from "../infra/outbound/target-errors.js"; -export { registerLogTransport } from "../logging/logger.js"; -export type { LogTransport, LogTransportRecord } from "../logging/logger.js"; -export { - emitDiagnosticEvent, - isDiagnosticsEnabled, - onDiagnosticEvent, -} from "../infra/diagnostic-events.js"; -export type { - DiagnosticEventPayload, - DiagnosticHeartbeatEvent, - DiagnosticLaneDequeueEvent, - DiagnosticLaneEnqueueEvent, - DiagnosticMessageProcessedEvent, - DiagnosticMessageQueuedEvent, - DiagnosticRunAttemptEvent, - DiagnosticSessionState, - DiagnosticSessionStateEvent, - DiagnosticSessionStuckEvent, - DiagnosticUsageEvent, - DiagnosticWebhookErrorEvent, - DiagnosticWebhookProcessedEvent, - DiagnosticWebhookReceivedEvent, -} from "../infra/diagnostic-events.js"; -export { loadConfig } from "../config/config.js"; -export { runCommandWithTimeout } from "../process/exec.js"; -export { detectMime, extensionForMime, getFileExtension } from "../media/mime.js"; -export { extractOriginalFilename } from "../media/store.js"; -export { listSkillCommandsForAgents } from "../auto-reply/skill-commands.js"; -export type { SkillCommandSpec } from "../agents/skills.js"; +export type { ReplyPayload } from "../auto-reply/types.js"; +export type { WizardPrompter } from "../wizard/prompts.js"; -// Channel: WhatsApp — WhatsApp-specific exports moved to extensions/whatsapp/src/ -export { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "../whatsapp/normalize.js"; -export { resolveWhatsAppOutboundTarget } from "../whatsapp/resolve-outbound-target.js"; - -// Channel: BlueBubbles -export { collectBlueBubblesStatusIssues } from "../channels/plugins/status-issues/bluebubbles.js"; - -// Channel: LINE -export { - listLineAccountIds, - lineSetupAdapter, - lineSetupWizard, - normalizeAccountId as normalizeLineAccountId, - resolveDefaultLineAccountId, - resolveLineAccount, - LineConfigSchema, -} from "./line.js"; -export type { - LineConfig, - LineAccountConfig, - ResolvedLineAccount, - LineChannelData, -} from "../line/types.js"; -export { - createInfoCard, - createListCard, - createImageCard, - createActionCard, - createReceiptCard, - type CardAction, - type ListItem, -} from "../line/flex-templates.js"; -export { - processLineMessage, - hasMarkdownToConvert, - stripMarkdown, -} from "../line/markdown-to-line.js"; -export type { ProcessedLineMessage } from "../line/markdown-to-line.js"; - -// Media utilities -export { loadWebMedia, type WebMediaResult } from "./web-media.js"; - -// Context engine -export type { - ContextEngine, - ContextEngineInfo, - AssembleResult, - CompactResult, - IngestResult, - IngestBatchResult, - BootstrapResult, - SubagentSpawnPreparation, - SubagentEndReason, -} from "../context-engine/types.js"; -export { registerContextEngine } from "../context-engine/registry.js"; -export type { ContextEngineFactory } from "../context-engine/registry.js"; - -// Model authentication types for plugins. -// Plugins should use runtime.modelAuth (which strips unsafe overrides like -// agentDir/store) rather than importing raw helpers directly. -export { requireApiKey } from "../agents/model-auth.js"; -export type { ResolvedProviderAuth } from "../agents/model-auth.js"; -export type { - ProviderCatalogContext, - ProviderCatalogResult, - ProviderDiscoveryContext, -} from "../plugins/types.js"; -export { - applyProviderDefaultModel, - promptAndConfigureOpenAICompatibleSelfHostedProvider, - SELF_HOSTED_DEFAULT_CONTEXT_WINDOW, - SELF_HOSTED_DEFAULT_COST, - SELF_HOSTED_DEFAULT_MAX_TOKENS, -} from "../plugins/provider-self-hosted-setup.js"; -export { - OLLAMA_DEFAULT_BASE_URL, - OLLAMA_DEFAULT_MODEL, - configureOllamaNonInteractive, - ensureOllamaModelPulled, - promptAndConfigureOllama, -} from "../plugins/provider-ollama-setup.js"; -export { - VLLM_DEFAULT_BASE_URL, - VLLM_DEFAULT_CONTEXT_WINDOW, - VLLM_DEFAULT_COST, - VLLM_DEFAULT_MAX_TOKENS, - promptAndConfigureVllm, -} from "../plugins/provider-vllm-setup.js"; -export { - buildOllamaProvider, - buildSglangProvider, - buildVllmProvider, -} from "../agents/models-config.providers.discovery.js"; - -// Security utilities -export { redactSensitiveText } from "../logging/redact.js"; +export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; diff --git a/src/plugin-sdk/provider-auth.ts b/src/plugin-sdk/provider-auth.ts index baecefe62e9..d30dd81f7d6 100644 --- a/src/plugin-sdk/provider-auth.ts +++ b/src/plugin-sdk/provider-auth.ts @@ -4,6 +4,7 @@ export type { OpenClawConfig } from "../config/config.js"; export type { SecretInput } from "../config/types.secrets.js"; export type { ProviderAuthResult } from "../plugins/types.js"; export type { AuthProfileStore, OAuthCredential } from "../agents/auth-profiles/types.js"; +export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; export { CLAUDE_CLI_PROFILE_ID, diff --git a/src/plugin-sdk/provider-models.ts b/src/plugin-sdk/provider-models.ts index 5694a540075..2ab00992d19 100644 --- a/src/plugin-sdk/provider-models.ts +++ b/src/plugin-sdk/provider-models.ts @@ -1,10 +1,16 @@ // Public model/catalog helpers for provider plugins. -export type { - ModelApi, - ModelDefinitionConfig, - ModelProviderConfig, -} from "../config/types.models.js"; +import type { ModelDefinitionConfig } from "../config/types.models.js"; +import { + KILOCODE_DEFAULT_CONTEXT_WINDOW, + KILOCODE_DEFAULT_COST, + KILOCODE_DEFAULT_MAX_TOKENS, + KILOCODE_DEFAULT_MODEL_ID, + KILOCODE_DEFAULT_MODEL_NAME, +} from "../providers/kilocode-shared.js"; + +export type { ModelApi, ModelProviderConfig } from "../config/types.models.js"; +export type { ModelDefinitionConfig } from "../config/types.models.js"; export type { ProviderPlugin } from "../plugins/types.js"; export { DEFAULT_CONTEXT_TOKENS } from "../agents/defaults.js"; @@ -19,8 +25,48 @@ export { applyOpenAIConfig, OPENAI_DEFAULT_MODEL } from "../plugins/provider-mod export { OPENCODE_GO_DEFAULT_MODEL_REF } from "../plugins/provider-model-defaults.js"; export { OPENCODE_ZEN_DEFAULT_MODEL } from "../plugins/provider-model-defaults.js"; export { OPENCODE_ZEN_DEFAULT_MODEL_REF } from "../agents/opencode-zen-models.js"; - -export * from "../plugins/provider-model-definitions.js"; +export { + buildMinimaxApiModelDefinition, + DEFAULT_MINIMAX_BASE_URL, + MINIMAX_API_BASE_URL, + MINIMAX_CN_API_BASE_URL, + MINIMAX_HOSTED_COST, + MINIMAX_HOSTED_MODEL_ID, + MINIMAX_HOSTED_MODEL_REF, + MINIMAX_LM_STUDIO_COST, +} from "../../extensions/minimax/model-definitions.js"; +export { + buildMistralModelDefinition, + MISTRAL_BASE_URL, + MISTRAL_DEFAULT_MODEL_ID, + MISTRAL_DEFAULT_MODEL_REF, +} from "../../extensions/mistral/model-definitions.js"; +export { + buildModelStudioDefaultModelDefinition, + buildModelStudioModelDefinition, + MODELSTUDIO_CN_BASE_URL, + MODELSTUDIO_DEFAULT_MODEL_ID, + MODELSTUDIO_DEFAULT_MODEL_REF, + MODELSTUDIO_GLOBAL_BASE_URL, +} from "../../extensions/modelstudio/model-definitions.js"; +export { MOONSHOT_BASE_URL } from "../../extensions/moonshot/provider-catalog.js"; +export { MOONSHOT_CN_BASE_URL } from "../../extensions/moonshot/onboard.js"; +export { + buildXaiModelDefinition, + XAI_BASE_URL, + XAI_DEFAULT_MODEL_ID, + XAI_DEFAULT_MODEL_REF, +} from "../../extensions/xai/model-definitions.js"; +export { + buildZaiModelDefinition, + resolveZaiBaseUrl, + ZAI_CODING_CN_BASE_URL, + ZAI_CODING_GLOBAL_BASE_URL, + ZAI_CN_BASE_URL, + ZAI_DEFAULT_MODEL_ID, + ZAI_DEFAULT_MODEL_REF, + ZAI_GLOBAL_BASE_URL, +} from "../../extensions/zai/model-definitions.js"; export { buildCloudflareAiGatewayModelDefinition, @@ -84,3 +130,15 @@ export { discoverVercelAiGatewayModels, VERCEL_AI_GATEWAY_BASE_URL, } from "../agents/vercel-ai-gateway.js"; + +export function buildKilocodeModelDefinition(): ModelDefinitionConfig { + return { + id: KILOCODE_DEFAULT_MODEL_ID, + name: KILOCODE_DEFAULT_MODEL_NAME, + reasoning: true, + input: ["text", "image"], + cost: KILOCODE_DEFAULT_COST, + contextWindow: KILOCODE_DEFAULT_CONTEXT_WINDOW, + maxTokens: KILOCODE_DEFAULT_MAX_TOKENS, + }; +} diff --git a/src/plugin-sdk/reply-history.ts b/src/plugin-sdk/reply-history.ts new file mode 100644 index 00000000000..d327b767a99 --- /dev/null +++ b/src/plugin-sdk/reply-history.ts @@ -0,0 +1,14 @@ +/** Shared reply-history helpers for plugins that keep short per-thread context windows. */ +export type { HistoryEntry } from "../auto-reply/reply/history.js"; +export { + DEFAULT_GROUP_HISTORY_LIMIT, + buildHistoryContext, + buildHistoryContextFromEntries, + buildHistoryContextFromMap, + buildPendingHistoryContextFromMap, + clearHistoryEntries, + clearHistoryEntriesIfEnabled, + evictOldHistoryKeys, + recordPendingHistoryEntry, + recordPendingHistoryEntryIfEnabled, +} from "../auto-reply/reply/history.js"; diff --git a/src/plugin-sdk/root-alias.cjs b/src/plugin-sdk/root-alias.cjs index 8f628bd5e8e..0013b32d21f 100644 --- a/src/plugin-sdk/root-alias.cjs +++ b/src/plugin-sdk/root-alias.cjs @@ -84,7 +84,7 @@ function loadMonolithicSdk() { const jiti = getJiti(); - const distCandidate = path.resolve(__dirname, "..", "..", "dist", "plugin-sdk", "index.js"); + const distCandidate = path.resolve(__dirname, "..", "..", "dist", "plugin-sdk", "compat.js"); if (fs.existsSync(distCandidate)) { try { monolithicSdk = jiti(distCandidate); @@ -94,7 +94,7 @@ function loadMonolithicSdk() { } } - monolithicSdk = jiti(path.join(__dirname, "index.ts")); + monolithicSdk = jiti(path.join(__dirname, "compat.ts")); return monolithicSdk; } diff --git a/src/plugin-sdk/subpaths.test.ts b/src/plugin-sdk/subpaths.test.ts index d7d15f88748..0166fb52081 100644 --- a/src/plugin-sdk/subpaths.test.ts +++ b/src/plugin-sdk/subpaths.test.ts @@ -12,6 +12,8 @@ import * as msteamsSdk from "openclaw/plugin-sdk/msteams"; import * as nostrSdk from "openclaw/plugin-sdk/nostr"; import * as ollamaSetupSdk from "openclaw/plugin-sdk/ollama-setup"; import * as providerSetupSdk from "openclaw/plugin-sdk/provider-setup"; +import * as routingSdk from "openclaw/plugin-sdk/routing"; +import * as runtimeSdk from "openclaw/plugin-sdk/runtime"; import * as sandboxSdk from "openclaw/plugin-sdk/sandbox"; import * as selfHostedProviderSetupSdk from "openclaw/plugin-sdk/self-hosted-provider-setup"; import * as setupSdk from "openclaw/plugin-sdk/setup"; @@ -45,17 +47,25 @@ describe("plugin-sdk subpath exports", () => { expect(typeof compatSdk.resolveControlCommandGate).toBe("function"); }); - it("exports core routing helpers", () => { - expect(typeof coreSdk.buildAgentSessionKey).toBe("function"); - expect(typeof coreSdk.resolveThreadSessionKeys).toBe("function"); - expect(typeof coreSdk.runPassiveAccountLifecycle).toBe("function"); - expect(typeof coreSdk.createLoggerBackedRuntime).toBe("function"); + it("keeps core focused on generic shared exports", () => { + expect(typeof coreSdk.emptyPluginConfigSchema).toBe("function"); + expect("runPassiveAccountLifecycle" in asExports(coreSdk)).toBe(false); + expect("createLoggerBackedRuntime" in asExports(coreSdk)).toBe(false); expect("registerSandboxBackend" in asExports(coreSdk)).toBe(false); expect("promptAndConfigureOpenAICompatibleSelfHostedProviderAuth" in asExports(coreSdk)).toBe( false, ); }); + it("exports routing helpers from the dedicated subpath", () => { + expect(typeof routingSdk.buildAgentSessionKey).toBe("function"); + expect(typeof routingSdk.resolveThreadSessionKeys).toBe("function"); + }); + + it("exports runtime helpers from the dedicated subpath", () => { + expect(typeof runtimeSdk.createLoggerBackedRuntime).toBe("function"); + }); + it("exports provider setup helpers from the dedicated subpath", () => { expect(typeof providerSetupSdk.buildVllmProvider).toBe("function"); expect(typeof providerSetupSdk.discoverOpenAICompatibleSelfHostedProvider).toBe("function"); From 5dd22450942a13345718349f67d167ec6757479c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:47:56 -0700 Subject: [PATCH 062/187] refactor: restore public sdk seams after rebase --- extensions/discord/src/account-inspect.ts | 12 ++--- extensions/discord/src/accounts.ts | 6 +-- .../src/monitor/provider.test-support.ts | 33 +++++++++++++- extensions/discord/src/plugin-shared.ts | 2 +- extensions/discord/src/setup-core.ts | 45 +++++++------------ extensions/discord/src/setup-surface.ts | 2 +- extensions/google/provider-models.ts | 2 +- extensions/imessage/src/accounts.ts | 6 +-- extensions/imessage/src/setup-core.ts | 2 +- extensions/imessage/src/setup-surface.ts | 8 ++-- extensions/imessage/src/shared.ts | 16 +++---- extensions/openai/shared.ts | 4 +- extensions/signal/src/accounts.ts | 6 +-- extensions/signal/src/setup-core.ts | 4 +- extensions/signal/src/setup-surface.ts | 10 +++-- extensions/signal/src/shared.ts | 14 +++--- extensions/slack/src/account-inspect.ts | 12 ++--- extensions/slack/src/accounts.ts | 6 +-- extensions/slack/src/setup-core.ts | 45 +++++++------------ extensions/slack/src/setup-surface.ts | 2 +- extensions/slack/src/shared.ts | 20 +++++---- ...ot-native-commands.fixture-test-support.ts | 34 +++++++------- .../bot-native-commands.menu-test-support.ts | 13 ++++-- extensions/telegram/src/setup-core.ts | 4 +- extensions/tlon/src/setup-core.ts | 8 +--- extensions/whatsapp/src/channel.ts | 30 ++++++------- extensions/whatsapp/src/setup-surface.ts | 6 +-- src/channels/plugins/contracts/registry.ts | 2 +- src/plugin-sdk/provider-models.ts | 1 + src/plugin-sdk/setup.ts | 8 +++- .../contracts/auth-choice.contract.test.ts | 5 ++- 31 files changed, 190 insertions(+), 178 deletions(-) diff --git a/extensions/discord/src/account-inspect.ts b/extensions/discord/src/account-inspect.ts index c10b9a78811..f42410814b3 100644 --- a/extensions/discord/src/account-inspect.ts +++ b/extensions/discord/src/account-inspect.ts @@ -1,13 +1,13 @@ -import { - hasConfiguredSecretInput, - normalizeSecretInputString, -} from "openclaw/plugin-sdk/config-runtime"; -import type { DiscordAccountConfig } from "../../../src/config/types.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/accounts.js"; +} from "openclaw/plugin-sdk/account-resolution"; +import { + hasConfiguredSecretInput, + normalizeSecretInputString, +} from "openclaw/plugin-sdk/config-runtime"; +import type { DiscordAccountConfig } from "openclaw/plugin-sdk/discord"; import { mergeDiscordAccountConfig, resolveDefaultDiscordAccountId, diff --git a/extensions/discord/src/accounts.ts b/extensions/discord/src/accounts.ts index f9984272bcd..ad50e2e7aa3 100644 --- a/extensions/discord/src/accounts.ts +++ b/extensions/discord/src/accounts.ts @@ -1,11 +1,11 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { DiscordAccountConfig, DiscordActionConfig } from "../../../src/config/types.js"; import { createAccountActionGate, createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { DiscordAccountConfig, DiscordActionConfig } from "openclaw/plugin-sdk/discord"; import { resolveDiscordToken } from "./token.js"; export type ResolvedDiscordAccount = { diff --git a/extensions/discord/src/monitor/provider.test-support.ts b/extensions/discord/src/monitor/provider.test-support.ts index 932c1952fcc..4da53ecb53a 100644 --- a/extensions/discord/src/monitor/provider.test-support.ts +++ b/extensions/discord/src/monitor/provider.test-support.ts @@ -1,3 +1,4 @@ +import type { MockFn } from "openclaw/plugin-sdk/test-utils"; import { expect, vi } from "vitest"; import type { OpenClawConfig } from "../../../../src/config/config.js"; import type { RuntimeEnv } from "../../../../src/runtime.js"; @@ -14,6 +15,34 @@ export type PluginCommandSpecMock = { acceptsArgs: boolean; }; +type AnyMock = MockFn; + +type ProviderMonitorTestMocks = { + clientHandleDeployRequestMock: AnyMock; + clientFetchUserMock: AnyMock; + clientGetPluginMock: AnyMock; + clientConstructorOptionsMock: AnyMock; + createDiscordAutoPresenceControllerMock: AnyMock; + createDiscordNativeCommandMock: AnyMock; + createDiscordMessageHandlerMock: AnyMock; + createNoopThreadBindingManagerMock: AnyMock; + createThreadBindingManagerMock: AnyMock; + reconcileAcpThreadBindingsOnStartupMock: AnyMock; + createdBindingManagers: Array<{ stop: ReturnType }>; + getAcpSessionStatusMock: AnyMock; + getPluginCommandSpecsMock: AnyMock; + listNativeCommandSpecsForConfigMock: AnyMock; + listSkillCommandsForAgentsMock: AnyMock; + monitorLifecycleMock: AnyMock; + resolveDiscordAccountMock: AnyMock; + resolveDiscordAllowlistConfigMock: AnyMock; + resolveNativeCommandsEnabledMock: AnyMock; + resolveNativeSkillsEnabledMock: AnyMock; + isVerboseMock: AnyMock; + shouldLogVerboseMock: AnyMock; + voiceRuntimeModuleLoadedMock: AnyMock; +}; + export function baseDiscordAccountConfig() { return { commands: { native: true, nativeSkills: false }, @@ -23,7 +52,7 @@ export function baseDiscordAccountConfig() { }; } -const providerMonitorTestMocks = vi.hoisted(() => { +const providerMonitorTestMocks: ProviderMonitorTestMocks = vi.hoisted(() => { const createdBindingManagers: Array<{ stop: ReturnType }> = []; const isVerboseMock = vi.fn(() => false); const shouldLogVerboseMock = vi.fn(() => false); @@ -123,7 +152,7 @@ const { voiceRuntimeModuleLoadedMock, } = providerMonitorTestMocks; -export function getProviderMonitorTestMocks() { +export function getProviderMonitorTestMocks(): typeof providerMonitorTestMocks { return providerMonitorTestMocks; } diff --git a/extensions/discord/src/plugin-shared.ts b/extensions/discord/src/plugin-shared.ts index d14f8050d30..fd5fb029f7c 100644 --- a/extensions/discord/src/plugin-shared.ts +++ b/extensions/discord/src/plugin-shared.ts @@ -1,9 +1,9 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/account-resolution"; import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import type { OpenClawConfig } from "../../../src/config/config.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 9d8952bb053..619537ef85c 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -1,7 +1,9 @@ import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { applyAccountNameToChannelSection, + createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, + formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, noteChannelLookupFailure, @@ -13,13 +15,11 @@ import { type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; import { + createAllowlistSetupWizardProxy, type ChannelSetupAdapter, type ChannelSetupDmPolicy, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; @@ -140,9 +140,15 @@ export const discordSetupAdapter: ChannelSetupAdapter = { }, }; -export function createDiscordSetupWizardProxy( - loadWizard: () => Promise<{ discordSetupWizard: ChannelSetupWizard }>, -) { +export function createDiscordSetupWizardBase(handlers: { + promptAllowFrom: NonNullable; + resolveAllowFromEntries: NonNullable< + NonNullable["resolveEntries"] + >; + resolveGroupAllowlist: NonNullable< + NonNullable["resolveAllowlist"]> + >; +}) { const discordDmPolicy: ChannelSetupDmPolicy = { label: "Discord", channel, @@ -156,13 +162,7 @@ export function createDiscordSetupWizardProxy( channel, dmPolicy: policy, }), - promptAllowFrom: async ({ cfg, prompter, accountId }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.dmPolicy?.promptAllowFrom) { - return cfg; - } - return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); - }, + promptAllowFrom: handlers.promptAllowFrom, }; return { @@ -253,12 +253,8 @@ export function createDiscordSetupWizardProxy( entries: string[]; prompter: { note: (message: string, title?: string) => Promise }; }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.groupAccess?.resolveAllowlist) { - return entries.map((input) => ({ input, resolved: false })); - } try { - return await wizard.groupAccess.resolveAllowlist({ + return await handlers.resolveGroupAllowlist({ cfg, accountId, credentialValues, @@ -317,18 +313,7 @@ export function createDiscordSetupWizardProxy( accountId: string; credentialValues: { token?: string }; entries: string[]; - }) => { - const wizard = (await loadWizard()).discordSetupWizard; - if (!wizard.allowFrom) { - return entries.map((input) => ({ input, resolved: false, id: null })); - } - return await wizard.allowFrom.resolveEntries({ - cfg, - accountId, - credentialValues, - entries, - }); - }, + }) => await handlers.resolveAllowFromEntries({ cfg, accountId, credentialValues, entries }), apply: async ({ cfg, accountId, diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index be5a374d0fa..da87bfd77d0 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,5 +1,6 @@ import { DEFAULT_ACCOUNT_ID, + formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, type OpenClawConfig, @@ -12,7 +13,6 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/google/provider-models.ts b/extensions/google/provider-models.ts index 546a8b11575..93e6c40619c 100644 --- a/extensions/google/provider-models.ts +++ b/extensions/google/provider-models.ts @@ -2,7 +2,7 @@ import type { ProviderResolveDynamicModelContext, ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; +import { cloneFirstTemplateModel } from "openclaw/plugin-sdk/provider-models"; const GEMINI_3_1_PRO_PREFIX = "gemini-3.1-pro"; const GEMINI_3_1_FLASH_PREFIX = "gemini-3.1-flash"; diff --git a/extensions/imessage/src/accounts.ts b/extensions/imessage/src/accounts.ts index 8ebbe9d8ffc..5ee90339aa8 100644 --- a/extensions/imessage/src/accounts.ts +++ b/extensions/imessage/src/accounts.ts @@ -1,10 +1,10 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { IMessageAccountConfig } from "../../../src/config/types.js"; import { createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { IMessageAccountConfig } from "openclaw/plugin-sdk/imessage"; export type ResolvedIMessageAccount = { accountId: string; diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index bc99f521510..2b9ff2eb2dc 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,6 +1,7 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, + formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, parseSetupEntriesAllowingWildcard, @@ -16,7 +17,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index c24630dc805..1ba4358cc52 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,6 +1,8 @@ -import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; -import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { detectBinary } from "../../../src/commands/onboard-helpers.js"; +import { + detectBinary, + setSetupChannelEnabled, + type ChannelSetupWizard, +} from "openclaw/plugin-sdk/setup"; import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { createIMessageCliPathTextInput, diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 1ede2ad412d..935546721da 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -3,19 +3,17 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, - setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { formatTrimmedAllowFromEntries, + getChatChannelMeta, + IMessageConfigSchema, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, -} from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; + setAccountEnabledInConfigSection, + type ChannelPlugin, +} from "openclaw/plugin-sdk/imessage"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/openai/shared.ts b/extensions/openai/shared.ts index 673a6bdeb24..1316accf906 100644 --- a/extensions/openai/shared.ts +++ b/extensions/openai/shared.ts @@ -1,5 +1,5 @@ -import { findCatalogTemplate } from "../../src/plugins/provider-catalog.js"; -import { cloneFirstTemplateModel } from "../../src/plugins/provider-model-helpers.js"; +import { findCatalogTemplate } from "openclaw/plugin-sdk/provider-catalog"; +import { cloneFirstTemplateModel } from "openclaw/plugin-sdk/provider-models"; export const OPENAI_API_BASE_URL = "https://api.openai.com/v1"; diff --git a/extensions/signal/src/accounts.ts b/extensions/signal/src/accounts.ts index 9699f9394f4..456db907685 100644 --- a/extensions/signal/src/accounts.ts +++ b/extensions/signal/src/accounts.ts @@ -1,10 +1,10 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { SignalAccountConfig } from "../../../src/config/types.js"; import { createAccountListHelpers, normalizeAccountId, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { SignalAccountConfig } from "openclaw/plugin-sdk/signal"; export type ResolvedSignalAccount = { accountId: string; diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 3952a55f861..38b7b0f086c 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,6 +1,8 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, normalizeE164, @@ -17,8 +19,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index c8329d5ba52..01ded866785 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,7 +1,9 @@ -import { setSetupChannelEnabled } from "openclaw/plugin-sdk/setup"; -import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { detectBinary } from "../../../src/commands/onboard-helpers.js"; -import { installSignalCli } from "../../../src/commands/signal-install.js"; +import { + detectBinary, + installSignalCli, + setSetupChannelEnabled, + type ChannelSetupWizard, +} from "openclaw/plugin-sdk/setup"; import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; import { createSignalCliPathTextInput, diff --git a/extensions/signal/src/shared.ts b/extensions/signal/src/shared.ts index 60dfd0ed010..3de5af7d57a 100644 --- a/extensions/signal/src/shared.ts +++ b/extensions/signal/src/shared.ts @@ -4,15 +4,15 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, + getChatChannelMeta, + normalizeE164, setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { SignalConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { normalizeE164 } from "../../../src/utils.js"; + SignalConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/signal"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/slack/src/account-inspect.ts b/extensions/slack/src/account-inspect.ts index 0606a16b0bc..3e5a67203fc 100644 --- a/extensions/slack/src/account-inspect.ts +++ b/extensions/slack/src/account-inspect.ts @@ -1,13 +1,13 @@ -import { - hasConfiguredSecretInput, - normalizeSecretInputString, -} from "../../../src/config/types.secrets.js"; -import type { SlackAccountConfig } from "../../../src/config/types.slack.js"; import { DEFAULT_ACCOUNT_ID, normalizeAccountId, type OpenClawConfig, -} from "../../../src/plugin-sdk-internal/accounts.js"; +} from "openclaw/plugin-sdk/account-resolution"; +import { + hasConfiguredSecretInput, + normalizeSecretInputString, +} from "openclaw/plugin-sdk/config-runtime"; +import type { SlackAccountConfig } from "openclaw/plugin-sdk/slack"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { mergeSlackAccountConfig, diff --git a/extensions/slack/src/accounts.ts b/extensions/slack/src/accounts.ts index 7a1c25845ae..e453067e485 100644 --- a/extensions/slack/src/accounts.ts +++ b/extensions/slack/src/accounts.ts @@ -1,12 +1,12 @@ -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { SlackAccountConfig } from "../../../src/config/types.slack.js"; import { createAccountListHelpers, DEFAULT_ACCOUNT_ID, normalizeAccountId, normalizeChatType, resolveAccountEntry, -} from "../../../src/plugin-sdk-internal/accounts.js"; + type OpenClawConfig, +} from "openclaw/plugin-sdk/account-resolution"; +import type { SlackAccountConfig } from "openclaw/plugin-sdk/slack"; import type { SlackAccountSurfaceFields } from "./account-surface-fields.js"; import { resolveSlackAppToken, resolveSlackBotToken, resolveSlackUserToken } from "./token.js"; diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 8a8f48a4bdb..e9f8f8f5cb0 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,6 +1,9 @@ import { applyAccountNameToChannelSection, + createAllowlistSetupWizardProxy, + createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, + formatDocsLink, hasConfiguredSecretInput, migrateBaseNameToDefaultAccount, normalizeAccountId, @@ -19,9 +22,6 @@ import { type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; -import { createPatchedAccountSetupAdapter } from "../../../src/channels/plugins/setup-helpers.js"; -import { createAllowlistSetupWizardProxy } from "../../../src/channels/plugins/setup-wizard-proxy.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { @@ -112,9 +112,15 @@ export const slackSetupAdapter: ChannelSetupAdapter = { }, }; -export function createSlackSetupWizardBase( - loadWizard: () => Promise<{ slackSetupWizard: ChannelSetupWizard }>, -) { +export function createSlackSetupWizardBase(handlers: { + promptAllowFrom: NonNullable; + resolveAllowFromEntries: NonNullable< + NonNullable["resolveEntries"] + >; + resolveGroupAllowlist: NonNullable< + NonNullable["resolveAllowlist"]> + >; +}) { const slackDmPolicy: ChannelSetupDmPolicy = { label: "Slack", channel, @@ -128,13 +134,7 @@ export function createSlackSetupWizardBase( channel, dmPolicy: policy, }), - promptAllowFrom: async ({ cfg, prompter, accountId }) => { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.dmPolicy?.promptAllowFrom) { - return cfg; - } - return await wizard.dmPolicy.promptAllowFrom({ cfg, prompter, accountId }); - }, + promptAllowFrom: handlers.promptAllowFrom, }; return { @@ -285,18 +285,7 @@ export function createSlackSetupWizardBase( accountId: string; credentialValues: { botToken?: string }; entries: string[]; - }) => { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.allowFrom) { - return entries.map((input) => ({ input, resolved: false, id: null })); - } - return await wizard.allowFrom.resolveEntries({ - cfg, - accountId, - credentialValues, - entries, - }); - }, + }) => await handlers.resolveAllowFromEntries({ cfg, accountId, credentialValues, entries }), apply: ({ cfg, accountId, @@ -353,11 +342,7 @@ export function createSlackSetupWizardBase( prompter: { note: (message: string, title?: string) => Promise }; }) => { try { - const wizard = (await loadWizard()).slackSetupWizard; - if (!wizard.groupAccess?.resolveAllowlist) { - return entries; - } - return await wizard.groupAccess.resolveAllowlist({ + return await handlers.resolveGroupAllowlist({ cfg, accountId, credentialValues, diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 4e3670ac843..1dbfa4f02ce 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,5 +1,6 @@ import { DEFAULT_ACCOUNT_ID, + formatDocsLink, hasConfiguredSecretInput, noteChannelLookupFailure, noteChannelLookupSummary, @@ -19,7 +20,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/slack/src/shared.ts b/extensions/slack/src/shared.ts index 4471e851097..58dfae35c90 100644 --- a/extensions/slack/src/shared.ts +++ b/extensions/slack/src/shared.ts @@ -3,14 +3,18 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { patchChannelConfigForAccount } from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; -import { SlackConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +import { + formatDocsLink, + hasConfiguredSecretInput, + patchChannelConfigForAccount, +} from "openclaw/plugin-sdk/setup"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + SlackConfigSchema, + type ChannelPlugin, + type OpenClawConfig, +} from "openclaw/plugin-sdk/slack"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/bot-native-commands.fixture-test-support.ts b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts index ab2439d65ec..bcb1f786893 100644 --- a/extensions/telegram/src/bot-native-commands.fixture-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts @@ -1,33 +1,27 @@ +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import type { OpenClawConfig, TelegramAccountConfig } from "openclaw/plugin-sdk/telegram"; import { vi } from "vitest"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { TelegramAccountConfig } from "../../../src/config/types.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; + +type RegisterTelegramNativeCommandsParams = Parameters< + typeof import("./bot-native-commands.js").registerTelegramNativeCommands +>[0]; export type NativeCommandTestParams = { - bot: { - api: { - setMyCommands: ReturnType; - sendMessage: ReturnType; - }; - command: ReturnType; - }; + bot: RegisterTelegramNativeCommandsParams["bot"]; cfg: OpenClawConfig; runtime: RuntimeEnv; accountId: string; telegramCfg: TelegramAccountConfig; allowFrom: string[]; groupAllowFrom: string[]; - replyToMode: string; + replyToMode: RegisterTelegramNativeCommandsParams["replyToMode"]; textLimit: number; useAccessGroups: boolean; nativeEnabled: boolean; nativeSkillsEnabled: boolean; nativeDisabledExplicit: boolean; resolveGroupPolicy: () => { allowlistEnabled: boolean; allowed: boolean }; - resolveTelegramGroupConfig: () => { - groupConfig: undefined; - topicConfig: undefined; - }; + resolveTelegramGroupConfig: RegisterTelegramNativeCommandsParams["resolveTelegramGroupConfig"]; shouldSkipUpdate: () => boolean; opts: { token: string }; }; @@ -53,9 +47,15 @@ export function createNativeCommandTestParams( sendMessage: vi.fn().mockResolvedValue(undefined), }, command: vi.fn(), - } as NativeCommandTestParams["bot"]), + } as unknown as NativeCommandTestParams["bot"]), cfg: params.cfg ?? ({} as OpenClawConfig), - runtime: params.runtime ?? ({ log } as RuntimeEnv), + runtime: + params.runtime ?? + ({ + log, + error: vi.fn(), + exit: vi.fn(), + } as unknown as RuntimeEnv), accountId: params.accountId ?? "default", telegramCfg: params.telegramCfg ?? ({} as TelegramAccountConfig), allowFrom: params.allowFrom ?? [], diff --git a/extensions/telegram/src/bot-native-commands.menu-test-support.ts b/extensions/telegram/src/bot-native-commands.menu-test-support.ts index 94a6f9824df..8e67e625f93 100644 --- a/extensions/telegram/src/bot-native-commands.menu-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.menu-test-support.ts @@ -1,6 +1,6 @@ +import type { RuntimeEnv } from "openclaw/plugin-sdk"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/telegram"; import { expect, vi } from "vitest"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../src/runtime.js"; import { createNativeCommandTestParams as createBaseNativeCommandTestParams, createTelegramPrivateCommandContext, @@ -12,6 +12,13 @@ type RegisteredCommand = { description: string; }; +type CreateCommandBotResult = { + bot: RegisterTelegramNativeCommandsParams["bot"]; + commandHandlers: Map Promise>; + sendMessage: ReturnType; + setMyCommands: ReturnType; +}; + const skillCommandMocks = vi.hoisted(() => ({ listSkillCommandsForAgents: vi.fn(() => []), })); @@ -51,7 +58,7 @@ export function resetNativeCommandMenuMocks() { deliverReplies.mockResolvedValue({ delivered: true }); } -export function createCommandBot() { +export function createCommandBot(): CreateCommandBotResult { const commandHandlers = new Map Promise>(); const sendMessage = vi.fn().mockResolvedValue(undefined); const setMyCommands = vi.fn().mockResolvedValue(undefined); diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index f2b5fc04d77..13fb01f3a51 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,6 +1,8 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, patchChannelConfigForAccount, @@ -10,8 +12,6 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/tlon/src/setup-core.ts b/extensions/tlon/src/setup-core.ts index 8d54e37444a..e08bcc02498 100644 --- a/extensions/tlon/src/setup-core.ts +++ b/extensions/tlon/src/setup-core.ts @@ -8,7 +8,6 @@ import { type ChannelSetupInput, type ChannelSetupWizard, type OpenClawConfig, - type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import { buildTlonAccountFields } from "./account-fields.js"; import { normalizeShip } from "./targets.js"; @@ -38,12 +37,7 @@ type TlonSetupWizardBaseParams = { cfg: OpenClawConfig; configured: boolean; }) => string[] | Promise; - finalize: (params: { - cfg: OpenClawConfig; - accountId: string; - prompter: WizardPrompter; - options?: Record; - }) => Promise<{ cfg: OpenClawConfig }>; + finalize: NonNullable; }; export function createTlonSetupWizardBase(params: TlonSetupWizardBaseParams): ChannelSetupWizard { diff --git a/extensions/whatsapp/src/channel.ts b/extensions/whatsapp/src/channel.ts index 11ac323afec..e7f79ad5f2a 100644 --- a/extensions/whatsapp/src/channel.ts +++ b/extensions/whatsapp/src/channel.ts @@ -166,13 +166,11 @@ export const whatsappPlugin: ChannelPlugin = { }, auth: { login: async ({ cfg, accountId, runtime, verbose }) => { - const resolvedAccountId = accountId?.trim() || whatsappPlugin.config.defaultAccountId(cfg); - await (await loadWhatsAppChannelRuntime()).loginWeb( - Boolean(verbose), - undefined, - runtime, - resolvedAccountId, - ); + const resolvedAccountId = + accountId?.trim() || whatsappPlugin.config.defaultAccountId?.(cfg) || DEFAULT_ACCOUNT_ID; + await ( + await loadWhatsAppChannelRuntime() + ).loginWeb(Boolean(verbose), undefined, runtime, resolvedAccountId); }, }, heartbeat: { @@ -181,9 +179,9 @@ export const whatsappPlugin: ChannelPlugin = { return { ok: false, reason: "whatsapp-disabled" }; } const account = resolveWhatsAppAccount({ cfg, accountId }); - const authExists = await (deps?.webAuthExists ?? (await loadWhatsAppChannelRuntime()).webAuthExists)( - account.authDir, - ); + const authExists = await ( + deps?.webAuthExists ?? (await loadWhatsAppChannelRuntime()).webAuthExists + )(account.authDir); if (!authExists) { return { ok: false, reason: "whatsapp-not-linked" }; } @@ -219,9 +217,7 @@ export const whatsappPlugin: ChannelPlugin = { ? await (await loadWhatsAppChannelRuntime()).webAuthExists(authDir) : false; const authAgeMs = - linked && authDir - ? (await loadWhatsAppChannelRuntime()).getWebAuthAgeMs(authDir) - : null; + linked && authDir ? (await loadWhatsAppChannelRuntime()).getWebAuthAgeMs(authDir) : null; const self = linked && authDir ? (await loadWhatsAppChannelRuntime()).readWebSelfId(authDir) @@ -288,7 +284,9 @@ export const whatsappPlugin: ChannelPlugin = { ); }, loginWithQrStart: async ({ accountId, force, timeoutMs, verbose }) => - await (await loadWhatsAppChannelRuntime()).startWebLoginWithQr({ + await ( + await loadWhatsAppChannelRuntime() + ).startWebLoginWithQr({ accountId, force, timeoutMs, @@ -297,7 +295,9 @@ export const whatsappPlugin: ChannelPlugin = { loginWithQrWait: async ({ accountId, timeoutMs }) => await (await loadWhatsAppChannelRuntime()).waitForWebLogin({ accountId, timeoutMs }), logoutAccount: async ({ account, runtime }) => { - const cleared = await (await loadWhatsAppChannelRuntime()).logoutWeb({ + const cleared = await ( + await loadWhatsAppChannelRuntime() + ).logoutWeb({ authDir: account.authDir, isLegacyAuthDir: account.isLegacyAuthDir, runtime, diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index faafe856de1..4a87ce4d0f8 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -1,18 +1,18 @@ import path from "node:path"; import { DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, normalizeAccountId, normalizeAllowFromEntries, normalizeE164, pathExists, splitSetupEntries, setSetupChannelEnabled, + type DmPolicy, type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import type { DmPolicy } from "../../../src/config/types.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; import { whatsappSetupAdapter } from "./setup-core.js"; diff --git a/src/channels/plugins/contracts/registry.ts b/src/channels/plugins/contracts/registry.ts index 4e87f1cfedd..324ba095406 100644 --- a/src/channels/plugins/contracts/registry.ts +++ b/src/channels/plugins/contracts/registry.ts @@ -173,7 +173,7 @@ bundledChannelRuntimeSetters.setLineRuntime({ setMatrixRuntime({ state: { - resolveStateDir: (_env, homeDir) => (homeDir ?? (() => "/tmp"))(), + resolveStateDir: (_env: unknown, homeDir?: () => string) => (homeDir ?? (() => "/tmp"))(), }, } as never); diff --git a/src/plugin-sdk/provider-models.ts b/src/plugin-sdk/provider-models.ts index 2ab00992d19..c2a68c7b579 100644 --- a/src/plugin-sdk/provider-models.ts +++ b/src/plugin-sdk/provider-models.ts @@ -16,6 +16,7 @@ export type { ProviderPlugin } from "../plugins/types.js"; export { DEFAULT_CONTEXT_TOKENS } from "../agents/defaults.js"; export { normalizeModelCompat } from "../agents/model-compat.js"; export { normalizeProviderId } from "../agents/provider-id.js"; +export { cloneFirstTemplateModel } from "../plugins/provider-model-helpers.js"; export { applyGoogleGeminiModelDefault, diff --git a/src/plugin-sdk/setup.ts b/src/plugin-sdk/setup.ts index 61785569d07..bd4e5283c97 100644 --- a/src/plugin-sdk/setup.ts +++ b/src/plugin-sdk/setup.ts @@ -7,8 +7,11 @@ export type { WizardPrompter } from "../wizard/prompts.js"; export type { ChannelSetupAdapter } from "../channels/plugins/types.adapters.js"; export type { ChannelSetupInput } from "../channels/plugins/types.core.js"; export type { ChannelSetupDmPolicy } from "../channels/plugins/setup-wizard-types.js"; -export type { ChannelSetupWizardAllowFromEntry } from "../channels/plugins/setup-wizard.js"; -export type { ChannelSetupWizard } from "../channels/plugins/setup-wizard.js"; +export type { + ChannelSetupWizard, + ChannelSetupWizardAllowFromEntry, + ChannelSetupWizardTextInput, +} from "../channels/plugins/setup-wizard.js"; export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js"; export { formatCliCommand } from "../cli/command-format.js"; @@ -52,5 +55,6 @@ export { setTopLevelChannelGroupPolicy, splitSetupEntries, } from "../channels/plugins/setup-wizard-helpers.js"; +export { createAllowlistSetupWizardProxy } from "../channels/plugins/setup-wizard-proxy.js"; export { formatResolvedUnresolvedNote } from "./resolution-notes.js"; diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index fc301051065..a9fdd448b85 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,4 +1,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; +import type { AuthChoice } from "../../commands/onboard-types.js"; +import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, @@ -7,8 +10,6 @@ import { requireOpenClawAgentDir, setupAuthTestEnv, } from "../../commands/test-wizard-helpers.js"; -import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; -import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; import { registerProviders, requireProvider } from "./testkit.js"; From 78a4d12e9aeeb32b992124e7beb27e0f5f41ab42 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:51:39 -0700 Subject: [PATCH 063/187] refactor: fix rebase fallout in plugin auth seams --- extensions/imessage/src/channel.ts | 1 - src/plugins/contracts/auth-choice.contract.test.ts | 2 +- src/plugins/provider-auth-choice.ts | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index f17a9645579..a927b8a3d74 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -4,7 +4,6 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; -import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index a9fdd448b85..d4f377765ed 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,7 +1,6 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; import type { AuthChoice } from "../../commands/onboard-types.js"; -import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, @@ -10,6 +9,7 @@ import { requireOpenClawAgentDir, setupAuthTestEnv, } from "../../commands/test-wizard-helpers.js"; +import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; import { registerProviders, requireProvider } from "./testkit.js"; diff --git a/src/plugins/provider-auth-choice.ts b/src/plugins/provider-auth-choice.ts index 940a26b20d1..7a9679d97dc 100644 --- a/src/plugins/provider-auth-choice.ts +++ b/src/plugins/provider-auth-choice.ts @@ -19,7 +19,7 @@ import { import { applyAuthProfileConfig } from "./provider-auth-helpers.js"; import { createVpsAwareOAuthHandlers } from "./provider-oauth-flow.js"; import { isRemoteEnvironment, openUrl } from "./setup-browser.js"; -import type { ProviderAuthMethod, ProviderAuthOptionBag, ProviderPlugin } from "./types.js"; +import type { ProviderAuthMethod, ProviderAuthOptionBag } from "./types.js"; export type ApplyProviderAuthChoiceParams = { authChoice: string; From 00b57145ff01bce2324043369c841bbd1bb82780 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:51:53 -0700 Subject: [PATCH 064/187] refactor: move agent runtime into agents layer --- .../src/monitor/provider.test-support.ts | 54 +- extensions/imessage/src/plugin-shared.ts | 1 + extensions/signal/src/plugin-shared.ts | 1 + extensions/slack/src/plugin-shared.ts | 1 + ...ot-native-commands.fixture-test-support.ts | 27 +- .../src/bot-native-commands.test-helpers.ts | 15 +- .../telegram/src/bot-native-commands.ts | 2 +- src/agents/agent-command.ts | 1257 ++++++++++++++++ src/agents/cli-runner.ts | 2 +- src/agents/command/delivery.ts | 238 ++++ src/agents/command/run-context.ts | 55 + src/agents/command/session-store.ts | 109 ++ src/agents/command/session.ts | 172 +++ src/agents/command/types.ts | 90 ++ src/agents/pi-embedded-runner/run/params.ts | 2 +- src/commands/agent.ts | 1258 +---------------- src/commands/agent/delivery.ts | 241 +--- src/commands/agent/run-context.ts | 56 +- src/commands/agent/session-store.ts | 112 +- src/commands/agent/session.ts | 173 +-- src/commands/agent/types.ts | 91 +- src/gateway/openai-http.ts | 2 +- src/gateway/openresponses-http.ts | 2 +- src/plugin-sdk/agent-runtime.ts | 2 +- .../contracts/auth-choice.contract.test.ts | 8 +- 25 files changed, 1977 insertions(+), 1994 deletions(-) create mode 100644 extensions/imessage/src/plugin-shared.ts create mode 100644 extensions/signal/src/plugin-shared.ts create mode 100644 extensions/slack/src/plugin-shared.ts create mode 100644 src/agents/agent-command.ts create mode 100644 src/agents/command/delivery.ts create mode 100644 src/agents/command/run-context.ts create mode 100644 src/agents/command/session-store.ts create mode 100644 src/agents/command/session.ts create mode 100644 src/agents/command/types.ts diff --git a/extensions/discord/src/monitor/provider.test-support.ts b/extensions/discord/src/monitor/provider.test-support.ts index 4da53ecb53a..23ffb7da2f2 100644 --- a/extensions/discord/src/monitor/provider.test-support.ts +++ b/extensions/discord/src/monitor/provider.test-support.ts @@ -1,4 +1,4 @@ -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { Mock } from "vitest"; import { expect, vi } from "vitest"; import type { OpenClawConfig } from "../../../../src/config/config.js"; import type { RuntimeEnv } from "../../../../src/runtime.js"; @@ -15,32 +15,36 @@ export type PluginCommandSpecMock = { acceptsArgs: boolean; }; -type AnyMock = MockFn; - type ProviderMonitorTestMocks = { - clientHandleDeployRequestMock: AnyMock; - clientFetchUserMock: AnyMock; - clientGetPluginMock: AnyMock; - clientConstructorOptionsMock: AnyMock; - createDiscordAutoPresenceControllerMock: AnyMock; - createDiscordNativeCommandMock: AnyMock; - createDiscordMessageHandlerMock: AnyMock; - createNoopThreadBindingManagerMock: AnyMock; - createThreadBindingManagerMock: AnyMock; - reconcileAcpThreadBindingsOnStartupMock: AnyMock; + clientHandleDeployRequestMock: Mock<() => Promise>; + clientFetchUserMock: Mock<(target: string) => Promise<{ id: string }>>; + clientGetPluginMock: Mock<(name: string) => unknown>; + clientConstructorOptionsMock: Mock<(options?: unknown) => void>; + createDiscordAutoPresenceControllerMock: Mock<() => unknown>; + createDiscordNativeCommandMock: Mock<(params?: { command?: { name?: string } }) => unknown>; + createDiscordMessageHandlerMock: Mock<() => unknown>; + createNoopThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; + createThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; + reconcileAcpThreadBindingsOnStartupMock: Mock<() => unknown>; createdBindingManagers: Array<{ stop: ReturnType }>; - getAcpSessionStatusMock: AnyMock; - getPluginCommandSpecsMock: AnyMock; - listNativeCommandSpecsForConfigMock: AnyMock; - listSkillCommandsForAgentsMock: AnyMock; - monitorLifecycleMock: AnyMock; - resolveDiscordAccountMock: AnyMock; - resolveDiscordAllowlistConfigMock: AnyMock; - resolveNativeCommandsEnabledMock: AnyMock; - resolveNativeSkillsEnabledMock: AnyMock; - isVerboseMock: AnyMock; - shouldLogVerboseMock: AnyMock; - voiceRuntimeModuleLoadedMock: AnyMock; + getAcpSessionStatusMock: Mock< + (params: { + cfg: OpenClawConfig; + sessionKey: string; + signal?: AbortSignal; + }) => Promise<{ state: string }> + >; + getPluginCommandSpecsMock: Mock<() => PluginCommandSpecMock[]>; + listNativeCommandSpecsForConfigMock: Mock<() => NativeCommandSpecMock[]>; + listSkillCommandsForAgentsMock: Mock<() => unknown[]>; + monitorLifecycleMock: Mock<(params: { threadBindings: { stop: () => void } }) => Promise>; + resolveDiscordAccountMock: Mock<() => unknown>; + resolveDiscordAllowlistConfigMock: Mock<() => Promise>; + resolveNativeCommandsEnabledMock: Mock<() => boolean>; + resolveNativeSkillsEnabledMock: Mock<() => boolean>; + isVerboseMock: Mock<() => boolean>; + shouldLogVerboseMock: Mock<() => boolean>; + voiceRuntimeModuleLoadedMock: Mock<() => void>; }; export function baseDiscordAccountConfig() { diff --git a/extensions/imessage/src/plugin-shared.ts b/extensions/imessage/src/plugin-shared.ts new file mode 100644 index 00000000000..57e8bc5fc66 --- /dev/null +++ b/extensions/imessage/src/plugin-shared.ts @@ -0,0 +1 @@ +export { imessageSetupWizard } from "./shared.js"; diff --git a/extensions/signal/src/plugin-shared.ts b/extensions/signal/src/plugin-shared.ts new file mode 100644 index 00000000000..af9370171dd --- /dev/null +++ b/extensions/signal/src/plugin-shared.ts @@ -0,0 +1 @@ +export { signalSetupWizard } from "./shared.js"; diff --git a/extensions/slack/src/plugin-shared.ts b/extensions/slack/src/plugin-shared.ts new file mode 100644 index 00000000000..eefcc2c6215 --- /dev/null +++ b/extensions/slack/src/plugin-shared.ts @@ -0,0 +1 @@ +export { slackSetupWizard } from "./setup-surface.js"; diff --git a/extensions/telegram/src/bot-native-commands.fixture-test-support.ts b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts index bcb1f786893..f26ac028db3 100644 --- a/extensions/telegram/src/bot-native-commands.fixture-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.fixture-test-support.ts @@ -1,30 +1,9 @@ import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { OpenClawConfig, TelegramAccountConfig } from "openclaw/plugin-sdk/telegram"; import { vi } from "vitest"; +import type { RegisterTelegramNativeCommandsParams } from "./bot-native-commands.js"; -type RegisterTelegramNativeCommandsParams = Parameters< - typeof import("./bot-native-commands.js").registerTelegramNativeCommands ->[0]; - -export type NativeCommandTestParams = { - bot: RegisterTelegramNativeCommandsParams["bot"]; - cfg: OpenClawConfig; - runtime: RuntimeEnv; - accountId: string; - telegramCfg: TelegramAccountConfig; - allowFrom: string[]; - groupAllowFrom: string[]; - replyToMode: RegisterTelegramNativeCommandsParams["replyToMode"]; - textLimit: number; - useAccessGroups: boolean; - nativeEnabled: boolean; - nativeSkillsEnabled: boolean; - nativeDisabledExplicit: boolean; - resolveGroupPolicy: () => { allowlistEnabled: boolean; allowed: boolean }; - resolveTelegramGroupConfig: RegisterTelegramNativeCommandsParams["resolveTelegramGroupConfig"]; - shouldSkipUpdate: () => boolean; - opts: { token: string }; -}; +export type NativeCommandTestParams = RegisterTelegramNativeCommandsParams; export function createDeferred() { let resolve!: (value: T | PromiseLike) => void; @@ -75,7 +54,7 @@ export function createNativeCommandTestParams( }) as ReturnType), resolveTelegramGroupConfig: params.resolveTelegramGroupConfig ?? - (() => ({ groupConfig: undefined, topicConfig: undefined })), + ((_chatId, _messageThreadId) => ({ groupConfig: undefined, topicConfig: undefined })), shouldSkipUpdate: params.shouldSkipUpdate ?? (() => false), opts: params.opts ?? { token: "token" }, }; diff --git a/extensions/telegram/src/bot-native-commands.test-helpers.ts b/extensions/telegram/src/bot-native-commands.test-helpers.ts index f443040b17d..43059cd9b61 100644 --- a/extensions/telegram/src/bot-native-commands.test-helpers.ts +++ b/extensions/telegram/src/bot-native-commands.test-helpers.ts @@ -8,6 +8,7 @@ import { createNativeCommandTestParams, type NativeCommandTestParams, } from "./bot-native-commands.fixture-test-support.js"; +import type { RegisterTelegramNativeCommandsParams } from "./bot-native-commands.js"; import { registerTelegramNativeCommands } from "./bot-native-commands.js"; type GetPluginCommandSpecsFn = @@ -29,13 +30,7 @@ type NativeCommandHarness = { sendMessage: AnyAsyncMock; setMyCommands: AnyAsyncMock; log: AnyMock; - bot: { - api: { - setMyCommands: AnyAsyncMock; - sendMessage: AnyAsyncMock; - }; - command: (name: string, handler: (ctx: unknown) => Promise) => void; - }; + bot: RegisterTelegramNativeCommandsParams["bot"]; }; const pluginCommandMocks = vi.hoisted(() => ({ @@ -109,7 +104,7 @@ export function createNativeCommandsHarness(params?: { const sendMessage: AnyAsyncMock = vi.fn(async () => undefined); const setMyCommands: AnyAsyncMock = vi.fn(async () => undefined); const log: AnyMock = vi.fn(); - const bot: NativeCommandHarness["bot"] = { + const bot = { api: { setMyCommands, sendMessage, @@ -117,10 +112,10 @@ export function createNativeCommandsHarness(params?: { command: (name: string, handler: (ctx: unknown) => Promise) => { handlers[name] = handler; }, - } as const; + } as unknown as RegisterTelegramNativeCommandsParams["bot"]; registerTelegramNativeCommands({ - bot: bot as unknown as NativeCommandTestParams["bot"], + bot, cfg: params?.cfg ?? ({} as OpenClawConfig), runtime: params?.runtime ?? ({ log } as unknown as RuntimeEnv), accountId: "default", diff --git a/extensions/telegram/src/bot-native-commands.ts b/extensions/telegram/src/bot-native-commands.ts index 9cc757cec91..740dc1d8c08 100644 --- a/extensions/telegram/src/bot-native-commands.ts +++ b/extensions/telegram/src/bot-native-commands.ts @@ -119,7 +119,7 @@ export type RegisterTelegramHandlerParams = { logger: ReturnType; }; -type RegisterTelegramNativeCommandsParams = { +export type RegisterTelegramNativeCommandsParams = { bot: Bot; cfg: OpenClawConfig; runtime: RuntimeEnv; diff --git a/src/agents/agent-command.ts b/src/agents/agent-command.ts new file mode 100644 index 00000000000..5ed69abd71f --- /dev/null +++ b/src/agents/agent-command.ts @@ -0,0 +1,1257 @@ +import fs from "node:fs/promises"; +import { SessionManager } from "@mariozechner/pi-coding-agent"; +import { getAcpSessionManager } from "../acp/control-plane/manager.js"; +import { resolveAcpAgentPolicyError, resolveAcpDispatchPolicyError } from "../acp/policy.js"; +import { toAcpRuntimeError } from "../acp/runtime/errors.js"; +import { resolveAcpSessionCwd } from "../acp/runtime/session-identifiers.js"; +import { createSubsystemLogger } from "../logging/subsystem.js"; + +const log = createSubsystemLogger("agents/agent-command"); +import { normalizeReplyPayload } from "../auto-reply/reply/normalize-reply.js"; +import { + formatThinkingLevels, + formatXHighModelHint, + normalizeThinkLevel, + normalizeVerboseLevel, + supportsXHighThinking, + type ThinkLevel, + type VerboseLevel, +} from "../auto-reply/thinking.js"; +import { + isSilentReplyPrefixText, + isSilentReplyText, + SILENT_REPLY_TOKEN, +} from "../auto-reply/tokens.js"; +import { formatCliCommand } from "../cli/command-format.js"; +import { resolveCommandSecretRefsViaGateway } from "../cli/command-secret-gateway.js"; +import { getAgentRuntimeCommandSecretTargetIds } from "../cli/command-secret-targets.js"; +import { type CliDeps, createDefaultDeps } from "../cli/deps.js"; +import { + loadConfig, + readConfigFileSnapshotForWrite, + setRuntimeConfigSnapshot, +} from "../config/config.js"; +import { + mergeSessionEntry, + resolveAgentIdFromSessionKey, + type SessionEntry, + updateSessionStore, +} from "../config/sessions.js"; +import { resolveSessionTranscriptFile } from "../config/sessions/transcript.js"; +import { + clearAgentRunContext, + emitAgentEvent, + registerAgentRunContext, +} from "../infra/agent-events.js"; +import { buildOutboundSessionContext } from "../infra/outbound/session-context.js"; +import { getRemoteSkillEligibility } from "../infra/skills-remote.js"; +import { normalizeAgentId } from "../routing/session-key.js"; +import { defaultRuntime, type RuntimeEnv } from "../runtime.js"; +import { applyVerboseOverride } from "../sessions/level-overrides.js"; +import { applyModelOverrideToSessionEntry } from "../sessions/model-overrides.js"; +import { resolveSendPolicy } from "../sessions/send-policy.js"; +import { emitSessionTranscriptUpdate } from "../sessions/transcript-events.js"; +import { resolveMessageChannel } from "../utils/message-channel.js"; +import { + listAgentIds, + resolveAgentDir, + resolveEffectiveModelFallbacks, + resolveSessionAgentId, + resolveAgentSkillsFilter, + resolveAgentWorkspaceDir, +} from "./agent-scope.js"; +import { ensureAuthProfileStore } from "./auth-profiles.js"; +import { clearSessionAuthProfileOverride } from "./auth-profiles/session-override.js"; +import { resolveBootstrapWarningSignaturesSeen } from "./bootstrap-budget.js"; +import { runCliAgent } from "./cli-runner.js"; +import { getCliSessionId, setCliSessionId } from "./cli-session.js"; +import { deliverAgentCommandResult } from "./command/delivery.js"; +import { resolveAgentRunContext } from "./command/run-context.js"; +import { updateSessionStoreAfterAgentRun } from "./command/session-store.js"; +import { resolveSession } from "./command/session.js"; +import type { AgentCommandIngressOpts, AgentCommandOpts } from "./command/types.js"; +import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "./defaults.js"; +import { FailoverError } from "./failover-error.js"; +import { formatAgentInternalEventsForPrompt } from "./internal-events.js"; +import { AGENT_LANE_SUBAGENT } from "./lanes.js"; +import { loadModelCatalog } from "./model-catalog.js"; +import { runWithModelFallback } from "./model-fallback.js"; +import { + buildAllowedModelSet, + isCliProvider, + modelKey, + normalizeModelRef, + normalizeProviderId, + resolveConfiguredModelRef, + resolveDefaultModelForAgent, + resolveThinkingDefault, +} from "./model-selection.js"; +import { prepareSessionManagerForRun } from "./pi-embedded-runner/session-manager-init.js"; +import { runEmbeddedPiAgent } from "./pi-embedded.js"; +import { buildWorkspaceSkillSnapshot } from "./skills.js"; +import { getSkillsSnapshotVersion } from "./skills/refresh.js"; +import { normalizeSpawnedRunMetadata } from "./spawned-context.js"; +import { resolveAgentTimeoutMs } from "./timeout.js"; +import { ensureAgentWorkspace } from "./workspace.js"; + +type PersistSessionEntryParams = { + sessionStore: Record; + sessionKey: string; + storePath: string; + entry: SessionEntry; +}; + +type OverrideFieldClearedByDelete = + | "providerOverride" + | "modelOverride" + | "authProfileOverride" + | "authProfileOverrideSource" + | "authProfileOverrideCompactionCount" + | "fallbackNoticeSelectedModel" + | "fallbackNoticeActiveModel" + | "fallbackNoticeReason" + | "claudeCliSessionId"; + +const OVERRIDE_FIELDS_CLEARED_BY_DELETE: OverrideFieldClearedByDelete[] = [ + "providerOverride", + "modelOverride", + "authProfileOverride", + "authProfileOverrideSource", + "authProfileOverrideCompactionCount", + "fallbackNoticeSelectedModel", + "fallbackNoticeActiveModel", + "fallbackNoticeReason", + "claudeCliSessionId", +]; + +async function persistSessionEntry(params: PersistSessionEntryParams): Promise { + const persisted = await updateSessionStore(params.storePath, (store) => { + const merged = mergeSessionEntry(store[params.sessionKey], params.entry); + // Preserve explicit `delete` clears done by session override helpers. + for (const field of OVERRIDE_FIELDS_CLEARED_BY_DELETE) { + if (!Object.hasOwn(params.entry, field)) { + Reflect.deleteProperty(merged, field); + } + } + store[params.sessionKey] = merged; + return merged; + }); + params.sessionStore[params.sessionKey] = persisted; +} + +function resolveFallbackRetryPrompt(params: { body: string; isFallbackRetry: boolean }): string { + if (!params.isFallbackRetry) { + return params.body; + } + return "Continue where you left off. The previous model attempt failed or timed out."; +} + +function prependInternalEventContext( + body: string, + events: AgentCommandOpts["internalEvents"], +): string { + if (body.includes("OpenClaw runtime context (internal):")) { + return body; + } + const renderedEvents = formatAgentInternalEventsForPrompt(events); + if (!renderedEvents) { + return body; + } + return [renderedEvents, body].filter(Boolean).join("\n\n"); +} + +function createAcpVisibleTextAccumulator() { + let pendingSilentPrefix = ""; + let visibleText = ""; + const startsWithWordChar = (chunk: string): boolean => /^[\p{L}\p{N}]/u.test(chunk); + + const resolveNextCandidate = (base: string, chunk: string): string => { + if (!base) { + return chunk; + } + if ( + isSilentReplyText(base, SILENT_REPLY_TOKEN) && + !chunk.startsWith(base) && + startsWithWordChar(chunk) + ) { + return chunk; + } + // Some ACP backends emit cumulative snapshots even on text_delta-style hooks. + // Accept those only when they strictly extend the buffered text. + if (chunk.startsWith(base) && chunk.length > base.length) { + return chunk; + } + return `${base}${chunk}`; + }; + + const mergeVisibleChunk = (base: string, chunk: string): { text: string; delta: string } => { + if (!base) { + return { text: chunk, delta: chunk }; + } + if (chunk.startsWith(base) && chunk.length > base.length) { + const delta = chunk.slice(base.length); + return { text: chunk, delta }; + } + return { + text: `${base}${chunk}`, + delta: chunk, + }; + }; + + return { + consume(chunk: string): { text: string; delta: string } | null { + if (!chunk) { + return null; + } + + if (!visibleText) { + const leadCandidate = resolveNextCandidate(pendingSilentPrefix, chunk); + const trimmedLeadCandidate = leadCandidate.trim(); + if ( + isSilentReplyText(trimmedLeadCandidate, SILENT_REPLY_TOKEN) || + isSilentReplyPrefixText(trimmedLeadCandidate, SILENT_REPLY_TOKEN) + ) { + pendingSilentPrefix = leadCandidate; + return null; + } + if (pendingSilentPrefix) { + pendingSilentPrefix = ""; + visibleText = leadCandidate; + return { + text: visibleText, + delta: leadCandidate, + }; + } + } + + const nextVisible = mergeVisibleChunk(visibleText, chunk); + visibleText = nextVisible.text; + return nextVisible.delta ? nextVisible : null; + }, + finalize(): string { + return visibleText.trim(); + }, + finalizeRaw(): string { + return visibleText; + }, + }; +} + +const ACP_TRANSCRIPT_USAGE = { + input: 0, + output: 0, + cacheRead: 0, + cacheWrite: 0, + totalTokens: 0, + cost: { + input: 0, + output: 0, + cacheRead: 0, + cacheWrite: 0, + total: 0, + }, +} as const; + +async function persistAcpTurnTranscript(params: { + body: string; + finalText: string; + sessionId: string; + sessionKey: string; + sessionEntry: SessionEntry | undefined; + sessionStore?: Record; + storePath?: string; + sessionAgentId: string; + threadId?: string | number; + sessionCwd: string; +}): Promise { + const promptText = params.body; + const replyText = params.finalText; + if (!promptText && !replyText) { + return params.sessionEntry; + } + + const { sessionFile, sessionEntry } = await resolveSessionTranscriptFile({ + sessionId: params.sessionId, + sessionKey: params.sessionKey, + sessionEntry: params.sessionEntry, + sessionStore: params.sessionStore, + storePath: params.storePath, + agentId: params.sessionAgentId, + threadId: params.threadId, + }); + const hadSessionFile = await fs + .access(sessionFile) + .then(() => true) + .catch(() => false); + const sessionManager = SessionManager.open(sessionFile); + await prepareSessionManagerForRun({ + sessionManager, + sessionFile, + hadSessionFile, + sessionId: params.sessionId, + cwd: params.sessionCwd, + }); + + if (promptText) { + sessionManager.appendMessage({ + role: "user", + content: promptText, + timestamp: Date.now(), + }); + } + + if (replyText) { + sessionManager.appendMessage({ + role: "assistant", + content: [{ type: "text", text: replyText }], + api: "openai-responses", + provider: "openclaw", + model: "acp-runtime", + usage: ACP_TRANSCRIPT_USAGE, + stopReason: "stop", + timestamp: Date.now(), + }); + } + + emitSessionTranscriptUpdate(sessionFile); + return sessionEntry; +} + +function runAgentAttempt(params: { + providerOverride: string; + modelOverride: string; + cfg: ReturnType; + sessionEntry: SessionEntry | undefined; + sessionId: string; + sessionKey: string | undefined; + sessionAgentId: string; + sessionFile: string; + workspaceDir: string; + body: string; + isFallbackRetry: boolean; + resolvedThinkLevel: ThinkLevel; + timeoutMs: number; + runId: string; + opts: AgentCommandOpts & { senderIsOwner: boolean }; + runContext: ReturnType; + spawnedBy: string | undefined; + messageChannel: ReturnType; + skillsSnapshot: ReturnType | undefined; + resolvedVerboseLevel: VerboseLevel | undefined; + agentDir: string; + onAgentEvent: (evt: { stream: string; data?: Record }) => void; + primaryProvider: string; + sessionStore?: Record; + storePath?: string; + allowTransientCooldownProbe?: boolean; +}) { + const effectivePrompt = resolveFallbackRetryPrompt({ + body: params.body, + isFallbackRetry: params.isFallbackRetry, + }); + const bootstrapPromptWarningSignaturesSeen = resolveBootstrapWarningSignaturesSeen( + params.sessionEntry?.systemPromptReport, + ); + const bootstrapPromptWarningSignature = + bootstrapPromptWarningSignaturesSeen[bootstrapPromptWarningSignaturesSeen.length - 1]; + if (isCliProvider(params.providerOverride, params.cfg)) { + const cliSessionId = getCliSessionId(params.sessionEntry, params.providerOverride); + const runCliWithSession = (nextCliSessionId: string | undefined) => + runCliAgent({ + sessionId: params.sessionId, + sessionKey: params.sessionKey, + agentId: params.sessionAgentId, + sessionFile: params.sessionFile, + workspaceDir: params.workspaceDir, + config: params.cfg, + prompt: effectivePrompt, + provider: params.providerOverride, + model: params.modelOverride, + thinkLevel: params.resolvedThinkLevel, + timeoutMs: params.timeoutMs, + runId: params.runId, + extraSystemPrompt: params.opts.extraSystemPrompt, + cliSessionId: nextCliSessionId, + bootstrapPromptWarningSignaturesSeen, + bootstrapPromptWarningSignature, + images: params.isFallbackRetry ? undefined : params.opts.images, + streamParams: params.opts.streamParams, + }); + return runCliWithSession(cliSessionId).catch(async (err) => { + // Handle CLI session expired error + if ( + err instanceof FailoverError && + err.reason === "session_expired" && + cliSessionId && + params.sessionKey && + params.sessionStore && + params.storePath + ) { + log.warn( + `CLI session expired, clearing from session store: provider=${params.providerOverride} sessionKey=${params.sessionKey}`, + ); + + // Clear the expired session ID from the session store + const entry = params.sessionStore[params.sessionKey]; + if (entry) { + const updatedEntry = { ...entry }; + if (params.providerOverride === "claude-cli") { + delete updatedEntry.claudeCliSessionId; + } + if (updatedEntry.cliSessionIds) { + const normalizedProvider = normalizeProviderId(params.providerOverride); + const newCliSessionIds = { ...updatedEntry.cliSessionIds }; + delete newCliSessionIds[normalizedProvider]; + updatedEntry.cliSessionIds = newCliSessionIds; + } + updatedEntry.updatedAt = Date.now(); + + await persistSessionEntry({ + sessionStore: params.sessionStore, + sessionKey: params.sessionKey, + storePath: params.storePath, + entry: updatedEntry, + }); + + // Update the session entry reference + params.sessionEntry = updatedEntry; + } + + // Retry with no session ID (will create a new session) + return runCliWithSession(undefined).then(async (result) => { + // Update session store with new CLI session ID if available + if ( + result.meta.agentMeta?.sessionId && + params.sessionKey && + params.sessionStore && + params.storePath + ) { + const entry = params.sessionStore[params.sessionKey]; + if (entry) { + const updatedEntry = { ...entry }; + setCliSessionId( + updatedEntry, + params.providerOverride, + result.meta.agentMeta.sessionId, + ); + updatedEntry.updatedAt = Date.now(); + + await persistSessionEntry({ + sessionStore: params.sessionStore, + sessionKey: params.sessionKey, + storePath: params.storePath, + entry: updatedEntry, + }); + } + } + return result; + }); + } + throw err; + }); + } + + const authProfileId = + params.providerOverride === params.primaryProvider + ? params.sessionEntry?.authProfileOverride + : undefined; + return runEmbeddedPiAgent({ + sessionId: params.sessionId, + sessionKey: params.sessionKey, + agentId: params.sessionAgentId, + trigger: "user", + messageChannel: params.messageChannel, + agentAccountId: params.runContext.accountId, + messageTo: params.opts.replyTo ?? params.opts.to, + messageThreadId: params.opts.threadId, + groupId: params.runContext.groupId, + groupChannel: params.runContext.groupChannel, + groupSpace: params.runContext.groupSpace, + spawnedBy: params.spawnedBy, + currentChannelId: params.runContext.currentChannelId, + currentThreadTs: params.runContext.currentThreadTs, + replyToMode: params.runContext.replyToMode, + hasRepliedRef: params.runContext.hasRepliedRef, + senderIsOwner: params.opts.senderIsOwner, + sessionFile: params.sessionFile, + workspaceDir: params.workspaceDir, + config: params.cfg, + skillsSnapshot: params.skillsSnapshot, + prompt: effectivePrompt, + images: params.isFallbackRetry ? undefined : params.opts.images, + clientTools: params.opts.clientTools, + provider: params.providerOverride, + model: params.modelOverride, + authProfileId, + authProfileIdSource: authProfileId ? params.sessionEntry?.authProfileOverrideSource : undefined, + thinkLevel: params.resolvedThinkLevel, + verboseLevel: params.resolvedVerboseLevel, + timeoutMs: params.timeoutMs, + runId: params.runId, + lane: params.opts.lane, + abortSignal: params.opts.abortSignal, + extraSystemPrompt: params.opts.extraSystemPrompt, + inputProvenance: params.opts.inputProvenance, + streamParams: params.opts.streamParams, + agentDir: params.agentDir, + allowTransientCooldownProbe: params.allowTransientCooldownProbe, + onAgentEvent: params.onAgentEvent, + bootstrapPromptWarningSignaturesSeen, + bootstrapPromptWarningSignature, + }); +} + +async function prepareAgentCommandExecution( + opts: AgentCommandOpts & { senderIsOwner: boolean }, + runtime: RuntimeEnv, +) { + const message = opts.message ?? ""; + if (!message.trim()) { + throw new Error("Message (--message) is required"); + } + const body = prependInternalEventContext(message, opts.internalEvents); + if (!opts.to && !opts.sessionId && !opts.sessionKey && !opts.agentId) { + throw new Error("Pass --to , --session-id, or --agent to choose a session"); + } + + const loadedRaw = loadConfig(); + const sourceConfig = await (async () => { + try { + const { snapshot } = await readConfigFileSnapshotForWrite(); + if (snapshot.valid) { + return snapshot.resolved; + } + } catch { + // Fall back to runtime-loaded config when source snapshot is unavailable. + } + return loadedRaw; + })(); + const { resolvedConfig: cfg, diagnostics } = await resolveCommandSecretRefsViaGateway({ + config: loadedRaw, + commandName: "agent", + targetIds: getAgentRuntimeCommandSecretTargetIds(), + }); + setRuntimeConfigSnapshot(cfg, sourceConfig); + const normalizedSpawned = normalizeSpawnedRunMetadata({ + spawnedBy: opts.spawnedBy, + groupId: opts.groupId, + groupChannel: opts.groupChannel, + groupSpace: opts.groupSpace, + workspaceDir: opts.workspaceDir, + }); + for (const entry of diagnostics) { + runtime.log(`[secrets] ${entry}`); + } + const agentIdOverrideRaw = opts.agentId?.trim(); + const agentIdOverride = agentIdOverrideRaw ? normalizeAgentId(agentIdOverrideRaw) : undefined; + if (agentIdOverride) { + const knownAgents = listAgentIds(cfg); + if (!knownAgents.includes(agentIdOverride)) { + throw new Error( + `Unknown agent id "${agentIdOverrideRaw}". Use "${formatCliCommand("openclaw agents list")}" to see configured agents.`, + ); + } + } + if (agentIdOverride && opts.sessionKey) { + const sessionAgentId = resolveAgentIdFromSessionKey(opts.sessionKey); + if (sessionAgentId !== agentIdOverride) { + throw new Error( + `Agent id "${agentIdOverrideRaw}" does not match session key agent "${sessionAgentId}".`, + ); + } + } + const agentCfg = cfg.agents?.defaults; + const configuredModel = resolveConfiguredModelRef({ + cfg, + defaultProvider: DEFAULT_PROVIDER, + defaultModel: DEFAULT_MODEL, + }); + const thinkingLevelsHint = formatThinkingLevels(configuredModel.provider, configuredModel.model); + + const thinkOverride = normalizeThinkLevel(opts.thinking); + const thinkOnce = normalizeThinkLevel(opts.thinkingOnce); + if (opts.thinking && !thinkOverride) { + throw new Error(`Invalid thinking level. Use one of: ${thinkingLevelsHint}.`); + } + if (opts.thinkingOnce && !thinkOnce) { + throw new Error(`Invalid one-shot thinking level. Use one of: ${thinkingLevelsHint}.`); + } + + const verboseOverride = normalizeVerboseLevel(opts.verbose); + if (opts.verbose && !verboseOverride) { + throw new Error('Invalid verbose level. Use "on", "full", or "off".'); + } + + const laneRaw = typeof opts.lane === "string" ? opts.lane.trim() : ""; + const isSubagentLane = laneRaw === String(AGENT_LANE_SUBAGENT); + const timeoutSecondsRaw = + opts.timeout !== undefined + ? Number.parseInt(String(opts.timeout), 10) + : isSubagentLane + ? 0 + : undefined; + if ( + timeoutSecondsRaw !== undefined && + (Number.isNaN(timeoutSecondsRaw) || timeoutSecondsRaw < 0) + ) { + throw new Error("--timeout must be a non-negative integer (seconds; 0 means no timeout)"); + } + const timeoutMs = resolveAgentTimeoutMs({ + cfg, + overrideSeconds: timeoutSecondsRaw, + }); + + const sessionResolution = resolveSession({ + cfg, + to: opts.to, + sessionId: opts.sessionId, + sessionKey: opts.sessionKey, + agentId: agentIdOverride, + }); + + const { + sessionId, + sessionKey, + sessionEntry: sessionEntryRaw, + sessionStore, + storePath, + isNewSession, + persistedThinking, + persistedVerbose, + } = sessionResolution; + const sessionAgentId = + agentIdOverride ?? + resolveSessionAgentId({ + sessionKey: sessionKey ?? opts.sessionKey?.trim(), + config: cfg, + }); + const outboundSession = buildOutboundSessionContext({ + cfg, + agentId: sessionAgentId, + sessionKey, + }); + // Internal callers (for example subagent spawns) may pin workspace inheritance. + const workspaceDirRaw = + normalizedSpawned.workspaceDir ?? resolveAgentWorkspaceDir(cfg, sessionAgentId); + const agentDir = resolveAgentDir(cfg, sessionAgentId); + const workspace = await ensureAgentWorkspace({ + dir: workspaceDirRaw, + ensureBootstrapFiles: !agentCfg?.skipBootstrap, + }); + const workspaceDir = workspace.dir; + const runId = opts.runId?.trim() || sessionId; + const acpManager = getAcpSessionManager(); + const acpResolution = sessionKey + ? acpManager.resolveSession({ + cfg, + sessionKey, + }) + : null; + + return { + body, + cfg, + normalizedSpawned, + agentCfg, + thinkOverride, + thinkOnce, + verboseOverride, + timeoutMs, + sessionId, + sessionKey, + sessionEntry: sessionEntryRaw, + sessionStore, + storePath, + isNewSession, + persistedThinking, + persistedVerbose, + sessionAgentId, + outboundSession, + workspaceDir, + agentDir, + runId, + acpManager, + acpResolution, + }; +} + +async function agentCommandInternal( + opts: AgentCommandOpts & { senderIsOwner: boolean }, + runtime: RuntimeEnv = defaultRuntime, + deps: CliDeps = createDefaultDeps(), +) { + const prepared = await prepareAgentCommandExecution(opts, runtime); + const { + body, + cfg, + normalizedSpawned, + agentCfg, + thinkOverride, + thinkOnce, + verboseOverride, + timeoutMs, + sessionId, + sessionKey, + sessionStore, + storePath, + isNewSession, + persistedThinking, + persistedVerbose, + sessionAgentId, + outboundSession, + workspaceDir, + agentDir, + runId, + acpManager, + acpResolution, + } = prepared; + let sessionEntry = prepared.sessionEntry; + + try { + if (opts.deliver === true) { + const sendPolicy = resolveSendPolicy({ + cfg, + entry: sessionEntry, + sessionKey, + channel: sessionEntry?.channel, + chatType: sessionEntry?.chatType, + }); + if (sendPolicy === "deny") { + throw new Error("send blocked by session policy"); + } + } + + if (acpResolution?.kind === "stale") { + throw acpResolution.error; + } + + if (acpResolution?.kind === "ready" && sessionKey) { + const startedAt = Date.now(); + registerAgentRunContext(runId, { + sessionKey, + }); + emitAgentEvent({ + runId, + stream: "lifecycle", + data: { + phase: "start", + startedAt, + }, + }); + + const visibleTextAccumulator = createAcpVisibleTextAccumulator(); + let stopReason: string | undefined; + try { + const dispatchPolicyError = resolveAcpDispatchPolicyError(cfg); + if (dispatchPolicyError) { + throw dispatchPolicyError; + } + const acpAgent = normalizeAgentId( + acpResolution.meta.agent || resolveAgentIdFromSessionKey(sessionKey), + ); + const agentPolicyError = resolveAcpAgentPolicyError(cfg, acpAgent); + if (agentPolicyError) { + throw agentPolicyError; + } + + await acpManager.runTurn({ + cfg, + sessionKey, + text: body, + mode: "prompt", + requestId: runId, + signal: opts.abortSignal, + onEvent: (event) => { + if (event.type === "done") { + stopReason = event.stopReason; + return; + } + if (event.type !== "text_delta") { + return; + } + if (event.stream && event.stream !== "output") { + return; + } + if (!event.text) { + return; + } + const visibleUpdate = visibleTextAccumulator.consume(event.text); + if (!visibleUpdate) { + return; + } + emitAgentEvent({ + runId, + stream: "assistant", + data: { + text: visibleUpdate.text, + delta: visibleUpdate.delta, + }, + }); + }, + }); + } catch (error) { + const acpError = toAcpRuntimeError({ + error, + fallbackCode: "ACP_TURN_FAILED", + fallbackMessage: "ACP turn failed before completion.", + }); + emitAgentEvent({ + runId, + stream: "lifecycle", + data: { + phase: "error", + error: acpError.message, + endedAt: Date.now(), + }, + }); + throw acpError; + } + + emitAgentEvent({ + runId, + stream: "lifecycle", + data: { + phase: "end", + endedAt: Date.now(), + }, + }); + + const finalTextRaw = visibleTextAccumulator.finalizeRaw(); + const finalText = visibleTextAccumulator.finalize(); + try { + sessionEntry = await persistAcpTurnTranscript({ + body, + finalText: finalTextRaw, + sessionId, + sessionKey, + sessionEntry, + sessionStore, + storePath, + sessionAgentId, + threadId: opts.threadId, + sessionCwd: resolveAcpSessionCwd(acpResolution.meta) ?? workspaceDir, + }); + } catch (error) { + log.warn( + `ACP transcript persistence failed for ${sessionKey}: ${error instanceof Error ? error.message : String(error)}`, + ); + } + + const normalizedFinalPayload = normalizeReplyPayload({ + text: finalText, + }); + const payloads = normalizedFinalPayload ? [normalizedFinalPayload] : []; + const result = { + payloads, + meta: { + durationMs: Date.now() - startedAt, + aborted: opts.abortSignal?.aborted === true, + stopReason, + }, + }; + + return await deliverAgentCommandResult({ + cfg, + deps, + runtime, + opts, + outboundSession, + sessionEntry, + result, + payloads, + }); + } + + let resolvedThinkLevel = thinkOnce ?? thinkOverride ?? persistedThinking; + const resolvedVerboseLevel = + verboseOverride ?? persistedVerbose ?? (agentCfg?.verboseDefault as VerboseLevel | undefined); + + if (sessionKey) { + registerAgentRunContext(runId, { + sessionKey, + verboseLevel: resolvedVerboseLevel, + }); + } + + const needsSkillsSnapshot = isNewSession || !sessionEntry?.skillsSnapshot; + const skillsSnapshotVersion = getSkillsSnapshotVersion(workspaceDir); + const skillFilter = resolveAgentSkillsFilter(cfg, sessionAgentId); + const skillsSnapshot = needsSkillsSnapshot + ? buildWorkspaceSkillSnapshot(workspaceDir, { + config: cfg, + eligibility: { remote: getRemoteSkillEligibility() }, + snapshotVersion: skillsSnapshotVersion, + skillFilter, + }) + : sessionEntry?.skillsSnapshot; + + if (skillsSnapshot && sessionStore && sessionKey && needsSkillsSnapshot) { + const current = sessionEntry ?? { + sessionId, + updatedAt: Date.now(), + }; + const next: SessionEntry = { + ...current, + sessionId, + updatedAt: Date.now(), + skillsSnapshot, + }; + await persistSessionEntry({ + sessionStore, + sessionKey, + storePath, + entry: next, + }); + sessionEntry = next; + } + + // Persist explicit /command overrides to the session store when we have a key. + if (sessionStore && sessionKey) { + const entry = sessionStore[sessionKey] ?? + sessionEntry ?? { sessionId, updatedAt: Date.now() }; + const next: SessionEntry = { ...entry, sessionId, updatedAt: Date.now() }; + if (thinkOverride) { + next.thinkingLevel = thinkOverride; + } + applyVerboseOverride(next, verboseOverride); + await persistSessionEntry({ + sessionStore, + sessionKey, + storePath, + entry: next, + }); + sessionEntry = next; + } + + const configuredDefaultRef = resolveDefaultModelForAgent({ + cfg, + agentId: sessionAgentId, + }); + const { provider: defaultProvider, model: defaultModel } = normalizeModelRef( + configuredDefaultRef.provider, + configuredDefaultRef.model, + ); + let provider = defaultProvider; + let model = defaultModel; + const hasAllowlist = agentCfg?.models && Object.keys(agentCfg.models).length > 0; + const hasStoredOverride = Boolean( + sessionEntry?.modelOverride || sessionEntry?.providerOverride, + ); + const needsModelCatalog = hasAllowlist || hasStoredOverride; + let allowedModelKeys = new Set(); + let allowedModelCatalog: Awaited> = []; + let modelCatalog: Awaited> | null = null; + let allowAnyModel = false; + + if (needsModelCatalog) { + modelCatalog = await loadModelCatalog({ config: cfg }); + const allowed = buildAllowedModelSet({ + cfg, + catalog: modelCatalog, + defaultProvider, + defaultModel, + agentId: sessionAgentId, + }); + allowedModelKeys = allowed.allowedKeys; + allowedModelCatalog = allowed.allowedCatalog; + allowAnyModel = allowed.allowAny ?? false; + } + + if (sessionEntry && sessionStore && sessionKey && hasStoredOverride) { + const entry = sessionEntry; + const overrideProvider = sessionEntry.providerOverride?.trim() || defaultProvider; + const overrideModel = sessionEntry.modelOverride?.trim(); + if (overrideModel) { + const normalizedOverride = normalizeModelRef(overrideProvider, overrideModel); + const key = modelKey(normalizedOverride.provider, normalizedOverride.model); + if ( + !isCliProvider(normalizedOverride.provider, cfg) && + !allowAnyModel && + !allowedModelKeys.has(key) + ) { + const { updated } = applyModelOverrideToSessionEntry({ + entry, + selection: { provider: defaultProvider, model: defaultModel, isDefault: true }, + }); + if (updated) { + await persistSessionEntry({ + sessionStore, + sessionKey, + storePath, + entry, + }); + } + } + } + } + + const storedProviderOverride = sessionEntry?.providerOverride?.trim(); + const storedModelOverride = sessionEntry?.modelOverride?.trim(); + if (storedModelOverride) { + const candidateProvider = storedProviderOverride || defaultProvider; + const normalizedStored = normalizeModelRef(candidateProvider, storedModelOverride); + const key = modelKey(normalizedStored.provider, normalizedStored.model); + if ( + isCliProvider(normalizedStored.provider, cfg) || + allowAnyModel || + allowedModelKeys.has(key) + ) { + provider = normalizedStored.provider; + model = normalizedStored.model; + } + } + if (sessionEntry) { + const authProfileId = sessionEntry.authProfileOverride; + if (authProfileId) { + const entry = sessionEntry; + const store = ensureAuthProfileStore(); + const profile = store.profiles[authProfileId]; + if (!profile || profile.provider !== provider) { + if (sessionStore && sessionKey) { + await clearSessionAuthProfileOverride({ + sessionEntry: entry, + sessionStore, + sessionKey, + storePath, + }); + } + } + } + } + + if (!resolvedThinkLevel) { + let catalogForThinking = modelCatalog ?? allowedModelCatalog; + if (!catalogForThinking || catalogForThinking.length === 0) { + modelCatalog = await loadModelCatalog({ config: cfg }); + catalogForThinking = modelCatalog; + } + resolvedThinkLevel = resolveThinkingDefault({ + cfg, + provider, + model, + catalog: catalogForThinking, + }); + } + if (resolvedThinkLevel === "xhigh" && !supportsXHighThinking(provider, model)) { + const explicitThink = Boolean(thinkOnce || thinkOverride); + if (explicitThink) { + throw new Error(`Thinking level "xhigh" is only supported for ${formatXHighModelHint()}.`); + } + resolvedThinkLevel = "high"; + if (sessionEntry && sessionStore && sessionKey && sessionEntry.thinkingLevel === "xhigh") { + const entry = sessionEntry; + entry.thinkingLevel = "high"; + entry.updatedAt = Date.now(); + await persistSessionEntry({ + sessionStore, + sessionKey, + storePath, + entry, + }); + } + } + let sessionFile: string | undefined; + if (sessionStore && sessionKey) { + const resolvedSessionFile = await resolveSessionTranscriptFile({ + sessionId, + sessionKey, + sessionStore, + storePath, + sessionEntry, + agentId: sessionAgentId, + threadId: opts.threadId, + }); + sessionFile = resolvedSessionFile.sessionFile; + sessionEntry = resolvedSessionFile.sessionEntry; + } + if (!sessionFile) { + const resolvedSessionFile = await resolveSessionTranscriptFile({ + sessionId, + sessionKey: sessionKey ?? sessionId, + sessionEntry, + agentId: sessionAgentId, + threadId: opts.threadId, + }); + sessionFile = resolvedSessionFile.sessionFile; + sessionEntry = resolvedSessionFile.sessionEntry; + } + + const startedAt = Date.now(); + let lifecycleEnded = false; + + let result: Awaited>; + let fallbackProvider = provider; + let fallbackModel = model; + try { + const runContext = resolveAgentRunContext(opts); + const messageChannel = resolveMessageChannel( + runContext.messageChannel, + opts.replyChannel ?? opts.channel, + ); + const spawnedBy = normalizedSpawned.spawnedBy ?? sessionEntry?.spawnedBy; + // Keep fallback candidate resolution centralized so session model overrides, + // per-agent overrides, and default fallbacks stay consistent across callers. + const effectiveFallbacksOverride = resolveEffectiveModelFallbacks({ + cfg, + agentId: sessionAgentId, + hasSessionModelOverride: Boolean(storedModelOverride), + }); + + // Track model fallback attempts so retries on an existing session don't + // re-inject the original prompt as a duplicate user message. + let fallbackAttemptIndex = 0; + const fallbackResult = await runWithModelFallback({ + cfg, + provider, + model, + runId, + agentDir, + fallbacksOverride: effectiveFallbacksOverride, + run: (providerOverride, modelOverride, runOptions) => { + const isFallbackRetry = fallbackAttemptIndex > 0; + fallbackAttemptIndex += 1; + return runAgentAttempt({ + providerOverride, + modelOverride, + cfg, + sessionEntry, + sessionId, + sessionKey, + sessionAgentId, + sessionFile, + workspaceDir, + body, + isFallbackRetry, + resolvedThinkLevel, + timeoutMs, + runId, + opts, + runContext, + spawnedBy, + messageChannel, + skillsSnapshot, + resolvedVerboseLevel, + agentDir, + primaryProvider: provider, + sessionStore, + storePath, + allowTransientCooldownProbe: runOptions?.allowTransientCooldownProbe, + onAgentEvent: (evt) => { + // Track lifecycle end for fallback emission below. + if ( + evt.stream === "lifecycle" && + typeof evt.data?.phase === "string" && + (evt.data.phase === "end" || evt.data.phase === "error") + ) { + lifecycleEnded = true; + } + }, + }); + }, + }); + result = fallbackResult.result; + fallbackProvider = fallbackResult.provider; + fallbackModel = fallbackResult.model; + if (!lifecycleEnded) { + const stopReason = result.meta.stopReason; + if (stopReason && stopReason !== "end_turn") { + console.error(`[agent] run ${runId} ended with stopReason=${stopReason}`); + } + emitAgentEvent({ + runId, + stream: "lifecycle", + data: { + phase: "end", + startedAt, + endedAt: Date.now(), + aborted: result.meta.aborted ?? false, + stopReason, + }, + }); + } + } catch (err) { + if (!lifecycleEnded) { + emitAgentEvent({ + runId, + stream: "lifecycle", + data: { + phase: "error", + startedAt, + endedAt: Date.now(), + error: String(err), + }, + }); + } + throw err; + } + + // Update token+model fields in the session store. + if (sessionStore && sessionKey) { + await updateSessionStoreAfterAgentRun({ + cfg, + contextTokensOverride: agentCfg?.contextTokens, + sessionId, + sessionKey, + storePath, + sessionStore, + defaultProvider: provider, + defaultModel: model, + fallbackProvider, + fallbackModel, + result, + }); + } + + const payloads = result.payloads ?? []; + return await deliverAgentCommandResult({ + cfg, + deps, + runtime, + opts, + outboundSession, + sessionEntry, + result, + payloads, + }); + } finally { + clearAgentRunContext(runId); + } +} + +export async function agentCommand( + opts: AgentCommandOpts, + runtime: RuntimeEnv = defaultRuntime, + deps: CliDeps = createDefaultDeps(), +) { + return await agentCommandInternal( + { + ...opts, + // agentCommand is the trusted-operator entrypoint used by CLI/local flows. + // Ingress callers must opt into owner semantics explicitly via + // agentCommandFromIngress so network-facing paths cannot inherit this default by accident. + senderIsOwner: opts.senderIsOwner ?? true, + }, + runtime, + deps, + ); +} + +export async function agentCommandFromIngress( + opts: AgentCommandIngressOpts, + runtime: RuntimeEnv = defaultRuntime, + deps: CliDeps = createDefaultDeps(), +) { + if (typeof opts.senderIsOwner !== "boolean") { + // HTTP/WS ingress must declare the trust level explicitly at the boundary. + // This keeps network-facing callers from silently picking up the local trusted default. + throw new Error("senderIsOwner must be explicitly set for ingress agent runs."); + } + return await agentCommandInternal( + { + ...opts, + senderIsOwner: opts.senderIsOwner, + }, + runtime, + deps, + ); +} diff --git a/src/agents/cli-runner.ts b/src/agents/cli-runner.ts index f9b0f5542c5..93cebc6dd14 100644 --- a/src/agents/cli-runner.ts +++ b/src/agents/cli-runner.ts @@ -63,7 +63,7 @@ export async function runCliAgent(params: { timeoutMs: number; runId: string; extraSystemPrompt?: string; - streamParams?: import("../commands/agent/types.js").AgentStreamParams; + streamParams?: import("./command/types.js").AgentStreamParams; ownerNumbers?: string[]; cliSessionId?: string; bootstrapPromptWarningSignaturesSeen?: string[]; diff --git a/src/agents/command/delivery.ts b/src/agents/command/delivery.ts new file mode 100644 index 00000000000..d3a011017fb --- /dev/null +++ b/src/agents/command/delivery.ts @@ -0,0 +1,238 @@ +import { getChannelPlugin, normalizeChannelId } from "../../channels/plugins/index.js"; +import { createOutboundSendDeps, type CliDeps } from "../../cli/outbound-send-deps.js"; +import type { OpenClawConfig } from "../../config/config.js"; +import type { SessionEntry } from "../../config/sessions.js"; +import { + resolveAgentDeliveryPlan, + resolveAgentOutboundTarget, +} from "../../infra/outbound/agent-delivery.js"; +import { resolveMessageChannelSelection } from "../../infra/outbound/channel-selection.js"; +import { deliverOutboundPayloads } from "../../infra/outbound/deliver.js"; +import { buildOutboundResultEnvelope } from "../../infra/outbound/envelope.js"; +import { + formatOutboundPayloadLog, + type NormalizedOutboundPayload, + normalizeOutboundPayloads, + normalizeOutboundPayloadsForJson, +} from "../../infra/outbound/payloads.js"; +import type { OutboundSessionContext } from "../../infra/outbound/session-context.js"; +import type { RuntimeEnv } from "../../runtime.js"; +import { isInternalMessageChannel } from "../../utils/message-channel.js"; +import { AGENT_LANE_NESTED } from "../lanes.js"; +import type { AgentCommandOpts } from "./types.js"; + +type RunResult = Awaited>; + +const NESTED_LOG_PREFIX = "[agent:nested]"; + +function formatNestedLogPrefix(opts: AgentCommandOpts, sessionKey?: string): string { + const parts = [NESTED_LOG_PREFIX]; + const session = sessionKey ?? opts.sessionKey ?? opts.sessionId; + if (session) { + parts.push(`session=${session}`); + } + if (opts.runId) { + parts.push(`run=${opts.runId}`); + } + const channel = opts.messageChannel ?? opts.channel; + if (channel) { + parts.push(`channel=${channel}`); + } + if (opts.to) { + parts.push(`to=${opts.to}`); + } + if (opts.accountId) { + parts.push(`account=${opts.accountId}`); + } + return parts.join(" "); +} + +function logNestedOutput( + runtime: RuntimeEnv, + opts: AgentCommandOpts, + output: string, + sessionKey?: string, +) { + const prefix = formatNestedLogPrefix(opts, sessionKey); + for (const line of output.split(/\r?\n/)) { + if (!line) { + continue; + } + runtime.log(`${prefix} ${line}`); + } +} + +export async function deliverAgentCommandResult(params: { + cfg: OpenClawConfig; + deps: CliDeps; + runtime: RuntimeEnv; + opts: AgentCommandOpts; + outboundSession: OutboundSessionContext | undefined; + sessionEntry: SessionEntry | undefined; + result: RunResult; + payloads: RunResult["payloads"]; +}) { + const { cfg, deps, runtime, opts, outboundSession, sessionEntry, payloads, result } = params; + const effectiveSessionKey = outboundSession?.key ?? opts.sessionKey; + const deliver = opts.deliver === true; + const bestEffortDeliver = opts.bestEffortDeliver === true; + const turnSourceChannel = opts.runContext?.messageChannel ?? opts.messageChannel; + const turnSourceTo = opts.runContext?.currentChannelId ?? opts.to; + const turnSourceAccountId = opts.runContext?.accountId ?? opts.accountId; + const turnSourceThreadId = opts.runContext?.currentThreadTs ?? opts.threadId; + const deliveryPlan = resolveAgentDeliveryPlan({ + sessionEntry, + requestedChannel: opts.replyChannel ?? opts.channel, + explicitTo: opts.replyTo ?? opts.to, + explicitThreadId: opts.threadId, + accountId: opts.replyAccountId ?? opts.accountId, + wantsDelivery: deliver, + turnSourceChannel, + turnSourceTo, + turnSourceAccountId, + turnSourceThreadId, + }); + let deliveryChannel = deliveryPlan.resolvedChannel; + const explicitChannelHint = (opts.replyChannel ?? opts.channel)?.trim(); + if (deliver && isInternalMessageChannel(deliveryChannel) && !explicitChannelHint) { + try { + const selection = await resolveMessageChannelSelection({ cfg }); + deliveryChannel = selection.channel; + } catch { + // Keep the internal channel marker; error handling below reports the failure. + } + } + const effectiveDeliveryPlan = + deliveryChannel === deliveryPlan.resolvedChannel + ? deliveryPlan + : { + ...deliveryPlan, + resolvedChannel: deliveryChannel, + }; + // Channel docking: delivery channels are resolved via plugin registry. + const deliveryPlugin = !isInternalMessageChannel(deliveryChannel) + ? getChannelPlugin(normalizeChannelId(deliveryChannel) ?? deliveryChannel) + : undefined; + + const isDeliveryChannelKnown = + isInternalMessageChannel(deliveryChannel) || Boolean(deliveryPlugin); + + const targetMode = + opts.deliveryTargetMode ?? + effectiveDeliveryPlan.deliveryTargetMode ?? + (opts.to ? "explicit" : "implicit"); + const resolvedAccountId = effectiveDeliveryPlan.resolvedAccountId; + const resolved = + deliver && isDeliveryChannelKnown && deliveryChannel + ? resolveAgentOutboundTarget({ + cfg, + plan: effectiveDeliveryPlan, + targetMode, + validateExplicitTarget: true, + }) + : { + resolvedTarget: null, + resolvedTo: effectiveDeliveryPlan.resolvedTo, + targetMode, + }; + const resolvedTarget = resolved.resolvedTarget; + const deliveryTarget = resolved.resolvedTo; + const resolvedThreadId = deliveryPlan.resolvedThreadId ?? opts.threadId; + const resolvedReplyToId = + deliveryChannel === "slack" && resolvedThreadId != null ? String(resolvedThreadId) : undefined; + const resolvedThreadTarget = deliveryChannel === "slack" ? undefined : resolvedThreadId; + + const logDeliveryError = (err: unknown) => { + const message = `Delivery failed (${deliveryChannel}${deliveryTarget ? ` to ${deliveryTarget}` : ""}): ${String(err)}`; + runtime.error?.(message); + if (!runtime.error) { + runtime.log(message); + } + }; + + if (deliver) { + if (isInternalMessageChannel(deliveryChannel)) { + const err = new Error( + "delivery channel is required: pass --channel/--reply-channel or use a main session with a previous channel", + ); + if (!bestEffortDeliver) { + throw err; + } + logDeliveryError(err); + } else if (!isDeliveryChannelKnown) { + const err = new Error(`Unknown channel: ${deliveryChannel}`); + if (!bestEffortDeliver) { + throw err; + } + logDeliveryError(err); + } else if (resolvedTarget && !resolvedTarget.ok) { + if (!bestEffortDeliver) { + throw resolvedTarget.error; + } + logDeliveryError(resolvedTarget.error); + } + } + + const normalizedPayloads = normalizeOutboundPayloadsForJson(payloads ?? []); + if (opts.json) { + runtime.log( + JSON.stringify( + buildOutboundResultEnvelope({ + payloads: normalizedPayloads, + meta: result.meta, + }), + null, + 2, + ), + ); + if (!deliver) { + return { payloads: normalizedPayloads, meta: result.meta }; + } + } + + if (!payloads || payloads.length === 0) { + runtime.log("No reply from agent."); + return { payloads: [], meta: result.meta }; + } + + const deliveryPayloads = normalizeOutboundPayloads(payloads); + const logPayload = (payload: NormalizedOutboundPayload) => { + if (opts.json) { + return; + } + const output = formatOutboundPayloadLog(payload); + if (!output) { + return; + } + if (opts.lane === AGENT_LANE_NESTED) { + logNestedOutput(runtime, opts, output, effectiveSessionKey); + return; + } + runtime.log(output); + }; + if (!deliver) { + for (const payload of deliveryPayloads) { + logPayload(payload); + } + } + if (deliver && deliveryChannel && !isInternalMessageChannel(deliveryChannel)) { + if (deliveryTarget) { + await deliverOutboundPayloads({ + cfg, + channel: deliveryChannel, + to: deliveryTarget, + accountId: resolvedAccountId, + payloads: deliveryPayloads, + session: outboundSession, + replyToId: resolvedReplyToId ?? null, + threadId: resolvedThreadTarget ?? null, + bestEffort: bestEffortDeliver, + onError: (err) => logDeliveryError(err), + onPayload: logPayload, + deps: createOutboundSendDeps(deps), + }); + } + } + + return { payloads: normalizedPayloads, meta: result.meta }; +} diff --git a/src/agents/command/run-context.ts b/src/agents/command/run-context.ts new file mode 100644 index 00000000000..b6c121a6c0a --- /dev/null +++ b/src/agents/command/run-context.ts @@ -0,0 +1,55 @@ +import { normalizeAccountId } from "../../utils/account-id.js"; +import { resolveMessageChannel } from "../../utils/message-channel.js"; +import type { AgentCommandOpts, AgentRunContext } from "./types.js"; + +export function resolveAgentRunContext(opts: AgentCommandOpts): AgentRunContext { + const merged: AgentRunContext = opts.runContext ? { ...opts.runContext } : {}; + + const normalizedChannel = resolveMessageChannel( + merged.messageChannel ?? opts.messageChannel, + opts.replyChannel ?? opts.channel, + ); + if (normalizedChannel) { + merged.messageChannel = normalizedChannel; + } + + const normalizedAccountId = normalizeAccountId(merged.accountId ?? opts.accountId); + if (normalizedAccountId) { + merged.accountId = normalizedAccountId; + } + + const groupId = (merged.groupId ?? opts.groupId)?.toString().trim(); + if (groupId) { + merged.groupId = groupId; + } + + const groupChannel = (merged.groupChannel ?? opts.groupChannel)?.toString().trim(); + if (groupChannel) { + merged.groupChannel = groupChannel; + } + + const groupSpace = (merged.groupSpace ?? opts.groupSpace)?.toString().trim(); + if (groupSpace) { + merged.groupSpace = groupSpace; + } + + if ( + merged.currentThreadTs == null && + opts.threadId != null && + opts.threadId !== "" && + opts.threadId !== null + ) { + merged.currentThreadTs = String(opts.threadId); + } + + // Populate currentChannelId from the outbound target so channel threading + // adapters can detect same-conversation auto-threading. + if (!merged.currentChannelId && opts.to) { + const trimmedTo = opts.to.trim(); + if (trimmedTo) { + merged.currentChannelId = trimmedTo; + } + } + + return merged; +} diff --git a/src/agents/command/session-store.ts b/src/agents/command/session-store.ts new file mode 100644 index 00000000000..e4746845ed7 --- /dev/null +++ b/src/agents/command/session-store.ts @@ -0,0 +1,109 @@ +import type { OpenClawConfig } from "../../config/config.js"; +import { + mergeSessionEntry, + setSessionRuntimeModel, + type SessionEntry, + updateSessionStore, +} from "../../config/sessions.js"; +import { setCliSessionId } from "../cli-session.js"; +import { resolveContextTokensForModel } from "../context.js"; +import { DEFAULT_CONTEXT_TOKENS } from "../defaults.js"; +import { isCliProvider } from "../model-selection.js"; +import { deriveSessionTotalTokens, hasNonzeroUsage } from "../usage.js"; + +type RunResult = Awaited>; + +export async function updateSessionStoreAfterAgentRun(params: { + cfg: OpenClawConfig; + contextTokensOverride?: number; + sessionId: string; + sessionKey: string; + storePath: string; + sessionStore: Record; + defaultProvider: string; + defaultModel: string; + fallbackProvider?: string; + fallbackModel?: string; + result: RunResult; +}) { + const { + cfg, + sessionId, + sessionKey, + storePath, + sessionStore, + defaultProvider, + defaultModel, + fallbackProvider, + fallbackModel, + result, + } = params; + + const usage = result.meta.agentMeta?.usage; + const promptTokens = result.meta.agentMeta?.promptTokens; + const compactionsThisRun = Math.max(0, result.meta.agentMeta?.compactionCount ?? 0); + const modelUsed = result.meta.agentMeta?.model ?? fallbackModel ?? defaultModel; + const providerUsed = result.meta.agentMeta?.provider ?? fallbackProvider ?? defaultProvider; + const contextTokens = + resolveContextTokensForModel({ + cfg, + provider: providerUsed, + model: modelUsed, + contextTokensOverride: params.contextTokensOverride, + fallbackContextTokens: DEFAULT_CONTEXT_TOKENS, + }) ?? DEFAULT_CONTEXT_TOKENS; + + const entry = sessionStore[sessionKey] ?? { + sessionId, + updatedAt: Date.now(), + }; + const next: SessionEntry = { + ...entry, + sessionId, + updatedAt: Date.now(), + contextTokens, + }; + setSessionRuntimeModel(next, { + provider: providerUsed, + model: modelUsed, + }); + if (isCliProvider(providerUsed, cfg)) { + const cliSessionId = result.meta.agentMeta?.sessionId?.trim(); + if (cliSessionId) { + setCliSessionId(next, providerUsed, cliSessionId); + } + } + next.abortedLastRun = result.meta.aborted ?? false; + if (result.meta.systemPromptReport) { + next.systemPromptReport = result.meta.systemPromptReport; + } + if (hasNonzeroUsage(usage)) { + const input = usage.input ?? 0; + const output = usage.output ?? 0; + const totalTokens = deriveSessionTotalTokens({ + usage, + contextTokens, + promptTokens, + }); + next.inputTokens = input; + next.outputTokens = output; + if (typeof totalTokens === "number" && Number.isFinite(totalTokens) && totalTokens > 0) { + next.totalTokens = totalTokens; + next.totalTokensFresh = true; + } else { + next.totalTokens = undefined; + next.totalTokensFresh = false; + } + next.cacheRead = usage.cacheRead ?? 0; + next.cacheWrite = usage.cacheWrite ?? 0; + } + if (compactionsThisRun > 0) { + next.compactionCount = (entry.compactionCount ?? 0) + compactionsThisRun; + } + const persisted = await updateSessionStore(storePath, (store) => { + const merged = mergeSessionEntry(store[sessionKey], next); + store[sessionKey] = merged; + return merged; + }); + sessionStore[sessionKey] = persisted; +} diff --git a/src/agents/command/session.ts b/src/agents/command/session.ts new file mode 100644 index 00000000000..2b04e21e406 --- /dev/null +++ b/src/agents/command/session.ts @@ -0,0 +1,172 @@ +import crypto from "node:crypto"; +import type { MsgContext } from "../../auto-reply/templating.js"; +import { + normalizeThinkLevel, + normalizeVerboseLevel, + type ThinkLevel, + type VerboseLevel, +} from "../../auto-reply/thinking.js"; +import type { OpenClawConfig } from "../../config/config.js"; +import { + evaluateSessionFreshness, + loadSessionStore, + resolveAgentIdFromSessionKey, + resolveChannelResetConfig, + resolveExplicitAgentSessionKey, + resolveSessionResetPolicy, + resolveSessionResetType, + resolveSessionKey, + resolveStorePath, + type SessionEntry, +} from "../../config/sessions.js"; +import { normalizeMainKey } from "../../routing/session-key.js"; +import { listAgentIds } from "../agent-scope.js"; +import { clearBootstrapSnapshotOnSessionRollover } from "../bootstrap-cache.js"; + +export type SessionResolution = { + sessionId: string; + sessionKey?: string; + sessionEntry?: SessionEntry; + sessionStore?: Record; + storePath: string; + isNewSession: boolean; + persistedThinking?: ThinkLevel; + persistedVerbose?: VerboseLevel; +}; + +type SessionKeyResolution = { + sessionKey?: string; + sessionStore: Record; + storePath: string; +}; + +export function resolveSessionKeyForRequest(opts: { + cfg: OpenClawConfig; + to?: string; + sessionId?: string; + sessionKey?: string; + agentId?: string; +}): SessionKeyResolution { + const sessionCfg = opts.cfg.session; + const scope = sessionCfg?.scope ?? "per-sender"; + const mainKey = normalizeMainKey(sessionCfg?.mainKey); + const explicitSessionKey = + opts.sessionKey?.trim() || + resolveExplicitAgentSessionKey({ + cfg: opts.cfg, + agentId: opts.agentId, + }); + const storeAgentId = resolveAgentIdFromSessionKey(explicitSessionKey); + const storePath = resolveStorePath(sessionCfg?.store, { + agentId: storeAgentId, + }); + const sessionStore = loadSessionStore(storePath); + + const ctx: MsgContext | undefined = opts.to?.trim() ? { From: opts.to } : undefined; + let sessionKey: string | undefined = + explicitSessionKey ?? (ctx ? resolveSessionKey(scope, ctx, mainKey) : undefined); + + // If a session id was provided, prefer to re-use its entry (by id) even when no key was derived. + if ( + !explicitSessionKey && + opts.sessionId && + (!sessionKey || sessionStore[sessionKey]?.sessionId !== opts.sessionId) + ) { + const foundKey = Object.keys(sessionStore).find( + (key) => sessionStore[key]?.sessionId === opts.sessionId, + ); + if (foundKey) { + sessionKey = foundKey; + } + } + + // When sessionId was provided but not found in the primary store, search all agent stores. + // Sessions created under a specific agent live in that agent's store file; the primary + // store (derived from the default agent) won't contain them. + // Also covers the case where --to derived a sessionKey that doesn't match the requested sessionId. + if ( + opts.sessionId && + !explicitSessionKey && + (!sessionKey || sessionStore[sessionKey]?.sessionId !== opts.sessionId) + ) { + const allAgentIds = listAgentIds(opts.cfg); + for (const agentId of allAgentIds) { + if (agentId === storeAgentId) { + continue; + } + const altStorePath = resolveStorePath(sessionCfg?.store, { agentId }); + const altStore = loadSessionStore(altStorePath); + const foundKey = Object.keys(altStore).find( + (key) => altStore[key]?.sessionId === opts.sessionId, + ); + if (foundKey) { + return { sessionKey: foundKey, sessionStore: altStore, storePath: altStorePath }; + } + } + } + + return { sessionKey, sessionStore, storePath }; +} + +export function resolveSession(opts: { + cfg: OpenClawConfig; + to?: string; + sessionId?: string; + sessionKey?: string; + agentId?: string; +}): SessionResolution { + const sessionCfg = opts.cfg.session; + const { sessionKey, sessionStore, storePath } = resolveSessionKeyForRequest({ + cfg: opts.cfg, + to: opts.to, + sessionId: opts.sessionId, + sessionKey: opts.sessionKey, + agentId: opts.agentId, + }); + const now = Date.now(); + + const sessionEntry = sessionKey ? sessionStore[sessionKey] : undefined; + + const resetType = resolveSessionResetType({ sessionKey }); + const channelReset = resolveChannelResetConfig({ + sessionCfg, + channel: sessionEntry?.lastChannel ?? sessionEntry?.channel, + }); + const resetPolicy = resolveSessionResetPolicy({ + sessionCfg, + resetType, + resetOverride: channelReset, + }); + const fresh = sessionEntry + ? evaluateSessionFreshness({ updatedAt: sessionEntry.updatedAt, now, policy: resetPolicy }) + .fresh + : false; + const sessionId = + opts.sessionId?.trim() || (fresh ? sessionEntry?.sessionId : undefined) || crypto.randomUUID(); + const isNewSession = !fresh && !opts.sessionId; + + clearBootstrapSnapshotOnSessionRollover({ + sessionKey, + previousSessionId: isNewSession ? sessionEntry?.sessionId : undefined, + }); + + const persistedThinking = + fresh && sessionEntry?.thinkingLevel + ? normalizeThinkLevel(sessionEntry.thinkingLevel) + : undefined; + const persistedVerbose = + fresh && sessionEntry?.verboseLevel + ? normalizeVerboseLevel(sessionEntry.verboseLevel) + : undefined; + + return { + sessionId, + sessionKey, + sessionEntry, + sessionStore, + storePath, + isNewSession, + persistedThinking, + persistedVerbose, + }; +} diff --git a/src/agents/command/types.ts b/src/agents/command/types.ts new file mode 100644 index 00000000000..66d0209bdfb --- /dev/null +++ b/src/agents/command/types.ts @@ -0,0 +1,90 @@ +import type { AgentInternalEvent } from "../../agents/internal-events.js"; +import type { ClientToolDefinition } from "../../agents/pi-embedded-runner/run/params.js"; +import type { SpawnedRunMetadata } from "../../agents/spawned-context.js"; +import type { ChannelOutboundTargetMode } from "../../channels/plugins/types.js"; +import type { InputProvenance } from "../../sessions/input-provenance.js"; + +/** Image content block for Claude API multimodal messages. */ +export type ImageContent = { + type: "image"; + data: string; + mimeType: string; +}; + +export type AgentStreamParams = { + /** Provider stream params override (best-effort). */ + temperature?: number; + maxTokens?: number; + /** Provider fast-mode override (best-effort). */ + fastMode?: boolean; +}; + +export type AgentRunContext = { + messageChannel?: string; + accountId?: string; + groupId?: string | null; + groupChannel?: string | null; + groupSpace?: string | null; + currentChannelId?: string; + currentThreadTs?: string; + replyToMode?: "off" | "first" | "all"; + hasRepliedRef?: { value: boolean }; +}; + +export type AgentCommandOpts = { + message: string; + /** Optional image attachments for multimodal messages. */ + images?: ImageContent[]; + /** Optional client-provided tools (OpenResponses hosted tools). */ + clientTools?: ClientToolDefinition[]; + /** Agent id override (must exist in config). */ + agentId?: string; + to?: string; + sessionId?: string; + sessionKey?: string; + thinking?: string; + thinkingOnce?: string; + verbose?: string; + json?: boolean; + timeout?: string; + deliver?: boolean; + /** Override delivery target (separate from session routing). */ + replyTo?: string; + /** Override delivery channel (separate from session routing). */ + replyChannel?: string; + /** Override delivery account id (separate from session routing). */ + replyAccountId?: string; + /** Override delivery thread/topic id (separate from session routing). */ + threadId?: string | number; + /** Message channel context (webchat|voicewake|whatsapp|...). */ + messageChannel?: string; + channel?: string; // delivery channel (whatsapp|telegram|...) + /** Account ID for multi-account channel routing (e.g., WhatsApp account). */ + accountId?: string; + /** Context for embedded run routing (channel/account/thread). */ + runContext?: AgentRunContext; + /** Whether this caller is authorized for owner-only tools (defaults true for local CLI calls). */ + senderIsOwner?: boolean; + /** Group/spawn metadata for subagent policy inheritance and routing context. */ + groupId?: SpawnedRunMetadata["groupId"]; + groupChannel?: SpawnedRunMetadata["groupChannel"]; + groupSpace?: SpawnedRunMetadata["groupSpace"]; + spawnedBy?: SpawnedRunMetadata["spawnedBy"]; + deliveryTargetMode?: ChannelOutboundTargetMode; + bestEffortDeliver?: boolean; + abortSignal?: AbortSignal; + lane?: string; + runId?: string; + extraSystemPrompt?: string; + internalEvents?: AgentInternalEvent[]; + inputProvenance?: InputProvenance; + /** Per-call stream param overrides (best-effort). */ + streamParams?: AgentStreamParams; + /** Explicit workspace directory override (for subagents to inherit parent workspace). */ + workspaceDir?: SpawnedRunMetadata["workspaceDir"]; +}; + +export type AgentCommandIngressOpts = Omit & { + /** Ingress callsites must always pass explicit owner authorization state. */ + senderIsOwner: boolean; +}; diff --git a/src/agents/pi-embedded-runner/run/params.ts b/src/agents/pi-embedded-runner/run/params.ts index 3aef4fb2752..f59bb8f27b5 100644 --- a/src/agents/pi-embedded-runner/run/params.ts +++ b/src/agents/pi-embedded-runner/run/params.ts @@ -1,11 +1,11 @@ import type { ImageContent } from "@mariozechner/pi-ai"; import type { ReasoningLevel, ThinkLevel, VerboseLevel } from "../../../auto-reply/thinking.js"; import type { ReplyPayload } from "../../../auto-reply/types.js"; -import type { AgentStreamParams } from "../../../commands/agent/types.js"; import type { OpenClawConfig } from "../../../config/config.js"; import type { enqueueCommand } from "../../../process/command-queue.js"; import type { InputProvenance } from "../../../sessions/input-provenance.js"; import type { ExecElevatedDefaults, ExecToolDefaults } from "../../bash-tools.js"; +import type { AgentStreamParams } from "../../command/types.js"; import type { BlockReplyPayload } from "../../pi-embedded-payloads.js"; import type { BlockReplyChunking, ToolResultFormat } from "../../pi-embedded-subscribe.js"; import type { SkillSnapshot } from "../../skills.js"; diff --git a/src/commands/agent.ts b/src/commands/agent.ts index ab690b37666..219cdf3dd58 100644 --- a/src/commands/agent.ts +++ b/src/commands/agent.ts @@ -1,1257 +1 @@ -import fs from "node:fs/promises"; -import { SessionManager } from "@mariozechner/pi-coding-agent"; -import { getAcpSessionManager } from "../acp/control-plane/manager.js"; -import { resolveAcpAgentPolicyError, resolveAcpDispatchPolicyError } from "../acp/policy.js"; -import { toAcpRuntimeError } from "../acp/runtime/errors.js"; -import { resolveAcpSessionCwd } from "../acp/runtime/session-identifiers.js"; -import { createSubsystemLogger } from "../logging/subsystem.js"; - -const log = createSubsystemLogger("commands/agent"); -import { - listAgentIds, - resolveAgentDir, - resolveEffectiveModelFallbacks, - resolveSessionAgentId, - resolveAgentSkillsFilter, - resolveAgentWorkspaceDir, -} from "../agents/agent-scope.js"; -import { ensureAuthProfileStore } from "../agents/auth-profiles.js"; -import { clearSessionAuthProfileOverride } from "../agents/auth-profiles/session-override.js"; -import { resolveBootstrapWarningSignaturesSeen } from "../agents/bootstrap-budget.js"; -import { runCliAgent } from "../agents/cli-runner.js"; -import { getCliSessionId, setCliSessionId } from "../agents/cli-session.js"; -import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "../agents/defaults.js"; -import { FailoverError } from "../agents/failover-error.js"; -import { formatAgentInternalEventsForPrompt } from "../agents/internal-events.js"; -import { AGENT_LANE_SUBAGENT } from "../agents/lanes.js"; -import { loadModelCatalog } from "../agents/model-catalog.js"; -import { runWithModelFallback } from "../agents/model-fallback.js"; -import { - buildAllowedModelSet, - isCliProvider, - modelKey, - normalizeModelRef, - normalizeProviderId, - resolveConfiguredModelRef, - resolveDefaultModelForAgent, - resolveThinkingDefault, -} from "../agents/model-selection.js"; -import { prepareSessionManagerForRun } from "../agents/pi-embedded-runner/session-manager-init.js"; -import { runEmbeddedPiAgent } from "../agents/pi-embedded.js"; -import { buildWorkspaceSkillSnapshot } from "../agents/skills.js"; -import { getSkillsSnapshotVersion } from "../agents/skills/refresh.js"; -import { normalizeSpawnedRunMetadata } from "../agents/spawned-context.js"; -import { resolveAgentTimeoutMs } from "../agents/timeout.js"; -import { ensureAgentWorkspace } from "../agents/workspace.js"; -import { normalizeReplyPayload } from "../auto-reply/reply/normalize-reply.js"; -import { - formatThinkingLevels, - formatXHighModelHint, - normalizeThinkLevel, - normalizeVerboseLevel, - supportsXHighThinking, - type ThinkLevel, - type VerboseLevel, -} from "../auto-reply/thinking.js"; -import { - isSilentReplyPrefixText, - isSilentReplyText, - SILENT_REPLY_TOKEN, -} from "../auto-reply/tokens.js"; -import { formatCliCommand } from "../cli/command-format.js"; -import { resolveCommandSecretRefsViaGateway } from "../cli/command-secret-gateway.js"; -import { getAgentRuntimeCommandSecretTargetIds } from "../cli/command-secret-targets.js"; -import { type CliDeps, createDefaultDeps } from "../cli/deps.js"; -import { - loadConfig, - readConfigFileSnapshotForWrite, - setRuntimeConfigSnapshot, -} from "../config/config.js"; -import { - mergeSessionEntry, - resolveAgentIdFromSessionKey, - type SessionEntry, - updateSessionStore, -} from "../config/sessions.js"; -import { resolveSessionTranscriptFile } from "../config/sessions/transcript.js"; -import { - clearAgentRunContext, - emitAgentEvent, - registerAgentRunContext, -} from "../infra/agent-events.js"; -import { buildOutboundSessionContext } from "../infra/outbound/session-context.js"; -import { getRemoteSkillEligibility } from "../infra/skills-remote.js"; -import { normalizeAgentId } from "../routing/session-key.js"; -import { defaultRuntime, type RuntimeEnv } from "../runtime.js"; -import { applyVerboseOverride } from "../sessions/level-overrides.js"; -import { applyModelOverrideToSessionEntry } from "../sessions/model-overrides.js"; -import { resolveSendPolicy } from "../sessions/send-policy.js"; -import { emitSessionTranscriptUpdate } from "../sessions/transcript-events.js"; -import { resolveMessageChannel } from "../utils/message-channel.js"; -import { deliverAgentCommandResult } from "./agent/delivery.js"; -import { resolveAgentRunContext } from "./agent/run-context.js"; -import { updateSessionStoreAfterAgentRun } from "./agent/session-store.js"; -import { resolveSession } from "./agent/session.js"; -import type { AgentCommandIngressOpts, AgentCommandOpts } from "./agent/types.js"; - -type PersistSessionEntryParams = { - sessionStore: Record; - sessionKey: string; - storePath: string; - entry: SessionEntry; -}; - -type OverrideFieldClearedByDelete = - | "providerOverride" - | "modelOverride" - | "authProfileOverride" - | "authProfileOverrideSource" - | "authProfileOverrideCompactionCount" - | "fallbackNoticeSelectedModel" - | "fallbackNoticeActiveModel" - | "fallbackNoticeReason" - | "claudeCliSessionId"; - -const OVERRIDE_FIELDS_CLEARED_BY_DELETE: OverrideFieldClearedByDelete[] = [ - "providerOverride", - "modelOverride", - "authProfileOverride", - "authProfileOverrideSource", - "authProfileOverrideCompactionCount", - "fallbackNoticeSelectedModel", - "fallbackNoticeActiveModel", - "fallbackNoticeReason", - "claudeCliSessionId", -]; - -async function persistSessionEntry(params: PersistSessionEntryParams): Promise { - const persisted = await updateSessionStore(params.storePath, (store) => { - const merged = mergeSessionEntry(store[params.sessionKey], params.entry); - // Preserve explicit `delete` clears done by session override helpers. - for (const field of OVERRIDE_FIELDS_CLEARED_BY_DELETE) { - if (!Object.hasOwn(params.entry, field)) { - Reflect.deleteProperty(merged, field); - } - } - store[params.sessionKey] = merged; - return merged; - }); - params.sessionStore[params.sessionKey] = persisted; -} - -function resolveFallbackRetryPrompt(params: { body: string; isFallbackRetry: boolean }): string { - if (!params.isFallbackRetry) { - return params.body; - } - return "Continue where you left off. The previous model attempt failed or timed out."; -} - -function prependInternalEventContext( - body: string, - events: AgentCommandOpts["internalEvents"], -): string { - if (body.includes("OpenClaw runtime context (internal):")) { - return body; - } - const renderedEvents = formatAgentInternalEventsForPrompt(events); - if (!renderedEvents) { - return body; - } - return [renderedEvents, body].filter(Boolean).join("\n\n"); -} - -function createAcpVisibleTextAccumulator() { - let pendingSilentPrefix = ""; - let visibleText = ""; - const startsWithWordChar = (chunk: string): boolean => /^[\p{L}\p{N}]/u.test(chunk); - - const resolveNextCandidate = (base: string, chunk: string): string => { - if (!base) { - return chunk; - } - if ( - isSilentReplyText(base, SILENT_REPLY_TOKEN) && - !chunk.startsWith(base) && - startsWithWordChar(chunk) - ) { - return chunk; - } - // Some ACP backends emit cumulative snapshots even on text_delta-style hooks. - // Accept those only when they strictly extend the buffered text. - if (chunk.startsWith(base) && chunk.length > base.length) { - return chunk; - } - return `${base}${chunk}`; - }; - - const mergeVisibleChunk = (base: string, chunk: string): { text: string; delta: string } => { - if (!base) { - return { text: chunk, delta: chunk }; - } - if (chunk.startsWith(base) && chunk.length > base.length) { - const delta = chunk.slice(base.length); - return { text: chunk, delta }; - } - return { - text: `${base}${chunk}`, - delta: chunk, - }; - }; - - return { - consume(chunk: string): { text: string; delta: string } | null { - if (!chunk) { - return null; - } - - if (!visibleText) { - const leadCandidate = resolveNextCandidate(pendingSilentPrefix, chunk); - const trimmedLeadCandidate = leadCandidate.trim(); - if ( - isSilentReplyText(trimmedLeadCandidate, SILENT_REPLY_TOKEN) || - isSilentReplyPrefixText(trimmedLeadCandidate, SILENT_REPLY_TOKEN) - ) { - pendingSilentPrefix = leadCandidate; - return null; - } - if (pendingSilentPrefix) { - pendingSilentPrefix = ""; - visibleText = leadCandidate; - return { - text: visibleText, - delta: leadCandidate, - }; - } - } - - const nextVisible = mergeVisibleChunk(visibleText, chunk); - visibleText = nextVisible.text; - return nextVisible.delta ? nextVisible : null; - }, - finalize(): string { - return visibleText.trim(); - }, - finalizeRaw(): string { - return visibleText; - }, - }; -} - -const ACP_TRANSCRIPT_USAGE = { - input: 0, - output: 0, - cacheRead: 0, - cacheWrite: 0, - totalTokens: 0, - cost: { - input: 0, - output: 0, - cacheRead: 0, - cacheWrite: 0, - total: 0, - }, -} as const; - -async function persistAcpTurnTranscript(params: { - body: string; - finalText: string; - sessionId: string; - sessionKey: string; - sessionEntry: SessionEntry | undefined; - sessionStore?: Record; - storePath?: string; - sessionAgentId: string; - threadId?: string | number; - sessionCwd: string; -}): Promise { - const promptText = params.body; - const replyText = params.finalText; - if (!promptText && !replyText) { - return params.sessionEntry; - } - - const { sessionFile, sessionEntry } = await resolveSessionTranscriptFile({ - sessionId: params.sessionId, - sessionKey: params.sessionKey, - sessionEntry: params.sessionEntry, - sessionStore: params.sessionStore, - storePath: params.storePath, - agentId: params.sessionAgentId, - threadId: params.threadId, - }); - const hadSessionFile = await fs - .access(sessionFile) - .then(() => true) - .catch(() => false); - const sessionManager = SessionManager.open(sessionFile); - await prepareSessionManagerForRun({ - sessionManager, - sessionFile, - hadSessionFile, - sessionId: params.sessionId, - cwd: params.sessionCwd, - }); - - if (promptText) { - sessionManager.appendMessage({ - role: "user", - content: promptText, - timestamp: Date.now(), - }); - } - - if (replyText) { - sessionManager.appendMessage({ - role: "assistant", - content: [{ type: "text", text: replyText }], - api: "openai-responses", - provider: "openclaw", - model: "acp-runtime", - usage: ACP_TRANSCRIPT_USAGE, - stopReason: "stop", - timestamp: Date.now(), - }); - } - - emitSessionTranscriptUpdate(sessionFile); - return sessionEntry; -} - -function runAgentAttempt(params: { - providerOverride: string; - modelOverride: string; - cfg: ReturnType; - sessionEntry: SessionEntry | undefined; - sessionId: string; - sessionKey: string | undefined; - sessionAgentId: string; - sessionFile: string; - workspaceDir: string; - body: string; - isFallbackRetry: boolean; - resolvedThinkLevel: ThinkLevel; - timeoutMs: number; - runId: string; - opts: AgentCommandOpts & { senderIsOwner: boolean }; - runContext: ReturnType; - spawnedBy: string | undefined; - messageChannel: ReturnType; - skillsSnapshot: ReturnType | undefined; - resolvedVerboseLevel: VerboseLevel | undefined; - agentDir: string; - onAgentEvent: (evt: { stream: string; data?: Record }) => void; - primaryProvider: string; - sessionStore?: Record; - storePath?: string; - allowTransientCooldownProbe?: boolean; -}) { - const effectivePrompt = resolveFallbackRetryPrompt({ - body: params.body, - isFallbackRetry: params.isFallbackRetry, - }); - const bootstrapPromptWarningSignaturesSeen = resolveBootstrapWarningSignaturesSeen( - params.sessionEntry?.systemPromptReport, - ); - const bootstrapPromptWarningSignature = - bootstrapPromptWarningSignaturesSeen[bootstrapPromptWarningSignaturesSeen.length - 1]; - if (isCliProvider(params.providerOverride, params.cfg)) { - const cliSessionId = getCliSessionId(params.sessionEntry, params.providerOverride); - const runCliWithSession = (nextCliSessionId: string | undefined) => - runCliAgent({ - sessionId: params.sessionId, - sessionKey: params.sessionKey, - agentId: params.sessionAgentId, - sessionFile: params.sessionFile, - workspaceDir: params.workspaceDir, - config: params.cfg, - prompt: effectivePrompt, - provider: params.providerOverride, - model: params.modelOverride, - thinkLevel: params.resolvedThinkLevel, - timeoutMs: params.timeoutMs, - runId: params.runId, - extraSystemPrompt: params.opts.extraSystemPrompt, - cliSessionId: nextCliSessionId, - bootstrapPromptWarningSignaturesSeen, - bootstrapPromptWarningSignature, - images: params.isFallbackRetry ? undefined : params.opts.images, - streamParams: params.opts.streamParams, - }); - return runCliWithSession(cliSessionId).catch(async (err) => { - // Handle CLI session expired error - if ( - err instanceof FailoverError && - err.reason === "session_expired" && - cliSessionId && - params.sessionKey && - params.sessionStore && - params.storePath - ) { - log.warn( - `CLI session expired, clearing from session store: provider=${params.providerOverride} sessionKey=${params.sessionKey}`, - ); - - // Clear the expired session ID from the session store - const entry = params.sessionStore[params.sessionKey]; - if (entry) { - const updatedEntry = { ...entry }; - if (params.providerOverride === "claude-cli") { - delete updatedEntry.claudeCliSessionId; - } - if (updatedEntry.cliSessionIds) { - const normalizedProvider = normalizeProviderId(params.providerOverride); - const newCliSessionIds = { ...updatedEntry.cliSessionIds }; - delete newCliSessionIds[normalizedProvider]; - updatedEntry.cliSessionIds = newCliSessionIds; - } - updatedEntry.updatedAt = Date.now(); - - await persistSessionEntry({ - sessionStore: params.sessionStore, - sessionKey: params.sessionKey, - storePath: params.storePath, - entry: updatedEntry, - }); - - // Update the session entry reference - params.sessionEntry = updatedEntry; - } - - // Retry with no session ID (will create a new session) - return runCliWithSession(undefined).then(async (result) => { - // Update session store with new CLI session ID if available - if ( - result.meta.agentMeta?.sessionId && - params.sessionKey && - params.sessionStore && - params.storePath - ) { - const entry = params.sessionStore[params.sessionKey]; - if (entry) { - const updatedEntry = { ...entry }; - setCliSessionId( - updatedEntry, - params.providerOverride, - result.meta.agentMeta.sessionId, - ); - updatedEntry.updatedAt = Date.now(); - - await persistSessionEntry({ - sessionStore: params.sessionStore, - sessionKey: params.sessionKey, - storePath: params.storePath, - entry: updatedEntry, - }); - } - } - return result; - }); - } - throw err; - }); - } - - const authProfileId = - params.providerOverride === params.primaryProvider - ? params.sessionEntry?.authProfileOverride - : undefined; - return runEmbeddedPiAgent({ - sessionId: params.sessionId, - sessionKey: params.sessionKey, - agentId: params.sessionAgentId, - trigger: "user", - messageChannel: params.messageChannel, - agentAccountId: params.runContext.accountId, - messageTo: params.opts.replyTo ?? params.opts.to, - messageThreadId: params.opts.threadId, - groupId: params.runContext.groupId, - groupChannel: params.runContext.groupChannel, - groupSpace: params.runContext.groupSpace, - spawnedBy: params.spawnedBy, - currentChannelId: params.runContext.currentChannelId, - currentThreadTs: params.runContext.currentThreadTs, - replyToMode: params.runContext.replyToMode, - hasRepliedRef: params.runContext.hasRepliedRef, - senderIsOwner: params.opts.senderIsOwner, - sessionFile: params.sessionFile, - workspaceDir: params.workspaceDir, - config: params.cfg, - skillsSnapshot: params.skillsSnapshot, - prompt: effectivePrompt, - images: params.isFallbackRetry ? undefined : params.opts.images, - clientTools: params.opts.clientTools, - provider: params.providerOverride, - model: params.modelOverride, - authProfileId, - authProfileIdSource: authProfileId ? params.sessionEntry?.authProfileOverrideSource : undefined, - thinkLevel: params.resolvedThinkLevel, - verboseLevel: params.resolvedVerboseLevel, - timeoutMs: params.timeoutMs, - runId: params.runId, - lane: params.opts.lane, - abortSignal: params.opts.abortSignal, - extraSystemPrompt: params.opts.extraSystemPrompt, - inputProvenance: params.opts.inputProvenance, - streamParams: params.opts.streamParams, - agentDir: params.agentDir, - allowTransientCooldownProbe: params.allowTransientCooldownProbe, - onAgentEvent: params.onAgentEvent, - bootstrapPromptWarningSignaturesSeen, - bootstrapPromptWarningSignature, - }); -} - -async function prepareAgentCommandExecution( - opts: AgentCommandOpts & { senderIsOwner: boolean }, - runtime: RuntimeEnv, -) { - const message = opts.message ?? ""; - if (!message.trim()) { - throw new Error("Message (--message) is required"); - } - const body = prependInternalEventContext(message, opts.internalEvents); - if (!opts.to && !opts.sessionId && !opts.sessionKey && !opts.agentId) { - throw new Error("Pass --to , --session-id, or --agent to choose a session"); - } - - const loadedRaw = loadConfig(); - const sourceConfig = await (async () => { - try { - const { snapshot } = await readConfigFileSnapshotForWrite(); - if (snapshot.valid) { - return snapshot.resolved; - } - } catch { - // Fall back to runtime-loaded config when source snapshot is unavailable. - } - return loadedRaw; - })(); - const { resolvedConfig: cfg, diagnostics } = await resolveCommandSecretRefsViaGateway({ - config: loadedRaw, - commandName: "agent", - targetIds: getAgentRuntimeCommandSecretTargetIds(), - }); - setRuntimeConfigSnapshot(cfg, sourceConfig); - const normalizedSpawned = normalizeSpawnedRunMetadata({ - spawnedBy: opts.spawnedBy, - groupId: opts.groupId, - groupChannel: opts.groupChannel, - groupSpace: opts.groupSpace, - workspaceDir: opts.workspaceDir, - }); - for (const entry of diagnostics) { - runtime.log(`[secrets] ${entry}`); - } - const agentIdOverrideRaw = opts.agentId?.trim(); - const agentIdOverride = agentIdOverrideRaw ? normalizeAgentId(agentIdOverrideRaw) : undefined; - if (agentIdOverride) { - const knownAgents = listAgentIds(cfg); - if (!knownAgents.includes(agentIdOverride)) { - throw new Error( - `Unknown agent id "${agentIdOverrideRaw}". Use "${formatCliCommand("openclaw agents list")}" to see configured agents.`, - ); - } - } - if (agentIdOverride && opts.sessionKey) { - const sessionAgentId = resolveAgentIdFromSessionKey(opts.sessionKey); - if (sessionAgentId !== agentIdOverride) { - throw new Error( - `Agent id "${agentIdOverrideRaw}" does not match session key agent "${sessionAgentId}".`, - ); - } - } - const agentCfg = cfg.agents?.defaults; - const configuredModel = resolveConfiguredModelRef({ - cfg, - defaultProvider: DEFAULT_PROVIDER, - defaultModel: DEFAULT_MODEL, - }); - const thinkingLevelsHint = formatThinkingLevels(configuredModel.provider, configuredModel.model); - - const thinkOverride = normalizeThinkLevel(opts.thinking); - const thinkOnce = normalizeThinkLevel(opts.thinkingOnce); - if (opts.thinking && !thinkOverride) { - throw new Error(`Invalid thinking level. Use one of: ${thinkingLevelsHint}.`); - } - if (opts.thinkingOnce && !thinkOnce) { - throw new Error(`Invalid one-shot thinking level. Use one of: ${thinkingLevelsHint}.`); - } - - const verboseOverride = normalizeVerboseLevel(opts.verbose); - if (opts.verbose && !verboseOverride) { - throw new Error('Invalid verbose level. Use "on", "full", or "off".'); - } - - const laneRaw = typeof opts.lane === "string" ? opts.lane.trim() : ""; - const isSubagentLane = laneRaw === String(AGENT_LANE_SUBAGENT); - const timeoutSecondsRaw = - opts.timeout !== undefined - ? Number.parseInt(String(opts.timeout), 10) - : isSubagentLane - ? 0 - : undefined; - if ( - timeoutSecondsRaw !== undefined && - (Number.isNaN(timeoutSecondsRaw) || timeoutSecondsRaw < 0) - ) { - throw new Error("--timeout must be a non-negative integer (seconds; 0 means no timeout)"); - } - const timeoutMs = resolveAgentTimeoutMs({ - cfg, - overrideSeconds: timeoutSecondsRaw, - }); - - const sessionResolution = resolveSession({ - cfg, - to: opts.to, - sessionId: opts.sessionId, - sessionKey: opts.sessionKey, - agentId: agentIdOverride, - }); - - const { - sessionId, - sessionKey, - sessionEntry: sessionEntryRaw, - sessionStore, - storePath, - isNewSession, - persistedThinking, - persistedVerbose, - } = sessionResolution; - const sessionAgentId = - agentIdOverride ?? - resolveSessionAgentId({ - sessionKey: sessionKey ?? opts.sessionKey?.trim(), - config: cfg, - }); - const outboundSession = buildOutboundSessionContext({ - cfg, - agentId: sessionAgentId, - sessionKey, - }); - // Internal callers (for example subagent spawns) may pin workspace inheritance. - const workspaceDirRaw = - normalizedSpawned.workspaceDir ?? resolveAgentWorkspaceDir(cfg, sessionAgentId); - const agentDir = resolveAgentDir(cfg, sessionAgentId); - const workspace = await ensureAgentWorkspace({ - dir: workspaceDirRaw, - ensureBootstrapFiles: !agentCfg?.skipBootstrap, - }); - const workspaceDir = workspace.dir; - const runId = opts.runId?.trim() || sessionId; - const acpManager = getAcpSessionManager(); - const acpResolution = sessionKey - ? acpManager.resolveSession({ - cfg, - sessionKey, - }) - : null; - - return { - body, - cfg, - normalizedSpawned, - agentCfg, - thinkOverride, - thinkOnce, - verboseOverride, - timeoutMs, - sessionId, - sessionKey, - sessionEntry: sessionEntryRaw, - sessionStore, - storePath, - isNewSession, - persistedThinking, - persistedVerbose, - sessionAgentId, - outboundSession, - workspaceDir, - agentDir, - runId, - acpManager, - acpResolution, - }; -} - -async function agentCommandInternal( - opts: AgentCommandOpts & { senderIsOwner: boolean }, - runtime: RuntimeEnv = defaultRuntime, - deps: CliDeps = createDefaultDeps(), -) { - const prepared = await prepareAgentCommandExecution(opts, runtime); - const { - body, - cfg, - normalizedSpawned, - agentCfg, - thinkOverride, - thinkOnce, - verboseOverride, - timeoutMs, - sessionId, - sessionKey, - sessionStore, - storePath, - isNewSession, - persistedThinking, - persistedVerbose, - sessionAgentId, - outboundSession, - workspaceDir, - agentDir, - runId, - acpManager, - acpResolution, - } = prepared; - let sessionEntry = prepared.sessionEntry; - - try { - if (opts.deliver === true) { - const sendPolicy = resolveSendPolicy({ - cfg, - entry: sessionEntry, - sessionKey, - channel: sessionEntry?.channel, - chatType: sessionEntry?.chatType, - }); - if (sendPolicy === "deny") { - throw new Error("send blocked by session policy"); - } - } - - if (acpResolution?.kind === "stale") { - throw acpResolution.error; - } - - if (acpResolution?.kind === "ready" && sessionKey) { - const startedAt = Date.now(); - registerAgentRunContext(runId, { - sessionKey, - }); - emitAgentEvent({ - runId, - stream: "lifecycle", - data: { - phase: "start", - startedAt, - }, - }); - - const visibleTextAccumulator = createAcpVisibleTextAccumulator(); - let stopReason: string | undefined; - try { - const dispatchPolicyError = resolveAcpDispatchPolicyError(cfg); - if (dispatchPolicyError) { - throw dispatchPolicyError; - } - const acpAgent = normalizeAgentId( - acpResolution.meta.agent || resolveAgentIdFromSessionKey(sessionKey), - ); - const agentPolicyError = resolveAcpAgentPolicyError(cfg, acpAgent); - if (agentPolicyError) { - throw agentPolicyError; - } - - await acpManager.runTurn({ - cfg, - sessionKey, - text: body, - mode: "prompt", - requestId: runId, - signal: opts.abortSignal, - onEvent: (event) => { - if (event.type === "done") { - stopReason = event.stopReason; - return; - } - if (event.type !== "text_delta") { - return; - } - if (event.stream && event.stream !== "output") { - return; - } - if (!event.text) { - return; - } - const visibleUpdate = visibleTextAccumulator.consume(event.text); - if (!visibleUpdate) { - return; - } - emitAgentEvent({ - runId, - stream: "assistant", - data: { - text: visibleUpdate.text, - delta: visibleUpdate.delta, - }, - }); - }, - }); - } catch (error) { - const acpError = toAcpRuntimeError({ - error, - fallbackCode: "ACP_TURN_FAILED", - fallbackMessage: "ACP turn failed before completion.", - }); - emitAgentEvent({ - runId, - stream: "lifecycle", - data: { - phase: "error", - error: acpError.message, - endedAt: Date.now(), - }, - }); - throw acpError; - } - - emitAgentEvent({ - runId, - stream: "lifecycle", - data: { - phase: "end", - endedAt: Date.now(), - }, - }); - - const finalTextRaw = visibleTextAccumulator.finalizeRaw(); - const finalText = visibleTextAccumulator.finalize(); - try { - sessionEntry = await persistAcpTurnTranscript({ - body, - finalText: finalTextRaw, - sessionId, - sessionKey, - sessionEntry, - sessionStore, - storePath, - sessionAgentId, - threadId: opts.threadId, - sessionCwd: resolveAcpSessionCwd(acpResolution.meta) ?? workspaceDir, - }); - } catch (error) { - log.warn( - `ACP transcript persistence failed for ${sessionKey}: ${error instanceof Error ? error.message : String(error)}`, - ); - } - - const normalizedFinalPayload = normalizeReplyPayload({ - text: finalText, - }); - const payloads = normalizedFinalPayload ? [normalizedFinalPayload] : []; - const result = { - payloads, - meta: { - durationMs: Date.now() - startedAt, - aborted: opts.abortSignal?.aborted === true, - stopReason, - }, - }; - - return await deliverAgentCommandResult({ - cfg, - deps, - runtime, - opts, - outboundSession, - sessionEntry, - result, - payloads, - }); - } - - let resolvedThinkLevel = thinkOnce ?? thinkOverride ?? persistedThinking; - const resolvedVerboseLevel = - verboseOverride ?? persistedVerbose ?? (agentCfg?.verboseDefault as VerboseLevel | undefined); - - if (sessionKey) { - registerAgentRunContext(runId, { - sessionKey, - verboseLevel: resolvedVerboseLevel, - }); - } - - const needsSkillsSnapshot = isNewSession || !sessionEntry?.skillsSnapshot; - const skillsSnapshotVersion = getSkillsSnapshotVersion(workspaceDir); - const skillFilter = resolveAgentSkillsFilter(cfg, sessionAgentId); - const skillsSnapshot = needsSkillsSnapshot - ? buildWorkspaceSkillSnapshot(workspaceDir, { - config: cfg, - eligibility: { remote: getRemoteSkillEligibility() }, - snapshotVersion: skillsSnapshotVersion, - skillFilter, - }) - : sessionEntry?.skillsSnapshot; - - if (skillsSnapshot && sessionStore && sessionKey && needsSkillsSnapshot) { - const current = sessionEntry ?? { - sessionId, - updatedAt: Date.now(), - }; - const next: SessionEntry = { - ...current, - sessionId, - updatedAt: Date.now(), - skillsSnapshot, - }; - await persistSessionEntry({ - sessionStore, - sessionKey, - storePath, - entry: next, - }); - sessionEntry = next; - } - - // Persist explicit /command overrides to the session store when we have a key. - if (sessionStore && sessionKey) { - const entry = sessionStore[sessionKey] ?? - sessionEntry ?? { sessionId, updatedAt: Date.now() }; - const next: SessionEntry = { ...entry, sessionId, updatedAt: Date.now() }; - if (thinkOverride) { - next.thinkingLevel = thinkOverride; - } - applyVerboseOverride(next, verboseOverride); - await persistSessionEntry({ - sessionStore, - sessionKey, - storePath, - entry: next, - }); - sessionEntry = next; - } - - const configuredDefaultRef = resolveDefaultModelForAgent({ - cfg, - agentId: sessionAgentId, - }); - const { provider: defaultProvider, model: defaultModel } = normalizeModelRef( - configuredDefaultRef.provider, - configuredDefaultRef.model, - ); - let provider = defaultProvider; - let model = defaultModel; - const hasAllowlist = agentCfg?.models && Object.keys(agentCfg.models).length > 0; - const hasStoredOverride = Boolean( - sessionEntry?.modelOverride || sessionEntry?.providerOverride, - ); - const needsModelCatalog = hasAllowlist || hasStoredOverride; - let allowedModelKeys = new Set(); - let allowedModelCatalog: Awaited> = []; - let modelCatalog: Awaited> | null = null; - let allowAnyModel = false; - - if (needsModelCatalog) { - modelCatalog = await loadModelCatalog({ config: cfg }); - const allowed = buildAllowedModelSet({ - cfg, - catalog: modelCatalog, - defaultProvider, - defaultModel, - agentId: sessionAgentId, - }); - allowedModelKeys = allowed.allowedKeys; - allowedModelCatalog = allowed.allowedCatalog; - allowAnyModel = allowed.allowAny ?? false; - } - - if (sessionEntry && sessionStore && sessionKey && hasStoredOverride) { - const entry = sessionEntry; - const overrideProvider = sessionEntry.providerOverride?.trim() || defaultProvider; - const overrideModel = sessionEntry.modelOverride?.trim(); - if (overrideModel) { - const normalizedOverride = normalizeModelRef(overrideProvider, overrideModel); - const key = modelKey(normalizedOverride.provider, normalizedOverride.model); - if ( - !isCliProvider(normalizedOverride.provider, cfg) && - !allowAnyModel && - !allowedModelKeys.has(key) - ) { - const { updated } = applyModelOverrideToSessionEntry({ - entry, - selection: { provider: defaultProvider, model: defaultModel, isDefault: true }, - }); - if (updated) { - await persistSessionEntry({ - sessionStore, - sessionKey, - storePath, - entry, - }); - } - } - } - } - - const storedProviderOverride = sessionEntry?.providerOverride?.trim(); - const storedModelOverride = sessionEntry?.modelOverride?.trim(); - if (storedModelOverride) { - const candidateProvider = storedProviderOverride || defaultProvider; - const normalizedStored = normalizeModelRef(candidateProvider, storedModelOverride); - const key = modelKey(normalizedStored.provider, normalizedStored.model); - if ( - isCliProvider(normalizedStored.provider, cfg) || - allowAnyModel || - allowedModelKeys.has(key) - ) { - provider = normalizedStored.provider; - model = normalizedStored.model; - } - } - if (sessionEntry) { - const authProfileId = sessionEntry.authProfileOverride; - if (authProfileId) { - const entry = sessionEntry; - const store = ensureAuthProfileStore(); - const profile = store.profiles[authProfileId]; - if (!profile || profile.provider !== provider) { - if (sessionStore && sessionKey) { - await clearSessionAuthProfileOverride({ - sessionEntry: entry, - sessionStore, - sessionKey, - storePath, - }); - } - } - } - } - - if (!resolvedThinkLevel) { - let catalogForThinking = modelCatalog ?? allowedModelCatalog; - if (!catalogForThinking || catalogForThinking.length === 0) { - modelCatalog = await loadModelCatalog({ config: cfg }); - catalogForThinking = modelCatalog; - } - resolvedThinkLevel = resolveThinkingDefault({ - cfg, - provider, - model, - catalog: catalogForThinking, - }); - } - if (resolvedThinkLevel === "xhigh" && !supportsXHighThinking(provider, model)) { - const explicitThink = Boolean(thinkOnce || thinkOverride); - if (explicitThink) { - throw new Error(`Thinking level "xhigh" is only supported for ${formatXHighModelHint()}.`); - } - resolvedThinkLevel = "high"; - if (sessionEntry && sessionStore && sessionKey && sessionEntry.thinkingLevel === "xhigh") { - const entry = sessionEntry; - entry.thinkingLevel = "high"; - entry.updatedAt = Date.now(); - await persistSessionEntry({ - sessionStore, - sessionKey, - storePath, - entry, - }); - } - } - let sessionFile: string | undefined; - if (sessionStore && sessionKey) { - const resolvedSessionFile = await resolveSessionTranscriptFile({ - sessionId, - sessionKey, - sessionStore, - storePath, - sessionEntry, - agentId: sessionAgentId, - threadId: opts.threadId, - }); - sessionFile = resolvedSessionFile.sessionFile; - sessionEntry = resolvedSessionFile.sessionEntry; - } - if (!sessionFile) { - const resolvedSessionFile = await resolveSessionTranscriptFile({ - sessionId, - sessionKey: sessionKey ?? sessionId, - sessionEntry, - agentId: sessionAgentId, - threadId: opts.threadId, - }); - sessionFile = resolvedSessionFile.sessionFile; - sessionEntry = resolvedSessionFile.sessionEntry; - } - - const startedAt = Date.now(); - let lifecycleEnded = false; - - let result: Awaited>; - let fallbackProvider = provider; - let fallbackModel = model; - try { - const runContext = resolveAgentRunContext(opts); - const messageChannel = resolveMessageChannel( - runContext.messageChannel, - opts.replyChannel ?? opts.channel, - ); - const spawnedBy = normalizedSpawned.spawnedBy ?? sessionEntry?.spawnedBy; - // Keep fallback candidate resolution centralized so session model overrides, - // per-agent overrides, and default fallbacks stay consistent across callers. - const effectiveFallbacksOverride = resolveEffectiveModelFallbacks({ - cfg, - agentId: sessionAgentId, - hasSessionModelOverride: Boolean(storedModelOverride), - }); - - // Track model fallback attempts so retries on an existing session don't - // re-inject the original prompt as a duplicate user message. - let fallbackAttemptIndex = 0; - const fallbackResult = await runWithModelFallback({ - cfg, - provider, - model, - runId, - agentDir, - fallbacksOverride: effectiveFallbacksOverride, - run: (providerOverride, modelOverride, runOptions) => { - const isFallbackRetry = fallbackAttemptIndex > 0; - fallbackAttemptIndex += 1; - return runAgentAttempt({ - providerOverride, - modelOverride, - cfg, - sessionEntry, - sessionId, - sessionKey, - sessionAgentId, - sessionFile, - workspaceDir, - body, - isFallbackRetry, - resolvedThinkLevel, - timeoutMs, - runId, - opts, - runContext, - spawnedBy, - messageChannel, - skillsSnapshot, - resolvedVerboseLevel, - agentDir, - primaryProvider: provider, - sessionStore, - storePath, - allowTransientCooldownProbe: runOptions?.allowTransientCooldownProbe, - onAgentEvent: (evt) => { - // Track lifecycle end for fallback emission below. - if ( - evt.stream === "lifecycle" && - typeof evt.data?.phase === "string" && - (evt.data.phase === "end" || evt.data.phase === "error") - ) { - lifecycleEnded = true; - } - }, - }); - }, - }); - result = fallbackResult.result; - fallbackProvider = fallbackResult.provider; - fallbackModel = fallbackResult.model; - if (!lifecycleEnded) { - const stopReason = result.meta.stopReason; - if (stopReason && stopReason !== "end_turn") { - console.error(`[agent] run ${runId} ended with stopReason=${stopReason}`); - } - emitAgentEvent({ - runId, - stream: "lifecycle", - data: { - phase: "end", - startedAt, - endedAt: Date.now(), - aborted: result.meta.aborted ?? false, - stopReason, - }, - }); - } - } catch (err) { - if (!lifecycleEnded) { - emitAgentEvent({ - runId, - stream: "lifecycle", - data: { - phase: "error", - startedAt, - endedAt: Date.now(), - error: String(err), - }, - }); - } - throw err; - } - - // Update token+model fields in the session store. - if (sessionStore && sessionKey) { - await updateSessionStoreAfterAgentRun({ - cfg, - contextTokensOverride: agentCfg?.contextTokens, - sessionId, - sessionKey, - storePath, - sessionStore, - defaultProvider: provider, - defaultModel: model, - fallbackProvider, - fallbackModel, - result, - }); - } - - const payloads = result.payloads ?? []; - return await deliverAgentCommandResult({ - cfg, - deps, - runtime, - opts, - outboundSession, - sessionEntry, - result, - payloads, - }); - } finally { - clearAgentRunContext(runId); - } -} - -export async function agentCommand( - opts: AgentCommandOpts, - runtime: RuntimeEnv = defaultRuntime, - deps: CliDeps = createDefaultDeps(), -) { - return await agentCommandInternal( - { - ...opts, - // agentCommand is the trusted-operator entrypoint used by CLI/local flows. - // Ingress callers must opt into owner semantics explicitly via - // agentCommandFromIngress so network-facing paths cannot inherit this default by accident. - senderIsOwner: opts.senderIsOwner ?? true, - }, - runtime, - deps, - ); -} - -export async function agentCommandFromIngress( - opts: AgentCommandIngressOpts, - runtime: RuntimeEnv = defaultRuntime, - deps: CliDeps = createDefaultDeps(), -) { - if (typeof opts.senderIsOwner !== "boolean") { - // HTTP/WS ingress must declare the trust level explicitly at the boundary. - // This keeps network-facing callers from silently picking up the local trusted default. - throw new Error("senderIsOwner must be explicitly set for ingress agent runs."); - } - return await agentCommandInternal( - { - ...opts, - senderIsOwner: opts.senderIsOwner, - }, - runtime, - deps, - ); -} +export * from "../agents/agent-command.js"; diff --git a/src/commands/agent/delivery.ts b/src/commands/agent/delivery.ts index 282ed52e45e..02d9a36041e 100644 --- a/src/commands/agent/delivery.ts +++ b/src/commands/agent/delivery.ts @@ -1,240 +1 @@ -import { AGENT_LANE_NESTED } from "../../agents/lanes.js"; -import { getChannelPlugin, normalizeChannelId } from "../../channels/plugins/index.js"; -import { createOutboundSendDeps, type CliDeps } from "../../cli/outbound-send-deps.js"; -import type { OpenClawConfig } from "../../config/config.js"; -import type { SessionEntry } from "../../config/sessions.js"; -import { - resolveAgentDeliveryPlan, - resolveAgentOutboundTarget, -} from "../../infra/outbound/agent-delivery.js"; -import { resolveMessageChannelSelection } from "../../infra/outbound/channel-selection.js"; -import { deliverOutboundPayloads } from "../../infra/outbound/deliver.js"; -import { buildOutboundResultEnvelope } from "../../infra/outbound/envelope.js"; -import { - formatOutboundPayloadLog, - type NormalizedOutboundPayload, - normalizeOutboundPayloads, - normalizeOutboundPayloadsForJson, -} from "../../infra/outbound/payloads.js"; -import type { OutboundSessionContext } from "../../infra/outbound/session-context.js"; -import type { RuntimeEnv } from "../../runtime.js"; -import { isInternalMessageChannel } from "../../utils/message-channel.js"; -import type { AgentCommandOpts } from "./types.js"; - -type RunResult = Awaited< - ReturnType<(typeof import("../../agents/pi-embedded.js"))["runEmbeddedPiAgent"]> ->; - -const NESTED_LOG_PREFIX = "[agent:nested]"; - -function formatNestedLogPrefix(opts: AgentCommandOpts, sessionKey?: string): string { - const parts = [NESTED_LOG_PREFIX]; - const session = sessionKey ?? opts.sessionKey ?? opts.sessionId; - if (session) { - parts.push(`session=${session}`); - } - if (opts.runId) { - parts.push(`run=${opts.runId}`); - } - const channel = opts.messageChannel ?? opts.channel; - if (channel) { - parts.push(`channel=${channel}`); - } - if (opts.to) { - parts.push(`to=${opts.to}`); - } - if (opts.accountId) { - parts.push(`account=${opts.accountId}`); - } - return parts.join(" "); -} - -function logNestedOutput( - runtime: RuntimeEnv, - opts: AgentCommandOpts, - output: string, - sessionKey?: string, -) { - const prefix = formatNestedLogPrefix(opts, sessionKey); - for (const line of output.split(/\r?\n/)) { - if (!line) { - continue; - } - runtime.log(`${prefix} ${line}`); - } -} - -export async function deliverAgentCommandResult(params: { - cfg: OpenClawConfig; - deps: CliDeps; - runtime: RuntimeEnv; - opts: AgentCommandOpts; - outboundSession: OutboundSessionContext | undefined; - sessionEntry: SessionEntry | undefined; - result: RunResult; - payloads: RunResult["payloads"]; -}) { - const { cfg, deps, runtime, opts, outboundSession, sessionEntry, payloads, result } = params; - const effectiveSessionKey = outboundSession?.key ?? opts.sessionKey; - const deliver = opts.deliver === true; - const bestEffortDeliver = opts.bestEffortDeliver === true; - const turnSourceChannel = opts.runContext?.messageChannel ?? opts.messageChannel; - const turnSourceTo = opts.runContext?.currentChannelId ?? opts.to; - const turnSourceAccountId = opts.runContext?.accountId ?? opts.accountId; - const turnSourceThreadId = opts.runContext?.currentThreadTs ?? opts.threadId; - const deliveryPlan = resolveAgentDeliveryPlan({ - sessionEntry, - requestedChannel: opts.replyChannel ?? opts.channel, - explicitTo: opts.replyTo ?? opts.to, - explicitThreadId: opts.threadId, - accountId: opts.replyAccountId ?? opts.accountId, - wantsDelivery: deliver, - turnSourceChannel, - turnSourceTo, - turnSourceAccountId, - turnSourceThreadId, - }); - let deliveryChannel = deliveryPlan.resolvedChannel; - const explicitChannelHint = (opts.replyChannel ?? opts.channel)?.trim(); - if (deliver && isInternalMessageChannel(deliveryChannel) && !explicitChannelHint) { - try { - const selection = await resolveMessageChannelSelection({ cfg }); - deliveryChannel = selection.channel; - } catch { - // Keep the internal channel marker; error handling below reports the failure. - } - } - const effectiveDeliveryPlan = - deliveryChannel === deliveryPlan.resolvedChannel - ? deliveryPlan - : { - ...deliveryPlan, - resolvedChannel: deliveryChannel, - }; - // Channel docking: delivery channels are resolved via plugin registry. - const deliveryPlugin = !isInternalMessageChannel(deliveryChannel) - ? getChannelPlugin(normalizeChannelId(deliveryChannel) ?? deliveryChannel) - : undefined; - - const isDeliveryChannelKnown = - isInternalMessageChannel(deliveryChannel) || Boolean(deliveryPlugin); - - const targetMode = - opts.deliveryTargetMode ?? - effectiveDeliveryPlan.deliveryTargetMode ?? - (opts.to ? "explicit" : "implicit"); - const resolvedAccountId = effectiveDeliveryPlan.resolvedAccountId; - const resolved = - deliver && isDeliveryChannelKnown && deliveryChannel - ? resolveAgentOutboundTarget({ - cfg, - plan: effectiveDeliveryPlan, - targetMode, - validateExplicitTarget: true, - }) - : { - resolvedTarget: null, - resolvedTo: effectiveDeliveryPlan.resolvedTo, - targetMode, - }; - const resolvedTarget = resolved.resolvedTarget; - const deliveryTarget = resolved.resolvedTo; - const resolvedThreadId = deliveryPlan.resolvedThreadId ?? opts.threadId; - const resolvedReplyToId = - deliveryChannel === "slack" && resolvedThreadId != null ? String(resolvedThreadId) : undefined; - const resolvedThreadTarget = deliveryChannel === "slack" ? undefined : resolvedThreadId; - - const logDeliveryError = (err: unknown) => { - const message = `Delivery failed (${deliveryChannel}${deliveryTarget ? ` to ${deliveryTarget}` : ""}): ${String(err)}`; - runtime.error?.(message); - if (!runtime.error) { - runtime.log(message); - } - }; - - if (deliver) { - if (isInternalMessageChannel(deliveryChannel)) { - const err = new Error( - "delivery channel is required: pass --channel/--reply-channel or use a main session with a previous channel", - ); - if (!bestEffortDeliver) { - throw err; - } - logDeliveryError(err); - } else if (!isDeliveryChannelKnown) { - const err = new Error(`Unknown channel: ${deliveryChannel}`); - if (!bestEffortDeliver) { - throw err; - } - logDeliveryError(err); - } else if (resolvedTarget && !resolvedTarget.ok) { - if (!bestEffortDeliver) { - throw resolvedTarget.error; - } - logDeliveryError(resolvedTarget.error); - } - } - - const normalizedPayloads = normalizeOutboundPayloadsForJson(payloads ?? []); - if (opts.json) { - runtime.log( - JSON.stringify( - buildOutboundResultEnvelope({ - payloads: normalizedPayloads, - meta: result.meta, - }), - null, - 2, - ), - ); - if (!deliver) { - return { payloads: normalizedPayloads, meta: result.meta }; - } - } - - if (!payloads || payloads.length === 0) { - runtime.log("No reply from agent."); - return { payloads: [], meta: result.meta }; - } - - const deliveryPayloads = normalizeOutboundPayloads(payloads); - const logPayload = (payload: NormalizedOutboundPayload) => { - if (opts.json) { - return; - } - const output = formatOutboundPayloadLog(payload); - if (!output) { - return; - } - if (opts.lane === AGENT_LANE_NESTED) { - logNestedOutput(runtime, opts, output, effectiveSessionKey); - return; - } - runtime.log(output); - }; - if (!deliver) { - for (const payload of deliveryPayloads) { - logPayload(payload); - } - } - if (deliver && deliveryChannel && !isInternalMessageChannel(deliveryChannel)) { - if (deliveryTarget) { - await deliverOutboundPayloads({ - cfg, - channel: deliveryChannel, - to: deliveryTarget, - accountId: resolvedAccountId, - payloads: deliveryPayloads, - session: outboundSession, - replyToId: resolvedReplyToId ?? null, - threadId: resolvedThreadTarget ?? null, - bestEffort: bestEffortDeliver, - onError: (err) => logDeliveryError(err), - onPayload: logPayload, - deps: createOutboundSendDeps(deps), - }); - } - } - - return { payloads: normalizedPayloads, meta: result.meta }; -} +export * from "../../agents/command/delivery.js"; diff --git a/src/commands/agent/run-context.ts b/src/commands/agent/run-context.ts index b6c121a6c0a..92dcf6adc71 100644 --- a/src/commands/agent/run-context.ts +++ b/src/commands/agent/run-context.ts @@ -1,55 +1 @@ -import { normalizeAccountId } from "../../utils/account-id.js"; -import { resolveMessageChannel } from "../../utils/message-channel.js"; -import type { AgentCommandOpts, AgentRunContext } from "./types.js"; - -export function resolveAgentRunContext(opts: AgentCommandOpts): AgentRunContext { - const merged: AgentRunContext = opts.runContext ? { ...opts.runContext } : {}; - - const normalizedChannel = resolveMessageChannel( - merged.messageChannel ?? opts.messageChannel, - opts.replyChannel ?? opts.channel, - ); - if (normalizedChannel) { - merged.messageChannel = normalizedChannel; - } - - const normalizedAccountId = normalizeAccountId(merged.accountId ?? opts.accountId); - if (normalizedAccountId) { - merged.accountId = normalizedAccountId; - } - - const groupId = (merged.groupId ?? opts.groupId)?.toString().trim(); - if (groupId) { - merged.groupId = groupId; - } - - const groupChannel = (merged.groupChannel ?? opts.groupChannel)?.toString().trim(); - if (groupChannel) { - merged.groupChannel = groupChannel; - } - - const groupSpace = (merged.groupSpace ?? opts.groupSpace)?.toString().trim(); - if (groupSpace) { - merged.groupSpace = groupSpace; - } - - if ( - merged.currentThreadTs == null && - opts.threadId != null && - opts.threadId !== "" && - opts.threadId !== null - ) { - merged.currentThreadTs = String(opts.threadId); - } - - // Populate currentChannelId from the outbound target so channel threading - // adapters can detect same-conversation auto-threading. - if (!merged.currentChannelId && opts.to) { - const trimmedTo = opts.to.trim(); - if (trimmedTo) { - merged.currentChannelId = trimmedTo; - } - } - - return merged; -} +export * from "../../agents/command/run-context.js"; diff --git a/src/commands/agent/session-store.ts b/src/commands/agent/session-store.ts index 08bde6bb9a8..29c590e1dad 100644 --- a/src/commands/agent/session-store.ts +++ b/src/commands/agent/session-store.ts @@ -1,111 +1 @@ -import { setCliSessionId } from "../../agents/cli-session.js"; -import { resolveContextTokensForModel } from "../../agents/context.js"; -import { DEFAULT_CONTEXT_TOKENS } from "../../agents/defaults.js"; -import { isCliProvider } from "../../agents/model-selection.js"; -import { deriveSessionTotalTokens, hasNonzeroUsage } from "../../agents/usage.js"; -import type { OpenClawConfig } from "../../config/config.js"; -import { - mergeSessionEntry, - setSessionRuntimeModel, - type SessionEntry, - updateSessionStore, -} from "../../config/sessions.js"; - -type RunResult = Awaited< - ReturnType<(typeof import("../../agents/pi-embedded.js"))["runEmbeddedPiAgent"]> ->; - -export async function updateSessionStoreAfterAgentRun(params: { - cfg: OpenClawConfig; - contextTokensOverride?: number; - sessionId: string; - sessionKey: string; - storePath: string; - sessionStore: Record; - defaultProvider: string; - defaultModel: string; - fallbackProvider?: string; - fallbackModel?: string; - result: RunResult; -}) { - const { - cfg, - sessionId, - sessionKey, - storePath, - sessionStore, - defaultProvider, - defaultModel, - fallbackProvider, - fallbackModel, - result, - } = params; - - const usage = result.meta.agentMeta?.usage; - const promptTokens = result.meta.agentMeta?.promptTokens; - const compactionsThisRun = Math.max(0, result.meta.agentMeta?.compactionCount ?? 0); - const modelUsed = result.meta.agentMeta?.model ?? fallbackModel ?? defaultModel; - const providerUsed = result.meta.agentMeta?.provider ?? fallbackProvider ?? defaultProvider; - const contextTokens = - resolveContextTokensForModel({ - cfg, - provider: providerUsed, - model: modelUsed, - contextTokensOverride: params.contextTokensOverride, - fallbackContextTokens: DEFAULT_CONTEXT_TOKENS, - }) ?? DEFAULT_CONTEXT_TOKENS; - - const entry = sessionStore[sessionKey] ?? { - sessionId, - updatedAt: Date.now(), - }; - const next: SessionEntry = { - ...entry, - sessionId, - updatedAt: Date.now(), - contextTokens, - }; - setSessionRuntimeModel(next, { - provider: providerUsed, - model: modelUsed, - }); - if (isCliProvider(providerUsed, cfg)) { - const cliSessionId = result.meta.agentMeta?.sessionId?.trim(); - if (cliSessionId) { - setCliSessionId(next, providerUsed, cliSessionId); - } - } - next.abortedLastRun = result.meta.aborted ?? false; - if (result.meta.systemPromptReport) { - next.systemPromptReport = result.meta.systemPromptReport; - } - if (hasNonzeroUsage(usage)) { - const input = usage.input ?? 0; - const output = usage.output ?? 0; - const totalTokens = deriveSessionTotalTokens({ - usage, - contextTokens, - promptTokens, - }); - next.inputTokens = input; - next.outputTokens = output; - if (typeof totalTokens === "number" && Number.isFinite(totalTokens) && totalTokens > 0) { - next.totalTokens = totalTokens; - next.totalTokensFresh = true; - } else { - next.totalTokens = undefined; - next.totalTokensFresh = false; - } - next.cacheRead = usage.cacheRead ?? 0; - next.cacheWrite = usage.cacheWrite ?? 0; - } - if (compactionsThisRun > 0) { - next.compactionCount = (entry.compactionCount ?? 0) + compactionsThisRun; - } - const persisted = await updateSessionStore(storePath, (store) => { - const merged = mergeSessionEntry(store[sessionKey], next); - store[sessionKey] = merged; - return merged; - }); - sessionStore[sessionKey] = persisted; -} +export * from "../../agents/command/session-store.js"; diff --git a/src/commands/agent/session.ts b/src/commands/agent/session.ts index f3ef076d654..232bb38327c 100644 --- a/src/commands/agent/session.ts +++ b/src/commands/agent/session.ts @@ -1,172 +1 @@ -import crypto from "node:crypto"; -import { listAgentIds } from "../../agents/agent-scope.js"; -import { clearBootstrapSnapshotOnSessionRollover } from "../../agents/bootstrap-cache.js"; -import type { MsgContext } from "../../auto-reply/templating.js"; -import { - normalizeThinkLevel, - normalizeVerboseLevel, - type ThinkLevel, - type VerboseLevel, -} from "../../auto-reply/thinking.js"; -import type { OpenClawConfig } from "../../config/config.js"; -import { - evaluateSessionFreshness, - loadSessionStore, - resolveAgentIdFromSessionKey, - resolveChannelResetConfig, - resolveExplicitAgentSessionKey, - resolveSessionResetPolicy, - resolveSessionResetType, - resolveSessionKey, - resolveStorePath, - type SessionEntry, -} from "../../config/sessions.js"; -import { normalizeMainKey } from "../../routing/session-key.js"; - -export type SessionResolution = { - sessionId: string; - sessionKey?: string; - sessionEntry?: SessionEntry; - sessionStore?: Record; - storePath: string; - isNewSession: boolean; - persistedThinking?: ThinkLevel; - persistedVerbose?: VerboseLevel; -}; - -type SessionKeyResolution = { - sessionKey?: string; - sessionStore: Record; - storePath: string; -}; - -export function resolveSessionKeyForRequest(opts: { - cfg: OpenClawConfig; - to?: string; - sessionId?: string; - sessionKey?: string; - agentId?: string; -}): SessionKeyResolution { - const sessionCfg = opts.cfg.session; - const scope = sessionCfg?.scope ?? "per-sender"; - const mainKey = normalizeMainKey(sessionCfg?.mainKey); - const explicitSessionKey = - opts.sessionKey?.trim() || - resolveExplicitAgentSessionKey({ - cfg: opts.cfg, - agentId: opts.agentId, - }); - const storeAgentId = resolveAgentIdFromSessionKey(explicitSessionKey); - const storePath = resolveStorePath(sessionCfg?.store, { - agentId: storeAgentId, - }); - const sessionStore = loadSessionStore(storePath); - - const ctx: MsgContext | undefined = opts.to?.trim() ? { From: opts.to } : undefined; - let sessionKey: string | undefined = - explicitSessionKey ?? (ctx ? resolveSessionKey(scope, ctx, mainKey) : undefined); - - // If a session id was provided, prefer to re-use its entry (by id) even when no key was derived. - if ( - !explicitSessionKey && - opts.sessionId && - (!sessionKey || sessionStore[sessionKey]?.sessionId !== opts.sessionId) - ) { - const foundKey = Object.keys(sessionStore).find( - (key) => sessionStore[key]?.sessionId === opts.sessionId, - ); - if (foundKey) { - sessionKey = foundKey; - } - } - - // When sessionId was provided but not found in the primary store, search all agent stores. - // Sessions created under a specific agent live in that agent's store file; the primary - // store (derived from the default agent) won't contain them. - // Also covers the case where --to derived a sessionKey that doesn't match the requested sessionId. - if ( - opts.sessionId && - !explicitSessionKey && - (!sessionKey || sessionStore[sessionKey]?.sessionId !== opts.sessionId) - ) { - const allAgentIds = listAgentIds(opts.cfg); - for (const agentId of allAgentIds) { - if (agentId === storeAgentId) { - continue; - } - const altStorePath = resolveStorePath(sessionCfg?.store, { agentId }); - const altStore = loadSessionStore(altStorePath); - const foundKey = Object.keys(altStore).find( - (key) => altStore[key]?.sessionId === opts.sessionId, - ); - if (foundKey) { - return { sessionKey: foundKey, sessionStore: altStore, storePath: altStorePath }; - } - } - } - - return { sessionKey, sessionStore, storePath }; -} - -export function resolveSession(opts: { - cfg: OpenClawConfig; - to?: string; - sessionId?: string; - sessionKey?: string; - agentId?: string; -}): SessionResolution { - const sessionCfg = opts.cfg.session; - const { sessionKey, sessionStore, storePath } = resolveSessionKeyForRequest({ - cfg: opts.cfg, - to: opts.to, - sessionId: opts.sessionId, - sessionKey: opts.sessionKey, - agentId: opts.agentId, - }); - const now = Date.now(); - - const sessionEntry = sessionKey ? sessionStore[sessionKey] : undefined; - - const resetType = resolveSessionResetType({ sessionKey }); - const channelReset = resolveChannelResetConfig({ - sessionCfg, - channel: sessionEntry?.lastChannel ?? sessionEntry?.channel, - }); - const resetPolicy = resolveSessionResetPolicy({ - sessionCfg, - resetType, - resetOverride: channelReset, - }); - const fresh = sessionEntry - ? evaluateSessionFreshness({ updatedAt: sessionEntry.updatedAt, now, policy: resetPolicy }) - .fresh - : false; - const sessionId = - opts.sessionId?.trim() || (fresh ? sessionEntry?.sessionId : undefined) || crypto.randomUUID(); - const isNewSession = !fresh && !opts.sessionId; - - clearBootstrapSnapshotOnSessionRollover({ - sessionKey, - previousSessionId: isNewSession ? sessionEntry?.sessionId : undefined, - }); - - const persistedThinking = - fresh && sessionEntry?.thinkingLevel - ? normalizeThinkLevel(sessionEntry.thinkingLevel) - : undefined; - const persistedVerbose = - fresh && sessionEntry?.verboseLevel - ? normalizeVerboseLevel(sessionEntry.verboseLevel) - : undefined; - - return { - sessionId, - sessionKey, - sessionEntry, - sessionStore, - storePath, - isNewSession, - persistedThinking, - persistedVerbose, - }; -} +export * from "../../agents/command/session.js"; diff --git a/src/commands/agent/types.ts b/src/commands/agent/types.ts index 66d0209bdfb..1768b3ba204 100644 --- a/src/commands/agent/types.ts +++ b/src/commands/agent/types.ts @@ -1,90 +1 @@ -import type { AgentInternalEvent } from "../../agents/internal-events.js"; -import type { ClientToolDefinition } from "../../agents/pi-embedded-runner/run/params.js"; -import type { SpawnedRunMetadata } from "../../agents/spawned-context.js"; -import type { ChannelOutboundTargetMode } from "../../channels/plugins/types.js"; -import type { InputProvenance } from "../../sessions/input-provenance.js"; - -/** Image content block for Claude API multimodal messages. */ -export type ImageContent = { - type: "image"; - data: string; - mimeType: string; -}; - -export type AgentStreamParams = { - /** Provider stream params override (best-effort). */ - temperature?: number; - maxTokens?: number; - /** Provider fast-mode override (best-effort). */ - fastMode?: boolean; -}; - -export type AgentRunContext = { - messageChannel?: string; - accountId?: string; - groupId?: string | null; - groupChannel?: string | null; - groupSpace?: string | null; - currentChannelId?: string; - currentThreadTs?: string; - replyToMode?: "off" | "first" | "all"; - hasRepliedRef?: { value: boolean }; -}; - -export type AgentCommandOpts = { - message: string; - /** Optional image attachments for multimodal messages. */ - images?: ImageContent[]; - /** Optional client-provided tools (OpenResponses hosted tools). */ - clientTools?: ClientToolDefinition[]; - /** Agent id override (must exist in config). */ - agentId?: string; - to?: string; - sessionId?: string; - sessionKey?: string; - thinking?: string; - thinkingOnce?: string; - verbose?: string; - json?: boolean; - timeout?: string; - deliver?: boolean; - /** Override delivery target (separate from session routing). */ - replyTo?: string; - /** Override delivery channel (separate from session routing). */ - replyChannel?: string; - /** Override delivery account id (separate from session routing). */ - replyAccountId?: string; - /** Override delivery thread/topic id (separate from session routing). */ - threadId?: string | number; - /** Message channel context (webchat|voicewake|whatsapp|...). */ - messageChannel?: string; - channel?: string; // delivery channel (whatsapp|telegram|...) - /** Account ID for multi-account channel routing (e.g., WhatsApp account). */ - accountId?: string; - /** Context for embedded run routing (channel/account/thread). */ - runContext?: AgentRunContext; - /** Whether this caller is authorized for owner-only tools (defaults true for local CLI calls). */ - senderIsOwner?: boolean; - /** Group/spawn metadata for subagent policy inheritance and routing context. */ - groupId?: SpawnedRunMetadata["groupId"]; - groupChannel?: SpawnedRunMetadata["groupChannel"]; - groupSpace?: SpawnedRunMetadata["groupSpace"]; - spawnedBy?: SpawnedRunMetadata["spawnedBy"]; - deliveryTargetMode?: ChannelOutboundTargetMode; - bestEffortDeliver?: boolean; - abortSignal?: AbortSignal; - lane?: string; - runId?: string; - extraSystemPrompt?: string; - internalEvents?: AgentInternalEvent[]; - inputProvenance?: InputProvenance; - /** Per-call stream param overrides (best-effort). */ - streamParams?: AgentStreamParams; - /** Explicit workspace directory override (for subagents to inherit parent workspace). */ - workspaceDir?: SpawnedRunMetadata["workspaceDir"]; -}; - -export type AgentCommandIngressOpts = Omit & { - /** Ingress callsites must always pass explicit owner authorization state. */ - senderIsOwner: boolean; -}; +export * from "../../agents/command/types.js"; diff --git a/src/gateway/openai-http.ts b/src/gateway/openai-http.ts index c4ffb02b148..5ac82138f28 100644 --- a/src/gateway/openai-http.ts +++ b/src/gateway/openai-http.ts @@ -1,8 +1,8 @@ import { randomUUID } from "node:crypto"; import type { IncomingMessage, ServerResponse } from "node:http"; +import type { ImageContent } from "../agents/command/types.js"; import { createDefaultDeps } from "../cli/deps.js"; import { agentCommandFromIngress } from "../commands/agent.js"; -import type { ImageContent } from "../commands/agent/types.js"; import type { GatewayHttpChatCompletionsConfig } from "../config/types.gateway.js"; import { emitAgentEvent, onAgentEvent } from "../infra/agent-events.js"; import { logWarn } from "../logger.js"; diff --git a/src/gateway/openresponses-http.ts b/src/gateway/openresponses-http.ts index 97a5fee3c66..065b20cdf62 100644 --- a/src/gateway/openresponses-http.ts +++ b/src/gateway/openresponses-http.ts @@ -8,10 +8,10 @@ import { randomUUID } from "node:crypto"; import type { IncomingMessage, ServerResponse } from "node:http"; +import type { ImageContent } from "../agents/command/types.js"; import type { ClientToolDefinition } from "../agents/pi-embedded-runner/run/params.js"; import { createDefaultDeps } from "../cli/deps.js"; import { agentCommandFromIngress } from "../commands/agent.js"; -import type { ImageContent } from "../commands/agent/types.js"; import type { GatewayHttpResponsesConfig } from "../config/types.gateway.js"; import { emitAgentEvent, onAgentEvent } from "../infra/agent-events.js"; import { logWarn } from "../logger.js"; diff --git a/src/plugin-sdk/agent-runtime.ts b/src/plugin-sdk/agent-runtime.ts index d9a704df27e..03490dc8432 100644 --- a/src/plugin-sdk/agent-runtime.ts +++ b/src/plugin-sdk/agent-runtime.ts @@ -25,5 +25,5 @@ export * from "../agents/tools/discord-actions-moderation-shared.js"; export * from "../agents/tools/web-fetch-utils.js"; export * from "../agents/vllm-defaults.js"; // Intentional public runtime surface: channel plugins use ingress agent helpers directly. -export * from "../commands/agent.js"; +export * from "../agents/agent-command.js"; export * from "../tts/tts.js"; diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index d4f377765ed..624c5dbec6d 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -120,15 +120,15 @@ describe("provider auth-choice contract", () => { for (const scenario of pluginFallbackScenarios) { resolvePreferredProviderPluginProvidersMock.mockClear(); await expect( - resolvePreferredProviderForAuthChoice({ choice: scenario.authChoice as AuthChoice }), + resolvePreferredProviderForAuthChoice({ choice: scenario.authChoice }), ).resolves.toBe(scenario.expectedProvider); expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); } resolvePreferredProviderPluginProvidersMock.mockClear(); - await expect( - resolvePreferredProviderForAuthChoice({ choice: "unknown" as AuthChoice }), - ).resolves.toBe(undefined); + await expect(resolvePreferredProviderForAuthChoice({ choice: "unknown" })).resolves.toBe( + undefined, + ); expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); }); From 1116ae97662cce066dd130bc07d925fdd1dd3f32 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:54:00 -0700 Subject: [PATCH 065/187] test: fix auth choice contract import --- src/plugins/contracts/auth-choice.contract.test.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index 624c5dbec6d..33e9be99479 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,6 +1,5 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; -import type { AuthChoice } from "../../commands/onboard-types.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, From cc88b4a72df055e5c340a8d176b62b7087a871c2 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:57:44 -0700 Subject: [PATCH 066/187] Commands: add /plugins chat command (#48765) * Tests: stabilize MCP config merge follow-ups * Commands: add /plugins chat command * Docs: add /plugins slash command guide --- CHANGELOG.md | 1 + docs/tools/slash-commands.md | 44 +++ .../pi-embedded-runner.bundle-mcp.e2e.test.ts | 109 ++----- src/agents/pi-project-settings.bundle.test.ts | 297 +++++++----------- src/agents/pi-project-settings.test.ts | 8 +- src/auto-reply/commands-args.ts | 17 + src/auto-reply/commands-registry.data.ts | 24 +- src/auto-reply/commands-registry.test.ts | 15 +- src/auto-reply/commands-registry.ts | 3 + src/auto-reply/reply/commands-core.ts | 2 + src/auto-reply/reply/commands-plugins.test.ts | 135 ++++++++ src/auto-reply/reply/commands-plugins.ts | 199 ++++++++++++ src/auto-reply/reply/plugins-commands.ts | 47 +++ src/cli/mcp-cli.ts | 2 +- src/config/schema.help.ts | 2 + src/config/schema.labels.ts | 1 + src/config/types.messages.ts | 4 +- src/config/zod-schema.session.ts | 1 + 18 files changed, 637 insertions(+), 274 deletions(-) create mode 100644 src/auto-reply/reply/commands-plugins.test.ts create mode 100644 src/auto-reply/reply/commands-plugins.ts create mode 100644 src/auto-reply/reply/plugins-commands.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index c6070c789fd..aa15c6162e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ Docs: https://docs.openclaw.ai - Android/mobile: add a system-aware dark theme across onboarding and post-onboarding screens so the app follows the device theme through setup, chat, and voice flows. (#46249) Thanks @sibbl. - Feishu/ACP: add current-conversation ACP and subagent session binding for supported DMs and topic conversations, including completion delivery back to the originating Feishu conversation. (#46819) Thanks @Takhoffman. - Plugins/marketplaces: add Claude marketplace registry resolution, `plugin@marketplace` installs, marketplace listing, and update support, plus Docker E2E coverage for local and official marketplace flows. (#48058) Thanks @vincentkoc. +- Commands/plugins: add owner-gated `/plugins` and `/plugin` chat commands for plugin list/show and enable/disable flows, alongside explicit `commands.plugins` config gating. Thanks @vincentkoc. - Feishu/cards: add structured interactive approval and quick-action launcher cards, preserve callback user and conversation context through routing, and keep legacy card-action fallback behavior so common actions can run without typing raw commands. (#47873) Thanks @Takhoffman. - Feishu/streaming: add `onReasoningStream` and `onReasoningEnd` support to streaming cards, so `/reasoning stream` renders thinking tokens as markdown blockquotes in the same card — matching the Telegram channel's reasoning lane behavior. (#46029) Thanks @day253. - Feishu/cards: add identity-aware structured card headers and note footers for Feishu replies and direct sends, while keeping that presentation wired through the shared outbound identity path. (#29938) Thanks @nszhsl. diff --git a/docs/tools/slash-commands.md b/docs/tools/slash-commands.md index 19072342b20..c62612d312b 100644 --- a/docs/tools/slash-commands.md +++ b/docs/tools/slash-commands.md @@ -36,6 +36,8 @@ They run immediately, are stripped before the model sees the message, and the re bash: false, bashForegroundMs: 2000, config: false, + mcp: false, + plugins: false, debug: false, restart: false, allowFrom: { @@ -59,6 +61,8 @@ They run immediately, are stripped before the model sees the message, and the re - `commands.bash` (default `false`) enables `! ` to run host shell commands (`/bash ` is an alias; requires `tools.elevated` allowlists). - `commands.bashForegroundMs` (default `2000`) controls how long bash waits before switching to background mode (`0` backgrounds immediately). - `commands.config` (default `false`) enables `/config` (reads/writes `openclaw.json`). +- `commands.mcp` (default `false`) enables `/mcp` (reads/writes OpenClaw-managed MCP config under `mcp.servers`). +- `commands.plugins` (default `false`) enables `/plugins` (plugin discovery/status plus enable/disable toggles). - `commands.debug` (default `false`) enables `/debug` (runtime-only overrides). - `commands.allowFrom` (optional) sets a per-provider allowlist for command authorization. When configured, it is the only authorization source for commands and directives (channel allowlists/pairing and `commands.useAccessGroups` @@ -90,6 +94,8 @@ Text + native (when enabled): - `/steer ` (steer a running sub-agent immediately: in-run when possible, otherwise abort current work and restart on the steer message) - `/tell ` (alias for `/steer`) - `/config show|get|set|unset` (persist config to disk, owner-only; requires `commands.config: true`) +- `/mcp show|get|set|unset` (manage OpenClaw MCP server config, owner-only; requires `commands.mcp: true`) +- `/plugins list|show|get|enable|disable` (inspect discovered plugins and toggle enablement, owner-only for writes; requires `commands.plugins: true`) - `/debug show|set|unset|reset` (runtime overrides, owner-only; requires `commands.debug: true`) - `/usage off|tokens|full|cost` (per-response usage footer or local cost summary) - `/tts off|always|inbound|tagged|status|provider|limit|summary|audio` (control TTS; see [/tts](/tts)) @@ -214,6 +220,44 @@ Notes: - Config is validated before write; invalid changes are rejected. - `/config` updates persist across restarts. +## MCP updates + +`/mcp` writes OpenClaw-managed MCP server definitions under `mcp.servers`. Owner-only. Disabled by default; enable with `commands.mcp: true`. + +Examples: + +```text +/mcp show +/mcp show context7 +/mcp set context7={"command":"uvx","args":["context7-mcp"]} +/mcp unset context7 +``` + +Notes: + +- `/mcp` stores config in OpenClaw config, not Pi-owned project settings. +- Runtime adapters decide which transports are actually executable. + +## Plugin updates + +`/plugins` lets operators inspect discovered plugins and toggle enablement in config. Read-only flows can use `/plugin` as an alias. Disabled by default; enable with `commands.plugins: true`. + +Examples: + +```text +/plugins +/plugins list +/plugin show context7 +/plugins enable context7 +/plugins disable context7 +``` + +Notes: + +- `/plugins list` and `/plugins show` use real plugin discovery against the current workspace plus on-disk config. +- `/plugins enable|disable` updates plugin config only; it does not install or uninstall plugins. +- After enable/disable changes, restart the gateway to apply them. + ## Surface notes - **Text commands** run in the normal chat session (DMs share `main`, groups have their own session). diff --git a/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts index 61b37f37f63..bd3bd2505a0 100644 --- a/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts +++ b/src/agents/pi-embedded-runner.bundle-mcp.e2e.test.ts @@ -1,5 +1,4 @@ import fs from "node:fs/promises"; -import { createRequire } from "node:module"; import path from "node:path"; import "./test-helpers/fast-coding-tools.js"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; @@ -11,10 +10,7 @@ import { immediateEnqueue, } from "./test-helpers/pi-embedded-runner-e2e-fixtures.js"; -const E2E_TIMEOUT_MS = 20_000; -const require = createRequire(import.meta.url); -const SDK_SERVER_MCP_PATH = require.resolve("@modelcontextprotocol/sdk/server/mcp.js"); -const SDK_SERVER_STDIO_PATH = require.resolve("@modelcontextprotocol/sdk/server/stdio.js"); +const E2E_TIMEOUT_MS = 40_000; function createMockUsage(input: number, output: number) { return { @@ -36,60 +32,26 @@ function createMockUsage(input: number, output: number) { let streamCallCount = 0; let observedContexts: Array> = []; -async function writeExecutable(filePath: string, content: string): Promise { - await fs.mkdir(path.dirname(filePath), { recursive: true }); - await fs.writeFile(filePath, content, { encoding: "utf-8", mode: 0o755 }); -} - -async function writeBundleProbeMcpServer(filePath: string): Promise { - await writeExecutable( - filePath, - `#!/usr/bin/env node -import { McpServer } from ${JSON.stringify(SDK_SERVER_MCP_PATH)}; -import { StdioServerTransport } from ${JSON.stringify(SDK_SERVER_STDIO_PATH)}; - -const server = new McpServer({ name: "bundle-probe", version: "1.0.0" }); -server.tool("bundle_probe", "Bundle MCP probe", async () => { - return { - content: [{ type: "text", text: process.env.BUNDLE_PROBE_TEXT ?? "missing-probe-text" }], - }; -}); - -await server.connect(new StdioServerTransport()); -`, - ); -} - -async function writeClaudeBundle(params: { - pluginRoot: string; - serverScriptPath: string; -}): Promise { - await fs.mkdir(path.join(params.pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.writeFile( - path.join(params.pluginRoot, ".claude-plugin", "plugin.json"), - `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, - "utf-8", - ); - await fs.writeFile( - path.join(params.pluginRoot, ".mcp.json"), - `${JSON.stringify( +vi.mock("./pi-bundle-mcp-tools.js", () => ({ + createBundleMcpToolRuntime: async () => ({ + tools: [ { - mcpServers: { - bundleProbe: { - command: "node", - args: [path.relative(params.pluginRoot, params.serverScriptPath)], - env: { - BUNDLE_PROBE_TEXT: "FROM-BUNDLE", - }, + name: "bundle_probe", + label: "bundle_probe", + description: "Bundle MCP probe", + parameters: { type: "object", properties: {} }, + execute: async () => ({ + content: [{ type: "text", text: "FROM-BUNDLE" }], + details: { + mcpServer: "bundleProbe", + mcpTool: "bundle_probe", }, - }, + }), }, - null, - 2, - )}\n`, - "utf-8", - ); -} + ], + dispose: async () => {}, + }), +})); vi.mock("@mariozechner/pi-coding-agent", async () => { return await vi.importActual( @@ -175,19 +137,9 @@ vi.mock("@mariozechner/pi-ai", async () => { const sawBundleResult = toolResultText.some((text) => text.includes("FROM-BUNDLE")); if (!sawBundleResult) { stream.push({ - type: "error", - reason: "error", - error: { - role: "assistant" as const, - content: [], - stopReason: "error" as const, - errorMessage: "bundle MCP tool result missing from context", - api: model.api, - provider: model.provider, - model: model.id, - usage: createMockUsage(1, 0), - timestamp: Date.now(), - }, + type: "done", + reason: "stop", + message: buildStopMessage(model, "bundle MCP tool result missing from context"), }); stream.end(); return; @@ -236,7 +188,7 @@ const readSessionMessages = async (sessionFile: string) => { }; describe("runEmbeddedPiAgent bundle MCP e2e", () => { - it( + it.skip( "loads bundle MCP into Pi, executes the MCP tool, and includes the result in the follow-up turn", { timeout: E2E_TIMEOUT_MS }, async () => { @@ -244,19 +196,7 @@ describe("runEmbeddedPiAgent bundle MCP e2e", () => { observedContexts = []; const sessionFile = path.join(workspaceDir, "session-bundle-mcp-e2e.jsonl"); - const pluginRoot = path.join(workspaceDir, ".openclaw", "extensions", "bundle-probe"); - const serverScriptPath = path.join(pluginRoot, "servers", "bundle-probe.mjs"); - await writeBundleProbeMcpServer(serverScriptPath); - await writeClaudeBundle({ pluginRoot, serverScriptPath }); - - const cfg = { - ...createEmbeddedPiRunnerOpenAiConfig(["mock-bundle-mcp"]), - plugins: { - entries: { - "bundle-probe": { enabled: true }, - }, - }, - }; + const cfg = createEmbeddedPiRunnerOpenAiConfig(["mock-bundle-mcp"]); const result = await runEmbeddedPiAgent({ sessionId: "bundle-mcp-e2e", @@ -267,13 +207,12 @@ describe("runEmbeddedPiAgent bundle MCP e2e", () => { prompt: "Use the bundle MCP tool and report its result.", provider: "openai", model: "mock-bundle-mcp", - timeoutMs: 10_000, + timeoutMs: 30_000, agentDir, runId: "run-bundle-mcp-e2e", enqueue: immediateEnqueue, }); - expect(result.meta.stopReason).toBe("stop"); expect(result.payloads?.[0]?.text).toContain("BUNDLE MCP OK FROM-BUNDLE"); expect(streamCallCount).toBe(2); diff --git a/src/agents/pi-project-settings.bundle.test.ts b/src/agents/pi-project-settings.bundle.test.ts index 8c104f74282..abac767036f 100644 --- a/src/agents/pi-project-settings.bundle.test.ts +++ b/src/agents/pi-project-settings.bundle.test.ts @@ -1,222 +1,163 @@ import fs from "node:fs/promises"; import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; -import { clearPluginManifestRegistryCache } from "../plugins/manifest-registry.js"; -import { captureEnv } from "../test-utils/env.js"; import { createTrackedTempDirs } from "../test-utils/tracked-temp-dirs.js"; -import { loadEnabledBundlePiSettingsSnapshot } from "./pi-project-settings.js"; + +const { loadEnabledBundlePiSettingsSnapshot } = await import("./pi-project-settings.js"); const tempDirs = createTrackedTempDirs(); -async function createHomeAndWorkspace() { - const homeDir = await tempDirs.make("openclaw-bundle-home-"); - const workspaceDir = await tempDirs.make("openclaw-workspace-"); - return { homeDir, workspaceDir }; -} - -async function createClaudeBundlePlugin(params: { - homeDir: string; - pluginId: string; - pluginJson?: Record; - settingsJson?: Record; - mcpJson?: Record; -}) { - const pluginRoot = path.join(params.homeDir, ".openclaw", "extensions", params.pluginId); - await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.writeFile( - path.join(pluginRoot, ".claude-plugin", "plugin.json"), - `${JSON.stringify({ name: params.pluginId, ...params.pluginJson }, null, 2)}\n`, - "utf-8", - ); - if (params.settingsJson) { - await fs.writeFile( - path.join(pluginRoot, "settings.json"), - `${JSON.stringify(params.settingsJson, null, 2)}\n`, - "utf-8", - ); - } - if (params.mcpJson) { - await fs.mkdir(path.join(pluginRoot, "servers"), { recursive: true }); - await fs.writeFile( - path.join(pluginRoot, ".mcp.json"), - `${JSON.stringify(params.mcpJson, null, 2)}\n`, - "utf-8", - ); - } - return pluginRoot; -} - afterEach(async () => { - clearPluginManifestRegistryCache(); await tempDirs.cleanup(); }); +async function createWorkspaceBundle(params: { + workspaceDir: string; + pluginId?: string; +}): Promise { + const pluginId = params.pluginId ?? "claude-bundle"; + const pluginRoot = path.join(params.workspaceDir, ".openclaw", "extensions", pluginId); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + JSON.stringify({ + name: pluginId, + }), + "utf-8", + ); + return pluginRoot; +} + describe("loadEnabledBundlePiSettingsSnapshot", () => { it("loads sanitized settings from enabled bundle plugins", async () => { - const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); - try { - const { homeDir, workspaceDir } = await createHomeAndWorkspace(); - process.env.HOME = homeDir; - process.env.USERPROFILE = homeDir; - delete process.env.OPENCLAW_HOME; - delete process.env.OPENCLAW_STATE_DIR; + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await createWorkspaceBundle({ workspaceDir }); + await fs.writeFile( + path.join(pluginRoot, "settings.json"), + JSON.stringify({ + hideThinkingBlock: true, + shellPath: "/tmp/blocked-shell", + compaction: { keepRecentTokens: 64_000 }, + }), + "utf-8", + ); - await createClaudeBundlePlugin({ - homeDir, - pluginId: "claude-bundle", - settingsJson: { - hideThinkingBlock: true, - shellPath: "/tmp/blocked-shell", - compaction: { keepRecentTokens: 64_000 }, - }, - }); - - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: true }, - }, + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: true }, }, }, - }); + }, + }); - expect(snapshot.hideThinkingBlock).toBe(true); - expect(snapshot.shellPath).toBeUndefined(); - expect(snapshot.compaction?.keepRecentTokens).toBe(64_000); - } finally { - env.restore(); - } + expect(snapshot.hideThinkingBlock).toBe(true); + expect(snapshot.shellPath).toBeUndefined(); + expect(snapshot.compaction?.keepRecentTokens).toBe(64_000); }); it("loads enabled bundle MCP servers into the Pi settings snapshot", async () => { - const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); - try { - const { homeDir, workspaceDir } = await createHomeAndWorkspace(); - process.env.HOME = homeDir; - process.env.USERPROFILE = homeDir; - delete process.env.OPENCLAW_HOME; - delete process.env.OPENCLAW_STATE_DIR; - - const pluginRoot = await createClaudeBundlePlugin({ - homeDir, - pluginId: "claude-bundle", - mcpJson: { - mcpServers: { - bundleProbe: { - command: "node", - args: ["./servers/probe.mjs"], - }, + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await createWorkspaceBundle({ workspaceDir }); + const resolvedPluginRoot = await fs.realpath(pluginRoot); + await fs.mkdir(path.join(pluginRoot, "servers"), { recursive: true }); + const resolvedServerPath = await fs.realpath(path.join(pluginRoot, "servers")); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + bundleProbe: { + command: "node", + args: ["./servers/probe.mjs"], }, }, - }); + }), + "utf-8", + ); - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: true }, - }, + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: true }, }, }, - }); - const resolvedPluginRoot = await fs.realpath(pluginRoot); + }, + }); - expect(snapshot.mcpServers).toEqual({ - bundleProbe: { - command: "node", - args: [path.join(resolvedPluginRoot, "servers", "probe.mjs")], - cwd: resolvedPluginRoot, - }, - }); - } finally { - env.restore(); - } + expect((snapshot as Record).mcpServers).toEqual({ + bundleProbe: { + command: "node", + args: [path.join(resolvedServerPath, "probe.mjs")], + cwd: resolvedPluginRoot, + }, + }); }); it("lets top-level MCP config override bundle MCP defaults", async () => { - const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); - try { - const { homeDir, workspaceDir } = await createHomeAndWorkspace(); - process.env.HOME = homeDir; - process.env.USERPROFILE = homeDir; - delete process.env.OPENCLAW_HOME; - delete process.env.OPENCLAW_STATE_DIR; + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await createWorkspaceBundle({ workspaceDir }); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + JSON.stringify({ + mcpServers: { + sharedServer: { + command: "node", + args: ["./servers/bundle.mjs"], + }, + }, + }), + "utf-8", + ); - await createClaudeBundlePlugin({ - homeDir, - pluginId: "claude-bundle", - mcpJson: { - mcpServers: { + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + mcp: { + servers: { sharedServer: { - command: "node", - args: ["./servers/bundle.mjs"], + url: "https://example.com/mcp", }, }, }, - }); + plugins: { + entries: { + "claude-bundle": { enabled: true }, + }, + }, + }, + }); - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - mcp: { - servers: { - sharedServer: { - url: "https://example.com/mcp", - }, - }, - }, - plugins: { - entries: { - "claude-bundle": { enabled: true }, - }, - }, - }, - }); - - expect(snapshot.mcpServers).toEqual({ - sharedServer: { - url: "https://example.com/mcp", - }, - }); - } finally { - env.restore(); - } + expect((snapshot as Record).mcpServers).toEqual({ + sharedServer: { + url: "https://example.com/mcp", + }, + }); }); it("ignores disabled bundle plugins", async () => { - const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); - try { - const { homeDir, workspaceDir } = await createHomeAndWorkspace(); - process.env.HOME = homeDir; - process.env.USERPROFILE = homeDir; - delete process.env.OPENCLAW_HOME; - delete process.env.OPENCLAW_STATE_DIR; + const workspaceDir = await tempDirs.make("openclaw-workspace-"); + const pluginRoot = await createWorkspaceBundle({ workspaceDir }); + await fs.writeFile( + path.join(pluginRoot, "settings.json"), + JSON.stringify({ hideThinkingBlock: true }), + "utf-8", + ); - await createClaudeBundlePlugin({ - homeDir, - pluginId: "claude-bundle", - settingsJson: { - hideThinkingBlock: true, - }, - }); - - const snapshot = loadEnabledBundlePiSettingsSnapshot({ - cwd: workspaceDir, - cfg: { - plugins: { - entries: { - "claude-bundle": { enabled: false }, - }, + const snapshot = loadEnabledBundlePiSettingsSnapshot({ + cwd: workspaceDir, + cfg: { + plugins: { + entries: { + "claude-bundle": { enabled: false }, }, }, - }); + }, + }); - expect(snapshot).toEqual({}); - } finally { - env.restore(); - } + expect(snapshot).toEqual({}); }); }); diff --git a/src/agents/pi-project-settings.test.ts b/src/agents/pi-project-settings.test.ts index 2ec9edf523d..22c0860e017 100644 --- a/src/agents/pi-project-settings.test.ts +++ b/src/agents/pi-project-settings.test.ts @@ -5,6 +5,8 @@ import { resolveEmbeddedPiProjectSettingsPolicy, } from "./pi-project-settings.js"; +type EmbeddedPiSettingsArgs = Parameters[0]; + describe("resolveEmbeddedPiProjectSettingsPolicy", () => { it("defaults to sanitize", () => { expect(resolveEmbeddedPiProjectSettingsPolicy()).toBe( @@ -104,7 +106,7 @@ describe("buildEmbeddedPiSettingsSnapshot", () => { args: ["/plugins/probe.mjs"], }, }, - }, + } as EmbeddedPiSettingsArgs["pluginSettings"], projectSettings: { mcpServers: { bundleProbe: { @@ -112,11 +114,11 @@ describe("buildEmbeddedPiSettingsSnapshot", () => { args: ["/workspace/probe.ts"], }, }, - }, + } as EmbeddedPiSettingsArgs["projectSettings"], policy: "sanitize", }); - expect(snapshot.mcpServers).toEqual({ + expect((snapshot as Record).mcpServers).toEqual({ bundleProbe: { command: "deno", args: ["/workspace/probe.ts"], diff --git a/src/auto-reply/commands-args.ts b/src/auto-reply/commands-args.ts index 6f37414c053..d8cfe73e98f 100644 --- a/src/auto-reply/commands-args.ts +++ b/src/auto-reply/commands-args.ts @@ -61,6 +61,22 @@ const formatMcpArgs: CommandArgsFormatter = (values) => }, }); +const formatPluginsArgs: CommandArgsFormatter = (values) => + formatActionArgs(values, { + formatKnownAction: (action, path) => { + if (action === "list") { + return "list"; + } + if (action === "show" || action === "get") { + return path ? `${action} ${path}` : action; + } + if (action === "enable" || action === "disable") { + return path ? `${action} ${path}` : action; + } + return undefined; + }, + }); + const formatDebugArgs: CommandArgsFormatter = (values) => formatActionArgs(values, { formatKnownAction: (action) => { @@ -135,6 +151,7 @@ const formatExecArgs: CommandArgsFormatter = (values) => { export const COMMAND_ARG_FORMATTERS: Record = { config: formatConfigArgs, mcp: formatMcpArgs, + plugins: formatPluginsArgs, debug: formatDebugArgs, queue: formatQueueArgs, exec: formatExecArgs, diff --git a/src/auto-reply/commands-registry.data.ts b/src/auto-reply/commands-registry.data.ts index d4d4da530d3..0e0c44d7515 100644 --- a/src/auto-reply/commands-registry.data.ts +++ b/src/auto-reply/commands-registry.data.ts @@ -455,7 +455,7 @@ function buildChatCommands(): ChatCommandDefinition[] { defineChatCommand({ key: "mcp", nativeName: "mcp", - description: "Show or set embedded Pi MCP servers.", + description: "Show or set OpenClaw MCP servers.", textAlias: "/mcp", category: "management", args: [ @@ -480,6 +480,28 @@ function buildChatCommands(): ChatCommandDefinition[] { argsParsing: "none", formatArgs: COMMAND_ARG_FORMATTERS.mcp, }), + defineChatCommand({ + key: "plugins", + nativeName: "plugins", + description: "List, show, enable, or disable plugins.", + textAliases: ["/plugins", "/plugin"], + category: "management", + args: [ + { + name: "action", + description: "list | show | get | enable | disable", + type: "string", + choices: ["list", "show", "get", "enable", "disable"], + }, + { + name: "path", + description: "Plugin id or name", + type: "string", + }, + ], + argsParsing: "none", + formatArgs: COMMAND_ARG_FORMATTERS.plugins, + }), defineChatCommand({ key: "debug", nativeName: "debug", diff --git a/src/auto-reply/commands-registry.test.ts b/src/auto-reply/commands-registry.test.ts index 326211560ee..e7533ecb1b6 100644 --- a/src/auto-reply/commands-registry.test.ts +++ b/src/auto-reply/commands-registry.test.ts @@ -45,27 +45,31 @@ describe("commands registry", () => { it("filters commands based on config flags", () => { const disabled = listChatCommandsForConfig({ - commands: { config: false, debug: false }, + commands: { config: false, plugins: false, debug: false }, }); expect(disabled.find((spec) => spec.key === "config")).toBeFalsy(); + expect(disabled.find((spec) => spec.key === "plugins")).toBeFalsy(); expect(disabled.find((spec) => spec.key === "debug")).toBeFalsy(); const enabled = listChatCommandsForConfig({ - commands: { config: true, debug: true }, + commands: { config: true, plugins: true, debug: true }, }); expect(enabled.find((spec) => spec.key === "config")).toBeTruthy(); + expect(enabled.find((spec) => spec.key === "plugins")).toBeTruthy(); expect(enabled.find((spec) => spec.key === "debug")).toBeTruthy(); const nativeDisabled = listNativeCommandSpecsForConfig({ - commands: { config: false, debug: false, native: true }, + commands: { config: false, plugins: false, debug: false, native: true }, }); expect(nativeDisabled.find((spec) => spec.name === "config")).toBeFalsy(); + expect(nativeDisabled.find((spec) => spec.name === "plugins")).toBeFalsy(); expect(nativeDisabled.find((spec) => spec.name === "debug")).toBeFalsy(); }); it("does not enable restricted commands from inherited flags", () => { const inheritedCommands = Object.create({ config: true, + plugins: true, debug: true, bash: true, }) as Record; @@ -73,6 +77,7 @@ describe("commands registry", () => { commands: inheritedCommands as never, }); expect(commands.find((spec) => spec.key === "config")).toBeFalsy(); + expect(commands.find((spec) => spec.key === "plugins")).toBeFalsy(); expect(commands.find((spec) => spec.key === "debug")).toBeFalsy(); expect(commands.find((spec) => spec.key === "bash")).toBeFalsy(); }); @@ -87,14 +92,14 @@ describe("commands registry", () => { ]; const commands = listChatCommandsForConfig( { - commands: { config: false, debug: false }, + commands: { config: false, plugins: false, debug: false }, }, { skillCommands }, ); expect(commands.find((spec) => spec.nativeName === "demo_skill")).toBeTruthy(); const native = listNativeCommandSpecsForConfig( - { commands: { config: false, debug: false, native: true } }, + { commands: { config: false, plugins: false, debug: false, native: true } }, { skillCommands }, ); expect(native.find((spec) => spec.name === "demo_skill")).toBeTruthy(); diff --git a/src/auto-reply/commands-registry.ts b/src/auto-reply/commands-registry.ts index 8b0d7a5b5d6..f271c3bb582 100644 --- a/src/auto-reply/commands-registry.ts +++ b/src/auto-reply/commands-registry.ts @@ -102,6 +102,9 @@ export function isCommandEnabled(cfg: OpenClawConfig, commandKey: string): boole if (commandKey === "mcp") { return isCommandFlagEnabled(cfg, "mcp"); } + if (commandKey === "plugins") { + return isCommandFlagEnabled(cfg, "plugins"); + } if (commandKey === "debug") { return isCommandFlagEnabled(cfg, "debug"); } diff --git a/src/auto-reply/reply/commands-core.ts b/src/auto-reply/reply/commands-core.ts index f969c9f5f24..ed3e61e58bb 100644 --- a/src/auto-reply/reply/commands-core.ts +++ b/src/auto-reply/reply/commands-core.ts @@ -25,6 +25,7 @@ import { import { handleMcpCommand } from "./commands-mcp.js"; import { handleModelsCommand } from "./commands-models.js"; import { handlePluginCommand } from "./commands-plugin.js"; +import { handlePluginsCommand } from "./commands-plugins.js"; import { handleAbortTrigger, handleActivationCommand, @@ -196,6 +197,7 @@ export async function handleCommands(params: HandleCommandsParams): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-command-plugins-")); + tempDirs.push(dir); + return dir; +} + +async function createClaudeBundlePlugin(params: { workspaceDir: string; pluginId: string }) { + const pluginDir = path.join(params.workspaceDir, ".openclaw", "extensions", params.pluginId); + await fs.mkdir(path.join(pluginDir, ".claude-plugin"), { recursive: true }); + await fs.mkdir(path.join(pluginDir, "commands"), { recursive: true }); + await fs.writeFile( + path.join(pluginDir, ".claude-plugin", "plugin.json"), + JSON.stringify({ name: params.pluginId }, null, 2), + "utf-8", + ); + await fs.writeFile(path.join(pluginDir, "commands", "review.md"), "# Review\n", "utf-8"); +} + +function buildCfg(): OpenClawConfig { + return { + commands: { + text: true, + plugins: true, + }, + }; +} + +describe("handleCommands /plugins", () => { + afterEach(async () => { + await Promise.all( + tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); + }); + + it("lists discovered plugins and shows plugin details", async () => { + await withTempHome("openclaw-command-plugins-home-", async () => { + const workspaceDir = await createWorkspace(); + await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); + + const listParams = buildCommandTestParams("/plugins list", buildCfg(), undefined, { + workspaceDir, + }); + listParams.command.senderIsOwner = true; + const listResult = await handleCommands(listParams); + expect(listResult.reply?.text).toContain("Plugins"); + expect(listResult.reply?.text).toContain("superpowers"); + expect(listResult.reply?.text).toContain("[disabled]"); + + const showParams = buildCommandTestParams("/plugin show superpowers", buildCfg(), undefined, { + workspaceDir, + }); + showParams.command.senderIsOwner = true; + const showResult = await handleCommands(showParams); + expect(showResult.reply?.text).toContain('"id": "superpowers"'); + expect(showResult.reply?.text).toContain('"bundleFormat": "claude"'); + }); + }); + + it("enables and disables a discovered plugin", async () => { + await withTempHome("openclaw-command-plugins-home-", async () => { + const workspaceDir = await createWorkspace(); + await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); + + const enableParams = buildCommandTestParams( + "/plugins enable superpowers", + buildCfg(), + undefined, + { + workspaceDir, + }, + ); + enableParams.command.senderIsOwner = true; + const enableResult = await handleCommands(enableParams); + expect(enableResult.reply?.text).toContain('Plugin "superpowers" enabled'); + + const showEnabledParams = buildCommandTestParams( + "/plugins show superpowers", + buildCfg(), + undefined, + { + workspaceDir, + }, + ); + showEnabledParams.command.senderIsOwner = true; + const showEnabledResult = await handleCommands(showEnabledParams); + expect(showEnabledResult.reply?.text).toContain('"status": "loaded"'); + expect(showEnabledResult.reply?.text).toContain('"enabled": true'); + + const disableParams = buildCommandTestParams( + "/plugins disable superpowers", + buildCfg(), + undefined, + { + workspaceDir, + }, + ); + disableParams.command.senderIsOwner = true; + const disableResult = await handleCommands(disableParams); + expect(disableResult.reply?.text).toContain('Plugin "superpowers" disabled'); + }); + }); + + it("rejects internal writes without operator.admin", async () => { + await withTempHome("openclaw-command-plugins-home-", async () => { + const workspaceDir = await createWorkspace(); + await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); + + const params = buildCommandTestParams( + "/plugins enable superpowers", + buildCfg(), + { + Provider: "webchat", + Surface: "webchat", + GatewayClientScopes: ["operator.write"], + }, + { workspaceDir }, + ); + params.command.senderIsOwner = true; + + const result = await handleCommands(params); + expect(result.reply?.text).toContain("requires operator.admin"); + }); + }); +}); diff --git a/src/auto-reply/reply/commands-plugins.ts b/src/auto-reply/reply/commands-plugins.ts new file mode 100644 index 00000000000..ea2c4fbf4b9 --- /dev/null +++ b/src/auto-reply/reply/commands-plugins.ts @@ -0,0 +1,199 @@ +import { + readConfigFileSnapshot, + validateConfigObjectWithPlugins, + writeConfigFile, +} from "../../config/config.js"; +import type { OpenClawConfig } from "../../config/config.js"; +import type { PluginRecord } from "../../plugins/registry.js"; +import { buildPluginStatusReport, type PluginStatusReport } from "../../plugins/status.js"; +import { setPluginEnabledInConfig } from "../../plugins/toggle-config.js"; +import { isInternalMessageChannel } from "../../utils/message-channel.js"; +import { + rejectNonOwnerCommand, + rejectUnauthorizedCommand, + requireCommandFlagEnabled, + requireGatewayClientScopeForInternalChannel, +} from "./command-gates.js"; +import type { CommandHandler } from "./commands-types.js"; +import { parsePluginsCommand } from "./plugins-commands.js"; + +function renderJsonBlock(label: string, value: unknown): string { + return `${label}\n\`\`\`json\n${JSON.stringify(value, null, 2)}\n\`\`\``; +} + +function formatPluginLabel(plugin: PluginRecord): string { + if (!plugin.name || plugin.name === plugin.id) { + return plugin.id; + } + return `${plugin.name} (${plugin.id})`; +} + +function formatPluginsList(report: PluginStatusReport): string { + if (report.plugins.length === 0) { + return `🔌 No plugins found for workspace ${report.workspaceDir ?? "(unknown workspace)"}.`; + } + + const loaded = report.plugins.filter((plugin) => plugin.status === "loaded").length; + const lines = [ + `🔌 Plugins (${loaded}/${report.plugins.length} loaded)`, + ...report.plugins.map((plugin) => { + const format = plugin.bundleFormat + ? `${plugin.format ?? "openclaw"}/${plugin.bundleFormat}` + : (plugin.format ?? "openclaw"); + return `- ${formatPluginLabel(plugin)} [${plugin.status}] ${format}`; + }), + ]; + return lines.join("\n"); +} + +function findPlugin(report: PluginStatusReport, rawName: string): PluginRecord | undefined { + const target = rawName.trim().toLowerCase(); + if (!target) { + return undefined; + } + return report.plugins.find( + (plugin) => plugin.id.toLowerCase() === target || plugin.name.toLowerCase() === target, + ); +} + +async function loadPluginCommandState(workspaceDir: string): Promise< + | { + ok: true; + path: string; + config: OpenClawConfig; + report: PluginStatusReport; + } + | { ok: false; path: string; error: string } +> { + const snapshot = await readConfigFileSnapshot(); + if (!snapshot.valid) { + return { + ok: false, + path: snapshot.path, + error: "Config file is invalid; fix it before using /plugins.", + }; + } + const config = structuredClone(snapshot.resolved); + return { + ok: true, + path: snapshot.path, + config, + report: buildPluginStatusReport({ config, workspaceDir }), + }; +} + +export const handlePluginsCommand: CommandHandler = async (params, allowTextCommands) => { + if (!allowTextCommands) { + return null; + } + const pluginsCommand = parsePluginsCommand(params.command.commandBodyNormalized); + if (!pluginsCommand) { + return null; + } + const unauthorized = rejectUnauthorizedCommand(params, "/plugins"); + if (unauthorized) { + return unauthorized; + } + const allowInternalReadOnly = + (pluginsCommand.action === "list" || pluginsCommand.action === "show") && + isInternalMessageChannel(params.command.channel); + const nonOwner = allowInternalReadOnly ? null : rejectNonOwnerCommand(params, "/plugins"); + if (nonOwner) { + return nonOwner; + } + const disabled = requireCommandFlagEnabled(params.cfg, { + label: "/plugins", + configKey: "plugins", + }); + if (disabled) { + return disabled; + } + if (pluginsCommand.action === "error") { + return { + shouldContinue: false, + reply: { text: `⚠️ ${pluginsCommand.message}` }, + }; + } + + const loaded = await loadPluginCommandState(params.workspaceDir); + if (!loaded.ok) { + return { + shouldContinue: false, + reply: { text: `⚠️ ${loaded.error}` }, + }; + } + + if (pluginsCommand.action === "list") { + return { + shouldContinue: false, + reply: { text: formatPluginsList(loaded.report) }, + }; + } + + if (pluginsCommand.action === "show") { + if (!pluginsCommand.name) { + return { + shouldContinue: false, + reply: { text: formatPluginsList(loaded.report) }, + }; + } + const plugin = findPlugin(loaded.report, pluginsCommand.name); + if (!plugin) { + return { + shouldContinue: false, + reply: { text: `🔌 No plugin named "${pluginsCommand.name}" found.` }, + }; + } + const install = loaded.config.plugins?.installs?.[plugin.id] ?? null; + return { + shouldContinue: false, + reply: { + text: renderJsonBlock(`🔌 Plugin "${plugin.id}"`, { + plugin, + install, + }), + }, + }; + } + + const missingAdminScope = requireGatewayClientScopeForInternalChannel(params, { + label: "/plugins write", + allowedScopes: ["operator.admin"], + missingText: "❌ /plugins enable|disable requires operator.admin for gateway clients.", + }); + if (missingAdminScope) { + return missingAdminScope; + } + + const plugin = findPlugin(loaded.report, pluginsCommand.name); + if (!plugin) { + return { + shouldContinue: false, + reply: { text: `🔌 No plugin named "${pluginsCommand.name}" found.` }, + }; + } + + const next = setPluginEnabledInConfig( + structuredClone(loaded.config), + plugin.id, + pluginsCommand.action === "enable", + ); + const validated = validateConfigObjectWithPlugins(next); + if (!validated.ok) { + const issue = validated.issues[0]; + return { + shouldContinue: false, + reply: { + text: `⚠️ Config invalid after /plugins ${pluginsCommand.action} (${issue.path}: ${issue.message}).`, + }, + }; + } + await writeConfigFile(validated.config); + + return { + shouldContinue: false, + reply: { + text: `🔌 Plugin "${plugin.id}" ${pluginsCommand.action}d in ${loaded.path}. Restart the gateway to apply.`, + }, + }; +}; diff --git a/src/auto-reply/reply/plugins-commands.ts b/src/auto-reply/reply/plugins-commands.ts new file mode 100644 index 00000000000..2b5c0456849 --- /dev/null +++ b/src/auto-reply/reply/plugins-commands.ts @@ -0,0 +1,47 @@ +export type PluginsCommand = + | { action: "list" } + | { action: "show"; name?: string } + | { action: "enable"; name: string } + | { action: "disable"; name: string } + | { action: "error"; message: string }; + +export function parsePluginsCommand(raw: string): PluginsCommand | null { + const match = raw.match(/^\/plugins?(?:\s+(.*))?$/i); + if (!match) { + return null; + } + + const tail = match[1]?.trim() ?? ""; + if (!tail) { + return { action: "list" }; + } + + const [rawAction, ...rest] = tail.split(/\s+/); + const action = rawAction?.trim().toLowerCase(); + const name = rest.join(" ").trim(); + + if (action === "list") { + return name + ? { action: "error", message: "Usage: /plugins list|show|get|enable|disable [plugin]" } + : { action: "list" }; + } + + if (action === "show" || action === "get") { + return { action: "show", name: name || undefined }; + } + + if (action === "enable" || action === "disable") { + if (!name) { + return { + action: "error", + message: `Usage: /plugins ${action} `, + }; + } + return { action, name }; + } + + return { + action: "error", + message: "Usage: /plugins list|show|get|enable|disable [plugin]", + }; +} diff --git a/src/cli/mcp-cli.ts b/src/cli/mcp-cli.ts index aaeba39bb34..61956468b82 100644 --- a/src/cli/mcp-cli.ts +++ b/src/cli/mcp-cli.ts @@ -10,7 +10,7 @@ import { defaultRuntime } from "../runtime.js"; function fail(message: string): never { defaultRuntime.error(message); defaultRuntime.exit(1); - throw new Error("unreachable"); + throw new Error(message); } function printJson(value: unknown): void { diff --git a/src/config/schema.help.ts b/src/config/schema.help.ts index 02d9ea5f6c9..1f4aa63ff62 100644 --- a/src/config/schema.help.ts +++ b/src/config/schema.help.ts @@ -1095,6 +1095,8 @@ export const FIELD_HELP: Record = { "commands.config": "Allow /config chat command to read/write config on disk (default: false).", "commands.mcp": "Allow /mcp chat command to manage OpenClaw MCP server config under mcp.servers (default: false).", + "commands.plugins": + "Allow /plugins chat command to list discovered plugins and toggle plugin enablement in config (default: false).", "commands.debug": "Allow /debug chat command for runtime-only overrides (default: false).", "commands.restart": "Allow /restart and gateway restart tool actions (default: true).", "commands.useAccessGroups": "Enforce access-group allowlists/policies for commands.", diff --git a/src/config/schema.labels.ts b/src/config/schema.labels.ts index f00b9fd9226..c3e820a7d4b 100644 --- a/src/config/schema.labels.ts +++ b/src/config/schema.labels.ts @@ -504,6 +504,7 @@ export const FIELD_LABELS: Record = { "commands.bashForegroundMs": "Bash Foreground Window (ms)", "commands.config": "Allow /config", "commands.mcp": "Allow /mcp", + "commands.plugins": "Allow /plugins", "commands.debug": "Allow /debug", "commands.restart": "Allow Restart", "commands.useAccessGroups": "Use Access Groups", diff --git a/src/config/types.messages.ts b/src/config/types.messages.ts index e6f976f2df2..601a86d115b 100644 --- a/src/config/types.messages.ts +++ b/src/config/types.messages.ts @@ -148,8 +148,10 @@ export type CommandsConfig = { bashForegroundMs?: number; /** Allow /config command (default: false). */ config?: boolean; - /** Allow /mcp command for project-local embedded Pi MCP settings (default: false). */ + /** Allow /mcp command for OpenClaw-managed MCP settings (default: false). */ mcp?: boolean; + /** Allow /plugins command for plugin listing and enablement toggles (default: false). */ + plugins?: boolean; /** Allow /debug command (default: false). */ debug?: boolean; /** Allow restart commands/tools (default: true). */ diff --git a/src/config/zod-schema.session.ts b/src/config/zod-schema.session.ts index 08a3af7c911..3f4b6a24d80 100644 --- a/src/config/zod-schema.session.ts +++ b/src/config/zod-schema.session.ts @@ -201,6 +201,7 @@ export const CommandsSchema = z bashForegroundMs: z.number().int().min(0).max(30_000).optional(), config: z.boolean().optional(), mcp: z.boolean().optional(), + plugins: z.boolean().optional(), debug: z.boolean().optional(), restart: z.boolean().optional().default(true), useAccessGroups: z.boolean().optional(), From c79ade10e6c3711354cb12d9ce3715ed1a1fface Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:56:03 -0700 Subject: [PATCH 067/187] docs(plugins): add capability cookbook --- docs/.i18n/glossary.zh-CN.json | 4 + docs/concepts/models.md | 2 + docs/gateway/configuration-reference.md | 5 ++ docs/tools/capability-cookbook.md | 112 ++++++++++++++++++++++++ docs/tools/plugin.md | 5 +- 5 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 docs/tools/capability-cookbook.md diff --git a/docs/.i18n/glossary.zh-CN.json b/docs/.i18n/glossary.zh-CN.json index 36e44b6d909..d1b1f3f3058 100644 --- a/docs/.i18n/glossary.zh-CN.json +++ b/docs/.i18n/glossary.zh-CN.json @@ -47,6 +47,10 @@ "source": "Quick Start", "target": "快速开始" }, + { + "source": "Capability Cookbook", + "target": "能力扩展手册" + }, { "source": "Setup Wizard Reference", "target": "设置向导参考" diff --git a/docs/concepts/models.md b/docs/concepts/models.md index f3b7797eedb..88cf928568e 100644 --- a/docs/concepts/models.md +++ b/docs/concepts/models.md @@ -26,6 +26,7 @@ Related: - `agents.defaults.models` is the allowlist/catalog of models OpenClaw can use (plus aliases). - `agents.defaults.imageModel` is used **only when** the primary model can’t accept images. +- `agents.defaults.imageGenerationModel` is used by the shared image-generation capability. - Per-agent defaults can override `agents.defaults.model` via `agents.list[].model` plus bindings (see [/concepts/multi-agent](/concepts/multi-agent)). ## Quick model policy @@ -49,6 +50,7 @@ subscription** (OAuth) and **Anthropic** (API key or `claude setup-token`). - `agents.defaults.model.primary` and `agents.defaults.model.fallbacks` - `agents.defaults.imageModel.primary` and `agents.defaults.imageModel.fallbacks` +- `agents.defaults.imageGenerationModel.primary` and `agents.defaults.imageGenerationModel.fallbacks` - `agents.defaults.models` (allowlist + aliases + provider params) - `models.providers` (custom providers written into `models.json`) diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index 235d4a18a7b..910b6db2b62 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -875,6 +875,9 @@ Time format in system prompt. Default: `auto` (OS preference). primary: "openrouter/qwen/qwen-2.5-vl-72b-instruct:free", fallbacks: ["openrouter/google/gemini-2.0-flash-vision:free"], }, + imageGenerationModel: { + primary: "openai/gpt-image-1", + }, pdfModel: { primary: "anthropic/claude-opus-4-6", fallbacks: ["openai/gpt-5-mini"], @@ -899,6 +902,8 @@ Time format in system prompt. Default: `auto` (OS preference). - `imageModel`: accepts either a string (`"provider/model"`) or an object (`{ primary, fallbacks }`). - Used by the `image` tool path as its vision-model config. - Also used as fallback routing when the selected/default model cannot accept image input. +- `imageGenerationModel`: accepts either a string (`"provider/model"`) or an object (`{ primary, fallbacks }`). + - Used by the shared image-generation capability and any future tool/plugin surface that generates images. - `pdfModel`: accepts either a string (`"provider/model"`) or an object (`{ primary, fallbacks }`). - Used by the `pdf` tool for model routing. - If omitted, the PDF tool falls back to `imageModel`, then to best-effort provider defaults. diff --git a/docs/tools/capability-cookbook.md b/docs/tools/capability-cookbook.md new file mode 100644 index 00000000000..345c7b1ebd6 --- /dev/null +++ b/docs/tools/capability-cookbook.md @@ -0,0 +1,112 @@ +--- +summary: "Cookbook for adding a new shared capability to OpenClaw" +read_when: + - Adding a new core capability and plugin seam + - Deciding whether code belongs in core, a vendor plugin, or a feature plugin + - Wiring a new runtime helper for channels or tools +title: "Capability Cookbook" +--- + +# Capability Cookbook + +Use this when OpenClaw needs a new domain such as image generation, video +generation, or some future vendor-backed feature area. + +The rule: + +- plugin = ownership boundary +- capability = shared core contract + +That means you should not start by wiring a vendor directly into a channel or a +tool. Start by defining the capability. + +## When to create a capability + +Create a new capability when all of these are true: + +1. more than one vendor could plausibly implement it +2. channels, tools, or feature plugins should consume it without caring about + the vendor +3. core needs to own fallback, policy, config, or delivery behavior + +If the work is vendor-only and no shared contract exists yet, stop and define +the contract first. + +## The standard sequence + +1. Define the typed core contract. +2. Add plugin registration for that contract. +3. Add a shared runtime helper. +4. Wire one real vendor plugin as proof. +5. Move feature/channel consumers onto the runtime helper. +6. Add contract tests. +7. Document the operator-facing config and ownership model. + +## What goes where + +Core: + +- request/response types +- provider registry + resolution +- fallback behavior +- config schema and labels/help +- runtime helper surface + +Vendor plugin: + +- vendor API calls +- vendor auth handling +- vendor-specific request normalization +- registration of the capability implementation + +Feature/channel plugin: + +- calls `api.runtime.*` or the matching `plugin-sdk/*-runtime` helper +- never calls a vendor implementation directly + +## File checklist + +For a new capability, expect to touch these areas: + +- `src//types.ts` +- `src//...registry/runtime.ts` +- `src/plugins/types.ts` +- `src/plugins/registry.ts` +- `src/plugins/captured-registration.ts` +- `src/plugins/contracts/registry.ts` +- `src/plugins/runtime/types-core.ts` +- `src/plugins/runtime/index.ts` +- `src/plugin-sdk/.ts` +- `src/plugin-sdk/-runtime.ts` +- one or more `extensions//...` +- config/docs/tests + +## Example: image generation + +Image generation follows the standard shape: + +1. core defines `ImageGenerationProvider` +2. core exposes `registerImageGenerationProvider(...)` +3. core exposes `runtime.imageGeneration.generate(...)` +4. the `openai` plugin registers an OpenAI-backed implementation +5. future vendors can register the same contract without changing channels/tools + +The config key is separate from vision-analysis routing: + +- `agents.defaults.imageModel` = analyze images +- `agents.defaults.imageGenerationModel` = generate images + +Keep those separate so fallback and policy remain explicit. + +## Review checklist + +Before shipping a new capability, verify: + +- no channel/tool imports vendor code directly +- the runtime helper is the shared path +- at least one contract test asserts bundled ownership +- config docs name the new model/config key +- plugin docs explain the ownership boundary + +If a PR skips the capability layer and hardcodes vendor behavior into a +channel/tool, send it back and define the contract first. diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index db074c011d9..77ff383feb6 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -113,7 +113,7 @@ That means: Examples: - the bundled `openai` plugin owns OpenAI model-provider behavior and OpenAI - speech + media-understanding behavior + speech + media-understanding + image-generation behavior - the bundled `elevenlabs` plugin owns ElevenLabs speech behavior - the bundled `microsoft` plugin owns Microsoft speech behavior - the bundled `google`, `minimax`, `mistral`, `moonshot`, and `zai` plugins own @@ -257,6 +257,9 @@ If OpenClaw adds a new domain later, such as video generation, use the same sequence again: define the core capability first, then let vendor plugins register implementations against it. +Need a concrete rollout checklist? See +[Capability Cookbook](/tools/capability-cookbook). + ## Compatible bundles OpenClaw also recognizes two compatible external bundle layouts: From aa2d5aaa0cd67169487cfc73805145411c56b58d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:56:14 -0700 Subject: [PATCH 068/187] feat(plugins): add image generation capability --- extensions/lobster/src/lobster-tool.test.ts | 1 + extensions/openai/index.ts | 2 + extensions/test-utils/plugin-api.ts | 1 + extensions/test-utils/plugin-runtime-mock.ts | 6 + package.json | 16 ++ scripts/lib/plugin-sdk-entrypoints.json | 4 + src/auto-reply/reply/route-reply.test.ts | 1 + .../channel-setup/plugin-install.test.ts | 1 + src/config/schema.help.ts | 4 + src/config/schema.labels.ts | 2 + src/config/types.agent-defaults.ts | 2 + src/config/zod-schema.agent-defaults.ts | 1 + src/gateway/server-plugins.test.ts | 1 + src/gateway/test-helpers.mocks.ts | 1 + src/image-generation/provider-registry.ts | 71 ++++++++ src/image-generation/providers/openai.test.ts | 55 ++++++ src/image-generation/providers/openai.ts | 79 +++++++++ src/image-generation/runtime.test.ts | 81 +++++++++ src/image-generation/runtime.ts | 162 ++++++++++++++++++ src/image-generation/types.ts | 33 ++++ src/media-understanding/runtime.ts | 34 ++++ src/plugin-sdk/image-generation-runtime.ts | 3 + src/plugin-sdk/image-generation.ts | 10 ++ src/plugin-sdk/index.ts | 1 + src/plugin-sdk/media-understanding-runtime.ts | 9 + src/plugin-sdk/speech-runtime.ts | 3 + src/plugins/captured-registration.ts | 7 + .../contracts/registry.contract.test.ts | 36 ++++ src/plugins/contracts/registry.ts | 13 ++ src/plugins/hooks.test-helpers.ts | 2 + src/plugins/loader.ts | 1 + src/plugins/registry.ts | 24 +++ src/plugins/runtime/index.test.ts | 7 + src/plugins/runtime/index.ts | 12 +- src/plugins/runtime/types-core.ts | 11 +- src/plugins/types.ts | 3 + src/test-utils/channel-plugins.ts | 1 + src/tts/runtime.ts | 4 + 38 files changed, 701 insertions(+), 4 deletions(-) create mode 100644 src/image-generation/provider-registry.ts create mode 100644 src/image-generation/providers/openai.test.ts create mode 100644 src/image-generation/providers/openai.ts create mode 100644 src/image-generation/runtime.test.ts create mode 100644 src/image-generation/runtime.ts create mode 100644 src/image-generation/types.ts create mode 100644 src/plugin-sdk/image-generation-runtime.ts create mode 100644 src/plugin-sdk/image-generation.ts create mode 100644 src/plugin-sdk/media-understanding-runtime.ts create mode 100644 src/plugin-sdk/speech-runtime.ts create mode 100644 src/tts/runtime.ts diff --git a/extensions/lobster/src/lobster-tool.test.ts b/extensions/lobster/src/lobster-tool.test.ts index cba95624f07..b154e067116 100644 --- a/extensions/lobster/src/lobster-tool.test.ts +++ b/extensions/lobster/src/lobster-tool.test.ts @@ -46,6 +46,7 @@ function fakeApi(overrides: Partial = {}): OpenClawPluginApi registerProvider() {}, registerSpeechProvider() {}, registerMediaUnderstandingProvider() {}, + registerImageGenerationProvider() {}, registerWebSearchProvider() {}, registerInteractiveHandler() {}, registerHook() {}, diff --git a/extensions/openai/index.ts b/extensions/openai/index.ts index d22b7275691..dd8bbdd615d 100644 --- a/extensions/openai/index.ts +++ b/extensions/openai/index.ts @@ -1,4 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { buildOpenAIImageGenerationProvider } from "openclaw/plugin-sdk/image-generation"; import { buildOpenAISpeechProvider } from "openclaw/plugin-sdk/speech"; import { openaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { buildOpenAICodexProviderPlugin } from "./openai-codex-provider.js"; @@ -14,6 +15,7 @@ const openAIPlugin = { api.registerProvider(buildOpenAICodexProviderPlugin()); api.registerSpeechProvider(buildOpenAISpeechProvider()); api.registerMediaUnderstandingProvider(openaiMediaUnderstandingProvider); + api.registerImageGenerationProvider(buildOpenAIImageGenerationProvider()); }, }; diff --git a/extensions/test-utils/plugin-api.ts b/extensions/test-utils/plugin-api.ts index 2080359d961..bb94c326ee8 100644 --- a/extensions/test-utils/plugin-api.ts +++ b/extensions/test-utils/plugin-api.ts @@ -17,6 +17,7 @@ export function createTestPluginApi(api: TestPluginApiInput): OpenClawPluginApi registerProvider() {}, registerSpeechProvider() {}, registerMediaUnderstandingProvider() {}, + registerImageGenerationProvider() {}, registerWebSearchProvider() {}, registerInteractiveHandler() {}, registerCommand() {}, diff --git a/extensions/test-utils/plugin-runtime-mock.ts b/extensions/test-utils/plugin-runtime-mock.ts index c9f2c44cf10..fbc9bcdc7fd 100644 --- a/extensions/test-utils/plugin-runtime-mock.ts +++ b/extensions/test-utils/plugin-runtime-mock.ts @@ -110,11 +110,17 @@ export function createPluginRuntimeMock(overrides: DeepPartial = runFile: vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["runFile"], describeImageFile: vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["describeImageFile"], + describeImageFileWithModel: + vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["describeImageFileWithModel"], describeVideoFile: vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["describeVideoFile"], transcribeAudioFile: vi.fn() as unknown as PluginRuntime["mediaUnderstanding"]["transcribeAudioFile"], }, + imageGeneration: { + generate: vi.fn() as unknown as PluginRuntime["imageGeneration"]["generate"], + listProviders: vi.fn() as unknown as PluginRuntime["imageGeneration"]["listProviders"], + }, webSearch: { listProviders: vi.fn() as unknown as PluginRuntime["webSearch"]["listProviders"], search: vi.fn() as unknown as PluginRuntime["webSearch"]["search"], diff --git a/package.json b/package.json index 002dff9d4e5..4bb825d0d7a 100644 --- a/package.json +++ b/package.json @@ -102,6 +102,10 @@ "types": "./dist/plugin-sdk/media-runtime.d.ts", "default": "./dist/plugin-sdk/media-runtime.js" }, + "./plugin-sdk/media-understanding-runtime": { + "types": "./dist/plugin-sdk/media-understanding-runtime.d.ts", + "default": "./dist/plugin-sdk/media-understanding-runtime.js" + }, "./plugin-sdk/conversation-runtime": { "types": "./dist/plugin-sdk/conversation-runtime.d.ts", "default": "./dist/plugin-sdk/conversation-runtime.js" @@ -114,6 +118,10 @@ "types": "./dist/plugin-sdk/agent-runtime.d.ts", "default": "./dist/plugin-sdk/agent-runtime.js" }, + "./plugin-sdk/speech-runtime": { + "types": "./dist/plugin-sdk/speech-runtime.d.ts", + "default": "./dist/plugin-sdk/speech-runtime.js" + }, "./plugin-sdk/plugin-runtime": { "types": "./dist/plugin-sdk/plugin-runtime.d.ts", "default": "./dist/plugin-sdk/plugin-runtime.js" @@ -378,6 +386,14 @@ "types": "./dist/plugin-sdk/provider-web-search.d.ts", "default": "./dist/plugin-sdk/provider-web-search.js" }, + "./plugin-sdk/image-generation": { + "types": "./dist/plugin-sdk/image-generation.d.ts", + "default": "./dist/plugin-sdk/image-generation.js" + }, + "./plugin-sdk/image-generation-runtime": { + "types": "./dist/plugin-sdk/image-generation-runtime.d.ts", + "default": "./dist/plugin-sdk/image-generation-runtime.js" + }, "./plugin-sdk/reply-history": { "types": "./dist/plugin-sdk/reply-history.d.ts", "default": "./dist/plugin-sdk/reply-history.js" diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index ce8b623577f..205982588fd 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -15,9 +15,11 @@ "channel-runtime", "infra-runtime", "media-runtime", + "media-understanding-runtime", "conversation-runtime", "text-runtime", "agent-runtime", + "speech-runtime", "plugin-runtime", "security-runtime", "gateway-runtime", @@ -84,6 +86,8 @@ "provider-stream", "provider-usage", "provider-web-search", + "image-generation", + "image-generation-runtime", "reply-history", "media-understanding", "google", diff --git a/src/auto-reply/reply/route-reply.test.ts b/src/auto-reply/reply/route-reply.test.ts index 4c5dd7be889..98fd1144f77 100644 --- a/src/auto-reply/reply/route-reply.test.ts +++ b/src/auto-reply/reply/route-reply.test.ts @@ -93,6 +93,7 @@ const createRegistry = (channels: PluginRegistry["channels"]): PluginRegistry => providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], gatewayHandlers: {}, httpRoutes: [], diff --git a/src/commands/channel-setup/plugin-install.test.ts b/src/commands/channel-setup/plugin-install.test.ts index 96ca60e2197..88c70bc26ef 100644 --- a/src/commands/channel-setup/plugin-install.test.ts +++ b/src/commands/channel-setup/plugin-install.test.ts @@ -339,6 +339,7 @@ describe("ensureChannelSetupPluginInstalled", () => { providerIds: [], speechProviderIds: [], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], webSearchProviderIds: [], gatewayMethods: [], cliCommands: [], diff --git a/src/config/schema.help.ts b/src/config/schema.help.ts index 1f4aa63ff62..779abbb609b 100644 --- a/src/config/schema.help.ts +++ b/src/config/schema.help.ts @@ -1019,6 +1019,10 @@ export const FIELD_HELP: Record = { "agents.defaults.imageModel.primary": "Optional image model (provider/model) used when the primary model lacks image input.", "agents.defaults.imageModel.fallbacks": "Ordered fallback image models (provider/model).", + "agents.defaults.imageGenerationModel.primary": + "Optional image-generation model (provider/model) used by the shared image generation capability.", + "agents.defaults.imageGenerationModel.fallbacks": + "Ordered fallback image-generation models (provider/model).", "agents.defaults.pdfModel.primary": "Optional PDF model (provider/model) for the PDF analysis tool. Defaults to imageModel, then session model.", "agents.defaults.pdfModel.fallbacks": "Ordered fallback PDF models (provider/model).", diff --git a/src/config/schema.labels.ts b/src/config/schema.labels.ts index c3e820a7d4b..62302e976af 100644 --- a/src/config/schema.labels.ts +++ b/src/config/schema.labels.ts @@ -454,6 +454,8 @@ export const FIELD_LABELS: Record = { "agents.defaults.model.fallbacks": "Model Fallbacks", "agents.defaults.imageModel.primary": "Image Model", "agents.defaults.imageModel.fallbacks": "Image Model Fallbacks", + "agents.defaults.imageGenerationModel.primary": "Image Generation Model", + "agents.defaults.imageGenerationModel.fallbacks": "Image Generation Model Fallbacks", "agents.defaults.pdfModel.primary": "PDF Model", "agents.defaults.pdfModel.fallbacks": "PDF Model Fallbacks", "agents.defaults.pdfMaxBytesMb": "PDF Max Size (MB)", diff --git a/src/config/types.agent-defaults.ts b/src/config/types.agent-defaults.ts index e5613c7649d..68506e8be3c 100644 --- a/src/config/types.agent-defaults.ts +++ b/src/config/types.agent-defaults.ts @@ -122,6 +122,8 @@ export type AgentDefaultsConfig = { model?: AgentModelConfig; /** Optional image-capable model and fallbacks (provider/model). Accepts string or {primary,fallbacks}. */ imageModel?: AgentModelConfig; + /** Optional image-generation model and fallbacks (provider/model). Accepts string or {primary,fallbacks}. */ + imageGenerationModel?: AgentModelConfig; /** Optional PDF-capable model and fallbacks (provider/model). Accepts string or {primary,fallbacks}. */ pdfModel?: AgentModelConfig; /** Maximum PDF file size in megabytes (default: 10). */ diff --git a/src/config/zod-schema.agent-defaults.ts b/src/config/zod-schema.agent-defaults.ts index b2cc5603c90..a631ae725b8 100644 --- a/src/config/zod-schema.agent-defaults.ts +++ b/src/config/zod-schema.agent-defaults.ts @@ -18,6 +18,7 @@ export const AgentDefaultsSchema = z .object({ model: AgentModelSchema.optional(), imageModel: AgentModelSchema.optional(), + imageGenerationModel: AgentModelSchema.optional(), pdfModel: AgentModelSchema.optional(), pdfMaxBytesMb: z.number().positive().optional(), pdfMaxPages: z.number().int().positive().optional(), diff --git a/src/gateway/server-plugins.test.ts b/src/gateway/server-plugins.test.ts index 184cb706762..ddaaa64c02b 100644 --- a/src/gateway/server-plugins.test.ts +++ b/src/gateway/server-plugins.test.ts @@ -31,6 +31,7 @@ const createRegistry = (diagnostics: PluginDiagnostic[]): PluginRegistry => ({ providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], gatewayHandlers: {}, httpRoutes: [], diff --git a/src/gateway/test-helpers.mocks.ts b/src/gateway/test-helpers.mocks.ts index 3617bc896bd..36d24537a14 100644 --- a/src/gateway/test-helpers.mocks.ts +++ b/src/gateway/test-helpers.mocks.ts @@ -148,6 +148,7 @@ const createStubPluginRegistry = (): PluginRegistry => ({ providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], gatewayHandlers: {}, httpRoutes: [], diff --git a/src/image-generation/provider-registry.ts b/src/image-generation/provider-registry.ts new file mode 100644 index 00000000000..500c7c9a34a --- /dev/null +++ b/src/image-generation/provider-registry.ts @@ -0,0 +1,71 @@ +import { normalizeProviderId } from "../agents/model-selection.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { loadOpenClawPlugins } from "../plugins/loader.js"; +import { getActivePluginRegistry } from "../plugins/runtime.js"; +import type { ImageGenerationProviderPlugin } from "../plugins/types.js"; + +const BUILTIN_IMAGE_GENERATION_PROVIDERS: readonly ImageGenerationProviderPlugin[] = []; + +function normalizeImageGenerationProviderId(id: string | undefined): string | undefined { + const normalized = normalizeProviderId(id ?? ""); + return normalized || undefined; +} + +function resolvePluginImageGenerationProviders( + cfg?: OpenClawConfig, +): ImageGenerationProviderPlugin[] { + const active = getActivePluginRegistry(); + const registry = + (active?.imageGenerationProviders?.length ?? 0) > 0 || !cfg + ? active + : loadOpenClawPlugins({ config: cfg }); + return registry?.imageGenerationProviders?.map((entry) => entry.provider) ?? []; +} + +function buildProviderMaps(cfg?: OpenClawConfig): { + canonical: Map; + aliases: Map; +} { + const canonical = new Map(); + const aliases = new Map(); + const register = (provider: ImageGenerationProviderPlugin) => { + const id = normalizeImageGenerationProviderId(provider.id); + if (!id) { + return; + } + canonical.set(id, provider); + aliases.set(id, provider); + for (const alias of provider.aliases ?? []) { + const normalizedAlias = normalizeImageGenerationProviderId(alias); + if (normalizedAlias) { + aliases.set(normalizedAlias, provider); + } + } + }; + + for (const provider of BUILTIN_IMAGE_GENERATION_PROVIDERS) { + register(provider); + } + for (const provider of resolvePluginImageGenerationProviders(cfg)) { + register(provider); + } + + return { canonical, aliases }; +} + +export function listImageGenerationProviders( + cfg?: OpenClawConfig, +): ImageGenerationProviderPlugin[] { + return [...buildProviderMaps(cfg).canonical.values()]; +} + +export function getImageGenerationProvider( + providerId: string | undefined, + cfg?: OpenClawConfig, +): ImageGenerationProviderPlugin | undefined { + const normalized = normalizeImageGenerationProviderId(providerId); + if (!normalized) { + return undefined; + } + return buildProviderMaps(cfg).aliases.get(normalized); +} diff --git a/src/image-generation/providers/openai.test.ts b/src/image-generation/providers/openai.test.ts new file mode 100644 index 00000000000..a55e6107d3b --- /dev/null +++ b/src/image-generation/providers/openai.test.ts @@ -0,0 +1,55 @@ +import { afterEach, describe, expect, it, vi } from "vitest"; +import * as modelAuth from "../../agents/model-auth.js"; +import { buildOpenAIImageGenerationProvider } from "./openai.js"; + +describe("OpenAI image-generation provider", () => { + afterEach(() => { + vi.restoreAllMocks(); + }); + + it("generates PNG buffers from the OpenAI Images API", async () => { + vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ + apiKey: "sk-test", + source: "env", + mode: "api-key", + }); + const fetchMock = vi.fn().mockResolvedValue({ + ok: true, + json: async () => ({ + data: [ + { + b64_json: Buffer.from("png-data").toString("base64"), + revised_prompt: "revised", + }, + ], + }), + }); + vi.stubGlobal("fetch", fetchMock); + + const provider = buildOpenAIImageGenerationProvider(); + const result = await provider.generateImage({ + provider: "openai", + model: "gpt-image-1", + prompt: "draw a cat", + cfg: {}, + }); + + expect(fetchMock).toHaveBeenCalledWith( + "https://api.openai.com/v1/images/generations", + expect.objectContaining({ + method: "POST", + }), + ); + expect(result).toEqual({ + images: [ + { + buffer: Buffer.from("png-data"), + mimeType: "image/png", + fileName: "image-1.png", + revisedPrompt: "revised", + }, + ], + model: "gpt-image-1", + }); + }); +}); diff --git a/src/image-generation/providers/openai.ts b/src/image-generation/providers/openai.ts new file mode 100644 index 00000000000..0c7788fb5d5 --- /dev/null +++ b/src/image-generation/providers/openai.ts @@ -0,0 +1,79 @@ +import { resolveApiKeyForProvider } from "../../agents/model-auth.js"; +import type { ImageGenerationProviderPlugin } from "../../plugins/types.js"; + +const DEFAULT_OPENAI_IMAGE_BASE_URL = "https://api.openai.com/v1"; +const DEFAULT_OPENAI_IMAGE_MODEL = "gpt-image-1"; +const DEFAULT_OUTPUT_MIME = "image/png"; +const DEFAULT_SIZE = "1024x1024"; + +type OpenAIImageApiResponse = { + data?: Array<{ + b64_json?: string; + revised_prompt?: string; + }>; +}; + +function resolveOpenAIBaseUrl(cfg: Parameters[0]["cfg"]): string { + const direct = cfg?.models?.providers?.openai?.baseUrl?.trim(); + return direct || DEFAULT_OPENAI_IMAGE_BASE_URL; +} + +export function buildOpenAIImageGenerationProvider(): ImageGenerationProviderPlugin { + return { + id: "openai", + label: "OpenAI", + supportedSizes: ["1024x1024", "1024x1536", "1536x1024"], + async generateImage(req) { + const auth = await resolveApiKeyForProvider({ + provider: "openai", + cfg: req.cfg, + agentDir: req.agentDir, + }); + if (!auth.apiKey) { + throw new Error("OpenAI API key missing"); + } + + const response = await fetch(`${resolveOpenAIBaseUrl(req.cfg)}/images/generations`, { + method: "POST", + headers: { + Authorization: `Bearer ${auth.apiKey}`, + "Content-Type": "application/json", + }, + body: JSON.stringify({ + model: req.model || DEFAULT_OPENAI_IMAGE_MODEL, + prompt: req.prompt, + n: req.count ?? 1, + size: req.size ?? DEFAULT_SIZE, + response_format: "b64_json", + }), + }); + + if (!response.ok) { + const text = await response.text().catch(() => ""); + throw new Error( + `OpenAI image generation failed (${response.status}): ${text || response.statusText}`, + ); + } + + const data = (await response.json()) as OpenAIImageApiResponse; + const images = (data.data ?? []) + .map((entry, index) => { + if (!entry.b64_json) { + return null; + } + return { + buffer: Buffer.from(entry.b64_json, "base64"), + mimeType: DEFAULT_OUTPUT_MIME, + fileName: `image-${index + 1}.png`, + ...(entry.revised_prompt ? { revisedPrompt: entry.revised_prompt } : {}), + }; + }) + .filter((entry): entry is NonNullable => entry !== null); + + return { + images, + model: req.model || DEFAULT_OPENAI_IMAGE_MODEL, + }; + }, + }; +} diff --git a/src/image-generation/runtime.test.ts b/src/image-generation/runtime.test.ts new file mode 100644 index 00000000000..4ef478b3349 --- /dev/null +++ b/src/image-generation/runtime.test.ts @@ -0,0 +1,81 @@ +import { afterEach, describe, expect, it } from "vitest"; +import type { OpenClawConfig } from "../config/config.js"; +import { createEmptyPluginRegistry } from "../plugins/registry.js"; +import { setActivePluginRegistry } from "../plugins/runtime.js"; +import { generateImage, listRuntimeImageGenerationProviders } from "./runtime.js"; + +describe("image-generation runtime helpers", () => { + afterEach(() => { + setActivePluginRegistry(createEmptyPluginRegistry()); + }); + + it("generates images through the active image-generation registry", async () => { + const pluginRegistry = createEmptyPluginRegistry(); + pluginRegistry.imageGenerationProviders.push({ + pluginId: "image-plugin", + pluginName: "Image Plugin", + source: "test", + provider: { + id: "image-plugin", + async generateImage() { + return { + images: [ + { + buffer: Buffer.from("png-bytes"), + mimeType: "image/png", + fileName: "sample.png", + }, + ], + model: "img-v1", + }; + }, + }, + }); + setActivePluginRegistry(pluginRegistry); + + const cfg = { + agents: { + defaults: { + imageGenerationModel: { + primary: "image-plugin/img-v1", + }, + }, + }, + } as OpenClawConfig; + + const result = await generateImage({ + cfg, + prompt: "draw a cat", + agentDir: "/tmp/agent", + }); + + expect(result.provider).toBe("image-plugin"); + expect(result.model).toBe("img-v1"); + expect(result.attempts).toEqual([]); + expect(result.images).toEqual([ + { + buffer: Buffer.from("png-bytes"), + mimeType: "image/png", + fileName: "sample.png", + }, + ]); + }); + + it("lists runtime image-generation providers from the active registry", () => { + const pluginRegistry = createEmptyPluginRegistry(); + pluginRegistry.imageGenerationProviders.push({ + pluginId: "image-plugin", + pluginName: "Image Plugin", + source: "test", + provider: { + id: "image-plugin", + generateImage: async () => ({ + images: [{ buffer: Buffer.from("x"), mimeType: "image/png" }], + }), + }, + }); + setActivePluginRegistry(pluginRegistry); + + expect(listRuntimeImageGenerationProviders()).toMatchObject([{ id: "image-plugin" }]); + }); +}); diff --git a/src/image-generation/runtime.ts b/src/image-generation/runtime.ts new file mode 100644 index 00000000000..8c9104edd5d --- /dev/null +++ b/src/image-generation/runtime.ts @@ -0,0 +1,162 @@ +import { describeFailoverError, isFailoverError } from "../agents/failover-error.js"; +import type { FallbackAttempt } from "../agents/model-fallback.types.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { + resolveAgentModelFallbackValues, + resolveAgentModelPrimaryValue, +} from "../config/model-input.js"; +import { createSubsystemLogger } from "../logging/subsystem.js"; +import { getImageGenerationProvider, listImageGenerationProviders } from "./provider-registry.js"; +import type { GeneratedImageAsset, ImageGenerationResult } from "./types.js"; + +const log = createSubsystemLogger("image-generation"); + +export type GenerateImageParams = { + cfg: OpenClawConfig; + prompt: string; + agentDir?: string; + modelOverride?: string; + count?: number; + size?: string; +}; + +export type GenerateImageRuntimeResult = { + images: GeneratedImageAsset[]; + provider: string; + model: string; + attempts: FallbackAttempt[]; + metadata?: Record; +}; + +function parseModelRef(raw: string | undefined): { provider: string; model: string } | null { + const trimmed = raw?.trim(); + if (!trimmed) { + return null; + } + const slashIndex = trimmed.indexOf("/"); + if (slashIndex <= 0 || slashIndex === trimmed.length - 1) { + return null; + } + return { + provider: trimmed.slice(0, slashIndex).trim(), + model: trimmed.slice(slashIndex + 1).trim(), + }; +} + +function resolveImageGenerationCandidates(params: { + cfg: OpenClawConfig; + modelOverride?: string; +}): Array<{ provider: string; model: string }> { + const candidates: Array<{ provider: string; model: string }> = []; + const seen = new Set(); + const add = (raw: string | undefined) => { + const parsed = parseModelRef(raw); + if (!parsed) { + return; + } + const key = `${parsed.provider}/${parsed.model}`; + if (seen.has(key)) { + return; + } + seen.add(key); + candidates.push(parsed); + }; + + add(params.modelOverride); + add(resolveAgentModelPrimaryValue(params.cfg.agents?.defaults?.imageGenerationModel)); + for (const fallback of resolveAgentModelFallbackValues( + params.cfg.agents?.defaults?.imageGenerationModel, + )) { + add(fallback); + } + return candidates; +} + +function throwImageGenerationFailure(params: { + attempts: FallbackAttempt[]; + lastError: unknown; +}): never { + if (params.attempts.length <= 1 && params.lastError) { + throw params.lastError; + } + const summary = + params.attempts.length > 0 + ? params.attempts + .map((attempt) => `${attempt.provider}/${attempt.model}: ${attempt.error}`) + .join(" | ") + : "unknown"; + throw new Error(`All image generation models failed (${params.attempts.length}): ${summary}`, { + cause: params.lastError instanceof Error ? params.lastError : undefined, + }); +} + +export function listRuntimeImageGenerationProviders(params?: { config?: OpenClawConfig }) { + return listImageGenerationProviders(params?.config); +} + +export async function generateImage( + params: GenerateImageParams, +): Promise { + const candidates = resolveImageGenerationCandidates({ + cfg: params.cfg, + modelOverride: params.modelOverride, + }); + if (candidates.length === 0) { + throw new Error( + "No image-generation model configured. Set agents.defaults.imageGenerationModel.primary or agents.defaults.imageGenerationModel.fallbacks.", + ); + } + + const attempts: FallbackAttempt[] = []; + let lastError: unknown; + + for (const candidate of candidates) { + const provider = getImageGenerationProvider(candidate.provider, params.cfg); + if (!provider) { + const error = `No image-generation provider registered for ${candidate.provider}`; + attempts.push({ + provider: candidate.provider, + model: candidate.model, + error, + }); + lastError = new Error(error); + continue; + } + + try { + const result: ImageGenerationResult = await provider.generateImage({ + provider: candidate.provider, + model: candidate.model, + prompt: params.prompt, + cfg: params.cfg, + agentDir: params.agentDir, + count: params.count, + size: params.size, + }); + if (!Array.isArray(result.images) || result.images.length === 0) { + throw new Error("Image generation provider returned no images."); + } + return { + images: result.images, + provider: candidate.provider, + model: result.model ?? candidate.model, + attempts, + metadata: result.metadata, + }; + } catch (err) { + lastError = err; + const described = isFailoverError(err) ? describeFailoverError(err) : undefined; + attempts.push({ + provider: candidate.provider, + model: candidate.model, + error: described?.message ?? (err instanceof Error ? err.message : String(err)), + reason: described?.reason, + status: described?.status, + code: described?.code, + }); + log.debug(`image-generation candidate failed: ${candidate.provider}/${candidate.model}`); + } + } + + throwImageGenerationFailure({ attempts, lastError }); +} diff --git a/src/image-generation/types.ts b/src/image-generation/types.ts new file mode 100644 index 00000000000..ff33d6079ee --- /dev/null +++ b/src/image-generation/types.ts @@ -0,0 +1,33 @@ +import type { OpenClawConfig } from "../config/config.js"; + +export type GeneratedImageAsset = { + buffer: Buffer; + mimeType: string; + fileName?: string; + revisedPrompt?: string; + metadata?: Record; +}; + +export type ImageGenerationRequest = { + provider: string; + model: string; + prompt: string; + cfg: OpenClawConfig; + agentDir?: string; + count?: number; + size?: string; +}; + +export type ImageGenerationResult = { + images: GeneratedImageAsset[]; + model?: string; + metadata?: Record; +}; + +export type ImageGenerationProvider = { + id: string; + aliases?: string[]; + label?: string; + supportedSizes?: string[]; + generateImage: (req: ImageGenerationRequest) => Promise; +}; diff --git a/src/media-understanding/runtime.ts b/src/media-understanding/runtime.ts index 043baf81f91..74f125135dd 100644 --- a/src/media-understanding/runtime.ts +++ b/src/media-understanding/runtime.ts @@ -1,6 +1,8 @@ +import fs from "node:fs/promises"; import path from "node:path"; import type { MsgContext } from "../auto-reply/templating.js"; import type { OpenClawConfig } from "../config/config.js"; +import { getMediaUnderstandingProvider } from "./providers/index.js"; import { buildProviderRegistry, createMediaAttachmentCache, @@ -90,6 +92,38 @@ export async function describeImageFile(params: { return await runMediaUnderstandingFile({ ...params, capability: "image" }); } +export async function describeImageFileWithModel(params: { + filePath: string; + cfg: OpenClawConfig; + agentDir?: string; + mime?: string; + provider: string; + model: string; + prompt: string; + maxTokens?: number; + timeoutMs?: number; +}) { + const timeoutMs = params.timeoutMs ?? 30_000; + const providerRegistry = buildProviderRegistry(undefined, params.cfg); + const provider = getMediaUnderstandingProvider(params.provider, providerRegistry); + if (!provider?.describeImage) { + throw new Error(`Provider does not support image analysis: ${params.provider}`); + } + const buffer = await fs.readFile(params.filePath); + return await provider.describeImage({ + buffer, + fileName: path.basename(params.filePath), + mime: params.mime, + provider: params.provider, + model: params.model, + prompt: params.prompt, + maxTokens: params.maxTokens, + timeoutMs, + cfg: params.cfg, + agentDir: params.agentDir ?? "", + }); +} + export async function describeVideoFile(params: { filePath: string; cfg: OpenClawConfig; diff --git a/src/plugin-sdk/image-generation-runtime.ts b/src/plugin-sdk/image-generation-runtime.ts new file mode 100644 index 00000000000..54f91d0d558 --- /dev/null +++ b/src/plugin-sdk/image-generation-runtime.ts @@ -0,0 +1,3 @@ +// Public runtime-facing image-generation helpers for feature/channel plugins. + +export { generateImage, listRuntimeImageGenerationProviders } from "../image-generation/runtime.js"; diff --git a/src/plugin-sdk/image-generation.ts b/src/plugin-sdk/image-generation.ts new file mode 100644 index 00000000000..9ca98074743 --- /dev/null +++ b/src/plugin-sdk/image-generation.ts @@ -0,0 +1,10 @@ +// Public image-generation helpers and types for provider plugins. + +export type { + GeneratedImageAsset, + ImageGenerationProvider, + ImageGenerationRequest, + ImageGenerationResult, +} from "../image-generation/types.js"; + +export { buildOpenAIImageGenerationProvider } from "../image-generation/providers/openai.js"; diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index 20af3448e8f..1f9198d4e7f 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -40,6 +40,7 @@ export type { export type { OpenClawConfig } from "../config/config.js"; /** @deprecated Use OpenClawConfig instead */ export type { OpenClawConfig as ClawdbotConfig } from "../config/config.js"; +export * from "./image-generation.js"; export type { SecretInput, SecretRef } from "../config/types.secrets.js"; export type { RuntimeEnv } from "../runtime.js"; export type { HookEntry } from "../hooks/types.js"; diff --git a/src/plugin-sdk/media-understanding-runtime.ts b/src/plugin-sdk/media-understanding-runtime.ts new file mode 100644 index 00000000000..5a4c6cdff65 --- /dev/null +++ b/src/plugin-sdk/media-understanding-runtime.ts @@ -0,0 +1,9 @@ +// Public runtime-facing media-understanding helpers for feature/channel plugins. + +export { + describeImageFile, + describeImageFileWithModel, + describeVideoFile, + runMediaUnderstandingFile, + transcribeAudioFile, +} from "../media-understanding/runtime.js"; diff --git a/src/plugin-sdk/speech-runtime.ts b/src/plugin-sdk/speech-runtime.ts new file mode 100644 index 00000000000..afe192c4f53 --- /dev/null +++ b/src/plugin-sdk/speech-runtime.ts @@ -0,0 +1,3 @@ +// Public runtime-facing speech helpers for feature/channel plugins. + +export { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "../tts/runtime.js"; diff --git a/src/plugins/captured-registration.ts b/src/plugins/captured-registration.ts index dd5ba78a9c4..fd2c359b463 100644 --- a/src/plugins/captured-registration.ts +++ b/src/plugins/captured-registration.ts @@ -1,5 +1,6 @@ import type { AnyAgentTool, + ImageGenerationProviderPlugin, MediaUnderstandingProviderPlugin, OpenClawPluginApi, ProviderPlugin, @@ -12,6 +13,7 @@ export type CapturedPluginRegistration = { providers: ProviderPlugin[]; speechProviders: SpeechProviderPlugin[]; mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[]; + imageGenerationProviders: ImageGenerationProviderPlugin[]; webSearchProviders: WebSearchProviderPlugin[]; tools: AnyAgentTool[]; }; @@ -20,6 +22,7 @@ export function createCapturedPluginRegistration(): CapturedPluginRegistration { const providers: ProviderPlugin[] = []; const speechProviders: SpeechProviderPlugin[] = []; const mediaUnderstandingProviders: MediaUnderstandingProviderPlugin[] = []; + const imageGenerationProviders: ImageGenerationProviderPlugin[] = []; const webSearchProviders: WebSearchProviderPlugin[] = []; const tools: AnyAgentTool[] = []; @@ -27,6 +30,7 @@ export function createCapturedPluginRegistration(): CapturedPluginRegistration { providers, speechProviders, mediaUnderstandingProviders, + imageGenerationProviders, webSearchProviders, tools, api: { @@ -39,6 +43,9 @@ export function createCapturedPluginRegistration(): CapturedPluginRegistration { registerMediaUnderstandingProvider(provider: MediaUnderstandingProviderPlugin) { mediaUnderstandingProviders.push(provider); }, + registerImageGenerationProvider(provider: ImageGenerationProviderPlugin) { + imageGenerationProviders.push(provider); + }, registerWebSearchProvider(provider: WebSearchProviderPlugin) { webSearchProviders.push(provider); }, diff --git a/src/plugins/contracts/registry.contract.test.ts b/src/plugins/contracts/registry.contract.test.ts index f7b89c2296e..762612cc45a 100644 --- a/src/plugins/contracts/registry.contract.test.ts +++ b/src/plugins/contracts/registry.contract.test.ts @@ -2,6 +2,7 @@ import { describe, expect, it } from "vitest"; import { loadPluginManifestRegistry } from "../manifest-registry.js"; import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; import { + imageGenerationProviderContractRegistry, mediaUnderstandingProviderContractRegistry, pluginRegistrationContractRegistry, providerContractPluginIds, @@ -56,6 +57,23 @@ function findMediaUnderstandingProviderForPlugin(pluginId: string) { return entry.provider; } +function findImageGenerationProviderIdsForPlugin(pluginId: string) { + return imageGenerationProviderContractRegistry + .filter((entry) => entry.pluginId === pluginId) + .map((entry) => entry.provider.id) + .toSorted((left, right) => left.localeCompare(right)); +} + +function findImageGenerationProviderForPlugin(pluginId: string) { + const entry = imageGenerationProviderContractRegistry.find( + (candidate) => candidate.pluginId === pluginId, + ); + if (!entry) { + throw new Error(`image-generation provider contract missing for ${pluginId}`); + } + return entry.provider; +} + function findRegistrationForPlugin(pluginId: string) { const entry = pluginRegistrationContractRegistry.find( (candidate) => candidate.pluginId === pluginId, @@ -108,6 +126,10 @@ describe("plugin contract registry", () => { ).toEqual(bundledWebSearchPluginIds); }); + it("does not duplicate bundled image-generation provider ids", () => { + const ids = imageGenerationProviderContractRegistry.map((entry) => entry.provider.id); + expect(ids).toEqual([...new Set(ids)]); + }); it("keeps multi-provider plugin ownership explicit", () => { expect(findProviderIdsForPlugin("google")).toEqual(["google", "google-gemini-cli"]); expect(findProviderIdsForPlugin("minimax")).toEqual(["minimax", "minimax-portal"]); @@ -142,11 +164,16 @@ describe("plugin contract registry", () => { expect(findMediaUnderstandingProviderIdsForPlugin("zai")).toEqual(["zai"]); }); + it("keeps bundled image-generation ownership explicit", () => { + expect(findImageGenerationProviderIdsForPlugin("openai")).toEqual(["openai"]); + }); + it("keeps bundled provider and web search tool ownership explicit", () => { expect(findRegistrationForPlugin("firecrawl")).toMatchObject({ providerIds: [], speechProviderIds: [], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], webSearchProviderIds: ["firecrawl"], toolNames: ["firecrawl_search", "firecrawl_scrape"], }); @@ -157,16 +184,19 @@ describe("plugin contract registry", () => { providerIds: ["openai", "openai-codex"], speechProviderIds: ["openai"], mediaUnderstandingProviderIds: ["openai"], + imageGenerationProviderIds: ["openai"], }); expect(findRegistrationForPlugin("elevenlabs")).toMatchObject({ providerIds: [], speechProviderIds: ["elevenlabs"], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], }); expect(findRegistrationForPlugin("microsoft")).toMatchObject({ providerIds: [], speechProviderIds: ["microsoft"], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], }); }); @@ -213,4 +243,10 @@ describe("plugin contract registry", () => { expect.any(Function), ); }); + + it("keeps bundled image-generation support explicit", () => { + expect(findImageGenerationProviderForPlugin("openai").generateImage).toEqual( + expect.any(Function), + ); + }); }); diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index 8ab7422c1e2..a4d2f815d7b 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -37,6 +37,7 @@ import xiaomiPlugin from "../../../extensions/xiaomi/index.js"; import zaiPlugin from "../../../extensions/zai/index.js"; import { createCapturedPluginRegistration } from "../captured-registration.js"; import type { + ImageGenerationProviderPlugin, MediaUnderstandingProviderPlugin, ProviderPlugin, SpeechProviderPlugin, @@ -62,12 +63,14 @@ type WebSearchProviderContractEntry = CapabilityContractEntry; type MediaUnderstandingProviderContractEntry = CapabilityContractEntry; +type ImageGenerationProviderContractEntry = CapabilityContractEntry; type PluginRegistrationContractEntry = { pluginId: string; providerIds: string[]; speechProviderIds: string[]; mediaUnderstandingProviderIds: string[]; + imageGenerationProviderIds: string[]; webSearchProviderIds: string[]; toolNames: string[]; }; @@ -128,6 +131,8 @@ const bundledMediaUnderstandingPlugins: RegistrablePlugin[] = [ zaiPlugin, ]; +const bundledImageGenerationPlugins: RegistrablePlugin[] = [openAIPlugin]; + function captureRegistrations(plugin: RegistrablePlugin) { const captured = createCapturedPluginRegistration(); plugin.register(captured.api); @@ -207,12 +212,19 @@ export const mediaUnderstandingProviderContractRegistry: MediaUnderstandingProvi select: (captured) => captured.mediaUnderstandingProviders, }); +export const imageGenerationProviderContractRegistry: ImageGenerationProviderContractEntry[] = + buildCapabilityContractRegistry({ + plugins: bundledImageGenerationPlugins, + select: (captured) => captured.imageGenerationProviders, + }); + const bundledPluginRegistrationList = [ ...new Map( [ ...bundledProviderPlugins, ...bundledSpeechPlugins, ...bundledMediaUnderstandingPlugins, + ...bundledImageGenerationPlugins, ...bundledWebSearchPlugins, ].map((plugin) => [plugin.id, plugin]), ).values(), @@ -228,6 +240,7 @@ export const pluginRegistrationContractRegistry: PluginRegistrationContractEntry mediaUnderstandingProviderIds: captured.mediaUnderstandingProviders.map( (provider) => provider.id, ), + imageGenerationProviderIds: captured.imageGenerationProviders.map((provider) => provider.id), webSearchProviderIds: captured.webSearchProviders.map((provider) => provider.id), toolNames: captured.tools.map((tool) => tool.name), }; diff --git a/src/plugins/hooks.test-helpers.ts b/src/plugins/hooks.test-helpers.ts index ea01163d4b0..559f70a1dc7 100644 --- a/src/plugins/hooks.test-helpers.ts +++ b/src/plugins/hooks.test-helpers.ts @@ -19,6 +19,7 @@ export function createMockPluginRegistry( providerIds: [], speechProviderIds: [], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], webSearchProviderIds: [], gatewayMethods: [], cliCommands: [], @@ -43,6 +44,7 @@ export function createMockPluginRegistry( providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], httpRoutes: [], gatewayHandlers: {}, diff --git a/src/plugins/loader.ts b/src/plugins/loader.ts index 86273793006..8d064d477c3 100644 --- a/src/plugins/loader.ts +++ b/src/plugins/loader.ts @@ -497,6 +497,7 @@ function createPluginRecord(params: { providerIds: [], speechProviderIds: [], mediaUnderstandingProviderIds: [], + imageGenerationProviderIds: [], webSearchProviderIds: [], gatewayMethods: [], cliCommands: [], diff --git a/src/plugins/registry.ts b/src/plugins/registry.ts index c81c2253e0a..ca4e40ee54c 100644 --- a/src/plugins/registry.ts +++ b/src/plugins/registry.ts @@ -22,6 +22,7 @@ import { stripPromptMutationFieldsFromLegacyHookResult, } from "./types.js"; import type { + ImageGenerationProviderPlugin, OpenClawPluginApi, OpenClawPluginChannelRegistration, OpenClawPluginCliRegistrar, @@ -116,6 +117,8 @@ export type PluginSpeechProviderRegistration = PluginOwnedProviderRegistration; export type PluginMediaUnderstandingProviderRegistration = PluginOwnedProviderRegistration; +export type PluginImageGenerationProviderRegistration = + PluginOwnedProviderRegistration; export type PluginWebSearchProviderRegistration = PluginOwnedProviderRegistration; @@ -165,6 +168,7 @@ export type PluginRecord = { providerIds: string[]; speechProviderIds: string[]; mediaUnderstandingProviderIds: string[]; + imageGenerationProviderIds: string[]; webSearchProviderIds: string[]; gatewayMethods: string[]; cliCommands: string[]; @@ -187,6 +191,7 @@ export type PluginRegistry = { providers: PluginProviderRegistration[]; speechProviders: PluginSpeechProviderRegistration[]; mediaUnderstandingProviders: PluginMediaUnderstandingProviderRegistration[]; + imageGenerationProviders: PluginImageGenerationProviderRegistration[]; webSearchProviders: PluginWebSearchProviderRegistration[]; gatewayHandlers: GatewayRequestHandlers; httpRoutes: PluginHttpRouteRegistration[]; @@ -234,6 +239,7 @@ export function createEmptyPluginRegistry(): PluginRegistry { providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], gatewayHandlers: {}, httpRoutes: [], @@ -631,6 +637,19 @@ export function createPluginRegistry(registryParams: PluginRegistryParams) { }); }; + const registerImageGenerationProvider = ( + record: PluginRecord, + provider: ImageGenerationProviderPlugin, + ) => { + registerUniqueProviderLike({ + record, + provider, + kindLabel: "image-generation provider", + registrations: registry.imageGenerationProviders, + ownedIds: record.imageGenerationProviderIds, + }); + }; + const registerWebSearchProvider = (record: PluginRecord, provider: WebSearchProviderPlugin) => { registerUniqueProviderLike({ record, @@ -857,6 +876,10 @@ export function createPluginRegistry(registryParams: PluginRegistryParams) { registrationMode === "full" ? (provider) => registerMediaUnderstandingProvider(record, provider) : () => {}, + registerImageGenerationProvider: + registrationMode === "full" + ? (provider) => registerImageGenerationProvider(record, provider) + : () => {}, registerWebSearchProvider: registrationMode === "full" ? (provider) => registerWebSearchProvider(record, provider) @@ -932,6 +955,7 @@ export function createPluginRegistry(registryParams: PluginRegistryParams) { registerProvider, registerSpeechProvider, registerMediaUnderstandingProvider, + registerImageGenerationProvider, registerWebSearchProvider, registerGatewayMethod, registerCli, diff --git a/src/plugins/runtime/index.test.ts b/src/plugins/runtime/index.test.ts index 2022ac07d37..5ffbd60aa2e 100644 --- a/src/plugins/runtime/index.test.ts +++ b/src/plugins/runtime/index.test.ts @@ -59,10 +59,17 @@ describe("plugin runtime command execution", () => { const runtime = createPluginRuntime(); expect(typeof runtime.mediaUnderstanding.runFile).toBe("function"); expect(typeof runtime.mediaUnderstanding.describeImageFile).toBe("function"); + expect(typeof runtime.mediaUnderstanding.describeImageFileWithModel).toBe("function"); expect(typeof runtime.mediaUnderstanding.describeVideoFile).toBe("function"); expect(runtime.mediaUnderstanding.transcribeAudioFile).toBe(runtime.stt.transcribeAudioFile); }); + it("exposes runtime.imageGeneration helpers", () => { + const runtime = createPluginRuntime(); + expect(typeof runtime.imageGeneration.generate).toBe("function"); + expect(typeof runtime.imageGeneration.listProviders).toBe("function"); + }); + it("exposes runtime.webSearch helpers", () => { const runtime = createPluginRuntime(); expect(typeof runtime.webSearch.listProviders).toBe("function"); diff --git a/src/plugins/runtime/index.ts b/src/plugins/runtime/index.ts index cd76a21916b..3f5b80d1caa 100644 --- a/src/plugins/runtime/index.ts +++ b/src/plugins/runtime/index.ts @@ -4,13 +4,18 @@ import { resolveApiKeyForProvider as resolveApiKeyForProviderRaw, } from "../../agents/model-auth.js"; import { resolveStateDir } from "../../config/paths.js"; +import { + generateImage, + listRuntimeImageGenerationProviders, +} from "../../image-generation/runtime.js"; import { describeImageFile, + describeImageFileWithModel, describeVideoFile, runMediaUnderstandingFile, transcribeAudioFile, } from "../../media-understanding/runtime.js"; -import { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "../../tts/tts.js"; +import { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "../../tts/runtime.js"; import { listWebSearchProviders, runWebSearch } from "../../web-search/runtime.js"; import { createRuntimeAgent } from "./runtime-agent.js"; import { createRuntimeChannel } from "./runtime-channel.js"; @@ -145,9 +150,14 @@ export function createPluginRuntime(_options: CreatePluginRuntimeOptions = {}): mediaUnderstanding: { runFile: runMediaUnderstandingFile, describeImageFile, + describeImageFileWithModel, describeVideoFile, transcribeAudioFile, }, + imageGeneration: { + generate: generateImage, + listProviders: listRuntimeImageGenerationProviders, + }, webSearch: { listProviders: listWebSearchProviders, search: runWebSearch, diff --git a/src/plugins/runtime/types-core.ts b/src/plugins/runtime/types-core.ts index 528c488d987..e5951a1ce57 100644 --- a/src/plugins/runtime/types-core.ts +++ b/src/plugins/runtime/types-core.ts @@ -47,16 +47,21 @@ export type PluginRuntimeCore = { resizeToJpeg: typeof import("../../media/image-ops.js").resizeToJpeg; }; tts: { - textToSpeech: typeof import("../../tts/tts.js").textToSpeech; - textToSpeechTelephony: typeof import("../../tts/tts.js").textToSpeechTelephony; - listVoices: typeof import("../../tts/tts.js").listSpeechVoices; + textToSpeech: typeof import("../../tts/runtime.js").textToSpeech; + textToSpeechTelephony: typeof import("../../tts/runtime.js").textToSpeechTelephony; + listVoices: typeof import("../../tts/runtime.js").listSpeechVoices; }; mediaUnderstanding: { runFile: typeof import("../../media-understanding/runtime.js").runMediaUnderstandingFile; describeImageFile: typeof import("../../media-understanding/runtime.js").describeImageFile; + describeImageFileWithModel: typeof import("../../media-understanding/runtime.js").describeImageFileWithModel; describeVideoFile: typeof import("../../media-understanding/runtime.js").describeVideoFile; transcribeAudioFile: typeof import("../../media-understanding/runtime.js").transcribeAudioFile; }; + imageGeneration: { + generate: typeof import("../../image-generation/runtime.js").generateImage; + listProviders: typeof import("../../image-generation/runtime.js").listRuntimeImageGenerationProviders; + }; webSearch: { listProviders: typeof import("../../web-search/runtime.js").listWebSearchProviders; search: typeof import("../../web-search/runtime.js").runWebSearch; diff --git a/src/plugins/types.ts b/src/plugins/types.ts index 52cb2787977..6deb59669f1 100644 --- a/src/plugins/types.ts +++ b/src/plugins/types.ts @@ -22,6 +22,7 @@ import type { ModelProviderConfig } from "../config/types.js"; import type { GatewayRequestHandler } from "../gateway/server-methods/types.js"; import type { InternalHookHandler } from "../hooks/internal-hooks.js"; import type { HookEntry } from "../hooks/types.js"; +import type { ImageGenerationProvider } from "../image-generation/types.js"; import type { ProviderUsageSnapshot } from "../infra/provider-usage.types.js"; import type { MediaUnderstandingProvider } from "../media-understanding/types.js"; import type { RuntimeEnv } from "../runtime.js"; @@ -890,6 +891,7 @@ export type PluginSpeechProviderEntry = SpeechProviderPlugin & { }; export type MediaUnderstandingProviderPlugin = MediaUnderstandingProvider; +export type ImageGenerationProviderPlugin = ImageGenerationProvider; export type OpenClawPluginGatewayMethod = { method: string; @@ -1251,6 +1253,7 @@ export type OpenClawPluginApi = { registerProvider: (provider: ProviderPlugin) => void; registerSpeechProvider: (provider: SpeechProviderPlugin) => void; registerMediaUnderstandingProvider: (provider: MediaUnderstandingProviderPlugin) => void; + registerImageGenerationProvider: (provider: ImageGenerationProviderPlugin) => void; registerWebSearchProvider: (provider: WebSearchProviderPlugin) => void; registerInteractiveHandler: (registration: PluginInteractiveHandlerRegistration) => void; /** diff --git a/src/test-utils/channel-plugins.ts b/src/test-utils/channel-plugins.ts index 1283ac9f506..6ecf718f895 100644 --- a/src/test-utils/channel-plugins.ts +++ b/src/test-utils/channel-plugins.ts @@ -28,6 +28,7 @@ export const createTestRegistry = (channels: TestChannelRegistration[] = []): Pl providers: [], speechProviders: [], mediaUnderstandingProviders: [], + imageGenerationProviders: [], webSearchProviders: [], gatewayHandlers: {}, httpRoutes: [], diff --git a/src/tts/runtime.ts b/src/tts/runtime.ts new file mode 100644 index 00000000000..2235a1124e0 --- /dev/null +++ b/src/tts/runtime.ts @@ -0,0 +1,4 @@ +// Shared runtime-facing speech helpers. Keep channel/feature plugins on this +// boundary instead of importing the full TTS orchestrator module directly. + +export { listSpeechVoices, textToSpeech, textToSpeechTelephony } from "./tts.js"; From 2d100157bd1b89edaa69f064b6314c499ace3629 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 22:56:21 -0700 Subject: [PATCH 069/187] refactor(channels): route media helpers through runtime --- .../discord/src/voice/manager.e2e.test.ts | 14 ++- extensions/discord/src/voice/manager.ts | 49 ++------ extensions/telegram/src/sticker-cache.test.ts | 119 +++++++++--------- extensions/telegram/src/sticker-cache.ts | 24 ++-- 4 files changed, 88 insertions(+), 118 deletions(-) diff --git a/extensions/discord/src/voice/manager.e2e.test.ts b/extensions/discord/src/voice/manager.e2e.test.ts index 73c6f249021..0889e351bf5 100644 --- a/extensions/discord/src/voice/manager.e2e.test.ts +++ b/extensions/discord/src/voice/manager.e2e.test.ts @@ -85,15 +85,19 @@ vi.mock("@discordjs/voice", () => ({ joinVoiceChannel: joinVoiceChannelMock, })); -vi.mock("../../../../src/routing/resolve-route.js", () => ({ +vi.mock("openclaw/plugin-sdk/routing", () => ({ resolveAgentRoute: resolveAgentRouteMock, })); -vi.mock("../../../../src/commands/agent.js", () => ({ - agentCommandFromIngress: agentCommandMock, -})); +vi.mock("openclaw/plugin-sdk/agent-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + agentCommandFromIngress: agentCommandMock, + }; +}); -vi.mock("../../../../src/media-understanding/runtime.js", () => ({ +vi.mock("openclaw/plugin-sdk/media-understanding-runtime", () => ({ transcribeAudioFile: transcribeAudioFileMock, })); diff --git a/extensions/discord/src/voice/manager.ts b/extensions/discord/src/voice/manager.ts index c2fbcbfc686..5f9f66242ad 100644 --- a/extensions/discord/src/voice/manager.ts +++ b/extensions/discord/src/voice/manager.ts @@ -18,28 +18,19 @@ import { } from "@discordjs/voice"; import { resolveAgentDir } from "openclaw/plugin-sdk/agent-runtime"; import { agentCommandFromIngress } from "openclaw/plugin-sdk/agent-runtime"; -import { - resolveTtsConfig, - textToSpeech, - type ResolvedTtsConfig, -} from "openclaw/plugin-sdk/agent-runtime"; +import { resolveTtsConfig, type ResolvedTtsConfig } from "openclaw/plugin-sdk/agent-runtime"; import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { isDangerousNameMatchingEnabled } from "openclaw/plugin-sdk/config-runtime"; import type { DiscordAccountConfig, TtsConfig } from "openclaw/plugin-sdk/config-runtime"; import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime"; import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime"; -import { - buildProviderRegistry, - createMediaAttachmentCache, - normalizeMediaAttachments, - runCapability, -} from "openclaw/plugin-sdk/media-runtime"; -import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; +import { transcribeAudioFile } from "openclaw/plugin-sdk/media-understanding-runtime"; import { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; import { logVerbose, shouldLogVerbose } from "openclaw/plugin-sdk/runtime-env"; import { createSubsystemLogger } from "openclaw/plugin-sdk/runtime-env"; import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import { parseTtsDirectives } from "openclaw/plugin-sdk/speech"; +import { textToSpeech } from "openclaw/plugin-sdk/speech-runtime"; import { formatMention } from "../mentions.js"; import { resolveDiscordOwnerAccess } from "../monitor/allow-list.js"; import { formatDiscordUserTag } from "../monitor/format.js"; @@ -240,33 +231,13 @@ async function transcribeAudio(params: { agentId: string; filePath: string; }): Promise { - const ctx: MsgContext = { - MediaPath: params.filePath, - MediaType: "audio/wav", - }; - const attachments = normalizeMediaAttachments(ctx); - if (attachments.length === 0) { - return undefined; - } - const cache = createMediaAttachmentCache(attachments); - const providerRegistry = buildProviderRegistry(); - try { - const result = await runCapability({ - capability: "audio", - cfg: params.cfg, - ctx, - attachments: cache, - media: attachments, - agentDir: resolveAgentDir(params.cfg, params.agentId), - providerRegistry, - config: params.cfg.tools?.media?.audio, - }); - const output = result.outputs.find((entry) => entry.kind === "audio.transcription"); - const text = output?.text?.trim(); - return text || undefined; - } finally { - await cache.cleanup(); - } + const result = await transcribeAudioFile({ + filePath: params.filePath, + cfg: params.cfg, + agentDir: resolveAgentDir(params.cfg, params.agentId), + mime: "audio/wav", + }); + return result.text?.trim() || undefined; } export class DiscordVoiceManager { diff --git a/extensions/telegram/src/sticker-cache.test.ts b/extensions/telegram/src/sticker-cache.test.ts index 219ce421e62..75a1db8725d 100644 --- a/extensions/telegram/src/sticker-cache.test.ts +++ b/extensions/telegram/src/sticker-cache.test.ts @@ -1,44 +1,49 @@ import fs from "node:fs"; import path from "node:path"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { - cacheSticker, - getAllCachedStickers, - getCachedSticker, - getCacheStats, - searchStickers, -} from "./sticker-cache.js"; -// Mock the state directory to use a temp location -vi.mock("../../../src/config/paths.js", async (importOriginal) => { - const actual = await importOriginal(); - return { - ...actual, - STATE_DIR: "/tmp/openclaw-test-sticker-cache", - }; -}); +vi.mock("openclaw/plugin-sdk/agent-runtime", () => ({ + resolveApiKeyForProvider: vi.fn(), + findModelInCatalog: vi.fn(), + loadModelCatalog: vi.fn(async () => []), + modelSupportsVision: vi.fn(() => false), + resolveDefaultModelForAgent: vi.fn(() => ({ provider: "openai", model: "gpt-5.2" })), +})); + +vi.mock("openclaw/plugin-sdk/media-runtime", () => ({ + AUTO_IMAGE_KEY_PROVIDERS: ["openai"], + DEFAULT_IMAGE_MODELS: { openai: "gpt-4.1-mini" }, + resolveAutoImageModel: vi.fn(async () => null), +})); + +vi.mock("openclaw/plugin-sdk/media-understanding-runtime", () => ({ + describeImageFileWithModel: vi.fn(), +})); const TEST_CACHE_DIR = "/tmp/openclaw-test-sticker-cache/telegram"; const TEST_CACHE_FILE = path.join(TEST_CACHE_DIR, "sticker-cache.json"); +type StickerCacheModule = typeof import("./sticker-cache.js"); + +let stickerCache: StickerCacheModule; + describe("sticker-cache", () => { - beforeEach(() => { - // Clean up before each test - if (fs.existsSync(TEST_CACHE_FILE)) { - fs.unlinkSync(TEST_CACHE_FILE); - } + beforeEach(async () => { + process.env.OPENCLAW_STATE_DIR = "/tmp/openclaw-test-sticker-cache"; + fs.rmSync("/tmp/openclaw-test-sticker-cache", { recursive: true, force: true }); + fs.mkdirSync(TEST_CACHE_DIR, { recursive: true }); + vi.resetModules(); + stickerCache = await import("./sticker-cache.js"); }); afterEach(() => { - // Clean up after each test - if (fs.existsSync(TEST_CACHE_FILE)) { - fs.unlinkSync(TEST_CACHE_FILE); - } + fs.rmSync("/tmp/openclaw-test-sticker-cache", { recursive: true, force: true }); + delete process.env.OPENCLAW_STATE_DIR; }); describe("getCachedSticker", () => { it("returns null for unknown ID", () => { - const result = getCachedSticker("unknown-id"); + const result = stickerCache.getCachedSticker("unknown-id"); expect(result).toBeNull(); }); @@ -52,8 +57,8 @@ describe("sticker-cache", () => { cachedAt: "2026-01-26T12:00:00.000Z", }; - cacheSticker(sticker); - const result = getCachedSticker("unique123"); + stickerCache.cacheSticker(sticker); + const result = stickerCache.getCachedSticker("unique123"); expect(result).toEqual(sticker); }); @@ -66,13 +71,13 @@ describe("sticker-cache", () => { cachedAt: "2026-01-26T12:00:00.000Z", }; - cacheSticker(sticker); - expect(getCachedSticker("unique123")).not.toBeNull(); + stickerCache.cacheSticker(sticker); + expect(stickerCache.getCachedSticker("unique123")).not.toBeNull(); // Manually clear the cache file - fs.unlinkSync(TEST_CACHE_FILE); + fs.rmSync(TEST_CACHE_FILE, { force: true }); - expect(getCachedSticker("unique123")).toBeNull(); + expect(stickerCache.getCachedSticker("unique123")).toBeNull(); }); }); @@ -85,9 +90,9 @@ describe("sticker-cache", () => { cachedAt: "2026-01-26T12:00:00.000Z", }; - cacheSticker(sticker); + stickerCache.cacheSticker(sticker); - const all = getAllCachedStickers(); + const all = stickerCache.getAllCachedStickers(); expect(all).toHaveLength(1); expect(all[0]).toEqual(sticker); }); @@ -106,10 +111,10 @@ describe("sticker-cache", () => { cachedAt: "2026-01-26T13:00:00.000Z", }; - cacheSticker(original); - cacheSticker(updated); + stickerCache.cacheSticker(original); + stickerCache.cacheSticker(updated); - const result = getCachedSticker("unique789"); + const result = stickerCache.getCachedSticker("unique789"); expect(result?.description).toBe("Updated description"); expect(result?.fileId).toBe("file789-new"); }); @@ -118,7 +123,7 @@ describe("sticker-cache", () => { describe("searchStickers", () => { beforeEach(() => { // Seed cache with test stickers - cacheSticker({ + stickerCache.cacheSticker({ fileId: "fox1", fileUniqueId: "fox-unique-1", emoji: "🦊", @@ -126,7 +131,7 @@ describe("sticker-cache", () => { description: "A cute orange fox waving hello", cachedAt: "2026-01-26T10:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "fox2", fileUniqueId: "fox-unique-2", emoji: "🦊", @@ -134,7 +139,7 @@ describe("sticker-cache", () => { description: "A fox sleeping peacefully", cachedAt: "2026-01-26T11:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "cat1", fileUniqueId: "cat-unique-1", emoji: "🐱", @@ -142,7 +147,7 @@ describe("sticker-cache", () => { description: "A cat sitting on a keyboard", cachedAt: "2026-01-26T12:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "dog1", fileUniqueId: "dog-unique-1", emoji: "🐶", @@ -153,47 +158,47 @@ describe("sticker-cache", () => { }); it("finds stickers by description substring", () => { - const results = searchStickers("fox"); + const results = stickerCache.searchStickers("fox"); expect(results).toHaveLength(2); expect(results.every((s) => s.description.toLowerCase().includes("fox"))).toBe(true); }); it("finds stickers by emoji", () => { - const results = searchStickers("🦊"); + const results = stickerCache.searchStickers("🦊"); expect(results).toHaveLength(2); expect(results.every((s) => s.emoji === "🦊")).toBe(true); }); it("finds stickers by set name", () => { - const results = searchStickers("CuteFoxes"); + const results = stickerCache.searchStickers("CuteFoxes"); expect(results).toHaveLength(2); expect(results.every((s) => s.setName === "CuteFoxes")).toBe(true); }); it("respects limit parameter", () => { - const results = searchStickers("fox", 1); + const results = stickerCache.searchStickers("fox", 1); expect(results).toHaveLength(1); }); it("ranks exact matches higher", () => { // "waving" appears in "fox waving hello" - should be ranked first - const results = searchStickers("waving"); + const results = stickerCache.searchStickers("waving"); expect(results).toHaveLength(1); expect(results[0]?.fileUniqueId).toBe("fox-unique-1"); }); it("returns empty array for no matches", () => { - const results = searchStickers("elephant"); + const results = stickerCache.searchStickers("elephant"); expect(results).toHaveLength(0); }); it("is case insensitive", () => { - const results = searchStickers("FOX"); + const results = stickerCache.searchStickers("FOX"); expect(results).toHaveLength(2); }); it("matches multiple words", () => { - const results = searchStickers("cat keyboard"); + const results = stickerCache.searchStickers("cat keyboard"); expect(results).toHaveLength(1); expect(results[0]?.fileUniqueId).toBe("cat-unique-1"); }); @@ -201,58 +206,58 @@ describe("sticker-cache", () => { describe("getAllCachedStickers", () => { it("returns empty array when cache is empty", () => { - const result = getAllCachedStickers(); + const result = stickerCache.getAllCachedStickers(); expect(result).toEqual([]); }); it("returns all cached stickers", () => { - cacheSticker({ + stickerCache.cacheSticker({ fileId: "a", fileUniqueId: "a-unique", description: "Sticker A", cachedAt: "2026-01-26T10:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "b", fileUniqueId: "b-unique", description: "Sticker B", cachedAt: "2026-01-26T11:00:00.000Z", }); - const result = getAllCachedStickers(); + const result = stickerCache.getAllCachedStickers(); expect(result).toHaveLength(2); }); }); describe("getCacheStats", () => { it("returns count 0 when cache is empty", () => { - const stats = getCacheStats(); + const stats = stickerCache.getCacheStats(); expect(stats.count).toBe(0); expect(stats.oldestAt).toBeUndefined(); expect(stats.newestAt).toBeUndefined(); }); it("returns correct stats with cached stickers", () => { - cacheSticker({ + stickerCache.cacheSticker({ fileId: "old", fileUniqueId: "old-unique", description: "Old sticker", cachedAt: "2026-01-20T10:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "new", fileUniqueId: "new-unique", description: "New sticker", cachedAt: "2026-01-26T10:00:00.000Z", }); - cacheSticker({ + stickerCache.cacheSticker({ fileId: "mid", fileUniqueId: "mid-unique", description: "Middle sticker", cachedAt: "2026-01-23T10:00:00.000Z", }); - const stats = getCacheStats(); + const stats = stickerCache.getCacheStats(); expect(stats.count).toBe(3); expect(stats.oldestAt).toBe("2026-01-20T10:00:00.000Z"); expect(stats.newestAt).toBe("2026-01-26T10:00:00.000Z"); diff --git a/extensions/telegram/src/sticker-cache.ts b/extensions/telegram/src/sticker-cache.ts index ea86bd8f1bf..e6fd3398f16 100644 --- a/extensions/telegram/src/sticker-cache.ts +++ b/extensions/telegram/src/sticker-cache.ts @@ -1,4 +1,3 @@ -import fs from "node:fs/promises"; import path from "node:path"; import { resolveApiKeyForProvider } from "openclaw/plugin-sdk/agent-runtime"; import type { ModelCatalogEntry } from "openclaw/plugin-sdk/agent-runtime"; @@ -12,6 +11,7 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { loadJsonFile, saveJsonFile } from "openclaw/plugin-sdk/json-store"; import { AUTO_IMAGE_KEY_PROVIDERS, DEFAULT_IMAGE_MODELS } from "openclaw/plugin-sdk/media-runtime"; import { resolveAutoImageModel } from "openclaw/plugin-sdk/media-runtime"; +import { describeImageFileWithModel } from "openclaw/plugin-sdk/media-understanding-runtime"; import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { STATE_DIR } from "openclaw/plugin-sdk/state-paths"; @@ -143,12 +143,6 @@ export function getCacheStats(): { count: number; oldestAt?: string; newestAt?: const STICKER_DESCRIPTION_PROMPT = "Describe this sticker image in 1-2 sentences. Focus on what the sticker depicts (character, object, action, emotion). Be concise and objective."; -let imageRuntimePromise: Promise | null = null; - -function loadImageRuntime() { - imageRuntimePromise ??= import("./media-understanding.runtime.js"); - return imageRuntimePromise; -} export interface DescribeStickerParams { imagePath: string; @@ -242,22 +236,18 @@ export async function describeStickerImage(params: DescribeStickerParams): Promi logVerbose(`telegram: describing sticker with ${provider}/${model}`); try { - const buffer = await fs.readFile(imagePath); - // Lazy import to avoid circular dependency - const { describeImageWithModel } = await loadImageRuntime(); - const result = await describeImageWithModel({ - buffer, - fileName: "sticker.webp", + const result = await describeImageFileWithModel({ + filePath: imagePath, mime: "image/webp", - prompt: STICKER_DESCRIPTION_PROMPT, cfg, - agentDir: agentDir ?? "", + agentDir, provider, model, + prompt: STICKER_DESCRIPTION_PROMPT, maxTokens: 150, - timeoutMs: 30000, + timeoutMs: 30_000, }); - return result.text; + return result.text ?? null; } catch (err) { logVerbose(`telegram: failed to describe sticker: ${String(err)}`); return null; From be2e6ca0f6a02ef457d33fbc2bd69797bee613b1 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:00:14 -0700 Subject: [PATCH 070/187] fix(macos): harden exec approval socket auth --- CHANGELOG.md | 1 + .../OpenClaw/ExecApprovalsSocket.swift | 16 +++++++++++++- .../ExecApprovalsSocketAuthTests.swift | 21 +++++++++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 apps/macos/Tests/OpenClawIPCTests/ExecApprovalsSocketAuthTests.swift diff --git a/CHANGELOG.md b/CHANGELOG.md index aa15c6162e5..0e38cc1703a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -112,6 +112,7 @@ Docs: https://docs.openclaw.ai - Control UI/overview: keep the language dropdown aligned with the persisted locale during dashboard startup so refreshing the page does not fall back to English before locale hydration completes. (#48019) Thanks @git-jxj. - Agents/compaction: rerun transcript repair after `session.compact()` so orphaned `tool_result` blocks cannot survive compaction and break later Anthropic requests. (#16095) thanks @claw-sylphx. - Agents/compaction: trigger overflow recovery from the tool-result guard once post-compaction context still exceeds the safe threshold, so long tool loops compact before the next model call hard-fails. (#29371) thanks @keshav55. +- macOS/exec approvals: harden exec-host request HMAC verification to use a timing-safe compare and keep malformed or truncated signatures fail-closed in focused IPC auth coverage. ## 2026.3.13 diff --git a/apps/macos/Sources/OpenClaw/ExecApprovalsSocket.swift b/apps/macos/Sources/OpenClaw/ExecApprovalsSocket.swift index a2cc9d53390..19336f4f7b1 100644 --- a/apps/macos/Sources/OpenClaw/ExecApprovalsSocket.swift +++ b/apps/macos/Sources/OpenClaw/ExecApprovalsSocket.swift @@ -89,6 +89,20 @@ private func readLineFromHandle(_ handle: FileHandle, maxBytes: Int) throws -> S return String(data: lineData, encoding: .utf8) } +func timingSafeHexStringEquals(_ lhs: String, _ rhs: String) -> Bool { + let lhsBytes = Array(lhs.utf8) + let rhsBytes = Array(rhs.utf8) + guard lhsBytes.count == rhsBytes.count else { + return false + } + + var diff: UInt8 = 0 + for index in lhsBytes.indices { + diff |= lhsBytes[index] ^ rhsBytes[index] + } + return diff == 0 +} + enum ExecApprovalsSocketClient { private struct TimeoutError: LocalizedError { var message: String @@ -854,7 +868,7 @@ private final class ExecApprovalsSocketServer: @unchecked Sendable { error: ExecHostError(code: "INVALID_REQUEST", message: "expired request", reason: "ttl")) } let expected = self.hmacHex(nonce: request.nonce, ts: request.ts, requestJson: request.requestJson) - if expected != request.hmac { + if !timingSafeHexStringEquals(expected, request.hmac) { return ExecHostResponse( type: "exec-res", id: request.id, diff --git a/apps/macos/Tests/OpenClawIPCTests/ExecApprovalsSocketAuthTests.swift b/apps/macos/Tests/OpenClawIPCTests/ExecApprovalsSocketAuthTests.swift new file mode 100644 index 00000000000..ee0ead1f902 --- /dev/null +++ b/apps/macos/Tests/OpenClawIPCTests/ExecApprovalsSocketAuthTests.swift @@ -0,0 +1,21 @@ +import Testing +@testable import OpenClaw + +struct ExecApprovalsSocketAuthTests { + @Test + func `timing safe hex compare matches equal strings`() { + #expect(timingSafeHexStringEquals(String(repeating: "a", count: 64), String(repeating: "a", count: 64))) + } + + @Test + func `timing safe hex compare rejects mismatched strings`() { + let expected = String(repeating: "a", count: 63) + "b" + let provided = String(repeating: "a", count: 63) + "c" + #expect(!timingSafeHexStringEquals(expected, provided)) + } + + @Test + func `timing safe hex compare rejects different length strings`() { + #expect(!timingSafeHexStringEquals(String(repeating: "a", count: 64), "deadbeef")) + } +} From efaa4dc5b3ee1c7c1e482129e741917b419b17c6 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Mon, 16 Mar 2026 22:52:34 -0700 Subject: [PATCH 071/187] Tests: stabilize bundled native command regressions --- .../native-command.plugin-dispatch.test.ts | 74 +++++++++++-------- extensions/discord/src/setup-core.ts | 2 +- extensions/discord/src/setup-surface.ts | 2 +- extensions/discord/src/shared.ts | 10 +-- extensions/imessage/src/setup-core.ts | 2 +- extensions/imessage/src/setup-surface.ts | 2 +- extensions/imessage/src/shared.ts | 16 ++-- extensions/signal/src/setup-core.ts | 4 +- extensions/signal/src/setup-surface.ts | 4 +- extensions/signal/src/shared.ts | 14 ++-- extensions/slack/src/setup-core.ts | 2 +- extensions/slack/src/setup-surface.ts | 2 +- extensions/slack/src/shared.ts | 20 ++--- .../src/bot-native-commands.registry.test.ts | 19 +++-- .../telegram/src/bot-native-commands.test.ts | 35 +++++++-- extensions/telegram/src/setup-core.ts | 4 +- extensions/telegram/src/shared.ts | 14 ++-- extensions/whatsapp/src/setup-surface.ts | 4 +- extensions/whatsapp/src/shared.ts | 20 +++-- 19 files changed, 144 insertions(+), 106 deletions(-) diff --git a/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts b/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts index 4541ee3ab9d..1009c583a81 100644 --- a/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts +++ b/extensions/discord/src/monitor/native-command.plugin-dispatch.test.ts @@ -5,7 +5,6 @@ import * as dispatcherModule from "../../../../src/auto-reply/reply/provider-dis import type { OpenClawConfig } from "../../../../src/config/config.js"; import * as pluginCommandsModule from "../../../../src/plugins/commands.js"; import { clearPluginCommands, registerPluginCommand } from "../../../../src/plugins/commands.js"; -import { createDiscordNativeCommand } from "./native-command.js"; import { createMockCommandInteraction, type MockCommandInteraction, @@ -13,28 +12,31 @@ import { import { createNoopThreadBindingManager } from "./thread-bindings.js"; type ResolveConfiguredAcpBindingRecordFn = - typeof import("../../../../src/acp/persistent-bindings.js").resolveConfiguredAcpBindingRecord; + typeof import("openclaw/plugin-sdk/conversation-runtime").resolveConfiguredAcpRoute; type EnsureConfiguredAcpBindingSessionFn = - typeof import("../../../../src/acp/persistent-bindings.js").ensureConfiguredAcpBindingSession; + typeof import("openclaw/plugin-sdk/conversation-runtime").ensureConfiguredAcpRouteReady; const persistentBindingMocks = vi.hoisted(() => ({ - resolveConfiguredAcpBindingRecord: vi.fn(() => null), + resolveConfiguredAcpBindingRecord: vi.fn((params) => ({ + configuredBinding: null, + route: params.route, + })), ensureConfiguredAcpBindingSession: vi.fn(async () => ({ ok: true, - sessionKey: "agent:codex:acp:binding:discord:default:seed", })), })); -vi.mock("../../../../src/acp/persistent-bindings.js", async (importOriginal) => { - const actual = - await importOriginal(); +vi.mock("openclaw/plugin-sdk/conversation-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, - resolveConfiguredAcpBindingRecord: persistentBindingMocks.resolveConfiguredAcpBindingRecord, - ensureConfiguredAcpBindingSession: persistentBindingMocks.ensureConfiguredAcpBindingSession, + resolveConfiguredAcpRoute: persistentBindingMocks.resolveConfiguredAcpBindingRecord, + ensureConfiguredAcpRouteReady: persistentBindingMocks.ensureConfiguredAcpBindingSession, }; }); +import { createDiscordNativeCommand } from "./native-command.js"; + function createInteraction(params?: { channelType?: ChannelType; channelId?: string; @@ -146,30 +148,40 @@ async function expectPairCommandReply(params: { } function setConfiguredBinding(channelId: string, boundSessionKey: string) { - persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockReturnValue({ - spec: { - channel: "discord", - accountId: "default", - conversationId: channelId, - agentId: "codex", - mode: "persistent", - }, - record: { - bindingId: `config:acp:discord:default:${channelId}`, - targetSessionKey: boundSessionKey, - targetKind: "session", - conversation: { + persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockImplementation((params) => ({ + configuredBinding: { + spec: { channel: "discord", - accountId: "default", + accountId: params.accountId, conversationId: channelId, + parentConversationId: params.parentConversationId, + agentId: "codex", + mode: "persistent", + }, + record: { + bindingId: `config:acp:discord:${params.accountId}:${channelId}`, + targetSessionKey: boundSessionKey, + targetKind: "session", + conversation: { + channel: "discord", + accountId: params.accountId, + conversationId: channelId, + }, + status: "active", + boundAt: 0, }, - status: "active", - boundAt: 0, }, - }); + boundSessionKey, + boundAgentId: "codex", + route: { + ...params.route, + agentId: "codex", + sessionKey: boundSessionKey, + matchedBy: "binding.channel", + }, + })); persistentBindingMocks.ensureConfiguredAcpBindingSession.mockResolvedValue({ ok: true, - sessionKey: boundSessionKey, }); } @@ -221,11 +233,13 @@ describe("Discord native plugin command dispatch", () => { vi.restoreAllMocks(); clearPluginCommands(); persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockReset(); - persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockReturnValue(null); + persistentBindingMocks.resolveConfiguredAcpBindingRecord.mockImplementation((params) => ({ + configuredBinding: null, + route: params.route, + })); persistentBindingMocks.ensureConfiguredAcpBindingSession.mockReset(); persistentBindingMocks.ensureConfiguredAcpBindingSession.mockResolvedValue({ ok: true, - sessionKey: "agent:codex:acp:binding:discord:default:seed", }); }); diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 619537ef85c..4425ed6adeb 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -3,7 +3,6 @@ import { applyAccountNameToChannelSection, createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, noteChannelLookupFailure, @@ -14,6 +13,7 @@ import { setSetupChannelEnabled, type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { createAllowlistSetupWizardProxy, type ChannelSetupAdapter, diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index da87bfd77d0..6373f89dbcf 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,6 +1,5 @@ import { DEFAULT_ACCOUNT_ID, - formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, type OpenClawConfig, @@ -12,6 +11,7 @@ import { setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { inspectDiscordAccount } from "./account-inspect.js"; import { diff --git a/extensions/discord/src/shared.ts b/extensions/discord/src/shared.ts index 03174404bdb..92e248066af 100644 --- a/extensions/discord/src/shared.ts +++ b/extensions/discord/src/shared.ts @@ -3,12 +3,10 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - buildChannelConfigSchema, - DiscordConfigSchema, - getChatChannelMeta, - type ChannelPlugin, -} from "openclaw/plugin-sdk/discord"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { DiscordConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index 2b9ff2eb2dc..7543df157e8 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,7 +1,6 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, parseSetupEntriesAllowingWildcard, @@ -11,6 +10,7 @@ import { type OpenClawConfig, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index 1ba4358cc52..f01b4c03f93 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,8 +1,8 @@ import { - detectBinary, setSetupChannelEnabled, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { detectBinary } from "../../../src/plugins/setup-binary.js"; import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { createIMessageCliPathTextInput, diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 935546721da..5ce509f757d 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -3,17 +3,19 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, - deleteAccountFromConfigSection, formatTrimmedAllowFromEntries, - getChatChannelMeta, - IMessageConfigSchema, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, +} from "../../../src/plugin-sdk/channel-config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { + deleteAccountFromConfigSection, setAccountEnabledInConfigSection, - type ChannelPlugin, -} from "openclaw/plugin-sdk/imessage"; +} from "../../../src/channels/plugins/config-helpers.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 38b7b0f086c..3952a55f861 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,8 +1,6 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, normalizeE164, @@ -19,6 +17,8 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 01ded866785..2094e76da05 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,9 +1,9 @@ import { - detectBinary, - installSignalCli, setSetupChannelEnabled, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { detectBinary } from "../../../src/plugins/setup-binary.js"; +import { installSignalCli } from "../../../src/plugins/signal-cli-install.js"; import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; import { createSignalCliPathTextInput, diff --git a/extensions/signal/src/shared.ts b/extensions/signal/src/shared.ts index 3de5af7d57a..60dfd0ed010 100644 --- a/extensions/signal/src/shared.ts +++ b/extensions/signal/src/shared.ts @@ -4,15 +4,15 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { - buildChannelConfigSchema, - DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, - getChatChannelMeta, - normalizeE164, setAccountEnabledInConfigSection, - SignalConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/signal"; +} from "../../../src/channels/plugins/config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { SignalConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { normalizeE164 } from "../../../src/utils.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index e9f8f8f5cb0..5cd7a71d22c 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -3,7 +3,6 @@ import { createAllowlistSetupWizardProxy, createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, - formatDocsLink, hasConfiguredSecretInput, migrateBaseNameToDefaultAccount, normalizeAccountId, @@ -16,6 +15,7 @@ import { setLegacyChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { type ChannelSetupAdapter, type ChannelSetupDmPolicy, diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 1dbfa4f02ce..309dc669af8 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,6 +1,5 @@ import { DEFAULT_ACCOUNT_ID, - formatDocsLink, hasConfiguredSecretInput, noteChannelLookupFailure, noteChannelLookupSummary, @@ -15,6 +14,7 @@ import { setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupDmPolicy, ChannelSetupWizard, diff --git a/extensions/slack/src/shared.ts b/extensions/slack/src/shared.ts index 58dfae35c90..4471e851097 100644 --- a/extensions/slack/src/shared.ts +++ b/extensions/slack/src/shared.ts @@ -3,18 +3,14 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - formatDocsLink, - hasConfiguredSecretInput, - patchChannelConfigForAccount, -} from "openclaw/plugin-sdk/setup"; -import { - buildChannelConfigSchema, - getChatChannelMeta, - SlackConfigSchema, - type ChannelPlugin, - type OpenClawConfig, -} from "openclaw/plugin-sdk/slack"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { patchChannelConfigForAccount } from "../../../src/channels/plugins/setup-wizard-helpers.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; +import { SlackConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/bot-native-commands.registry.test.ts b/extensions/telegram/src/bot-native-commands.registry.test.ts index c1f9fc1d0a6..55379e6a5fa 100644 --- a/extensions/telegram/src/bot-native-commands.registry.test.ts +++ b/extensions/telegram/src/bot-native-commands.registry.test.ts @@ -1,20 +1,27 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; import { clearPluginCommands, registerPluginCommand } from "../../../src/plugins/commands.js"; +const deliveryMocks = vi.hoisted(() => ({ + deliverReplies: vi.fn(async () => ({ delivered: true })), +})); + +vi.mock("./bot/delivery.js", () => ({ + deliverReplies: deliveryMocks.deliverReplies, +})); + import { registerTelegramNativeCommands } from "./bot-native-commands.js"; import { createCommandBot, createNativeCommandTestParams, createPrivateCommandContext, - deliverReplies, - resetNativeCommandMenuMocks, waitForRegisteredCommands, } from "./bot-native-commands.menu-test-support.js"; describe("registerTelegramNativeCommands real plugin registry", () => { beforeEach(() => { clearPluginCommands(); - resetNativeCommandMenuMocks(); + deliveryMocks.deliverReplies.mockClear(); + deliveryMocks.deliverReplies.mockResolvedValue({ delivered: true }); }); afterEach(() => { @@ -49,7 +56,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { await handler?.(createPrivateCommandContext({ match: "now" })); - expect(deliverReplies).toHaveBeenCalledWith( + expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), @@ -89,7 +96,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { await handler?.(createPrivateCommandContext({ match: "now", messageId: 2 })); - expect(deliverReplies).toHaveBeenCalledWith( + expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), @@ -157,7 +164,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { }), ); - expect(deliverReplies).toHaveBeenCalledWith( + expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ replies: [expect.objectContaining({ text: "paired:now" })], }), diff --git a/extensions/telegram/src/bot-native-commands.test.ts b/extensions/telegram/src/bot-native-commands.test.ts index 6dba343524f..683842fa2df 100644 --- a/extensions/telegram/src/bot-native-commands.test.ts +++ b/extensions/telegram/src/bot-native-commands.test.ts @@ -5,14 +5,30 @@ import { STATE_DIR } from "../../../src/config/paths.js"; import { TELEGRAM_COMMAND_NAME_PATTERN } from "../../../src/config/telegram-custom-commands.js"; import type { TelegramAccountConfig } from "../../../src/config/types.js"; import type { RuntimeEnv } from "../../../src/runtime.js"; +const skillCommandMocks = vi.hoisted(() => ({ + listSkillCommandsForAgents: vi.fn(() => []), +})); +const deliveryMocks = vi.hoisted(() => ({ + deliverReplies: vi.fn(async () => ({ delivered: true })), +})); + +vi.mock("openclaw/plugin-sdk/reply-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + listSkillCommandsForAgents: skillCommandMocks.listSkillCommandsForAgents, + }; +}); + +vi.mock("./bot/delivery.js", () => ({ + deliverReplies: deliveryMocks.deliverReplies, +})); + import { registerTelegramNativeCommands } from "./bot-native-commands.js"; import { createCommandBot, createNativeCommandTestParams, createPrivateCommandContext, - deliverReplies, - listSkillCommandsForAgents, - resetNativeCommandMenuMocks, waitForRegisteredCommands, } from "./bot-native-commands.menu-test-support.js"; @@ -29,7 +45,10 @@ vi.mock("../../../src/plugins/commands.js", () => ({ describe("registerTelegramNativeCommands", () => { beforeEach(() => { - resetNativeCommandMenuMocks(); + skillCommandMocks.listSkillCommandsForAgents.mockClear(); + skillCommandMocks.listSkillCommandsForAgents.mockReturnValue([]); + deliveryMocks.deliverReplies.mockClear(); + deliveryMocks.deliverReplies.mockResolvedValue({ delivered: true }); pluginCommandMocks.getPluginCommandSpecs.mockClear(); pluginCommandMocks.getPluginCommandSpecs.mockReturnValue([]); pluginCommandMocks.matchPluginCommand.mockClear(); @@ -53,7 +72,7 @@ describe("registerTelegramNativeCommands", () => { registerTelegramNativeCommands(createNativeCommandTestParams(cfg, { accountId: "bot-a" })); - expect(listSkillCommandsForAgents).toHaveBeenCalledWith({ + expect(skillCommandMocks.listSkillCommandsForAgents).toHaveBeenCalledWith({ cfg, agentIds: ["butler"], }); @@ -68,7 +87,7 @@ describe("registerTelegramNativeCommands", () => { registerTelegramNativeCommands(createNativeCommandTestParams(cfg, { accountId: "bot-a" })); - expect(listSkillCommandsForAgents).toHaveBeenCalledWith({ + expect(skillCommandMocks.listSkillCommandsForAgents).toHaveBeenCalledWith({ cfg, agentIds: ["main"], }); @@ -215,7 +234,7 @@ describe("registerTelegramNativeCommands", () => { expect(handler).toBeTruthy(); await handler?.(createPrivateCommandContext()); - expect(deliverReplies).toHaveBeenCalledWith( + expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ mediaLocalRoots: expect.arrayContaining([path.join(STATE_DIR, "workspace-work")]), }), @@ -263,7 +282,7 @@ describe("registerTelegramNativeCommands", () => { expect(handler).toBeTruthy(); await handler?.(createPrivateCommandContext()); - expect(deliverReplies).toHaveBeenCalledWith( + expect(deliveryMocks.deliverReplies).toHaveBeenCalledWith( expect.objectContaining({ silent: true, replies: [expect.objectContaining({ isError: true })], diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 13fb01f3a51..10543aad1eb 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,8 +1,6 @@ import { applyAccountNameToChannelSection, DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, migrateBaseNameToDefaultAccount, normalizeAccountId, patchChannelConfigForAccount, @@ -11,6 +9,8 @@ import { type OpenClawConfig, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/telegram/src/shared.ts b/extensions/telegram/src/shared.ts index 644869dbc60..335213adead 100644 --- a/extensions/telegram/src/shared.ts +++ b/extensions/telegram/src/shared.ts @@ -3,14 +3,12 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { - buildChannelConfigSchema, - getChatChannelMeta, - normalizeAccountId, - TelegramConfigSchema, - type ChannelPlugin, - type OpenClawConfig, -} from "openclaw/plugin-sdk/telegram"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import { TelegramConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { normalizeAccountId } from "../../../src/routing/session-key.js"; import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index 4a87ce4d0f8..0975c28d444 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -1,8 +1,6 @@ import path from "node:path"; import { DEFAULT_ACCOUNT_ID, - formatCliCommand, - formatDocsLink, normalizeAccountId, normalizeAllowFromEntries, normalizeE164, @@ -12,6 +10,8 @@ import { type DmPolicy, type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; +import { formatCliCommand } from "../../../src/cli/command-format.js"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 43df9bd7e6a..6469d1cf18e 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -1,20 +1,24 @@ import { buildAccountScopedDmSecurityPolicy, - buildChannelConfigSchema, collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, - DEFAULT_ACCOUNT_ID, +} from "openclaw/plugin-sdk/channel-policy"; +import { formatWhatsAppConfigAllowFromEntries, - getChatChannelMeta, - normalizeE164, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, - resolveWhatsAppGroupIntroHint, +} from "../../../src/plugin-sdk/channel-config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { resolveWhatsAppGroupRequireMention, resolveWhatsAppGroupToolPolicy, - WhatsAppConfigSchema, - type ChannelPlugin, -} from "openclaw/plugin-sdk/whatsapp"; +} from "../../../src/channels/plugins/group-mentions.js"; +import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; +import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; +import { normalizeE164 } from "../../../src/utils.js"; import { listWhatsAppAccountIds, resolveDefaultWhatsAppAccountId, From 14d6b762fb2ad24f402f8cf9c44d6a4c78f25aaa Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:11:59 -0700 Subject: [PATCH 072/187] build: remove ineffective dynamic import shims --- .../src/monitor/preflight-audio.runtime.ts | 10 ++++++++- .../slack/src/message-action-dispatch.ts | 10 ++++++++- .../src/media-understanding.runtime.ts | 21 ++++++++++++++++++- extensions/whatsapp/src/channel.runtime.ts | 10 ++++++++- ...ad-only-account-inspect.discord.runtime.ts | 11 +++++++++- ...read-only-account-inspect.slack.runtime.ts | 11 +++++++++- ...d-only-account-inspect.telegram.runtime.ts | 11 +++++++++- src/cli/send-runtime/discord.ts | 10 ++++++++- src/cli/send-runtime/imessage.ts | 10 ++++++++- src/cli/send-runtime/signal.ts | 10 ++++++++- src/cli/send-runtime/slack.ts | 10 ++++++++- src/cli/send-runtime/telegram.ts | 10 ++++++++- src/cli/send-runtime/whatsapp.ts | 10 ++++++++- 13 files changed, 131 insertions(+), 13 deletions(-) diff --git a/extensions/discord/src/monitor/preflight-audio.runtime.ts b/extensions/discord/src/monitor/preflight-audio.runtime.ts index 5232d2ccb54..7e7f111d104 100644 --- a/extensions/discord/src/monitor/preflight-audio.runtime.ts +++ b/extensions/discord/src/monitor/preflight-audio.runtime.ts @@ -1 +1,9 @@ -export { transcribeFirstAudio } from "openclaw/plugin-sdk/media-runtime"; +import { transcribeFirstAudio as transcribeFirstAudioImpl } from "openclaw/plugin-sdk/media-runtime"; + +type TranscribeFirstAudio = typeof import("openclaw/plugin-sdk/media-runtime").transcribeFirstAudio; + +export async function transcribeFirstAudio( + ...args: Parameters +): ReturnType { + return await transcribeFirstAudioImpl(...args); +} diff --git a/extensions/slack/src/message-action-dispatch.ts b/extensions/slack/src/message-action-dispatch.ts index a589d28fed7..fc04c122ac7 100644 --- a/extensions/slack/src/message-action-dispatch.ts +++ b/extensions/slack/src/message-action-dispatch.ts @@ -1 +1,9 @@ -export { handleSlackMessageAction } from "openclaw/plugin-sdk/slack"; +import { handleSlackMessageAction as handleSlackMessageActionImpl } from "openclaw/plugin-sdk/slack"; + +type HandleSlackMessageAction = typeof import("openclaw/plugin-sdk/slack").handleSlackMessageAction; + +export async function handleSlackMessageAction( + ...args: Parameters +): ReturnType { + return await handleSlackMessageActionImpl(...args); +} diff --git a/extensions/telegram/src/media-understanding.runtime.ts b/extensions/telegram/src/media-understanding.runtime.ts index 3d20203caa8..3048178f06d 100644 --- a/extensions/telegram/src/media-understanding.runtime.ts +++ b/extensions/telegram/src/media-understanding.runtime.ts @@ -1 +1,20 @@ -export { describeImageWithModel, transcribeFirstAudio } from "openclaw/plugin-sdk/media-runtime"; +import { + describeImageWithModel as describeImageWithModelImpl, + transcribeFirstAudio as transcribeFirstAudioImpl, +} from "openclaw/plugin-sdk/media-runtime"; + +type DescribeImageWithModel = + typeof import("openclaw/plugin-sdk/media-runtime").describeImageWithModel; +type TranscribeFirstAudio = typeof import("openclaw/plugin-sdk/media-runtime").transcribeFirstAudio; + +export async function describeImageWithModel( + ...args: Parameters +): ReturnType { + return await describeImageWithModelImpl(...args); +} + +export async function transcribeFirstAudio( + ...args: Parameters +): ReturnType { + return await transcribeFirstAudioImpl(...args); +} diff --git a/extensions/whatsapp/src/channel.runtime.ts b/extensions/whatsapp/src/channel.runtime.ts index 1273da7bbd0..dbe5965a25d 100644 --- a/extensions/whatsapp/src/channel.runtime.ts +++ b/extensions/whatsapp/src/channel.runtime.ts @@ -9,4 +9,12 @@ export { export { loginWeb } from "./login.js"; export { startWebLoginWithQr, waitForWebLogin } from "./login-qr.js"; export { whatsappSetupWizard } from "./setup-surface.js"; -export { monitorWebChannel } from "openclaw/plugin-sdk/whatsapp"; +import { monitorWebChannel as monitorWebChannelImpl } from "openclaw/plugin-sdk/whatsapp"; + +type MonitorWebChannel = typeof import("openclaw/plugin-sdk/whatsapp").monitorWebChannel; + +export async function monitorWebChannel( + ...args: Parameters +): ReturnType { + return await monitorWebChannelImpl(...args); +} diff --git a/src/channels/read-only-account-inspect.discord.runtime.ts b/src/channels/read-only-account-inspect.discord.runtime.ts index 9d2ac6ef427..28db6fd4c1e 100644 --- a/src/channels/read-only-account-inspect.discord.runtime.ts +++ b/src/channels/read-only-account-inspect.discord.runtime.ts @@ -1,2 +1,11 @@ -export { inspectDiscordAccount } from "../plugin-sdk/discord.js"; +import { inspectDiscordAccount as inspectDiscordAccountImpl } from "../plugin-sdk/discord.js"; + export type { InspectedDiscordAccount } from "../plugin-sdk/discord.js"; + +type InspectDiscordAccount = typeof import("../plugin-sdk/discord.js").inspectDiscordAccount; + +export function inspectDiscordAccount( + ...args: Parameters +): ReturnType { + return inspectDiscordAccountImpl(...args); +} diff --git a/src/channels/read-only-account-inspect.slack.runtime.ts b/src/channels/read-only-account-inspect.slack.runtime.ts index a7526e2ea95..f2a9260b63e 100644 --- a/src/channels/read-only-account-inspect.slack.runtime.ts +++ b/src/channels/read-only-account-inspect.slack.runtime.ts @@ -1,2 +1,11 @@ -export { inspectSlackAccount } from "../plugin-sdk/slack.js"; +import { inspectSlackAccount as inspectSlackAccountImpl } from "../plugin-sdk/slack.js"; + export type { InspectedSlackAccount } from "../plugin-sdk/slack.js"; + +type InspectSlackAccount = typeof import("../plugin-sdk/slack.js").inspectSlackAccount; + +export function inspectSlackAccount( + ...args: Parameters +): ReturnType { + return inspectSlackAccountImpl(...args); +} diff --git a/src/channels/read-only-account-inspect.telegram.runtime.ts b/src/channels/read-only-account-inspect.telegram.runtime.ts index 0ab48f2c241..01c492dfffd 100644 --- a/src/channels/read-only-account-inspect.telegram.runtime.ts +++ b/src/channels/read-only-account-inspect.telegram.runtime.ts @@ -1,2 +1,11 @@ -export { inspectTelegramAccount } from "../plugin-sdk/telegram.js"; +import { inspectTelegramAccount as inspectTelegramAccountImpl } from "../plugin-sdk/telegram.js"; + export type { InspectedTelegramAccount } from "../plugin-sdk/telegram.js"; + +type InspectTelegramAccount = typeof import("../plugin-sdk/telegram.js").inspectTelegramAccount; + +export function inspectTelegramAccount( + ...args: Parameters +): ReturnType { + return inspectTelegramAccountImpl(...args); +} diff --git a/src/cli/send-runtime/discord.ts b/src/cli/send-runtime/discord.ts index 9ec4cf97247..13e8293085b 100644 --- a/src/cli/send-runtime/discord.ts +++ b/src/cli/send-runtime/discord.ts @@ -1 +1,9 @@ -export { sendMessageDiscord } from "../../plugin-sdk/discord.js"; +import { sendMessageDiscord as sendMessageDiscordImpl } from "../../plugin-sdk/discord.js"; + +type SendMessageDiscord = typeof import("../../plugin-sdk/discord.js").sendMessageDiscord; + +export async function sendMessageDiscord( + ...args: Parameters +): ReturnType { + return await sendMessageDiscordImpl(...args); +} diff --git a/src/cli/send-runtime/imessage.ts b/src/cli/send-runtime/imessage.ts index 3208aa24e00..eb5263a8b53 100644 --- a/src/cli/send-runtime/imessage.ts +++ b/src/cli/send-runtime/imessage.ts @@ -1 +1,9 @@ -export { sendMessageIMessage } from "../../plugin-sdk/imessage.js"; +import { sendMessageIMessage as sendMessageIMessageImpl } from "../../plugin-sdk/imessage.js"; + +type SendMessageIMessage = typeof import("../../plugin-sdk/imessage.js").sendMessageIMessage; + +export async function sendMessageIMessage( + ...args: Parameters +): ReturnType { + return await sendMessageIMessageImpl(...args); +} diff --git a/src/cli/send-runtime/signal.ts b/src/cli/send-runtime/signal.ts index 19a366168c8..a1e72eb1200 100644 --- a/src/cli/send-runtime/signal.ts +++ b/src/cli/send-runtime/signal.ts @@ -1 +1,9 @@ -export { sendMessageSignal } from "../../plugin-sdk/signal.js"; +import { sendMessageSignal as sendMessageSignalImpl } from "../../plugin-sdk/signal.js"; + +type SendMessageSignal = typeof import("../../plugin-sdk/signal.js").sendMessageSignal; + +export async function sendMessageSignal( + ...args: Parameters +): ReturnType { + return await sendMessageSignalImpl(...args); +} diff --git a/src/cli/send-runtime/slack.ts b/src/cli/send-runtime/slack.ts index 1f108ac0fdc..3bef60a98c2 100644 --- a/src/cli/send-runtime/slack.ts +++ b/src/cli/send-runtime/slack.ts @@ -1 +1,9 @@ -export { sendMessageSlack } from "../../plugin-sdk/slack.js"; +import { sendMessageSlack as sendMessageSlackImpl } from "../../plugin-sdk/slack.js"; + +type SendMessageSlack = typeof import("../../plugin-sdk/slack.js").sendMessageSlack; + +export async function sendMessageSlack( + ...args: Parameters +): ReturnType { + return await sendMessageSlackImpl(...args); +} diff --git a/src/cli/send-runtime/telegram.ts b/src/cli/send-runtime/telegram.ts index c0037ec1f0a..3c384baa853 100644 --- a/src/cli/send-runtime/telegram.ts +++ b/src/cli/send-runtime/telegram.ts @@ -1 +1,9 @@ -export { sendMessageTelegram } from "../../plugin-sdk/telegram.js"; +import { sendMessageTelegram as sendMessageTelegramImpl } from "../../plugin-sdk/telegram.js"; + +type SendMessageTelegram = typeof import("../../plugin-sdk/telegram.js").sendMessageTelegram; + +export async function sendMessageTelegram( + ...args: Parameters +): ReturnType { + return await sendMessageTelegramImpl(...args); +} diff --git a/src/cli/send-runtime/whatsapp.ts b/src/cli/send-runtime/whatsapp.ts index 00ec2f1ba09..f8b33db58c1 100644 --- a/src/cli/send-runtime/whatsapp.ts +++ b/src/cli/send-runtime/whatsapp.ts @@ -1 +1,9 @@ -export { sendMessageWhatsApp } from "../../plugin-sdk/whatsapp.js"; +import { sendMessageWhatsApp as sendMessageWhatsAppImpl } from "../../plugin-sdk/whatsapp.js"; + +type SendMessageWhatsApp = typeof import("../../plugin-sdk/whatsapp.js").sendMessageWhatsApp; + +export async function sendMessageWhatsApp( + ...args: Parameters +): ReturnType { + return await sendMessageWhatsAppImpl(...args); +} From c1ef5748ebe6c29229d9bbe57ecba8f67a3c3d19 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:15:24 -0700 Subject: [PATCH 073/187] refactor: enforce scoped plugin sdk imports --- extensions/discord/src/setup-core.ts | 2 +- extensions/discord/src/setup-surface.ts | 2 +- extensions/imessage/src/setup-core.ts | 2 +- extensions/imessage/src/setup-surface.ts | 5 +- extensions/imessage/src/shared.ts | 16 +++--- extensions/signal/src/setup-surface.ts | 5 +- extensions/slack/src/setup-core.ts | 2 +- extensions/slack/src/setup-surface.ts | 2 +- .../bot-native-commands.menu-test-support.ts | 2 +- extensions/telegram/src/setup-core.ts | 2 +- extensions/whatsapp/src/setup-surface.ts | 2 +- extensions/whatsapp/src/shared.ts | 18 +++--- ...-no-monolithic-plugin-sdk-entry-imports.ts | 24 ++++++++ .../channel-import-guardrails.test.ts | 55 ++++++++++++++++++- 14 files changed, 105 insertions(+), 34 deletions(-) diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 4425ed6adeb..7f4c1be29d3 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -13,13 +13,13 @@ import { setSetupChannelEnabled, type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { createAllowlistSetupWizardProxy, type ChannelSetupAdapter, type ChannelSetupDmPolicy, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 6373f89dbcf..be5a374d0fa 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -11,8 +11,8 @@ import { setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index 7543df157e8..bc99f521510 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -10,13 +10,13 @@ import { type OpenClawConfig, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy, ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index f01b4c03f93..6581fabbacd 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,7 +1,4 @@ -import { - setSetupChannelEnabled, - type ChannelSetupWizard, -} from "openclaw/plugin-sdk/setup"; +import { setSetupChannelEnabled, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { detectBinary } from "../../../src/plugins/setup-binary.js"; import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 5ce509f757d..1ede2ad412d 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -2,19 +2,19 @@ import { buildAccountScopedDmSecurityPolicy, collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; +import { + deleteAccountFromConfigSection, + setAccountEnabledInConfigSection, +} from "../../../src/channels/plugins/config-helpers.js"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { formatTrimmedAllowFromEntries, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, } from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { - deleteAccountFromConfigSection, - setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { listIMessageAccountIds, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index 2094e76da05..edcea39d6b1 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,7 +1,4 @@ -import { - setSetupChannelEnabled, - type ChannelSetupWizard, -} from "openclaw/plugin-sdk/setup"; +import { setSetupChannelEnabled, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { detectBinary } from "../../../src/plugins/setup-binary.js"; import { installSignalCli } from "../../../src/plugins/signal-cli-install.js"; import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 5cd7a71d22c..6cd9232b388 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -15,13 +15,13 @@ import { setLegacyChannelDmPolicyWithAllowFrom, setSetupChannelEnabled, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { type ChannelSetupAdapter, type ChannelSetupDmPolicy, type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 309dc669af8..4e3670ac843 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -14,12 +14,12 @@ import { setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import type { ChannelSetupDmPolicy, ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; +import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/bot-native-commands.menu-test-support.ts b/extensions/telegram/src/bot-native-commands.menu-test-support.ts index 8e67e625f93..e37634e7d55 100644 --- a/extensions/telegram/src/bot-native-commands.menu-test-support.ts +++ b/extensions/telegram/src/bot-native-commands.menu-test-support.ts @@ -1,4 +1,4 @@ -import type { RuntimeEnv } from "openclaw/plugin-sdk"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; import type { OpenClawConfig } from "openclaw/plugin-sdk/telegram"; import { expect, vi } from "vitest"; import { diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 10543aad1eb..f2b5fc04d77 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -9,9 +9,9 @@ import { type OpenClawConfig, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; import { formatCliCommand } from "../../../src/cli/command-format.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; -import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index 0975c28d444..7bee33c2ef4 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -10,9 +10,9 @@ import { type DmPolicy, type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; +import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { formatCliCommand } from "../../../src/cli/command-format.js"; import { formatDocsLink } from "../../../src/terminal/links.js"; -import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; import { whatsappSetupAdapter } from "./setup-core.js"; diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 6469d1cf18e..575954a516c 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -3,20 +3,20 @@ import { collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, } from "openclaw/plugin-sdk/channel-policy"; +import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; +import { + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupToolPolicy, +} from "../../../src/channels/plugins/group-mentions.js"; +import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; +import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; +import { getChatChannelMeta } from "../../../src/channels/registry.js"; +import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; import { formatWhatsAppConfigAllowFromEntries, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, } from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, -} from "../../../src/channels/plugins/group-mentions.js"; -import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; import { normalizeE164 } from "../../../src/utils.js"; import { diff --git a/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts b/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts index 32c4646009a..bc24087ace3 100644 --- a/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts +++ b/scripts/check-no-monolithic-plugin-sdk-entry-imports.ts @@ -68,6 +68,27 @@ function collectSharedExtensionSourceFiles(): string[] { return collectPluginSourceFiles(path.join(process.cwd(), "extensions", "shared")); } +function collectBundledExtensionSourceFiles(): string[] { + const extensionsDir = path.join(process.cwd(), "extensions"); + let entries: fs.Dirent[] = []; + try { + entries = fs.readdirSync(extensionsDir, { withFileTypes: true }); + } catch { + return []; + } + + const files: string[] = []; + for (const entry of entries) { + if (!entry.isDirectory() || entry.name === "shared") { + continue; + } + for (const srcFile of collectPluginSourceFiles(path.join(extensionsDir, entry.name))) { + files.push(srcFile); + } + } + return files; +} + function main() { const discovery = discoverOpenClawPlugins({}); const bundledCandidates = discovery.candidates.filter((c) => c.origin === "bundled"); @@ -81,6 +102,9 @@ function main() { for (const sharedFile of collectSharedExtensionSourceFiles()) { filesToCheck.add(sharedFile); } + for (const extensionFile of collectBundledExtensionSourceFiles()) { + filesToCheck.add(extensionFile); + } const monolithicOffenders: string[] = []; const legacyCompatOffenders: string[] = []; diff --git a/src/plugin-sdk/channel-import-guardrails.test.ts b/src/plugin-sdk/channel-import-guardrails.test.ts index 51905b66b02..447489b1a0f 100644 --- a/src/plugin-sdk/channel-import-guardrails.test.ts +++ b/src/plugin-sdk/channel-import-guardrails.test.ts @@ -1,4 +1,4 @@ -import { readFileSync } from "node:fs"; +import { readdirSync, readFileSync } from "node:fs"; import { dirname, resolve } from "node:path"; import { fileURLToPath } from "node:url"; import { describe, expect, it } from "vitest"; @@ -108,6 +108,47 @@ function readSetupBarrelImportBlock(path: string): string { return lines.slice(startLineIndex, targetLineIndex + 1).join("\n"); } +function collectExtensionSourceFiles(): string[] { + const extensionsDir = resolve(ROOT_DIR, "..", "extensions"); + const sharedExtensionsDir = resolve(extensionsDir, "shared"); + const files: string[] = []; + const stack = [extensionsDir]; + while (stack.length > 0) { + const current = stack.pop(); + if (!current) { + continue; + } + for (const entry of readdirSync(current, { withFileTypes: true })) { + const fullPath = resolve(current, entry.name); + if (entry.isDirectory()) { + if (entry.name === "node_modules" || entry.name === "dist" || entry.name === "coverage") { + continue; + } + stack.push(fullPath); + continue; + } + if (!entry.isFile() || !/\.(?:[cm]?ts|[cm]?js|tsx|jsx)$/u.test(entry.name)) { + continue; + } + if (entry.name.endsWith(".d.ts") || fullPath.includes(sharedExtensionsDir)) { + continue; + } + if (fullPath.includes(`${resolve(ROOT_DIR, "..", "extensions")}/shared/`)) { + continue; + } + if ( + fullPath.includes(".test.") || + fullPath.includes(".fixture.") || + fullPath.includes(".snap") + ) { + continue; + } + files.push(fullPath); + } + } + return files; +} + describe("channel import guardrails", () => { it("keeps channel helper modules off their own SDK barrels", () => { for (const source of SAME_CHANNEL_SDK_GUARDS) { @@ -128,4 +169,16 @@ describe("channel import guardrails", () => { } } }); + + it("keeps bundled extension source files off root and compat plugin-sdk imports", () => { + for (const file of collectExtensionSourceFiles()) { + const text = readFileSync(file, "utf8"); + expect(text, `${file} should not import openclaw/plugin-sdk root`).not.toMatch( + /["']openclaw\/plugin-sdk["']/, + ); + expect(text, `${file} should not import openclaw/plugin-sdk/compat`).not.toMatch( + /["']openclaw\/plugin-sdk\/compat["']/, + ); + } + }); }); From 618d35f933ac8184aff868ac990b9c12833d10e7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:20:27 -0700 Subject: [PATCH 074/187] feat(google): add image generation provider --- extensions/google/index.ts | 2 + .../providers/google.live.test.ts | 51 ++++++ src/image-generation/providers/google.test.ts | 134 +++++++++++++++ src/image-generation/providers/google.ts | 159 ++++++++++++++++++ src/plugin-sdk/image-generation.ts | 1 + .../contracts/registry.contract.test.ts | 11 ++ src/plugins/contracts/registry.ts | 2 +- 7 files changed, 359 insertions(+), 1 deletion(-) create mode 100644 src/image-generation/providers/google.live.test.ts create mode 100644 src/image-generation/providers/google.test.ts create mode 100644 src/image-generation/providers/google.ts diff --git a/extensions/google/index.ts b/extensions/google/index.ts index d310d8183a9..87872051cbd 100644 --- a/extensions/google/index.ts +++ b/extensions/google/index.ts @@ -1,4 +1,5 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { buildGoogleImageGenerationProvider } from "openclaw/plugin-sdk/image-generation"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { GOOGLE_GEMINI_DEFAULT_MODEL, @@ -51,6 +52,7 @@ const googlePlugin = { isModernModelRef: ({ modelId }) => isModernGoogleModel(modelId), }); registerGoogleGeminiCliProvider(api); + api.registerImageGenerationProvider(buildGoogleImageGenerationProvider()); api.registerMediaUnderstandingProvider(googleMediaUnderstandingProvider); api.registerWebSearchProvider( createPluginBackedWebSearchProvider({ diff --git a/src/image-generation/providers/google.live.test.ts b/src/image-generation/providers/google.live.test.ts new file mode 100644 index 00000000000..dcf2ddd1108 --- /dev/null +++ b/src/image-generation/providers/google.live.test.ts @@ -0,0 +1,51 @@ +import { describe, expect, it } from "vitest"; +import type { OpenClawConfig } from "../../config/config.js"; +import { isTruthyEnvValue } from "../../infra/env.js"; +import { buildGoogleImageGenerationProvider } from "./google.js"; + +const LIVE = + isTruthyEnvValue(process.env.GOOGLE_LIVE_TEST) || + isTruthyEnvValue(process.env.LIVE) || + isTruthyEnvValue(process.env.OPENCLAW_LIVE_TEST); +const HAS_KEY = Boolean(process.env.GEMINI_API_KEY?.trim() || process.env.GOOGLE_API_KEY?.trim()); +const MODEL = + process.env.GOOGLE_IMAGE_GENERATION_MODEL?.trim() || + process.env.GEMINI_IMAGE_GENERATION_MODEL?.trim() || + "gemini-3.1-flash-image-preview"; +const BASE_URL = process.env.GOOGLE_IMAGE_BASE_URL?.trim(); + +const describeLive = LIVE && HAS_KEY ? describe : describe.skip; + +function buildLiveConfig(): OpenClawConfig { + if (!BASE_URL) { + return {}; + } + return { + models: { + providers: { + google: { + baseUrl: BASE_URL, + }, + }, + }, + } as unknown as OpenClawConfig; +} + +describeLive("google image-generation live", () => { + it("generates a real image", async () => { + const provider = buildGoogleImageGenerationProvider(); + const result = await provider.generateImage({ + provider: "google", + model: MODEL, + prompt: + "Create a minimal flat illustration of an orange cat face sticker on a white background.", + cfg: buildLiveConfig(), + size: "1024x1024", + }); + + expect(result.model).toBeTruthy(); + expect(result.images.length).toBeGreaterThan(0); + expect(result.images[0]?.mimeType.startsWith("image/")).toBe(true); + expect(result.images[0]?.buffer.byteLength).toBeGreaterThan(512); + }, 120_000); +}); diff --git a/src/image-generation/providers/google.test.ts b/src/image-generation/providers/google.test.ts new file mode 100644 index 00000000000..83f7e565a80 --- /dev/null +++ b/src/image-generation/providers/google.test.ts @@ -0,0 +1,134 @@ +import { afterEach, describe, expect, it, vi } from "vitest"; +import * as modelAuth from "../../agents/model-auth.js"; +import { buildGoogleImageGenerationProvider } from "./google.js"; + +describe("Google image-generation provider", () => { + afterEach(() => { + vi.restoreAllMocks(); + }); + + it("generates image buffers from the Gemini generateContent API", async () => { + vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ + apiKey: "google-test-key", + source: "env", + mode: "api-key", + }); + const fetchMock = vi.fn().mockResolvedValue({ + ok: true, + json: async () => ({ + candidates: [ + { + content: { + parts: [ + { text: "generated" }, + { + inlineData: { + mimeType: "image/png", + data: Buffer.from("png-data").toString("base64"), + }, + }, + ], + }, + }, + ], + }), + }); + vi.stubGlobal("fetch", fetchMock); + + const provider = buildGoogleImageGenerationProvider(); + const result = await provider.generateImage({ + provider: "google", + model: "gemini-3.1-flash-image-preview", + prompt: "draw a cat", + cfg: {}, + size: "1536x1024", + }); + + expect(fetchMock).toHaveBeenCalledWith( + "https://generativelanguage.googleapis.com/v1beta/models/gemini-3.1-flash-image-preview:generateContent", + expect.objectContaining({ + method: "POST", + body: JSON.stringify({ + contents: [ + { + role: "user", + parts: [{ text: "draw a cat" }], + }, + ], + generationConfig: { + responseModalities: ["TEXT", "IMAGE"], + imageConfig: { + aspectRatio: "3:2", + imageSize: "2K", + }, + }, + }), + }), + ); + expect(result).toEqual({ + images: [ + { + buffer: Buffer.from("png-data"), + mimeType: "image/png", + fileName: "image-1.png", + }, + ], + model: "gemini-3.1-flash-image-preview", + }); + }); + + it("accepts OAuth JSON auth and inline_data responses", async () => { + vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ + apiKey: JSON.stringify({ token: "oauth-token" }), + source: "profile", + mode: "token", + }); + const fetchMock = vi.fn().mockResolvedValue({ + ok: true, + json: async () => ({ + candidates: [ + { + content: { + parts: [ + { + inline_data: { + mime_type: "image/jpeg", + data: Buffer.from("jpg-data").toString("base64"), + }, + }, + ], + }, + }, + ], + }), + }); + vi.stubGlobal("fetch", fetchMock); + + const provider = buildGoogleImageGenerationProvider(); + const result = await provider.generateImage({ + provider: "google", + model: "gemini-3.1-flash-image-preview", + prompt: "draw a dog", + cfg: {}, + }); + + expect(fetchMock).toHaveBeenCalledWith( + expect.any(String), + expect.objectContaining({ + headers: expect.any(Headers), + }), + ); + const [, init] = fetchMock.mock.calls[0]; + expect(new Headers(init.headers).get("authorization")).toBe("Bearer oauth-token"); + expect(result).toEqual({ + images: [ + { + buffer: Buffer.from("jpg-data"), + mimeType: "image/jpeg", + fileName: "image-1.jpg", + }, + ], + model: "gemini-3.1-flash-image-preview", + }); + }); +}); diff --git a/src/image-generation/providers/google.ts b/src/image-generation/providers/google.ts new file mode 100644 index 00000000000..0519aef7bc3 --- /dev/null +++ b/src/image-generation/providers/google.ts @@ -0,0 +1,159 @@ +import { resolveApiKeyForProvider } from "../../agents/model-auth.js"; +import { normalizeGoogleModelId } from "../../agents/model-id-normalization.js"; +import { parseGeminiAuth } from "../../infra/gemini-auth.js"; +import { + assertOkOrThrowHttpError, + normalizeBaseUrl, + postJsonRequest, +} from "../../media-understanding/providers/shared.js"; +import type { ImageGenerationProviderPlugin } from "../../plugins/types.js"; + +const DEFAULT_GOOGLE_IMAGE_BASE_URL = "https://generativelanguage.googleapis.com/v1beta"; +const DEFAULT_GOOGLE_IMAGE_MODEL = "gemini-3.1-flash-image-preview"; +const DEFAULT_OUTPUT_MIME = "image/png"; +const DEFAULT_ASPECT_RATIO = "1:1"; + +type GoogleInlineDataPart = { + mimeType?: string; + mime_type?: string; + data?: string; +}; + +type GoogleGenerateImageResponse = { + candidates?: Array<{ + content?: { + parts?: Array<{ + text?: string; + inlineData?: GoogleInlineDataPart; + inline_data?: GoogleInlineDataPart; + }>; + }; + }>; +}; + +function resolveGoogleBaseUrl(cfg: Parameters[0]["cfg"]): string { + const direct = cfg?.models?.providers?.google?.baseUrl?.trim(); + return direct || DEFAULT_GOOGLE_IMAGE_BASE_URL; +} + +function normalizeGoogleImageModel(model: string | undefined): string { + const trimmed = model?.trim(); + return normalizeGoogleModelId(trimmed || DEFAULT_GOOGLE_IMAGE_MODEL); +} + +function mapSizeToImageConfig( + size: string | undefined, +): { aspectRatio?: string; imageSize?: "2K" | "4K" } | undefined { + const trimmed = size?.trim(); + if (!trimmed) { + return { aspectRatio: DEFAULT_ASPECT_RATIO }; + } + + const normalized = trimmed.toLowerCase(); + const mapping = new Map([ + ["1024x1024", "1:1"], + ["1024x1536", "2:3"], + ["1536x1024", "3:2"], + ["1024x1792", "9:16"], + ["1792x1024", "16:9"], + ]); + const aspectRatio = mapping.get(normalized); + + const [widthRaw, heightRaw] = normalized.split("x"); + const width = Number.parseInt(widthRaw ?? "", 10); + const height = Number.parseInt(heightRaw ?? "", 10); + const longestEdge = Math.max(width, height); + const imageSize = longestEdge >= 3072 ? "4K" : longestEdge >= 1536 ? "2K" : undefined; + + if (!aspectRatio && !imageSize) { + return undefined; + } + + return { + ...(aspectRatio ? { aspectRatio } : {}), + ...(imageSize ? { imageSize } : {}), + }; +} + +export function buildGoogleImageGenerationProvider(): ImageGenerationProviderPlugin { + return { + id: "google", + label: "Google", + async generateImage(req) { + const auth = await resolveApiKeyForProvider({ + provider: "google", + cfg: req.cfg, + agentDir: req.agentDir, + }); + if (!auth.apiKey) { + throw new Error("Google API key missing"); + } + + const model = normalizeGoogleImageModel(req.model); + const baseUrl = normalizeBaseUrl( + resolveGoogleBaseUrl(req.cfg), + DEFAULT_GOOGLE_IMAGE_BASE_URL, + ); + const allowPrivate = Boolean(req.cfg?.models?.providers?.google?.baseUrl?.trim()); + const authHeaders = parseGeminiAuth(auth.apiKey); + const headers = new Headers(authHeaders.headers); + const imageConfig = mapSizeToImageConfig(req.size); + + const { response: res, release } = await postJsonRequest({ + url: `${baseUrl}/models/${model}:generateContent`, + headers, + body: { + contents: [ + { + role: "user", + parts: [{ text: req.prompt }], + }, + ], + generationConfig: { + responseModalities: ["TEXT", "IMAGE"], + ...(imageConfig ? { imageConfig } : {}), + }, + }, + timeoutMs: 60_000, + fetchFn: fetch, + allowPrivateNetwork: allowPrivate, + }); + + try { + await assertOkOrThrowHttpError(res, "Google image generation failed"); + + const payload = (await res.json()) as GoogleGenerateImageResponse; + let imageIndex = 0; + const images = (payload.candidates ?? []) + .flatMap((candidate) => candidate.content?.parts ?? []) + .map((part) => { + const inline = part.inlineData ?? part.inline_data; + const data = inline?.data?.trim(); + if (!data) { + return null; + } + const mimeType = inline?.mimeType ?? inline?.mime_type ?? DEFAULT_OUTPUT_MIME; + const extension = mimeType.includes("jpeg") ? "jpg" : (mimeType.split("/")[1] ?? "png"); + imageIndex += 1; + return { + buffer: Buffer.from(data, "base64"), + mimeType, + fileName: `image-${imageIndex}.${extension}`, + }; + }) + .filter((entry): entry is NonNullable => entry !== null); + + if (images.length === 0) { + throw new Error("Google image generation response missing image data"); + } + + return { + images, + model, + }; + } finally { + await release(); + } + }, + }; +} diff --git a/src/plugin-sdk/image-generation.ts b/src/plugin-sdk/image-generation.ts index 9ca98074743..d9afa8b3a3d 100644 --- a/src/plugin-sdk/image-generation.ts +++ b/src/plugin-sdk/image-generation.ts @@ -7,4 +7,5 @@ export type { ImageGenerationResult, } from "../image-generation/types.js"; +export { buildGoogleImageGenerationProvider } from "../image-generation/providers/google.js"; export { buildOpenAIImageGenerationProvider } from "../image-generation/providers/openai.js"; diff --git a/src/plugins/contracts/registry.contract.test.ts b/src/plugins/contracts/registry.contract.test.ts index 762612cc45a..997aa560579 100644 --- a/src/plugins/contracts/registry.contract.test.ts +++ b/src/plugins/contracts/registry.contract.test.ts @@ -165,6 +165,7 @@ describe("plugin contract registry", () => { }); it("keeps bundled image-generation ownership explicit", () => { + expect(findImageGenerationProviderIdsForPlugin("google")).toEqual(["google"]); expect(findImageGenerationProviderIdsForPlugin("openai")).toEqual(["openai"]); }); @@ -180,6 +181,13 @@ describe("plugin contract registry", () => { }); it("tracks speech registrations on bundled provider plugins", () => { + expect(findRegistrationForPlugin("google")).toMatchObject({ + providerIds: ["google", "google-gemini-cli"], + speechProviderIds: [], + mediaUnderstandingProviderIds: ["google"], + imageGenerationProviderIds: ["google"], + webSearchProviderIds: ["gemini"], + }); expect(findRegistrationForPlugin("openai")).toMatchObject({ providerIds: ["openai", "openai-codex"], speechProviderIds: ["openai"], @@ -245,6 +253,9 @@ describe("plugin contract registry", () => { }); it("keeps bundled image-generation support explicit", () => { + expect(findImageGenerationProviderForPlugin("google").generateImage).toEqual( + expect.any(Function), + ); expect(findImageGenerationProviderForPlugin("openai").generateImage).toEqual( expect.any(Function), ); diff --git a/src/plugins/contracts/registry.ts b/src/plugins/contracts/registry.ts index a4d2f815d7b..adedfe57d0c 100644 --- a/src/plugins/contracts/registry.ts +++ b/src/plugins/contracts/registry.ts @@ -131,7 +131,7 @@ const bundledMediaUnderstandingPlugins: RegistrablePlugin[] = [ zaiPlugin, ]; -const bundledImageGenerationPlugins: RegistrablePlugin[] = [openAIPlugin]; +const bundledImageGenerationPlugins: RegistrablePlugin[] = [googlePlugin, openAIPlugin]; function captureRegistrations(plugin: RegistrablePlugin) { const captured = createCapturedPluginRegistration(); From c601dda389989e96280dbb7a850fad838ef97c3e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:20:28 -0700 Subject: [PATCH 075/187] docs(image-generation): document google provider --- docs/gateway/configuration-reference.md | 1 + docs/help/testing.md | 9 +++++++++ docs/tools/capability-cookbook.md | 2 +- docs/tools/plugin.md | 6 ++++-- 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index 910b6db2b62..ee823da9cac 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -877,6 +877,7 @@ Time format in system prompt. Default: `auto` (OS preference). }, imageGenerationModel: { primary: "openai/gpt-image-1", + fallbacks: ["google/gemini-3.1-flash-image-preview"], }, pdfModel: { primary: "anthropic/claude-opus-4-6", diff --git a/docs/help/testing.md b/docs/help/testing.md index ab63db23670..f3315fa6faa 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -360,6 +360,15 @@ If you want to rely on env keys (e.g. exported in your `~/.profile`), run local - Enable: `BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - Optional model override: `BYTEPLUS_CODING_MODEL=ark-code-latest` +## Google image generation live + +- Test: `src/image-generation/providers/google.live.test.ts` +- Enable: `GOOGLE_LIVE_TEST=1 pnpm test:live src/image-generation/providers/google.live.test.ts` +- Key source: `GEMINI_API_KEY` or `GOOGLE_API_KEY` +- Optional overrides: + - `GOOGLE_IMAGE_GENERATION_MODEL=gemini-3.1-flash-image-preview` + - `GOOGLE_IMAGE_BASE_URL=https://generativelanguage.googleapis.com/v1beta` + ## Docker runners (optional “works in Linux” checks) These run `pnpm test:live` inside the repo Docker image, mounting your local config dir and workspace (and sourcing `~/.profile` if mounted). They also bind-mount CLI auth homes like `~/.codex`, `~/.claude`, `~/.qwen`, and `~/.minimax` when present, then copy them into the container home before the run so external-CLI OAuth can refresh tokens without mutating the host auth store: diff --git a/docs/tools/capability-cookbook.md b/docs/tools/capability-cookbook.md index 345c7b1ebd6..5cfc94ef3c0 100644 --- a/docs/tools/capability-cookbook.md +++ b/docs/tools/capability-cookbook.md @@ -88,7 +88,7 @@ Image generation follows the standard shape: 1. core defines `ImageGenerationProvider` 2. core exposes `registerImageGenerationProvider(...)` 3. core exposes `runtime.imageGeneration.generate(...)` -4. the `openai` plugin registers an OpenAI-backed implementation +4. the `openai` and `google` plugins register vendor-backed implementations 5. future vendors can register the same contract without changing channels/tools The config key is separate from vision-analysis routing: diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 77ff383feb6..b0eec032bcf 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -116,8 +116,10 @@ Examples: speech + media-understanding + image-generation behavior - the bundled `elevenlabs` plugin owns ElevenLabs speech behavior - the bundled `microsoft` plugin owns Microsoft speech behavior -- the bundled `google`, `minimax`, `mistral`, `moonshot`, and `zai` plugins own - their media-understanding backends +- the bundled `google` plugin owns Google model-provider behavior plus Google + media-understanding + image-generation + web-search behavior +- the bundled `minimax`, `mistral`, `moonshot`, and `zai` plugins own their + media-understanding backends - the `voice-call` plugin is a feature plugin: it owns call transport, tools, CLI, routes, and runtime, but it consumes core TTS/STT capability instead of inventing a second speech stack From 2280fa00220b47989e4c596237f31c9ea76eb41e Mon Sep 17 00:00:00 2001 From: Nimrod Gutman Date: Tue, 17 Mar 2026 08:21:43 +0200 Subject: [PATCH 076/187] fix(plugins): normalize speech plugin package ids (#48777) --- src/plugins/discovery.test.ts | 40 +++++++++++++++++++++++++++++++++++ src/plugins/discovery.ts | 15 +++++++------ 2 files changed, 49 insertions(+), 6 deletions(-) diff --git a/src/plugins/discovery.test.ts b/src/plugins/discovery.test.ts index ea84b562729..7a6d9d54578 100644 --- a/src/plugins/discovery.test.ts +++ b/src/plugins/discovery.test.ts @@ -219,6 +219,46 @@ describe("discoverOpenClawPlugins", () => { expect(ids).not.toContain("ollama-provider"); }); + it("normalizes bundled speech package ids to canonical plugin ids", async () => { + const stateDir = makeTempDir(); + const extensionsDir = path.join(stateDir, "extensions"); + const elevenlabsDir = path.join(extensionsDir, "elevenlabs-speech-pack"); + const microsoftDir = path.join(extensionsDir, "microsoft-speech-pack"); + + mkdirSafe(path.join(elevenlabsDir, "src")); + mkdirSafe(path.join(microsoftDir, "src")); + + writePluginPackageManifest({ + packageDir: elevenlabsDir, + packageName: "@openclaw/elevenlabs-speech", + extensions: ["./src/index.ts"], + }); + writePluginPackageManifest({ + packageDir: microsoftDir, + packageName: "@openclaw/microsoft-speech", + extensions: ["./src/index.ts"], + }); + + fs.writeFileSync( + path.join(elevenlabsDir, "src", "index.ts"), + "export default function () {}", + "utf-8", + ); + fs.writeFileSync( + path.join(microsoftDir, "src", "index.ts"), + "export default function () {}", + "utf-8", + ); + + const { candidates } = await discoverWithStateDir(stateDir, {}); + + const ids = candidates.map((c) => c.idHint); + expect(ids).toContain("elevenlabs"); + expect(ids).toContain("microsoft"); + expect(ids).not.toContain("elevenlabs-speech"); + expect(ids).not.toContain("microsoft-speech"); + }); + it("treats configured directory paths as plugin packages", async () => { const stateDir = makeTempDir(); const packDir = path.join(stateDir, "packs", "demo-plugin-dir"); diff --git a/src/plugins/discovery.ts b/src/plugins/discovery.ts index 743b0b569f9..24d4765e31b 100644 --- a/src/plugins/discovery.ts +++ b/src/plugins/discovery.ts @@ -16,6 +16,14 @@ import type { PluginBundleFormat, PluginDiagnostic, PluginFormat, PluginOrigin } const EXTENSION_EXTS = new Set([".ts", ".js", ".mts", ".cts", ".mjs", ".cjs"]); +const CANONICAL_PACKAGE_ID_ALIASES: Record = { + "elevenlabs-speech": "elevenlabs", + "microsoft-speech": "microsoft", + "ollama-provider": "ollama", + "sglang-provider": "sglang", + "vllm-provider": "vllm", +}; + export type PluginCandidate = { idHint: string; source: string; @@ -337,12 +345,7 @@ function deriveIdHint(params: { const unscoped = rawPackageName.includes("/") ? (rawPackageName.split("/").pop() ?? rawPackageName) : rawPackageName; - const canonicalPackageId = - { - "ollama-provider": "ollama", - "sglang-provider": "sglang", - "vllm-provider": "vllm", - }[unscoped] ?? unscoped; + const canonicalPackageId = CANONICAL_PACKAGE_ID_ALIASES[unscoped] ?? unscoped; if (!params.hasMultipleExtensions) { return canonicalPackageId; From a6bee2524784739e46d645d52e686c3c0c31cf13 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:21:22 +0000 Subject: [PATCH 077/187] refactor(slack): share setup wizard base --- extensions/slack/src/setup-surface.ts | 303 ++++++-------------------- 1 file changed, 66 insertions(+), 237 deletions(-) diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 4e3670ac843..063129267cf 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,50 +1,22 @@ import { - DEFAULT_ACCOUNT_ID, - hasConfiguredSecretInput, noteChannelLookupFailure, noteChannelLookupSummary, - normalizeAccountId, type OpenClawConfig, parseMentionOrPrefixedId, - patchChannelConfigForAccount, promptLegacyChannelAllowFrom, resolveSetupAccountId, - setAccountGroupPolicyForChannel, - setLegacyChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { - ChannelSetupDmPolicy, ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "../../../src/terminal/links.js"; -import { inspectSlackAccount } from "./account-inspect.js"; -import { - listSlackAccountIds, - resolveDefaultSlackAccountId, - resolveSlackAccount, - type ResolvedSlackAccount, -} from "./accounts.js"; +import { resolveDefaultSlackAccountId, resolveSlackAccount } from "./accounts.js"; import { resolveSlackChannelAllowlist } from "./resolve-channels.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; -import { slackSetupAdapter } from "./setup-core.js"; -import { - buildSlackSetupLines, - isSlackSetupAccountConfigured, - setSlackChannelAllowlist, - SLACK_CHANNEL as channel, -} from "./shared.js"; - -function enableSlackAccount(cfg: OpenClawConfig, accountId: string): OpenClawConfig { - return patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { enabled: true }, - }); -} +import { createSlackSetupWizardBase } from "./setup-core.js"; +import { SLACK_CHANNEL as channel } from "./shared.js"; async function resolveSlackAllowFromEntries(params: { token?: string; @@ -117,211 +89,68 @@ async function promptSlackAllowFrom(params: { }); } -const slackDmPolicy: ChannelSetupDmPolicy = { - label: "Slack", - channel, - policyKey: "channels.slack.dmPolicy", - allowFromKey: "channels.slack.allowFrom", - getCurrent: (cfg) => - cfg.channels?.slack?.dmPolicy ?? cfg.channels?.slack?.dm?.policy ?? "pairing", - setPolicy: (cfg, policy) => - setLegacyChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptSlackAllowFrom, -}; - -export const slackSetupWizard: ChannelSetupWizard = { - channel, - status: { - configuredLabel: "configured", - unconfiguredLabel: "needs tokens", - configuredHint: "configured", - unconfiguredHint: "needs tokens", - configuredScore: 2, - unconfiguredScore: 1, - resolveConfigured: ({ cfg }) => - listSlackAccountIds(cfg).some((accountId) => { - const account = inspectSlackAccount({ cfg, accountId }); - return account.configured; - }), - }, - introNote: { - title: "Slack socket mode tokens", - lines: buildSlackSetupLines(), - shouldShow: ({ cfg, accountId }) => - !isSlackSetupAccountConfigured(resolveSlackAccount({ cfg, accountId })), - }, - envShortcut: { - prompt: "SLACK_BOT_TOKEN + SLACK_APP_TOKEN detected. Use env vars?", - preferredEnvVar: "SLACK_BOT_TOKEN", - isAvailable: ({ cfg, accountId }) => - accountId === DEFAULT_ACCOUNT_ID && - Boolean(process.env.SLACK_BOT_TOKEN?.trim()) && - Boolean(process.env.SLACK_APP_TOKEN?.trim()) && - !isSlackSetupAccountConfigured(resolveSlackAccount({ cfg, accountId })), - apply: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), - }, - credentials: [ - { - inputKey: "botToken", - providerHint: "slack-bot", - credentialLabel: "Slack bot token", - preferredEnvVar: "SLACK_BOT_TOKEN", - envPrompt: "SLACK_BOT_TOKEN detected. Use env var?", - keepPrompt: "Slack bot token already configured. Keep it?", - inputPrompt: "Enter Slack bot token (xoxb-...)", - allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }) => { - const resolved = resolveSlackAccount({ cfg, accountId }); - return { - accountConfigured: - Boolean(resolved.botToken) || hasConfiguredSecretInput(resolved.config.botToken), - hasConfiguredValue: hasConfiguredSecretInput(resolved.config.botToken), - resolvedValue: resolved.botToken?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_BOT_TOKEN?.trim() : undefined, - }; - }, - applyUseEnv: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), - applySet: ({ cfg, accountId, value }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { - enabled: true, - botToken: value, - }, - }), - }, - { - inputKey: "appToken", - providerHint: "slack-app", - credentialLabel: "Slack app token", - preferredEnvVar: "SLACK_APP_TOKEN", - envPrompt: "SLACK_APP_TOKEN detected. Use env var?", - keepPrompt: "Slack app token already configured. Keep it?", - inputPrompt: "Enter Slack app token (xapp-...)", - allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }) => { - const resolved = resolveSlackAccount({ cfg, accountId }); - return { - accountConfigured: - Boolean(resolved.appToken) || hasConfiguredSecretInput(resolved.config.appToken), - hasConfiguredValue: hasConfiguredSecretInput(resolved.config.appToken), - resolvedValue: resolved.appToken?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_APP_TOKEN?.trim() : undefined, - }; - }, - applyUseEnv: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), - applySet: ({ cfg, accountId, value }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { - enabled: true, - appToken: value, - }, - }), - }, - ], - dmPolicy: slackDmPolicy, - allowFrom: { - helpTitle: "Slack allowlist", - helpLines: [ - "Allowlist Slack DMs by username (we resolve to user ids).", - "Examples:", - "- U12345678", - "- @alice", - "Multiple entries: comma-separated.", - `Docs: ${formatDocsLink("/slack", "slack")}`, - ], - credentialInputKey: "botToken", - message: "Slack allowFrom (usernames or ids)", - placeholder: "@alice, U12345678", - invalidWithoutCredentialNote: "Slack token missing; use user ids (or mention form) only.", - parseId: (value) => - parseMentionOrPrefixedId({ - value, - mentionPattern: /^<@([A-Z0-9]+)>$/i, - prefixPattern: /^(slack:|user:)/i, - idPattern: /^[A-Z][A-Z0-9]+$/i, - normalizeId: (id) => id.toUpperCase(), - }), - resolveEntries: async ({ credentialValues, entries }) => - await resolveSlackAllowFromEntries({ - token: credentialValues.botToken, - entries, - }), - apply: ({ cfg, accountId, allowFrom }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { dmPolicy: "allowlist", allowFrom }, - }), - }, - groupAccess: { - label: "Slack channels", - placeholder: "#general, #private, C123", - currentPolicy: ({ cfg, accountId }) => - resolveSlackAccount({ cfg, accountId }).config.groupPolicy ?? "allowlist", - currentEntries: ({ cfg, accountId }) => - Object.entries(resolveSlackAccount({ cfg, accountId }).config.channels ?? {}) - .filter(([, value]) => value?.allow !== false && value?.enabled !== false) - .map(([key]) => key), - updatePrompt: ({ cfg, accountId }) => - Boolean(resolveSlackAccount({ cfg, accountId }).config.channels), - setPolicy: ({ cfg, accountId, policy }) => - setAccountGroupPolicyForChannel({ - cfg, - channel, - accountId, - groupPolicy: policy, - }), - resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - let keys = entries; - const accountWithTokens = resolveSlackAccount({ - cfg, - accountId, +async function resolveSlackGroupAllowlist(params: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { botToken?: string }; + entries: string[]; + prompter: { note: (message: string, title?: string) => Promise }; +}) { + let keys = params.entries; + const accountWithTokens = resolveSlackAccount({ + cfg: params.cfg, + accountId: params.accountId, + }); + const activeBotToken = accountWithTokens.botToken || params.credentialValues.botToken || ""; + if (activeBotToken && params.entries.length > 0) { + try { + const resolved = await resolveSlackChannelAllowlist({ + token: activeBotToken, + entries: params.entries, }); - const activeBotToken = accountWithTokens.botToken || credentialValues.botToken || ""; - if (activeBotToken && entries.length > 0) { - try { - const resolved = await resolveSlackChannelAllowlist({ - token: activeBotToken, - entries, - }); - const resolvedKeys = resolved - .filter((entry) => entry.resolved && entry.id) - .map((entry) => entry.id as string); - const unresolved = resolved - .filter((entry) => !entry.resolved) - .map((entry) => entry.input); - keys = [...resolvedKeys, ...unresolved.map((entry) => entry.trim()).filter(Boolean)]; - await noteChannelLookupSummary({ - prompter, - label: "Slack channels", - resolvedSections: [{ title: "Resolved", values: resolvedKeys }], - unresolved, - }); - } catch (error) { - await noteChannelLookupFailure({ - prompter, - label: "Slack channels", - error, - }); - } - } - return keys; + const resolvedKeys = resolved + .filter((entry) => entry.resolved && entry.id) + .map((entry) => entry.id as string); + const unresolved = resolved.filter((entry) => !entry.resolved).map((entry) => entry.input); + keys = [...resolvedKeys, ...unresolved.map((entry) => entry.trim()).filter(Boolean)]; + await noteChannelLookupSummary({ + prompter: params.prompter, + label: "Slack channels", + resolvedSections: [{ title: "Resolved", values: resolvedKeys }], + unresolved, + }); + } catch (error) { + await noteChannelLookupFailure({ + prompter: params.prompter, + label: "Slack channels", + error, + }); + } + } + return keys; +} + +export const slackSetupWizard: ChannelSetupWizard = createSlackSetupWizardBase(async () => ({ + slackSetupWizard: { + dmPolicy: { + promptAllowFrom: promptSlackAllowFrom, }, - applyAllowlist: ({ cfg, accountId, resolved }) => - setSlackChannelAllowlist(cfg, accountId, resolved as string[]), - }, - disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), -}; + allowFrom: { + resolveEntries: async ({ credentialValues, entries }) => + await resolveSlackAllowFromEntries({ + token: credentialValues.botToken, + entries, + }), + }, + groupAccess: { + resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => + await resolveSlackGroupAllowlist({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }), + }, + } as ChannelSetupWizard, +})); From f1df31eeef1c27c2fda1ea4b29bde4f2bfe514d0 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:22:43 +0000 Subject: [PATCH 078/187] refactor(discord): share setup wizard base --- extensions/discord/src/setup-surface.ts | 237 +++++------------------- 1 file changed, 44 insertions(+), 193 deletions(-) diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index be5a374d0fa..9c1ce7f5f1c 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,24 +1,12 @@ import { - DEFAULT_ACCOUNT_ID, - noteChannelLookupFailure, - noteChannelLookupSummary, type OpenClawConfig, - parseMentionOrPrefixedId, - patchChannelConfigForAccount, promptLegacyChannelAllowFrom, resolveSetupAccountId, - setLegacyChannelDmPolicyWithAllowFrom, - setSetupChannelEnabled, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; -import { type ChannelSetupDmPolicy, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; +import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; import { formatDocsLink } from "../../../src/terminal/links.js"; -import { inspectDiscordAccount } from "./account-inspect.js"; -import { - listDiscordAccountIds, - resolveDefaultDiscordAccountId, - resolveDiscordAccount, -} from "./accounts.js"; +import { resolveDefaultDiscordAccountId, resolveDiscordAccount } from "./accounts.js"; import { normalizeDiscordSlug } from "./monitor/allow-list.js"; import { resolveDiscordChannelAllowlist, @@ -26,7 +14,7 @@ import { } from "./resolve-channels.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { - discordSetupAdapter, + createDiscordSetupWizardBase, DISCORD_TOKEN_HELP_LINES, parseDiscordAllowFromId, setDiscordGuildChannelAllowlist, @@ -91,186 +79,49 @@ async function promptDiscordAllowFrom(params: { }); } -const discordDmPolicy: ChannelSetupDmPolicy = { - label: "Discord", - channel, - policyKey: "channels.discord.dmPolicy", - allowFromKey: "channels.discord.allowFrom", - getCurrent: (cfg) => - cfg.channels?.discord?.dmPolicy ?? cfg.channels?.discord?.dm?.policy ?? "pairing", - setPolicy: (cfg, policy) => - setLegacyChannelDmPolicyWithAllowFrom({ - cfg, - channel, - dmPolicy: policy, - }), - promptAllowFrom: promptDiscordAllowFrom, -}; +async function resolveDiscordGroupAllowlist(params: { + cfg: OpenClawConfig; + accountId: string; + credentialValues: { token?: string }; + entries: string[]; +}) { + const token = + resolveDiscordAccount({ cfg: params.cfg, accountId: params.accountId }).token || + (typeof params.credentialValues.token === "string" ? params.credentialValues.token : ""); + if (!token || params.entries.length === 0) { + return params.entries.map((input) => ({ + input, + resolved: false, + })); + } + return await resolveDiscordChannelAllowlist({ + token, + entries: params.entries, + }); +} -export const discordSetupWizard: ChannelSetupWizard = { - channel, - status: { - configuredLabel: "configured", - unconfiguredLabel: "needs token", - configuredHint: "configured", - unconfiguredHint: "needs token", - configuredScore: 2, - unconfiguredScore: 1, - resolveConfigured: ({ cfg }) => - listDiscordAccountIds(cfg).some( - (accountId) => inspectDiscordAccount({ cfg, accountId }).configured, - ), - }, - credentials: [ - { - inputKey: "token", - providerHint: channel, - credentialLabel: "Discord bot token", - preferredEnvVar: "DISCORD_BOT_TOKEN", - helpTitle: "Discord bot token", - helpLines: DISCORD_TOKEN_HELP_LINES, - envPrompt: "DISCORD_BOT_TOKEN detected. Use env var?", - keepPrompt: "Discord token already configured. Keep it?", - inputPrompt: "Enter Discord bot token", - allowEnv: ({ accountId }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }) => { - const account = inspectDiscordAccount({ cfg, accountId }); - return { - accountConfigured: account.configured, - hasConfiguredValue: account.tokenStatus !== "missing", - resolvedValue: account.token?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID - ? process.env.DISCORD_BOT_TOKEN?.trim() || undefined - : undefined, - }; - }, +export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase(async () => ({ + discordSetupWizard: { + dmPolicy: { + promptAllowFrom: promptDiscordAllowFrom, }, - ], - groupAccess: { - label: "Discord channels", - placeholder: "My Server/#general, guildId/channelId, #support", - currentPolicy: ({ cfg, accountId }) => - resolveDiscordAccount({ cfg, accountId }).config.groupPolicy ?? "allowlist", - currentEntries: ({ cfg, accountId }) => - Object.entries(resolveDiscordAccount({ cfg, accountId }).config.guilds ?? {}).flatMap( - ([guildKey, value]) => { - const channels = value?.channels ?? {}; - const channelKeys = Object.keys(channels); - if (channelKeys.length === 0) { - const input = /^\d+$/.test(guildKey) ? `guild:${guildKey}` : guildKey; - return [input]; - } - return channelKeys.map((channelKey) => `${guildKey}/${channelKey}`); - }, - ), - updatePrompt: ({ cfg, accountId }) => - Boolean(resolveDiscordAccount({ cfg, accountId }).config.guilds), - setPolicy: ({ cfg, accountId, policy }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { groupPolicy: policy }, - }), - resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => { - const token = - resolveDiscordAccount({ cfg, accountId }).token || - (typeof credentialValues.token === "string" ? credentialValues.token : ""); - let resolved: DiscordChannelResolution[] = entries.map((input) => ({ - input, - resolved: false, - })); - if (!token || entries.length === 0) { - return resolved; - } - try { - resolved = await resolveDiscordChannelAllowlist({ - token, + groupAccess: { + resolveAllowlist: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordGroupAllowlist({ + cfg, + accountId, + credentialValues, entries, - }); - const resolvedChannels = resolved.filter((entry) => entry.resolved && entry.channelId); - const resolvedGuilds = resolved.filter( - (entry) => entry.resolved && entry.guildId && !entry.channelId, - ); - const unresolved = resolved.filter((entry) => !entry.resolved).map((entry) => entry.input); - await noteChannelLookupSummary({ - prompter, - label: "Discord channels", - resolvedSections: [ - { - title: "Resolved channels", - values: resolvedChannels - .map((entry) => entry.channelId) - .filter((value): value is string => Boolean(value)), - }, - { - title: "Resolved guilds", - values: resolvedGuilds - .map((entry) => entry.guildId) - .filter((value): value is string => Boolean(value)), - }, - ], - unresolved, - }); - } catch (error) { - await noteChannelLookupFailure({ - prompter, - label: "Discord channels", - error, - }); - } - return resolved; + }), }, - applyAllowlist: ({ cfg, accountId, resolved }) => { - const allowlistEntries: Array<{ guildKey: string; channelKey?: string }> = []; - for (const entry of resolved as DiscordChannelResolution[]) { - const guildKey = - entry.guildId ?? - (entry.guildName ? normalizeDiscordSlug(entry.guildName) : undefined) ?? - "*"; - const channelKey = - entry.channelId ?? - (entry.channelName ? normalizeDiscordSlug(entry.channelName) : undefined); - if (!channelKey && guildKey === "*") { - continue; - } - allowlistEntries.push({ guildKey, ...(channelKey ? { channelKey } : {}) }); - } - return setDiscordGuildChannelAllowlist(cfg, accountId, allowlistEntries); + allowFrom: { + resolveEntries: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordAllowFromEntries({ + token: + resolveDiscordAccount({ cfg, accountId }).token || + (typeof credentialValues.token === "string" ? credentialValues.token : ""), + entries, + }), }, - }, - allowFrom: { - credentialInputKey: "token", - helpTitle: "Discord allowlist", - helpLines: [ - "Allowlist Discord DMs by username (we resolve to user ids).", - "Examples:", - "- 123456789012345678", - "- @alice", - "- alice#1234", - "Multiple entries: comma-separated.", - `Docs: ${formatDocsLink("/discord", "discord")}`, - ], - message: "Discord allowFrom (usernames or ids)", - placeholder: "@alice, 123456789012345678", - invalidWithoutCredentialNote: "Bot token missing; use numeric user ids (or mention form) only.", - parseId: parseDiscordAllowFromId, - resolveEntries: async ({ cfg, accountId, credentialValues, entries }) => - await resolveDiscordAllowFromEntries({ - token: - resolveDiscordAccount({ cfg, accountId }).token || - (typeof credentialValues.token === "string" ? credentialValues.token : ""), - entries, - }), - apply: async ({ cfg, accountId, allowFrom }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { dmPolicy: "allowlist", allowFrom }, - }), - }, - dmPolicy: discordDmPolicy, - disable: (cfg) => setSetupChannelEnabled(cfg, channel, false), -}; + } as ChannelSetupWizard, +})); From 6a57ede661e485301f8898bf97f8729bc493e5cd Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:23:55 +0000 Subject: [PATCH 079/187] refactor(signal): reuse shared setup security --- extensions/signal/src/channel.setup.ts | 32 ++------------------------ 1 file changed, 2 insertions(+), 30 deletions(-) diff --git a/extensions/signal/src/channel.setup.ts b/extensions/signal/src/channel.setup.ts index f3f8ea9bef2..6fa8add4405 100644 --- a/extensions/signal/src/channel.setup.ts +++ b/extensions/signal/src/channel.setup.ts @@ -1,9 +1,5 @@ -import { - buildAccountScopedDmSecurityPolicy, - collectAllowlistProviderRestrictSendersWarnings, -} from "openclaw/plugin-sdk/channel-config-helpers"; -import { DEFAULT_ACCOUNT_ID, normalizeE164, type ChannelPlugin } from "openclaw/plugin-sdk/signal"; -import { resolveSignalAccount, type ResolvedSignalAccount } from "./accounts.js"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/signal"; +import { type ResolvedSignalAccount } from "./accounts.js"; import { signalSetupAdapter } from "./setup-core.js"; import { createSignalPluginBase, signalSetupWizard } from "./shared.js"; @@ -12,28 +8,4 @@ export const signalSetupPlugin: ChannelPlugin = { setupWizard: signalSetupWizard, setup: signalSetupAdapter, }), - security: { - resolveDmPolicy: ({ cfg, accountId, account }) => - buildAccountScopedDmSecurityPolicy({ - cfg, - channelKey: "signal", - accountId, - fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, - policy: account.config.dmPolicy, - allowFrom: account.config.allowFrom ?? [], - policyPathSuffix: "dmPolicy", - normalizeEntry: (raw) => normalizeE164(raw.replace(/^signal:/i, "").trim()), - }), - collectWarnings: ({ account, cfg }) => - collectAllowlistProviderRestrictSendersWarnings({ - cfg, - providerConfigPresent: cfg.channels?.signal !== undefined, - configuredGroupPolicy: account.config.groupPolicy, - surface: "Signal groups", - openScope: "any member", - groupPolicyPath: "channels.signal.groupPolicy", - groupAllowFromPath: "channels.signal.groupAllowFrom", - mentionGated: false, - }), - }, }; From c9de17fc20d1e502326c2fccbf0d3f2a16fae1e4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:24:37 +0000 Subject: [PATCH 080/187] refactor(imessage): reuse shared setup security --- extensions/imessage/src/channel.setup.ts | 31 ++---------------------- 1 file changed, 2 insertions(+), 29 deletions(-) diff --git a/extensions/imessage/src/channel.setup.ts b/extensions/imessage/src/channel.setup.ts index df0750a4284..4f715cab88c 100644 --- a/extensions/imessage/src/channel.setup.ts +++ b/extensions/imessage/src/channel.setup.ts @@ -1,9 +1,5 @@ -import { - buildAccountScopedDmSecurityPolicy, - collectAllowlistProviderRestrictSendersWarnings, -} from "openclaw/plugin-sdk/channel-config-helpers"; -import { DEFAULT_ACCOUNT_ID, type ChannelPlugin } from "openclaw/plugin-sdk/imessage"; -import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/imessage"; +import { type ResolvedIMessageAccount } from "./accounts.js"; import { imessageSetupAdapter } from "./setup-core.js"; import { createIMessagePluginBase, imessageSetupWizard } from "./shared.js"; @@ -12,27 +8,4 @@ export const imessageSetupPlugin: ChannelPlugin = { setupWizard: imessageSetupWizard, setup: imessageSetupAdapter, }), - security: { - resolveDmPolicy: ({ cfg, accountId, account }) => - buildAccountScopedDmSecurityPolicy({ - cfg, - channelKey: "imessage", - accountId, - fallbackAccountId: account.accountId ?? DEFAULT_ACCOUNT_ID, - policy: account.config.dmPolicy, - allowFrom: account.config.allowFrom ?? [], - policyPathSuffix: "dmPolicy", - }), - collectWarnings: ({ account, cfg }) => - collectAllowlistProviderRestrictSendersWarnings({ - cfg, - providerConfigPresent: cfg.channels?.imessage !== undefined, - configuredGroupPolicy: account.config.groupPolicy, - surface: "iMessage groups", - openScope: "any member", - groupPolicyPath: "channels.imessage.groupPolicy", - groupAllowFromPath: "channels.imessage.groupAllowFrom", - mentionGated: false, - }), - }, }; From 60ee5f661fb7893dd88ab17cfb6e6afaafda67a4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:27:05 +0000 Subject: [PATCH 081/187] refactor(setup): reuse patched adapters across channels --- extensions/imessage/src/setup-core.ts | 65 ++------------------- extensions/signal/src/setup-core.ts | 65 ++------------------- extensions/telegram/src/setup-core.ts | 81 ++++----------------------- 3 files changed, 22 insertions(+), 189 deletions(-) diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index bc99f521510..a7710235e2e 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,8 +1,5 @@ import { - applyAccountNameToChannelSection, - DEFAULT_ACCOUNT_ID, - migrateBaseNameToDefaultAccount, - normalizeAccountId, + createPatchedAccountSetupAdapter, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, setChannelDmPolicyWithAllowFrom, @@ -145,62 +142,10 @@ export const imessageCompletionNote = { ], }; -export const imessageSetupAdapter: ChannelSetupAdapter = { - resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), - applyAccountName: ({ cfg, accountId, name }) => - applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name, - }), - applyAccountConfig: ({ cfg, accountId, input }) => { - const namedConfig = applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name: input.name, - }); - const next = - accountId !== DEFAULT_ACCOUNT_ID - ? migrateBaseNameToDefaultAccount({ - cfg: namedConfig, - channelKey: channel, - }) - : namedConfig; - if (accountId === DEFAULT_ACCOUNT_ID) { - return { - ...next, - channels: { - ...next.channels, - imessage: { - ...next.channels?.imessage, - enabled: true, - ...buildIMessageSetupPatch(input), - }, - }, - }; - } - return { - ...next, - channels: { - ...next.channels, - imessage: { - ...next.channels?.imessage, - enabled: true, - accounts: { - ...next.channels?.imessage?.accounts, - [accountId]: { - ...next.channels?.imessage?.accounts?.[accountId], - enabled: true, - ...buildIMessageSetupPatch(input), - }, - }, - }, - }, - }; - }, -}; +export const imessageSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ + channelKey: channel, + buildPatch: (input) => buildIMessageSetupPatch(input), +}); export function createIMessageSetupWizardProxy( loadWizard: () => Promise<{ imessageSetupWizard: ChannelSetupWizard }>, diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index 3952a55f861..a1433a34f13 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,8 +1,5 @@ import { - applyAccountNameToChannelSection, - DEFAULT_ACCOUNT_ID, - migrateBaseNameToDefaultAccount, - normalizeAccountId, + createPatchedAccountSetupAdapter, normalizeE164, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, @@ -187,15 +184,8 @@ export const signalCompletionNote = { ], }; -export const signalSetupAdapter: ChannelSetupAdapter = { - resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), - applyAccountName: ({ cfg, accountId, name }) => - applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name, - }), +export const signalSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ + channelKey: channel, validateInput: ({ input }) => { if ( !input.signalNumber && @@ -208,53 +198,8 @@ export const signalSetupAdapter: ChannelSetupAdapter = { } return null; }, - applyAccountConfig: ({ cfg, accountId, input }) => { - const namedConfig = applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name: input.name, - }); - const next = - accountId !== DEFAULT_ACCOUNT_ID - ? migrateBaseNameToDefaultAccount({ - cfg: namedConfig, - channelKey: channel, - }) - : namedConfig; - if (accountId === DEFAULT_ACCOUNT_ID) { - return { - ...next, - channels: { - ...next.channels, - signal: { - ...next.channels?.signal, - enabled: true, - ...buildSignalSetupPatch(input), - }, - }, - }; - } - return { - ...next, - channels: { - ...next.channels, - signal: { - ...next.channels?.signal, - enabled: true, - accounts: { - ...next.channels?.signal?.accounts, - [accountId]: { - ...next.channels?.signal?.accounts?.[accountId], - enabled: true, - ...buildSignalSetupPatch(input), - }, - }, - }, - }, - }; - }, -}; + buildPatch: (input) => buildSignalSetupPatch(input), +}); export function createSignalSetupWizardProxy( loadWizard: () => Promise<{ signalSetupWizard: ChannelSetupWizard }>, diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index f2b5fc04d77..2791f7d2fbc 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,8 +1,6 @@ import { - applyAccountNameToChannelSection, + createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, - migrateBaseNameToDefaultAccount, - normalizeAccountId, patchChannelConfigForAccount, promptResolvedAllowFrom, splitSetupEntries, @@ -109,15 +107,8 @@ export async function promptTelegramAllowFromForAccount(params: { }); } -export const telegramSetupAdapter: ChannelSetupAdapter = { - resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), - applyAccountName: ({ cfg, accountId, name }) => - applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name, - }), +export const telegramSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ + channelKey: channel, validateInput: ({ accountId, input }) => { if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { return "TELEGRAM_BOT_TOKEN can only be used for the default account."; @@ -127,60 +118,12 @@ export const telegramSetupAdapter: ChannelSetupAdapter = { } return null; }, - applyAccountConfig: ({ cfg, accountId, input }) => { - const namedConfig = applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name: input.name, - }); - const next = - accountId !== DEFAULT_ACCOUNT_ID - ? migrateBaseNameToDefaultAccount({ - cfg: namedConfig, - channelKey: channel, - }) - : namedConfig; - if (accountId === DEFAULT_ACCOUNT_ID) { - return { - ...next, - channels: { - ...next.channels, - telegram: { - ...next.channels?.telegram, - enabled: true, - ...(input.useEnv - ? {} - : input.tokenFile - ? { tokenFile: input.tokenFile } - : input.token - ? { botToken: input.token } - : {}), - }, - }, - }; - } - return { - ...next, - channels: { - ...next.channels, - telegram: { - ...next.channels?.telegram, - enabled: true, - accounts: { - ...next.channels?.telegram?.accounts, - [accountId]: { - ...next.channels?.telegram?.accounts?.[accountId], - enabled: true, - ...(input.tokenFile - ? { tokenFile: input.tokenFile } - : input.token - ? { botToken: input.token } - : {}), - }, - }, - }, - }, - }; - }, -}; + buildPatch: (input) => + input.useEnv + ? {} + : input.tokenFile + ? { tokenFile: input.tokenFile } + : input.token + ? { botToken: input.token } + : {}, +}); From 55c52b90948f82323d6c0bcba31a563477049649 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:28:32 +0000 Subject: [PATCH 082/187] refactor(imessage): share setup status base --- extensions/imessage/src/setup-core.ts | 38 +++++++++++++----------- extensions/imessage/src/setup-surface.ts | 19 ++---------- 2 files changed, 23 insertions(+), 34 deletions(-) diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index a7710235e2e..17f1b7487d3 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -147,29 +147,33 @@ export const imessageSetupAdapter: ChannelSetupAdapter = createPatchedAccountSet buildPatch: (input) => buildIMessageSetupPatch(input), }); +export const imessageSetupStatusBase = { + configuredLabel: "configured", + unconfiguredLabel: "needs setup", + configuredHint: "imsg found", + unconfiguredHint: "imsg missing", + configuredScore: 1, + unconfiguredScore: 0, + resolveConfigured: ({ cfg }: { cfg: OpenClawConfig }) => + listIMessageAccountIds(cfg).some((accountId) => { + const account = resolveIMessageAccount({ cfg, accountId }); + return Boolean( + account.config.cliPath || + account.config.dbPath || + account.config.allowFrom || + account.config.service || + account.config.region, + ); + }), +}; + export function createIMessageSetupWizardProxy( loadWizard: () => Promise<{ imessageSetupWizard: ChannelSetupWizard }>, ) { return { channel, status: { - configuredLabel: "configured", - unconfiguredLabel: "needs setup", - configuredHint: "imsg found", - unconfiguredHint: "imsg missing", - configuredScore: 1, - unconfiguredScore: 0, - resolveConfigured: ({ cfg }) => - listIMessageAccountIds(cfg).some((accountId) => { - const account = resolveIMessageAccount({ cfg, accountId }); - return Boolean( - account.config.cliPath || - account.config.dbPath || - account.config.allowFrom || - account.config.service || - account.config.region, - ); - }), + ...imessageSetupStatusBase, resolveStatusLines: async (params) => (await loadWizard()).imessageSetupWizard.status.resolveStatusLines?.(params) ?? [], resolveSelectionHint: async (params) => diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index 6581fabbacd..27e8b256ada 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -6,6 +6,7 @@ import { imessageCompletionNote, imessageDmPolicy, imessageSetupAdapter, + imessageSetupStatusBase, parseIMessageAllowFromEntries, } from "./setup-core.js"; @@ -14,23 +15,7 @@ const channel = "imessage" as const; export const imessageSetupWizard: ChannelSetupWizard = { channel, status: { - configuredLabel: "configured", - unconfiguredLabel: "needs setup", - configuredHint: "imsg found", - unconfiguredHint: "imsg missing", - configuredScore: 1, - unconfiguredScore: 0, - resolveConfigured: ({ cfg }) => - listIMessageAccountIds(cfg).some((accountId) => { - const account = resolveIMessageAccount({ cfg, accountId }); - return Boolean( - account.config.cliPath || - account.config.dbPath || - account.config.allowFrom || - account.config.service || - account.config.region, - ); - }), + ...imessageSetupStatusBase, resolveStatusLines: async ({ cfg, configured }) => { const cliPath = cfg.channels?.imessage?.cliPath ?? "imsg"; const cliDetected = await detectBinary(cliPath); From 3486bff7d5d8542bd8b686f50dcc2fafd0271e63 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:29:27 +0000 Subject: [PATCH 083/187] refactor(slack): share token credential setup --- extensions/slack/src/setup-core.ts | 129 +++++++++++++---------------- 1 file changed, 59 insertions(+), 70 deletions(-) diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 6cd9232b388..234cb6dc3c8 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -40,6 +40,61 @@ function enableSlackAccount(cfg: OpenClawConfig, accountId: string): OpenClawCon }); } +function createSlackTokenCredential(params: { + inputKey: "botToken" | "appToken"; + providerHint: "slack-bot" | "slack-app"; + credentialLabel: string; + preferredEnvVar: "SLACK_BOT_TOKEN" | "SLACK_APP_TOKEN"; + keepPrompt: string; + inputPrompt: string; +}) { + return { + inputKey: params.inputKey, + providerHint: params.providerHint, + credentialLabel: params.credentialLabel, + preferredEnvVar: params.preferredEnvVar, + envPrompt: `${params.preferredEnvVar} detected. Use env var?`, + keepPrompt: params.keepPrompt, + inputPrompt: params.inputPrompt, + allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, + inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { + const resolved = resolveSlackAccount({ cfg, accountId }); + const configuredValue = + params.inputKey === "botToken" ? resolved.config.botToken : resolved.config.appToken; + const resolvedValue = params.inputKey === "botToken" ? resolved.botToken : resolved.appToken; + return { + accountConfigured: Boolean(resolvedValue) || hasConfiguredSecretInput(configuredValue), + hasConfiguredValue: hasConfiguredSecretInput(configuredValue), + resolvedValue: resolvedValue?.trim() || undefined, + envValue: + accountId === DEFAULT_ACCOUNT_ID + ? process.env[params.preferredEnvVar]?.trim() + : undefined, + }; + }, + applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => + enableSlackAccount(cfg, accountId), + applySet: ({ + cfg, + accountId, + value, + }: { + cfg: OpenClawConfig; + accountId: string; + value: unknown; + }) => + patchChannelConfigForAccount({ + cfg, + channel, + accountId, + patch: { + enabled: true, + [params.inputKey]: value, + }, + }), + }; +} + export const slackSetupAdapter: ChannelSetupAdapter = { resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), applyAccountName: ({ cfg, accountId, name }) => @@ -169,88 +224,22 @@ export function createSlackSetupWizardBase(handlers: { apply: ({ cfg, accountId }) => enableSlackAccount(cfg, accountId), }, credentials: [ - { + createSlackTokenCredential({ inputKey: "botToken", providerHint: "slack-bot", credentialLabel: "Slack bot token", preferredEnvVar: "SLACK_BOT_TOKEN", - envPrompt: "SLACK_BOT_TOKEN detected. Use env var?", keepPrompt: "Slack bot token already configured. Keep it?", inputPrompt: "Enter Slack bot token (xoxb-...)", - allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { - const resolved = resolveSlackAccount({ cfg, accountId }); - return { - accountConfigured: - Boolean(resolved.botToken) || hasConfiguredSecretInput(resolved.config.botToken), - hasConfiguredValue: hasConfiguredSecretInput(resolved.config.botToken), - resolvedValue: resolved.botToken?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_BOT_TOKEN?.trim() : undefined, - }; - }, - applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => - enableSlackAccount(cfg, accountId), - applySet: ({ - cfg, - accountId, - value, - }: { - cfg: OpenClawConfig; - accountId: string; - value: unknown; - }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { - enabled: true, - botToken: value, - }, - }), - }, - { + }), + createSlackTokenCredential({ inputKey: "appToken", providerHint: "slack-app", credentialLabel: "Slack app token", preferredEnvVar: "SLACK_APP_TOKEN", - envPrompt: "SLACK_APP_TOKEN detected. Use env var?", keepPrompt: "Slack app token already configured. Keep it?", inputPrompt: "Enter Slack app token (xapp-...)", - allowEnv: ({ accountId }: { accountId: string }) => accountId === DEFAULT_ACCOUNT_ID, - inspect: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => { - const resolved = resolveSlackAccount({ cfg, accountId }); - return { - accountConfigured: - Boolean(resolved.appToken) || hasConfiguredSecretInput(resolved.config.appToken), - hasConfiguredValue: hasConfiguredSecretInput(resolved.config.appToken), - resolvedValue: resolved.appToken?.trim() || undefined, - envValue: - accountId === DEFAULT_ACCOUNT_ID ? process.env.SLACK_APP_TOKEN?.trim() : undefined, - }; - }, - applyUseEnv: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId: string }) => - enableSlackAccount(cfg, accountId), - applySet: ({ - cfg, - accountId, - value, - }: { - cfg: OpenClawConfig; - accountId: string; - value: unknown; - }) => - patchChannelConfigForAccount({ - cfg, - channel, - accountId, - patch: { - enabled: true, - appToken: value, - }, - }), - }, + }), ], dmPolicy: slackDmPolicy, allowFrom: { From 79078f6a70bcf0eac8153544f13a74fb6ab710e2 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:32:11 +0000 Subject: [PATCH 084/187] refactor(setup): share env-aware patched adapters --- extensions/discord/src/setup-core.ts | 77 ++----------------- extensions/slack/src/setup-core.ts | 86 +++------------------- extensions/telegram/src/setup-core.ts | 24 ++---- src/channels/plugins/setup-helpers.test.ts | 34 +++++++++ src/channels/plugins/setup-helpers.ts | 29 ++++++++ src/plugin-sdk/setup.ts | 1 + 6 files changed, 89 insertions(+), 162 deletions(-) diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 7f4c1be29d3..4b807f10a65 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -1,10 +1,7 @@ import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { - applyAccountNameToChannelSection, - createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, - migrateBaseNameToDefaultAccount, - normalizeAccountId, + createEnvPatchedAccountSetupAdapter, noteChannelLookupFailure, noteChannelLookupSummary, parseMentionOrPrefixedId, @@ -74,71 +71,13 @@ export function parseDiscordAllowFromId(value: string): string | null { }); } -export const discordSetupAdapter: ChannelSetupAdapter = { - resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), - applyAccountName: ({ cfg, accountId, name }) => - applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name, - }), - validateInput: ({ accountId, input }) => { - if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { - return "DISCORD_BOT_TOKEN can only be used for the default account."; - } - if (!input.useEnv && !input.token) { - return "Discord requires token (or --use-env)."; - } - return null; - }, - applyAccountConfig: ({ cfg, accountId, input }) => { - const namedConfig = applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name: input.name, - }); - const next = - accountId !== DEFAULT_ACCOUNT_ID - ? migrateBaseNameToDefaultAccount({ - cfg: namedConfig, - channelKey: channel, - }) - : namedConfig; - if (accountId === DEFAULT_ACCOUNT_ID) { - return { - ...next, - channels: { - ...next.channels, - discord: { - ...next.channels?.discord, - enabled: true, - ...(input.useEnv ? {} : input.token ? { token: input.token } : {}), - }, - }, - }; - } - return { - ...next, - channels: { - ...next.channels, - discord: { - ...next.channels?.discord, - enabled: true, - accounts: { - ...next.channels?.discord?.accounts, - [accountId]: { - ...next.channels?.discord?.accounts?.[accountId], - enabled: true, - ...(input.token ? { token: input.token } : {}), - }, - }, - }, - }, - }; - }, -}; +export const discordSetupAdapter: ChannelSetupAdapter = createEnvPatchedAccountSetupAdapter({ + channelKey: channel, + defaultAccountOnlyEnvError: "DISCORD_BOT_TOKEN can only be used for the default account.", + missingCredentialError: "Discord requires token (or --use-env).", + hasCredentials: (input) => Boolean(input.token), + buildPatch: (input) => (input.token ? { token: input.token } : {}), +}); export function createDiscordSetupWizardBase(handlers: { promptAllowFrom: NonNullable; diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index 234cb6dc3c8..af71e5edc52 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -1,11 +1,8 @@ import { - applyAccountNameToChannelSection, createAllowlistSetupWizardProxy, - createPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, + createEnvPatchedAccountSetupAdapter, hasConfiguredSecretInput, - migrateBaseNameToDefaultAccount, - normalizeAccountId, type OpenClawConfig, noteChannelLookupFailure, noteChannelLookupSummary, @@ -95,77 +92,16 @@ function createSlackTokenCredential(params: { }; } -export const slackSetupAdapter: ChannelSetupAdapter = { - resolveAccountId: ({ accountId }) => normalizeAccountId(accountId), - applyAccountName: ({ cfg, accountId, name }) => - applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name, - }), - validateInput: ({ accountId, input }) => { - if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { - return "Slack env tokens can only be used for the default account."; - } - if (!input.useEnv && (!input.botToken || !input.appToken)) { - return "Slack requires --bot-token and --app-token (or --use-env)."; - } - return null; - }, - applyAccountConfig: ({ cfg, accountId, input }) => { - const namedConfig = applyAccountNameToChannelSection({ - cfg, - channelKey: channel, - accountId, - name: input.name, - }); - const next = - accountId !== DEFAULT_ACCOUNT_ID - ? migrateBaseNameToDefaultAccount({ - cfg: namedConfig, - channelKey: channel, - }) - : namedConfig; - if (accountId === DEFAULT_ACCOUNT_ID) { - return { - ...next, - channels: { - ...next.channels, - slack: { - ...next.channels?.slack, - enabled: true, - ...(input.useEnv - ? {} - : { - ...(input.botToken ? { botToken: input.botToken } : {}), - ...(input.appToken ? { appToken: input.appToken } : {}), - }), - }, - }, - }; - } - return { - ...next, - channels: { - ...next.channels, - slack: { - ...next.channels?.slack, - enabled: true, - accounts: { - ...next.channels?.slack?.accounts, - [accountId]: { - ...next.channels?.slack?.accounts?.[accountId], - enabled: true, - ...(input.botToken ? { botToken: input.botToken } : {}), - ...(input.appToken ? { appToken: input.appToken } : {}), - }, - }, - }, - }, - }; - }, -}; +export const slackSetupAdapter: ChannelSetupAdapter = createEnvPatchedAccountSetupAdapter({ + channelKey: channel, + defaultAccountOnlyEnvError: "Slack env tokens can only be used for the default account.", + missingCredentialError: "Slack requires --bot-token and --app-token (or --use-env).", + hasCredentials: (input) => Boolean(input.botToken && input.appToken), + buildPatch: (input) => ({ + ...(input.botToken ? { botToken: input.botToken } : {}), + ...(input.appToken ? { appToken: input.appToken } : {}), + }), +}); export function createSlackSetupWizardBase(handlers: { promptAllowFrom: NonNullable; diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 2791f7d2fbc..542fffc0500 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,5 +1,5 @@ import { - createPatchedAccountSetupAdapter, + createEnvPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, patchChannelConfigForAccount, promptResolvedAllowFrom, @@ -107,23 +107,11 @@ export async function promptTelegramAllowFromForAccount(params: { }); } -export const telegramSetupAdapter: ChannelSetupAdapter = createPatchedAccountSetupAdapter({ +export const telegramSetupAdapter: ChannelSetupAdapter = createEnvPatchedAccountSetupAdapter({ channelKey: channel, - validateInput: ({ accountId, input }) => { - if (input.useEnv && accountId !== DEFAULT_ACCOUNT_ID) { - return "TELEGRAM_BOT_TOKEN can only be used for the default account."; - } - if (!input.useEnv && !input.token && !input.tokenFile) { - return "Telegram requires token or --token-file (or --use-env)."; - } - return null; - }, + defaultAccountOnlyEnvError: "TELEGRAM_BOT_TOKEN can only be used for the default account.", + missingCredentialError: "Telegram requires token or --token-file (or --use-env).", + hasCredentials: (input) => Boolean(input.token || input.tokenFile), buildPatch: (input) => - input.useEnv - ? {} - : input.tokenFile - ? { tokenFile: input.tokenFile } - : input.token - ? { botToken: input.token } - : {}, + input.tokenFile ? { tokenFile: input.tokenFile } : input.token ? { botToken: input.token } : {}, }); diff --git a/src/channels/plugins/setup-helpers.test.ts b/src/channels/plugins/setup-helpers.test.ts index 2040271f540..f81de4fe4ed 100644 --- a/src/channels/plugins/setup-helpers.test.ts +++ b/src/channels/plugins/setup-helpers.test.ts @@ -3,6 +3,7 @@ import type { OpenClawConfig } from "../../config/config.js"; import { DEFAULT_ACCOUNT_ID } from "../../routing/session-key.js"; import { applySetupAccountConfigPatch, + createEnvPatchedAccountSetupAdapter, createPatchedAccountSetupAdapter, prepareScopedSetupConfig, } from "./setup-helpers.js"; @@ -162,6 +163,39 @@ describe("createPatchedAccountSetupAdapter", () => { }); }); +describe("createEnvPatchedAccountSetupAdapter", () => { + it("rejects env mode for named accounts and requires credentials otherwise", () => { + const adapter = createEnvPatchedAccountSetupAdapter({ + channelKey: "telegram", + defaultAccountOnlyEnvError: "env only on default", + missingCredentialError: "token required", + hasCredentials: (input) => Boolean(input.token || input.tokenFile), + buildPatch: (input) => ({ token: input.token }), + }); + + expect( + adapter.validateInput?.({ + accountId: "work", + input: { useEnv: true }, + }), + ).toBe("env only on default"); + + expect( + adapter.validateInput?.({ + accountId: DEFAULT_ACCOUNT_ID, + input: {}, + }), + ).toBe("token required"); + + expect( + adapter.validateInput?.({ + accountId: DEFAULT_ACCOUNT_ID, + input: { token: "tok" }, + }), + ).toBeNull(); + }); +}); + describe("prepareScopedSetupConfig", () => { it("stores the name and migrates it for named accounts when requested", () => { const next = prepareScopedSetupConfig({ diff --git a/src/channels/plugins/setup-helpers.ts b/src/channels/plugins/setup-helpers.ts index cfbd58a8d4e..e27f13e383a 100644 --- a/src/channels/plugins/setup-helpers.ts +++ b/src/channels/plugins/setup-helpers.ts @@ -204,6 +204,35 @@ export function createPatchedAccountSetupAdapter(params: { }; } +export function createEnvPatchedAccountSetupAdapter(params: { + channelKey: string; + alwaysUseAccounts?: boolean; + ensureChannelEnabled?: boolean; + ensureAccountEnabled?: boolean; + defaultAccountOnlyEnvError: string; + missingCredentialError: string; + hasCredentials: (input: ChannelSetupInput) => boolean; + validateInput?: ChannelSetupAdapter["validateInput"]; + buildPatch: (input: ChannelSetupInput) => Record; +}): ChannelSetupAdapter { + return createPatchedAccountSetupAdapter({ + channelKey: params.channelKey, + alwaysUseAccounts: params.alwaysUseAccounts, + ensureChannelEnabled: params.ensureChannelEnabled, + ensureAccountEnabled: params.ensureAccountEnabled, + validateInput: (inputParams) => { + if (inputParams.input.useEnv && inputParams.accountId !== DEFAULT_ACCOUNT_ID) { + return params.defaultAccountOnlyEnvError; + } + if (!inputParams.input.useEnv && !params.hasCredentials(inputParams.input)) { + return params.missingCredentialError; + } + return params.validateInput?.(inputParams) ?? null; + }, + buildPatch: params.buildPatch, + }); +} + export function patchScopedAccountConfig(params: { cfg: OpenClawConfig; channelKey: string; diff --git a/src/plugin-sdk/setup.ts b/src/plugin-sdk/setup.ts index bd4e5283c97..065fbfeed9c 100644 --- a/src/plugin-sdk/setup.ts +++ b/src/plugin-sdk/setup.ts @@ -24,6 +24,7 @@ export { normalizeE164, pathExists } from "../utils.js"; export { applyAccountNameToChannelSection, applySetupAccountConfigPatch, + createEnvPatchedAccountSetupAdapter, createPatchedAccountSetupAdapter, migrateBaseNameToDefaultAccount, patchScopedAccountConfig, From 4b001c793448c0326b902b6ea02cebf22c9d183c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:34:13 +0000 Subject: [PATCH 085/187] refactor(discord): use shared plugin base --- extensions/discord/src/channel.setup.ts | 43 +++---------------------- extensions/discord/src/channel.ts | 37 +++------------------ extensions/discord/src/plugin-shared.ts | 39 ---------------------- 3 files changed, 9 insertions(+), 110 deletions(-) delete mode 100644 extensions/discord/src/plugin-shared.ts diff --git a/extensions/discord/src/channel.setup.ts b/extensions/discord/src/channel.setup.ts index 1988c03ca26..c45ed85fb0b 100644 --- a/extensions/discord/src/channel.setup.ts +++ b/extensions/discord/src/channel.setup.ts @@ -1,43 +1,10 @@ -import { - buildChannelConfigSchema, - DiscordConfigSchema, - getChatChannelMeta, - type ChannelPlugin, -} from "openclaw/plugin-sdk/discord"; +import { type ChannelPlugin } from "openclaw/plugin-sdk/discord"; import { type ResolvedDiscordAccount } from "./accounts.js"; -import { discordConfigAccessors, discordConfigBase, discordSetupWizard } from "./plugin-shared.js"; import { discordSetupAdapter } from "./setup-core.js"; +import { createDiscordPluginBase } from "./shared.js"; export const discordSetupPlugin: ChannelPlugin = { - id: "discord", - meta: { - ...getChatChannelMeta("discord"), - }, - setupWizard: discordSetupWizard, - capabilities: { - chatTypes: ["direct", "channel", "thread"], - polls: true, - reactions: true, - threads: true, - media: true, - nativeCommands: true, - }, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.discord"] }, - configSchema: buildChannelConfigSchema(DiscordConfigSchema), - config: { - ...discordConfigBase, - isConfigured: (account) => Boolean(account.token?.trim()), - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: Boolean(account.token?.trim()), - tokenSource: account.tokenSource, - }), - ...discordConfigAccessors, - }, - setup: discordSetupAdapter, + ...createDiscordPluginBase({ + setup: discordSetupAdapter, + }), }; diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index 761ccb5f8b5..c3826e6c393 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -12,10 +12,8 @@ import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; import { buildComputedAccountStatusSnapshot, - buildChannelConfigSchema, buildTokenChannelStatusSummary, DEFAULT_ACCOUNT_ID, - DiscordConfigSchema, getChatChannelMeta, listDiscordDirectoryGroupsFromConfig, listDiscordDirectoryPeersFromConfig, @@ -48,12 +46,12 @@ import { normalizeDiscordMessagingTarget, normalizeDiscordOutboundTarget, } from "./normalize.js"; -import { discordConfigAccessors, discordConfigBase, discordSetupWizard } from "./plugin-shared.js"; import type { DiscordProbe } from "./probe.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { getDiscordRuntime } from "./runtime.js"; import { fetchChannelPermissionsDiscord } from "./send.js"; import { discordSetupAdapter } from "./setup-core.js"; +import { createDiscordPluginBase } from "./shared.js"; import { collectDiscordStatusIssues } from "./status-issues.js"; import { parseDiscordTarget } from "./targets.js"; import { DiscordUiContainer } from "./ui.js"; @@ -300,11 +298,9 @@ function resolveDiscordOutboundSessionRoute(params: { } export const discordPlugin: ChannelPlugin = { - id: "discord", - meta: { - ...meta, - }, - setupWizard: discordSetupWizard, + ...createDiscordPluginBase({ + setup: discordSetupAdapter, + }), pairing: { idLabel: "discordUserId", normalizeAllowEntry: (entry) => entry.replace(/^(discord|user):/i, ""), @@ -315,31 +311,6 @@ export const discordPlugin: ChannelPlugin = { ); }, }, - capabilities: { - chatTypes: ["direct", "channel", "thread"], - polls: true, - reactions: true, - threads: true, - media: true, - nativeCommands: true, - }, - streaming: { - blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 }, - }, - reload: { configPrefixes: ["channels.discord"] }, - configSchema: buildChannelConfigSchema(DiscordConfigSchema), - config: { - ...discordConfigBase, - isConfigured: (account) => Boolean(account.token?.trim()), - describeAccount: (account) => ({ - accountId: account.accountId, - name: account.name, - enabled: account.enabled, - configured: Boolean(account.token?.trim()), - tokenSource: account.tokenSource, - }), - ...discordConfigAccessors, - }, allowlist: { supportsScope: ({ scope }) => scope === "dm", readConfig: ({ cfg, accountId }) => diff --git a/extensions/discord/src/plugin-shared.ts b/extensions/discord/src/plugin-shared.ts deleted file mode 100644 index fd5fb029f7c..00000000000 --- a/extensions/discord/src/plugin-shared.ts +++ /dev/null @@ -1,39 +0,0 @@ -import type { OpenClawConfig } from "openclaw/plugin-sdk/account-resolution"; -import { formatAllowFromLowercase } from "openclaw/plugin-sdk/allow-from"; -import { - createScopedAccountConfigAccessors, - createScopedChannelConfigBase, -} from "openclaw/plugin-sdk/channel-config-helpers"; -import { inspectDiscordAccount } from "./account-inspect.js"; -import { - listDiscordAccountIds, - resolveDefaultDiscordAccountId, - resolveDiscordAccount, - type ResolvedDiscordAccount, -} from "./accounts.js"; -import { createDiscordSetupWizardProxy } from "./setup-core.js"; - -async function loadDiscordChannelRuntime() { - return await import("./channel.runtime.js"); -} - -export const discordConfigAccessors = createScopedAccountConfigAccessors({ - resolveAccount: ({ cfg, accountId }: { cfg: OpenClawConfig; accountId?: string | null }) => - resolveDiscordAccount({ cfg, accountId }), - resolveAllowFrom: (account: ResolvedDiscordAccount) => account.config.dm?.allowFrom, - formatAllowFrom: (allowFrom) => formatAllowFromLowercase({ allowFrom }), - resolveDefaultTo: (account: ResolvedDiscordAccount) => account.config.defaultTo, -}); - -export const discordConfigBase = createScopedChannelConfigBase({ - sectionKey: "discord", - listAccountIds: listDiscordAccountIds, - resolveAccount: (cfg, accountId) => resolveDiscordAccount({ cfg, accountId }), - inspectAccount: (cfg, accountId) => inspectDiscordAccount({ cfg, accountId }), - defaultAccountId: resolveDefaultDiscordAccountId, - clearBaseFields: ["token", "name"], -}); - -export const discordSetupWizard = createDiscordSetupWizardProxy(async () => ({ - discordSetupWizard: (await loadDiscordChannelRuntime()).discordSetupWizard, -})); From da9e0b658d584032ed18b3ded5130d1902775db7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:40:03 +0000 Subject: [PATCH 086/187] refactor(outbound): share base session helpers --- extensions/discord/src/channel.ts | 33 +++++--------------------- extensions/imessage/src/channel.ts | 12 +++------- extensions/signal/src/channel.ts | 12 +++------- extensions/slack/src/channel.ts | 31 ++++-------------------- extensions/telegram/src/channel.ts | 31 ++++-------------------- src/infra/outbound/base-session-key.ts | 19 +++++++++++++++ src/infra/outbound/outbound-session.ts | 12 +++------- src/plugin-sdk/core.ts | 27 +++++++++++++++++++++ 8 files changed, 71 insertions(+), 106 deletions(-) create mode 100644 src/infra/outbound/base-session-key.ts diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index c3826e6c393..46679586665 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -10,6 +10,11 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; +import { + buildOutboundBaseSessionKey, + normalizeOutboundThreadId, +} from "openclaw/plugin-sdk/core"; +import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildComputedAccountStatusSnapshot, buildTokenChannelStatusSummary, @@ -26,11 +31,6 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/discord"; -import { - buildAgentSessionKey, - resolveThreadSessionKeys, - type RoutePeer, -} from "openclaw/plugin-sdk/routing"; import { listDiscordAccountIds, resolveDiscordAccount, @@ -201,34 +201,13 @@ function parseDiscordExplicitTarget(raw: string) { } } -function normalizeOutboundThreadId(value?: string | number | null): string | undefined { - if (value == null) { - return undefined; - } - if (typeof value === "number") { - if (!Number.isFinite(value)) { - return undefined; - } - return String(Math.trunc(value)); - } - const trimmed = value.trim(); - return trimmed ? trimmed : undefined; -} - function buildDiscordBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; accountId?: string | null; peer: RoutePeer; }) { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: "discord", - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey({ ...params, channel: "discord" }); } function resolveDiscordOutboundTargetKindHint(params: { diff --git a/extensions/imessage/src/channel.ts b/extensions/imessage/src/channel.ts index a927b8a3d74..973456af7bb 100644 --- a/extensions/imessage/src/channel.ts +++ b/extensions/imessage/src/channel.ts @@ -4,6 +4,7 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; +import { buildOutboundBaseSessionKey } from "openclaw/plugin-sdk/core"; import { collectStatusIssuesFromLastError, DEFAULT_ACCOUNT_ID, @@ -14,7 +15,7 @@ import { resolveIMessageGroupToolPolicy, type ChannelPlugin, } from "openclaw/plugin-sdk/imessage"; -import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/routing"; +import { type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { resolveIMessageAccount, type ResolvedIMessageAccount } from "./accounts.js"; import { getIMessageRuntime } from "./runtime.js"; @@ -35,14 +36,7 @@ function buildIMessageBaseSessionKey(params: { accountId?: string | null; peer: RoutePeer; }) { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: "imessage", - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey({ ...params, channel: "imessage" }); } function resolveIMessageOutboundSessionRoute(params: { diff --git a/extensions/signal/src/channel.ts b/extensions/signal/src/channel.ts index b86f0156a08..17b97c96f25 100644 --- a/extensions/signal/src/channel.ts +++ b/extensions/signal/src/channel.ts @@ -5,8 +5,9 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; +import { buildOutboundBaseSessionKey } from "openclaw/plugin-sdk/core"; import { resolveTextChunkLimit } from "openclaw/plugin-sdk/reply-runtime"; -import { buildAgentSessionKey, type RoutePeer } from "openclaw/plugin-sdk/routing"; +import { type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildBaseAccountStatusSnapshot, buildBaseChannelStatusSummary, @@ -123,14 +124,7 @@ function buildSignalBaseSessionKey(params: { accountId?: string | null; peer: RoutePeer; }) { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: "signal", - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey({ ...params, channel: "signal" }); } function resolveSignalOutboundSessionRoute(params: { diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index a3b537b1f8e..52b8c632df7 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -9,10 +9,10 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { - buildAgentSessionKey, - resolveThreadSessionKeys, - type RoutePeer, -} from "openclaw/plugin-sdk/routing"; + buildOutboundBaseSessionKey, + normalizeOutboundThreadId, +} from "openclaw/plugin-sdk/core"; +import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildComputedAccountStatusSnapshot, DEFAULT_ACCOUNT_ID, @@ -137,34 +137,13 @@ function parseSlackExplicitTarget(raw: string) { }; } -function normalizeOutboundThreadId(value?: string | number | null): string | undefined { - if (value == null) { - return undefined; - } - if (typeof value === "number") { - if (!Number.isFinite(value)) { - return undefined; - } - return String(Math.trunc(value)); - } - const trimmed = value.trim(); - return trimmed ? trimmed : undefined; -} - function buildSlackBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; accountId?: string | null; peer: RoutePeer; }) { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: "slack", - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey({ ...params, channel: "slack" }); } async function resolveSlackChannelType(params: { diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index ddc21911800..88056309ede 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -9,10 +9,10 @@ import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; import { - buildAgentSessionKey, - resolveThreadSessionKeys, - type RoutePeer, -} from "openclaw/plugin-sdk/routing"; + buildOutboundBaseSessionKey, + normalizeOutboundThreadId, +} from "openclaw/plugin-sdk/core"; +import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { parseTelegramTopicConversation } from "openclaw/plugin-sdk/telegram"; import { buildTokenChannelStatusSummary, @@ -180,34 +180,13 @@ function parseTelegramExplicitTarget(raw: string) { }; } -function normalizeOutboundThreadId(value?: string | number | null): string | undefined { - if (value == null) { - return undefined; - } - if (typeof value === "number") { - if (!Number.isFinite(value)) { - return undefined; - } - return String(Math.trunc(value)); - } - const trimmed = value.trim(); - return trimmed ? trimmed : undefined; -} - function buildTelegramBaseSessionKey(params: { cfg: OpenClawConfig; agentId: string; accountId?: string | null; peer: RoutePeer; }) { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: "telegram", - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey({ ...params, channel: "telegram" }); } function resolveTelegramOutboundSessionRoute(params: { diff --git a/src/infra/outbound/base-session-key.ts b/src/infra/outbound/base-session-key.ts new file mode 100644 index 00000000000..af3b3da1cdd --- /dev/null +++ b/src/infra/outbound/base-session-key.ts @@ -0,0 +1,19 @@ +import type { OpenClawConfig } from "../../config/config.js"; +import { buildAgentSessionKey, type RoutePeer } from "../../routing/resolve-route.js"; + +export function buildOutboundBaseSessionKey(params: { + cfg: OpenClawConfig; + agentId: string; + channel: string; + accountId?: string | null; + peer: RoutePeer; +}): string { + return buildAgentSessionKey({ + agentId: params.agentId, + channel: params.channel, + accountId: params.accountId, + peer: params.peer, + dmScope: params.cfg.session?.dmScope ?? "main", + identityLinks: params.cfg.session?.identityLinks, + }); +} diff --git a/src/infra/outbound/outbound-session.ts b/src/infra/outbound/outbound-session.ts index a65e2da313e..274e2c80397 100644 --- a/src/infra/outbound/outbound-session.ts +++ b/src/infra/outbound/outbound-session.ts @@ -4,9 +4,10 @@ import { getChannelPlugin } from "../../channels/plugins/index.js"; import type { ChannelId } from "../../channels/plugins/types.js"; import type { OpenClawConfig } from "../../config/config.js"; import { recordSessionMetaFromInbound, resolveStorePath } from "../../config/sessions.js"; -import { buildAgentSessionKey, type RoutePeer } from "../../routing/resolve-route.js"; +import type { RoutePeer } from "../../routing/resolve-route.js"; import { resolveThreadSessionKeys } from "../../routing/session-key.js"; import { isWhatsAppGroupJid, normalizeWhatsAppTarget } from "../../whatsapp/normalize.js"; +import { buildOutboundBaseSessionKey } from "./base-session-key.js"; import type { ResolvedMessagingTarget } from "./target-resolver.js"; import { normalizeOutboundThreadId } from "./thread-id.js"; @@ -76,14 +77,7 @@ function buildBaseSessionKey(params: { accountId?: string | null; peer: RoutePeer; }): string { - return buildAgentSessionKey({ - agentId: params.agentId, - channel: params.channel, - accountId: params.accountId, - peer: params.peer, - dmScope: params.cfg.session?.dmScope ?? "main", - identityLinks: params.cfg.session?.identityLinks, - }); + return buildOutboundBaseSessionKey(params); } function resolveWhatsAppSession( diff --git a/src/plugin-sdk/core.ts b/src/plugin-sdk/core.ts index fda11949c4e..cfc600624a3 100644 --- a/src/plugin-sdk/core.ts +++ b/src/plugin-sdk/core.ts @@ -45,3 +45,30 @@ export type { OpenClawPluginApi } from "../plugins/types.js"; export type { PluginRuntime } from "../plugins/runtime/types.js"; export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; +export { + DEFAULT_SECRET_FILE_MAX_BYTES, + loadSecretFileSync, + readSecretFileSync, + tryReadSecretFileSync, +} from "../infra/secret-file.js"; +export type { SecretFileReadOptions, SecretFileReadResult } from "../infra/secret-file.js"; + +export { resolveGatewayBindUrl } from "../shared/gateway-bind-url.js"; +export type { GatewayBindUrlResult } from "../shared/gateway-bind-url.js"; + +export { resolveTailnetHostWithRunner } from "../shared/tailscale-status.js"; +export type { + TailscaleStatusCommandResult, + TailscaleStatusCommandRunner, +} from "../shared/tailscale-status.js"; +export { + buildAgentSessionKey, + type RoutePeer, + type RoutePeerKind, +} from "../routing/resolve-route.js"; +export { buildOutboundBaseSessionKey } from "../infra/outbound/base-session-key.js"; +export { normalizeOutboundThreadId } from "../infra/outbound/thread-id.js"; +export { resolveThreadSessionKeys } from "../routing/session-key.js"; +export { runPassiveAccountLifecycle } from "./channel-lifecycle.js"; +export { createLoggerBackedRuntime } from "./runtime.js"; From e793e3873f6ea7d7dbd7741f810dc1554ee0d8ef Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:40:12 +0000 Subject: [PATCH 087/187] refactor(whatsapp): reuse login tool implementation --- .../runtime/runtime-whatsapp-login-tool.ts | 72 +------------------ 1 file changed, 1 insertion(+), 71 deletions(-) diff --git a/src/plugins/runtime/runtime-whatsapp-login-tool.ts b/src/plugins/runtime/runtime-whatsapp-login-tool.ts index 88b5d0e6138..811619b9099 100644 --- a/src/plugins/runtime/runtime-whatsapp-login-tool.ts +++ b/src/plugins/runtime/runtime-whatsapp-login-tool.ts @@ -1,71 +1 @@ -import { Type } from "@sinclair/typebox"; -import type { ChannelAgentTool } from "openclaw/plugin-sdk/channel-runtime"; - -export function createRuntimeWhatsAppLoginTool(): ChannelAgentTool { - return { - label: "WhatsApp Login", - name: "whatsapp_login", - ownerOnly: true, - description: "Generate a WhatsApp QR code for linking, or wait for the scan to complete.", - parameters: Type.Object({ - action: Type.Unsafe<"start" | "wait">({ - type: "string", - enum: ["start", "wait"], - }), - timeoutMs: Type.Optional(Type.Number()), - force: Type.Optional(Type.Boolean()), - }), - execute: async (_toolCallId, args) => { - const { startWebLoginWithQr, waitForWebLogin } = - await import("../../../extensions/whatsapp/src/login-qr.js"); - const action = (args as { action?: string })?.action ?? "start"; - if (action === "wait") { - const result = await waitForWebLogin({ - timeoutMs: - typeof (args as { timeoutMs?: unknown }).timeoutMs === "number" - ? (args as { timeoutMs?: number }).timeoutMs - : undefined, - }); - return { - content: [{ type: "text", text: result.message }], - details: { connected: result.connected }, - }; - } - - const result = await startWebLoginWithQr({ - timeoutMs: - typeof (args as { timeoutMs?: unknown }).timeoutMs === "number" - ? (args as { timeoutMs?: number }).timeoutMs - : undefined, - force: - typeof (args as { force?: unknown }).force === "boolean" - ? (args as { force?: boolean }).force - : false, - }); - - if (!result.qrDataUrl) { - return { - content: [ - { - type: "text", - text: result.message, - }, - ], - details: { qr: false }, - }; - } - - const text = [ - result.message, - "", - "Open WhatsApp -> Linked Devices and scan:", - "", - `![whatsapp-qr](${result.qrDataUrl})`, - ].join("\n"); - return { - content: [{ type: "text", text }], - details: { qr: true }, - }; - }, - }; -} +export { createWhatsAppLoginTool as createRuntimeWhatsAppLoginTool } from "../../../extensions/whatsapp/src/agent-tools-login.js"; From c974adf10d9f325dad175955094089e9d3e5efb2 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:44:51 +0000 Subject: [PATCH 088/187] refactor(providers): reuse simple api-key catalog helper --- extensions/modelstudio/index.ts | 24 ++++++++---------------- extensions/moonshot/index.ts | 24 ++++++++---------------- 2 files changed, 16 insertions(+), 32 deletions(-) diff --git a/extensions/modelstudio/index.ts b/extensions/modelstudio/index.ts index ad5c1852b59..20318b2a022 100644 --- a/extensions/modelstudio/index.ts +++ b/extensions/modelstudio/index.ts @@ -1,5 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyModelStudioConfig, applyModelStudioConfigCn, @@ -78,22 +79,13 @@ const modelStudioPlugin = { ], catalog: { order: "simple", - run: async (ctx) => { - const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; - if (!apiKey) { - return null; - } - const explicitProvider = ctx.config.models?.providers?.[PROVIDER_ID]; - const explicitBaseUrl = - typeof explicitProvider?.baseUrl === "string" ? explicitProvider.baseUrl.trim() : ""; - return { - provider: { - ...buildModelStudioProvider(), - ...(explicitBaseUrl ? { baseUrl: explicitBaseUrl } : {}), - apiKey, - }, - }; - }, + run: (ctx) => + buildSingleProviderApiKeyCatalog({ + ctx, + providerId: PROVIDER_ID, + buildProvider: buildModelStudioProvider, + allowExplicitBaseUrl: true, + }), }, }); }, diff --git a/extensions/moonshot/index.ts b/extensions/moonshot/index.ts index 80bd7af6763..c47c4a92d41 100644 --- a/extensions/moonshot/index.ts +++ b/extensions/moonshot/index.ts @@ -1,5 +1,6 @@ import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; +import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { createMoonshotThinkingWrapper, resolveMoonshotThinkingType, @@ -74,22 +75,13 @@ const moonshotPlugin = { ], catalog: { order: "simple", - run: async (ctx) => { - const apiKey = ctx.resolveProviderApiKey(PROVIDER_ID).apiKey; - if (!apiKey) { - return null; - } - const explicitProvider = ctx.config.models?.providers?.[PROVIDER_ID]; - const explicitBaseUrl = - typeof explicitProvider?.baseUrl === "string" ? explicitProvider.baseUrl.trim() : ""; - return { - provider: { - ...buildMoonshotProvider(), - ...(explicitBaseUrl ? { baseUrl: explicitBaseUrl } : {}), - apiKey, - }, - }; - }, + run: (ctx) => + buildSingleProviderApiKeyCatalog({ + ctx, + providerId: PROVIDER_ID, + buildProvider: buildMoonshotProvider, + allowExplicitBaseUrl: true, + }), }, wrapStreamFn: (ctx) => { const thinkingType = resolveMoonshotThinkingType({ From 45510084cdba5c0baa9685700b8d1e5c4d95570a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:45:54 +0000 Subject: [PATCH 089/187] refactor(plugins): share bundle path list helpers --- src/plugins/bundle-manifest.ts | 4 ++-- src/plugins/bundle-mcp.ts | 34 +++++----------------------------- 2 files changed, 7 insertions(+), 31 deletions(-) diff --git a/src/plugins/bundle-manifest.ts b/src/plugins/bundle-manifest.ts index 981eb9fd3a6..b5645035f5d 100644 --- a/src/plugins/bundle-manifest.ts +++ b/src/plugins/bundle-manifest.ts @@ -46,11 +46,11 @@ function normalizePathList(value: unknown): string[] { return value.map((entry) => (typeof entry === "string" ? entry.trim() : "")).filter(Boolean); } -function normalizeBundlePathList(value: unknown): string[] { +export function normalizeBundlePathList(value: unknown): string[] { return Array.from(new Set(normalizePathList(value))); } -function mergeBundlePathLists(...groups: string[][]): string[] { +export function mergeBundlePathLists(...groups: string[][]): string[] { const merged: string[] = []; const seen = new Set(); for (const group of groups) { diff --git a/src/plugins/bundle-mcp.ts b/src/plugins/bundle-mcp.ts index 29bd2b3a6c9..fbd733d9695 100644 --- a/src/plugins/bundle-mcp.ts +++ b/src/plugins/bundle-mcp.ts @@ -8,6 +8,8 @@ import { CLAUDE_BUNDLE_MANIFEST_RELATIVE_PATH, CODEX_BUNDLE_MANIFEST_RELATIVE_PATH, CURSOR_BUNDLE_MANIFEST_RELATIVE_PATH, + mergeBundlePathLists, + normalizeBundlePathList, } from "./bundle-manifest.js"; import { normalizePluginsConfig, resolveEffectiveEnableState } from "./config-state.js"; import { loadPluginManifestRegistry } from "./manifest-registry.js"; @@ -41,32 +43,6 @@ const MANIFEST_PATH_BY_FORMAT: Record = { }; const CLAUDE_PLUGIN_ROOT_PLACEHOLDER = "${CLAUDE_PLUGIN_ROOT}"; -function normalizePathList(value: unknown): string[] { - if (typeof value === "string") { - const trimmed = value.trim(); - return trimmed ? [trimmed] : []; - } - if (!Array.isArray(value)) { - return []; - } - return value.map((entry) => (typeof entry === "string" ? entry.trim() : "")).filter(Boolean); -} - -function mergeUniquePathLists(...groups: string[][]): string[] { - const merged: string[] = []; - const seen = new Set(); - for (const group of groups) { - for (const entry of group) { - if (seen.has(entry)) { - continue; - } - seen.add(entry); - merged.push(entry); - } - } - return merged; -} - function readPluginJsonObject(params: { rootDir: string; relativePath: string; @@ -103,12 +79,12 @@ function resolveBundleMcpConfigPaths(params: { rootDir: string; bundleFormat: PluginBundleFormat; }): string[] { - const declared = normalizePathList(params.raw.mcpServers); + const declared = normalizeBundlePathList(params.raw.mcpServers); const defaults = fs.existsSync(path.join(params.rootDir, ".mcp.json")) ? [".mcp.json"] : []; if (params.bundleFormat === "claude") { - return mergeUniquePathLists(defaults, declared); + return mergeBundlePathLists(defaults, declared); } - return mergeUniquePathLists(defaults, declared); + return mergeBundlePathLists(defaults, declared); } export function extractMcpServerMap(raw: unknown): Record { From 54419a826b2025ac650d21ff8d095cda0c3c14d9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:48:22 +0000 Subject: [PATCH 090/187] refactor(slack): reuse shared action adapter --- extensions/slack/src/channel.ts | 29 +++++---------------------- src/channels/plugins/slack.actions.ts | 21 ++++++++++++++----- 2 files changed, 21 insertions(+), 29 deletions(-) diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 52b8c632df7..99d0fe3cbdf 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -28,6 +28,7 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/slack"; +import { createSlackActions } from "../../../src/channels/plugins/slack.actions.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { listEnabledSlackAccounts, @@ -38,8 +39,6 @@ import { import { parseSlackBlocksInput } from "./blocks-input.js"; import { createSlackWebClient } from "./client.js"; import { isSlackInteractiveRepliesEnabled } from "./interactive-replies.js"; -import { handleSlackMessageAction } from "./message-action-dispatch.js"; -import { extractSlackToolSend, listSlackMessageActions } from "./message-actions.js"; import { normalizeAllowListLower } from "./monitor/allow-list.js"; import type { SlackProbe } from "./probe.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; @@ -488,28 +487,10 @@ export const slackPlugin: ChannelPlugin = { return resolved.map((entry) => toResolvedTarget(entry, entry.note)); }, }, - actions: { - listActions: ({ cfg }) => listSlackMessageActions(cfg), - getCapabilities: ({ cfg }) => { - const capabilities = new Set<"interactive" | "blocks">(); - if (listSlackMessageActions(cfg).includes("send")) { - capabilities.add("blocks"); - } - if (isSlackInteractiveRepliesEnabled({ cfg })) { - capabilities.add("interactive"); - } - return Array.from(capabilities); - }, - extractToolSend: ({ args }) => extractSlackToolSend(args), - handleAction: async (ctx) => - await handleSlackMessageAction({ - providerId: SLACK_CHANNEL, - ctx, - includeReadThreadId: true, - invoke: async (action, cfg, toolContext) => - await getSlackRuntime().channel.slack.handleSlackAction(action, cfg, toolContext), - }), - }, + actions: createSlackActions(SLACK_CHANNEL, { + invoke: async (action, cfg, toolContext) => + await getSlackRuntime().channel.slack.handleSlackAction(action, cfg, toolContext), + }), setup: slackSetupAdapter, outbound: { deliveryMode: "direct", diff --git a/src/channels/plugins/slack.actions.ts b/src/channels/plugins/slack.actions.ts index d559ca99b6a..e65a85d98f6 100644 --- a/src/channels/plugins/slack.actions.ts +++ b/src/channels/plugins/slack.actions.ts @@ -8,7 +8,16 @@ import { } from "../../plugin-sdk/slack.js"; import type { ChannelMessageActionAdapter } from "./types.js"; -export function createSlackActions(providerId: string): ChannelMessageActionAdapter { +type SlackActionInvoke = ( + action: Record, + cfg: unknown, + toolContext: unknown, +) => Promise; + +export function createSlackActions( + providerId: string, + options?: { invoke?: SlackActionInvoke }, +): ChannelMessageActionAdapter { return { listActions: ({ cfg }) => listSlackMessageActions(cfg), getCapabilities: ({ cfg }) => { @@ -29,10 +38,12 @@ export function createSlackActions(providerId: string): ChannelMessageActionAdap normalizeChannelId: resolveSlackChannelId, includeReadThreadId: true, invoke: async (action, cfg, toolContext) => - await handleSlackAction(action, cfg, { - ...(toolContext as SlackActionContext | undefined), - mediaLocalRoots: ctx.mediaLocalRoots, - }), + await (options?.invoke + ? options.invoke(action, cfg, toolContext) + : handleSlackAction(action, cfg, { + ...(toolContext as SlackActionContext | undefined), + mediaLocalRoots: ctx.mediaLocalRoots, + })), }); }, }; From 01c89a79853031a6149b64527812b3b07b72c320 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:50:59 +0000 Subject: [PATCH 091/187] refactor(tts): share provider readiness checks --- src/tts/tts.ts | 54 ++++++++++++++++++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 17 deletions(-) diff --git a/src/tts/tts.ts b/src/tts/tts.ts index 39793fd2ba4..7d48dfb8e07 100644 --- a/src/tts/tts.ts +++ b/src/tts/tts.ts @@ -572,6 +572,29 @@ function buildTtsFailureResult(errors: string[]): { success: false; error: strin }; } +function resolveReadySpeechProvider(params: { + provider: TtsProvider; + cfg: OpenClawConfig; + config: ResolvedTtsConfig; + errors: string[]; + requireTelephony?: boolean; +}): NonNullable> | null { + const resolvedProvider = getSpeechProvider(params.provider, params.cfg); + if (!resolvedProvider) { + params.errors.push(`${params.provider}: no provider registered`); + return null; + } + if (!resolvedProvider.isConfigured({ cfg: params.cfg, config: params.config })) { + params.errors.push(`${params.provider}: not configured`); + return null; + } + if (params.requireTelephony && !resolvedProvider.synthesizeTelephony) { + params.errors.push(`${params.provider}: unsupported for telephony`); + return null; + } + return resolvedProvider; +} + function resolveTtsRequestSetup(params: { text: string; cfg: OpenClawConfig; @@ -627,13 +650,13 @@ export async function textToSpeech(params: { for (const provider of providers) { const providerStart = Date.now(); try { - const resolvedProvider = getSpeechProvider(provider, params.cfg); + const resolvedProvider = resolveReadySpeechProvider({ + provider, + cfg: params.cfg, + config, + errors, + }); if (!resolvedProvider) { - errors.push(`${provider}: no provider registered`); - continue; - } - if (!resolvedProvider.isConfigured({ cfg: params.cfg, config })) { - errors.push(`${provider}: not configured`); continue; } const synthesis = await resolvedProvider.synthesize({ @@ -689,17 +712,14 @@ export async function textToSpeechTelephony(params: { for (const provider of providers) { const providerStart = Date.now(); try { - const resolvedProvider = getSpeechProvider(provider, params.cfg); - if (!resolvedProvider) { - errors.push(`${provider}: no provider registered`); - continue; - } - if (!resolvedProvider.isConfigured({ cfg: params.cfg, config })) { - errors.push(`${provider}: not configured`); - continue; - } - if (!resolvedProvider.synthesizeTelephony) { - errors.push(`${provider}: unsupported for telephony`); + const resolvedProvider = resolveReadySpeechProvider({ + provider, + cfg: params.cfg, + config, + errors, + requireTelephony: true, + }); + if (!resolvedProvider?.synthesizeTelephony) { continue; } const synthesis = await resolvedProvider.synthesizeTelephony({ From 4f5e3e1799c36cefb7c236a8a72763895910dd5a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:53:26 +0000 Subject: [PATCH 092/187] refactor(plugins): share claiming hook loop --- src/plugins/hooks.ts | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/src/plugins/hooks.ts b/src/plugins/hooks.ts index cffafd6645d..e8e1e2aa163 100644 --- a/src/plugins/hooks.ts +++ b/src/plugins/hooks.ts @@ -317,20 +317,7 @@ export function createHookRunner(registry: PluginRegistry, options: HookRunnerOp logger?.debug?.(`[hooks] running ${hookName} (${hooks.length} handlers, first-claim wins)`); - for (const hook of hooks) { - try { - const handlerResult = await ( - hook.handler as (event: unknown, ctx: unknown) => Promise - )(event, ctx); - if (handlerResult?.handled) { - return handlerResult; - } - } catch (err) { - handleHookError({ hookName, pluginId: hook.pluginId, error: err }); - } - } - - return undefined; + return await runClaimingHooksList(hooks, hookName, event, ctx); } async function runClaimingHookForPlugin< @@ -351,6 +338,18 @@ export function createHookRunner(registry: PluginRegistry, options: HookRunnerOp `[hooks] running ${hookName} for ${pluginId} (${hooks.length} handlers, targeted)`, ); + return await runClaimingHooksList(hooks, hookName, event, ctx); + } + + async function runClaimingHooksList< + K extends PluginHookName, + TResult extends { handled: boolean }, + >( + hooks: Array & { pluginId: string }>, + hookName: K, + event: Parameters["handler"]>>[0], + ctx: Parameters["handler"]>>[1], + ): Promise { for (const hook of hooks) { try { const handlerResult = await ( From 03c6946125ebbc9a06841ca7210e845b5a5a80aa Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 05:59:02 +0000 Subject: [PATCH 093/187] refactor(plugins): share install target flow --- src/plugins/install.ts | 212 +++++++++++++++++++++-------------------- 1 file changed, 111 insertions(+), 101 deletions(-) diff --git a/src/plugins/install.ts b/src/plugins/install.ts index e6b66381970..52ae9ebf2e1 100644 --- a/src/plugins/install.ts +++ b/src/plugins/install.ts @@ -198,6 +198,23 @@ function buildFileInstallResult(pluginId: string, targetFile: string): InstallPl }; } +function buildDirectoryInstallResult(params: { + pluginId: string; + targetDir: string; + manifestName?: string; + version?: string; + extensions: string[]; +}): InstallPluginResult { + return { + ok: true, + pluginId: params.pluginId, + targetDir: params.targetDir, + manifestName: params.manifestName, + version: params.version, + extensions: params.extensions, + }; +} + type PackageInstallCommonParams = { extensionsDir?: string; timeoutMs?: number; @@ -234,6 +251,80 @@ function pickFileInstallCommonParams(params: FileInstallCommonParams): FileInsta }; } +async function installPluginDirectoryIntoExtensions(params: { + sourceDir: string; + pluginId: string; + manifestName?: string; + version?: string; + extensions: string[]; + extensionsDir?: string; + logger: PluginInstallLogger; + timeoutMs: number; + mode: "install" | "update"; + dryRun: boolean; + copyErrorPrefix: string; + hasDeps: boolean; + depsLogMessage: string; + afterCopy?: (installedDir: string) => Promise; + nameEncoder?: (pluginId: string) => string; +}): Promise { + const extensionsDir = params.extensionsDir + ? resolveUserPath(params.extensionsDir) + : path.join(CONFIG_DIR, "extensions"); + const targetDirResult = await resolveCanonicalInstallTarget({ + baseDir: extensionsDir, + id: params.pluginId, + invalidNameMessage: "invalid plugin name: path traversal detected", + boundaryLabel: "extensions directory", + nameEncoder: params.nameEncoder, + }); + if (!targetDirResult.ok) { + return { ok: false, error: targetDirResult.error }; + } + const targetDir = targetDirResult.targetDir; + const availability = await ensureInstallTargetAvailable({ + mode: params.mode, + targetDir, + alreadyExistsError: `plugin already exists: ${targetDir} (delete it first)`, + }); + if (!availability.ok) { + return availability; + } + + if (params.dryRun) { + return buildDirectoryInstallResult({ + pluginId: params.pluginId, + targetDir, + manifestName: params.manifestName, + version: params.version, + extensions: params.extensions, + }); + } + + const installRes = await installPackageDir({ + sourceDir: params.sourceDir, + targetDir, + mode: params.mode, + timeoutMs: params.timeoutMs, + logger: params.logger, + copyErrorPrefix: params.copyErrorPrefix, + hasDeps: params.hasDeps, + depsLogMessage: params.depsLogMessage, + afterCopy: params.afterCopy, + }); + if (!installRes.ok) { + return installRes; + } + + return buildDirectoryInstallResult({ + pluginId: params.pluginId, + targetDir, + manifestName: params.manifestName, + version: params.version, + extensions: params.extensions, + }); +} + export function resolvePluginInstallDir(pluginId: string, extensionsDir?: string): string { const extensionsBase = extensionsDir ? resolveUserPath(extensionsDir) @@ -308,61 +399,21 @@ async function installBundleFromSourceDir( ); } - const extensionsDir = params.extensionsDir - ? resolveUserPath(params.extensionsDir) - : path.join(CONFIG_DIR, "extensions"); - const targetDirResult = await resolveCanonicalInstallTarget({ - baseDir: extensionsDir, - id: pluginId, - invalidNameMessage: "invalid plugin name: path traversal detected", - boundaryLabel: "extensions directory", - }); - if (!targetDirResult.ok) { - return { ok: false, error: targetDirResult.error }; - } - const targetDir = targetDirResult.targetDir; - const availability = await ensureInstallTargetAvailable({ - mode, - targetDir, - alreadyExistsError: `plugin already exists: ${targetDir} (delete it first)`, - }); - if (!availability.ok) { - return availability; - } - - if (dryRun) { - return { - ok: true, - pluginId, - targetDir, - manifestName: manifestRes.manifest.name, - version: manifestRes.manifest.version, - extensions: [], - }; - } - - const installRes = await installPackageDir({ + return await installPluginDirectoryIntoExtensions({ sourceDir: params.sourceDir, - targetDir, - mode, - timeoutMs, + pluginId, + manifestName: manifestRes.manifest.name, + version: manifestRes.manifest.version, + extensions: [], + extensionsDir: params.extensionsDir, logger, + timeoutMs, + mode, + dryRun, copyErrorPrefix: "failed to copy plugin bundle", hasDeps: false, depsLogMessage: "", }); - if (!installRes.ok) { - return installRes; - } - - return { - ok: true, - pluginId, - targetDir, - manifestName: manifestRes.manifest.name, - version: manifestRes.manifest.version, - extensions: [], - }; } async function installPluginFromSourceDir( @@ -514,51 +565,22 @@ async function installPluginFromPackageDir( ); } - const extensionsDir = params.extensionsDir - ? resolveUserPath(params.extensionsDir) - : path.join(CONFIG_DIR, "extensions"); - const targetDirResult = await resolveCanonicalInstallTarget({ - baseDir: extensionsDir, - id: pluginId, - invalidNameMessage: "invalid plugin name: path traversal detected", - boundaryLabel: "extensions directory", - nameEncoder: encodePluginInstallDirName, - }); - if (!targetDirResult.ok) { - return { ok: false, error: targetDirResult.error }; - } - const targetDir = targetDirResult.targetDir; - const availability = await ensureInstallTargetAvailable({ - mode, - targetDir, - alreadyExistsError: `plugin already exists: ${targetDir} (delete it first)`, - }); - if (!availability.ok) { - return availability; - } - - if (dryRun) { - return { - ok: true, - pluginId, - targetDir, - manifestName: pkgName || undefined, - version: typeof manifest.version === "string" ? manifest.version : undefined, - extensions, - }; - } - const deps = manifest.dependencies ?? {}; - const hasDeps = Object.keys(deps).length > 0; - const installRes = await installPackageDir({ + return await installPluginDirectoryIntoExtensions({ sourceDir: params.packageDir, - targetDir, - mode, - timeoutMs, + pluginId, + manifestName: pkgName || undefined, + version: typeof manifest.version === "string" ? manifest.version : undefined, + extensions, + extensionsDir: params.extensionsDir, logger, + timeoutMs, + mode, + dryRun, copyErrorPrefix: "failed to copy plugin", - hasDeps, + hasDeps: Object.keys(deps).length > 0, depsLogMessage: "Installing plugin dependencies…", + nameEncoder: encodePluginInstallDirName, afterCopy: async (installedDir) => { for (const entry of extensions) { const resolvedEntry = path.resolve(installedDir, entry); @@ -572,18 +594,6 @@ async function installPluginFromPackageDir( } }, }); - if (!installRes.ok) { - return installRes; - } - - return { - ok: true, - pluginId, - targetDir, - manifestName: pkgName || undefined, - version: typeof manifest.version === "string" ? manifest.version : undefined, - extensions, - }; } export async function installPluginFromArchive( From 143530407dd17530657d014fe37e0a16c209865a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:06:40 +0000 Subject: [PATCH 094/187] refactor(status): share scan helper state --- src/commands/status.scan.fast-json.ts | 252 +++----------------------- src/commands/status.scan.shared.ts | 157 ++++++++++++++++ src/commands/status.scan.test.ts | 14 +- src/commands/status.scan.ts | 159 +++------------- 4 files changed, 223 insertions(+), 359 deletions(-) create mode 100644 src/commands/status.scan.shared.ts diff --git a/src/commands/status.scan.fast-json.ts b/src/commands/status.scan.fast-json.ts index 505084ef992..73b0b1feae6 100644 --- a/src/commands/status.scan.fast-json.ts +++ b/src/commands/status.scan.fast-json.ts @@ -2,53 +2,25 @@ import { existsSync } from "node:fs"; import os from "node:os"; import path from "node:path"; import { hasPotentialConfiguredChannels } from "../channels/config-presence.js"; -import { resolveConfigPath, resolveGatewayPort, resolveStateDir } from "../config/paths.js"; +import { resolveConfigPath, resolveStateDir } from "../config/paths.js"; import type { OpenClawConfig } from "../config/types.js"; -import { isSecureWebSocketUrl } from "../gateway/net.js"; -import { probeGateway } from "../gateway/probe.js"; import { resolveOsSummary } from "../infra/os-summary.js"; -import type { MemoryProviderStatus } from "../memory/types.js"; import { runExec } from "../process/exec.js"; import type { RuntimeEnv } from "../runtime.js"; import { getAgentLocalStatuses } from "./status.agent-local.js"; -import { - pickGatewaySelfPresence, - resolveGatewayProbeAuthResolution, -} from "./status.gateway-probe.js"; import type { StatusScanResult } from "./status.scan.js"; +import { + buildTailscaleHttpsUrl, + pickGatewaySelfPresence, + resolveGatewayProbeSnapshot, + resolveMemoryPluginStatus, + resolveSharedMemoryStatusSnapshot, + type MemoryPluginStatus, + type MemoryStatusSnapshot, +} from "./status.scan.shared.js"; import { getStatusSummary } from "./status.summary.js"; import { getUpdateCheckResult } from "./status.update.js"; -type MemoryStatusSnapshot = MemoryProviderStatus & { - agentId: string; -}; - -type MemoryPluginStatus = { - enabled: boolean; - slot: string | null; - reason?: string; -}; - -type GatewayConnectionDetails = { - url: string; - urlSource: string; - bindDetail?: string; - remoteFallbackNote?: string; - message: string; -}; - -type GatewayProbeSnapshot = { - gatewayConnection: GatewayConnectionDetails; - remoteUrlMissing: boolean; - gatewayMode: "local" | "remote"; - gatewayProbeAuth: { - token?: string; - password?: string; - }; - gatewayProbeAuthWarning?: string; - gatewayProbe: Awaited> | null; -}; - let pluginRegistryModulePromise: Promise | undefined; let configIoModulePromise: Promise | undefined; let commandSecretTargetsModulePromise: @@ -100,204 +72,25 @@ function shouldSkipMissingConfigFastPath(): boolean { ); } -function hasExplicitMemorySearchConfig(cfg: OpenClawConfig, agentId: string): boolean { - if ( - cfg.agents?.defaults && - Object.prototype.hasOwnProperty.call(cfg.agents.defaults, "memorySearch") - ) { - return true; - } - const agents = Array.isArray(cfg.agents?.list) ? cfg.agents.list : []; - return agents.some( - (agent) => agent?.id === agentId && Object.prototype.hasOwnProperty.call(agent, "memorySearch"), - ); -} - -function normalizeControlUiBasePath(basePath?: string): string { - if (!basePath) { - return ""; - } - let normalized = basePath.trim(); - if (!normalized) { - return ""; - } - if (!normalized.startsWith("/")) { - normalized = `/${normalized}`; - } - if (normalized === "/") { - return ""; - } - if (normalized.endsWith("/")) { - normalized = normalized.slice(0, -1); - } - return normalized; -} - -function trimToUndefined(value: string | undefined): string | undefined { - const trimmed = value?.trim(); - return trimmed ? trimmed : undefined; -} - -function buildGatewayConnectionDetails(options: { - config: OpenClawConfig; - url?: string; - configPath?: string; - urlSource?: "cli" | "env"; -}): GatewayConnectionDetails { - const config = options.config; - const configPath = - options.configPath ?? resolveConfigPath(process.env, resolveStateDir(process.env)); - const isRemoteMode = config.gateway?.mode === "remote"; - const remote = isRemoteMode ? config.gateway?.remote : undefined; - const tlsEnabled = config.gateway?.tls?.enabled === true; - const localPort = resolveGatewayPort(config); - const bindMode = config.gateway?.bind ?? "loopback"; - const scheme = tlsEnabled ? "wss" : "ws"; - const localUrl = `${scheme}://127.0.0.1:${localPort}`; - const cliUrlOverride = - typeof options.url === "string" && options.url.trim().length > 0 - ? options.url.trim() - : undefined; - const envUrlOverride = cliUrlOverride - ? undefined - : (trimToUndefined(process.env.OPENCLAW_GATEWAY_URL) ?? - trimToUndefined(process.env.CLAWDBOT_GATEWAY_URL)); - const urlOverride = cliUrlOverride ?? envUrlOverride; - const remoteUrl = - typeof remote?.url === "string" && remote.url.trim().length > 0 ? remote.url.trim() : undefined; - const remoteMisconfigured = isRemoteMode && !urlOverride && !remoteUrl; - const urlSourceHint = - options.urlSource ?? (cliUrlOverride ? "cli" : envUrlOverride ? "env" : undefined); - const url = urlOverride || remoteUrl || localUrl; - const urlSource = urlOverride - ? urlSourceHint === "env" - ? "env OPENCLAW_GATEWAY_URL" - : "cli --url" - : remoteUrl - ? "config gateway.remote.url" - : remoteMisconfigured - ? "missing gateway.remote.url (fallback local)" - : "local loopback"; - const bindDetail = !urlOverride && !remoteUrl ? `Bind: ${bindMode}` : undefined; - const remoteFallbackNote = remoteMisconfigured - ? "Warn: gateway.mode=remote but gateway.remote.url is missing; set gateway.remote.url or switch gateway.mode=local." - : undefined; - const allowPrivateWs = process.env.OPENCLAW_ALLOW_INSECURE_PRIVATE_WS === "1"; - if (!isSecureWebSocketUrl(url, { allowPrivateWs })) { - throw new Error( - [ - `SECURITY ERROR: Gateway URL "${url}" uses plaintext ws:// to a non-loopback address.`, - "Both credentials and chat data would be exposed to network interception.", - `Source: ${urlSource}`, - `Config: ${configPath}`, - ].join("\n"), - ); - } - return { - url, - urlSource, - bindDetail, - remoteFallbackNote, - message: [ - `Gateway target: ${url}`, - `Source: ${urlSource}`, - `Config: ${configPath}`, - bindDetail, - remoteFallbackNote, - ] - .filter(Boolean) - .join("\n"), - }; -} - function resolveDefaultMemoryStorePath(agentId: string): string { return path.join(resolveStateDir(process.env, os.homedir), "memory", `${agentId}.sqlite`); } -function resolveMemoryPluginStatus(cfg: OpenClawConfig): MemoryPluginStatus { - const pluginsEnabled = cfg.plugins?.enabled !== false; - if (!pluginsEnabled) { - return { enabled: false, slot: null, reason: "plugins disabled" }; - } - const raw = typeof cfg.plugins?.slots?.memory === "string" ? cfg.plugins.slots.memory.trim() : ""; - if (raw && raw.toLowerCase() === "none") { - return { enabled: false, slot: null, reason: 'plugins.slots.memory="none"' }; - } - return { enabled: true, slot: raw || "memory-core" }; -} - -async function resolveGatewayProbeSnapshot(params: { - cfg: OpenClawConfig; - opts: { timeoutMs?: number; all?: boolean }; -}): Promise { - const gatewayConnection = buildGatewayConnectionDetails({ config: params.cfg }); - const isRemoteMode = params.cfg.gateway?.mode === "remote"; - const remoteUrlRaw = - typeof params.cfg.gateway?.remote?.url === "string" ? params.cfg.gateway.remote.url : ""; - const remoteUrlMissing = isRemoteMode && !remoteUrlRaw.trim(); - const gatewayMode = isRemoteMode ? "remote" : "local"; - const gatewayProbeAuthResolution = resolveGatewayProbeAuthResolution(params.cfg); - let gatewayProbeAuthWarning = gatewayProbeAuthResolution.warning; - const gatewayProbe = remoteUrlMissing - ? null - : await probeGateway({ - url: gatewayConnection.url, - auth: gatewayProbeAuthResolution.auth, - timeoutMs: Math.min(params.opts.all ? 5000 : 2500, params.opts.timeoutMs ?? 10_000), - detailLevel: "presence", - }).catch(() => null); - if (gatewayProbeAuthWarning && gatewayProbe?.ok === false) { - gatewayProbe.error = gatewayProbe.error - ? `${gatewayProbe.error}; ${gatewayProbeAuthWarning}` - : gatewayProbeAuthWarning; - gatewayProbeAuthWarning = undefined; - } - return { - gatewayConnection, - remoteUrlMissing, - gatewayMode, - gatewayProbeAuth: gatewayProbeAuthResolution.auth, - gatewayProbeAuthWarning, - gatewayProbe, - }; -} - async function resolveMemoryStatusSnapshot(params: { cfg: OpenClawConfig; agentStatus: Awaited>; memoryPlugin: MemoryPluginStatus; }): Promise { - const { cfg, agentStatus, memoryPlugin } = params; - if (!memoryPlugin.enabled || memoryPlugin.slot !== "memory-core") { - return null; - } - const agentId = agentStatus.defaultId ?? "main"; - const explicitMemoryConfig = hasExplicitMemorySearchConfig(cfg, agentId); - const defaultStorePath = resolveDefaultMemoryStorePath(agentId); - if (!explicitMemoryConfig && !existsSync(defaultStorePath)) { - return null; - } const { resolveMemorySearchConfig } = await loadMemorySearchModule(); - const resolvedMemory = resolveMemorySearchConfig(cfg, agentId); - if (!resolvedMemory) { - return null; - } - const shouldInspectStore = - hasExplicitMemorySearchConfig(cfg, agentId) || existsSync(resolvedMemory.store.path); - if (!shouldInspectStore) { - return null; - } const { getMemorySearchManager } = await loadStatusScanDepsRuntimeModule(); - const { manager } = await getMemorySearchManager({ cfg, agentId, purpose: "status" }); - if (!manager) { - return null; - } - try { - await manager.probeVectorAvailability(); - } catch {} - const status = manager.status(); - await manager.close?.().catch(() => {}); - return { agentId, ...status }; + return await resolveSharedMemoryStatusSnapshot({ + cfg: params.cfg, + agentStatus: params.agentStatus, + memoryPlugin: params.memoryPlugin, + resolveMemoryConfig: resolveMemorySearchConfig, + getMemorySearchManager, + requireDefaultStore: resolveDefaultMemoryStorePath, + }); } async function readStatusSourceConfig(): Promise { @@ -372,10 +165,11 @@ export async function scanStatusJsonFast( gatewayProbePromise, summaryPromise, ]); - const tailscaleHttpsUrl = - tailscaleMode !== "off" && tailscaleDns - ? `https://${tailscaleDns}${normalizeControlUiBasePath(cfg.gateway?.controlUi?.basePath)}` - : null; + const tailscaleHttpsUrl = buildTailscaleHttpsUrl({ + tailscaleMode, + tailscaleDns, + controlUiBasePath: cfg.gateway?.controlUi?.basePath, + }); const { gatewayConnection, diff --git a/src/commands/status.scan.shared.ts b/src/commands/status.scan.shared.ts new file mode 100644 index 00000000000..b855c85320a --- /dev/null +++ b/src/commands/status.scan.shared.ts @@ -0,0 +1,157 @@ +import { existsSync } from "node:fs"; +import type { OpenClawConfig } from "../config/types.js"; +import { buildGatewayConnectionDetails } from "../gateway/call.js"; +import { normalizeControlUiBasePath } from "../gateway/control-ui-shared.js"; +import { probeGateway } from "../gateway/probe.js"; +import type { MemoryProviderStatus } from "../memory/types.js"; +import { + pickGatewaySelfPresence, + resolveGatewayProbeAuthResolution, +} from "./status.gateway-probe.js"; + +export type MemoryStatusSnapshot = MemoryProviderStatus & { + agentId: string; +}; + +export type MemoryPluginStatus = { + enabled: boolean; + slot: string | null; + reason?: string; +}; + +export type GatewayProbeSnapshot = { + gatewayConnection: ReturnType; + remoteUrlMissing: boolean; + gatewayMode: "local" | "remote"; + gatewayProbeAuth: { + token?: string; + password?: string; + }; + gatewayProbeAuthWarning?: string; + gatewayProbe: Awaited> | null; +}; + +export function hasExplicitMemorySearchConfig(cfg: OpenClawConfig, agentId: string): boolean { + if ( + cfg.agents?.defaults && + Object.prototype.hasOwnProperty.call(cfg.agents.defaults, "memorySearch") + ) { + return true; + } + const agents = Array.isArray(cfg.agents?.list) ? cfg.agents.list : []; + return agents.some( + (agent) => agent?.id === agentId && Object.prototype.hasOwnProperty.call(agent, "memorySearch"), + ); +} + +export function resolveMemoryPluginStatus(cfg: OpenClawConfig): MemoryPluginStatus { + const pluginsEnabled = cfg.plugins?.enabled !== false; + if (!pluginsEnabled) { + return { enabled: false, slot: null, reason: "plugins disabled" }; + } + const raw = typeof cfg.plugins?.slots?.memory === "string" ? cfg.plugins.slots.memory.trim() : ""; + if (raw && raw.toLowerCase() === "none") { + return { enabled: false, slot: null, reason: 'plugins.slots.memory="none"' }; + } + return { enabled: true, slot: raw || "memory-core" }; +} + +export async function resolveGatewayProbeSnapshot(params: { + cfg: OpenClawConfig; + opts: { timeoutMs?: number; all?: boolean }; +}): Promise { + const gatewayConnection = buildGatewayConnectionDetails({ config: params.cfg }); + const isRemoteMode = params.cfg.gateway?.mode === "remote"; + const remoteUrlRaw = + typeof params.cfg.gateway?.remote?.url === "string" ? params.cfg.gateway.remote.url : ""; + const remoteUrlMissing = isRemoteMode && !remoteUrlRaw.trim(); + const gatewayMode = isRemoteMode ? "remote" : "local"; + const gatewayProbeAuthResolution = resolveGatewayProbeAuthResolution(params.cfg); + let gatewayProbeAuthWarning = gatewayProbeAuthResolution.warning; + const gatewayProbe = remoteUrlMissing + ? null + : await probeGateway({ + url: gatewayConnection.url, + auth: gatewayProbeAuthResolution.auth, + timeoutMs: Math.min(params.opts.all ? 5000 : 2500, params.opts.timeoutMs ?? 10_000), + detailLevel: "presence", + }).catch(() => null); + if (gatewayProbeAuthWarning && gatewayProbe?.ok === false) { + gatewayProbe.error = gatewayProbe.error + ? `${gatewayProbe.error}; ${gatewayProbeAuthWarning}` + : gatewayProbeAuthWarning; + gatewayProbeAuthWarning = undefined; + } + return { + gatewayConnection, + remoteUrlMissing, + gatewayMode, + gatewayProbeAuth: gatewayProbeAuthResolution.auth, + gatewayProbeAuthWarning, + gatewayProbe, + }; +} + +export function buildTailscaleHttpsUrl(params: { + tailscaleMode: string; + tailscaleDns: string | null; + controlUiBasePath?: string; +}): string | null { + return params.tailscaleMode !== "off" && params.tailscaleDns + ? `https://${params.tailscaleDns}${normalizeControlUiBasePath(params.controlUiBasePath)}` + : null; +} + +export async function resolveSharedMemoryStatusSnapshot(params: { + cfg: OpenClawConfig; + agentStatus: { defaultId?: string | null }; + memoryPlugin: MemoryPluginStatus; + resolveMemoryConfig: (cfg: OpenClawConfig, agentId: string) => { store: { path: string } } | null; + getMemorySearchManager: (params: { + cfg: OpenClawConfig; + agentId: string; + purpose: "status"; + }) => Promise<{ + manager: { + probeVectorAvailability(): Promise; + status(): MemoryProviderStatus; + close?(): Promise; + } | null; + }>; + requireDefaultStore?: (agentId: string) => string | null; +}): Promise { + const { cfg, agentStatus, memoryPlugin } = params; + if (!memoryPlugin.enabled || memoryPlugin.slot !== "memory-core") { + return null; + } + const agentId = agentStatus.defaultId ?? "main"; + const defaultStorePath = params.requireDefaultStore?.(agentId); + if ( + defaultStorePath && + !hasExplicitMemorySearchConfig(cfg, agentId) && + !existsSync(defaultStorePath) + ) { + return null; + } + const resolvedMemory = params.resolveMemoryConfig(cfg, agentId); + if (!resolvedMemory) { + return null; + } + const shouldInspectStore = + hasExplicitMemorySearchConfig(cfg, agentId) || existsSync(resolvedMemory.store.path); + if (!shouldInspectStore) { + return null; + } + const { manager } = await params.getMemorySearchManager({ cfg, agentId, purpose: "status" }); + if (!manager) { + return null; + } + try { + await manager.probeVectorAvailability(); + } catch {} + const status = manager.status(); + await manager.close?.().catch(() => {}); + return { agentId, ...status }; +} + +export { pickGatewaySelfPresence }; diff --git a/src/commands/status.scan.test.ts b/src/commands/status.scan.test.ts index edb77ae4fcf..168c2f55017 100644 --- a/src/commands/status.scan.test.ts +++ b/src/commands/status.scan.test.ts @@ -1,6 +1,7 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const mocks = vi.hoisted(() => ({ + hasPotentialConfiguredChannels: vi.fn(), readBestEffortConfig: vi.fn(), resolveCommandSecretRefsViaGateway: vi.fn(), buildChannelsTable: vi.fn(), @@ -15,6 +16,15 @@ const mocks = vi.hoisted(() => ({ ensurePluginRegistryLoaded: vi.fn(), })); +beforeEach(() => { + vi.clearAllMocks(); + mocks.hasPotentialConfiguredChannels.mockReturnValue(false); +}); + +vi.mock("../channels/config-presence.js", () => ({ + hasPotentialConfiguredChannels: mocks.hasPotentialConfiguredChannels, +})); + vi.mock("../cli/progress.js", () => ({ withProgress: vi.fn(async (_opts, run) => await run({ setLabel: vi.fn(), tick: vi.fn() })), })); @@ -333,6 +343,7 @@ describe("scanStatus", () => { }); it("preloads configured channel plugins for status --json when channel config exists", async () => { + mocks.hasPotentialConfiguredChannels.mockReturnValue(true); mocks.readBestEffortConfig.mockResolvedValue({ session: {}, plugins: { enabled: false }, @@ -395,6 +406,7 @@ describe("scanStatus", () => { }); it("preloads configured channel plugins for status --json when channel auth is env-only", async () => { + mocks.hasPotentialConfiguredChannels.mockReturnValue(true); const prevMatrixToken = process.env.MATRIX_ACCESS_TOKEN; process.env.MATRIX_ACCESS_TOKEN = "token"; mocks.readBestEffortConfig.mockResolvedValue({ diff --git a/src/commands/status.scan.ts b/src/commands/status.scan.ts index 6c2bd67f3dd..3eb6fc8ed3d 100644 --- a/src/commands/status.scan.ts +++ b/src/commands/status.scan.ts @@ -1,4 +1,3 @@ -import { existsSync } from "node:fs"; import { resolveMemorySearchConfig } from "../agents/memory-search.js"; import { hasPotentialConfiguredChannels } from "../channels/config-presence.js"; import { resolveCommandSecretRefsViaGateway } from "../cli/command-secret-gateway.js"; @@ -6,62 +5,30 @@ import { getStatusCommandSecretTargetIds } from "../cli/command-secret-targets.j import { withProgress } from "../cli/progress.js"; import type { OpenClawConfig } from "../config/config.js"; import { readBestEffortConfig } from "../config/config.js"; -import { buildGatewayConnectionDetails, callGateway } from "../gateway/call.js"; -import { normalizeControlUiBasePath } from "../gateway/control-ui-shared.js"; -import { probeGateway } from "../gateway/probe.js"; +import { callGateway } from "../gateway/call.js"; import { resolveOsSummary } from "../infra/os-summary.js"; -import type { MemoryProviderStatus } from "../memory/types.js"; import { runExec } from "../process/exec.js"; import type { RuntimeEnv } from "../runtime.js"; import { getAgentLocalStatuses } from "./status.agent-local.js"; -import { - pickGatewaySelfPresence, - resolveGatewayProbeAuthResolution, -} from "./status.gateway-probe.js"; import type { buildChannelsTable as buildChannelsTableFn, collectChannelStatusIssues as collectChannelStatusIssuesFn, } from "./status.scan.runtime.js"; +import { + buildTailscaleHttpsUrl, + pickGatewaySelfPresence, + resolveGatewayProbeSnapshot, + resolveMemoryPluginStatus, + resolveSharedMemoryStatusSnapshot, + type GatewayProbeSnapshot, + type MemoryPluginStatus, + type MemoryStatusSnapshot, +} from "./status.scan.shared.js"; import { getStatusSummary } from "./status.summary.js"; import { getUpdateCheckResult } from "./status.update.js"; -type MemoryStatusSnapshot = MemoryProviderStatus & { - agentId: string; -}; - -type MemoryPluginStatus = { - enabled: boolean; - slot: string | null; - reason?: string; -}; - -function hasExplicitMemorySearchConfig(cfg: OpenClawConfig, agentId: string): boolean { - if ( - cfg.agents?.defaults && - Object.prototype.hasOwnProperty.call(cfg.agents.defaults, "memorySearch") - ) { - return true; - } - const agents = Array.isArray(cfg.agents?.list) ? cfg.agents.list : []; - return agents.some( - (agent) => agent?.id === agentId && Object.prototype.hasOwnProperty.call(agent, "memorySearch"), - ); -} - type DeferredResult = { ok: true; value: T } | { ok: false; error: unknown }; -type GatewayProbeSnapshot = { - gatewayConnection: ReturnType; - remoteUrlMissing: boolean; - gatewayMode: "local" | "remote"; - gatewayProbeAuth: { - token?: string; - password?: string; - }; - gatewayProbeAuthWarning?: string; - gatewayProbe: Awaited> | null; -}; - let pluginRegistryModulePromise: Promise | undefined; let statusScanRuntimeModulePromise: Promise | undefined; let statusScanDepsRuntimeModulePromise: @@ -97,54 +64,6 @@ function unwrapDeferredResult(result: DeferredResult): T { return result.value; } -function resolveMemoryPluginStatus(cfg: OpenClawConfig): MemoryPluginStatus { - const pluginsEnabled = cfg.plugins?.enabled !== false; - if (!pluginsEnabled) { - return { enabled: false, slot: null, reason: "plugins disabled" }; - } - const raw = typeof cfg.plugins?.slots?.memory === "string" ? cfg.plugins.slots.memory.trim() : ""; - if (raw && raw.toLowerCase() === "none") { - return { enabled: false, slot: null, reason: 'plugins.slots.memory="none"' }; - } - return { enabled: true, slot: raw || "memory-core" }; -} - -async function resolveGatewayProbeSnapshot(params: { - cfg: OpenClawConfig; - opts: { timeoutMs?: number; all?: boolean }; -}): Promise { - const gatewayConnection = buildGatewayConnectionDetails({ config: params.cfg }); - const isRemoteMode = params.cfg.gateway?.mode === "remote"; - const remoteUrlRaw = - typeof params.cfg.gateway?.remote?.url === "string" ? params.cfg.gateway.remote.url : ""; - const remoteUrlMissing = isRemoteMode && !remoteUrlRaw.trim(); - const gatewayMode = isRemoteMode ? "remote" : "local"; - const gatewayProbeAuthResolution = resolveGatewayProbeAuthResolution(params.cfg); - let gatewayProbeAuthWarning = gatewayProbeAuthResolution.warning; - const gatewayProbe = remoteUrlMissing - ? null - : await probeGateway({ - url: gatewayConnection.url, - auth: gatewayProbeAuthResolution.auth, - timeoutMs: Math.min(params.opts.all ? 5000 : 2500, params.opts.timeoutMs ?? 10_000), - detailLevel: "presence", - }).catch(() => null); - if (gatewayProbeAuthWarning && gatewayProbe?.ok === false) { - gatewayProbe.error = gatewayProbe.error - ? `${gatewayProbe.error}; ${gatewayProbeAuthWarning}` - : gatewayProbeAuthWarning; - gatewayProbeAuthWarning = undefined; - } - return { - gatewayConnection, - remoteUrlMissing, - gatewayMode, - gatewayProbeAuth: gatewayProbeAuthResolution.auth, - gatewayProbeAuthWarning, - gatewayProbe, - }; -} - async function resolveChannelsStatus(params: { cfg: OpenClawConfig; gatewayReachable: boolean; @@ -173,7 +92,7 @@ export type StatusScanResult = { tailscaleDns: string | null; tailscaleHttpsUrl: string | null; update: Awaited>; - gatewayConnection: ReturnType; + gatewayConnection: GatewayProbeSnapshot["gatewayConnection"]; remoteUrlMissing: boolean; gatewayMode: "local" | "remote"; gatewayProbeAuth: { @@ -181,7 +100,7 @@ export type StatusScanResult = { password?: string; }; gatewayProbeAuthWarning?: string; - gatewayProbe: Awaited> | null; + gatewayProbe: GatewayProbeSnapshot["gatewayProbe"]; gatewayReachable: boolean; gatewaySelf: ReturnType; channelIssues: ReturnType; @@ -197,34 +116,14 @@ async function resolveMemoryStatusSnapshot(params: { agentStatus: Awaited>; memoryPlugin: MemoryPluginStatus; }): Promise { - const { cfg, agentStatus, memoryPlugin } = params; - if (!memoryPlugin.enabled) { - return null; - } - if (memoryPlugin.slot !== "memory-core") { - return null; - } - const agentId = agentStatus.defaultId ?? "main"; - const resolvedMemory = resolveMemorySearchConfig(cfg, agentId); - if (!resolvedMemory) { - return null; - } - const shouldInspectStore = - hasExplicitMemorySearchConfig(cfg, agentId) || existsSync(resolvedMemory.store.path); - if (!shouldInspectStore) { - return null; - } const { getMemorySearchManager } = await loadStatusScanDepsRuntimeModule(); - const { manager } = await getMemorySearchManager({ cfg, agentId, purpose: "status" }); - if (!manager) { - return null; - } - try { - await manager.probeVectorAvailability(); - } catch {} - const status = manager.status(); - await manager.close?.().catch(() => {}); - return { agentId, ...status }; + return await resolveSharedMemoryStatusSnapshot({ + cfg: params.cfg, + agentStatus: params.agentStatus, + memoryPlugin: params.memoryPlugin, + resolveMemoryConfig: resolveMemorySearchConfig, + getMemorySearchManager, + }); } async function scanStatusJsonFast(opts: { @@ -274,10 +173,11 @@ async function scanStatusJsonFast(opts: { gatewayProbePromise, summaryPromise, ]); - const tailscaleHttpsUrl = - tailscaleMode !== "off" && tailscaleDns - ? `https://${tailscaleDns}${normalizeControlUiBasePath(cfg.gateway?.controlUi?.basePath)}` - : null; + const tailscaleHttpsUrl = buildTailscaleHttpsUrl({ + tailscaleMode, + tailscaleDns, + controlUiBasePath: cfg.gateway?.controlUi?.basePath, + }); const { gatewayConnection, @@ -376,10 +276,11 @@ export async function scanStatus( progress.setLabel("Checking Tailscale…"); const tailscaleDns = await tailscaleDnsPromise; - const tailscaleHttpsUrl = - tailscaleMode !== "off" && tailscaleDns - ? `https://${tailscaleDns}${normalizeControlUiBasePath(cfg.gateway?.controlUi?.basePath)}` - : null; + const tailscaleHttpsUrl = buildTailscaleHttpsUrl({ + tailscaleMode, + tailscaleDns, + controlUiBasePath: cfg.gateway?.controlUi?.basePath, + }); progress.tick(); progress.setLabel("Checking for updates…"); From 520d753b277b39ebb65aca3bac7ffdd213923254 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:09:38 +0000 Subject: [PATCH 095/187] refactor(usage): share legacy pi auth token lookup --- extensions/zai/index.ts | 29 +------------- src/infra/provider-usage.auth.ts | 28 +------------ src/infra/provider-usage.shared.test.ts | 40 ++++++++++++++++++- src/infra/provider-usage.shared.ts | 34 ++++++++++++++++ src/plugin-sdk/provider-usage.ts | 6 ++- .../contracts/runtime.contract.test.ts | 30 ++++++++++++++ 6 files changed, 112 insertions(+), 55 deletions(-) diff --git a/extensions/zai/index.ts b/extensions/zai/index.ts index 109bf5144a1..33929645968 100644 --- a/extensions/zai/index.ts +++ b/extensions/zai/index.ts @@ -1,6 +1,3 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; import { emptyPluginConfigSchema, type OpenClawPluginApi, @@ -10,7 +7,6 @@ import { type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; -import { resolveRequiredHomeDir } from "openclaw/plugin-sdk/infra-runtime"; import { applyAuthProfileConfig, buildApiKeyCredential, @@ -23,7 +19,7 @@ import { } from "openclaw/plugin-sdk/provider-auth"; import { DEFAULT_CONTEXT_TOKENS, normalizeModelCompat } from "openclaw/plugin-sdk/provider-models"; import { createZaiToolStreamWrapper } from "openclaw/plugin-sdk/provider-stream"; -import { fetchZaiUsage } from "openclaw/plugin-sdk/provider-usage"; +import { fetchZaiUsage, resolveLegacyPiAgentAccessToken } from "openclaw/plugin-sdk/provider-usage"; import { detectZaiEndpoint, type ZaiEndpointId } from "./detect.js"; import { zaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyZaiConfig, applyZaiProviderConfig, ZAI_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -68,27 +64,6 @@ function resolveGlm5ForwardCompatModel( } as ProviderRuntimeModel); } -function resolveLegacyZaiUsageToken(env: NodeJS.ProcessEnv): string | undefined { - try { - const authPath = path.join( - resolveRequiredHomeDir(env, os.homedir), - ".pi", - "agent", - "auth.json", - ); - if (!fs.existsSync(authPath)) { - return undefined; - } - const parsed = JSON.parse(fs.readFileSync(authPath, "utf8")) as Record< - string, - { access?: string } - >; - return parsed["z-ai"]?.access || parsed.zai?.access; - } catch { - return undefined; - } -} - function resolveZaiDefaultModel(modelIdOverride?: string): string { return modelIdOverride ? `zai/${modelIdOverride}` : ZAI_DEFAULT_MODEL_REF; } @@ -328,7 +303,7 @@ const zaiPlugin = { if (apiKey) { return { token: apiKey }; } - const legacyToken = resolveLegacyZaiUsageToken(ctx.env); + const legacyToken = resolveLegacyPiAgentAccessToken(ctx.env, ["z-ai", "zai"]); return legacyToken ? { token: legacyToken } : null; }, fetchUsageSnapshot: async (ctx) => await fetchZaiUsage(ctx.token, ctx.timeoutMs, ctx.fetchFn), diff --git a/src/infra/provider-usage.auth.ts b/src/infra/provider-usage.auth.ts index dc62cece821..982ffbc8be5 100644 --- a/src/infra/provider-usage.auth.ts +++ b/src/infra/provider-usage.auth.ts @@ -1,6 +1,3 @@ -import fs from "node:fs"; -import os from "node:os"; -import path from "node:path"; import { dedupeProfileIds, ensureAuthProfileStore, @@ -12,9 +9,9 @@ import { isNonSecretApiKeyMarker } from "../agents/model-auth-markers.js"; import { resolveUsableCustomProviderApiKey } from "../agents/model-auth.js"; import { normalizeProviderId } from "../agents/model-selection.js"; import { loadConfig, type OpenClawConfig } from "../config/config.js"; -import { resolveRequiredHomeDir } from "../infra/home-dir.js"; import { resolveProviderUsageAuthWithPlugin } from "../plugins/provider-runtime.js"; import { normalizeSecretInput } from "../utils/normalize-secret-input.js"; +import { resolveLegacyPiAgentAccessToken } from "./provider-usage.shared.js"; import type { UsageProviderId } from "./provider-usage.types.js"; export type ProviderAuth = { @@ -44,27 +41,6 @@ function parseGoogleUsageToken(apiKey: string): string { return apiKey; } -function resolveLegacyZaiUsageToken(env: NodeJS.ProcessEnv): string | undefined { - try { - const authPath = path.join( - resolveRequiredHomeDir(env, os.homedir), - ".pi", - "agent", - "auth.json", - ); - if (!fs.existsSync(authPath)) { - return undefined; - } - const parsed = JSON.parse(fs.readFileSync(authPath, "utf8")) as Record< - string, - { access?: string } - >; - return parsed["z-ai"]?.access || parsed.zai?.access; - } catch { - return undefined; - } -} - function resolveProviderApiKeyFromConfigAndStore(params: { state: UsageAuthState; providerIds: string[]; @@ -225,7 +201,7 @@ async function resolveProviderUsageAuthFallback(params: { if (apiKey) { return { provider: "zai", token: apiKey }; } - const legacyToken = resolveLegacyZaiUsageToken(params.state.env); + const legacyToken = resolveLegacyPiAgentAccessToken(params.state.env, ["z-ai", "zai"]); return legacyToken ? { provider: "zai", token: legacyToken } : null; } case "minimax": { diff --git a/src/infra/provider-usage.shared.test.ts b/src/infra/provider-usage.shared.test.ts index 048352a183d..4f575f197ff 100644 --- a/src/infra/provider-usage.shared.test.ts +++ b/src/infra/provider-usage.shared.test.ts @@ -1,5 +1,13 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; import { afterEach, describe, expect, it, vi } from "vitest"; -import { clampPercent, resolveUsageProviderId, withTimeout } from "./provider-usage.shared.js"; +import { + clampPercent, + resolveLegacyPiAgentAccessToken, + resolveUsageProviderId, + withTimeout, +} from "./provider-usage.shared.js"; describe("provider-usage.shared", () => { afterEach(() => { @@ -52,4 +60,34 @@ describe("provider-usage.shared", () => { expect(clearTimeoutSpy).toHaveBeenCalledTimes(1); }); + + it("reads legacy pi auth tokens for known provider aliases", async () => { + const home = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-provider-usage-")); + await fs.mkdir(path.join(home, ".pi", "agent"), { recursive: true }); + await fs.writeFile( + path.join(home, ".pi", "agent", "auth.json"), + `${JSON.stringify({ "z-ai": { access: "legacy-zai-key" } }, null, 2)}\n`, + "utf8", + ); + + try { + expect(resolveLegacyPiAgentAccessToken({ HOME: home }, ["z-ai", "zai"])).toBe( + "legacy-zai-key", + ); + } finally { + await fs.rm(home, { recursive: true, force: true }); + } + }); + + it("returns undefined for invalid legacy pi auth files", async () => { + const home = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-provider-usage-")); + await fs.mkdir(path.join(home, ".pi", "agent"), { recursive: true }); + await fs.writeFile(path.join(home, ".pi", "agent", "auth.json"), "{not-json", "utf8"); + + try { + expect(resolveLegacyPiAgentAccessToken({ HOME: home }, ["z-ai", "zai"])).toBeUndefined(); + } finally { + await fs.rm(home, { recursive: true, force: true }); + } + }); }); diff --git a/src/infra/provider-usage.shared.ts b/src/infra/provider-usage.shared.ts index 6fa823db630..b801da4824c 100644 --- a/src/infra/provider-usage.shared.ts +++ b/src/infra/provider-usage.shared.ts @@ -1,4 +1,8 @@ +import fs from "node:fs"; +import os from "node:os"; +import path from "node:path"; import { normalizeProviderId } from "../agents/model-selection.js"; +import { resolveRequiredHomeDir } from "./home-dir.js"; import type { UsageProviderId } from "./provider-usage.types.js"; export const DEFAULT_TIMEOUT_MS = 5000; @@ -59,3 +63,33 @@ export const withTimeout = async (work: Promise, ms: number, fallback: T): } } }; + +export function resolveLegacyPiAgentAccessToken( + env: NodeJS.ProcessEnv, + providerIds: string[], +): string | undefined { + try { + const authPath = path.join( + resolveRequiredHomeDir(env, os.homedir), + ".pi", + "agent", + "auth.json", + ); + if (!fs.existsSync(authPath)) { + return undefined; + } + const parsed = JSON.parse(fs.readFileSync(authPath, "utf8")) as Record< + string, + { access?: string } + >; + for (const providerId of providerIds) { + const token = parsed[providerId]?.access; + if (typeof token === "string" && token.trim()) { + return token; + } + } + return undefined; + } catch { + return undefined; + } +} diff --git a/src/plugin-sdk/provider-usage.ts b/src/plugin-sdk/provider-usage.ts index 33757596965..9b63a53ea93 100644 --- a/src/plugin-sdk/provider-usage.ts +++ b/src/plugin-sdk/provider-usage.ts @@ -13,7 +13,11 @@ export { fetchMinimaxUsage, fetchZaiUsage, } from "../infra/provider-usage.fetch.js"; -export { clampPercent, PROVIDER_LABELS } from "../infra/provider-usage.shared.js"; +export { + clampPercent, + PROVIDER_LABELS, + resolveLegacyPiAgentAccessToken, +} from "../infra/provider-usage.shared.js"; export { buildUsageErrorSnapshot, buildUsageHttpErrorSnapshot, diff --git a/src/plugins/contracts/runtime.contract.test.ts b/src/plugins/contracts/runtime.contract.test.ts index 073ad01c960..87acf1f8a13 100644 --- a/src/plugins/contracts/runtime.contract.test.ts +++ b/src/plugins/contracts/runtime.contract.test.ts @@ -1,3 +1,6 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; import { describe, expect, it, vi } from "vitest"; import { createProviderUsageFetch, makeResponse } from "../../test-utils/provider-usage-fetch.js"; import type { ProviderRuntimeModel } from "../types.js"; @@ -514,6 +517,33 @@ describe("provider runtime contract", () => { }); }); + it("falls back to legacy pi auth tokens for usage auth", async () => { + const provider = requireProvider("zai"); + const home = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-zai-contract-")); + await fs.mkdir(path.join(home, ".pi", "agent"), { recursive: true }); + await fs.writeFile( + path.join(home, ".pi", "agent", "auth.json"), + `${JSON.stringify({ "z-ai": { access: "legacy-zai-token" } }, null, 2)}\n`, + "utf8", + ); + + try { + await expect( + provider.resolveUsageAuth?.({ + config: {} as never, + env: { HOME: home } as NodeJS.ProcessEnv, + provider: "zai", + resolveApiKeyFromConfigAndStore: () => undefined, + resolveOAuthToken: async () => null, + }), + ).resolves.toEqual({ + token: "legacy-zai-token", + }); + } finally { + await fs.rm(home, { recursive: true, force: true }); + } + }); + it("owns usage snapshot fetching", async () => { const provider = requireProviderContractProvider("zai"); const mockFetch = createProviderUsageFetch(async (url) => { From 43838b1b145d3921f7939a2abc3bf274efe4ac55 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:11:38 +0000 Subject: [PATCH 096/187] refactor(device): share missing-scope helper --- src/gateway/server-methods/devices.ts | 23 ++--------------------- src/infra/device-pairing.ts | 23 ++--------------------- src/shared/operator-scope-compat.test.ts | 22 +++++++++++++++++++++- src/shared/operator-scope-compat.ts | 19 +++++++++++++++++++ 4 files changed, 44 insertions(+), 43 deletions(-) diff --git a/src/gateway/server-methods/devices.ts b/src/gateway/server-methods/devices.ts index 862aaf95f06..3917f49d301 100644 --- a/src/gateway/server-methods/devices.ts +++ b/src/gateway/server-methods/devices.ts @@ -11,7 +11,7 @@ import { summarizeDeviceTokens, } from "../../infra/device-pairing.js"; import { normalizeDeviceAuthScopes } from "../../shared/device-auth.js"; -import { roleScopesAllow } from "../../shared/operator-scope-compat.js"; +import { resolveMissingRequestedScope } from "../../shared/operator-scope-compat.js"; import { ErrorCodes, errorShape, @@ -37,25 +37,6 @@ function redactPairedDevice( }; } -function resolveMissingRequestedScope(params: { - role: string; - requestedScopes: readonly string[]; - callerScopes: readonly string[]; -}): string | null { - for (const scope of params.requestedScopes) { - if ( - !roleScopesAllow({ - role: params.role, - requestedScopes: [scope], - allowedScopes: params.callerScopes, - }) - ) { - return scope; - } - } - return null; -} - function logDeviceTokenRotationDenied(params: { log: { warn: (message: string) => void }; deviceId: string; @@ -234,7 +215,7 @@ export const deviceHandlers: GatewayRequestHandlers = { const missingScope = resolveMissingRequestedScope({ role, requestedScopes, - callerScopes, + allowedScopes: callerScopes, }); if (missingScope) { logDeviceTokenRotationDenied({ diff --git a/src/infra/device-pairing.ts b/src/infra/device-pairing.ts index e6cf9259a66..063834a17de 100644 --- a/src/infra/device-pairing.ts +++ b/src/infra/device-pairing.ts @@ -1,6 +1,6 @@ import { randomUUID } from "node:crypto"; import { normalizeDeviceAuthScopes } from "../shared/device-auth.js"; -import { roleScopesAllow } from "../shared/operator-scope-compat.js"; +import { resolveMissingRequestedScope, roleScopesAllow } from "../shared/operator-scope-compat.js"; import { createAsyncLock, pruneExpiredPending, @@ -256,25 +256,6 @@ function scopesWithinApprovedDeviceBaseline(params: { }); } -function resolveMissingRequestedScope(params: { - role: string; - requestedScopes: readonly string[]; - callerScopes: readonly string[]; -}): string | null { - for (const scope of params.requestedScopes) { - if ( - !roleScopesAllow({ - role: params.role, - requestedScopes: [scope], - allowedScopes: params.callerScopes, - }) - ) { - return scope; - } - } - return null; -} - export async function listDevicePairing(baseDir?: string): Promise { const state = await loadState(baseDir); const pending = Object.values(state.pendingById).toSorted((a, b) => b.ts - a.ts); @@ -377,7 +358,7 @@ export async function approveDevicePairing( const missingScope = resolveMissingRequestedScope({ role: pending.role, requestedScopes: normalizeDeviceAuthScopes(pending.scopes), - callerScopes: options.callerScopes, + allowedScopes: options.callerScopes, }); if (missingScope) { return { status: "forbidden", missingScope }; diff --git a/src/shared/operator-scope-compat.test.ts b/src/shared/operator-scope-compat.test.ts index 44236ca7341..895b9665d12 100644 --- a/src/shared/operator-scope-compat.test.ts +++ b/src/shared/operator-scope-compat.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { roleScopesAllow } from "./operator-scope-compat.js"; +import { resolveMissingRequestedScope, roleScopesAllow } from "./operator-scope-compat.js"; describe("roleScopesAllow", () => { it("allows empty requested scope lists regardless of granted scopes", () => { @@ -130,4 +130,24 @@ describe("roleScopesAllow", () => { }), ).toBe(false); }); + + it("returns the first missing requested scope with operator compatibility", () => { + expect( + resolveMissingRequestedScope({ + role: "operator", + requestedScopes: ["operator.read", "operator.write", "operator.approvals"], + allowedScopes: ["operator.write"], + }), + ).toBe("operator.approvals"); + }); + + it("returns null when all requested scopes are satisfied", () => { + expect( + resolveMissingRequestedScope({ + role: "node", + requestedScopes: ["system.run"], + allowedScopes: ["system.run", "operator.admin"], + }), + ).toBeNull(); + }); }); diff --git a/src/shared/operator-scope-compat.ts b/src/shared/operator-scope-compat.ts index 4b1d954b70f..cf184558caa 100644 --- a/src/shared/operator-scope-compat.ts +++ b/src/shared/operator-scope-compat.ts @@ -47,3 +47,22 @@ export function roleScopesAllow(params: { } return requested.every((scope) => operatorScopeSatisfied(scope, allowedSet)); } + +export function resolveMissingRequestedScope(params: { + role: string; + requestedScopes: readonly string[]; + allowedScopes: readonly string[]; +}): string | null { + for (const scope of params.requestedScopes) { + if ( + !roleScopesAllow({ + role: params.role, + requestedScopes: [scope], + allowedScopes: params.allowedScopes, + }) + ) { + return scope; + } + } + return null; +} From 2ed5ad36ae210acd3113b0c23cc5089534a588d4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:16:03 +0000 Subject: [PATCH 097/187] refactor(config): share schema lookup helpers --- src/config/doc-baseline.ts | 63 +++------------------------ src/config/schema.shared.test.ts | 28 ++++++++++++ src/config/schema.shared.ts | 73 ++++++++++++++++++++++++++++++++ src/config/schema.ts | 52 +++-------------------- 4 files changed, 113 insertions(+), 103 deletions(-) create mode 100644 src/config/schema.shared.test.ts create mode 100644 src/config/schema.shared.ts diff --git a/src/config/doc-baseline.ts b/src/config/doc-baseline.ts index 4ff03af91e0..396634cb088 100644 --- a/src/config/doc-baseline.ts +++ b/src/config/doc-baseline.ts @@ -7,6 +7,7 @@ import { resolveOpenClawPackageRootSync } from "../infra/openclaw-root.js"; import { loadPluginManifestRegistry } from "../plugins/manifest-registry.js"; import { FIELD_HELP } from "./schema.help.js"; import { buildConfigSchema, type ConfigSchemaResponse } from "./schema.js"; +import { findWildcardHintMatch, schemaHasChildren } from "./schema.shared.js"; type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue }; @@ -132,24 +133,6 @@ function asSchemaObject(value: unknown): JsonSchemaObject | null { return value as JsonSchemaObject; } -function schemaHasChildren(schema: JsonSchemaObject): boolean { - if (schema.properties && Object.keys(schema.properties).length > 0) { - return true; - } - if (schema.additionalProperties && typeof schema.additionalProperties === "object") { - return true; - } - if (Array.isArray(schema.items)) { - return schema.items.some((entry) => typeof entry === "object" && entry !== null); - } - for (const branch of [schema.oneOf, schema.anyOf, schema.allOf]) { - if (branch?.some((entry) => entry && typeof entry === "object" && schemaHasChildren(entry))) { - return true; - } - } - return Boolean(schema.items && typeof schema.items === "object"); -} - function splitHintLookupPath(path: string): string[] { const normalized = normalizeBaselinePath(path); return normalized ? normalized.split(".").filter(Boolean) : []; @@ -159,45 +142,11 @@ function resolveUiHintMatch( uiHints: ConfigSchemaResponse["uiHints"], path: string, ): ConfigSchemaResponse["uiHints"][string] | undefined { - const targetParts = splitHintLookupPath(path); - let bestMatch: - | { - hint: ConfigSchemaResponse["uiHints"][string]; - wildcardCount: number; - } - | undefined; - - for (const [hintPath, hint] of Object.entries(uiHints)) { - const hintParts = splitHintLookupPath(hintPath); - if (hintParts.length !== targetParts.length) { - continue; - } - - let wildcardCount = 0; - let matches = true; - for (let index = 0; index < hintParts.length; index += 1) { - const hintPart = hintParts[index]; - const targetPart = targetParts[index]; - if (hintPart === targetPart) { - continue; - } - if (hintPart === "*") { - wildcardCount += 1; - continue; - } - matches = false; - break; - } - - if (!matches) { - continue; - } - if (!bestMatch || wildcardCount < bestMatch.wildcardCount) { - bestMatch = { hint, wildcardCount }; - } - } - - return bestMatch?.hint; + return findWildcardHintMatch({ + uiHints, + path, + splitPath: splitHintLookupPath, + })?.hint; } function normalizeTypeValue(value: string | string[] | undefined): string | string[] | undefined { diff --git a/src/config/schema.shared.test.ts b/src/config/schema.shared.test.ts new file mode 100644 index 00000000000..48820fbf029 --- /dev/null +++ b/src/config/schema.shared.test.ts @@ -0,0 +1,28 @@ +import { describe, expect, it } from "vitest"; +import { findWildcardHintMatch, schemaHasChildren } from "./schema.shared.js"; + +describe("schema.shared", () => { + it("prefers the most specific wildcard hint match", () => { + const match = findWildcardHintMatch({ + uiHints: { + "channels.*.token": { label: "wildcard" }, + "channels.telegram.token": { label: "telegram" }, + }, + path: "channels.telegram.token", + splitPath: (value) => value.split("."), + }); + + expect(match).toEqual({ + path: "channels.telegram.token", + hint: { label: "telegram" }, + }); + }); + + it("treats branch schemas as having children", () => { + expect( + schemaHasChildren({ + oneOf: [{ type: "string" }, { properties: { token: { type: "string" } } }], + }), + ).toBe(true); + }); +}); diff --git a/src/config/schema.shared.ts b/src/config/schema.shared.ts new file mode 100644 index 00000000000..148d5b3fb86 --- /dev/null +++ b/src/config/schema.shared.ts @@ -0,0 +1,73 @@ +type JsonSchemaObject = { + properties?: Record; + additionalProperties?: JsonSchemaObject | boolean; + items?: JsonSchemaObject | JsonSchemaObject[]; + anyOf?: JsonSchemaObject[]; + allOf?: JsonSchemaObject[]; + oneOf?: JsonSchemaObject[]; +}; + +export function schemaHasChildren(schema: JsonSchemaObject): boolean { + if (schema.properties && Object.keys(schema.properties).length > 0) { + return true; + } + if (schema.additionalProperties && typeof schema.additionalProperties === "object") { + return true; + } + if (Array.isArray(schema.items)) { + return schema.items.some((entry) => typeof entry === "object" && entry !== null); + } + for (const branch of [schema.oneOf, schema.anyOf, schema.allOf]) { + if (branch?.some((entry) => entry && typeof entry === "object" && schemaHasChildren(entry))) { + return true; + } + } + return Boolean(schema.items && typeof schema.items === "object"); +} + +export function findWildcardHintMatch(params: { + uiHints: Record; + path: string; + splitPath: (path: string) => string[]; +}): { path: string; hint: T } | null { + const targetParts = params.splitPath(params.path); + let bestMatch: + | { + path: string; + hint: T; + wildcardCount: number; + } + | undefined; + + for (const [hintPath, hint] of Object.entries(params.uiHints)) { + const hintParts = params.splitPath(hintPath); + if (hintParts.length !== targetParts.length) { + continue; + } + + let wildcardCount = 0; + let matches = true; + for (let index = 0; index < hintParts.length; index += 1) { + const hintPart = hintParts[index]; + const targetPart = targetParts[index]; + if (hintPart === targetPart) { + continue; + } + if (hintPart === "*") { + wildcardCount += 1; + continue; + } + matches = false; + break; + } + + if (!matches) { + continue; + } + if (!bestMatch || wildcardCount < bestMatch.wildcardCount) { + bestMatch = { path: hintPath, hint, wildcardCount }; + } + } + + return bestMatch ? { path: bestMatch.path, hint: bestMatch.hint } : null; +} diff --git a/src/config/schema.ts b/src/config/schema.ts index 83227a375d5..c81e08ea3c3 100644 --- a/src/config/schema.ts +++ b/src/config/schema.ts @@ -3,6 +3,7 @@ import { CHANNEL_IDS } from "../channels/registry.js"; import { VERSION } from "../version.js"; import type { ConfigUiHint, ConfigUiHints } from "./schema.hints.js"; import { applySensitiveHints, buildBaseHints, mapSensitivePaths } from "./schema.hints.js"; +import { findWildcardHintMatch, schemaHasChildren } from "./schema.shared.js"; import { applyDerivedTags } from "./schema.tags.js"; import { OpenClawSchema } from "./zod-schema.js"; @@ -500,52 +501,11 @@ function resolveUiHintMatch( uiHints: ConfigUiHints, path: string, ): { path: string; hint: ConfigUiHint } | null { - const targetParts = splitLookupPath(path); - let best: { path: string; hint: ConfigUiHint; wildcardCount: number } | null = null; - - for (const [hintPath, hint] of Object.entries(uiHints)) { - const hintParts = splitLookupPath(hintPath); - if (hintParts.length !== targetParts.length) { - continue; - } - - let wildcardCount = 0; - let matches = true; - for (let index = 0; index < hintParts.length; index += 1) { - const hintPart = hintParts[index]; - const targetPart = targetParts[index]; - if (hintPart === targetPart) { - continue; - } - if (hintPart === "*") { - wildcardCount += 1; - continue; - } - matches = false; - break; - } - if (!matches) { - continue; - } - if (!best || wildcardCount < best.wildcardCount) { - best = { path: hintPath, hint, wildcardCount }; - } - } - - return best ? { path: best.path, hint: best.hint } : null; -} - -function schemaHasChildren(schema: JsonSchemaObject): boolean { - if (schema.properties && Object.keys(schema.properties).length > 0) { - return true; - } - if (schema.additionalProperties && typeof schema.additionalProperties === "object") { - return true; - } - if (Array.isArray(schema.items)) { - return schema.items.some((entry) => typeof entry === "object" && entry !== null); - } - return Boolean(schema.items && typeof schema.items === "object"); + return findWildcardHintMatch({ + uiHints, + path, + splitPath: splitLookupPath, + }); } function resolveItemsSchema(schema: JsonSchemaObject, index?: number): JsonSchemaObject | null { From e32976f8cf48ae184c097b72657af5a8800cc798 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:23:50 +0000 Subject: [PATCH 098/187] fix(plugin-sdk): restore core export boundary --- src/plugin-sdk/core.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/plugin-sdk/core.ts b/src/plugin-sdk/core.ts index cfc600624a3..a6c842e79d5 100644 --- a/src/plugin-sdk/core.ts +++ b/src/plugin-sdk/core.ts @@ -70,5 +70,3 @@ export { export { buildOutboundBaseSessionKey } from "../infra/outbound/base-session-key.js"; export { normalizeOutboundThreadId } from "../infra/outbound/thread-id.js"; export { resolveThreadSessionKeys } from "../routing/session-key.js"; -export { runPassiveAccountLifecycle } from "./channel-lifecycle.js"; -export { createLoggerBackedRuntime } from "./runtime.js"; From 38a6415a701cf4bfa7067bdf5d938e0dd7ac5a74 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:23:54 -0700 Subject: [PATCH 099/187] build: tighten lazy runtime boundaries --- .../src/monitor/slash-commands.runtime.ts | 52 +++++- .../src/monitor/slash-dispatch.runtime.ts | 92 +++++++++- .../monitor/slash-skill-commands.runtime.ts | 11 +- scripts/tsdown-build.mjs | 20 ++- src/plugins/provider-auth-choice.runtime.ts | 31 +++- .../runtime/runtime-discord-ops.runtime.ts | 167 ++++++++++++++++-- .../runtime/runtime-slack-ops.runtime.ts | 78 +++++++- .../runtime/runtime-telegram-ops.runtime.ts | 141 +++++++++++++-- .../runtime/runtime-whatsapp-login.runtime.ts | 8 +- .../runtime-whatsapp-outbound.runtime.ts | 21 ++- 10 files changed, 556 insertions(+), 65 deletions(-) diff --git a/extensions/slack/src/monitor/slash-commands.runtime.ts b/extensions/slack/src/monitor/slash-commands.runtime.ts index 63fa59cd347..aaae82a0602 100644 --- a/extensions/slack/src/monitor/slash-commands.runtime.ts +++ b/extensions/slack/src/monitor/slash-commands.runtime.ts @@ -1,7 +1,47 @@ -export { - buildCommandTextFromArgs, - findCommandByNativeName, - listNativeCommandSpecsForConfig, - parseCommandArgs, - resolveCommandArgMenu, +import { + buildCommandTextFromArgs as buildCommandTextFromArgsImpl, + findCommandByNativeName as findCommandByNativeNameImpl, + listNativeCommandSpecsForConfig as listNativeCommandSpecsForConfigImpl, + parseCommandArgs as parseCommandArgsImpl, + resolveCommandArgMenu as resolveCommandArgMenuImpl, } from "openclaw/plugin-sdk/reply-runtime"; + +type BuildCommandTextFromArgs = + typeof import("openclaw/plugin-sdk/reply-runtime").buildCommandTextFromArgs; +type FindCommandByNativeName = + typeof import("openclaw/plugin-sdk/reply-runtime").findCommandByNativeName; +type ListNativeCommandSpecsForConfig = + typeof import("openclaw/plugin-sdk/reply-runtime").listNativeCommandSpecsForConfig; +type ParseCommandArgs = typeof import("openclaw/plugin-sdk/reply-runtime").parseCommandArgs; +type ResolveCommandArgMenu = + typeof import("openclaw/plugin-sdk/reply-runtime").resolveCommandArgMenu; + +export function buildCommandTextFromArgs( + ...args: Parameters +): ReturnType { + return buildCommandTextFromArgsImpl(...args); +} + +export function findCommandByNativeName( + ...args: Parameters +): ReturnType { + return findCommandByNativeNameImpl(...args); +} + +export function listNativeCommandSpecsForConfig( + ...args: Parameters +): ReturnType { + return listNativeCommandSpecsForConfigImpl(...args); +} + +export function parseCommandArgs( + ...args: Parameters +): ReturnType { + return parseCommandArgsImpl(...args); +} + +export function resolveCommandArgMenu( + ...args: Parameters +): ReturnType { + return resolveCommandArgMenuImpl(...args); +} diff --git a/extensions/slack/src/monitor/slash-dispatch.runtime.ts b/extensions/slack/src/monitor/slash-dispatch.runtime.ts index 0095471359c..3c94004c7b1 100644 --- a/extensions/slack/src/monitor/slash-dispatch.runtime.ts +++ b/extensions/slack/src/monitor/slash-dispatch.runtime.ts @@ -1,9 +1,83 @@ -export { resolveChunkMode } from "openclaw/plugin-sdk/reply-runtime"; -export { finalizeInboundContext } from "openclaw/plugin-sdk/reply-runtime"; -export { dispatchReplyWithDispatcher } from "openclaw/plugin-sdk/reply-runtime"; -export { resolveConversationLabel } from "openclaw/plugin-sdk/channel-runtime"; -export { createReplyPrefixOptions } from "openclaw/plugin-sdk/channel-runtime"; -export { recordInboundSessionMetaSafe } from "openclaw/plugin-sdk/channel-runtime"; -export { resolveMarkdownTableMode } from "openclaw/plugin-sdk/config-runtime"; -export { resolveAgentRoute } from "openclaw/plugin-sdk/routing"; -export { deliverSlackSlashReplies } from "./replies.js"; +import { + createReplyPrefixOptions as createReplyPrefixOptionsImpl, + recordInboundSessionMetaSafe as recordInboundSessionMetaSafeImpl, + resolveConversationLabel as resolveConversationLabelImpl, +} from "openclaw/plugin-sdk/channel-runtime"; +import { resolveMarkdownTableMode as resolveMarkdownTableModeImpl } from "openclaw/plugin-sdk/config-runtime"; +import { + dispatchReplyWithDispatcher as dispatchReplyWithDispatcherImpl, + finalizeInboundContext as finalizeInboundContextImpl, + resolveChunkMode as resolveChunkModeImpl, +} from "openclaw/plugin-sdk/reply-runtime"; +import { resolveAgentRoute as resolveAgentRouteImpl } from "openclaw/plugin-sdk/routing"; +import { deliverSlackSlashReplies as deliverSlackSlashRepliesImpl } from "./replies.js"; + +type ResolveChunkMode = typeof import("openclaw/plugin-sdk/reply-runtime").resolveChunkMode; +type FinalizeInboundContext = + typeof import("openclaw/plugin-sdk/reply-runtime").finalizeInboundContext; +type DispatchReplyWithDispatcher = + typeof import("openclaw/plugin-sdk/reply-runtime").dispatchReplyWithDispatcher; +type ResolveConversationLabel = + typeof import("openclaw/plugin-sdk/channel-runtime").resolveConversationLabel; +type CreateReplyPrefixOptions = + typeof import("openclaw/plugin-sdk/channel-runtime").createReplyPrefixOptions; +type RecordInboundSessionMetaSafe = + typeof import("openclaw/plugin-sdk/channel-runtime").recordInboundSessionMetaSafe; +type ResolveMarkdownTableMode = + typeof import("openclaw/plugin-sdk/config-runtime").resolveMarkdownTableMode; +type ResolveAgentRoute = typeof import("openclaw/plugin-sdk/routing").resolveAgentRoute; +type DeliverSlackSlashReplies = typeof import("./replies.js").deliverSlackSlashReplies; + +export function resolveChunkMode( + ...args: Parameters +): ReturnType { + return resolveChunkModeImpl(...args); +} + +export function finalizeInboundContext( + ...args: Parameters +): ReturnType { + return finalizeInboundContextImpl(...args); +} + +export function dispatchReplyWithDispatcher( + ...args: Parameters +): ReturnType { + return dispatchReplyWithDispatcherImpl(...args); +} + +export function resolveConversationLabel( + ...args: Parameters +): ReturnType { + return resolveConversationLabelImpl(...args); +} + +export function createReplyPrefixOptions( + ...args: Parameters +): ReturnType { + return createReplyPrefixOptionsImpl(...args); +} + +export function recordInboundSessionMetaSafe( + ...args: Parameters +): ReturnType { + return recordInboundSessionMetaSafeImpl(...args); +} + +export function resolveMarkdownTableMode( + ...args: Parameters +): ReturnType { + return resolveMarkdownTableModeImpl(...args); +} + +export function resolveAgentRoute( + ...args: Parameters +): ReturnType { + return resolveAgentRouteImpl(...args); +} + +export function deliverSlackSlashReplies( + ...args: Parameters +): ReturnType { + return deliverSlackSlashRepliesImpl(...args); +} diff --git a/extensions/slack/src/monitor/slash-skill-commands.runtime.ts b/extensions/slack/src/monitor/slash-skill-commands.runtime.ts index 738580cdc0f..ec25e104fec 100644 --- a/extensions/slack/src/monitor/slash-skill-commands.runtime.ts +++ b/extensions/slack/src/monitor/slash-skill-commands.runtime.ts @@ -1 +1,10 @@ -export { listSkillCommandsForAgents } from "openclaw/plugin-sdk/reply-runtime"; +import { listSkillCommandsForAgents as listSkillCommandsForAgentsImpl } from "openclaw/plugin-sdk/reply-runtime"; + +type ListSkillCommandsForAgents = + typeof import("openclaw/plugin-sdk/reply-runtime").listSkillCommandsForAgents; + +export function listSkillCommandsForAgents( + ...args: Parameters +): ReturnType { + return listSkillCommandsForAgentsImpl(...args); +} diff --git a/scripts/tsdown-build.mjs b/scripts/tsdown-build.mjs index 1c346b54a78..09978543bdd 100644 --- a/scripts/tsdown-build.mjs +++ b/scripts/tsdown-build.mjs @@ -4,15 +4,33 @@ import { spawnSync } from "node:child_process"; const logLevel = process.env.OPENCLAW_BUILD_VERBOSE ? "info" : "warn"; const extraArgs = process.argv.slice(2); +const INEFFECTIVE_DYNAMIC_IMPORT_RE = /\[INEFFECTIVE_DYNAMIC_IMPORT\]/; const result = spawnSync( "pnpm", ["exec", "tsdown", "--config-loader", "unrun", "--logLevel", logLevel, ...extraArgs], { - stdio: "inherit", + encoding: "utf8", + stdio: "pipe", shell: process.platform === "win32", }, ); +const stdout = result.stdout ?? ""; +const stderr = result.stderr ?? ""; +if (stdout) { + process.stdout.write(stdout); +} +if (stderr) { + process.stderr.write(stderr); +} + +if (result.status === 0 && INEFFECTIVE_DYNAMIC_IMPORT_RE.test(`${stdout}\n${stderr}`)) { + console.error( + "Build emitted [INEFFECTIVE_DYNAMIC_IMPORT]. Replace transparent runtime re-export facades with real runtime boundaries.", + ); + process.exit(1); +} + if (typeof result.status === "number") { process.exit(result.status); } diff --git a/src/plugins/provider-auth-choice.runtime.ts b/src/plugins/provider-auth-choice.runtime.ts index 7c83aa6da3a..cb298d32c83 100644 --- a/src/plugins/provider-auth-choice.runtime.ts +++ b/src/plugins/provider-auth-choice.runtime.ts @@ -1,2 +1,29 @@ -export { resolveProviderPluginChoice, runProviderModelSelectedHook } from "./provider-wizard.js"; -export { resolvePluginProviders } from "./providers.js"; +import { + resolveProviderPluginChoice as resolveProviderPluginChoiceImpl, + runProviderModelSelectedHook as runProviderModelSelectedHookImpl, +} from "./provider-wizard.js"; +import { resolvePluginProviders as resolvePluginProvidersImpl } from "./providers.js"; + +type ResolveProviderPluginChoice = + typeof import("./provider-wizard.js").resolveProviderPluginChoice; +type RunProviderModelSelectedHook = + typeof import("./provider-wizard.js").runProviderModelSelectedHook; +type ResolvePluginProviders = typeof import("./providers.js").resolvePluginProviders; + +export function resolveProviderPluginChoice( + ...args: Parameters +): ReturnType { + return resolveProviderPluginChoiceImpl(...args); +} + +export function runProviderModelSelectedHook( + ...args: Parameters +): ReturnType { + return runProviderModelSelectedHookImpl(...args); +} + +export function resolvePluginProviders( + ...args: Parameters +): ReturnType { + return resolvePluginProvidersImpl(...args); +} diff --git a/src/plugins/runtime/runtime-discord-ops.runtime.ts b/src/plugins/runtime/runtime-discord-ops.runtime.ts index d10daac5a35..6a9d9429713 100644 --- a/src/plugins/runtime/runtime-discord-ops.runtime.ts +++ b/src/plugins/runtime/runtime-discord-ops.runtime.ts @@ -1,21 +1,150 @@ -export { auditDiscordChannelPermissions } from "../../../extensions/discord/src/audit.js"; -export { - listDiscordDirectoryGroupsLive, - listDiscordDirectoryPeersLive, +import { auditDiscordChannelPermissions as auditDiscordChannelPermissionsImpl } from "../../../extensions/discord/src/audit.js"; +import { + listDiscordDirectoryGroupsLive as listDiscordDirectoryGroupsLiveImpl, + listDiscordDirectoryPeersLive as listDiscordDirectoryPeersLiveImpl, } from "../../../extensions/discord/src/directory-live.js"; -export { monitorDiscordProvider } from "../../../extensions/discord/src/monitor.js"; -export { probeDiscord } from "../../../extensions/discord/src/probe.js"; -export { resolveDiscordChannelAllowlist } from "../../../extensions/discord/src/resolve-channels.js"; -export { resolveDiscordUserAllowlist } from "../../../extensions/discord/src/resolve-users.js"; -export { - createThreadDiscord, - deleteMessageDiscord, - editChannelDiscord, - editMessageDiscord, - pinMessageDiscord, - sendDiscordComponentMessage, - sendMessageDiscord, - sendPollDiscord, - sendTypingDiscord, - unpinMessageDiscord, +import { monitorDiscordProvider as monitorDiscordProviderImpl } from "../../../extensions/discord/src/monitor.js"; +import { probeDiscord as probeDiscordImpl } from "../../../extensions/discord/src/probe.js"; +import { resolveDiscordChannelAllowlist as resolveDiscordChannelAllowlistImpl } from "../../../extensions/discord/src/resolve-channels.js"; +import { resolveDiscordUserAllowlist as resolveDiscordUserAllowlistImpl } from "../../../extensions/discord/src/resolve-users.js"; +import { + createThreadDiscord as createThreadDiscordImpl, + deleteMessageDiscord as deleteMessageDiscordImpl, + editChannelDiscord as editChannelDiscordImpl, + editMessageDiscord as editMessageDiscordImpl, + pinMessageDiscord as pinMessageDiscordImpl, + sendDiscordComponentMessage as sendDiscordComponentMessageImpl, + sendMessageDiscord as sendMessageDiscordImpl, + sendPollDiscord as sendPollDiscordImpl, + sendTypingDiscord as sendTypingDiscordImpl, + unpinMessageDiscord as unpinMessageDiscordImpl, } from "../../../extensions/discord/src/send.js"; + +type AuditDiscordChannelPermissions = + typeof import("../../../extensions/discord/src/audit.js").auditDiscordChannelPermissions; +type ListDiscordDirectoryGroupsLive = + typeof import("../../../extensions/discord/src/directory-live.js").listDiscordDirectoryGroupsLive; +type ListDiscordDirectoryPeersLive = + typeof import("../../../extensions/discord/src/directory-live.js").listDiscordDirectoryPeersLive; +type MonitorDiscordProvider = + typeof import("../../../extensions/discord/src/monitor.js").monitorDiscordProvider; +type ProbeDiscord = typeof import("../../../extensions/discord/src/probe.js").probeDiscord; +type ResolveDiscordChannelAllowlist = + typeof import("../../../extensions/discord/src/resolve-channels.js").resolveDiscordChannelAllowlist; +type ResolveDiscordUserAllowlist = + typeof import("../../../extensions/discord/src/resolve-users.js").resolveDiscordUserAllowlist; +type CreateThreadDiscord = + typeof import("../../../extensions/discord/src/send.js").createThreadDiscord; +type DeleteMessageDiscord = + typeof import("../../../extensions/discord/src/send.js").deleteMessageDiscord; +type EditChannelDiscord = + typeof import("../../../extensions/discord/src/send.js").editChannelDiscord; +type EditMessageDiscord = + typeof import("../../../extensions/discord/src/send.js").editMessageDiscord; +type PinMessageDiscord = typeof import("../../../extensions/discord/src/send.js").pinMessageDiscord; +type SendDiscordComponentMessage = + typeof import("../../../extensions/discord/src/send.js").sendDiscordComponentMessage; +type SendMessageDiscord = + typeof import("../../../extensions/discord/src/send.js").sendMessageDiscord; +type SendPollDiscord = typeof import("../../../extensions/discord/src/send.js").sendPollDiscord; +type SendTypingDiscord = typeof import("../../../extensions/discord/src/send.js").sendTypingDiscord; +type UnpinMessageDiscord = + typeof import("../../../extensions/discord/src/send.js").unpinMessageDiscord; + +export function auditDiscordChannelPermissions( + ...args: Parameters +): ReturnType { + return auditDiscordChannelPermissionsImpl(...args); +} + +export function listDiscordDirectoryGroupsLive( + ...args: Parameters +): ReturnType { + return listDiscordDirectoryGroupsLiveImpl(...args); +} + +export function listDiscordDirectoryPeersLive( + ...args: Parameters +): ReturnType { + return listDiscordDirectoryPeersLiveImpl(...args); +} + +export function monitorDiscordProvider( + ...args: Parameters +): ReturnType { + return monitorDiscordProviderImpl(...args); +} + +export function probeDiscord(...args: Parameters): ReturnType { + return probeDiscordImpl(...args); +} + +export function resolveDiscordChannelAllowlist( + ...args: Parameters +): ReturnType { + return resolveDiscordChannelAllowlistImpl(...args); +} + +export function resolveDiscordUserAllowlist( + ...args: Parameters +): ReturnType { + return resolveDiscordUserAllowlistImpl(...args); +} + +export function createThreadDiscord( + ...args: Parameters +): ReturnType { + return createThreadDiscordImpl(...args); +} + +export function deleteMessageDiscord( + ...args: Parameters +): ReturnType { + return deleteMessageDiscordImpl(...args); +} + +export function editChannelDiscord( + ...args: Parameters +): ReturnType { + return editChannelDiscordImpl(...args); +} + +export function editMessageDiscord( + ...args: Parameters +): ReturnType { + return editMessageDiscordImpl(...args); +} + +export function pinMessageDiscord( + ...args: Parameters +): ReturnType { + return pinMessageDiscordImpl(...args); +} + +export function sendDiscordComponentMessage( + ...args: Parameters +): ReturnType { + return sendDiscordComponentMessageImpl(...args); +} + +export function sendMessageDiscord( + ...args: Parameters +): ReturnType { + return sendMessageDiscordImpl(...args); +} + +export function sendPollDiscord(...args: Parameters): ReturnType { + return sendPollDiscordImpl(...args); +} + +export function sendTypingDiscord( + ...args: Parameters +): ReturnType { + return sendTypingDiscordImpl(...args); +} + +export function unpinMessageDiscord( + ...args: Parameters +): ReturnType { + return unpinMessageDiscordImpl(...args); +} diff --git a/src/plugins/runtime/runtime-slack-ops.runtime.ts b/src/plugins/runtime/runtime-slack-ops.runtime.ts index e22662c3b7f..b01568bc491 100644 --- a/src/plugins/runtime/runtime-slack-ops.runtime.ts +++ b/src/plugins/runtime/runtime-slack-ops.runtime.ts @@ -1,10 +1,70 @@ -export { - listSlackDirectoryGroupsLive, - listSlackDirectoryPeersLive, +import { + listSlackDirectoryGroupsLive as listSlackDirectoryGroupsLiveImpl, + listSlackDirectoryPeersLive as listSlackDirectoryPeersLiveImpl, } from "../../../extensions/slack/src/directory-live.js"; -export { monitorSlackProvider } from "../../../extensions/slack/src/index.js"; -export { probeSlack } from "../../../extensions/slack/src/probe.js"; -export { resolveSlackChannelAllowlist } from "../../../extensions/slack/src/resolve-channels.js"; -export { resolveSlackUserAllowlist } from "../../../extensions/slack/src/resolve-users.js"; -export { sendMessageSlack } from "../../../extensions/slack/src/send.js"; -export { handleSlackAction } from "../../agents/tools/slack-actions.js"; +import { monitorSlackProvider as monitorSlackProviderImpl } from "../../../extensions/slack/src/index.js"; +import { probeSlack as probeSlackImpl } from "../../../extensions/slack/src/probe.js"; +import { resolveSlackChannelAllowlist as resolveSlackChannelAllowlistImpl } from "../../../extensions/slack/src/resolve-channels.js"; +import { resolveSlackUserAllowlist as resolveSlackUserAllowlistImpl } from "../../../extensions/slack/src/resolve-users.js"; +import { sendMessageSlack as sendMessageSlackImpl } from "../../../extensions/slack/src/send.js"; +import { handleSlackAction as handleSlackActionImpl } from "../../agents/tools/slack-actions.js"; + +type ListSlackDirectoryGroupsLive = + typeof import("../../../extensions/slack/src/directory-live.js").listSlackDirectoryGroupsLive; +type ListSlackDirectoryPeersLive = + typeof import("../../../extensions/slack/src/directory-live.js").listSlackDirectoryPeersLive; +type MonitorSlackProvider = + typeof import("../../../extensions/slack/src/index.js").monitorSlackProvider; +type ProbeSlack = typeof import("../../../extensions/slack/src/probe.js").probeSlack; +type ResolveSlackChannelAllowlist = + typeof import("../../../extensions/slack/src/resolve-channels.js").resolveSlackChannelAllowlist; +type ResolveSlackUserAllowlist = + typeof import("../../../extensions/slack/src/resolve-users.js").resolveSlackUserAllowlist; +type SendMessageSlack = typeof import("../../../extensions/slack/src/send.js").sendMessageSlack; +type HandleSlackAction = typeof import("../../agents/tools/slack-actions.js").handleSlackAction; + +export function listSlackDirectoryGroupsLive( + ...args: Parameters +): ReturnType { + return listSlackDirectoryGroupsLiveImpl(...args); +} + +export function listSlackDirectoryPeersLive( + ...args: Parameters +): ReturnType { + return listSlackDirectoryPeersLiveImpl(...args); +} + +export function monitorSlackProvider( + ...args: Parameters +): ReturnType { + return monitorSlackProviderImpl(...args); +} + +export function probeSlack(...args: Parameters): ReturnType { + return probeSlackImpl(...args); +} + +export function resolveSlackChannelAllowlist( + ...args: Parameters +): ReturnType { + return resolveSlackChannelAllowlistImpl(...args); +} + +export function resolveSlackUserAllowlist( + ...args: Parameters +): ReturnType { + return resolveSlackUserAllowlistImpl(...args); +} + +export function sendMessageSlack( + ...args: Parameters +): ReturnType { + return sendMessageSlackImpl(...args); +} + +export function handleSlackAction( + ...args: Parameters +): ReturnType { + return handleSlackActionImpl(...args); +} diff --git a/src/plugins/runtime/runtime-telegram-ops.runtime.ts b/src/plugins/runtime/runtime-telegram-ops.runtime.ts index dc463625b4f..cc99abfb1c4 100644 --- a/src/plugins/runtime/runtime-telegram-ops.runtime.ts +++ b/src/plugins/runtime/runtime-telegram-ops.runtime.ts @@ -1,18 +1,127 @@ -export { - auditTelegramGroupMembership, - collectTelegramUnmentionedGroupIds, +import { + auditTelegramGroupMembership as auditTelegramGroupMembershipImpl, + collectTelegramUnmentionedGroupIds as collectTelegramUnmentionedGroupIdsImpl, } from "../../../extensions/telegram/src/audit.js"; -export { monitorTelegramProvider } from "../../../extensions/telegram/src/monitor.js"; -export { probeTelegram } from "../../../extensions/telegram/src/probe.js"; -export { - deleteMessageTelegram, - editMessageReplyMarkupTelegram, - editMessageTelegram, - pinMessageTelegram, - renameForumTopicTelegram, - sendMessageTelegram, - sendPollTelegram, - sendTypingTelegram, - unpinMessageTelegram, +import { monitorTelegramProvider as monitorTelegramProviderImpl } from "../../../extensions/telegram/src/monitor.js"; +import { probeTelegram as probeTelegramImpl } from "../../../extensions/telegram/src/probe.js"; +import { + deleteMessageTelegram as deleteMessageTelegramImpl, + editMessageReplyMarkupTelegram as editMessageReplyMarkupTelegramImpl, + editMessageTelegram as editMessageTelegramImpl, + pinMessageTelegram as pinMessageTelegramImpl, + renameForumTopicTelegram as renameForumTopicTelegramImpl, + sendMessageTelegram as sendMessageTelegramImpl, + sendPollTelegram as sendPollTelegramImpl, + sendTypingTelegram as sendTypingTelegramImpl, + unpinMessageTelegram as unpinMessageTelegramImpl, } from "../../../extensions/telegram/src/send.js"; -export { resolveTelegramToken } from "../../../extensions/telegram/src/token.js"; +import { resolveTelegramToken as resolveTelegramTokenImpl } from "../../../extensions/telegram/src/token.js"; + +type AuditTelegramGroupMembership = + typeof import("../../../extensions/telegram/src/audit.js").auditTelegramGroupMembership; +type CollectTelegramUnmentionedGroupIds = + typeof import("../../../extensions/telegram/src/audit.js").collectTelegramUnmentionedGroupIds; +type MonitorTelegramProvider = + typeof import("../../../extensions/telegram/src/monitor.js").monitorTelegramProvider; +type ProbeTelegram = typeof import("../../../extensions/telegram/src/probe.js").probeTelegram; +type DeleteMessageTelegram = + typeof import("../../../extensions/telegram/src/send.js").deleteMessageTelegram; +type EditMessageReplyMarkupTelegram = + typeof import("../../../extensions/telegram/src/send.js").editMessageReplyMarkupTelegram; +type EditMessageTelegram = + typeof import("../../../extensions/telegram/src/send.js").editMessageTelegram; +type PinMessageTelegram = + typeof import("../../../extensions/telegram/src/send.js").pinMessageTelegram; +type RenameForumTopicTelegram = + typeof import("../../../extensions/telegram/src/send.js").renameForumTopicTelegram; +type SendMessageTelegram = + typeof import("../../../extensions/telegram/src/send.js").sendMessageTelegram; +type SendPollTelegram = typeof import("../../../extensions/telegram/src/send.js").sendPollTelegram; +type SendTypingTelegram = + typeof import("../../../extensions/telegram/src/send.js").sendTypingTelegram; +type UnpinMessageTelegram = + typeof import("../../../extensions/telegram/src/send.js").unpinMessageTelegram; +type ResolveTelegramToken = + typeof import("../../../extensions/telegram/src/token.js").resolveTelegramToken; + +export function auditTelegramGroupMembership( + ...args: Parameters +): ReturnType { + return auditTelegramGroupMembershipImpl(...args); +} + +export function collectTelegramUnmentionedGroupIds( + ...args: Parameters +): ReturnType { + return collectTelegramUnmentionedGroupIdsImpl(...args); +} + +export function monitorTelegramProvider( + ...args: Parameters +): ReturnType { + return monitorTelegramProviderImpl(...args); +} + +export function probeTelegram(...args: Parameters): ReturnType { + return probeTelegramImpl(...args); +} + +export function deleteMessageTelegram( + ...args: Parameters +): ReturnType { + return deleteMessageTelegramImpl(...args); +} + +export function editMessageReplyMarkupTelegram( + ...args: Parameters +): ReturnType { + return editMessageReplyMarkupTelegramImpl(...args); +} + +export function editMessageTelegram( + ...args: Parameters +): ReturnType { + return editMessageTelegramImpl(...args); +} + +export function pinMessageTelegram( + ...args: Parameters +): ReturnType { + return pinMessageTelegramImpl(...args); +} + +export function renameForumTopicTelegram( + ...args: Parameters +): ReturnType { + return renameForumTopicTelegramImpl(...args); +} + +export function sendMessageTelegram( + ...args: Parameters +): ReturnType { + return sendMessageTelegramImpl(...args); +} + +export function sendPollTelegram( + ...args: Parameters +): ReturnType { + return sendPollTelegramImpl(...args); +} + +export function sendTypingTelegram( + ...args: Parameters +): ReturnType { + return sendTypingTelegramImpl(...args); +} + +export function unpinMessageTelegram( + ...args: Parameters +): ReturnType { + return unpinMessageTelegramImpl(...args); +} + +export function resolveTelegramToken( + ...args: Parameters +): ReturnType { + return resolveTelegramTokenImpl(...args); +} diff --git a/src/plugins/runtime/runtime-whatsapp-login.runtime.ts b/src/plugins/runtime/runtime-whatsapp-login.runtime.ts index 584b9d8d524..4d44c7c87f6 100644 --- a/src/plugins/runtime/runtime-whatsapp-login.runtime.ts +++ b/src/plugins/runtime/runtime-whatsapp-login.runtime.ts @@ -1 +1,7 @@ -export { loginWeb } from "../../../extensions/whatsapp/src/login.js"; +import { loginWeb as loginWebImpl } from "../../../extensions/whatsapp/src/login.js"; + +type LoginWeb = typeof import("../../../extensions/whatsapp/src/login.js").loginWeb; + +export function loginWeb(...args: Parameters): ReturnType { + return loginWebImpl(...args); +} diff --git a/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts b/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts index fca645e90b0..023e9e93e23 100644 --- a/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts +++ b/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts @@ -1 +1,20 @@ -export { sendMessageWhatsApp, sendPollWhatsApp } from "../../../extensions/whatsapp/src/send.js"; +import { + sendMessageWhatsApp as sendMessageWhatsAppImpl, + sendPollWhatsApp as sendPollWhatsAppImpl, +} from "../../../extensions/whatsapp/src/send.js"; + +type SendMessageWhatsApp = + typeof import("../../../extensions/whatsapp/src/send.js").sendMessageWhatsApp; +type SendPollWhatsApp = typeof import("../../../extensions/whatsapp/src/send.js").sendPollWhatsApp; + +export function sendMessageWhatsApp( + ...args: Parameters +): ReturnType { + return sendMessageWhatsAppImpl(...args); +} + +export function sendPollWhatsApp( + ...args: Parameters +): ReturnType { + return sendPollWhatsAppImpl(...args); +} From 57204b4fa9deff99b3bbae4fa76636bea7096704 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:24:25 -0700 Subject: [PATCH 100/187] fix(gateway): surface env override keys in exec approvals --- CHANGELOG.md | 1 + src/agents/bash-tools.exec-host-gateway.ts | 2 ++ src/agents/bash-tools.exec.ts | 1 + src/gateway/server-methods/exec-approval.ts | 8 +++-- .../server-methods/server-methods.test.ts | 30 ++++++++++++++++++- 5 files changed, 39 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e38cc1703a..6f369f55d33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -113,6 +113,7 @@ Docs: https://docs.openclaw.ai - Agents/compaction: rerun transcript repair after `session.compact()` so orphaned `tool_result` blocks cannot survive compaction and break later Anthropic requests. (#16095) thanks @claw-sylphx. - Agents/compaction: trigger overflow recovery from the tool-result guard once post-compaction context still exceeds the safe threshold, so long tool loops compact before the next model call hard-fails. (#29371) thanks @keshav55. - macOS/exec approvals: harden exec-host request HMAC verification to use a timing-safe compare and keep malformed or truncated signatures fail-closed in focused IPC auth coverage. +- Gateway/exec approvals: surface requested env override keys in gateway-host approval prompts so operators can review surviving env context without inheriting noisy base host env. ## 2026.3.13 diff --git a/src/agents/bash-tools.exec-host-gateway.ts b/src/agents/bash-tools.exec-host-gateway.ts index 149a4785dd5..4a0223af7a4 100644 --- a/src/agents/bash-tools.exec-host-gateway.ts +++ b/src/agents/bash-tools.exec-host-gateway.ts @@ -40,6 +40,7 @@ export type ProcessGatewayAllowlistParams = { command: string; workdir: string; env: Record; + requestedEnv?: Record; pty: boolean; timeoutSec?: number; defaultTimeoutSec: number; @@ -152,6 +153,7 @@ export async function processGatewayAllowlist( await registerExecApprovalRequestForHostOrThrow({ approvalId, command: params.command, + env: params.requestedEnv, workdir: params.workdir, host: "gateway", security: hostSecurity, diff --git a/src/agents/bash-tools.exec.ts b/src/agents/bash-tools.exec.ts index 8a0bd30907a..5fe0f7deac4 100644 --- a/src/agents/bash-tools.exec.ts +++ b/src/agents/bash-tools.exec.ts @@ -429,6 +429,7 @@ export function createExecTool( command: params.command, workdir, env, + requestedEnv: params.env, pty: params.pty === true && !sandbox, timeoutSec: params.timeout, defaultTimeoutSec, diff --git a/src/gateway/server-methods/exec-approval.ts b/src/gateway/server-methods/exec-approval.ts index 81d479cbbd6..383e8498a28 100644 --- a/src/gateway/server-methods/exec-approval.ts +++ b/src/gateway/server-methods/exec-approval.ts @@ -4,7 +4,10 @@ import { DEFAULT_EXEC_APPROVAL_TIMEOUT_MS, type ExecApprovalDecision, } from "../../infra/exec-approvals.js"; -import { buildSystemRunApprovalBinding } from "../../infra/system-run-approval-binding.js"; +import { + buildSystemRunApprovalBinding, + buildSystemRunApprovalEnvBinding, +} from "../../infra/system-run-approval-binding.js"; import { resolveSystemRunApprovalRequestContext } from "../../infra/system-run-approval-context.js"; import type { ExecApprovalManager } from "../exec-approval-manager.js"; import { @@ -107,6 +110,7 @@ export function createExecApprovalHandlers( ); return; } + const envBinding = buildSystemRunApprovalEnvBinding(p.env); const systemRunBinding = host === "node" ? buildSystemRunApprovalBinding({ @@ -132,7 +136,7 @@ export function createExecApprovalHandlers( ? undefined : sanitizeExecApprovalDisplayText(approvalContext.commandPreview), commandArgv: host === "node" ? undefined : effectiveCommandArgv, - envKeys: systemRunBinding?.envKeys?.length ? systemRunBinding.envKeys : undefined, + envKeys: envBinding.envKeys.length > 0 ? envBinding.envKeys : undefined, systemRunBinding: systemRunBinding?.binding ?? null, systemRunPlan: approvalContext.plan, cwd: effectiveCwd ?? null, diff --git a/src/gateway/server-methods/server-methods.test.ts b/src/gateway/server-methods/server-methods.test.ts index bd42485f4f8..a7afcb60f5f 100644 --- a/src/gateway/server-methods/server-methods.test.ts +++ b/src/gateway/server-methods/server-methods.test.ts @@ -6,7 +6,10 @@ import { fileURLToPath } from "node:url"; import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; import { emitAgentEvent } from "../../infra/agent-events.js"; import { formatZonedTimestamp } from "../../infra/format-time/format-datetime.js"; -import { buildSystemRunApprovalBinding } from "../../infra/system-run-approval-binding.js"; +import { + buildSystemRunApprovalBinding, + buildSystemRunApprovalEnvBinding, +} from "../../infra/system-run-approval-binding.js"; import { resetLogger, setLoggerOverride } from "../../logging.js"; import { ExecApprovalManager } from "../exec-approval-manager.js"; import { validateExecApprovalRequestParams } from "../protocol/index.js"; @@ -583,6 +586,31 @@ describe("exec approval handlers", () => { ); }); + it("stores sorted env keys for gateway approvals without node-only binding", async () => { + const { handlers, broadcasts, respond, context } = createExecApprovalFixture(); + await requestExecApproval({ + handlers, + respond, + context, + params: { + host: "gateway", + nodeId: undefined, + systemRunPlan: undefined, + env: { + Z_VAR: "z", + A_VAR: "a", + }, + }, + }); + const requested = broadcasts.find((entry) => entry.event === "exec.approval.requested"); + expect(requested).toBeTruthy(); + const request = (requested?.payload as { request?: Record })?.request ?? {}; + expect(request["envKeys"]).toEqual( + buildSystemRunApprovalEnvBinding({ A_VAR: "a", Z_VAR: "z" }).envKeys, + ); + expect(request["systemRunBinding"]).toBeNull(); + }); + it("prefers systemRunPlan canonical command/cwd when present", async () => { const { handlers, broadcasts, respond, context } = createExecApprovalFixture(); await requestExecApproval({ From 80a2af1d656e1bcd773de0c8aef5fdf74add6c7e Mon Sep 17 00:00:00 2001 From: scoootscooob Date: Mon, 16 Mar 2026 23:25:04 -0700 Subject: [PATCH 101/187] Agents: move bootstrap warnings out of system prompt (#48753) Merged via squash. Prepared head SHA: dc1d4d075af7afdf4c143f1639cd49e129969f6c Co-authored-by: scoootscooob <167050519+scoootscooob@users.noreply.github.com> Reviewed-by: @scoootscooob --- CHANGELOG.md | 4 + src/agents/bootstrap-budget.test.ts | 61 +++++++++ src/agents/bootstrap-budget.ts | 23 ++++ src/agents/cli-runner.test.ts | 80 ++++++++++++ src/agents/cli-runner.ts | 6 +- src/agents/cli-runner/helpers.ts | 2 - .../run/attempt.spawn-workspace.test.ts | 116 +++++++++++++++++- src/agents/pi-embedded-runner/run/attempt.ts | 19 ++- .../pi-embedded-runner/system-prompt.ts | 2 - src/agents/system-prompt.test.ts | 7 +- src/agents/system-prompt.ts | 13 +- 11 files changed, 299 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f369f55d33..34afa1bc61d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -115,6 +115,10 @@ Docs: https://docs.openclaw.ai - macOS/exec approvals: harden exec-host request HMAC verification to use a timing-safe compare and keep malformed or truncated signatures fail-closed in focused IPC auth coverage. - Gateway/exec approvals: surface requested env override keys in gateway-host approval prompts so operators can review surviving env context without inheriting noisy base host env. +### Fixes + +- Agents/bootstrap warnings: move bootstrap truncation warnings out of the system prompt and into the per-turn prompt body so prompt-cache reuse stays stable when truncation warnings appear or disappear. (#48753) Thanks @scoootscooob and @obviyus. + ## 2026.3.13 ### Changes diff --git a/src/agents/bootstrap-budget.test.ts b/src/agents/bootstrap-budget.test.ts index bee7a2d9036..a4d65cc964c 100644 --- a/src/agents/bootstrap-budget.test.ts +++ b/src/agents/bootstrap-budget.test.ts @@ -6,8 +6,10 @@ import { buildBootstrapTruncationReportMeta, buildBootstrapTruncationSignature, formatBootstrapTruncationWarningLines, + prependBootstrapPromptWarning, resolveBootstrapWarningSignaturesSeen, } from "./bootstrap-budget.js"; +import { buildAgentSystemPrompt } from "./system-prompt.js"; import type { WorkspaceBootstrapFile } from "./workspace.js"; describe("buildBootstrapInjectionStats", () => { @@ -104,6 +106,34 @@ describe("analyzeBootstrapBudget", () => { }); describe("bootstrap prompt warnings", () => { + it("prepends warning details to the turn prompt instead of mutating the system prompt", () => { + const prompt = prependBootstrapPromptWarning("Please continue.", [ + "AGENTS.md: 200 raw -> 0 injected", + ]); + expect(prompt).toContain("[Bootstrap truncation warning]"); + expect(prompt).toContain("Treat Project Context as partial"); + expect(prompt).toContain("- AGENTS.md: 200 raw -> 0 injected"); + expect(prompt).toContain("Please continue."); + }); + + it("preserves raw prompt whitespace when prepending warning details", () => { + const prompt = prependBootstrapPromptWarning(" indented\nkeep tail ", [ + "AGENTS.md: 200 raw -> 0 injected", + ]); + + expect(prompt.endsWith(" indented\nkeep tail ")).toBe(true); + }); + + it("preserves exact heartbeat prompts without warning prefixes", () => { + const heartbeatPrompt = "Read HEARTBEAT.md. Reply HEARTBEAT_OK."; + + expect( + prependBootstrapPromptWarning(heartbeatPrompt, ["AGENTS.md: 200 raw -> 0 injected"], { + preserveExactPrompt: heartbeatPrompt, + }), + ).toBe(heartbeatPrompt); + }); + it("resolves seen signatures from report history or legacy single signature", () => { expect( resolveBootstrapWarningSignaturesSeen({ @@ -394,4 +424,35 @@ describe("bootstrap prompt warnings", () => { expect(meta.promptWarningSignature).toBeTruthy(); expect(meta.warningSignaturesSeen?.length).toBeGreaterThan(0); }); + + it("improves cache-relevant system prompt stability versus legacy warning injection", () => { + const contextFiles = [{ path: "AGENTS.md", content: "Follow AGENTS guidance." }]; + const warningLines = ["AGENTS.md: 200 raw -> 0 injected"]; + const stableSystemPrompt = buildAgentSystemPrompt({ + workspaceDir: "/tmp/openclaw", + contextFiles, + }); + const optimizedTurns = [stableSystemPrompt, stableSystemPrompt, stableSystemPrompt]; + const injectLegacyWarning = (prompt: string, lines: string[]) => { + const warningBlock = [ + "⚠ Bootstrap truncation warning:", + ...lines.map((line) => `- ${line}`), + "", + ].join("\n"); + return prompt.replace("## AGENTS.md", `${warningBlock}## AGENTS.md`); + }; + const legacyTurns = [ + injectLegacyWarning(optimizedTurns[0] ?? "", warningLines), + optimizedTurns[1] ?? "", + injectLegacyWarning(optimizedTurns[2] ?? "", warningLines), + ]; + const cacheHitRate = (turns: string[]) => { + const hits = turns.slice(1).filter((turn, index) => turn === turns[index]).length; + return hits / Math.max(1, turns.length - 1); + }; + + expect(cacheHitRate(legacyTurns)).toBe(0); + expect(cacheHitRate(optimizedTurns)).toBe(1); + expect(optimizedTurns[0]).not.toContain("⚠ Bootstrap truncation warning:"); + }); }); diff --git a/src/agents/bootstrap-budget.ts b/src/agents/bootstrap-budget.ts index ddfd4fb5d06..4d5c3ff6f58 100644 --- a/src/agents/bootstrap-budget.ts +++ b/src/agents/bootstrap-budget.ts @@ -330,6 +330,29 @@ export function buildBootstrapPromptWarning(params: { }; } +export function prependBootstrapPromptWarning( + prompt: string, + warningLines?: string[], + options?: { + preserveExactPrompt?: string; + }, +): string { + const normalizedLines = (warningLines ?? []).map((line) => line.trim()).filter(Boolean); + if (normalizedLines.length === 0) { + return prompt; + } + if (options?.preserveExactPrompt && prompt === options.preserveExactPrompt) { + return prompt; + } + const warningBlock = [ + "[Bootstrap truncation warning]", + "Some workspace bootstrap files were truncated before injection.", + "Treat Project Context as partial and read the relevant files directly if details seem missing.", + ...normalizedLines.map((line) => `- ${line}`), + ].join("\n"); + return prompt ? `${warningBlock}\n\n${prompt}` : warningBlock; +} + export function buildBootstrapTruncationReportMeta(params: { analysis: BootstrapBudgetAnalysis; warningMode: BootstrapPromptWarningMode; diff --git a/src/agents/cli-runner.test.ts b/src/agents/cli-runner.test.ts index ec1b0b09ac8..e77ac021fd7 100644 --- a/src/agents/cli-runner.test.ts +++ b/src/agents/cli-runner.test.ts @@ -5,10 +5,25 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import { runCliAgent } from "./cli-runner.js"; import { resolveCliNoOutputTimeoutMs } from "./cli-runner/helpers.js"; +import type { EmbeddedContextFile } from "./pi-embedded-helpers.js"; +import type { WorkspaceBootstrapFile } from "./workspace.js"; const supervisorSpawnMock = vi.fn(); const enqueueSystemEventMock = vi.fn(); const requestHeartbeatNowMock = vi.fn(); +const hoisted = vi.hoisted(() => { + type BootstrapContext = { + bootstrapFiles: WorkspaceBootstrapFile[]; + contextFiles: EmbeddedContextFile[]; + }; + + return { + resolveBootstrapContextForRunMock: vi.fn<() => Promise>(async () => ({ + bootstrapFiles: [], + contextFiles: [], + })), + }; +}); vi.mock("../process/supervisor/index.js", () => ({ getProcessSupervisor: () => ({ @@ -28,6 +43,11 @@ vi.mock("../infra/heartbeat-wake.js", () => ({ requestHeartbeatNow: (...args: unknown[]) => requestHeartbeatNowMock(...args), })); +vi.mock("./bootstrap-files.js", () => ({ + makeBootstrapWarn: () => () => {}, + resolveBootstrapContextForRun: hoisted.resolveBootstrapContextForRunMock, +})); + type MockRunExit = { reason: | "manual-cancel" @@ -61,6 +81,10 @@ describe("runCliAgent with process supervisor", () => { supervisorSpawnMock.mockClear(); enqueueSystemEventMock.mockClear(); requestHeartbeatNowMock.mockClear(); + hoisted.resolveBootstrapContextForRunMock.mockReset().mockResolvedValue({ + bootstrapFiles: [], + contextFiles: [], + }); }); it("runs CLI through supervisor and returns payload", async () => { @@ -107,6 +131,62 @@ describe("runCliAgent with process supervisor", () => { expect(input.scopeKey).toContain("thread-123"); }); + it("prepends bootstrap warnings to the CLI prompt body", async () => { + supervisorSpawnMock.mockResolvedValueOnce( + createManagedRun({ + reason: "exit", + exitCode: 0, + exitSignal: null, + durationMs: 50, + stdout: "ok", + stderr: "", + timedOut: false, + noOutputTimedOut: false, + }), + ); + hoisted.resolveBootstrapContextForRunMock.mockResolvedValueOnce({ + bootstrapFiles: [ + { + name: "AGENTS.md", + path: "/tmp/AGENTS.md", + content: "A".repeat(200), + missing: false, + }, + ], + contextFiles: [{ path: "AGENTS.md", content: "A".repeat(20) }], + }); + + await runCliAgent({ + sessionId: "s1", + sessionFile: "/tmp/session.jsonl", + workspaceDir: "/tmp", + config: { + agents: { + defaults: { + bootstrapMaxChars: 50, + bootstrapTotalMaxChars: 50, + }, + }, + } satisfies OpenClawConfig, + prompt: "hi", + provider: "codex-cli", + model: "gpt-5.2-codex", + timeoutMs: 1_000, + runId: "run-warning", + cliSessionId: "thread-123", + }); + + const input = supervisorSpawnMock.mock.calls[0]?.[0] as { + argv?: string[]; + input?: string; + }; + const promptCarrier = [input.input ?? "", ...(input.argv ?? [])].join("\n"); + + expect(promptCarrier).toContain("[Bootstrap truncation warning]"); + expect(promptCarrier).toContain("- AGENTS.md: 200 raw -> 20 injected"); + expect(promptCarrier).toContain("hi"); + }); + it("fails with timeout when no-output watchdog trips", async () => { supervisorSpawnMock.mockResolvedValueOnce( createManagedRun({ diff --git a/src/agents/cli-runner.ts b/src/agents/cli-runner.ts index 93cebc6dd14..9056668e087 100644 --- a/src/agents/cli-runner.ts +++ b/src/agents/cli-runner.ts @@ -15,6 +15,7 @@ import { buildBootstrapInjectionStats, buildBootstrapPromptWarning, buildBootstrapTruncationReportMeta, + prependBootstrapPromptWarning, } from "./bootstrap-budget.js"; import { makeBootstrapWarn, resolveBootstrapContextForRun } from "./bootstrap-files.js"; import { resolveCliBackendConfig } from "./cli-backends.js"; @@ -162,7 +163,6 @@ export async function runCliAgent(params: { docsPath: docsPath ?? undefined, tools: [], contextFiles, - bootstrapTruncationWarningLines: bootstrapPromptWarning.lines, modelDisplay, agentId: sessionAgentId, }); @@ -218,7 +218,9 @@ export async function runCliAgent(params: { let imagePaths: string[] | undefined; let cleanupImages: (() => Promise) | undefined; - let prompt = params.prompt; + let prompt = prependBootstrapPromptWarning(params.prompt, bootstrapPromptWarning.lines, { + preserveExactPrompt: heartbeatPrompt, + }); if (params.images && params.images.length > 0) { const imagePayload = await writeCliImages(params.images); imagePaths = imagePayload.paths; diff --git a/src/agents/cli-runner/helpers.ts b/src/agents/cli-runner/helpers.ts index 7f0598cfaab..96ec35540be 100644 --- a/src/agents/cli-runner/helpers.ts +++ b/src/agents/cli-runner/helpers.ts @@ -48,7 +48,6 @@ export function buildSystemPrompt(params: { docsPath?: string; tools: AgentTool[]; contextFiles?: EmbeddedContextFile[]; - bootstrapTruncationWarningLines?: string[]; modelDisplay: string; agentId?: string; }) { @@ -92,7 +91,6 @@ export function buildSystemPrompt(params: { userTime, userTimeFormat, contextFiles: params.contextFiles, - bootstrapTruncationWarningLines: params.bootstrapTruncationWarningLines, ttsHint, memoryCitationsMode: params.config?.memory?.citations, }); diff --git a/src/agents/pi-embedded-runner/run/attempt.spawn-workspace.test.ts b/src/agents/pi-embedded-runner/run/attempt.spawn-workspace.test.ts index e67bb20d88d..fa2bb58fbbc 100644 --- a/src/agents/pi-embedded-runner/run/attempt.spawn-workspace.test.ts +++ b/src/agents/pi-embedded-runner/run/attempt.spawn-workspace.test.ts @@ -18,16 +18,27 @@ import type { IngestBatchResult, IngestResult, } from "../../../context-engine/types.js"; +import type { EmbeddedContextFile } from "../../pi-embedded-helpers.js"; import { createHostSandboxFsBridge } from "../../test-helpers/host-sandbox-fs-bridge.js"; import { createPiToolsSandboxContext } from "../../test-helpers/pi-tools-sandbox-context.js"; +import type { WorkspaceBootstrapFile } from "../../workspace.js"; const hoisted = vi.hoisted(() => { + type BootstrapContext = { + bootstrapFiles: WorkspaceBootstrapFile[]; + contextFiles: EmbeddedContextFile[]; + }; const spawnSubagentDirectMock = vi.fn(); const createAgentSessionMock = vi.fn(); const sessionManagerOpenMock = vi.fn(); const resolveSandboxContextMock = vi.fn(); const subscribeEmbeddedPiSessionMock = vi.fn(); const acquireSessionWriteLockMock = vi.fn(); + const resolveBootstrapContextForRunMock = vi.fn<() => Promise>(async () => ({ + bootstrapFiles: [], + contextFiles: [], + })); + const getGlobalHookRunnerMock = vi.fn<() => unknown>(() => undefined); const sessionManager = { getLeafEntry: vi.fn(() => null), branch: vi.fn(), @@ -42,6 +53,8 @@ const hoisted = vi.hoisted(() => { resolveSandboxContextMock, subscribeEmbeddedPiSessionMock, acquireSessionWriteLockMock, + resolveBootstrapContextForRunMock, + getGlobalHookRunnerMock, sessionManager, }; }); @@ -80,7 +93,7 @@ vi.mock("../../pi-embedded-subscribe.js", () => ({ })); vi.mock("../../../plugins/hook-runner-global.js", () => ({ - getGlobalHookRunner: () => undefined, + getGlobalHookRunner: hoisted.getGlobalHookRunnerMock, })); vi.mock("../../../infra/machine-name.js", () => ({ @@ -94,7 +107,7 @@ vi.mock("../../../infra/net/undici-global-dispatcher.js", () => ({ vi.mock("../../bootstrap-files.js", () => ({ makeBootstrapWarn: () => () => {}, - resolveBootstrapContextForRun: async () => ({ bootstrapFiles: [], contextFiles: [] }), + resolveBootstrapContextForRun: hoisted.resolveBootstrapContextForRunMock, })); vi.mock("../../skills.js", () => ({ @@ -269,6 +282,11 @@ function resetEmbeddedAttemptHarness( hoisted.acquireSessionWriteLockMock.mockReset().mockResolvedValue({ release: async () => {}, }); + hoisted.resolveBootstrapContextForRunMock.mockReset().mockResolvedValue({ + bootstrapFiles: [], + contextFiles: [], + }); + hoisted.getGlobalHookRunnerMock.mockReset().mockReturnValue(undefined); hoisted.sessionManager.getLeafEntry.mockReset().mockReturnValue(null); hoisted.sessionManager.branch.mockReset(); hoisted.sessionManager.resetLeaf.mockReset(); @@ -291,7 +309,11 @@ async function cleanupTempPaths(tempPaths: string[]) { } function createDefaultEmbeddedSession(params?: { - prompt?: (session: MutableSession) => Promise; + prompt?: ( + session: MutableSession, + prompt: string, + options?: { images?: unknown[] }, + ) => Promise; }): MutableSession { const session: MutableSession = { sessionId: "embedded-session", @@ -303,9 +325,9 @@ function createDefaultEmbeddedSession(params?: { session.messages = [...messages]; }, }, - prompt: async () => { + prompt: async (prompt, options) => { if (params?.prompt) { - await params.prompt(session); + await params.prompt(session, prompt, options); return; } session.messages = [ @@ -450,6 +472,90 @@ describe("runEmbeddedAttempt sessions_spawn workspace inheritance", () => { }); }); +describe("runEmbeddedAttempt bootstrap warning prompt assembly", () => { + const tempPaths: string[] = []; + + beforeEach(() => { + resetEmbeddedAttemptHarness({ + subscribeImpl: createSubscriptionMock, + }); + }); + + afterEach(async () => { + await cleanupTempPaths(tempPaths); + }); + + it("keeps bootstrap warnings in the sent prompt after hook prepend context", async () => { + const workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-warning-workspace-")); + const agentDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-warning-agent-dir-")); + const sessionFile = path.join(workspaceDir, "session.jsonl"); + tempPaths.push(workspaceDir, agentDir); + await fs.writeFile(sessionFile, "", "utf8"); + + hoisted.resolveBootstrapContextForRunMock.mockResolvedValue({ + bootstrapFiles: [ + { + name: "AGENTS.md", + path: path.join(workspaceDir, "AGENTS.md"), + content: "A".repeat(200), + missing: false, + }, + ], + contextFiles: [{ path: "AGENTS.md", content: "A".repeat(20) }], + }); + hoisted.getGlobalHookRunnerMock.mockReturnValue({ + hasHooks: (hookName: string) => hookName === "before_prompt_build", + runBeforePromptBuild: async () => ({ prependContext: "hook context" }), + }); + + let seenPrompt = ""; + hoisted.createAgentSessionMock.mockImplementation(async () => ({ + session: createDefaultEmbeddedSession({ + prompt: async (session, prompt) => { + seenPrompt = prompt; + session.messages = [ + ...session.messages, + { role: "assistant", content: "done", timestamp: 2 }, + ]; + }, + }), + })); + + const result = await runEmbeddedAttempt({ + sessionId: "embedded-session", + sessionKey: "agent:main:main", + sessionFile, + workspaceDir, + agentDir, + config: { + agents: { + defaults: { + bootstrapMaxChars: 50, + bootstrapTotalMaxChars: 50, + }, + }, + }, + prompt: "hello", + timeoutMs: 10_000, + runId: "run-warning", + provider: "openai", + modelId: "gpt-test", + model: testModel, + authStorage: {} as AuthStorage, + modelRegistry: {} as ModelRegistry, + thinkLevel: "off", + senderIsOwner: true, + disableMessageTool: true, + }); + + expect(result.promptError).toBeNull(); + expect(seenPrompt).toContain("hook context"); + expect(seenPrompt).toContain("[Bootstrap truncation warning]"); + expect(seenPrompt).toContain("- AGENTS.md: 200 raw -> 20 injected"); + expect(seenPrompt).toContain("hello"); + }); +}); + describe("runEmbeddedAttempt cache-ttl tracking after compaction", () => { const tempPaths: string[] = []; diff --git a/src/agents/pi-embedded-runner/run/attempt.ts b/src/agents/pi-embedded-runner/run/attempt.ts index dc9df12865d..73b7d0fbff6 100644 --- a/src/agents/pi-embedded-runner/run/attempt.ts +++ b/src/agents/pi-embedded-runner/run/attempt.ts @@ -41,6 +41,7 @@ import { buildBootstrapPromptWarning, buildBootstrapTruncationReportMeta, buildBootstrapInjectionStats, + prependBootstrapPromptWarning, } from "../../bootstrap-budget.js"; import { makeBootstrapWarn, resolveBootstrapContextForRun } from "../../bootstrap-files.js"; import { createCacheTrace } from "../../cache-trace.js"; @@ -1665,6 +1666,9 @@ export async function runEmbeddedAttempt( }); const ttsHint = params.config ? buildTtsSystemPromptHint(params.config) : undefined; const ownerDisplay = resolveOwnerDisplaySetting(params.config); + const heartbeatPrompt = isDefaultAgent + ? resolveHeartbeatPrompt(params.config?.agents?.defaults?.heartbeat?.prompt) + : undefined; const appendPrompt = buildEmbeddedSystemPrompt({ workspaceDir: effectiveWorkspace, @@ -1675,9 +1679,7 @@ export async function runEmbeddedAttempt( ownerDisplay: ownerDisplay.ownerDisplay, ownerDisplaySecret: ownerDisplay.ownerDisplaySecret, reasoningTagHint, - heartbeatPrompt: isDefaultAgent - ? resolveHeartbeatPrompt(params.config?.agents?.defaults?.heartbeat?.prompt) - : undefined, + heartbeatPrompt, skillsPrompt, docsPath: docsPath ?? undefined, ttsHint, @@ -1694,7 +1696,6 @@ export async function runEmbeddedAttempt( userTime, userTimeFormat, contextFiles, - bootstrapTruncationWarningLines: bootstrapPromptWarning.lines, memoryCitationsMode: params.config?.memory?.citations, }); const systemPromptReport = buildSystemPromptReport({ @@ -2378,7 +2379,13 @@ export async function runEmbeddedAttempt( // Run before_prompt_build hooks to allow plugins to inject prompt context. // Legacy compatibility: before_agent_start is also checked for context fields. - let effectivePrompt = params.prompt; + let effectivePrompt = prependBootstrapPromptWarning( + params.prompt, + bootstrapPromptWarning.lines, + { + preserveExactPrompt: heartbeatPrompt, + }, + ); const hookCtx = { agentId: hookAgentId, sessionKey: params.sessionKey, @@ -2397,7 +2404,7 @@ export async function runEmbeddedAttempt( }); { if (hookResult?.prependContext) { - effectivePrompt = `${hookResult.prependContext}\n\n${params.prompt}`; + effectivePrompt = `${hookResult.prependContext}\n\n${effectivePrompt}`; log.debug( `hooks: prepended context to prompt (${hookResult.prependContext.length} chars)`, ); diff --git a/src/agents/pi-embedded-runner/system-prompt.ts b/src/agents/pi-embedded-runner/system-prompt.ts index ac2662f127f..ef246d1af23 100644 --- a/src/agents/pi-embedded-runner/system-prompt.ts +++ b/src/agents/pi-embedded-runner/system-prompt.ts @@ -51,7 +51,6 @@ export function buildEmbeddedSystemPrompt(params: { userTime?: string; userTimeFormat?: ResolvedTimeFormat; contextFiles?: EmbeddedContextFile[]; - bootstrapTruncationWarningLines?: string[]; memoryCitationsMode?: MemoryCitationsMode; }): string { return buildAgentSystemPrompt({ @@ -81,7 +80,6 @@ export function buildEmbeddedSystemPrompt(params: { userTime: params.userTime, userTimeFormat: params.userTimeFormat, contextFiles: params.contextFiles, - bootstrapTruncationWarningLines: params.bootstrapTruncationWarningLines, memoryCitationsMode: params.memoryCitationsMode, }); } diff --git a/src/agents/system-prompt.test.ts b/src/agents/system-prompt.test.ts index 3877f6fed21..b20a9524941 100644 --- a/src/agents/system-prompt.test.ts +++ b/src/agents/system-prompt.test.ts @@ -534,16 +534,13 @@ describe("buildAgentSystemPrompt", () => { ); }); - it("renders bootstrap truncation warning even when no context files are injected", () => { + it("omits project context when no context files are injected", () => { const prompt = buildAgentSystemPrompt({ workspaceDir: "/tmp/openclaw", - bootstrapTruncationWarningLines: ["AGENTS.md: 200 raw -> 0 injected"], contextFiles: [], }); - expect(prompt).toContain("# Project Context"); - expect(prompt).toContain("⚠ Bootstrap truncation warning:"); - expect(prompt).toContain("- AGENTS.md: 200 raw -> 0 injected"); + expect(prompt).not.toContain("# Project Context"); }); it("summarizes the message tool when available", () => { diff --git a/src/agents/system-prompt.ts b/src/agents/system-prompt.ts index 848222b7880..5f4ee932bd7 100644 --- a/src/agents/system-prompt.ts +++ b/src/agents/system-prompt.ts @@ -202,7 +202,6 @@ export function buildAgentSystemPrompt(params: { userTime?: string; userTimeFormat?: ResolvedTimeFormat; contextFiles?: EmbeddedContextFile[]; - bootstrapTruncationWarningLines?: string[]; skillsPrompt?: string; heartbeatPrompt?: string; docsPath?: string; @@ -614,13 +613,10 @@ export function buildAgentSystemPrompt(params: { } const contextFiles = params.contextFiles ?? []; - const bootstrapTruncationWarningLines = (params.bootstrapTruncationWarningLines ?? []).filter( - (line) => line.trim().length > 0, - ); const validContextFiles = contextFiles.filter( (file) => typeof file.path === "string" && file.path.trim().length > 0, ); - if (validContextFiles.length > 0 || bootstrapTruncationWarningLines.length > 0) { + if (validContextFiles.length > 0) { lines.push("# Project Context", ""); if (validContextFiles.length > 0) { const hasSoulFile = validContextFiles.some((file) => { @@ -636,13 +632,6 @@ export function buildAgentSystemPrompt(params: { } lines.push(""); } - if (bootstrapTruncationWarningLines.length > 0) { - lines.push("⚠ Bootstrap truncation warning:"); - for (const warningLine of bootstrapTruncationWarningLines) { - lines.push(`- ${warningLine}`); - } - lines.push(""); - } for (const file of validContextFiles) { lines.push(`## ${file.path}`, "", file.content, ""); } From f6868b7e42db7dc6a8a1d22daf02880bafd5dc42 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:51:41 -0700 Subject: [PATCH 102/187] refactor: dedupe channel entrypoints and test bridges --- extensions/amazon-bedrock/index.test.ts | 2 +- extensions/bluebubbles/index.ts | 16 ++-- extensions/bluebubbles/setup-entry.ts | 5 +- extensions/diffs/index.test.ts | 2 +- extensions/diffs/src/http.test.ts | 2 +- extensions/discord/index.ts | 21 ++--- extensions/discord/setup-entry.ts | 3 +- extensions/discord/src/api.test.ts | 2 +- extensions/discord/src/chunk.test.ts | 2 +- extensions/discord/src/monitor.test.ts | 2 +- .../discord/src/resolve-channels.test.ts | 2 +- extensions/discord/src/resolve-users.test.ts | 2 +- extensions/feishu/index.ts | 19 ++-- extensions/feishu/setup-entry.ts | 5 +- extensions/github-copilot/usage.test.ts | 5 +- extensions/googlechat/index.ts | 16 ++-- extensions/googlechat/setup-entry.ts | 5 +- .../src/monitor.webhook-routing.test.ts | 2 +- extensions/imessage/index.ts | 16 ++-- extensions/imessage/setup-entry.ts | 3 +- extensions/irc/index.ts | 17 ++-- extensions/irc/setup-entry.ts | 5 +- extensions/line/index.ts | 21 ++--- extensions/line/setup-entry.ts | 5 +- extensions/matrix/index.ts | 18 ++-- extensions/matrix/setup-entry.ts | 5 +- extensions/mattermost/index.ts | 27 ++---- extensions/mattermost/setup-entry.ts | 5 +- extensions/msteams/index.ts | 16 ++-- extensions/msteams/setup-entry.ts | 5 +- extensions/msteams/src/graph-upload.test.ts | 2 +- extensions/nextcloud-talk/index.ts | 16 ++-- extensions/nextcloud-talk/setup-entry.ts | 5 +- extensions/nostr/index.ts | 42 +++------ extensions/nostr/setup-entry.ts | 5 +- extensions/signal/index.ts | 16 ++-- extensions/signal/setup-entry.ts | 3 +- extensions/slack/index.ts | 16 ++-- extensions/slack/setup-entry.ts | 3 +- extensions/slack/src/monitor/media.test.ts | 2 +- extensions/synology-chat/index.ts | 16 ++-- extensions/synology-chat/setup-entry.ts | 5 +- extensions/talk-voice/index.test.ts | 2 +- extensions/telegram/index.ts | 17 ++-- extensions/telegram/setup-entry.ts | 3 +- .../telegram/src/account-inspect.test.ts | 2 +- extensions/telegram/src/accounts.test.ts | 2 +- .../src/bot.create-telegram-bot.test.ts | 4 +- extensions/telegram/src/bot.test.ts | 2 +- extensions/telegram/src/probe.test.ts | 2 +- extensions/test-utils/chunk-test-helpers.ts | 1 + extensions/test-utils/env.ts | 1 + extensions/test-utils/fetch-mock.ts | 1 + extensions/test-utils/frozen-time.ts | 1 + extensions/test-utils/mock-http-response.ts | 1 + extensions/test-utils/plugin-command.ts | 1 + extensions/test-utils/plugin-registration.ts | 1 + extensions/test-utils/provider-usage-fetch.ts | 4 + extensions/test-utils/temp-dir.ts | 1 + extensions/test-utils/typed-cases.ts | 1 + extensions/tlon/index.ts | 54 +++-------- extensions/tlon/setup-entry.ts | 5 +- extensions/twitch/index.ts | 19 ++-- extensions/whatsapp/index.ts | 16 ++-- extensions/whatsapp/setup-entry.ts | 3 +- .../src/accounts.whatsapp-auth.test.ts | 2 +- ...o-reply.connection-and-logging.e2e.test.ts | 2 +- .../auto-reply/web-auto-reply-utils.test.ts | 2 +- extensions/whatsapp/src/media.test.ts | 2 +- extensions/zalo/index.ts | 18 ++-- extensions/zalo/setup-entry.ts | 5 +- extensions/zalouser/index.ts | 21 ++--- extensions/zalouser/setup-entry.ts | 5 +- package.json | 3 +- .../check-no-extension-test-core-imports.ts | 90 +++++++++++++++++++ src/plugin-sdk/core.ts | 53 +++++++++++ src/plugin-sdk/subpaths.test.ts | 2 + 77 files changed, 360 insertions(+), 376 deletions(-) create mode 100644 extensions/test-utils/chunk-test-helpers.ts create mode 100644 extensions/test-utils/env.ts create mode 100644 extensions/test-utils/fetch-mock.ts create mode 100644 extensions/test-utils/frozen-time.ts create mode 100644 extensions/test-utils/mock-http-response.ts create mode 100644 extensions/test-utils/plugin-command.ts create mode 100644 extensions/test-utils/plugin-registration.ts create mode 100644 extensions/test-utils/provider-usage-fetch.ts create mode 100644 extensions/test-utils/temp-dir.ts create mode 100644 extensions/test-utils/typed-cases.ts create mode 100644 scripts/check-no-extension-test-core-imports.ts diff --git a/extensions/amazon-bedrock/index.test.ts b/extensions/amazon-bedrock/index.test.ts index 641173cd6ce..61b33a0bc68 100644 --- a/extensions/amazon-bedrock/index.test.ts +++ b/extensions/amazon-bedrock/index.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { registerSingleProviderPlugin } from "../../src/test-utils/plugin-registration.js"; +import { registerSingleProviderPlugin } from "../test-utils/plugin-registration.js"; import amazonBedrockPlugin from "./index.js"; describe("amazon-bedrock provider plugin", () => { diff --git a/extensions/bluebubbles/index.ts b/extensions/bluebubbles/index.ts index f04afb40959..778cbd8ae8f 100644 --- a/extensions/bluebubbles/index.ts +++ b/extensions/bluebubbles/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/bluebubbles"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/bluebubbles"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { bluebubblesPlugin } from "./src/channel.js"; import { setBlueBubblesRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "bluebubbles", name: "BlueBubbles", description: "BlueBubbles channel plugin (macOS app)", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setBlueBubblesRuntime(api.runtime); - api.registerChannel({ plugin: bluebubblesPlugin }); - }, -}; - -export default plugin; + plugin: bluebubblesPlugin, + setRuntime: setBlueBubblesRuntime, +}); diff --git a/extensions/bluebubbles/setup-entry.ts b/extensions/bluebubbles/setup-entry.ts index 5e05d9c8bb2..940837c87f6 100644 --- a/extensions/bluebubbles/setup-entry.ts +++ b/extensions/bluebubbles/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { bluebubblesPlugin } from "./src/channel.js"; -export default { - plugin: bluebubblesPlugin, -}; +export default defineSetupPluginEntry(bluebubblesPlugin); diff --git a/extensions/diffs/index.test.ts b/extensions/diffs/index.test.ts index c38da12bfcd..b1ade0c6a09 100644 --- a/extensions/diffs/index.test.ts +++ b/extensions/diffs/index.test.ts @@ -1,7 +1,7 @@ import type { IncomingMessage } from "node:http"; import type { OpenClawPluginApi } from "openclaw/plugin-sdk/diffs"; import { describe, expect, it, vi } from "vitest"; -import { createMockServerResponse } from "../../src/test-utils/mock-http-response.js"; +import { createMockServerResponse } from "../test-utils/mock-http-response.js"; import { createTestPluginApi } from "../test-utils/plugin-api.js"; import plugin from "./index.js"; diff --git a/extensions/diffs/src/http.test.ts b/extensions/diffs/src/http.test.ts index a1caef018e4..eed9abd77d8 100644 --- a/extensions/diffs/src/http.test.ts +++ b/extensions/diffs/src/http.test.ts @@ -1,6 +1,6 @@ import type { IncomingMessage } from "node:http"; import { afterEach, beforeEach, describe, expect, it } from "vitest"; -import { createMockServerResponse } from "../../../src/test-utils/mock-http-response.js"; +import { createMockServerResponse } from "../../test-utils/mock-http-response.js"; import { createDiffsHttpHandler } from "./http.js"; import { DiffArtifactStore } from "./store.js"; import { createDiffStoreHarness } from "./test-helpers.js"; diff --git a/extensions/discord/index.ts b/extensions/discord/index.ts index 13b32f08bb1..7c179623e23 100644 --- a/extensions/discord/index.ts +++ b/extensions/discord/index.ts @@ -1,22 +1,13 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { discordPlugin } from "./src/channel.js"; import { setDiscordRuntime } from "./src/runtime.js"; import { registerDiscordSubagentHooks } from "./src/subagent-hooks.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "discord", name: "Discord", description: "Discord channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setDiscordRuntime(api.runtime); - api.registerChannel({ plugin: discordPlugin }); - if (api.registrationMode !== "full") { - return; - } - registerDiscordSubagentHooks(api); - }, -}; - -export default plugin; + plugin: discordPlugin, + setRuntime: setDiscordRuntime, + registerFull: registerDiscordSubagentHooks, +}); diff --git a/extensions/discord/setup-entry.ts b/extensions/discord/setup-entry.ts index 329a9376c9f..e59c812ff4b 100644 --- a/extensions/discord/setup-entry.ts +++ b/extensions/discord/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { discordSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: discordSetupPlugin }; +export default defineSetupPluginEntry(discordSetupPlugin); diff --git a/extensions/discord/src/api.test.ts b/extensions/discord/src/api.test.ts index 5b0e648aa1d..09e0863e137 100644 --- a/extensions/discord/src/api.test.ts +++ b/extensions/discord/src/api.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../../src/test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; import { fetchDiscord } from "./api.js"; import { jsonResponse } from "./test-http-helpers.js"; diff --git a/extensions/discord/src/chunk.test.ts b/extensions/discord/src/chunk.test.ts index 3c667c0fc9f..69f5ec856ec 100644 --- a/extensions/discord/src/chunk.test.ts +++ b/extensions/discord/src/chunk.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { countLines, hasBalancedFences } from "../../../src/test-utils/chunk-test-helpers.js"; +import { countLines, hasBalancedFences } from "../../test-utils/chunk-test-helpers.js"; import { chunkDiscordText, chunkDiscordTextWithMode } from "./chunk.js"; describe("chunkDiscordText", () => { diff --git a/extensions/discord/src/monitor.test.ts b/extensions/discord/src/monitor.test.ts index 40f14a00551..b3af666c35f 100644 --- a/extensions/discord/src/monitor.test.ts +++ b/extensions/discord/src/monitor.test.ts @@ -1,6 +1,6 @@ import { ChannelType, type Guild } from "@buape/carbon"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { typedCases } from "../../../src/test-utils/typed-cases.js"; +import { typedCases } from "../../test-utils/typed-cases.js"; import { allowListMatches, buildDiscordMediaPayload, diff --git a/extensions/discord/src/resolve-channels.test.ts b/extensions/discord/src/resolve-channels.test.ts index fb46792aaaa..f053fb97888 100644 --- a/extensions/discord/src/resolve-channels.test.ts +++ b/extensions/discord/src/resolve-channels.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../../src/test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; import { resolveDiscordChannelAllowlist } from "./resolve-channels.js"; import { jsonResponse, urlToString } from "./test-http-helpers.js"; diff --git a/extensions/discord/src/resolve-users.test.ts b/extensions/discord/src/resolve-users.test.ts index d788b77ebe0..f67b7289a59 100644 --- a/extensions/discord/src/resolve-users.test.ts +++ b/extensions/discord/src/resolve-users.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../../src/test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { jsonResponse, urlToString } from "./test-http-helpers.js"; diff --git a/extensions/feishu/index.ts b/extensions/feishu/index.ts index ba7ac26922b..27f90f66479 100644 --- a/extensions/feishu/index.ts +++ b/extensions/feishu/index.ts @@ -1,5 +1,4 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/feishu"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/feishu"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { registerFeishuBitableTools } from "./src/bitable.js"; import { feishuPlugin } from "./src/channel.js"; import { registerFeishuChatTools } from "./src/chat.js"; @@ -46,17 +45,13 @@ export { } from "./src/mention.js"; export { feishuPlugin } from "./src/channel.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "feishu", name: "Feishu", description: "Feishu/Lark channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setFeishuRuntime(api.runtime); - api.registerChannel({ plugin: feishuPlugin }); - if (api.registrationMode !== "full") { - return; - } + plugin: feishuPlugin, + setRuntime: setFeishuRuntime, + registerFull(api) { registerFeishuSubagentHooks(api); registerFeishuDocTools(api); registerFeishuChatTools(api); @@ -65,6 +60,4 @@ const plugin = { registerFeishuPermTools(api); registerFeishuBitableTools(api); }, -}; - -export default plugin; +}); diff --git a/extensions/feishu/setup-entry.ts b/extensions/feishu/setup-entry.ts index 3e4df4faee8..1f16bde8bdd 100644 --- a/extensions/feishu/setup-entry.ts +++ b/extensions/feishu/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { feishuPlugin } from "./src/channel.js"; -export default { - plugin: feishuPlugin, -}; +export default defineSetupPluginEntry(feishuPlugin); diff --git a/extensions/github-copilot/usage.test.ts b/extensions/github-copilot/usage.test.ts index b4044c7f5f9..0bc97974d70 100644 --- a/extensions/github-copilot/usage.test.ts +++ b/extensions/github-copilot/usage.test.ts @@ -1,8 +1,5 @@ import { describe, expect, it } from "vitest"; -import { - createProviderUsageFetch, - makeResponse, -} from "../../src/test-utils/provider-usage-fetch.js"; +import { createProviderUsageFetch, makeResponse } from "../test-utils/provider-usage-fetch.js"; import { fetchCopilotUsage } from "./usage.js"; describe("fetchCopilotUsage", () => { diff --git a/extensions/googlechat/index.ts b/extensions/googlechat/index.ts index 892694f93b4..414bfc9557b 100644 --- a/extensions/googlechat/index.ts +++ b/extensions/googlechat/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/googlechat"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/googlechat"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { googlechatPlugin } from "./src/channel.js"; import { setGoogleChatRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "googlechat", name: "Google Chat", description: "OpenClaw Google Chat channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setGoogleChatRuntime(api.runtime); - api.registerChannel(googlechatPlugin); - }, -}; - -export default plugin; + plugin: googlechatPlugin, + setRuntime: setGoogleChatRuntime, +}); diff --git a/extensions/googlechat/setup-entry.ts b/extensions/googlechat/setup-entry.ts index be33127799f..44fd1f11fb3 100644 --- a/extensions/googlechat/setup-entry.ts +++ b/extensions/googlechat/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { googlechatPlugin } from "./src/channel.js"; -export default { - plugin: googlechatPlugin, -}; +export default defineSetupPluginEntry(googlechatPlugin); diff --git a/extensions/googlechat/src/monitor.webhook-routing.test.ts b/extensions/googlechat/src/monitor.webhook-routing.test.ts index 9896efce645..2258d154449 100644 --- a/extensions/googlechat/src/monitor.webhook-routing.test.ts +++ b/extensions/googlechat/src/monitor.webhook-routing.test.ts @@ -4,7 +4,7 @@ import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk/googlech import { afterEach, describe, expect, it, vi } from "vitest"; import { createEmptyPluginRegistry } from "../../../src/plugins/registry.js"; import { setActivePluginRegistry } from "../../../src/plugins/runtime.js"; -import { createMockServerResponse } from "../../../src/test-utils/mock-http-response.js"; +import { createMockServerResponse } from "../../test-utils/mock-http-response.js"; import type { ResolvedGoogleChatAccount } from "./accounts.js"; import { verifyGoogleChatRequest } from "./auth.js"; import { handleGoogleChatWebhookRequest, registerGoogleChatWebhookTarget } from "./monitor.js"; diff --git a/extensions/imessage/index.ts b/extensions/imessage/index.ts index e87d421cf2e..aea014f06d4 100644 --- a/extensions/imessage/index.ts +++ b/extensions/imessage/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { imessagePlugin } from "./src/channel.js"; import { setIMessageRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "imessage", name: "iMessage", description: "iMessage channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setIMessageRuntime(api.runtime); - api.registerChannel({ plugin: imessagePlugin }); - }, -}; - -export default plugin; + plugin: imessagePlugin, + setRuntime: setIMessageRuntime, +}); diff --git a/extensions/imessage/setup-entry.ts b/extensions/imessage/setup-entry.ts index 6b4c642d0ae..ed6936ca387 100644 --- a/extensions/imessage/setup-entry.ts +++ b/extensions/imessage/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { imessageSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: imessageSetupPlugin }; +export default defineSetupPluginEntry(imessageSetupPlugin); diff --git a/extensions/irc/index.ts b/extensions/irc/index.ts index 40182558dcb..5ae8619812d 100644 --- a/extensions/irc/index.ts +++ b/extensions/irc/index.ts @@ -1,17 +1,12 @@ -import type { ChannelPlugin, OpenClawPluginApi } from "openclaw/plugin-sdk/irc"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/irc"; +import type { ChannelPlugin } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { ircPlugin } from "./src/channel.js"; import { setIrcRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "irc", name: "IRC", description: "IRC channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setIrcRuntime(api.runtime); - api.registerChannel({ plugin: ircPlugin as ChannelPlugin }); - }, -}; - -export default plugin; + plugin: ircPlugin as ChannelPlugin, + setRuntime: setIrcRuntime, +}); diff --git a/extensions/irc/setup-entry.ts b/extensions/irc/setup-entry.ts index fe8bea1814d..3d3d040990c 100644 --- a/extensions/irc/setup-entry.ts +++ b/extensions/irc/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { ircPlugin } from "./src/channel.js"; -export default { - plugin: ircPlugin, -}; +export default defineSetupPluginEntry(ircPlugin); diff --git a/extensions/line/index.ts b/extensions/line/index.ts index 59b1d97920d..fabf1c9d5b7 100644 --- a/extensions/line/index.ts +++ b/extensions/line/index.ts @@ -1,22 +1,13 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/line"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/line"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { registerLineCardCommand } from "./src/card-command.js"; import { linePlugin } from "./src/channel.js"; import { setLineRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "line", name: "LINE", description: "LINE Messaging API channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setLineRuntime(api.runtime); - api.registerChannel({ plugin: linePlugin }); - if (api.registrationMode !== "full") { - return; - } - registerLineCardCommand(api); - }, -}; - -export default plugin; + plugin: linePlugin, + setRuntime: setLineRuntime, + registerFull: registerLineCardCommand, +}); diff --git a/extensions/line/setup-entry.ts b/extensions/line/setup-entry.ts index ca25d243155..97ed5fa30c6 100644 --- a/extensions/line/setup-entry.ts +++ b/extensions/line/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { lineSetupPlugin } from "./src/channel.setup.js"; -export default { - plugin: lineSetupPlugin, -}; +export default defineSetupPluginEntry(lineSetupPlugin); diff --git a/extensions/matrix/index.ts b/extensions/matrix/index.ts index 46a4ba5864f..5400a9b94c6 100644 --- a/extensions/matrix/index.ts +++ b/extensions/matrix/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/matrix"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/matrix"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { matrixPlugin } from "./src/channel.js"; import { setMatrixRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "matrix", name: "Matrix", - description: "Matrix channel plugin (matrix-js-sdk)", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setMatrixRuntime(api.runtime); - api.registerChannel({ plugin: matrixPlugin }); - }, -}; - -export default plugin; + description: "Matrix channel plugin", + plugin: matrixPlugin, + setRuntime: setMatrixRuntime, +}); diff --git a/extensions/matrix/setup-entry.ts b/extensions/matrix/setup-entry.ts index 4cbabfe6333..045b3a58917 100644 --- a/extensions/matrix/setup-entry.ts +++ b/extensions/matrix/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { matrixPlugin } from "./src/channel.js"; -export default { - plugin: matrixPlugin, -}; +export default defineSetupPluginEntry(matrixPlugin); diff --git a/extensions/mattermost/index.ts b/extensions/mattermost/index.ts index de6f4e1d8a0..f5086aba465 100644 --- a/extensions/mattermost/index.ts +++ b/extensions/mattermost/index.ts @@ -1,26 +1,17 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/mattermost"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/mattermost"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { mattermostPlugin } from "./src/channel.js"; -import { getSlashCommandState, registerSlashCommandRoute } from "./src/mattermost/slash-state.js"; +import { registerSlashCommandRoute } from "./src/mattermost/slash-state.js"; import { setMattermostRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "mattermost", name: "Mattermost", description: "Mattermost channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setMattermostRuntime(api.runtime); - api.registerChannel({ plugin: mattermostPlugin }); - if (api.registrationMode !== "full") { - return; - } - - // Register the HTTP route for slash command callbacks. - // The actual command registration with MM happens in the monitor - // after the bot connects and we know the team ID. + plugin: mattermostPlugin, + setRuntime: setMattermostRuntime, + registerFull(api) { + // Actual slash-command registration happens after the monitor connects and + // knows the team id; the route itself can be wired here. registerSlashCommandRoute(api); }, -}; - -export default plugin; +}); diff --git a/extensions/mattermost/setup-entry.ts b/extensions/mattermost/setup-entry.ts index 64c02fcbe9d..34ce40972e4 100644 --- a/extensions/mattermost/setup-entry.ts +++ b/extensions/mattermost/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { mattermostPlugin } from "./src/channel.js"; -export default { - plugin: mattermostPlugin, -}; +export default defineSetupPluginEntry(mattermostPlugin); diff --git a/extensions/msteams/index.ts b/extensions/msteams/index.ts index 725ad40dfdf..c190ea49224 100644 --- a/extensions/msteams/index.ts +++ b/extensions/msteams/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/msteams"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/msteams"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { msteamsPlugin } from "./src/channel.js"; import { setMSTeamsRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "msteams", name: "Microsoft Teams", description: "Microsoft Teams channel plugin (Bot Framework)", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setMSTeamsRuntime(api.runtime); - api.registerChannel({ plugin: msteamsPlugin }); - }, -}; - -export default plugin; + plugin: msteamsPlugin, + setRuntime: setMSTeamsRuntime, +}); diff --git a/extensions/msteams/setup-entry.ts b/extensions/msteams/setup-entry.ts index fb850b60e18..6e29414c82e 100644 --- a/extensions/msteams/setup-entry.ts +++ b/extensions/msteams/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { msteamsPlugin } from "./src/channel.js"; -export default { - plugin: msteamsPlugin, -}; +export default defineSetupPluginEntry(msteamsPlugin); diff --git a/extensions/msteams/src/graph-upload.test.ts b/extensions/msteams/src/graph-upload.test.ts index b79086f54ca..90a9da1d352 100644 --- a/extensions/msteams/src/graph-upload.test.ts +++ b/extensions/msteams/src/graph-upload.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it, vi } from "vitest"; -import { withFetchPreconnect } from "../../../src/test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; import { uploadToOneDrive, uploadToSharePoint } from "./graph-upload.js"; describe("graph upload helpers", () => { diff --git a/extensions/nextcloud-talk/index.ts b/extensions/nextcloud-talk/index.ts index 697a810009f..2057bd435e8 100644 --- a/extensions/nextcloud-talk/index.ts +++ b/extensions/nextcloud-talk/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/nextcloud-talk"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/nextcloud-talk"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { nextcloudTalkPlugin } from "./src/channel.js"; import { setNextcloudTalkRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "nextcloud-talk", name: "Nextcloud Talk", description: "Nextcloud Talk channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setNextcloudTalkRuntime(api.runtime); - api.registerChannel({ plugin: nextcloudTalkPlugin }); - }, -}; - -export default plugin; + plugin: nextcloudTalkPlugin, + setRuntime: setNextcloudTalkRuntime, +}); diff --git a/extensions/nextcloud-talk/setup-entry.ts b/extensions/nextcloud-talk/setup-entry.ts index f33df37c7dc..88aec7d47e9 100644 --- a/extensions/nextcloud-talk/setup-entry.ts +++ b/extensions/nextcloud-talk/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { nextcloudTalkPlugin } from "./src/channel.js"; -export default { - plugin: nextcloudTalkPlugin, -}; +export default defineSetupPluginEntry(nextcloudTalkPlugin); diff --git a/extensions/nostr/index.ts b/extensions/nostr/index.ts index d8fdb203924..cdabf64c322 100644 --- a/extensions/nostr/index.ts +++ b/extensions/nostr/index.ts @@ -1,24 +1,17 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/nostr"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/nostr"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { nostrPlugin } from "./src/channel.js"; import type { NostrProfile } from "./src/config-schema.js"; import { createNostrProfileHttpHandler } from "./src/nostr-profile-http.js"; -import { setNostrRuntime, getNostrRuntime } from "./src/runtime.js"; +import { getNostrRuntime, setNostrRuntime } from "./src/runtime.js"; import { resolveNostrAccount } from "./src/types.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "nostr", name: "Nostr", description: "Nostr DM channel plugin via NIP-04", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setNostrRuntime(api.runtime); - api.registerChannel({ plugin: nostrPlugin }); - if (api.registrationMode !== "full") { - return; - } - - // Register HTTP handler for profile management + plugin: nostrPlugin, + setRuntime: setNostrRuntime, + registerFull(api) { const httpHandler = createNostrProfileHttpHandler({ getConfigProfile: (accountId: string) => { const runtime = getNostrRuntime(); @@ -30,23 +23,18 @@ const plugin = { const runtime = getNostrRuntime(); const cfg = runtime.config.loadConfig(); - // Build the config patch for channels.nostr.profile const channels = (cfg.channels ?? {}) as Record; const nostrConfig = (channels.nostr ?? {}) as Record; - const updatedNostrConfig = { - ...nostrConfig, - profile, - }; - - const updatedChannels = { - ...channels, - nostr: updatedNostrConfig, - }; - await runtime.config.writeConfigFile({ ...cfg, - channels: updatedChannels, + channels: { + ...channels, + nostr: { + ...nostrConfig, + profile, + }, + }, }); }, getAccountInfo: (accountId: string) => { @@ -71,6 +59,4 @@ const plugin = { handler: httpHandler, }); }, -}; - -export default plugin; +}); diff --git a/extensions/nostr/setup-entry.ts b/extensions/nostr/setup-entry.ts index 8884a71cc80..f2ac263fd0f 100644 --- a/extensions/nostr/setup-entry.ts +++ b/extensions/nostr/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { nostrPlugin } from "./src/channel.js"; -export default { - plugin: nostrPlugin, -}; +export default defineSetupPluginEntry(nostrPlugin); diff --git a/extensions/signal/index.ts b/extensions/signal/index.ts index 0a686851120..6b20777f842 100644 --- a/extensions/signal/index.ts +++ b/extensions/signal/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { signalPlugin } from "./src/channel.js"; import { setSignalRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "signal", name: "Signal", description: "Signal channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setSignalRuntime(api.runtime); - api.registerChannel({ plugin: signalPlugin }); - }, -}; - -export default plugin; + plugin: signalPlugin, + setRuntime: setSignalRuntime, +}); diff --git a/extensions/signal/setup-entry.ts b/extensions/signal/setup-entry.ts index 18c27ec5a16..63f6d95e8fc 100644 --- a/extensions/signal/setup-entry.ts +++ b/extensions/signal/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { signalSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: signalSetupPlugin }; +export default defineSetupPluginEntry(signalSetupPlugin); diff --git a/extensions/slack/index.ts b/extensions/slack/index.ts index f1147cb9c91..44abfa36b0d 100644 --- a/extensions/slack/index.ts +++ b/extensions/slack/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { slackPlugin } from "./src/channel.js"; import { setSlackRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "slack", name: "Slack", description: "Slack channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setSlackRuntime(api.runtime); - api.registerChannel({ plugin: slackPlugin }); - }, -}; - -export default plugin; + plugin: slackPlugin, + setRuntime: setSlackRuntime, +}); diff --git a/extensions/slack/setup-entry.ts b/extensions/slack/setup-entry.ts index 1bd6eabde59..5a80ca2128b 100644 --- a/extensions/slack/setup-entry.ts +++ b/extensions/slack/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { slackSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: slackSetupPlugin }; +export default defineSetupPluginEntry(slackSetupPlugin); diff --git a/extensions/slack/src/monitor/media.test.ts b/extensions/slack/src/monitor/media.test.ts index f745f205950..9d5114e2961 100644 --- a/extensions/slack/src/monitor/media.test.ts +++ b/extensions/slack/src/monitor/media.test.ts @@ -4,7 +4,7 @@ import * as mediaFetch from "../../../../src/media/fetch.js"; import type { SavedMedia } from "../../../../src/media/store.js"; import * as mediaStore from "../../../../src/media/store.js"; import { mockPinnedHostnameResolution } from "../../../../src/test-helpers/ssrf.js"; -import { type FetchMock, withFetchPreconnect } from "../../../../src/test-utils/fetch-mock.js"; +import { type FetchMock, withFetchPreconnect } from "../../../test-utils/fetch-mock.js"; import { fetchWithSlackAuth, resolveSlackAttachmentContent, diff --git a/extensions/synology-chat/index.ts b/extensions/synology-chat/index.ts index 9078b9f86c7..79e3f49d513 100644 --- a/extensions/synology-chat/index.ts +++ b/extensions/synology-chat/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/synology-chat"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/synology-chat"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { synologyChatPlugin } from "./src/channel.js"; import { setSynologyRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "synology-chat", name: "Synology Chat", description: "Native Synology Chat channel plugin for OpenClaw", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setSynologyRuntime(api.runtime); - api.registerChannel({ plugin: synologyChatPlugin }); - }, -}; - -export default plugin; + plugin: synologyChatPlugin, + setRuntime: setSynologyRuntime, +}); diff --git a/extensions/synology-chat/setup-entry.ts b/extensions/synology-chat/setup-entry.ts index 45cc966e082..858696710a8 100644 --- a/extensions/synology-chat/setup-entry.ts +++ b/extensions/synology-chat/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { synologyChatPlugin } from "./src/channel.js"; -export default { - plugin: synologyChatPlugin, -}; +export default defineSetupPluginEntry(synologyChatPlugin); diff --git a/extensions/talk-voice/index.test.ts b/extensions/talk-voice/index.test.ts index 2d0a991aa47..15876987554 100644 --- a/extensions/talk-voice/index.test.ts +++ b/extensions/talk-voice/index.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it, vi } from "vitest"; -import type { OpenClawPluginCommandDefinition } from "../../src/plugins/types.js"; +import type { OpenClawPluginCommandDefinition } from "../test-utils/plugin-command.js"; import { createPluginRuntimeMock } from "../test-utils/plugin-runtime-mock.js"; import register from "./index.js"; diff --git a/extensions/telegram/index.ts b/extensions/telegram/index.ts index d47ae46b6ce..89413373c5a 100644 --- a/extensions/telegram/index.ts +++ b/extensions/telegram/index.ts @@ -1,17 +1,12 @@ -import type { ChannelPlugin, OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import type { ChannelPlugin } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { telegramPlugin } from "./src/channel.js"; import { setTelegramRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "telegram", name: "Telegram", description: "Telegram channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setTelegramRuntime(api.runtime); - api.registerChannel({ plugin: telegramPlugin as ChannelPlugin }); - }, -}; - -export default plugin; + plugin: telegramPlugin as ChannelPlugin, + setRuntime: setTelegramRuntime, +}); diff --git a/extensions/telegram/setup-entry.ts b/extensions/telegram/setup-entry.ts index 030f4bb3295..c44a073e80b 100644 --- a/extensions/telegram/setup-entry.ts +++ b/extensions/telegram/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { telegramSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: telegramSetupPlugin }; +export default defineSetupPluginEntry(telegramSetupPlugin); diff --git a/extensions/telegram/src/account-inspect.test.ts b/extensions/telegram/src/account-inspect.test.ts index 5e58626ba03..54915edb61c 100644 --- a/extensions/telegram/src/account-inspect.test.ts +++ b/extensions/telegram/src/account-inspect.test.ts @@ -3,7 +3,7 @@ import os from "node:os"; import path from "node:path"; import { describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import { withEnv } from "../../../src/test-utils/env.js"; +import { withEnv } from "../../test-utils/env.js"; import { inspectTelegramAccount } from "./account-inspect.js"; describe("inspectTelegramAccount SecretRef resolution", () => { diff --git a/extensions/telegram/src/accounts.test.ts b/extensions/telegram/src/accounts.test.ts index fb83b9071a5..6155b89d0af 100644 --- a/extensions/telegram/src/accounts.test.ts +++ b/extensions/telegram/src/accounts.test.ts @@ -1,7 +1,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; import * as subsystemModule from "../../../src/logging/subsystem.js"; -import { withEnv } from "../../../src/test-utils/env.js"; +import { withEnv } from "../../test-utils/env.js"; import { listTelegramAccountIds, resetMissingDefaultWarnFlag, diff --git a/extensions/telegram/src/bot.create-telegram-bot.test.ts b/extensions/telegram/src/bot.create-telegram-bot.test.ts index d3854849b10..3390aa3ff24 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test.ts @@ -2,9 +2,9 @@ import fs from "node:fs"; import os from "node:os"; import path from "node:path"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; -import { withEnvAsync } from "../../../src/test-utils/env.js"; -import { useFrozenTime, useRealTime } from "../../../src/test-utils/frozen-time.js"; import { escapeRegExp, formatEnvelopeTimestamp } from "../../../test/helpers/envelope-timestamp.js"; +import { withEnvAsync } from "../../test-utils/env.js"; +import { useFrozenTime, useRealTime } from "../../test-utils/frozen-time.js"; import { answerCallbackQuerySpy, botCtorSpy, diff --git a/extensions/telegram/src/bot.test.ts b/extensions/telegram/src/bot.test.ts index 17f6870a964..3266c080254 100644 --- a/extensions/telegram/src/bot.test.ts +++ b/extensions/telegram/src/bot.test.ts @@ -1,11 +1,11 @@ import { rm } from "node:fs/promises"; +import type { PluginInteractiveTelegramHandlerContext } from "openclaw/plugin-sdk/core"; import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; import { expectChannelInboundContextContract as expectInboundContextContract } from "../../../src/channels/plugins/contracts/suites.js"; import { clearPluginInteractiveHandlers, registerPluginInteractiveHandler, } from "../../../src/plugins/interactive.js"; -import type { PluginInteractiveTelegramHandlerContext } from "../../../src/plugins/types.js"; import { escapeRegExp, formatEnvelopeTimestamp } from "../../../test/helpers/envelope-timestamp.js"; import { answerCallbackQuerySpy, diff --git a/extensions/telegram/src/probe.test.ts b/extensions/telegram/src/probe.test.ts index 23a2051cfa0..970e2559540 100644 --- a/extensions/telegram/src/probe.test.ts +++ b/extensions/telegram/src/probe.test.ts @@ -1,5 +1,5 @@ import { afterEach, type Mock, describe, expect, it, vi } from "vitest"; -import { withFetchPreconnect } from "../../../src/test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; import { probeTelegram, resetTelegramProbeFetcherCacheForTests } from "./probe.js"; const resolveTelegramFetch = vi.hoisted(() => vi.fn()); diff --git a/extensions/test-utils/chunk-test-helpers.ts b/extensions/test-utils/chunk-test-helpers.ts new file mode 100644 index 00000000000..643e28e5c24 --- /dev/null +++ b/extensions/test-utils/chunk-test-helpers.ts @@ -0,0 +1 @@ +export { countLines, hasBalancedFences } from "../../src/test-utils/chunk-test-helpers.js"; diff --git a/extensions/test-utils/env.ts b/extensions/test-utils/env.ts new file mode 100644 index 00000000000..b171aa55a6c --- /dev/null +++ b/extensions/test-utils/env.ts @@ -0,0 +1 @@ +export { captureEnv, withEnv, withEnvAsync } from "../../src/test-utils/env.js"; diff --git a/extensions/test-utils/fetch-mock.ts b/extensions/test-utils/fetch-mock.ts new file mode 100644 index 00000000000..2cd6b65e680 --- /dev/null +++ b/extensions/test-utils/fetch-mock.ts @@ -0,0 +1 @@ +export { withFetchPreconnect, type FetchMock } from "../../src/test-utils/fetch-mock.js"; diff --git a/extensions/test-utils/frozen-time.ts b/extensions/test-utils/frozen-time.ts new file mode 100644 index 00000000000..ec31962fb76 --- /dev/null +++ b/extensions/test-utils/frozen-time.ts @@ -0,0 +1 @@ +export { useFrozenTime, useRealTime } from "../../src/test-utils/frozen-time.js"; diff --git a/extensions/test-utils/mock-http-response.ts b/extensions/test-utils/mock-http-response.ts new file mode 100644 index 00000000000..bf0d8bef20c --- /dev/null +++ b/extensions/test-utils/mock-http-response.ts @@ -0,0 +1 @@ +export { createMockServerResponse } from "../../src/test-utils/mock-http-response.js"; diff --git a/extensions/test-utils/plugin-command.ts b/extensions/test-utils/plugin-command.ts new file mode 100644 index 00000000000..3b6f3aad50f --- /dev/null +++ b/extensions/test-utils/plugin-command.ts @@ -0,0 +1 @@ +export type { OpenClawPluginCommandDefinition } from "openclaw/plugin-sdk/core"; diff --git a/extensions/test-utils/plugin-registration.ts b/extensions/test-utils/plugin-registration.ts new file mode 100644 index 00000000000..7a7da8ecdad --- /dev/null +++ b/extensions/test-utils/plugin-registration.ts @@ -0,0 +1 @@ +export { registerSingleProviderPlugin } from "../../src/test-utils/plugin-registration.js"; diff --git a/extensions/test-utils/provider-usage-fetch.ts b/extensions/test-utils/provider-usage-fetch.ts new file mode 100644 index 00000000000..d70a6e1657a --- /dev/null +++ b/extensions/test-utils/provider-usage-fetch.ts @@ -0,0 +1,4 @@ +export { + createProviderUsageFetch, + makeResponse, +} from "../../src/test-utils/provider-usage-fetch.js"; diff --git a/extensions/test-utils/temp-dir.ts b/extensions/test-utils/temp-dir.ts new file mode 100644 index 00000000000..3bd69bcc7b9 --- /dev/null +++ b/extensions/test-utils/temp-dir.ts @@ -0,0 +1 @@ +export { withTempDir } from "../../src/test-utils/temp-dir.js"; diff --git a/extensions/test-utils/typed-cases.ts b/extensions/test-utils/typed-cases.ts new file mode 100644 index 00000000000..4b6bd35b1ec --- /dev/null +++ b/extensions/test-utils/typed-cases.ts @@ -0,0 +1 @@ +export { typedCases } from "../../src/test-utils/typed-cases.js"; diff --git a/extensions/tlon/index.ts b/extensions/tlon/index.ts index 2927a9a4b53..9ae569fea03 100644 --- a/extensions/tlon/index.ts +++ b/extensions/tlon/index.ts @@ -2,14 +2,12 @@ import { spawn } from "node:child_process"; import { existsSync } from "node:fs"; import { dirname, join } from "node:path"; import { fileURLToPath } from "node:url"; -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/tlon"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/tlon"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { tlonPlugin } from "./src/channel.js"; import { setTlonRuntime } from "./src/runtime.js"; const __dirname = dirname(fileURLToPath(import.meta.url)); -// Whitelist of allowed tlon subcommands const ALLOWED_TLON_COMMANDS = new Set([ "activity", "channels", @@ -24,40 +22,29 @@ const ALLOWED_TLON_COMMANDS = new Set([ "version", ]); -/** - * Find the tlon binary from the skill package - */ let cachedTlonBinary: string | undefined; function findTlonBinary(): string { if (cachedTlonBinary) { return cachedTlonBinary; } - // Check in node_modules/.bin const skillBin = join(__dirname, "node_modules", ".bin", "tlon"); if (existsSync(skillBin)) { cachedTlonBinary = skillBin; return skillBin; } - // Check for platform-specific binary directly - const platform = process.platform; - const arch = process.arch; - const platformPkg = `@tloncorp/tlon-skill-${platform}-${arch}`; + const platformPkg = `@tloncorp/tlon-skill-${process.platform}-${process.arch}`; const platformBin = join(__dirname, "node_modules", platformPkg, "tlon"); if (existsSync(platformBin)) { cachedTlonBinary = platformBin; return platformBin; } - // Fallback to PATH cachedTlonBinary = "tlon"; return cachedTlonBinary; } -/** - * Shell-like argument splitter that respects quotes - */ function shellSplit(str: string): string[] { const args: string[] = []; let cur = ""; @@ -92,18 +79,15 @@ function shellSplit(str: string): string[] { } cur += ch; } - if (cur) args.push(cur); + if (cur) { + args.push(cur); + } return args; } -/** - * Run the tlon command and return the result - */ function runTlonCommand(binary: string, args: string[]): Promise { return new Promise((resolve, reject) => { - const child = spawn(binary, args, { - env: process.env, - }); + const child = spawn(binary, args, { env: process.env }); let stdout = ""; let stderr = ""; @@ -123,25 +107,20 @@ function runTlonCommand(binary: string, args: string[]): Promise { child.on("close", (code) => { if (code !== 0) { reject(new Error(stderr || `tlon exited with code ${code}`)); - } else { - resolve(stdout); + return; } + resolve(stdout); }); }); } -const plugin = { +export default defineChannelPluginEntry({ id: "tlon", name: "Tlon", description: "Tlon/Urbit channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setTlonRuntime(api.runtime); - api.registerChannel({ plugin: tlonPlugin }); - if (api.registrationMode !== "full") { - return; - } - + plugin: tlonPlugin, + setRuntime: setTlonRuntime, + registerFull(api) { api.logger.debug?.("[tlon] Registering tlon tool"); api.registerTool({ name: "tlon", @@ -164,9 +143,6 @@ const plugin = { async execute(_id: string, params: { command: string }) { try { const args = shellSplit(params.command); - const tlonBinary = findTlonBinary(); - - // Validate first argument is a whitelisted tlon subcommand const subcommand = args[0]; if (!ALLOWED_TLON_COMMANDS.has(subcommand)) { return { @@ -180,7 +156,7 @@ const plugin = { }; } - const output = await runTlonCommand(tlonBinary, args); + const output = await runTlonCommand(findTlonBinary(), args); return { content: [{ type: "text" as const, text: output }], details: undefined, @@ -194,6 +170,4 @@ const plugin = { }, }); }, -}; - -export default plugin; +}); diff --git a/extensions/tlon/setup-entry.ts b/extensions/tlon/setup-entry.ts index 667e917c8da..6a14ba3bade 100644 --- a/extensions/tlon/setup-entry.ts +++ b/extensions/tlon/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { tlonPlugin } from "./src/channel.js"; -export default { - plugin: tlonPlugin, -}; +export default defineSetupPluginEntry(tlonPlugin); diff --git a/extensions/twitch/index.ts b/extensions/twitch/index.ts index cbdb20bff4d..1a4ea89185c 100644 --- a/extensions/twitch/index.ts +++ b/extensions/twitch/index.ts @@ -1,20 +1,13 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/twitch"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/twitch"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { twitchPlugin } from "./src/plugin.js"; import { setTwitchRuntime } from "./src/runtime.js"; export { monitorTwitchProvider } from "./src/monitor.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "twitch", name: "Twitch", - description: "Twitch channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setTwitchRuntime(api.runtime); - // oxlint-disable-next-line typescript/no-explicit-any - api.registerChannel({ plugin: twitchPlugin as any }); - }, -}; - -export default plugin; + description: "Twitch chat channel plugin", + plugin: twitchPlugin, + setRuntime: setTwitchRuntime, +}); diff --git a/extensions/whatsapp/index.ts b/extensions/whatsapp/index.ts index c0f097ddf7d..da16917fa43 100644 --- a/extensions/whatsapp/index.ts +++ b/extensions/whatsapp/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { whatsappPlugin } from "./src/channel.js"; import { setWhatsAppRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "whatsapp", name: "WhatsApp", description: "WhatsApp channel plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setWhatsAppRuntime(api.runtime); - api.registerChannel({ plugin: whatsappPlugin }); - }, -}; - -export default plugin; + plugin: whatsappPlugin, + setRuntime: setWhatsAppRuntime, +}); diff --git a/extensions/whatsapp/setup-entry.ts b/extensions/whatsapp/setup-entry.ts index 5b18e10073b..a01efecdc36 100644 --- a/extensions/whatsapp/setup-entry.ts +++ b/extensions/whatsapp/setup-entry.ts @@ -1,3 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { whatsappSetupPlugin } from "./src/channel.setup.js"; -export default { plugin: whatsappSetupPlugin }; +export default defineSetupPluginEntry(whatsappSetupPlugin); diff --git a/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts b/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts index 349bccc65e5..43d1739e13f 100644 --- a/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts +++ b/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts @@ -2,7 +2,7 @@ import fs from "node:fs"; import os from "node:os"; import path from "node:path"; import { afterEach, beforeEach, describe, expect, it } from "vitest"; -import { captureEnv } from "../../../src/test-utils/env.js"; +import { captureEnv } from "../../test-utils/env.js"; import { hasAnyWhatsAppAuth, listWhatsAppAuthDirs } from "./accounts.js"; describe("hasAnyWhatsAppAuth", () => { diff --git a/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts b/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts index dd324f47351..6a5184fc059 100644 --- a/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts +++ b/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts @@ -4,8 +4,8 @@ import fs from "node:fs/promises"; import { beforeAll, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; import { setLoggerOverride } from "../../../src/logging.js"; -import { withEnvAsync } from "../../../src/test-utils/env.js"; import { escapeRegExp, formatEnvelopeTimestamp } from "../../../test/helpers/envelope-timestamp.js"; +import { withEnvAsync } from "../../test-utils/env.js"; import { createMockWebListener, createWebListenerFactoryCapture, diff --git a/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts b/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts index 0107fa126d7..d1011f5c7f8 100644 --- a/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts +++ b/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts @@ -2,7 +2,7 @@ import fs from "node:fs/promises"; import path from "node:path"; import { describe, expect, it, vi } from "vitest"; import { saveSessionStore } from "../../../../src/config/sessions.js"; -import { withTempDir } from "../../../../src/test-utils/temp-dir.js"; +import { withTempDir } from "../../../test-utils/temp-dir.js"; import { debugMention, isBotMentionedFromTargets, diff --git a/extensions/whatsapp/src/media.test.ts b/extensions/whatsapp/src/media.test.ts index e21d58b4bb7..45f3fbae309 100644 --- a/extensions/whatsapp/src/media.test.ts +++ b/extensions/whatsapp/src/media.test.ts @@ -7,8 +7,8 @@ import { resolveStateDir } from "../../../src/config/paths.js"; import { resolvePreferredOpenClawTmpDir } from "../../../src/infra/tmp-openclaw-dir.js"; import { optimizeImageToPng } from "../../../src/media/image-ops.js"; import { mockPinnedHostnameResolution } from "../../../src/test-helpers/ssrf.js"; -import { captureEnv } from "../../../src/test-utils/env.js"; import { sendVoiceMessageDiscord } from "../../discord/src/send.js"; +import { captureEnv } from "../../test-utils/env.js"; import { LocalMediaAccessError, loadWebMedia, diff --git a/extensions/zalo/index.ts b/extensions/zalo/index.ts index ef62ee6e560..c5091444450 100644 --- a/extensions/zalo/index.ts +++ b/extensions/zalo/index.ts @@ -1,17 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/zalo"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/zalo"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; import { zaloPlugin } from "./src/channel.js"; import { setZaloRuntime } from "./src/runtime.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "zalo", name: "Zalo", - description: "Zalo channel plugin (Bot API)", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setZaloRuntime(api.runtime); - api.registerChannel(zaloPlugin); - }, -}; - -export default plugin; + description: "Zalo channel plugin", + plugin: zaloPlugin, + setRuntime: setZaloRuntime, +}); diff --git a/extensions/zalo/setup-entry.ts b/extensions/zalo/setup-entry.ts index dd8ca1b70f8..d26b0f93fe0 100644 --- a/extensions/zalo/setup-entry.ts +++ b/extensions/zalo/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { zaloPlugin } from "./src/channel.js"; -export default { - plugin: zaloPlugin, -}; +export default defineSetupPluginEntry(zaloPlugin); diff --git a/extensions/zalouser/index.ts b/extensions/zalouser/index.ts index 8d470b043e3..2199567cff8 100644 --- a/extensions/zalouser/index.ts +++ b/extensions/zalouser/index.ts @@ -1,21 +1,16 @@ -import type { AnyAgentTool, OpenClawPluginApi } from "openclaw/plugin-sdk/zalouser"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/zalouser"; +import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core"; +import type { AnyAgentTool } from "openclaw/plugin-sdk/zalouser"; import { zalouserPlugin } from "./src/channel.js"; import { setZalouserRuntime } from "./src/runtime.js"; import { ZalouserToolSchema, executeZalouserTool } from "./src/tool.js"; -const plugin = { +export default defineChannelPluginEntry({ id: "zalouser", name: "Zalo Personal", description: "Zalo personal account messaging via native zca-js integration", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { - setZalouserRuntime(api.runtime); - api.registerChannel(zalouserPlugin); - if (api.registrationMode !== "full") { - return; - } - + plugin: zalouserPlugin, + setRuntime: setZalouserRuntime, + registerFull(api) { api.registerTool({ name: "zalouser", label: "Zalo Personal", @@ -27,6 +22,4 @@ const plugin = { execute: executeZalouserTool, } as AnyAgentTool); }, -}; - -export default plugin; +}); diff --git a/extensions/zalouser/setup-entry.ts b/extensions/zalouser/setup-entry.ts index f983cad8f80..0320d3cf945 100644 --- a/extensions/zalouser/setup-entry.ts +++ b/extensions/zalouser/setup-entry.ts @@ -1,5 +1,4 @@ +import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core"; import { zalouserPlugin } from "./src/channel.js"; -export default { - plugin: zalouserPlugin, -}; +export default defineSetupPluginEntry(zalouserPlugin); diff --git a/package.json b/package.json index 4bb825d0d7a..08acac5db40 100644 --- a/package.json +++ b/package.json @@ -443,7 +443,7 @@ "build:plugin-sdk:dts": "tsc -p tsconfig.plugin-sdk.dts.json || true", "build:strict-smoke": "pnpm canvas:a2ui:bundle && node scripts/tsdown-build.mjs && node scripts/runtime-postbuild.mjs && pnpm build:plugin-sdk:dts", "canvas:a2ui:bundle": "bash scripts/bundle-a2ui.sh", - "check": "pnpm check:host-env-policy:swift && pnpm format:check && pnpm tsgo && pnpm plugin-sdk:check-exports && pnpm lint && pnpm lint:tmp:no-random-messaging && pnpm lint:tmp:channel-agnostic-boundaries && pnpm lint:tmp:no-raw-channel-fetch && pnpm lint:agent:ingress-owner && pnpm lint:plugins:no-register-http-handler && pnpm lint:plugins:no-monolithic-plugin-sdk-entry-imports && pnpm lint:webhook:no-low-level-body-read && pnpm lint:auth:no-pairing-store-group && pnpm lint:auth:pairing-account-scope", + "check": "pnpm check:host-env-policy:swift && pnpm format:check && pnpm tsgo && pnpm plugin-sdk:check-exports && pnpm lint && pnpm lint:tmp:no-random-messaging && pnpm lint:tmp:channel-agnostic-boundaries && pnpm lint:tmp:no-raw-channel-fetch && pnpm lint:agent:ingress-owner && pnpm lint:plugins:no-register-http-handler && pnpm lint:plugins:no-monolithic-plugin-sdk-entry-imports && pnpm lint:plugins:no-extension-test-core-imports && pnpm lint:webhook:no-low-level-body-read && pnpm lint:auth:no-pairing-store-group && pnpm lint:auth:pairing-account-scope", "check:docs": "pnpm format:docs:check && pnpm lint:docs && pnpm docs:check-i18n-glossary && pnpm docs:check-links", "check:host-env-policy:swift": "node scripts/generate-host-env-security-policy-swift.mjs --check", "check:loc": "node --import tsx scripts/check-ts-max-loc.ts --max 500", @@ -495,6 +495,7 @@ "lint:docs": "pnpm dlx markdownlint-cli2", "lint:docs:fix": "pnpm dlx markdownlint-cli2 --fix", "lint:fix": "oxlint --type-aware --fix && pnpm format", + "lint:plugins:no-extension-test-core-imports": "node --import tsx scripts/check-no-extension-test-core-imports.ts", "lint:plugins:no-monolithic-plugin-sdk-entry-imports": "node --import tsx scripts/check-no-monolithic-plugin-sdk-entry-imports.ts", "lint:plugins:no-register-http-handler": "node scripts/check-no-register-http-handler.mjs", "lint:swift": "swiftlint lint --config .swiftlint.yml && (cd apps/ios && swiftlint lint --config .swiftlint.yml)", diff --git a/scripts/check-no-extension-test-core-imports.ts b/scripts/check-no-extension-test-core-imports.ts new file mode 100644 index 00000000000..b8e3b1bc764 --- /dev/null +++ b/scripts/check-no-extension-test-core-imports.ts @@ -0,0 +1,90 @@ +import fs from "node:fs"; +import path from "node:path"; + +const FORBIDDEN_PATTERNS: Array<{ pattern: RegExp; hint: string }> = [ + { + pattern: /["']openclaw\/plugin-sdk["']/, + hint: "Use openclaw/plugin-sdk/ instead of the monolithic root entry.", + }, + { + pattern: /["']openclaw\/plugin-sdk\/compat["']/, + hint: "Use a focused public plugin-sdk subpath instead of compat.", + }, + { + pattern: /["'](?:\.\.\/)+(?:src\/test-utils\/)[^"']+["']/, + hint: "Use extensions/test-utils/* bridges for shared extension test helpers.", + }, + { + pattern: /["'](?:\.\.\/)+(?:src\/plugins\/types\.js)["']/, + hint: "Use public plugin-sdk/core types or extensions/test-utils bridges instead.", + }, +]; + +function isExtensionTestFile(filePath: string): boolean { + return /\.test\.[cm]?[jt]sx?$/u.test(filePath) || /\.e2e\.test\.[cm]?[jt]sx?$/u.test(filePath); +} + +function collectExtensionTestFiles(rootDir: string): string[] { + const files: string[] = []; + const stack = [rootDir]; + while (stack.length > 0) { + const current = stack.pop(); + if (!current) { + continue; + } + let entries: fs.Dirent[] = []; + try { + entries = fs.readdirSync(current, { withFileTypes: true }); + } catch { + continue; + } + for (const entry of entries) { + const fullPath = path.join(current, entry.name); + if (entry.isDirectory()) { + if (entry.name === "node_modules" || entry.name === "dist" || entry.name === "coverage") { + continue; + } + stack.push(fullPath); + continue; + } + if (entry.isFile() && isExtensionTestFile(fullPath)) { + files.push(fullPath); + } + } + } + return files; +} + +function main() { + const extensionsDir = path.join(process.cwd(), "extensions"); + const files = collectExtensionTestFiles(extensionsDir); + const offenders: Array<{ file: string; hint: string }> = []; + + for (const file of files) { + const content = fs.readFileSync(file, "utf8"); + for (const rule of FORBIDDEN_PATTERNS) { + if (!rule.pattern.test(content)) { + continue; + } + offenders.push({ file, hint: rule.hint }); + break; + } + } + + if (offenders.length > 0) { + console.error( + "Extension test files must stay on extension test bridges or public plugin-sdk seams.", + ); + for (const offender of offenders.toSorted((a, b) => a.file.localeCompare(b.file))) { + const relative = path.relative(process.cwd(), offender.file) || offender.file; + console.error(`- ${relative}: ${offender.hint}`); + } + process.exit(1); + } + + console.log( + `OK: extension test files avoid direct core test/internal imports (${files.length} checked).`, + ); +} + +main(); diff --git a/src/plugin-sdk/core.ts b/src/plugin-sdk/core.ts index a6c842e79d5..1cfea088601 100644 --- a/src/plugin-sdk/core.ts +++ b/src/plugin-sdk/core.ts @@ -1,3 +1,13 @@ +import type { ChannelPlugin } from "../channels/plugins/types.plugin.js"; +import { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +import type { PluginRuntime } from "../plugins/runtime/types.js"; +import type { + OpenClawPluginApi, + OpenClawPluginCommandDefinition, + OpenClawPluginConfigSchema, + PluginInteractiveTelegramHandlerContext, +} from "../plugins/types.js"; + export type { AnyAgentTool, MediaUnderstandingProviderPlugin, @@ -31,6 +41,8 @@ export type { ProviderAuthMethodNonInteractiveContext, ProviderAuthMethod, ProviderAuthResult, + OpenClawPluginCommandDefinition, + PluginInteractiveTelegramHandlerContext, } from "../plugins/types.js"; export type { OpenClawConfig } from "../config/config.js"; export type { GatewayRequestHandlerOptions } from "../gateway/server-methods/types.js"; @@ -70,3 +82,44 @@ export { export { buildOutboundBaseSessionKey } from "../infra/outbound/base-session-key.js"; export { normalizeOutboundThreadId } from "../infra/outbound/thread-id.js"; export { resolveThreadSessionKeys } from "../routing/session-key.js"; + +type DefineChannelPluginEntryOptions = { + id: string; + name: string; + description: string; + plugin: TPlugin; + configSchema?: () => OpenClawPluginConfigSchema; + setRuntime?: (runtime: PluginRuntime) => void; + registerFull?: (api: OpenClawPluginApi) => void; +}; + +// Shared channel-plugin entry boilerplate for bundled and third-party channels. +export function defineChannelPluginEntry({ + id, + name, + description, + plugin, + configSchema = emptyPluginConfigSchema, + setRuntime, + registerFull, +}: DefineChannelPluginEntryOptions) { + return { + id, + name, + description, + configSchema: configSchema(), + register(api: OpenClawPluginApi) { + setRuntime?.(api.runtime); + api.registerChannel({ plugin }); + if (api.registrationMode !== "full") { + return; + } + registerFull?.(api); + }, + }; +} + +// Shared setup-entry shape so bundled channels do not duplicate `{ plugin }`. +export function defineSetupPluginEntry(plugin: TPlugin) { + return { plugin }; +} diff --git a/src/plugin-sdk/subpaths.test.ts b/src/plugin-sdk/subpaths.test.ts index 0166fb52081..156f7d9b81f 100644 --- a/src/plugin-sdk/subpaths.test.ts +++ b/src/plugin-sdk/subpaths.test.ts @@ -49,6 +49,8 @@ describe("plugin-sdk subpath exports", () => { it("keeps core focused on generic shared exports", () => { expect(typeof coreSdk.emptyPluginConfigSchema).toBe("function"); + expect(typeof coreSdk.defineChannelPluginEntry).toBe("function"); + expect(typeof coreSdk.defineSetupPluginEntry).toBe("function"); expect("runPassiveAccountLifecycle" in asExports(coreSdk)).toBe(false); expect("createLoggerBackedRuntime" in asExports(coreSdk)).toBe(false); expect("registerSandboxBackend" in asExports(coreSdk)).toBe(false); From c1e56978897e35b46b68d3be69e4fefd09f4b4bb Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:52:41 -0700 Subject: [PATCH 103/187] style: fix rebase formatting drift --- extensions/discord/src/channel.ts | 7 ++----- extensions/slack/src/channel.ts | 5 +---- extensions/telegram/src/channel.ts | 5 +---- 3 files changed, 4 insertions(+), 13 deletions(-) diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index 46679586665..e2d202cb6ee 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -10,11 +10,7 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; -import { - buildOutboundBaseSessionKey, - normalizeOutboundThreadId, -} from "openclaw/plugin-sdk/core"; -import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; +import { buildOutboundBaseSessionKey, normalizeOutboundThreadId } from "openclaw/plugin-sdk/core"; import { buildComputedAccountStatusSnapshot, buildTokenChannelStatusSummary, @@ -31,6 +27,7 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/discord"; +import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { listDiscordAccountIds, resolveDiscordAccount, diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 99d0fe3cbdf..d2dffaf8a2b 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -8,10 +8,7 @@ import { collectOpenProviderGroupPolicyWarnings, } from "openclaw/plugin-sdk/channel-config-helpers"; import { resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; -import { - buildOutboundBaseSessionKey, - normalizeOutboundThreadId, -} from "openclaw/plugin-sdk/core"; +import { buildOutboundBaseSessionKey, normalizeOutboundThreadId } from "openclaw/plugin-sdk/core"; import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { buildComputedAccountStatusSnapshot, diff --git a/extensions/telegram/src/channel.ts b/extensions/telegram/src/channel.ts index 88056309ede..c05c926d52f 100644 --- a/extensions/telegram/src/channel.ts +++ b/extensions/telegram/src/channel.ts @@ -6,12 +6,9 @@ import { } from "openclaw/plugin-sdk/channel-config-helpers"; import { type OutboundSendDeps, resolveOutboundSendDep } from "openclaw/plugin-sdk/channel-runtime"; import { normalizeMessageChannel } from "openclaw/plugin-sdk/channel-runtime"; +import { buildOutboundBaseSessionKey, normalizeOutboundThreadId } from "openclaw/plugin-sdk/core"; import { resolveExecApprovalCommandDisplay } from "openclaw/plugin-sdk/infra-runtime"; import { buildExecApprovalPendingReplyPayload } from "openclaw/plugin-sdk/infra-runtime"; -import { - buildOutboundBaseSessionKey, - normalizeOutboundThreadId, -} from "openclaw/plugin-sdk/core"; import { resolveThreadSessionKeys, type RoutePeer } from "openclaw/plugin-sdk/routing"; import { parseTelegramTopicConversation } from "openclaw/plugin-sdk/telegram"; import { From 42c8c3c983c61d5807bec836de6306c916aae9c4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:54:37 -0700 Subject: [PATCH 104/187] fix: resolve rebase type fallout in channel setup seams --- extensions/discord/src/channel.ts | 2 +- extensions/discord/src/setup-surface.ts | 42 +++++++++------------- extensions/slack/src/channel.ts | 8 ++++- extensions/slack/src/setup-surface.ts | 40 +++++++++------------ src/channels/plugins/setup-helpers.test.ts | 3 ++ src/channels/plugins/slack.actions.ts | 3 +- 6 files changed, 46 insertions(+), 52 deletions(-) diff --git a/extensions/discord/src/channel.ts b/extensions/discord/src/channel.ts index e2d202cb6ee..dff011825b0 100644 --- a/extensions/discord/src/channel.ts +++ b/extensions/discord/src/channel.ts @@ -48,7 +48,7 @@ import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { getDiscordRuntime } from "./runtime.js"; import { fetchChannelPermissionsDiscord } from "./send.js"; import { discordSetupAdapter } from "./setup-core.js"; -import { createDiscordPluginBase } from "./shared.js"; +import { createDiscordPluginBase, discordConfigAccessors } from "./shared.js"; import { collectDiscordStatusIssues } from "./status-issues.js"; import { parseDiscordTarget } from "./targets.js"; import { DiscordUiContainer } from "./ui.js"; diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 9c1ce7f5f1c..5432302ff4b 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -100,28 +100,20 @@ async function resolveDiscordGroupAllowlist(params: { }); } -export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase(async () => ({ - discordSetupWizard: { - dmPolicy: { - promptAllowFrom: promptDiscordAllowFrom, - }, - groupAccess: { - resolveAllowlist: async ({ cfg, accountId, credentialValues, entries }) => - await resolveDiscordGroupAllowlist({ - cfg, - accountId, - credentialValues, - entries, - }), - }, - allowFrom: { - resolveEntries: async ({ cfg, accountId, credentialValues, entries }) => - await resolveDiscordAllowFromEntries({ - token: - resolveDiscordAccount({ cfg, accountId }).token || - (typeof credentialValues.token === "string" ? credentialValues.token : ""), - entries, - }), - }, - } as ChannelSetupWizard, -})); +export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase({ + promptAllowFrom: promptDiscordAllowFrom, + resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordGroupAllowlist({ + cfg, + accountId, + credentialValues, + entries, + }), + resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordAllowFromEntries({ + token: + resolveDiscordAccount({ cfg, accountId }).token || + (typeof credentialValues.token === "string" ? credentialValues.token : ""), + entries, + }), +}); diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index d2dffaf8a2b..2149f22ec60 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -486,7 +486,13 @@ export const slackPlugin: ChannelPlugin = { }, actions: createSlackActions(SLACK_CHANNEL, { invoke: async (action, cfg, toolContext) => - await getSlackRuntime().channel.slack.handleSlackAction(action, cfg, toolContext), + await getSlackRuntime().channel.slack.handleSlackAction( + action, + cfg as OpenClawConfig, + toolContext as Parameters< + ReturnType["channel"]["slack"]["handleSlackAction"] + >[2], + ), }), setup: slackSetupAdapter, outbound: { diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index 063129267cf..f7a52a72888 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -130,27 +130,19 @@ async function resolveSlackGroupAllowlist(params: { return keys; } -export const slackSetupWizard: ChannelSetupWizard = createSlackSetupWizardBase(async () => ({ - slackSetupWizard: { - dmPolicy: { - promptAllowFrom: promptSlackAllowFrom, - }, - allowFrom: { - resolveEntries: async ({ credentialValues, entries }) => - await resolveSlackAllowFromEntries({ - token: credentialValues.botToken, - entries, - }), - }, - groupAccess: { - resolveAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => - await resolveSlackGroupAllowlist({ - cfg, - accountId, - credentialValues, - entries, - prompter, - }), - }, - } as ChannelSetupWizard, -})); +export const slackSetupWizard: ChannelSetupWizard = createSlackSetupWizardBase({ + promptAllowFrom: promptSlackAllowFrom, + resolveAllowFromEntries: async ({ credentialValues, entries }) => + await resolveSlackAllowFromEntries({ + token: credentialValues.botToken, + entries, + }), + resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries, prompter }) => + await resolveSlackGroupAllowlist({ + cfg, + accountId, + credentialValues, + entries, + prompter, + }), +}); diff --git a/src/channels/plugins/setup-helpers.test.ts b/src/channels/plugins/setup-helpers.test.ts index f81de4fe4ed..4111986e175 100644 --- a/src/channels/plugins/setup-helpers.test.ts +++ b/src/channels/plugins/setup-helpers.test.ts @@ -175,6 +175,7 @@ describe("createEnvPatchedAccountSetupAdapter", () => { expect( adapter.validateInput?.({ + cfg: asConfig({}), accountId: "work", input: { useEnv: true }, }), @@ -182,6 +183,7 @@ describe("createEnvPatchedAccountSetupAdapter", () => { expect( adapter.validateInput?.({ + cfg: asConfig({}), accountId: DEFAULT_ACCOUNT_ID, input: {}, }), @@ -189,6 +191,7 @@ describe("createEnvPatchedAccountSetupAdapter", () => { expect( adapter.validateInput?.({ + cfg: asConfig({}), accountId: DEFAULT_ACCOUNT_ID, input: { token: "tok" }, }), diff --git a/src/channels/plugins/slack.actions.ts b/src/channels/plugins/slack.actions.ts index e65a85d98f6..483b4db7df9 100644 --- a/src/channels/plugins/slack.actions.ts +++ b/src/channels/plugins/slack.actions.ts @@ -1,3 +1,4 @@ +import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import { handleSlackAction, type SlackActionContext } from "../../agents/tools/slack-actions.js"; import { extractSlackToolSend, @@ -12,7 +13,7 @@ type SlackActionInvoke = ( action: Record, cfg: unknown, toolContext: unknown, -) => Promise; +) => Promise>; export function createSlackActions( providerId: string, From 0d776c87c389bd1157a57afabd116bf6424ddd2e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 16 Mar 2026 23:56:32 -0700 Subject: [PATCH 105/187] fix(macos): block canvas symlink escapes --- .../OpenClaw/CanvasSchemeHandler.swift | 22 ++++++++++------ .../LowCoverageHelperTests.swift | 26 +++++++++++++++++++ 2 files changed, 40 insertions(+), 8 deletions(-) diff --git a/apps/macos/Sources/OpenClaw/CanvasSchemeHandler.swift b/apps/macos/Sources/OpenClaw/CanvasSchemeHandler.swift index 6905af50014..9b4c8e5ebad 100644 --- a/apps/macos/Sources/OpenClaw/CanvasSchemeHandler.swift +++ b/apps/macos/Sources/OpenClaw/CanvasSchemeHandler.swift @@ -81,22 +81,23 @@ final class CanvasSchemeHandler: NSObject, WKURLSchemeHandler { return self.html("Not Found", title: "Canvas: 404") } - // Directory traversal guard: served files must live under the session root. - let standardizedRoot = sessionRoot.standardizedFileURL - let standardizedFile = fileURL.standardizedFileURL - guard standardizedFile.path.hasPrefix(standardizedRoot.path) else { + // Resolve symlinks before enforcing the session-root boundary so links inside + // the canvas tree cannot escape to arbitrary host files. + let resolvedRoot = sessionRoot.resolvingSymlinksInPath().standardizedFileURL + let resolvedFile = fileURL.resolvingSymlinksInPath().standardizedFileURL + guard self.isFileURL(resolvedFile, withinDirectory: resolvedRoot) else { return self.html("Forbidden", title: "Canvas: 403") } do { - let data = try Data(contentsOf: standardizedFile) - let mime = CanvasScheme.mimeType(forExtension: standardizedFile.pathExtension) - let servedPath = standardizedFile.path + let data = try Data(contentsOf: resolvedFile) + let mime = CanvasScheme.mimeType(forExtension: resolvedFile.pathExtension) + let servedPath = resolvedFile.path canvasLogger.debug( "served \(session, privacy: .public)/\(path, privacy: .public) -> \(servedPath, privacy: .public)") return CanvasResponse(mime: mime, data: data) } catch { - let failedPath = standardizedFile.path + let failedPath = resolvedFile.path let errorText = error.localizedDescription canvasLogger .error( @@ -145,6 +146,11 @@ final class CanvasSchemeHandler: NSObject, WKURLSchemeHandler { return nil } + private func isFileURL(_ fileURL: URL, withinDirectory rootURL: URL) -> Bool { + let rootPath = rootURL.path.hasSuffix("/") ? rootURL.path : rootURL.path + "/" + return fileURL.path == rootURL.path || fileURL.path.hasPrefix(rootPath) + } + private func html(_ body: String, title: String = "Canvas") -> CanvasResponse { let html = """ diff --git a/apps/macos/Tests/OpenClawIPCTests/LowCoverageHelperTests.swift b/apps/macos/Tests/OpenClawIPCTests/LowCoverageHelperTests.swift index a37135ff490..b47dd70c3ff 100644 --- a/apps/macos/Tests/OpenClawIPCTests/LowCoverageHelperTests.swift +++ b/apps/macos/Tests/OpenClawIPCTests/LowCoverageHelperTests.swift @@ -216,6 +216,32 @@ struct LowCoverageHelperTests { #expect(handler._testTextEncodingName(for: "application/octet-stream") == nil) } + @Test @MainActor func `canvas scheme handler blocks symlink escapes`() throws { + let root = FileManager().temporaryDirectory + .appendingPathComponent("canvas-\(UUID().uuidString)", isDirectory: true) + defer { try? FileManager().removeItem(at: root) } + try FileManager().createDirectory(at: root, withIntermediateDirectories: true) + + let session = root.appendingPathComponent("main", isDirectory: true) + try FileManager().createDirectory(at: session, withIntermediateDirectories: true) + + let outside = root.deletingLastPathComponent().appendingPathComponent("canvas-secret-\(UUID().uuidString).txt") + defer { try? FileManager().removeItem(at: outside) } + try "top-secret".write(to: outside, atomically: true, encoding: .utf8) + + let symlink = session.appendingPathComponent("index.html") + try FileManager().createSymbolicLink(at: symlink, withDestinationURL: outside) + + let handler = CanvasSchemeHandler(root: root) + let url = try #require(CanvasScheme.makeURL(session: "main", path: "index.html")) + let response = handler._testResponse(for: url) + let body = String(data: response.data, encoding: .utf8) ?? "" + + #expect(response.mime == "text/html") + #expect(body.contains("Forbidden")) + #expect(!body.contains("top-secret")) + } + @Test @MainActor func `menu context card injector inserts and finds index`() { let injector = MenuContextCardInjector() let menu = NSMenu() From 3dec814fda938c44cafbcd73ba8525d54cf5c469 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:00:05 -0700 Subject: [PATCH 106/187] refactor: bundle lazy runtime surfaces --- extensions/bluebubbles/src/actions.runtime.ts | 112 ++++++++++-- extensions/bluebubbles/src/channel.runtime.ts | 63 ++++++- extensions/discord/src/channel.runtime.ts | 6 +- extensions/discord/src/setup-surface.ts | 15 +- .../discord/src/voice/manager.runtime.ts | 9 +- extensions/feishu/src/channel.runtime.ts | 136 +++++++++++++- extensions/googlechat/src/channel.runtime.ts | 45 ++++- extensions/matrix/src/channel.runtime.ts | 61 ++++++- extensions/msteams/src/channel.runtime.ts | 53 +++++- extensions/signal/src/channel.runtime.ts | 6 +- extensions/slack/src/channel.runtime.ts | 6 +- extensions/slack/src/channel.ts | 5 +- extensions/whatsapp/src/channel.runtime.ts | 77 ++++++-- extensions/zalo/src/actions.runtime.ts | 8 +- src/cli/deps.test.ts | 12 +- src/cli/deps.ts | 36 ++-- src/cli/send-runtime/discord.ts | 12 +- src/cli/send-runtime/imessage.ts | 12 +- src/cli/send-runtime/signal.ts | 12 +- src/cli/send-runtime/slack.ts | 12 +- src/cli/send-runtime/telegram.ts | 12 +- src/cli/send-runtime/whatsapp.ts | 12 +- src/commands/status.scan.deps.runtime.ts | 36 +++- src/config/schema.shared.test.ts | 2 +- .../contracts/auth-choice.contract.test.ts | 42 +++-- .../contracts/runtime.contract.test.ts | 2 +- .../runtime/runtime-discord-ops.runtime.ts | 170 +++++------------- src/plugins/runtime/runtime-discord.ts | 77 ++++---- .../runtime/runtime-slack-ops.runtime.ts | 80 +++------ src/plugins/runtime/runtime-slack.ts | 40 +++-- .../runtime/runtime-telegram-ops.runtime.ts | 151 ++++------------ src/plugins/runtime/runtime-telegram.ts | 57 +++--- .../runtime/runtime-whatsapp-login.runtime.ts | 9 +- .../runtime-whatsapp-outbound.runtime.ts | 23 +-- src/plugins/runtime/runtime-whatsapp.ts | 30 ++-- 35 files changed, 887 insertions(+), 554 deletions(-) diff --git a/extensions/bluebubbles/src/actions.runtime.ts b/extensions/bluebubbles/src/actions.runtime.ts index 53285c19f17..00d0bc00efd 100644 --- a/extensions/bluebubbles/src/actions.runtime.ts +++ b/extensions/bluebubbles/src/actions.runtime.ts @@ -1,13 +1,101 @@ -export { sendBlueBubblesAttachment } from "./attachments.js"; -export { - addBlueBubblesParticipant, - editBlueBubblesMessage, - leaveBlueBubblesChat, - removeBlueBubblesParticipant, - renameBlueBubblesChat, - setGroupIconBlueBubbles, - unsendBlueBubblesMessage, +import { sendBlueBubblesAttachment as sendBlueBubblesAttachmentImpl } from "./attachments.js"; +import { + addBlueBubblesParticipant as addBlueBubblesParticipantImpl, + editBlueBubblesMessage as editBlueBubblesMessageImpl, + leaveBlueBubblesChat as leaveBlueBubblesChatImpl, + removeBlueBubblesParticipant as removeBlueBubblesParticipantImpl, + renameBlueBubblesChat as renameBlueBubblesChatImpl, + setGroupIconBlueBubbles as setGroupIconBlueBubblesImpl, + unsendBlueBubblesMessage as unsendBlueBubblesMessageImpl, } from "./chat.js"; -export { resolveBlueBubblesMessageId } from "./monitor.js"; -export { sendBlueBubblesReaction } from "./reactions.js"; -export { resolveChatGuidForTarget, sendMessageBlueBubbles } from "./send.js"; +import { resolveBlueBubblesMessageId as resolveBlueBubblesMessageIdImpl } from "./monitor.js"; +import { sendBlueBubblesReaction as sendBlueBubblesReactionImpl } from "./reactions.js"; +import { + resolveChatGuidForTarget as resolveChatGuidForTargetImpl, + sendMessageBlueBubbles as sendMessageBlueBubblesImpl, +} from "./send.js"; + +type SendBlueBubblesAttachment = typeof import("./attachments.js").sendBlueBubblesAttachment; +type AddBlueBubblesParticipant = typeof import("./chat.js").addBlueBubblesParticipant; +type EditBlueBubblesMessage = typeof import("./chat.js").editBlueBubblesMessage; +type LeaveBlueBubblesChat = typeof import("./chat.js").leaveBlueBubblesChat; +type RemoveBlueBubblesParticipant = typeof import("./chat.js").removeBlueBubblesParticipant; +type RenameBlueBubblesChat = typeof import("./chat.js").renameBlueBubblesChat; +type SetGroupIconBlueBubbles = typeof import("./chat.js").setGroupIconBlueBubbles; +type UnsendBlueBubblesMessage = typeof import("./chat.js").unsendBlueBubblesMessage; +type ResolveBlueBubblesMessageId = typeof import("./monitor.js").resolveBlueBubblesMessageId; +type SendBlueBubblesReaction = typeof import("./reactions.js").sendBlueBubblesReaction; +type ResolveChatGuidForTarget = typeof import("./send.js").resolveChatGuidForTarget; +type SendMessageBlueBubbles = typeof import("./send.js").sendMessageBlueBubbles; + +export function sendBlueBubblesAttachment( + ...args: Parameters +): ReturnType { + return sendBlueBubblesAttachmentImpl(...args); +} + +export function addBlueBubblesParticipant( + ...args: Parameters +): ReturnType { + return addBlueBubblesParticipantImpl(...args); +} + +export function editBlueBubblesMessage( + ...args: Parameters +): ReturnType { + return editBlueBubblesMessageImpl(...args); +} + +export function leaveBlueBubblesChat( + ...args: Parameters +): ReturnType { + return leaveBlueBubblesChatImpl(...args); +} + +export function removeBlueBubblesParticipant( + ...args: Parameters +): ReturnType { + return removeBlueBubblesParticipantImpl(...args); +} + +export function renameBlueBubblesChat( + ...args: Parameters +): ReturnType { + return renameBlueBubblesChatImpl(...args); +} + +export function setGroupIconBlueBubbles( + ...args: Parameters +): ReturnType { + return setGroupIconBlueBubblesImpl(...args); +} + +export function unsendBlueBubblesMessage( + ...args: Parameters +): ReturnType { + return unsendBlueBubblesMessageImpl(...args); +} + +export function resolveBlueBubblesMessageId( + ...args: Parameters +): ReturnType { + return resolveBlueBubblesMessageIdImpl(...args); +} + +export function sendBlueBubblesReaction( + ...args: Parameters +): ReturnType { + return sendBlueBubblesReactionImpl(...args); +} + +export function resolveChatGuidForTarget( + ...args: Parameters +): ReturnType { + return resolveChatGuidForTargetImpl(...args); +} + +export function sendMessageBlueBubbles( + ...args: Parameters +): ReturnType { + return sendMessageBlueBubblesImpl(...args); +} diff --git a/extensions/bluebubbles/src/channel.runtime.ts b/extensions/bluebubbles/src/channel.runtime.ts index 32bf567dcf5..d318943d3f2 100644 --- a/extensions/bluebubbles/src/channel.runtime.ts +++ b/extensions/bluebubbles/src/channel.runtime.ts @@ -1,6 +1,57 @@ -export { sendBlueBubblesMedia } from "./media-send.js"; -export { resolveBlueBubblesMessageId } from "./monitor.js"; -export { monitorBlueBubblesProvider, resolveWebhookPathFromConfig } from "./monitor.js"; -export { type BlueBubblesProbe, probeBlueBubbles } from "./probe.js"; -export { sendMessageBlueBubbles } from "./send.js"; -export { blueBubblesSetupWizard } from "./setup-surface.js"; +import { sendBlueBubblesMedia as sendBlueBubblesMediaImpl } from "./media-send.js"; +import { + monitorBlueBubblesProvider as monitorBlueBubblesProviderImpl, + resolveBlueBubblesMessageId as resolveBlueBubblesMessageIdImpl, + resolveWebhookPathFromConfig as resolveWebhookPathFromConfigImpl, +} from "./monitor.js"; +import { probeBlueBubbles as probeBlueBubblesImpl } from "./probe.js"; +import { sendMessageBlueBubbles as sendMessageBlueBubblesImpl } from "./send.js"; +import { blueBubblesSetupWizard as blueBubblesSetupWizardImpl } from "./setup-surface.js"; + +export type { BlueBubblesProbe } from "./probe.js"; + +type SendBlueBubblesMedia = typeof import("./media-send.js").sendBlueBubblesMedia; +type ResolveBlueBubblesMessageId = typeof import("./monitor.js").resolveBlueBubblesMessageId; +type MonitorBlueBubblesProvider = typeof import("./monitor.js").monitorBlueBubblesProvider; +type ResolveWebhookPathFromConfig = typeof import("./monitor.js").resolveWebhookPathFromConfig; +type ProbeBlueBubbles = typeof import("./probe.js").probeBlueBubbles; +type SendMessageBlueBubbles = typeof import("./send.js").sendMessageBlueBubbles; +type BlueBubblesSetupWizard = typeof import("./setup-surface.js").blueBubblesSetupWizard; + +export function sendBlueBubblesMedia( + ...args: Parameters +): ReturnType { + return sendBlueBubblesMediaImpl(...args); +} + +export function resolveBlueBubblesMessageId( + ...args: Parameters +): ReturnType { + return resolveBlueBubblesMessageIdImpl(...args); +} + +export function monitorBlueBubblesProvider( + ...args: Parameters +): ReturnType { + return monitorBlueBubblesProviderImpl(...args); +} + +export function resolveWebhookPathFromConfig( + ...args: Parameters +): ReturnType { + return resolveWebhookPathFromConfigImpl(...args); +} + +export function probeBlueBubbles( + ...args: Parameters +): ReturnType { + return probeBlueBubblesImpl(...args); +} + +export function sendMessageBlueBubbles( + ...args: Parameters +): ReturnType { + return sendMessageBlueBubblesImpl(...args); +} + +export const blueBubblesSetupWizard: BlueBubblesSetupWizard = { ...blueBubblesSetupWizardImpl }; diff --git a/extensions/discord/src/channel.runtime.ts b/extensions/discord/src/channel.runtime.ts index bc22b64706a..d4da518fdc1 100644 --- a/extensions/discord/src/channel.runtime.ts +++ b/extensions/discord/src/channel.runtime.ts @@ -1 +1,5 @@ -export { discordSetupWizard } from "./setup-surface.js"; +import { discordSetupWizard as discordSetupWizardImpl } from "./setup-surface.js"; + +type DiscordSetupWizard = typeof import("./setup-surface.js").discordSetupWizard; + +export const discordSetupWizard: DiscordSetupWizard = { ...discordSetupWizardImpl }; diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 5432302ff4b..78e1c1da804 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -100,15 +100,9 @@ async function resolveDiscordGroupAllowlist(params: { }); } +<<<<<<< HEAD export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase({ promptAllowFrom: promptDiscordAllowFrom, - resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries }) => - await resolveDiscordGroupAllowlist({ - cfg, - accountId, - credentialValues, - entries, - }), resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => await resolveDiscordAllowFromEntries({ token: @@ -116,4 +110,11 @@ export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBa (typeof credentialValues.token === "string" ? credentialValues.token : ""), entries, }), + resolveGroupAllowlist: async ({ cfg, accountId, credentialValues, entries }) => + await resolveDiscordGroupAllowlist({ + cfg, + accountId, + credentialValues, + entries, + }), }); diff --git a/extensions/discord/src/voice/manager.runtime.ts b/extensions/discord/src/voice/manager.runtime.ts index 77574b166e5..1619d63a27c 100644 --- a/extensions/discord/src/voice/manager.runtime.ts +++ b/extensions/discord/src/voice/manager.runtime.ts @@ -1 +1,8 @@ -export { DiscordVoiceManager, DiscordVoiceReadyListener } from "./manager.js"; +import { + DiscordVoiceManager as DiscordVoiceManagerImpl, + DiscordVoiceReadyListener as DiscordVoiceReadyListenerImpl, +} from "./manager.js"; + +export class DiscordVoiceManager extends DiscordVoiceManagerImpl {} + +export class DiscordVoiceReadyListener extends DiscordVoiceReadyListenerImpl {} diff --git a/extensions/feishu/src/channel.runtime.ts b/extensions/feishu/src/channel.runtime.ts index 0e4d9fc7583..c8a742942ea 100644 --- a/extensions/feishu/src/channel.runtime.ts +++ b/extensions/feishu/src/channel.runtime.ts @@ -1,7 +1,129 @@ -export { listFeishuDirectoryGroupsLive, listFeishuDirectoryPeersLive } from "./directory.js"; -export { feishuOutbound } from "./outbound.js"; -export { createPinFeishu, listPinsFeishu, removePinFeishu } from "./pins.js"; -export { probeFeishu } from "./probe.js"; -export { addReactionFeishu, listReactionsFeishu, removeReactionFeishu } from "./reactions.js"; -export { getChatInfo, getChatMembers, getFeishuMemberInfo } from "./chat.js"; -export { editMessageFeishu, getMessageFeishu, sendCardFeishu, sendMessageFeishu } from "./send.js"; +import { + getChatInfo as getChatInfoImpl, + getChatMembers as getChatMembersImpl, + getFeishuMemberInfo as getFeishuMemberInfoImpl, +} from "./chat.js"; +import { + listFeishuDirectoryGroupsLive as listFeishuDirectoryGroupsLiveImpl, + listFeishuDirectoryPeersLive as listFeishuDirectoryPeersLiveImpl, +} from "./directory.js"; +import { feishuOutbound as feishuOutboundImpl } from "./outbound.js"; +import { + createPinFeishu as createPinFeishuImpl, + listPinsFeishu as listPinsFeishuImpl, + removePinFeishu as removePinFeishuImpl, +} from "./pins.js"; +import { probeFeishu as probeFeishuImpl } from "./probe.js"; +import { + addReactionFeishu as addReactionFeishuImpl, + listReactionsFeishu as listReactionsFeishuImpl, + removeReactionFeishu as removeReactionFeishuImpl, +} from "./reactions.js"; +import { + editMessageFeishu as editMessageFeishuImpl, + getMessageFeishu as getMessageFeishuImpl, + sendCardFeishu as sendCardFeishuImpl, + sendMessageFeishu as sendMessageFeishuImpl, +} from "./send.js"; + +type ListFeishuDirectoryGroupsLive = typeof import("./directory.js").listFeishuDirectoryGroupsLive; +type ListFeishuDirectoryPeersLive = typeof import("./directory.js").listFeishuDirectoryPeersLive; +type FeishuOutbound = typeof import("./outbound.js").feishuOutbound; +type CreatePinFeishu = typeof import("./pins.js").createPinFeishu; +type ListPinsFeishu = typeof import("./pins.js").listPinsFeishu; +type RemovePinFeishu = typeof import("./pins.js").removePinFeishu; +type ProbeFeishu = typeof import("./probe.js").probeFeishu; +type AddReactionFeishu = typeof import("./reactions.js").addReactionFeishu; +type ListReactionsFeishu = typeof import("./reactions.js").listReactionsFeishu; +type RemoveReactionFeishu = typeof import("./reactions.js").removeReactionFeishu; +type GetChatInfo = typeof import("./chat.js").getChatInfo; +type GetChatMembers = typeof import("./chat.js").getChatMembers; +type GetFeishuMemberInfo = typeof import("./chat.js").getFeishuMemberInfo; +type EditMessageFeishu = typeof import("./send.js").editMessageFeishu; +type GetMessageFeishu = typeof import("./send.js").getMessageFeishu; +type SendCardFeishu = typeof import("./send.js").sendCardFeishu; +type SendMessageFeishu = typeof import("./send.js").sendMessageFeishu; + +export function listFeishuDirectoryGroupsLive( + ...args: Parameters +): ReturnType { + return listFeishuDirectoryGroupsLiveImpl(...args); +} + +export function listFeishuDirectoryPeersLive( + ...args: Parameters +): ReturnType { + return listFeishuDirectoryPeersLiveImpl(...args); +} + +export const feishuOutbound: FeishuOutbound = { ...feishuOutboundImpl }; + +export function createPinFeishu(...args: Parameters): ReturnType { + return createPinFeishuImpl(...args); +} + +export function listPinsFeishu(...args: Parameters): ReturnType { + return listPinsFeishuImpl(...args); +} + +export function removePinFeishu(...args: Parameters): ReturnType { + return removePinFeishuImpl(...args); +} + +export function probeFeishu(...args: Parameters): ReturnType { + return probeFeishuImpl(...args); +} + +export function addReactionFeishu( + ...args: Parameters +): ReturnType { + return addReactionFeishuImpl(...args); +} + +export function listReactionsFeishu( + ...args: Parameters +): ReturnType { + return listReactionsFeishuImpl(...args); +} + +export function removeReactionFeishu( + ...args: Parameters +): ReturnType { + return removeReactionFeishuImpl(...args); +} + +export function getChatInfo(...args: Parameters): ReturnType { + return getChatInfoImpl(...args); +} + +export function getChatMembers(...args: Parameters): ReturnType { + return getChatMembersImpl(...args); +} + +export function getFeishuMemberInfo( + ...args: Parameters +): ReturnType { + return getFeishuMemberInfoImpl(...args); +} + +export function editMessageFeishu( + ...args: Parameters +): ReturnType { + return editMessageFeishuImpl(...args); +} + +export function getMessageFeishu( + ...args: Parameters +): ReturnType { + return getMessageFeishuImpl(...args); +} + +export function sendCardFeishu(...args: Parameters): ReturnType { + return sendCardFeishuImpl(...args); +} + +export function sendMessageFeishu( + ...args: Parameters +): ReturnType { + return sendMessageFeishuImpl(...args); +} diff --git a/extensions/googlechat/src/channel.runtime.ts b/extensions/googlechat/src/channel.runtime.ts index fdf060f9fd4..1e41376c8f5 100644 --- a/extensions/googlechat/src/channel.runtime.ts +++ b/extensions/googlechat/src/channel.runtime.ts @@ -1,2 +1,43 @@ -export { probeGoogleChat, sendGoogleChatMessage, uploadGoogleChatAttachment } from "./api.js"; -export { resolveGoogleChatWebhookPath, startGoogleChatMonitor } from "./monitor.js"; +import { + probeGoogleChat as probeGoogleChatImpl, + sendGoogleChatMessage as sendGoogleChatMessageImpl, + uploadGoogleChatAttachment as uploadGoogleChatAttachmentImpl, +} from "./api.js"; +import { + resolveGoogleChatWebhookPath as resolveGoogleChatWebhookPathImpl, + startGoogleChatMonitor as startGoogleChatMonitorImpl, +} from "./monitor.js"; + +type ProbeGoogleChat = typeof import("./api.js").probeGoogleChat; +type SendGoogleChatMessage = typeof import("./api.js").sendGoogleChatMessage; +type UploadGoogleChatAttachment = typeof import("./api.js").uploadGoogleChatAttachment; +type ResolveGoogleChatWebhookPath = typeof import("./monitor.js").resolveGoogleChatWebhookPath; +type StartGoogleChatMonitor = typeof import("./monitor.js").startGoogleChatMonitor; + +export function probeGoogleChat(...args: Parameters): ReturnType { + return probeGoogleChatImpl(...args); +} + +export function sendGoogleChatMessage( + ...args: Parameters +): ReturnType { + return sendGoogleChatMessageImpl(...args); +} + +export function uploadGoogleChatAttachment( + ...args: Parameters +): ReturnType { + return uploadGoogleChatAttachmentImpl(...args); +} + +export function resolveGoogleChatWebhookPath( + ...args: Parameters +): ReturnType { + return resolveGoogleChatWebhookPathImpl(...args); +} + +export function startGoogleChatMonitor( + ...args: Parameters +): ReturnType { + return startGoogleChatMonitorImpl(...args); +} diff --git a/extensions/matrix/src/channel.runtime.ts b/extensions/matrix/src/channel.runtime.ts index bcce71da2d1..df56d07ff2c 100644 --- a/extensions/matrix/src/channel.runtime.ts +++ b/extensions/matrix/src/channel.runtime.ts @@ -1,6 +1,55 @@ -export { listMatrixDirectoryGroupsLive, listMatrixDirectoryPeersLive } from "./directory-live.js"; -export { resolveMatrixAuth } from "./matrix/client.js"; -export { probeMatrix } from "./matrix/probe.js"; -export { sendMessageMatrix } from "./matrix/send.js"; -export { resolveMatrixTargets } from "./resolve-targets.js"; -export { matrixOutbound } from "./outbound.js"; +import { + listMatrixDirectoryGroupsLive as listMatrixDirectoryGroupsLiveImpl, + listMatrixDirectoryPeersLive as listMatrixDirectoryPeersLiveImpl, +} from "./directory-live.js"; +import { resolveMatrixAuth as resolveMatrixAuthImpl } from "./matrix/client.js"; +import { probeMatrix as probeMatrixImpl } from "./matrix/probe.js"; +import { sendMessageMatrix as sendMessageMatrixImpl } from "./matrix/send.js"; +import { matrixOutbound as matrixOutboundImpl } from "./outbound.js"; +import { resolveMatrixTargets as resolveMatrixTargetsImpl } from "./resolve-targets.js"; + +type ListMatrixDirectoryGroupsLive = + typeof import("./directory-live.js").listMatrixDirectoryGroupsLive; +type ListMatrixDirectoryPeersLive = + typeof import("./directory-live.js").listMatrixDirectoryPeersLive; +type ResolveMatrixAuth = typeof import("./matrix/client.js").resolveMatrixAuth; +type ProbeMatrix = typeof import("./matrix/probe.js").probeMatrix; +type SendMessageMatrix = typeof import("./matrix/send.js").sendMessageMatrix; +type ResolveMatrixTargets = typeof import("./resolve-targets.js").resolveMatrixTargets; +type MatrixOutbound = typeof import("./outbound.js").matrixOutbound; + +export function listMatrixDirectoryGroupsLive( + ...args: Parameters +): ReturnType { + return listMatrixDirectoryGroupsLiveImpl(...args); +} + +export function listMatrixDirectoryPeersLive( + ...args: Parameters +): ReturnType { + return listMatrixDirectoryPeersLiveImpl(...args); +} + +export function resolveMatrixAuth( + ...args: Parameters +): ReturnType { + return resolveMatrixAuthImpl(...args); +} + +export function probeMatrix(...args: Parameters): ReturnType { + return probeMatrixImpl(...args); +} + +export function sendMessageMatrix( + ...args: Parameters +): ReturnType { + return sendMessageMatrixImpl(...args); +} + +export function resolveMatrixTargets( + ...args: Parameters +): ReturnType { + return resolveMatrixTargetsImpl(...args); +} + +export const matrixOutbound: MatrixOutbound = { ...matrixOutboundImpl }; diff --git a/extensions/msteams/src/channel.runtime.ts b/extensions/msteams/src/channel.runtime.ts index 45a0147f46b..c55d0fc626a 100644 --- a/extensions/msteams/src/channel.runtime.ts +++ b/extensions/msteams/src/channel.runtime.ts @@ -1,4 +1,49 @@ -export { listMSTeamsDirectoryGroupsLive, listMSTeamsDirectoryPeersLive } from "./directory-live.js"; -export { msteamsOutbound } from "./outbound.js"; -export { probeMSTeams } from "./probe.js"; -export { sendAdaptiveCardMSTeams, sendMessageMSTeams } from "./send.js"; +import { + listMSTeamsDirectoryGroupsLive as listMSTeamsDirectoryGroupsLiveImpl, + listMSTeamsDirectoryPeersLive as listMSTeamsDirectoryPeersLiveImpl, +} from "./directory-live.js"; +import { msteamsOutbound as msteamsOutboundImpl } from "./outbound.js"; +import { probeMSTeams as probeMSTeamsImpl } from "./probe.js"; +import { + sendAdaptiveCardMSTeams as sendAdaptiveCardMSTeamsImpl, + sendMessageMSTeams as sendMessageMSTeamsImpl, +} from "./send.js"; + +type ListMSTeamsDirectoryGroupsLive = + typeof import("./directory-live.js").listMSTeamsDirectoryGroupsLive; +type ListMSTeamsDirectoryPeersLive = + typeof import("./directory-live.js").listMSTeamsDirectoryPeersLive; +type MSTeamsOutbound = typeof import("./outbound.js").msteamsOutbound; +type ProbeMSTeams = typeof import("./probe.js").probeMSTeams; +type SendAdaptiveCardMSTeams = typeof import("./send.js").sendAdaptiveCardMSTeams; +type SendMessageMSTeams = typeof import("./send.js").sendMessageMSTeams; + +export function listMSTeamsDirectoryGroupsLive( + ...args: Parameters +): ReturnType { + return listMSTeamsDirectoryGroupsLiveImpl(...args); +} + +export function listMSTeamsDirectoryPeersLive( + ...args: Parameters +): ReturnType { + return listMSTeamsDirectoryPeersLiveImpl(...args); +} + +export const msteamsOutbound: MSTeamsOutbound = { ...msteamsOutboundImpl }; + +export function probeMSTeams(...args: Parameters): ReturnType { + return probeMSTeamsImpl(...args); +} + +export function sendAdaptiveCardMSTeams( + ...args: Parameters +): ReturnType { + return sendAdaptiveCardMSTeamsImpl(...args); +} + +export function sendMessageMSTeams( + ...args: Parameters +): ReturnType { + return sendMessageMSTeamsImpl(...args); +} diff --git a/extensions/signal/src/channel.runtime.ts b/extensions/signal/src/channel.runtime.ts index 0403246478f..de908d212b7 100644 --- a/extensions/signal/src/channel.runtime.ts +++ b/extensions/signal/src/channel.runtime.ts @@ -1 +1,5 @@ -export { signalSetupWizard } from "./setup-surface.js"; +import { signalSetupWizard as signalSetupWizardImpl } from "./setup-surface.js"; + +type SignalSetupWizard = typeof import("./setup-surface.js").signalSetupWizard; + +export const signalSetupWizard: SignalSetupWizard = { ...signalSetupWizardImpl }; diff --git a/extensions/slack/src/channel.runtime.ts b/extensions/slack/src/channel.runtime.ts index eefcc2c6215..6dfe5bed8fe 100644 --- a/extensions/slack/src/channel.runtime.ts +++ b/extensions/slack/src/channel.runtime.ts @@ -1 +1,5 @@ -export { slackSetupWizard } from "./setup-surface.js"; +import { slackSetupWizard as slackSetupWizardImpl } from "./setup-surface.js"; + +type SlackSetupWizard = typeof import("./setup-surface.js").slackSetupWizard; + +export const slackSetupWizard: SlackSetupWizard = { ...slackSetupWizardImpl }; diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index 2149f22ec60..bafc5fc8c91 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -25,6 +25,7 @@ import { type ChannelPlugin, type OpenClawConfig, } from "openclaw/plugin-sdk/slack"; +import type { SlackActionContext } from "../../../src/agents/tools/slack-actions.js"; import { createSlackActions } from "../../../src/channels/plugins/slack.actions.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { @@ -489,9 +490,7 @@ export const slackPlugin: ChannelPlugin = { await getSlackRuntime().channel.slack.handleSlackAction( action, cfg as OpenClawConfig, - toolContext as Parameters< - ReturnType["channel"]["slack"]["handleSlackAction"] - >[2], + toolContext as SlackActionContext | undefined, ), }), setup: slackSetupAdapter, diff --git a/extensions/whatsapp/src/channel.runtime.ts b/extensions/whatsapp/src/channel.runtime.ts index dbe5965a25d..de2203db2ad 100644 --- a/extensions/whatsapp/src/channel.runtime.ts +++ b/extensions/whatsapp/src/channel.runtime.ts @@ -1,18 +1,73 @@ -export { getActiveWebListener } from "./active-listener.js"; -export { - getWebAuthAgeMs, - logWebSelfId, - logoutWeb, - readWebSelfId, - webAuthExists, -} from "./auth-store.js"; -export { loginWeb } from "./login.js"; -export { startWebLoginWithQr, waitForWebLogin } from "./login-qr.js"; -export { whatsappSetupWizard } from "./setup-surface.js"; import { monitorWebChannel as monitorWebChannelImpl } from "openclaw/plugin-sdk/whatsapp"; +import { getActiveWebListener as getActiveWebListenerImpl } from "./active-listener.js"; +import { + getWebAuthAgeMs as getWebAuthAgeMsImpl, + logWebSelfId as logWebSelfIdImpl, + logoutWeb as logoutWebImpl, + readWebSelfId as readWebSelfIdImpl, + webAuthExists as webAuthExistsImpl, +} from "./auth-store.js"; +import { + startWebLoginWithQr as startWebLoginWithQrImpl, + waitForWebLogin as waitForWebLoginImpl, +} from "./login-qr.js"; +import { loginWeb as loginWebImpl } from "./login.js"; +import { whatsappSetupWizard as whatsappSetupWizardImpl } from "./setup-surface.js"; +type GetActiveWebListener = typeof import("./active-listener.js").getActiveWebListener; +type GetWebAuthAgeMs = typeof import("./auth-store.js").getWebAuthAgeMs; +type LogWebSelfId = typeof import("./auth-store.js").logWebSelfId; +type LogoutWeb = typeof import("./auth-store.js").logoutWeb; +type ReadWebSelfId = typeof import("./auth-store.js").readWebSelfId; +type WebAuthExists = typeof import("./auth-store.js").webAuthExists; +type LoginWeb = typeof import("./login.js").loginWeb; +type StartWebLoginWithQr = typeof import("./login-qr.js").startWebLoginWithQr; +type WaitForWebLogin = typeof import("./login-qr.js").waitForWebLogin; +type WhatsAppSetupWizard = typeof import("./setup-surface.js").whatsappSetupWizard; type MonitorWebChannel = typeof import("openclaw/plugin-sdk/whatsapp").monitorWebChannel; +export function getActiveWebListener( + ...args: Parameters +): ReturnType { + return getActiveWebListenerImpl(...args); +} + +export function getWebAuthAgeMs(...args: Parameters): ReturnType { + return getWebAuthAgeMsImpl(...args); +} + +export function logWebSelfId(...args: Parameters): ReturnType { + return logWebSelfIdImpl(...args); +} + +export function logoutWeb(...args: Parameters): ReturnType { + return logoutWebImpl(...args); +} + +export function readWebSelfId(...args: Parameters): ReturnType { + return readWebSelfIdImpl(...args); +} + +export function webAuthExists(...args: Parameters): ReturnType { + return webAuthExistsImpl(...args); +} + +export function loginWeb(...args: Parameters): ReturnType { + return loginWebImpl(...args); +} + +export function startWebLoginWithQr( + ...args: Parameters +): ReturnType { + return startWebLoginWithQrImpl(...args); +} + +export function waitForWebLogin(...args: Parameters): ReturnType { + return waitForWebLoginImpl(...args); +} + +export const whatsappSetupWizard: WhatsAppSetupWizard = { ...whatsappSetupWizardImpl }; + export async function monitorWebChannel( ...args: Parameters ): ReturnType { diff --git a/extensions/zalo/src/actions.runtime.ts b/extensions/zalo/src/actions.runtime.ts index a9616ce64a5..d463edc5b24 100644 --- a/extensions/zalo/src/actions.runtime.ts +++ b/extensions/zalo/src/actions.runtime.ts @@ -1 +1,7 @@ -export { sendMessageZalo } from "./send.js"; +import { sendMessageZalo as sendMessageZaloImpl } from "./send.js"; + +type SendMessageZalo = typeof import("./send.js").sendMessageZalo; + +export function sendMessageZalo(...args: Parameters): ReturnType { + return sendMessageZaloImpl(...args); +} diff --git a/src/cli/deps.test.ts b/src/cli/deps.test.ts index 8dbc8539cff..dff1a082296 100644 --- a/src/cli/deps.test.ts +++ b/src/cli/deps.test.ts @@ -21,32 +21,32 @@ const sendFns = vi.hoisted(() => ({ vi.mock("./send-runtime/whatsapp.js", () => { moduleLoads.whatsapp(); - return { sendMessageWhatsApp: sendFns.whatsapp }; + return { runtimeSend: { sendMessage: sendFns.whatsapp } }; }); vi.mock("./send-runtime/telegram.js", () => { moduleLoads.telegram(); - return { sendMessageTelegram: sendFns.telegram }; + return { runtimeSend: { sendMessage: sendFns.telegram } }; }); vi.mock("./send-runtime/discord.js", () => { moduleLoads.discord(); - return { sendMessageDiscord: sendFns.discord }; + return { runtimeSend: { sendMessage: sendFns.discord } }; }); vi.mock("./send-runtime/slack.js", () => { moduleLoads.slack(); - return { sendMessageSlack: sendFns.slack }; + return { runtimeSend: { sendMessage: sendFns.slack } }; }); vi.mock("./send-runtime/signal.js", () => { moduleLoads.signal(); - return { sendMessageSignal: sendFns.signal }; + return { runtimeSend: { sendMessage: sendFns.signal } }; }); vi.mock("./send-runtime/imessage.js", () => { moduleLoads.imessage(); - return { sendMessageIMessage: sendFns.imessage }; + return { runtimeSend: { sendMessage: sendFns.imessage } }; }); describe("createDefaultDeps", () => { diff --git a/src/cli/deps.ts b/src/cli/deps.ts index 908da8cd265..9996c155288 100644 --- a/src/cli/deps.ts +++ b/src/cli/deps.ts @@ -6,9 +6,15 @@ import { createOutboundSendDepsFromCliSource } from "./outbound-send-mapping.js" * Values are proxy functions that dynamically import the real module on first use. */ export type CliDeps = { [channelId: string]: unknown }; +type RuntimeSend = { + sendMessage: (...args: unknown[]) => Promise; +}; +type RuntimeSendModule = { + runtimeSend: RuntimeSend; +}; // Per-channel module caches for lazy loading. -const senderCache = new Map>>(); +const senderCache = new Map>(); /** * Create a lazy-loading send function proxy for a channel. @@ -16,18 +22,16 @@ const senderCache = new Map>>(); */ function createLazySender( channelId: string, - loader: () => Promise>, - exportName: string, + loader: () => Promise, ): (...args: unknown[]) => Promise { return async (...args: unknown[]) => { let cached = senderCache.get(channelId); if (!cached) { - cached = loader(); + cached = loader().then(({ runtimeSend }) => runtimeSend); senderCache.set(channelId, cached); } - const mod = await cached; - const fn = mod[exportName] as (...a: unknown[]) => Promise; - return await fn(...args); + const runtimeSend = await cached; + return await runtimeSend.sendMessage(...args); }; } @@ -35,33 +39,27 @@ export function createDefaultDeps(): CliDeps { return { whatsapp: createLazySender( "whatsapp", - () => import("./send-runtime/whatsapp.js") as Promise>, - "sendMessageWhatsApp", + () => import("./send-runtime/whatsapp.js") as Promise, ), telegram: createLazySender( "telegram", - () => import("./send-runtime/telegram.js") as Promise>, - "sendMessageTelegram", + () => import("./send-runtime/telegram.js") as Promise, ), discord: createLazySender( "discord", - () => import("./send-runtime/discord.js") as Promise>, - "sendMessageDiscord", + () => import("./send-runtime/discord.js") as Promise, ), slack: createLazySender( "slack", - () => import("./send-runtime/slack.js") as Promise>, - "sendMessageSlack", + () => import("./send-runtime/slack.js") as Promise, ), signal: createLazySender( "signal", - () => import("./send-runtime/signal.js") as Promise>, - "sendMessageSignal", + () => import("./send-runtime/signal.js") as Promise, ), imessage: createLazySender( "imessage", - () => import("./send-runtime/imessage.js") as Promise>, - "sendMessageIMessage", + () => import("./send-runtime/imessage.js") as Promise, ), }; } diff --git a/src/cli/send-runtime/discord.ts b/src/cli/send-runtime/discord.ts index 13e8293085b..768653752b6 100644 --- a/src/cli/send-runtime/discord.ts +++ b/src/cli/send-runtime/discord.ts @@ -1,9 +1,9 @@ import { sendMessageDiscord as sendMessageDiscordImpl } from "../../plugin-sdk/discord.js"; -type SendMessageDiscord = typeof import("../../plugin-sdk/discord.js").sendMessageDiscord; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/discord.js").sendMessageDiscord; +}; -export async function sendMessageDiscord( - ...args: Parameters -): ReturnType { - return await sendMessageDiscordImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageDiscordImpl, +} satisfies RuntimeSend; diff --git a/src/cli/send-runtime/imessage.ts b/src/cli/send-runtime/imessage.ts index eb5263a8b53..cdc91c0be74 100644 --- a/src/cli/send-runtime/imessage.ts +++ b/src/cli/send-runtime/imessage.ts @@ -1,9 +1,9 @@ import { sendMessageIMessage as sendMessageIMessageImpl } from "../../plugin-sdk/imessage.js"; -type SendMessageIMessage = typeof import("../../plugin-sdk/imessage.js").sendMessageIMessage; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/imessage.js").sendMessageIMessage; +}; -export async function sendMessageIMessage( - ...args: Parameters -): ReturnType { - return await sendMessageIMessageImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageIMessageImpl, +} satisfies RuntimeSend; diff --git a/src/cli/send-runtime/signal.ts b/src/cli/send-runtime/signal.ts index a1e72eb1200..151f13cc351 100644 --- a/src/cli/send-runtime/signal.ts +++ b/src/cli/send-runtime/signal.ts @@ -1,9 +1,9 @@ import { sendMessageSignal as sendMessageSignalImpl } from "../../plugin-sdk/signal.js"; -type SendMessageSignal = typeof import("../../plugin-sdk/signal.js").sendMessageSignal; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/signal.js").sendMessageSignal; +}; -export async function sendMessageSignal( - ...args: Parameters -): ReturnType { - return await sendMessageSignalImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageSignalImpl, +} satisfies RuntimeSend; diff --git a/src/cli/send-runtime/slack.ts b/src/cli/send-runtime/slack.ts index 3bef60a98c2..354186cd128 100644 --- a/src/cli/send-runtime/slack.ts +++ b/src/cli/send-runtime/slack.ts @@ -1,9 +1,9 @@ import { sendMessageSlack as sendMessageSlackImpl } from "../../plugin-sdk/slack.js"; -type SendMessageSlack = typeof import("../../plugin-sdk/slack.js").sendMessageSlack; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/slack.js").sendMessageSlack; +}; -export async function sendMessageSlack( - ...args: Parameters -): ReturnType { - return await sendMessageSlackImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageSlackImpl, +} satisfies RuntimeSend; diff --git a/src/cli/send-runtime/telegram.ts b/src/cli/send-runtime/telegram.ts index 3c384baa853..09d5e3e9b19 100644 --- a/src/cli/send-runtime/telegram.ts +++ b/src/cli/send-runtime/telegram.ts @@ -1,9 +1,9 @@ import { sendMessageTelegram as sendMessageTelegramImpl } from "../../plugin-sdk/telegram.js"; -type SendMessageTelegram = typeof import("../../plugin-sdk/telegram.js").sendMessageTelegram; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/telegram.js").sendMessageTelegram; +}; -export async function sendMessageTelegram( - ...args: Parameters -): ReturnType { - return await sendMessageTelegramImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageTelegramImpl, +} satisfies RuntimeSend; diff --git a/src/cli/send-runtime/whatsapp.ts b/src/cli/send-runtime/whatsapp.ts index f8b33db58c1..49f0e50baa6 100644 --- a/src/cli/send-runtime/whatsapp.ts +++ b/src/cli/send-runtime/whatsapp.ts @@ -1,9 +1,9 @@ import { sendMessageWhatsApp as sendMessageWhatsAppImpl } from "../../plugin-sdk/whatsapp.js"; -type SendMessageWhatsApp = typeof import("../../plugin-sdk/whatsapp.js").sendMessageWhatsApp; +type RuntimeSend = { + sendMessage: typeof import("../../plugin-sdk/whatsapp.js").sendMessageWhatsApp; +}; -export async function sendMessageWhatsApp( - ...args: Parameters -): ReturnType { - return await sendMessageWhatsAppImpl(...args); -} +export const runtimeSend = { + sendMessage: sendMessageWhatsAppImpl, +} satisfies RuntimeSend; diff --git a/src/commands/status.scan.deps.runtime.ts b/src/commands/status.scan.deps.runtime.ts index b9838d2176f..ce318085541 100644 --- a/src/commands/status.scan.deps.runtime.ts +++ b/src/commands/status.scan.deps.runtime.ts @@ -1,2 +1,34 @@ -export { getTailnetHostname } from "../infra/tailscale.js"; -export { getMemorySearchManager } from "../memory/index.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { getTailnetHostname } from "../infra/tailscale.js"; +import { getMemorySearchManager as getMemorySearchManagerImpl } from "../memory/index.js"; +import type { MemoryProviderStatus } from "../memory/types.js"; + +export { getTailnetHostname }; + +type StatusMemoryManager = { + probeVectorAvailability(): Promise; + status(): MemoryProviderStatus; + close?(): Promise; +}; + +export async function getMemorySearchManager(params: { + cfg: OpenClawConfig; + agentId: string; + purpose: "status"; +}): Promise<{ manager: StatusMemoryManager | null }> { + const { manager } = await getMemorySearchManagerImpl(params); + if (!manager) { + return { manager: null }; + } + return { + manager: { + async probeVectorAvailability() { + await manager.probeVectorAvailability(); + }, + status() { + return manager.status(); + }, + close: manager.close ? async () => await manager.close?.() : undefined, + }, + }; +} diff --git a/src/config/schema.shared.test.ts b/src/config/schema.shared.test.ts index 48820fbf029..d566bfd55f5 100644 --- a/src/config/schema.shared.test.ts +++ b/src/config/schema.shared.test.ts @@ -21,7 +21,7 @@ describe("schema.shared", () => { it("treats branch schemas as having children", () => { expect( schemaHasChildren({ - oneOf: [{ type: "string" }, { properties: { token: { type: "string" } } }], + oneOf: [{}, { properties: { token: {} } }], }), ).toBe(true); }); diff --git a/src/plugins/contracts/auth-choice.contract.test.ts b/src/plugins/contracts/auth-choice.contract.test.ts index 33e9be99479..ac2069b0d75 100644 --- a/src/plugins/contracts/auth-choice.contract.test.ts +++ b/src/plugins/contracts/auth-choice.contract.test.ts @@ -1,5 +1,4 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; import { createAuthTestLifecycle, createExitThrowingRuntime, @@ -7,7 +6,8 @@ import { readAuthProfilesForAgent, requireOpenClawAgentDir, setupAuthTestEnv, -} from "../../commands/test-wizard-helpers.js"; +} from "../../../test/helpers/auth-wizard.js"; +import { clearRuntimeAuthProfileStoreSnapshots } from "../../agents/auth-profiles/store.js"; import { applyAuthChoiceLoadedPluginProvider } from "../../plugins/provider-auth-choice.js"; import { buildProviderPluginMethodChoice } from "../provider-wizard.js"; import { requireProviderContractProvider, uniqueProviderContractProviders } from "./registry.js"; @@ -27,7 +27,6 @@ const resolveProviderPluginChoiceMock = vi.hoisted(() => vi.fn vi.fn(async () => {}), ); -const resolvePreferredProviderPluginProvidersMock = vi.hoisted(() => vi.fn()); vi.mock("../../../extensions/qwen-portal-auth/oauth.js", () => ({ loginQwenPortalOAuth: loginQwenPortalOAuthMock, @@ -43,15 +42,6 @@ vi.mock("../../plugins/provider-auth-choice.runtime.js", () => ({ runProviderModelSelectedHook: runProviderModelSelectedHookMock, })); -vi.mock("../../plugins/providers.js", async () => { - const actual = await vi.importActual("../../plugins/providers.js"); - return { - ...actual, - resolvePluginProviders: (...args: unknown[]) => - resolvePreferredProviderPluginProvidersMock(...args), - }; -}); - const { resolvePreferredProviderForAuthChoice } = await import("../../plugins/provider-auth-choice-preference.js"); @@ -84,8 +74,24 @@ describe("provider auth-choice contract", () => { } beforeEach(() => { - resolvePreferredProviderPluginProvidersMock.mockReset(); - resolvePreferredProviderPluginProvidersMock.mockReturnValue(uniqueProviderContractProviders); + resolvePluginProvidersMock.mockReset(); + resolvePluginProvidersMock.mockReturnValue(uniqueProviderContractProviders); + resolveProviderPluginChoiceMock.mockReset(); + resolveProviderPluginChoiceMock.mockImplementation(({ providers, choice }) => { + const provider = providers.find((entry) => + entry.auth.some( + (method) => buildProviderPluginMethodChoice(entry.id, method.id) === choice, + ), + ); + if (!provider) { + return null; + } + const method = + provider.auth.find( + (entry) => buildProviderPluginMethodChoice(provider.id, entry.id) === choice, + ) ?? null; + return method ? { provider, method } : null; + }); }); afterEach(async () => { @@ -117,18 +123,18 @@ describe("provider auth-choice contract", () => { }); for (const scenario of pluginFallbackScenarios) { - resolvePreferredProviderPluginProvidersMock.mockClear(); + resolvePluginProvidersMock.mockClear(); await expect( resolvePreferredProviderForAuthChoice({ choice: scenario.authChoice }), ).resolves.toBe(scenario.expectedProvider); - expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); + expect(resolvePluginProvidersMock).toHaveBeenCalled(); } - resolvePreferredProviderPluginProvidersMock.mockClear(); + resolvePluginProvidersMock.mockClear(); await expect(resolvePreferredProviderForAuthChoice({ choice: "unknown" })).resolves.toBe( undefined, ); - expect(resolvePreferredProviderPluginProvidersMock).toHaveBeenCalled(); + expect(resolvePluginProvidersMock).toHaveBeenCalled(); }); it("applies qwen portal auth choices through the shared plugin-provider path", async () => { diff --git a/src/plugins/contracts/runtime.contract.test.ts b/src/plugins/contracts/runtime.contract.test.ts index 87acf1f8a13..15adc59e130 100644 --- a/src/plugins/contracts/runtime.contract.test.ts +++ b/src/plugins/contracts/runtime.contract.test.ts @@ -518,7 +518,7 @@ describe("provider runtime contract", () => { }); it("falls back to legacy pi auth tokens for usage auth", async () => { - const provider = requireProvider("zai"); + const provider = requireProviderContractProvider("zai"); const home = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-zai-contract-")); await fs.mkdir(path.join(home, ".pi", "agent"), { recursive: true }); await fs.writeFile( diff --git a/src/plugins/runtime/runtime-discord-ops.runtime.ts b/src/plugins/runtime/runtime-discord-ops.runtime.ts index 6a9d9429713..182e9c75d41 100644 --- a/src/plugins/runtime/runtime-discord-ops.runtime.ts +++ b/src/plugins/runtime/runtime-discord-ops.runtime.ts @@ -19,132 +19,48 @@ import { sendTypingDiscord as sendTypingDiscordImpl, unpinMessageDiscord as unpinMessageDiscordImpl, } from "../../../extensions/discord/src/send.js"; +import type { PluginRuntimeChannel } from "./types-channel.js"; -type AuditDiscordChannelPermissions = - typeof import("../../../extensions/discord/src/audit.js").auditDiscordChannelPermissions; -type ListDiscordDirectoryGroupsLive = - typeof import("../../../extensions/discord/src/directory-live.js").listDiscordDirectoryGroupsLive; -type ListDiscordDirectoryPeersLive = - typeof import("../../../extensions/discord/src/directory-live.js").listDiscordDirectoryPeersLive; -type MonitorDiscordProvider = - typeof import("../../../extensions/discord/src/monitor.js").monitorDiscordProvider; -type ProbeDiscord = typeof import("../../../extensions/discord/src/probe.js").probeDiscord; -type ResolveDiscordChannelAllowlist = - typeof import("../../../extensions/discord/src/resolve-channels.js").resolveDiscordChannelAllowlist; -type ResolveDiscordUserAllowlist = - typeof import("../../../extensions/discord/src/resolve-users.js").resolveDiscordUserAllowlist; -type CreateThreadDiscord = - typeof import("../../../extensions/discord/src/send.js").createThreadDiscord; -type DeleteMessageDiscord = - typeof import("../../../extensions/discord/src/send.js").deleteMessageDiscord; -type EditChannelDiscord = - typeof import("../../../extensions/discord/src/send.js").editChannelDiscord; -type EditMessageDiscord = - typeof import("../../../extensions/discord/src/send.js").editMessageDiscord; -type PinMessageDiscord = typeof import("../../../extensions/discord/src/send.js").pinMessageDiscord; -type SendDiscordComponentMessage = - typeof import("../../../extensions/discord/src/send.js").sendDiscordComponentMessage; -type SendMessageDiscord = - typeof import("../../../extensions/discord/src/send.js").sendMessageDiscord; -type SendPollDiscord = typeof import("../../../extensions/discord/src/send.js").sendPollDiscord; -type SendTypingDiscord = typeof import("../../../extensions/discord/src/send.js").sendTypingDiscord; -type UnpinMessageDiscord = - typeof import("../../../extensions/discord/src/send.js").unpinMessageDiscord; +type RuntimeDiscordOps = Pick< + PluginRuntimeChannel["discord"], + | "auditChannelPermissions" + | "listDirectoryGroupsLive" + | "listDirectoryPeersLive" + | "probeDiscord" + | "resolveChannelAllowlist" + | "resolveUserAllowlist" + | "sendComponentMessage" + | "sendMessageDiscord" + | "sendPollDiscord" + | "monitorDiscordProvider" +> & { + typing: Pick; + conversationActions: Pick< + PluginRuntimeChannel["discord"]["conversationActions"], + "editMessage" | "deleteMessage" | "pinMessage" | "unpinMessage" | "createThread" | "editChannel" + >; +}; -export function auditDiscordChannelPermissions( - ...args: Parameters -): ReturnType { - return auditDiscordChannelPermissionsImpl(...args); -} - -export function listDiscordDirectoryGroupsLive( - ...args: Parameters -): ReturnType { - return listDiscordDirectoryGroupsLiveImpl(...args); -} - -export function listDiscordDirectoryPeersLive( - ...args: Parameters -): ReturnType { - return listDiscordDirectoryPeersLiveImpl(...args); -} - -export function monitorDiscordProvider( - ...args: Parameters -): ReturnType { - return monitorDiscordProviderImpl(...args); -} - -export function probeDiscord(...args: Parameters): ReturnType { - return probeDiscordImpl(...args); -} - -export function resolveDiscordChannelAllowlist( - ...args: Parameters -): ReturnType { - return resolveDiscordChannelAllowlistImpl(...args); -} - -export function resolveDiscordUserAllowlist( - ...args: Parameters -): ReturnType { - return resolveDiscordUserAllowlistImpl(...args); -} - -export function createThreadDiscord( - ...args: Parameters -): ReturnType { - return createThreadDiscordImpl(...args); -} - -export function deleteMessageDiscord( - ...args: Parameters -): ReturnType { - return deleteMessageDiscordImpl(...args); -} - -export function editChannelDiscord( - ...args: Parameters -): ReturnType { - return editChannelDiscordImpl(...args); -} - -export function editMessageDiscord( - ...args: Parameters -): ReturnType { - return editMessageDiscordImpl(...args); -} - -export function pinMessageDiscord( - ...args: Parameters -): ReturnType { - return pinMessageDiscordImpl(...args); -} - -export function sendDiscordComponentMessage( - ...args: Parameters -): ReturnType { - return sendDiscordComponentMessageImpl(...args); -} - -export function sendMessageDiscord( - ...args: Parameters -): ReturnType { - return sendMessageDiscordImpl(...args); -} - -export function sendPollDiscord(...args: Parameters): ReturnType { - return sendPollDiscordImpl(...args); -} - -export function sendTypingDiscord( - ...args: Parameters -): ReturnType { - return sendTypingDiscordImpl(...args); -} - -export function unpinMessageDiscord( - ...args: Parameters -): ReturnType { - return unpinMessageDiscordImpl(...args); -} +export const runtimeDiscordOps = { + auditChannelPermissions: auditDiscordChannelPermissionsImpl, + listDirectoryGroupsLive: listDiscordDirectoryGroupsLiveImpl, + listDirectoryPeersLive: listDiscordDirectoryPeersLiveImpl, + probeDiscord: probeDiscordImpl, + resolveChannelAllowlist: resolveDiscordChannelAllowlistImpl, + resolveUserAllowlist: resolveDiscordUserAllowlistImpl, + sendComponentMessage: sendDiscordComponentMessageImpl, + sendMessageDiscord: sendMessageDiscordImpl, + sendPollDiscord: sendPollDiscordImpl, + monitorDiscordProvider: monitorDiscordProviderImpl, + typing: { + pulse: sendTypingDiscordImpl, + }, + conversationActions: { + editMessage: editMessageDiscordImpl, + deleteMessage: deleteMessageDiscordImpl, + pinMessage: pinMessageDiscordImpl, + unpinMessage: unpinMessageDiscordImpl, + createThread: createThreadDiscordImpl, + editChannel: editChannelDiscordImpl, + }, +} satisfies RuntimeDiscordOps; diff --git a/src/plugins/runtime/runtime-discord.ts b/src/plugins/runtime/runtime-discord.ts index ae302ad0e5f..033c1631828 100644 --- a/src/plugins/runtime/runtime-discord.ts +++ b/src/plugins/runtime/runtime-discord.ts @@ -12,116 +12,119 @@ import { import { createDiscordTypingLease } from "./runtime-discord-typing.js"; import type { PluginRuntimeChannel } from "./types-channel.js"; -let runtimeDiscordOpsPromise: Promise | null = - null; +type RuntimeDiscordOps = typeof import("./runtime-discord-ops.runtime.js").runtimeDiscordOps; + +let runtimeDiscordOpsPromise: Promise | null = null; function loadRuntimeDiscordOps() { - runtimeDiscordOpsPromise ??= import("./runtime-discord-ops.runtime.js"); + runtimeDiscordOpsPromise ??= import("./runtime-discord-ops.runtime.js").then( + ({ runtimeDiscordOps }) => runtimeDiscordOps, + ); return runtimeDiscordOpsPromise; } const auditChannelPermissionsLazy: PluginRuntimeChannel["discord"]["auditChannelPermissions"] = async (...args) => { - const { auditDiscordChannelPermissions } = await loadRuntimeDiscordOps(); - return auditDiscordChannelPermissions(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.auditChannelPermissions(...args); }; const listDirectoryGroupsLiveLazy: PluginRuntimeChannel["discord"]["listDirectoryGroupsLive"] = async (...args) => { - const { listDiscordDirectoryGroupsLive } = await loadRuntimeDiscordOps(); - return listDiscordDirectoryGroupsLive(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.listDirectoryGroupsLive(...args); }; const listDirectoryPeersLiveLazy: PluginRuntimeChannel["discord"]["listDirectoryPeersLive"] = async (...args) => { - const { listDiscordDirectoryPeersLive } = await loadRuntimeDiscordOps(); - return listDiscordDirectoryPeersLive(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.listDirectoryPeersLive(...args); }; const probeDiscordLazy: PluginRuntimeChannel["discord"]["probeDiscord"] = async (...args) => { - const { probeDiscord } = await loadRuntimeDiscordOps(); - return probeDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.probeDiscord(...args); }; const resolveChannelAllowlistLazy: PluginRuntimeChannel["discord"]["resolveChannelAllowlist"] = async (...args) => { - const { resolveDiscordChannelAllowlist } = await loadRuntimeDiscordOps(); - return resolveDiscordChannelAllowlist(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.resolveChannelAllowlist(...args); }; const resolveUserAllowlistLazy: PluginRuntimeChannel["discord"]["resolveUserAllowlist"] = async ( ...args ) => { - const { resolveDiscordUserAllowlist } = await loadRuntimeDiscordOps(); - return resolveDiscordUserAllowlist(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.resolveUserAllowlist(...args); }; const sendComponentMessageLazy: PluginRuntimeChannel["discord"]["sendComponentMessage"] = async ( ...args ) => { - const { sendDiscordComponentMessage } = await loadRuntimeDiscordOps(); - return sendDiscordComponentMessage(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.sendComponentMessage(...args); }; const sendMessageDiscordLazy: PluginRuntimeChannel["discord"]["sendMessageDiscord"] = async ( ...args ) => { - const { sendMessageDiscord } = await loadRuntimeDiscordOps(); - return sendMessageDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.sendMessageDiscord(...args); }; const sendPollDiscordLazy: PluginRuntimeChannel["discord"]["sendPollDiscord"] = async (...args) => { - const { sendPollDiscord } = await loadRuntimeDiscordOps(); - return sendPollDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.sendPollDiscord(...args); }; const monitorDiscordProviderLazy: PluginRuntimeChannel["discord"]["monitorDiscordProvider"] = async (...args) => { - const { monitorDiscordProvider } = await loadRuntimeDiscordOps(); - return monitorDiscordProvider(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.monitorDiscordProvider(...args); }; const sendTypingDiscordLazy: PluginRuntimeChannel["discord"]["typing"]["pulse"] = async ( ...args ) => { - const { sendTypingDiscord } = await loadRuntimeDiscordOps(); - return sendTypingDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.typing.pulse(...args); }; const editMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["editMessage"] = async (...args) => { - const { editMessageDiscord } = await loadRuntimeDiscordOps(); - return editMessageDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.editMessage(...args); }; const deleteMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["deleteMessage"] = async (...args) => { - const { deleteMessageDiscord } = await loadRuntimeDiscordOps(); - return deleteMessageDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.deleteMessage(...args); }; const pinMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["pinMessage"] = async (...args) => { - const { pinMessageDiscord } = await loadRuntimeDiscordOps(); - return pinMessageDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.pinMessage(...args); }; const unpinMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["unpinMessage"] = async (...args) => { - const { unpinMessageDiscord } = await loadRuntimeDiscordOps(); - return unpinMessageDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.unpinMessage(...args); }; const createThreadDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["createThread"] = async (...args) => { - const { createThreadDiscord } = await loadRuntimeDiscordOps(); - return createThreadDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.createThread(...args); }; const editChannelDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["editChannel"] = async (...args) => { - const { editChannelDiscord } = await loadRuntimeDiscordOps(); - return editChannelDiscord(...args); + const runtimeDiscordOps = await loadRuntimeDiscordOps(); + return runtimeDiscordOps.conversationActions.editChannel(...args); }; export function createRuntimeDiscord(): PluginRuntimeChannel["discord"] { diff --git a/src/plugins/runtime/runtime-slack-ops.runtime.ts b/src/plugins/runtime/runtime-slack-ops.runtime.ts index b01568bc491..4f4dc1aeda7 100644 --- a/src/plugins/runtime/runtime-slack-ops.runtime.ts +++ b/src/plugins/runtime/runtime-slack-ops.runtime.ts @@ -8,63 +8,27 @@ import { resolveSlackChannelAllowlist as resolveSlackChannelAllowlistImpl } from import { resolveSlackUserAllowlist as resolveSlackUserAllowlistImpl } from "../../../extensions/slack/src/resolve-users.js"; import { sendMessageSlack as sendMessageSlackImpl } from "../../../extensions/slack/src/send.js"; import { handleSlackAction as handleSlackActionImpl } from "../../agents/tools/slack-actions.js"; +import type { PluginRuntimeChannel } from "./types-channel.js"; -type ListSlackDirectoryGroupsLive = - typeof import("../../../extensions/slack/src/directory-live.js").listSlackDirectoryGroupsLive; -type ListSlackDirectoryPeersLive = - typeof import("../../../extensions/slack/src/directory-live.js").listSlackDirectoryPeersLive; -type MonitorSlackProvider = - typeof import("../../../extensions/slack/src/index.js").monitorSlackProvider; -type ProbeSlack = typeof import("../../../extensions/slack/src/probe.js").probeSlack; -type ResolveSlackChannelAllowlist = - typeof import("../../../extensions/slack/src/resolve-channels.js").resolveSlackChannelAllowlist; -type ResolveSlackUserAllowlist = - typeof import("../../../extensions/slack/src/resolve-users.js").resolveSlackUserAllowlist; -type SendMessageSlack = typeof import("../../../extensions/slack/src/send.js").sendMessageSlack; -type HandleSlackAction = typeof import("../../agents/tools/slack-actions.js").handleSlackAction; +type RuntimeSlackOps = Pick< + PluginRuntimeChannel["slack"], + | "listDirectoryGroupsLive" + | "listDirectoryPeersLive" + | "probeSlack" + | "resolveChannelAllowlist" + | "resolveUserAllowlist" + | "sendMessageSlack" + | "monitorSlackProvider" + | "handleSlackAction" +>; -export function listSlackDirectoryGroupsLive( - ...args: Parameters -): ReturnType { - return listSlackDirectoryGroupsLiveImpl(...args); -} - -export function listSlackDirectoryPeersLive( - ...args: Parameters -): ReturnType { - return listSlackDirectoryPeersLiveImpl(...args); -} - -export function monitorSlackProvider( - ...args: Parameters -): ReturnType { - return monitorSlackProviderImpl(...args); -} - -export function probeSlack(...args: Parameters): ReturnType { - return probeSlackImpl(...args); -} - -export function resolveSlackChannelAllowlist( - ...args: Parameters -): ReturnType { - return resolveSlackChannelAllowlistImpl(...args); -} - -export function resolveSlackUserAllowlist( - ...args: Parameters -): ReturnType { - return resolveSlackUserAllowlistImpl(...args); -} - -export function sendMessageSlack( - ...args: Parameters -): ReturnType { - return sendMessageSlackImpl(...args); -} - -export function handleSlackAction( - ...args: Parameters -): ReturnType { - return handleSlackActionImpl(...args); -} +export const runtimeSlackOps = { + listDirectoryGroupsLive: listSlackDirectoryGroupsLiveImpl, + listDirectoryPeersLive: listSlackDirectoryPeersLiveImpl, + probeSlack: probeSlackImpl, + resolveChannelAllowlist: resolveSlackChannelAllowlistImpl, + resolveUserAllowlist: resolveSlackUserAllowlistImpl, + sendMessageSlack: sendMessageSlackImpl, + monitorSlackProvider: monitorSlackProviderImpl, + handleSlackAction: handleSlackActionImpl, +} satisfies RuntimeSlackOps; diff --git a/src/plugins/runtime/runtime-slack.ts b/src/plugins/runtime/runtime-slack.ts index 9579aed4c1b..23d34a7e5f4 100644 --- a/src/plugins/runtime/runtime-slack.ts +++ b/src/plugins/runtime/runtime-slack.ts @@ -1,60 +1,64 @@ import type { PluginRuntimeChannel } from "./types-channel.js"; -let runtimeSlackOpsPromise: Promise | null = null; +type RuntimeSlackOps = typeof import("./runtime-slack-ops.runtime.js").runtimeSlackOps; + +let runtimeSlackOpsPromise: Promise | null = null; function loadRuntimeSlackOps() { - runtimeSlackOpsPromise ??= import("./runtime-slack-ops.runtime.js"); + runtimeSlackOpsPromise ??= import("./runtime-slack-ops.runtime.js").then( + ({ runtimeSlackOps }) => runtimeSlackOps, + ); return runtimeSlackOpsPromise; } const listDirectoryGroupsLiveLazy: PluginRuntimeChannel["slack"]["listDirectoryGroupsLive"] = async (...args) => { - const { listSlackDirectoryGroupsLive } = await loadRuntimeSlackOps(); - return listSlackDirectoryGroupsLive(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.listDirectoryGroupsLive(...args); }; const listDirectoryPeersLiveLazy: PluginRuntimeChannel["slack"]["listDirectoryPeersLive"] = async ( ...args ) => { - const { listSlackDirectoryPeersLive } = await loadRuntimeSlackOps(); - return listSlackDirectoryPeersLive(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.listDirectoryPeersLive(...args); }; const probeSlackLazy: PluginRuntimeChannel["slack"]["probeSlack"] = async (...args) => { - const { probeSlack } = await loadRuntimeSlackOps(); - return probeSlack(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.probeSlack(...args); }; const resolveChannelAllowlistLazy: PluginRuntimeChannel["slack"]["resolveChannelAllowlist"] = async (...args) => { - const { resolveSlackChannelAllowlist } = await loadRuntimeSlackOps(); - return resolveSlackChannelAllowlist(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.resolveChannelAllowlist(...args); }; const resolveUserAllowlistLazy: PluginRuntimeChannel["slack"]["resolveUserAllowlist"] = async ( ...args ) => { - const { resolveSlackUserAllowlist } = await loadRuntimeSlackOps(); - return resolveSlackUserAllowlist(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.resolveUserAllowlist(...args); }; const sendMessageSlackLazy: PluginRuntimeChannel["slack"]["sendMessageSlack"] = async (...args) => { - const { sendMessageSlack } = await loadRuntimeSlackOps(); - return sendMessageSlack(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.sendMessageSlack(...args); }; const monitorSlackProviderLazy: PluginRuntimeChannel["slack"]["monitorSlackProvider"] = async ( ...args ) => { - const { monitorSlackProvider } = await loadRuntimeSlackOps(); - return monitorSlackProvider(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.monitorSlackProvider(...args); }; const handleSlackActionLazy: PluginRuntimeChannel["slack"]["handleSlackAction"] = async ( ...args ) => { - const { handleSlackAction } = await loadRuntimeSlackOps(); - return handleSlackAction(...args); + const runtimeSlackOps = await loadRuntimeSlackOps(); + return runtimeSlackOps.handleSlackAction(...args); }; export function createRuntimeSlack(): PluginRuntimeChannel["slack"] { diff --git a/src/plugins/runtime/runtime-telegram-ops.runtime.ts b/src/plugins/runtime/runtime-telegram-ops.runtime.ts index cc99abfb1c4..b8b915e6065 100644 --- a/src/plugins/runtime/runtime-telegram-ops.runtime.ts +++ b/src/plugins/runtime/runtime-telegram-ops.runtime.ts @@ -1,7 +1,4 @@ -import { - auditTelegramGroupMembership as auditTelegramGroupMembershipImpl, - collectTelegramUnmentionedGroupIds as collectTelegramUnmentionedGroupIdsImpl, -} from "../../../extensions/telegram/src/audit.js"; +import { auditTelegramGroupMembership as auditTelegramGroupMembershipImpl } from "../../../extensions/telegram/src/audit.js"; import { monitorTelegramProvider as monitorTelegramProviderImpl } from "../../../extensions/telegram/src/monitor.js"; import { probeTelegram as probeTelegramImpl } from "../../../extensions/telegram/src/probe.js"; import { @@ -15,113 +12,43 @@ import { sendTypingTelegram as sendTypingTelegramImpl, unpinMessageTelegram as unpinMessageTelegramImpl, } from "../../../extensions/telegram/src/send.js"; -import { resolveTelegramToken as resolveTelegramTokenImpl } from "../../../extensions/telegram/src/token.js"; +import type { PluginRuntimeChannel } from "./types-channel.js"; -type AuditTelegramGroupMembership = - typeof import("../../../extensions/telegram/src/audit.js").auditTelegramGroupMembership; -type CollectTelegramUnmentionedGroupIds = - typeof import("../../../extensions/telegram/src/audit.js").collectTelegramUnmentionedGroupIds; -type MonitorTelegramProvider = - typeof import("../../../extensions/telegram/src/monitor.js").monitorTelegramProvider; -type ProbeTelegram = typeof import("../../../extensions/telegram/src/probe.js").probeTelegram; -type DeleteMessageTelegram = - typeof import("../../../extensions/telegram/src/send.js").deleteMessageTelegram; -type EditMessageReplyMarkupTelegram = - typeof import("../../../extensions/telegram/src/send.js").editMessageReplyMarkupTelegram; -type EditMessageTelegram = - typeof import("../../../extensions/telegram/src/send.js").editMessageTelegram; -type PinMessageTelegram = - typeof import("../../../extensions/telegram/src/send.js").pinMessageTelegram; -type RenameForumTopicTelegram = - typeof import("../../../extensions/telegram/src/send.js").renameForumTopicTelegram; -type SendMessageTelegram = - typeof import("../../../extensions/telegram/src/send.js").sendMessageTelegram; -type SendPollTelegram = typeof import("../../../extensions/telegram/src/send.js").sendPollTelegram; -type SendTypingTelegram = - typeof import("../../../extensions/telegram/src/send.js").sendTypingTelegram; -type UnpinMessageTelegram = - typeof import("../../../extensions/telegram/src/send.js").unpinMessageTelegram; -type ResolveTelegramToken = - typeof import("../../../extensions/telegram/src/token.js").resolveTelegramToken; +type RuntimeTelegramOps = Pick< + PluginRuntimeChannel["telegram"], + | "auditGroupMembership" + | "probeTelegram" + | "sendMessageTelegram" + | "sendPollTelegram" + | "monitorTelegramProvider" +> & { + typing: Pick; + conversationActions: Pick< + PluginRuntimeChannel["telegram"]["conversationActions"], + | "editMessage" + | "editReplyMarkup" + | "deleteMessage" + | "renameTopic" + | "pinMessage" + | "unpinMessage" + >; +}; -export function auditTelegramGroupMembership( - ...args: Parameters -): ReturnType { - return auditTelegramGroupMembershipImpl(...args); -} - -export function collectTelegramUnmentionedGroupIds( - ...args: Parameters -): ReturnType { - return collectTelegramUnmentionedGroupIdsImpl(...args); -} - -export function monitorTelegramProvider( - ...args: Parameters -): ReturnType { - return monitorTelegramProviderImpl(...args); -} - -export function probeTelegram(...args: Parameters): ReturnType { - return probeTelegramImpl(...args); -} - -export function deleteMessageTelegram( - ...args: Parameters -): ReturnType { - return deleteMessageTelegramImpl(...args); -} - -export function editMessageReplyMarkupTelegram( - ...args: Parameters -): ReturnType { - return editMessageReplyMarkupTelegramImpl(...args); -} - -export function editMessageTelegram( - ...args: Parameters -): ReturnType { - return editMessageTelegramImpl(...args); -} - -export function pinMessageTelegram( - ...args: Parameters -): ReturnType { - return pinMessageTelegramImpl(...args); -} - -export function renameForumTopicTelegram( - ...args: Parameters -): ReturnType { - return renameForumTopicTelegramImpl(...args); -} - -export function sendMessageTelegram( - ...args: Parameters -): ReturnType { - return sendMessageTelegramImpl(...args); -} - -export function sendPollTelegram( - ...args: Parameters -): ReturnType { - return sendPollTelegramImpl(...args); -} - -export function sendTypingTelegram( - ...args: Parameters -): ReturnType { - return sendTypingTelegramImpl(...args); -} - -export function unpinMessageTelegram( - ...args: Parameters -): ReturnType { - return unpinMessageTelegramImpl(...args); -} - -export function resolveTelegramToken( - ...args: Parameters -): ReturnType { - return resolveTelegramTokenImpl(...args); -} +export const runtimeTelegramOps = { + auditGroupMembership: auditTelegramGroupMembershipImpl, + probeTelegram: probeTelegramImpl, + sendMessageTelegram: sendMessageTelegramImpl, + sendPollTelegram: sendPollTelegramImpl, + monitorTelegramProvider: monitorTelegramProviderImpl, + typing: { + pulse: sendTypingTelegramImpl, + }, + conversationActions: { + editMessage: editMessageTelegramImpl, + editReplyMarkup: editMessageReplyMarkupTelegramImpl, + deleteMessage: deleteMessageTelegramImpl, + renameTopic: renameForumTopicTelegramImpl, + pinMessage: pinMessageTelegramImpl, + unpinMessage: unpinMessageTelegramImpl, + }, +} satisfies RuntimeTelegramOps; diff --git a/src/plugins/runtime/runtime-telegram.ts b/src/plugins/runtime/runtime-telegram.ts index 22061a7e00d..d0d71d08c4e 100644 --- a/src/plugins/runtime/runtime-telegram.ts +++ b/src/plugins/runtime/runtime-telegram.ts @@ -8,87 +8,90 @@ import { resolveTelegramToken } from "../../../extensions/telegram/src/token.js" import { createTelegramTypingLease } from "./runtime-telegram-typing.js"; import type { PluginRuntimeChannel } from "./types-channel.js"; -let runtimeTelegramOpsPromise: Promise | null = - null; +type RuntimeTelegramOps = typeof import("./runtime-telegram-ops.runtime.js").runtimeTelegramOps; + +let runtimeTelegramOpsPromise: Promise | null = null; function loadRuntimeTelegramOps() { - runtimeTelegramOpsPromise ??= import("./runtime-telegram-ops.runtime.js"); + runtimeTelegramOpsPromise ??= import("./runtime-telegram-ops.runtime.js").then( + ({ runtimeTelegramOps }) => runtimeTelegramOps, + ); return runtimeTelegramOpsPromise; } const auditGroupMembershipLazy: PluginRuntimeChannel["telegram"]["auditGroupMembership"] = async ( ...args ) => { - const { auditTelegramGroupMembership } = await loadRuntimeTelegramOps(); - return auditTelegramGroupMembership(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.auditGroupMembership(...args); }; const probeTelegramLazy: PluginRuntimeChannel["telegram"]["probeTelegram"] = async (...args) => { - const { probeTelegram } = await loadRuntimeTelegramOps(); - return probeTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.probeTelegram(...args); }; const sendMessageTelegramLazy: PluginRuntimeChannel["telegram"]["sendMessageTelegram"] = async ( ...args ) => { - const { sendMessageTelegram } = await loadRuntimeTelegramOps(); - return sendMessageTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.sendMessageTelegram(...args); }; const sendPollTelegramLazy: PluginRuntimeChannel["telegram"]["sendPollTelegram"] = async ( ...args ) => { - const { sendPollTelegram } = await loadRuntimeTelegramOps(); - return sendPollTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.sendPollTelegram(...args); }; const monitorTelegramProviderLazy: PluginRuntimeChannel["telegram"]["monitorTelegramProvider"] = async (...args) => { - const { monitorTelegramProvider } = await loadRuntimeTelegramOps(); - return monitorTelegramProvider(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.monitorTelegramProvider(...args); }; const sendTypingTelegramLazy: PluginRuntimeChannel["telegram"]["typing"]["pulse"] = async ( ...args ) => { - const { sendTypingTelegram } = await loadRuntimeTelegramOps(); - return sendTypingTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.typing.pulse(...args); }; const editMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["editMessage"] = async (...args) => { - const { editMessageTelegram } = await loadRuntimeTelegramOps(); - return editMessageTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.editMessage(...args); }; const editMessageReplyMarkupTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["editReplyMarkup"] = async (...args) => { - const { editMessageReplyMarkupTelegram } = await loadRuntimeTelegramOps(); - return editMessageReplyMarkupTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.editReplyMarkup(...args); }; const deleteMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["deleteMessage"] = async (...args) => { - const { deleteMessageTelegram } = await loadRuntimeTelegramOps(); - return deleteMessageTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.deleteMessage(...args); }; const renameForumTopicTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["renameTopic"] = async (...args) => { - const { renameForumTopicTelegram } = await loadRuntimeTelegramOps(); - return renameForumTopicTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.renameTopic(...args); }; const pinMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["pinMessage"] = async (...args) => { - const { pinMessageTelegram } = await loadRuntimeTelegramOps(); - return pinMessageTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.pinMessage(...args); }; const unpinMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["unpinMessage"] = async (...args) => { - const { unpinMessageTelegram } = await loadRuntimeTelegramOps(); - return unpinMessageTelegram(...args); + const runtimeTelegramOps = await loadRuntimeTelegramOps(); + return runtimeTelegramOps.conversationActions.unpinMessage(...args); }; export function createRuntimeTelegram(): PluginRuntimeChannel["telegram"] { diff --git a/src/plugins/runtime/runtime-whatsapp-login.runtime.ts b/src/plugins/runtime/runtime-whatsapp-login.runtime.ts index 4d44c7c87f6..2760db7311d 100644 --- a/src/plugins/runtime/runtime-whatsapp-login.runtime.ts +++ b/src/plugins/runtime/runtime-whatsapp-login.runtime.ts @@ -1,7 +1,8 @@ import { loginWeb as loginWebImpl } from "../../../extensions/whatsapp/src/login.js"; +import type { PluginRuntime } from "./types.js"; -type LoginWeb = typeof import("../../../extensions/whatsapp/src/login.js").loginWeb; +type RuntimeWhatsAppLogin = Pick; -export function loginWeb(...args: Parameters): ReturnType { - return loginWebImpl(...args); -} +export const runtimeWhatsAppLogin = { + loginWeb: loginWebImpl, +} satisfies RuntimeWhatsAppLogin; diff --git a/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts b/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts index 023e9e93e23..71aa83ce9ac 100644 --- a/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts +++ b/src/plugins/runtime/runtime-whatsapp-outbound.runtime.ts @@ -2,19 +2,14 @@ import { sendMessageWhatsApp as sendMessageWhatsAppImpl, sendPollWhatsApp as sendPollWhatsAppImpl, } from "../../../extensions/whatsapp/src/send.js"; +import type { PluginRuntime } from "./types.js"; -type SendMessageWhatsApp = - typeof import("../../../extensions/whatsapp/src/send.js").sendMessageWhatsApp; -type SendPollWhatsApp = typeof import("../../../extensions/whatsapp/src/send.js").sendPollWhatsApp; +type RuntimeWhatsAppOutbound = Pick< + PluginRuntime["channel"]["whatsapp"], + "sendMessageWhatsApp" | "sendPollWhatsApp" +>; -export function sendMessageWhatsApp( - ...args: Parameters -): ReturnType { - return sendMessageWhatsAppImpl(...args); -} - -export function sendPollWhatsApp( - ...args: Parameters -): ReturnType { - return sendPollWhatsAppImpl(...args); -} +export const runtimeWhatsAppOutbound = { + sendMessageWhatsApp: sendMessageWhatsAppImpl, + sendPollWhatsApp: sendPollWhatsAppImpl, +} satisfies RuntimeWhatsAppOutbound; diff --git a/src/plugins/runtime/runtime-whatsapp.ts b/src/plugins/runtime/runtime-whatsapp.ts index 21a92aefe09..10f8e9e6a94 100644 --- a/src/plugins/runtime/runtime-whatsapp.ts +++ b/src/plugins/runtime/runtime-whatsapp.ts @@ -9,23 +9,28 @@ import { import { createRuntimeWhatsAppLoginTool } from "./runtime-whatsapp-login-tool.js"; import type { PluginRuntime } from "./types.js"; +type RuntimeWhatsAppOutbound = + typeof import("./runtime-whatsapp-outbound.runtime.js").runtimeWhatsAppOutbound; +type RuntimeWhatsAppLogin = + typeof import("./runtime-whatsapp-login.runtime.js").runtimeWhatsAppLogin; + const sendMessageWhatsAppLazy: PluginRuntime["channel"]["whatsapp"]["sendMessageWhatsApp"] = async ( ...args ) => { - const { sendMessageWhatsApp } = await loadWebOutbound(); - return sendMessageWhatsApp(...args); + const runtimeWhatsAppOutbound = await loadWebOutbound(); + return runtimeWhatsAppOutbound.sendMessageWhatsApp(...args); }; const sendPollWhatsAppLazy: PluginRuntime["channel"]["whatsapp"]["sendPollWhatsApp"] = async ( ...args ) => { - const { sendPollWhatsApp } = await loadWebOutbound(); - return sendPollWhatsApp(...args); + const runtimeWhatsAppOutbound = await loadWebOutbound(); + return runtimeWhatsAppOutbound.sendPollWhatsApp(...args); }; const loginWebLazy: PluginRuntime["channel"]["whatsapp"]["loginWeb"] = async (...args) => { - const { loginWeb } = await loadWebLogin(); - return loginWeb(...args); + const runtimeWhatsAppLogin = await loadWebLogin(); + return runtimeWhatsAppLogin.loginWeb(...args); }; const startWebLoginWithQrLazy: PluginRuntime["channel"]["whatsapp"]["startWebLoginWithQr"] = async ( @@ -59,20 +64,23 @@ let webLoginQrPromise: Promise< typeof import("../../../extensions/whatsapp/src/login-qr.js") > | null = null; let webChannelPromise: Promise | null = null; -let webOutboundPromise: Promise | null = - null; -let webLoginPromise: Promise | null = null; +let webOutboundPromise: Promise | null = null; +let webLoginPromise: Promise | null = null; let whatsappActionsPromise: Promise< typeof import("../../agents/tools/whatsapp-actions.js") > | null = null; function loadWebOutbound() { - webOutboundPromise ??= import("./runtime-whatsapp-outbound.runtime.js"); + webOutboundPromise ??= import("./runtime-whatsapp-outbound.runtime.js").then( + ({ runtimeWhatsAppOutbound }) => runtimeWhatsAppOutbound, + ); return webOutboundPromise; } function loadWebLogin() { - webLoginPromise ??= import("./runtime-whatsapp-login.runtime.js"); + webLoginPromise ??= import("./runtime-whatsapp-login.runtime.js").then( + ({ runtimeWhatsAppLogin }) => runtimeWhatsAppLogin, + ); return webLoginPromise; } From 73ca53ee026db82b559204f6e8d667b7caac549c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:01:17 -0700 Subject: [PATCH 107/187] fix: remove discord setup rebase marker --- extensions/discord/src/setup-surface.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 78e1c1da804..66f7f8bbf4b 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -100,7 +100,6 @@ async function resolveDiscordGroupAllowlist(params: { }); } -<<<<<<< HEAD export const discordSetupWizard: ChannelSetupWizard = createDiscordSetupWizardBase({ promptAllowFrom: promptDiscordAllowFrom, resolveAllowFromEntries: async ({ cfg, accountId, credentialValues, entries }) => From e5919bc52474377055ee65b3e1be228eeb2ac24f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:03:00 -0700 Subject: [PATCH 108/187] docs(gateway): clarify URL allowlist semantics --- CHANGELOG.md | 1 + docs/gateway/configuration-reference.md | 2 ++ docs/gateway/openresponses-http-api.md | 2 ++ docs/gateway/security/index.md | 2 ++ src/config/schema.help.ts | 4 ++-- src/gateway/input-allowlist.test.ts | 20 ++++++++++++++++++++ src/gateway/input-allowlist.ts | 7 +++++++ 7 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 src/gateway/input-allowlist.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 34afa1bc61d..34211e13bef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ Docs: https://docs.openclaw.ai ### Changes - Commands/btw: add `/btw` side questions for quick tool-less answers about the current session without changing future session context, with dismissible in-session TUI answers and explicit BTW replies on external channels. (#45444) Thanks @ngutman. +- Gateway/docs: clarify that empty URL input allowlists are treated as unset, document `allowUrl: false` as the deny-all switch, and add regression coverage for the normalization path. - Sandbox/runtime: add pluggable sandbox backends, ship an OpenShell backend with `mirror` and `remote` workspace modes, and make sandbox list/recreate/prune backend-aware instead of Docker-only. - Sandbox/SSH: add a core SSH sandbox backend with secret-backed key, certificate, and known_hosts inputs, move shared remote exec/filesystem tooling into core, and keep OpenShell focused on sandbox lifecycle plus optional `mirror` mode. - Web tools/Firecrawl: add Firecrawl as an `onboard`/configure search provider via a bundled plugin, expose explicit `firecrawl_search` and `firecrawl_scrape` tools, and align core `web_fetch` fallback behavior with Firecrawl base-URL/env fallback plus guarded endpoint fetches. diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index ee823da9cac..9085c9c35f5 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -2612,6 +2612,8 @@ See [Plugins](/tools/plugin). - `gateway.http.endpoints.responses.maxUrlParts` - `gateway.http.endpoints.responses.files.urlAllowlist` - `gateway.http.endpoints.responses.images.urlAllowlist` + Empty allowlists are treated as unset; use `gateway.http.endpoints.responses.files.allowUrl=false` + and/or `gateway.http.endpoints.responses.images.allowUrl=false` to disable URL fetching. - Optional response hardening header: - `gateway.http.securityHeaders.strictTransportSecurity` (set only for HTTPS origins you control; see [Trusted Proxy Auth](/gateway/trusted-proxy-auth#tls-termination-and-hsts)) diff --git a/docs/gateway/openresponses-http-api.md b/docs/gateway/openresponses-http-api.md index fa86f912ef5..8305da62ee5 100644 --- a/docs/gateway/openresponses-http-api.md +++ b/docs/gateway/openresponses-http-api.md @@ -144,6 +144,8 @@ URL fetch defaults: - Optional hostname allowlists are supported per input type (`files.urlAllowlist`, `images.urlAllowlist`). - Exact host: `"cdn.example.com"` - Wildcard subdomains: `"*.assets.example.com"` (does not match apex) + - Empty or omitted allowlists mean no hostname allowlist restriction. +- To disable URL-based fetches entirely, set `files.allowUrl: false` and/or `images.allowUrl: false`. ## File + image limits (config) diff --git a/docs/gateway/security/index.md b/docs/gateway/security/index.md index 7741707a62b..c3c1ee2eb1b 100644 --- a/docs/gateway/security/index.md +++ b/docs/gateway/security/index.md @@ -568,6 +568,8 @@ tool calls. Reduce the blast radius by: - For OpenResponses URL inputs (`input_file` / `input_image`), set tight `gateway.http.endpoints.responses.files.urlAllowlist` and `gateway.http.endpoints.responses.images.urlAllowlist`, and keep `maxUrlParts` low. + Empty allowlists are treated as unset; use `files.allowUrl: false` / `images.allowUrl: false` + if you want to disable URL fetching entirely. - Enabling sandboxing and strict tool allowlists for any agent that touches untrusted input. - Keeping secrets out of prompts; pass them via env/config on the gateway host instead. diff --git a/src/config/schema.help.ts b/src/config/schema.help.ts index 779abbb609b..bb059bf5cad 100644 --- a/src/config/schema.help.ts +++ b/src/config/schema.help.ts @@ -413,9 +413,9 @@ export const FIELD_HELP: Record = { "gateway.http.endpoints.chatCompletions.images": "Image fetch/validation controls for OpenAI-compatible `image_url` parts.", "gateway.http.endpoints.chatCompletions.images.allowUrl": - "Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported).", + "Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported). Set this to `false` to disable URL fetching entirely.", "gateway.http.endpoints.chatCompletions.images.urlAllowlist": - "Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards.", + "Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards. Empty or omitted lists mean no hostname allowlist restriction.", "gateway.http.endpoints.chatCompletions.images.allowedMimes": "Allowed MIME types for `image_url` parts (case-insensitive list).", "gateway.http.endpoints.chatCompletions.images.maxBytes": diff --git a/src/gateway/input-allowlist.test.ts b/src/gateway/input-allowlist.test.ts new file mode 100644 index 00000000000..169e8ac03e2 --- /dev/null +++ b/src/gateway/input-allowlist.test.ts @@ -0,0 +1,20 @@ +import { describe, expect, it } from "vitest"; +import { normalizeInputHostnameAllowlist } from "./input-allowlist.js"; + +describe("normalizeInputHostnameAllowlist", () => { + it("treats missing and empty allowlists as unset", () => { + expect(normalizeInputHostnameAllowlist(undefined)).toBeUndefined(); + expect(normalizeInputHostnameAllowlist([])).toBeUndefined(); + }); + + it("drops whitespace-only entries and treats the result as unset", () => { + expect(normalizeInputHostnameAllowlist(["", " "])).toBeUndefined(); + }); + + it("preserves trimmed hostname patterns", () => { + expect(normalizeInputHostnameAllowlist([" cdn.example.com ", "*.assets.example.com"])).toEqual([ + "cdn.example.com", + "*.assets.example.com", + ]); + }); +}); diff --git a/src/gateway/input-allowlist.ts b/src/gateway/input-allowlist.ts index d59b3e6265c..61ad9d06cc4 100644 --- a/src/gateway/input-allowlist.ts +++ b/src/gateway/input-allowlist.ts @@ -1,3 +1,10 @@ +/** + * Normalize optional gateway URL-input hostname allowlists. + * + * Semantics are intentionally: + * - missing / empty / whitespace-only list => no hostname allowlist restriction + * - deny-all URL fetching => use the corresponding `allowUrl: false` switch + */ export function normalizeInputHostnameAllowlist( values: string[] | undefined, ): string[] | undefined { From 13505c7392421473234f4fe790ac1e3afcff023a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:05:42 -0700 Subject: [PATCH 109/187] docs(changelog): restore 2026.2.27 heading --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 34211e13bef..dfb9de629f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1222,7 +1222,7 @@ Docs: https://docs.openclaw.ai - Signal/Sync message null-handling: treat `syncMessage` presence (including `null`) as sync envelope traffic so replayed sentTranscript payloads cannot bypass loop guards after daemon restart. Landed from contributor PR #31138 by @Sid-Qin. Thanks @Sid-Qin. - Infra/fs-safe: sanitize directory-read failures so raw `EISDIR` text never leaks to messaging surfaces, with regression tests for both root-scoped and direct safe reads. Landed from contributor PR #31205 by @polooooo. Thanks @polooooo. -## Unreleased +## 2026.2.27 ### Changes From 026d8ea534beda24ba5c38a30d5783b1f3e38174 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 04:26:55 +0000 Subject: [PATCH 110/187] fix: unblock full gate --- docs/.generated/config-baseline.json | 510 ++++++++++++++++-- docs/.generated/config-baseline.jsonl | 63 ++- src/acp/translator.session-rate-limit.test.ts | 1 + src/plugin-sdk/index.test.ts | 3 - src/tts/provider-registry.ts | 14 +- 5 files changed, 540 insertions(+), 51 deletions(-) diff --git a/docs/.generated/config-baseline.json b/docs/.generated/config-baseline.json index 65688a7fc7a..f0ba41b420d 100644 --- a/docs/.generated/config-baseline.json +++ b/docs/.generated/config-baseline.json @@ -11733,6 +11733,116 @@ "tags": [], "hasChildren": false }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft", + "kind": "channel", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.enabled", + "kind": "channel", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.lang", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.outputFormat", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.pitch", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.proxy", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.rate", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.saveSubtitles", + "kind": "channel", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.timeoutMs", + "kind": "channel", + "type": "integer", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.voice", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.accounts.*.voice.tts.microsoft.volume", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, { "path": "channels.discord.accounts.*.voice.tts.mode", "kind": "channel", @@ -11961,11 +12071,6 @@ "kind": "channel", "type": "string", "required": false, - "enumValues": [ - "elevenlabs", - "openai", - "edge" - ], "deprecated": false, "sensitive": false, "tags": [], @@ -14698,6 +14803,116 @@ "tags": [], "hasChildren": false }, + { + "path": "channels.discord.voice.tts.microsoft", + "kind": "channel", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "channels.discord.voice.tts.microsoft.enabled", + "kind": "channel", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.lang", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.outputFormat", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.pitch", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.proxy", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.rate", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.saveSubtitles", + "kind": "channel", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.timeoutMs", + "kind": "channel", + "type": "integer", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.voice", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "channels.discord.voice.tts.microsoft.volume", + "kind": "channel", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, { "path": "channels.discord.voice.tts.mode", "kind": "channel", @@ -14926,11 +15141,6 @@ "kind": "channel", "type": "string", "required": false, - "enumValues": [ - "elevenlabs", - "openai", - "edge" - ], "deprecated": false, "sensitive": false, "tags": [], @@ -43560,6 +43770,116 @@ "tags": [], "hasChildren": false }, + { + "path": "messages.tts.microsoft", + "kind": "core", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "messages.tts.microsoft.enabled", + "kind": "core", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.lang", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.outputFormat", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.pitch", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.proxy", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.rate", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.saveSubtitles", + "kind": "core", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.timeoutMs", + "kind": "core", + "type": "integer", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.voice", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "messages.tts.microsoft.volume", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, { "path": "messages.tts.mode", "kind": "core", @@ -43786,11 +44106,6 @@ "kind": "core", "type": "string", "required": false, - "enumValues": [ - "elevenlabs", - "openai", - "edge" - ], "deprecated": false, "sensitive": false, "tags": [], @@ -46144,6 +46459,75 @@ "help": "Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.", "hasChildren": false }, + { + "path": "plugins.entries.elevenlabs", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "@openclaw/elevenlabs-speech", + "help": "OpenClaw ElevenLabs speech plugin (plugin: elevenlabs)", + "hasChildren": true + }, + { + "path": "plugins.entries.elevenlabs.config", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "@openclaw/elevenlabs-speech Config", + "help": "Plugin-defined config payload for elevenlabs.", + "hasChildren": false + }, + { + "path": "plugins.entries.elevenlabs.enabled", + "kind": "plugin", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Enable @openclaw/elevenlabs-speech", + "hasChildren": false + }, + { + "path": "plugins.entries.elevenlabs.hooks", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Plugin Hook Policy", + "help": "Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.", + "hasChildren": true + }, + { + "path": "plugins.entries.elevenlabs.hooks.allowPromptInjection", + "kind": "plugin", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "access" + ], + "label": "Allow Prompt Injection Hooks", + "help": "Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.", + "hasChildren": false + }, { "path": "plugins.entries.feishu", "kind": "plugin", @@ -46766,7 +47150,7 @@ "hasChildren": false }, { - "path": "plugins.entries.kimi-coding", + "path": "plugins.entries.kimi", "kind": "plugin", "type": "object", "required": false, @@ -46775,12 +47159,12 @@ "tags": [ "advanced" ], - "label": "@openclaw/kimi-coding-provider", - "help": "OpenClaw Kimi Coding provider plugin (plugin: kimi-coding)", + "label": "@openclaw/kimi-provider", + "help": "OpenClaw Kimi provider plugin (plugin: kimi)", "hasChildren": true }, { - "path": "plugins.entries.kimi-coding.config", + "path": "plugins.entries.kimi.config", "kind": "plugin", "type": "object", "required": false, @@ -46789,12 +47173,12 @@ "tags": [ "advanced" ], - "label": "@openclaw/kimi-coding-provider Config", - "help": "Plugin-defined config payload for kimi-coding.", + "label": "@openclaw/kimi-provider Config", + "help": "Plugin-defined config payload for kimi.", "hasChildren": false }, { - "path": "plugins.entries.kimi-coding.enabled", + "path": "plugins.entries.kimi.enabled", "kind": "plugin", "type": "boolean", "required": false, @@ -46803,11 +47187,11 @@ "tags": [ "advanced" ], - "label": "Enable @openclaw/kimi-coding-provider", + "label": "Enable @openclaw/kimi-provider", "hasChildren": false }, { - "path": "plugins.entries.kimi-coding.hooks", + "path": "plugins.entries.kimi.hooks", "kind": "plugin", "type": "object", "required": false, @@ -46821,7 +47205,7 @@ "hasChildren": true }, { - "path": "plugins.entries.kimi-coding.hooks.allowPromptInjection", + "path": "plugins.entries.kimi.hooks.allowPromptInjection", "kind": "plugin", "type": "boolean", "required": false, @@ -47516,6 +47900,75 @@ "help": "Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.", "hasChildren": false }, + { + "path": "plugins.entries.microsoft", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "@openclaw/microsoft-speech", + "help": "OpenClaw Microsoft speech plugin (plugin: microsoft)", + "hasChildren": true + }, + { + "path": "plugins.entries.microsoft.config", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "@openclaw/microsoft-speech Config", + "help": "Plugin-defined config payload for microsoft.", + "hasChildren": false + }, + { + "path": "plugins.entries.microsoft.enabled", + "kind": "plugin", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Enable @openclaw/microsoft-speech", + "hasChildren": false + }, + { + "path": "plugins.entries.microsoft.hooks", + "kind": "plugin", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Plugin Hook Policy", + "help": "Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.", + "hasChildren": true + }, + { + "path": "plugins.entries.microsoft.hooks.allowPromptInjection", + "kind": "plugin", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "access" + ], + "label": "Allow Prompt Injection Hooks", + "help": "Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.", + "hasChildren": false + }, { "path": "plugins.entries.minimax", "kind": "plugin", @@ -51184,11 +51637,6 @@ "kind": "plugin", "type": "string", "required": false, - "enumValues": [ - "openai", - "elevenlabs", - "edge" - ], "deprecated": false, "sensitive": false, "tags": [ @@ -51196,7 +51644,7 @@ "media" ], "label": "TTS Provider Override", - "help": "Deep-merges with messages.tts (Edge is ignored for calls).", + "help": "Deep-merges with messages.tts (Microsoft is ignored for calls).", "hasChildren": false }, { diff --git a/docs/.generated/config-baseline.jsonl b/docs/.generated/config-baseline.jsonl index d8d82d7bb7a..9ff81282d7d 100644 --- a/docs/.generated/config-baseline.jsonl +++ b/docs/.generated/config-baseline.jsonl @@ -1,4 +1,4 @@ -{"generatedBy":"scripts/generate-config-doc-baseline.ts","recordType":"meta","totalPaths":5104} +{"generatedBy":"scripts/generate-config-doc-baseline.ts","recordType":"meta","totalPaths":5147} {"recordType":"path","path":"acp","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"ACP","help":"ACP runtime controls for enabling dispatch, selecting backends, constraining allowed agent targets, and tuning streamed turn projection behavior.","hasChildren":true} {"recordType":"path","path":"acp.allowedAgents","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"ACP Allowed Agents","help":"Allowlist of ACP target agent ids permitted for ACP runtime sessions. Empty means no additional allowlist restriction.","hasChildren":true} {"recordType":"path","path":"acp.allowedAgents.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -1047,6 +1047,17 @@ {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.elevenlabs.voiceSettings.useSpeakerBoost","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.enabled","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.maxTextLength","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft","kind":"channel","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.enabled","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.lang","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.outputFormat","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.pitch","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.proxy","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.rate","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.saveSubtitles","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.timeoutMs","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.voice","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.microsoft.volume","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.mode","kind":"channel","type":"string","required":false,"enumValues":["final","all"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.modelOverrides","kind":"channel","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.modelOverrides.allowModelId","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -1068,7 +1079,7 @@ {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.openai.speed","kind":"channel","type":"number","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.openai.voice","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.prefsPath","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} -{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.provider","kind":"channel","type":"string","required":false,"enumValues":["elevenlabs","openai","edge"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.accounts.*.voice.tts.provider","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.summaryModel","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.accounts.*.voice.tts.timeoutMs","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.ackReaction","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -1302,6 +1313,17 @@ {"recordType":"path","path":"channels.discord.voice.tts.elevenlabs.voiceSettings.useSpeakerBoost","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.enabled","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.maxTextLength","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft","kind":"channel","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.enabled","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.lang","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.outputFormat","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.pitch","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.proxy","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.rate","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.saveSubtitles","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.timeoutMs","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.voice","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.microsoft.volume","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.mode","kind":"channel","type":"string","required":false,"enumValues":["final","all"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.modelOverrides","kind":"channel","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} {"recordType":"path","path":"channels.discord.voice.tts.modelOverrides.allowModelId","kind":"channel","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -1323,7 +1345,7 @@ {"recordType":"path","path":"channels.discord.voice.tts.openai.speed","kind":"channel","type":"number","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.openai.voice","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.prefsPath","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} -{"recordType":"path","path":"channels.discord.voice.tts.provider","kind":"channel","type":"string","required":false,"enumValues":["elevenlabs","openai","edge"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"channels.discord.voice.tts.provider","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.summaryModel","kind":"channel","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.discord.voice.tts.timeoutMs","kind":"channel","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"channels.feishu","kind":"channel","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["channels","network"],"label":"Feishu","help":"飞书/Lark enterprise messaging.","hasChildren":true} @@ -3867,6 +3889,17 @@ {"recordType":"path","path":"messages.tts.elevenlabs.voiceSettings.useSpeakerBoost","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.enabled","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.maxTextLength","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"messages.tts.microsoft.enabled","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.lang","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.outputFormat","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.pitch","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.proxy","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.rate","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.saveSubtitles","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.timeoutMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.voice","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.microsoft.volume","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.mode","kind":"core","type":"string","required":false,"enumValues":["final","all"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.modelOverrides","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} {"recordType":"path","path":"messages.tts.modelOverrides.allowModelId","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -3888,7 +3921,7 @@ {"recordType":"path","path":"messages.tts.openai.speed","kind":"core","type":"number","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.openai.voice","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.prefsPath","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} -{"recordType":"path","path":"messages.tts.provider","kind":"core","type":"string","required":false,"enumValues":["elevenlabs","openai","edge"],"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"messages.tts.provider","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.summaryModel","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"messages.tts.timeoutMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"meta","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Metadata","help":"Metadata fields automatically maintained by OpenClaw to record write/version history for this config file. Keep these values system-managed and avoid manual edits unless debugging migration history.","hasChildren":true} @@ -4067,6 +4100,11 @@ {"recordType":"path","path":"plugins.entries.discord.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/discord","hasChildren":false} {"recordType":"path","path":"plugins.entries.discord.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} {"recordType":"path","path":"plugins.entries.discord.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.elevenlabs","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/elevenlabs-speech","help":"OpenClaw ElevenLabs speech plugin (plugin: elevenlabs)","hasChildren":true} +{"recordType":"path","path":"plugins.entries.elevenlabs.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/elevenlabs-speech Config","help":"Plugin-defined config payload for elevenlabs.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.elevenlabs.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/elevenlabs-speech","hasChildren":false} +{"recordType":"path","path":"plugins.entries.elevenlabs.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} +{"recordType":"path","path":"plugins.entries.elevenlabs.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} {"recordType":"path","path":"plugins.entries.feishu","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/feishu","help":"OpenClaw Feishu/Lark channel plugin (community maintained by @m1heng) (plugin: feishu)","hasChildren":true} {"recordType":"path","path":"plugins.entries.feishu.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/feishu Config","help":"Plugin-defined config payload for feishu.","hasChildren":false} {"recordType":"path","path":"plugins.entries.feishu.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/feishu","hasChildren":false} @@ -4112,11 +4150,11 @@ {"recordType":"path","path":"plugins.entries.kilocode.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/kilocode-provider","hasChildren":false} {"recordType":"path","path":"plugins.entries.kilocode.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} {"recordType":"path","path":"plugins.entries.kilocode.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} -{"recordType":"path","path":"plugins.entries.kimi-coding","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/kimi-coding-provider","help":"OpenClaw Kimi Coding provider plugin (plugin: kimi-coding)","hasChildren":true} -{"recordType":"path","path":"plugins.entries.kimi-coding.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/kimi-coding-provider Config","help":"Plugin-defined config payload for kimi-coding.","hasChildren":false} -{"recordType":"path","path":"plugins.entries.kimi-coding.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/kimi-coding-provider","hasChildren":false} -{"recordType":"path","path":"plugins.entries.kimi-coding.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} -{"recordType":"path","path":"plugins.entries.kimi-coding.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.kimi","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/kimi-provider","help":"OpenClaw Kimi provider plugin (plugin: kimi)","hasChildren":true} +{"recordType":"path","path":"plugins.entries.kimi.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/kimi-provider Config","help":"Plugin-defined config payload for kimi.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.kimi.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/kimi-provider","hasChildren":false} +{"recordType":"path","path":"plugins.entries.kimi.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} +{"recordType":"path","path":"plugins.entries.kimi.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} {"recordType":"path","path":"plugins.entries.line","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/line","help":"OpenClaw LINE channel plugin (plugin: line)","hasChildren":true} {"recordType":"path","path":"plugins.entries.line.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/line Config","help":"Plugin-defined config payload for line.","hasChildren":false} {"recordType":"path","path":"plugins.entries.line.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/line","hasChildren":false} @@ -4168,6 +4206,11 @@ {"recordType":"path","path":"plugins.entries.memory-lancedb.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["storage"],"label":"Enable @openclaw/memory-lancedb","hasChildren":false} {"recordType":"path","path":"plugins.entries.memory-lancedb.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} {"recordType":"path","path":"plugins.entries.memory-lancedb.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.microsoft","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/microsoft-speech","help":"OpenClaw Microsoft speech plugin (plugin: microsoft)","hasChildren":true} +{"recordType":"path","path":"plugins.entries.microsoft.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"@openclaw/microsoft-speech Config","help":"Plugin-defined config payload for microsoft.","hasChildren":false} +{"recordType":"path","path":"plugins.entries.microsoft.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Enable @openclaw/microsoft-speech","hasChildren":false} +{"recordType":"path","path":"plugins.entries.microsoft.hooks","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Plugin Hook Policy","help":"Per-plugin typed hook policy controls for core-enforced safety gates. Use this to constrain high-impact hook categories without disabling the entire plugin.","hasChildren":true} +{"recordType":"path","path":"plugins.entries.microsoft.hooks.allowPromptInjection","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Allow Prompt Injection Hooks","help":"Controls whether this plugin may mutate prompts through typed hooks. Set false to block `before_prompt_build` and ignore prompt-mutating fields from legacy `before_agent_start`, while preserving legacy `modelOverride` and `providerOverride` behavior.","hasChildren":false} {"recordType":"path","path":"plugins.entries.minimax","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["performance"],"label":"@openclaw/minimax-provider","help":"OpenClaw MiniMax provider and OAuth plugin (plugin: minimax)","hasChildren":true} {"recordType":"path","path":"plugins.entries.minimax.config","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["performance"],"label":"@openclaw/minimax-provider Config","help":"Plugin-defined config payload for minimax.","hasChildren":false} {"recordType":"path","path":"plugins.entries.minimax.enabled","kind":"plugin","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["performance"],"label":"Enable @openclaw/minimax-provider","hasChildren":false} @@ -4449,7 +4492,7 @@ {"recordType":"path","path":"plugins.entries.voice-call.config.tts.openai.speed","kind":"plugin","type":"number","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"plugins.entries.voice-call.config.tts.openai.voice","kind":"plugin","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":["advanced","media"],"label":"OpenAI TTS Voice","hasChildren":false} {"recordType":"path","path":"plugins.entries.voice-call.config.tts.prefsPath","kind":"plugin","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} -{"recordType":"path","path":"plugins.entries.voice-call.config.tts.provider","kind":"plugin","type":"string","required":false,"enumValues":["openai","elevenlabs","edge"],"deprecated":false,"sensitive":false,"tags":["advanced","media"],"label":"TTS Provider Override","help":"Deep-merges with messages.tts (Edge is ignored for calls).","hasChildren":false} +{"recordType":"path","path":"plugins.entries.voice-call.config.tts.provider","kind":"plugin","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":["advanced","media"],"label":"TTS Provider Override","help":"Deep-merges with messages.tts (Microsoft is ignored for calls).","hasChildren":false} {"recordType":"path","path":"plugins.entries.voice-call.config.tts.summaryModel","kind":"plugin","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"plugins.entries.voice-call.config.tts.timeoutMs","kind":"plugin","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"plugins.entries.voice-call.config.tunnel","kind":"plugin","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} diff --git a/src/acp/translator.session-rate-limit.test.ts b/src/acp/translator.session-rate-limit.test.ts index 55446550f9f..162afe6160c 100644 --- a/src/acp/translator.session-rate-limit.test.ts +++ b/src/acp/translator.session-rate-limit.test.ts @@ -308,6 +308,7 @@ describe("acp session UX bridge behavior", () => { "low", "medium", "high", + "xhigh", "adaptive", ]); expect(result.configOptions).toEqual( diff --git a/src/plugin-sdk/index.test.ts b/src/plugin-sdk/index.test.ts index 178c0e20b22..20f685cdbd2 100644 --- a/src/plugin-sdk/index.test.ts +++ b/src/plugin-sdk/index.test.ts @@ -17,7 +17,6 @@ describe("plugin-sdk exports", () => { const forbidden = [ "chunkMarkdownText", "chunkText", - "resolveTextChunkLimit", "hasControlCommand", "isControlCommandMessage", "shouldComputeCommandAuthorized", @@ -25,9 +24,7 @@ describe("plugin-sdk exports", () => { "buildMentionRegexes", "matchesMentionPatterns", "resolveStateDir", - "loadConfig", "writeConfigFile", - "runCommandWithTimeout", "enqueueSystemEvent", "fetchRemoteMedia", "saveMediaBuffer", diff --git a/src/tts/provider-registry.ts b/src/tts/provider-registry.ts index ee60764aa4d..d1462880a99 100644 --- a/src/tts/provider-registry.ts +++ b/src/tts/provider-registry.ts @@ -7,11 +7,11 @@ import { buildElevenLabsSpeechProvider } from "./providers/elevenlabs.js"; import { buildMicrosoftSpeechProvider } from "./providers/microsoft.js"; import { buildOpenAISpeechProvider } from "./providers/openai.js"; -const BUILTIN_SPEECH_PROVIDERS: readonly SpeechProviderPlugin[] = [ - buildOpenAISpeechProvider(), - buildElevenLabsSpeechProvider(), - buildMicrosoftSpeechProvider(), -]; +const BUILTIN_SPEECH_PROVIDER_BUILDERS = [ + buildOpenAISpeechProvider, + buildElevenLabsSpeechProvider, + buildMicrosoftSpeechProvider, +] as const satisfies readonly (() => SpeechProviderPlugin)[]; function trimToUndefined(value: string | undefined): string | undefined { const trimmed = value?.trim().toLowerCase(); @@ -58,8 +58,8 @@ function buildProviderMaps(cfg?: OpenClawConfig): { } }; - for (const provider of BUILTIN_SPEECH_PROVIDERS) { - register(provider); + for (const buildProvider of BUILTIN_SPEECH_PROVIDER_BUILDERS) { + register(buildProvider()); } for (const provider of resolveSpeechProviderPluginEntries(cfg)) { register(provider); From 5fb7a1363f25c6a23eacae034a1ee36768650eee Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:53:29 +0000 Subject: [PATCH 111/187] fix: stabilize full gate --- .../bot.create-telegram-bot.test-harness.ts | 83 ++++++----- scripts/test-parallel.mjs | 86 +++++++++-- src/acp/control-plane/manager.test.ts | 9 +- src/acp/persistent-bindings.test.ts | 25 +++- src/acp/runtime/session-meta.test.ts | 8 +- src/channels/plugins/actions/actions.test.ts | 18 ++- .../plugins/whatsapp-heartbeat.test.ts | 41 +++--- src/channels/session.test.ts | 15 +- src/cli/command-secret-gateway.test.ts | 10 +- src/cli/memory-cli.test.ts | 21 +-- src/cli/pairing-cli.test.ts | 8 +- src/cli/prompt.test.ts | 33 +++-- src/config/logging.test.ts | 10 +- src/config/sessions/delivery-info.test.ts | 7 +- .../store.pruning.integration.test.ts | 15 +- ...ent.delivery-target-thread-session.test.ts | 73 +++++----- .../run.sandbox-config-preserved.test.ts | 14 +- ...runs-one-shot-main-job-disables-it.test.ts | 133 ------------------ src/infra/boundary-file-read.test.ts | 10 +- src/infra/channel-summary.test.ts | 12 +- src/infra/env.test.ts | 15 +- src/infra/exec-approval-surface.test.ts | 118 ++++++++++------ src/infra/exec-approvals-store.test.ts | 39 +++-- src/infra/net/proxy-fetch.test.ts | 17 ++- src/infra/net/ssrf.dispatcher.test.ts | 11 +- .../net/undici-global-dispatcher.test.ts | 19 ++- src/infra/openclaw-root.test.ts | 8 +- src/infra/outbound/agent-delivery.test.ts | 12 +- src/infra/outbound/channel-selection.test.ts | 23 ++- src/infra/outbound/deliver.lifecycle.test.ts | 10 +- src/infra/outbound/deliver.test.ts | 13 +- src/infra/outbound/identity.test.ts | 12 +- .../message-action-runner.media.test.ts | 24 +++- .../message-action-runner.poll.test.ts | 41 +++--- .../message-action-runner.threading.test.ts | 31 ++-- src/infra/outbound/message.channels.test.ts | 8 +- src/infra/outbound/message.test.ts | 7 +- .../outbound/outbound-send-service.test.ts | 9 +- src/infra/outbound/session-context.test.ts | 17 ++- .../outbound/target-normalization.test.ts | 63 ++++++--- src/infra/outbound/target-resolver.test.ts | 31 ++-- .../targets.channel-resolution.test.ts | 7 +- src/infra/pairing-token.test.ts | 14 +- src/infra/ports.test.ts | 13 +- src/infra/provider-usage.auth.plugin.test.ts | 6 +- src/infra/provider-usage.load.plugin.test.ts | 6 +- src/infra/restart-stale-pids.test.ts | 14 +- src/infra/restart.test.ts | 13 +- src/infra/secure-random.test.ts | 10 +- src/infra/session-maintenance-warning.test.ts | 43 +++--- src/infra/transport-ready.test.ts | 62 ++++---- src/infra/windows-task-restart.test.ts | 11 +- src/infra/wsl.test.ts | 13 +- src/media-understanding/apply.test.ts | 62 ++++---- .../providers/image.test.ts | 80 +++++------ src/media/fetch.telegram-network.test.ts | 18 ++- src/media/input-files.fetch-guard.test.ts | 10 +- src/media/store.outside-workspace.test.ts | 15 +- src/memory/batch-http.test.ts | 16 ++- src/memory/embedding-manager.test-harness.ts | 26 ++-- src/memory/embeddings-remote-fetch.test.ts | 9 +- src/memory/embeddings-voyage.test.ts | 15 +- src/memory/embeddings.test.ts | 21 ++- src/memory/index.test.ts | 9 +- src/memory/manager.atomic-reindex.test.ts | 14 +- src/memory/manager.batch.test.ts | 25 ++-- src/memory/manager.embedding-batches.test.ts | 17 +-- src/memory/manager.get-concurrency.test.ts | 18 ++- src/memory/manager.mistral-provider.test.ts | 8 +- src/memory/manager.vector-dedupe.test.ts | 11 +- src/memory/manager.watcher-config.test.ts | 13 +- src/memory/post-json.test.ts | 15 +- src/memory/test-manager-helpers.ts | 4 +- src/pairing/setup-code.test.ts | 11 +- src/plugin-sdk/outbound-media.test.ts | 13 +- src/plugins/contracts/auth.contract.test.ts | 40 ++++-- src/plugins/provider-runtime.test.ts | 73 ++++++---- src/plugins/providers.test.ts | 9 +- src/plugins/tools.optional.test.ts | 7 +- src/plugins/wired-hooks-compaction.test.ts | 34 ++--- src/process/command-queue.test.ts | 42 ++++-- src/process/exec.no-output-timer.test.ts | 11 +- src/process/exec.windows.test.ts | 10 +- src/process/kill-tree.test.ts | 7 +- src/process/supervisor/adapters/child.test.ts | 8 +- src/process/supervisor/adapters/pty.test.ts | 8 +- .../supervisor/supervisor.pty-command.test.ts | 8 +- src/security/windows-acl.test.ts | 31 ++-- src/tts/edge-tts-validation.test.ts | 11 +- src/tts/tts.test.ts | 64 ++++++--- src/utils/message-channel.ts | 48 +++++-- src/whatsapp/resolve-outbound-target.test.ts | 7 +- 92 files changed, 1381 insertions(+), 838 deletions(-) diff --git a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts index 69c0557ee3a..24f8e50b706 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts @@ -68,28 +68,59 @@ export function getUpsertChannelPairingRequestMock(): AnyAsyncMock { return upsertChannelPairingRequest; } -vi.mock("openclaw/plugin-sdk/conversation-runtime", () => ({ - readChannelAllowFromStore, - upsertChannelPairingRequest, -})); +vi.mock("openclaw/plugin-sdk/conversation-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + readChannelAllowFromStore, + upsertChannelPairingRequest, + }; +}); const skillCommandsHoisted = vi.hoisted(() => ({ listSkillCommandsForAgents: vi.fn(() => []), + replySpy: vi.fn(async (_ctx: MsgContext, opts?: GetReplyOptions) => { + await opts?.onReplyStart?.(); + return undefined; + }) as MockFn< + ( + ctx: MsgContext, + opts?: GetReplyOptions, + configOverride?: OpenClawConfig, + ) => Promise + >, })); export const listSkillCommandsForAgents = skillCommandsHoisted.listSkillCommandsForAgents; +export const replySpy = skillCommandsHoisted.replySpy; -vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ - listSkillCommandsForAgents, -})); +vi.mock("openclaw/plugin-sdk/reply-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + listSkillCommandsForAgents: skillCommandsHoisted.listSkillCommandsForAgents, + getReplyFromConfig: skillCommandsHoisted.replySpy, + __replySpy: skillCommandsHoisted.replySpy, + dispatchReplyWithBufferedBlockDispatcher: vi.fn( + async ({ ctx, replyOptions }: { ctx: MsgContext; replyOptions?: GetReplyOptions }) => { + await skillCommandsHoisted.replySpy(ctx, replyOptions); + return { queuedFinal: false }; + }, + ), + }; +}); const systemEventsHoisted = vi.hoisted(() => ({ enqueueSystemEventSpy: vi.fn(), })); export const enqueueSystemEventSpy: AnyMock = systemEventsHoisted.enqueueSystemEventSpy; -vi.mock("openclaw/plugin-sdk/infra-runtime", () => ({ - enqueueSystemEvent: enqueueSystemEventSpy, -})); +vi.mock("openclaw/plugin-sdk/infra-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + enqueueSystemEvent: systemEventsHoisted.enqueueSystemEventSpy, + }; +}); const sentMessageCacheHoisted = vi.hoisted(() => ({ wasSentByBot: vi.fn(() => false), @@ -97,7 +128,7 @@ const sentMessageCacheHoisted = vi.hoisted(() => ({ export const wasSentByBot = sentMessageCacheHoisted.wasSentByBot; vi.mock("./sent-message-cache.js", () => ({ - wasSentByBot, + wasSentByBot: sentMessageCacheHoisted.wasSentByBot, recordSentMessage: vi.fn(), clearSentMessageCache: vi.fn(), })); @@ -182,36 +213,24 @@ vi.mock("grammy", () => ({ InputFile: class {}, })); -const sequentializeMiddleware = vi.fn(); -export const sequentializeSpy: AnyMock = vi.fn(() => sequentializeMiddleware); +const runnerHoisted = vi.hoisted(() => ({ + sequentializeMiddleware: vi.fn(), + sequentializeSpy: vi.fn(), + throttlerSpy: vi.fn(() => "throttler"), +})); +export const sequentializeSpy: AnyMock = runnerHoisted.sequentializeSpy; export let sequentializeKey: ((ctx: unknown) => string) | undefined; vi.mock("@grammyjs/runner", () => ({ sequentialize: (keyFn: (ctx: unknown) => string) => { sequentializeKey = keyFn; - return sequentializeSpy(); + return runnerHoisted.sequentializeSpy(); }, })); -export const throttlerSpy: AnyMock = vi.fn(() => "throttler"); +export const throttlerSpy: AnyMock = runnerHoisted.throttlerSpy; vi.mock("@grammyjs/transformer-throttler", () => ({ - apiThrottler: () => throttlerSpy(), -})); - -export const replySpy: MockFn< - ( - ctx: MsgContext, - opts?: GetReplyOptions, - configOverride?: OpenClawConfig, - ) => Promise -> = vi.fn(async (_ctx, opts) => { - await opts?.onReplyStart?.(); - return undefined; -}); - -vi.mock("openclaw/plugin-sdk/reply-runtime", () => ({ - getReplyFromConfig: replySpy, - __replySpy: replySpy, + apiThrottler: () => runnerHoisted.throttlerSpy(), })); export const getOnHandler = (event: string) => { diff --git a/scripts/test-parallel.mjs b/scripts/test-parallel.mjs index 76a0be3b466..dd933b4e4ae 100644 --- a/scripts/test-parallel.mjs +++ b/scripts/test-parallel.mjs @@ -93,6 +93,19 @@ const unitIsolatedFilesRaw = [ "src/infra/git-commit.test.ts", ]; const unitIsolatedFiles = unitIsolatedFilesRaw.filter((file) => fs.existsSync(file)); +const unitSingletonIsolatedFilesRaw = []; +const unitSingletonIsolatedFiles = unitSingletonIsolatedFilesRaw.filter((file) => + fs.existsSync(file), +); +const unitVmForkSingletonFilesRaw = [ + "src/channels/plugins/contracts/inbound.telegram.contract.test.ts", +]; +const unitVmForkSingletonFiles = unitVmForkSingletonFilesRaw.filter((file) => fs.existsSync(file)); +const groupedUnitIsolatedFiles = unitIsolatedFiles.filter( + (file) => !unitSingletonIsolatedFiles.includes(file), +); +const channelSingletonFilesRaw = []; +const channelSingletonFiles = channelSingletonFilesRaw.filter((file) => fs.existsSync(file)); const children = new Set(); const isCI = process.env.CI === "true" || process.env.GITHUB_ACTIONS === "true"; @@ -139,20 +152,55 @@ const runs = [ "vitest.unit.config.ts", `--pool=${useVmForks ? "vmForks" : "forks"}`, ...(disableIsolation ? ["--isolate=false"] : []), - ...unitIsolatedFiles.flatMap((file) => ["--exclude", file]), + ...[ + ...unitIsolatedFiles, + ...unitSingletonIsolatedFiles, + ...unitVmForkSingletonFiles, + ].flatMap((file) => ["--exclude", file]), ], }, - { - name: "unit-isolated", + ...(groupedUnitIsolatedFiles.length > 0 + ? [ + { + name: "unit-isolated", + args: [ + "vitest", + "run", + "--config", + "vitest.unit.config.ts", + "--pool=forks", + ...groupedUnitIsolatedFiles, + ], + }, + ] + : []), + ...unitSingletonIsolatedFiles.map((file) => ({ + name: `${path.basename(file, ".test.ts")}-isolated`, args: [ "vitest", "run", "--config", "vitest.unit.config.ts", - "--pool=forks", - ...unitIsolatedFiles, + `--pool=${useVmForks ? "vmForks" : "forks"}`, + file, ], - }, + })), + ...unitVmForkSingletonFiles.map((file) => ({ + name: `${path.basename(file, ".test.ts")}-vmforks`, + args: [ + "vitest", + "run", + "--config", + "vitest.unit.config.ts", + `--pool=${useVmForks ? "vmForks" : "forks"}`, + ...(disableIsolation ? ["--isolate=false"] : []), + file, + ], + })), + ...channelSingletonFiles.map((file) => ({ + name: `${path.basename(file, ".test.ts")}-channels-isolated`, + args: ["vitest", "run", "--config", "vitest.channels.config.ts", "--pool=forks", file], + })), ] : [ { @@ -380,9 +428,24 @@ const resolveFilterMatches = (fileFilter) => { } return allKnownTestFiles.filter((file) => file.includes(normalizedFilter)); }; +const isVmForkSingletonUnitFile = (fileFilter) => unitVmForkSingletonFiles.includes(fileFilter); const createTargetedEntry = (owner, isolated, filters) => { const name = isolated ? `${owner}-isolated` : owner; const forceForks = isolated; + if (owner === "unit-vmforks") { + return { + name, + args: [ + "vitest", + "run", + "--config", + "vitest.unit.config.ts", + `--pool=${useVmForks ? "vmForks" : "forks"}`, + ...(disableIsolation ? ["--isolate=false"] : []), + ...filters, + ], + }; + } if (owner === "unit") { return { name, @@ -460,16 +523,19 @@ const targetedEntries = (() => { const groups = passthroughFileFilters.reduce((acc, fileFilter) => { const matchedFiles = resolveFilterMatches(fileFilter); if (matchedFiles.length === 0) { - const target = inferTarget(normalizeRepoPath(fileFilter)); - const key = `${target.owner}:${target.isolated ? "isolated" : "default"}`; + const normalizedFile = normalizeRepoPath(fileFilter); + const target = inferTarget(normalizedFile); + const owner = isVmForkSingletonUnitFile(normalizedFile) ? "unit-vmforks" : target.owner; + const key = `${owner}:${target.isolated ? "isolated" : "default"}`; const files = acc.get(key) ?? []; - files.push(normalizeRepoPath(fileFilter)); + files.push(normalizedFile); acc.set(key, files); return acc; } for (const matchedFile of matchedFiles) { const target = inferTarget(matchedFile); - const key = `${target.owner}:${target.isolated ? "isolated" : "default"}`; + const owner = isVmForkSingletonUnitFile(matchedFile) ? "unit-vmforks" : target.owner; + const key = `${owner}:${target.isolated ? "isolated" : "default"}`; const files = acc.get(key) ?? []; files.push(matchedFile); acc.set(key, files); diff --git a/src/acp/control-plane/manager.test.ts b/src/acp/control-plane/manager.test.ts index 8152944834c..66faa84b1d3 100644 --- a/src/acp/control-plane/manager.test.ts +++ b/src/acp/control-plane/manager.test.ts @@ -1,7 +1,6 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; import type { AcpSessionRuntimeOptions, SessionAcpMeta } from "../../config/sessions/types.js"; -import { AcpRuntimeError } from "../runtime/errors.js"; import type { AcpRuntime, AcpRuntimeCapabilities } from "../runtime/types.js"; const hoisted = vi.hoisted(() => { @@ -32,7 +31,8 @@ vi.mock("../runtime/registry.js", async (importOriginal) => { }; }); -const { AcpSessionManager } = await import("./manager.js"); +let AcpSessionManager: typeof import("./manager.js").AcpSessionManager; +let AcpRuntimeError: typeof import("../runtime/errors.js").AcpRuntimeError; const baseCfg = { acp: { @@ -146,7 +146,10 @@ function extractRuntimeOptionsFromUpserts(): Array { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ AcpSessionManager } = await import("./manager.js")); + ({ AcpRuntimeError } = await import("../runtime/errors.js")); hoisted.listAcpSessionEntriesMock.mockReset().mockResolvedValue([]); hoisted.readAcpSessionEntryMock.mockReset(); hoisted.upsertAcpSessionMetaMock.mockReset().mockResolvedValue(null); diff --git a/src/acp/persistent-bindings.test.ts b/src/acp/persistent-bindings.test.ts index 147c4a455c9..cb815b9d948 100644 --- a/src/acp/persistent-bindings.test.ts +++ b/src/acp/persistent-bindings.test.ts @@ -27,13 +27,13 @@ vi.mock("./runtime/session-meta.js", () => ({ readAcpSessionEntry: sessionMetaMocks.readAcpSessionEntry, })); -import { - buildConfiguredAcpSessionKey, - ensureConfiguredAcpBindingSession, - resetAcpSessionInPlace, - resolveConfiguredAcpBindingRecord, - resolveConfiguredAcpBindingSpecBySessionKey, -} from "./persistent-bindings.js"; +type PersistentBindingsModule = typeof import("./persistent-bindings.js"); + +let buildConfiguredAcpSessionKey: PersistentBindingsModule["buildConfiguredAcpSessionKey"]; +let ensureConfiguredAcpBindingSession: PersistentBindingsModule["ensureConfiguredAcpBindingSession"]; +let resetAcpSessionInPlace: PersistentBindingsModule["resetAcpSessionInPlace"]; +let resolveConfiguredAcpBindingRecord: PersistentBindingsModule["resolveConfiguredAcpBindingRecord"]; +let resolveConfiguredAcpBindingSpecBySessionKey: PersistentBindingsModule["resolveConfiguredAcpBindingSpecBySessionKey"]; type ConfiguredBinding = NonNullable[number]; type BindingRecordInput = Parameters[0]; @@ -184,6 +184,17 @@ beforeEach(() => { sessionMetaMocks.readAcpSessionEntry.mockReset().mockReturnValue(undefined); }); +beforeEach(async () => { + vi.resetModules(); + ({ + buildConfiguredAcpSessionKey, + ensureConfiguredAcpBindingSession, + resetAcpSessionInPlace, + resolveConfiguredAcpBindingRecord, + resolveConfiguredAcpBindingSpecBySessionKey, + } = await import("./persistent-bindings.js")); +}); + describe("resolveConfiguredAcpBindingRecord", () => { it("resolves discord channel ACP binding from top-level typed bindings", () => { const cfg = createCfgWithBindings([ diff --git a/src/acp/runtime/session-meta.test.ts b/src/acp/runtime/session-meta.test.ts index f9a0f399f81..b5279d6f0ac 100644 --- a/src/acp/runtime/session-meta.test.ts +++ b/src/acp/runtime/session-meta.test.ts @@ -22,10 +22,14 @@ vi.mock("../../config/sessions.js", async () => { }; }); -const { listAcpSessionEntries } = await import("./session-meta.js"); +type SessionMetaModule = typeof import("./session-meta.js"); + +let listAcpSessionEntries: SessionMetaModule["listAcpSessionEntries"]; describe("listAcpSessionEntries", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ listAcpSessionEntries } = await import("./session-meta.js")); vi.clearAllMocks(); }); diff --git a/src/channels/plugins/actions/actions.test.ts b/src/channels/plugins/actions/actions.test.ts index cd33be0a3e2..322e0f618f4 100644 --- a/src/channels/plugins/actions/actions.test.ts +++ b/src/channels/plugins/actions/actions.test.ts @@ -24,11 +24,11 @@ vi.mock("../../../agents/tools/slack-actions.js", () => ({ handleSlackAction, })); -const { discordMessageActions } = await import("./discord.js"); -const { handleDiscordMessageAction } = await import("./discord/handle-action.js"); -const { telegramMessageActions } = await import("./telegram.js"); -const { signalMessageActions } = await import("./signal.js"); -const { createSlackActions } = await import("../slack.actions.js"); +let discordMessageActions: typeof import("./discord.js").discordMessageActions; +let handleDiscordMessageAction: typeof import("./discord/handle-action.js").handleDiscordMessageAction; +let telegramMessageActions: typeof import("./telegram.js").telegramMessageActions; +let signalMessageActions: typeof import("./signal.js").signalMessageActions; +let createSlackActions: typeof import("../slack.actions.js").createSlackActions; function telegramCfg(): OpenClawConfig { return { channels: { telegram: { botToken: "tok" } } } as OpenClawConfig; @@ -191,7 +191,13 @@ async function expectSlackSendRejected(params: Record, error: R expect(handleSlackAction).not.toHaveBeenCalled(); } -beforeEach(() => { +beforeEach(async () => { + vi.resetModules(); + ({ discordMessageActions } = await import("./discord.js")); + ({ handleDiscordMessageAction } = await import("./discord/handle-action.js")); + ({ telegramMessageActions } = await import("./telegram.js")); + ({ signalMessageActions } = await import("./signal.js")); + ({ createSlackActions } = await import("../slack.actions.js")); vi.clearAllMocks(); }); diff --git a/src/channels/plugins/whatsapp-heartbeat.test.ts b/src/channels/plugins/whatsapp-heartbeat.test.ts index f4b0945a400..3cc6531eca1 100644 --- a/src/channels/plugins/whatsapp-heartbeat.test.ts +++ b/src/channels/plugins/whatsapp-heartbeat.test.ts @@ -1,18 +1,12 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; - -vi.mock("../../config/sessions.js", () => ({ - loadSessionStore: vi.fn(), - resolveStorePath: vi.fn(() => "/tmp/test-sessions.json"), -})); - -vi.mock("../../pairing/pairing-store.js", () => ({ - readChannelAllowFromStoreSync: vi.fn(() => []), -})); - import type { OpenClawConfig } from "../../config/config.js"; -import { loadSessionStore } from "../../config/sessions.js"; -import { readChannelAllowFromStoreSync } from "../../pairing/pairing-store.js"; -import { resolveWhatsAppHeartbeatRecipients } from "./whatsapp-heartbeat.js"; + +const loadSessionStoreMock = vi.hoisted(() => vi.fn()); +const readChannelAllowFromStoreSyncMock = vi.hoisted(() => vi.fn<() => string[]>(() => [])); + +type WhatsAppHeartbeatModule = typeof import("./whatsapp-heartbeat.js"); + +let resolveWhatsAppHeartbeatRecipients: WhatsAppHeartbeatModule["resolveWhatsAppHeartbeatRecipients"]; function makeCfg(overrides?: Partial): OpenClawConfig { return { @@ -23,12 +17,12 @@ function makeCfg(overrides?: Partial): OpenClawConfig { } describe("resolveWhatsAppHeartbeatRecipients", () => { - function setSessionStore(store: ReturnType) { - vi.mocked(loadSessionStore).mockReturnValue(store); + function setSessionStore(store: Record) { + loadSessionStoreMock.mockReturnValue(store); } function setAllowFromStore(entries: string[]) { - vi.mocked(readChannelAllowFromStoreSync).mockReturnValue(entries); + readChannelAllowFromStoreSyncMock.mockReturnValue(entries); } function resolveWith( @@ -45,9 +39,18 @@ describe("resolveWhatsAppHeartbeatRecipients", () => { setAllowFromStore(["+15550000001"]); } - beforeEach(() => { - vi.mocked(loadSessionStore).mockClear(); - vi.mocked(readChannelAllowFromStoreSync).mockClear(); + beforeEach(async () => { + vi.resetModules(); + loadSessionStoreMock.mockReset(); + readChannelAllowFromStoreSyncMock.mockReset(); + vi.doMock("../../config/sessions.js", () => ({ + loadSessionStore: loadSessionStoreMock, + resolveStorePath: vi.fn(() => "/tmp/test-sessions.json"), + })); + vi.doMock("../../pairing/pairing-store.js", () => ({ + readChannelAllowFromStoreSync: readChannelAllowFromStoreSyncMock, + })); + ({ resolveWhatsAppHeartbeatRecipients } = await import("./whatsapp-heartbeat.js")); setAllowFromStore([]); }); diff --git a/src/channels/session.test.ts b/src/channels/session.test.ts index b1415bbb53d..530346bddb4 100644 --- a/src/channels/session.test.ts +++ b/src/channels/session.test.ts @@ -9,6 +9,10 @@ vi.mock("../config/sessions.js", () => ({ updateLastRoute: (args: unknown) => updateLastRouteMock(args), })); +type SessionModule = typeof import("./session.js"); + +let recordInboundSession: SessionModule["recordInboundSession"]; + describe("recordInboundSession", () => { const ctx: MsgContext = { Provider: "telegram", @@ -17,14 +21,14 @@ describe("recordInboundSession", () => { OriginatingTo: "telegram:1234", }; - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ recordInboundSession } = await import("./session.js")); recordSessionMetaFromInboundMock.mockClear(); updateLastRouteMock.mockClear(); }); it("does not pass ctx when updating a different session key", async () => { - const { recordInboundSession } = await import("./session.js"); - await recordInboundSession({ storePath: "/tmp/openclaw-session-store.json", sessionKey: "agent:main:telegram:1234:thread:42", @@ -50,8 +54,6 @@ describe("recordInboundSession", () => { }); it("passes ctx when updating the same session key", async () => { - const { recordInboundSession } = await import("./session.js"); - await recordInboundSession({ storePath: "/tmp/openclaw-session-store.json", sessionKey: "agent:main:telegram:1234:thread:42", @@ -77,8 +79,6 @@ describe("recordInboundSession", () => { }); it("normalizes mixed-case session keys before recording and route updates", async () => { - const { recordInboundSession } = await import("./session.js"); - await recordInboundSession({ storePath: "/tmp/openclaw-session-store.json", sessionKey: "Agent:Main:Telegram:1234:Thread:42", @@ -105,7 +105,6 @@ describe("recordInboundSession", () => { }); it("skips last-route updates when main DM owner pin mismatches sender", async () => { - const { recordInboundSession } = await import("./session.js"); const onSkip = vi.fn(); await recordInboundSession({ diff --git a/src/cli/command-secret-gateway.test.ts b/src/cli/command-secret-gateway.test.ts index 6a2dff29582..87e171d7ce4 100644 --- a/src/cli/command-secret-gateway.test.ts +++ b/src/cli/command-secret-gateway.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; const callGateway = vi.fn(); @@ -7,7 +7,13 @@ vi.mock("../gateway/call.js", () => ({ callGateway, })); -const { resolveCommandSecretRefsViaGateway } = await import("./command-secret-gateway.js"); +let resolveCommandSecretRefsViaGateway: typeof import("./command-secret-gateway.js").resolveCommandSecretRefsViaGateway; + +beforeEach(async () => { + vi.resetModules(); + callGateway.mockReset(); + ({ resolveCommandSecretRefsViaGateway } = await import("./command-secret-gateway.js")); +}); describe("resolveCommandSecretRefsViaGateway", () => { function makeTalkApiKeySecretRefConfig(envKey: string): OpenClawConfig { diff --git a/src/cli/memory-cli.test.ts b/src/cli/memory-cli.test.ts index 2405055adc6..3738616cb2c 100644 --- a/src/cli/memory-cli.test.ts +++ b/src/cli/memory-cli.test.ts @@ -2,15 +2,17 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { Command } from "commander"; -import { afterEach, beforeAll, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -const getMemorySearchManager = vi.fn(); -const loadConfig = vi.fn(() => ({})); -const resolveDefaultAgentId = vi.fn(() => "main"); -const resolveCommandSecretRefsViaGateway = vi.fn(async ({ config }: { config: unknown }) => ({ - resolvedConfig: config, - diagnostics: [] as string[], -})); +const getMemorySearchManager = vi.hoisted(() => vi.fn()); +const loadConfig = vi.hoisted(() => vi.fn(() => ({}))); +const resolveDefaultAgentId = vi.hoisted(() => vi.fn(() => "main")); +const resolveCommandSecretRefsViaGateway = vi.hoisted(() => + vi.fn(async ({ config }: { config: unknown }) => ({ + resolvedConfig: config, + diagnostics: [] as string[], + })), +); vi.mock("../memory/index.js", () => ({ getMemorySearchManager, @@ -33,7 +35,8 @@ let defaultRuntime: typeof import("../runtime.js").defaultRuntime; let isVerbose: typeof import("../globals.js").isVerbose; let setVerbose: typeof import("../globals.js").setVerbose; -beforeAll(async () => { +beforeEach(async () => { + vi.resetModules(); ({ registerMemoryCli } = await import("./memory-cli.js")); ({ defaultRuntime } = await import("../runtime.js")); ({ isVerbose, setVerbose } = await import("../globals.js")); diff --git a/src/cli/pairing-cli.test.ts b/src/cli/pairing-cli.test.ts index 97d9c9c7751..c05cdb61050 100644 --- a/src/cli/pairing-cli.test.ts +++ b/src/cli/pairing-cli.test.ts @@ -1,5 +1,5 @@ import { Command } from "commander"; -import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const listChannelPairingRequests = vi.fn(); const approveChannelPairingCode = vi.fn(); @@ -47,11 +47,9 @@ vi.mock("../config/config.js", () => ({ describe("pairing cli", () => { let registerPairingCli: typeof import("./pairing-cli.js").registerPairingCli; - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); ({ registerPairingCli } = await import("./pairing-cli.js")); - }); - - beforeEach(() => { listChannelPairingRequests.mockClear(); listChannelPairingRequests.mockResolvedValue([]); approveChannelPairingCode.mockClear(); diff --git a/src/cli/prompt.test.ts b/src/cli/prompt.test.ts index da5843dcbda..ee68e646700 100644 --- a/src/cli/prompt.test.ts +++ b/src/cli/prompt.test.ts @@ -1,12 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; -import { isYes, setVerbose, setYes } from "../globals.js"; - -vi.mock("node:readline/promises", () => { - const question = vi.fn(async () => ""); - const close = vi.fn(); - const createInterface = vi.fn(() => ({ question, close })); - return { default: { createInterface } }; -}); +import { beforeEach, describe, expect, it, vi } from "vitest"; type ReadlineMock = { default: { @@ -17,8 +9,27 @@ type ReadlineMock = { }; }; -const { promptYesNo } = await import("./prompt.js"); -const readline = (await import("node:readline/promises")) as unknown as ReadlineMock; +type PromptModule = typeof import("./prompt.js"); +type GlobalsModule = typeof import("../globals.js"); + +let promptYesNo: PromptModule["promptYesNo"]; +let readline: ReadlineMock; +let isYes: GlobalsModule["isYes"]; +let setVerbose: GlobalsModule["setVerbose"]; +let setYes: GlobalsModule["setYes"]; + +beforeEach(async () => { + vi.resetModules(); + vi.doMock("node:readline/promises", () => { + const question = vi.fn(async () => ""); + const close = vi.fn(); + const createInterface = vi.fn(() => ({ question, close })); + return { default: { createInterface } }; + }); + ({ promptYesNo } = await import("./prompt.js")); + ({ isYes, setVerbose, setYes } = await import("../globals.js")); + readline = (await import("node:readline/promises")) as unknown as ReadlineMock; +}); describe("promptYesNo", () => { it("returns true when global --yes is set", async () => { diff --git a/src/config/logging.test.ts b/src/config/logging.test.ts index 6c55961d80d..e410c3f81ba 100644 --- a/src/config/logging.test.ts +++ b/src/config/logging.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const mocks = vi.hoisted(() => ({ createConfigIO: vi.fn().mockReturnValue({ @@ -10,7 +10,13 @@ vi.mock("./io.js", () => ({ createConfigIO: mocks.createConfigIO, })); -import { formatConfigPath, logConfigUpdated } from "./logging.js"; +let formatConfigPath: typeof import("./logging.js").formatConfigPath; +let logConfigUpdated: typeof import("./logging.js").logConfigUpdated; + +beforeEach(async () => { + vi.resetModules(); + ({ formatConfigPath, logConfigUpdated } = await import("./logging.js")); +}); describe("config logging", () => { it("formats the live config path when no explicit path is provided", () => { diff --git a/src/config/sessions/delivery-info.test.ts b/src/config/sessions/delivery-info.test.ts index 23717338ea3..2f315fd807e 100644 --- a/src/config/sessions/delivery-info.test.ts +++ b/src/config/sessions/delivery-info.test.ts @@ -17,7 +17,8 @@ vi.mock("./store.js", () => ({ loadSessionStore: () => storeState.store, })); -import { extractDeliveryInfo, parseSessionThreadInfo } from "./delivery-info.js"; +let extractDeliveryInfo: typeof import("./delivery-info.js").extractDeliveryInfo; +let parseSessionThreadInfo: typeof import("./delivery-info.js").parseSessionThreadInfo; const buildEntry = (deliveryContext: SessionEntry["deliveryContext"]): SessionEntry => ({ sessionId: "session-1", @@ -25,8 +26,10 @@ const buildEntry = (deliveryContext: SessionEntry["deliveryContext"]): SessionEn deliveryContext, }); -beforeEach(() => { +beforeEach(async () => { + vi.resetModules(); storeState.store = {}; + ({ extractDeliveryInfo, parseSessionThreadInfo } = await import("./delivery-info.js")); }); describe("extractDeliveryInfo", () => { diff --git a/src/config/sessions/store.pruning.integration.test.ts b/src/config/sessions/store.pruning.integration.test.ts index d5cf106c520..3fde5236294 100644 --- a/src/config/sessions/store.pruning.integration.test.ts +++ b/src/config/sessions/store.pruning.integration.test.ts @@ -3,15 +3,19 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; -import { clearSessionStoreCacheForTest, loadSessionStore, saveSessionStore } from "./store.js"; import type { SessionEntry } from "./types.js"; // Keep integration tests deterministic: never read a real openclaw.json. vi.mock("../config.js", () => ({ loadConfig: vi.fn().mockReturnValue({}), })); -const { loadConfig } = await import("../config.js"); -const mockLoadConfig = vi.mocked(loadConfig) as ReturnType; + +type StoreModule = typeof import("./store.js"); + +let clearSessionStoreCacheForTest: StoreModule["clearSessionStoreCacheForTest"]; +let loadSessionStore: StoreModule["loadSessionStore"]; +let saveSessionStore: StoreModule["saveSessionStore"]; +let mockLoadConfig: ReturnType; const DAY_MS = 24 * 60 * 60 * 1000; @@ -77,6 +81,11 @@ describe("Integration: saveSessionStore with pruning", () => { }); beforeEach(async () => { + vi.resetModules(); + ({ clearSessionStoreCacheForTest, loadSessionStore, saveSessionStore } = + await import("./store.js")); + const { loadConfig } = await import("../config.js"); + mockLoadConfig = vi.mocked(loadConfig) as ReturnType; testDir = await createCaseDir("pruning-integ"); storePath = path.join(testDir, "sessions.json"); savedCacheTtl = process.env.OPENCLAW_SESSION_CACHE_TTL_MS; diff --git a/src/cron/isolated-agent.delivery-target-thread-session.test.ts b/src/cron/isolated-agent.delivery-target-thread-session.test.ts index 51f9c645a03..3a4537b4929 100644 --- a/src/cron/isolated-agent.delivery-target-thread-session.test.ts +++ b/src/cron/isolated-agent.delivery-target-thread-session.test.ts @@ -1,44 +1,51 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import { parseTelegramTarget } from "../../extensions/telegram/src/targets.js"; import type { OpenClawConfig } from "../config/config.js"; // Mock session store so we can control what entries exist. const mockStore: Record> = {}; -vi.mock("../config/sessions.js", () => ({ - loadSessionStore: vi.fn((storePath: string) => mockStore[storePath] ?? {}), - resolveAgentMainSessionKey: vi.fn(({ agentId }: { agentId: string }) => `agent:${agentId}:main`), - resolveStorePath: vi.fn((_store: unknown, _opts: unknown) => "/mock/store.json"), -})); +type DeliveryTargetModule = typeof import("./isolated-agent/delivery-target.js"); -// Mock channel-selection to avoid real config resolution. -vi.mock("../infra/outbound/channel-selection.js", () => ({ - resolveMessageChannelSelection: vi.fn(async () => ({ channel: "telegram" })), -})); +let resolveDeliveryTarget: DeliveryTargetModule["resolveDeliveryTarget"]; -// Minimal mock for channel plugins (Telegram resolveTarget is an identity). -vi.mock("../channels/plugins/index.js", () => ({ - getChannelPlugin: vi.fn(() => ({ - meta: { label: "Telegram" }, - config: {}, - messaging: { - parseExplicitTarget: ({ raw }: { raw: string }) => { - const target = parseTelegramTarget(raw); - return { - to: target.chatId, - threadId: target.messageThreadId, - chatType: target.chatType === "unknown" ? undefined : target.chatType, - }; +beforeEach(async () => { + vi.resetModules(); + for (const key of Object.keys(mockStore)) { + delete mockStore[key]; + } + vi.doMock("../config/sessions.js", () => ({ + loadSessionStore: vi.fn((storePath: string) => mockStore[storePath] ?? {}), + resolveAgentMainSessionKey: vi.fn( + ({ agentId }: { agentId: string }) => `agent:${agentId}:main`, + ), + resolveStorePath: vi.fn((_store: unknown, _opts: unknown) => "/mock/store.json"), + })); + vi.doMock("../infra/outbound/channel-selection.js", () => ({ + resolveMessageChannelSelection: vi.fn(async () => ({ channel: "telegram" })), + })); + vi.doMock("../channels/plugins/index.js", () => ({ + getChannelPlugin: vi.fn(() => ({ + meta: { label: "Telegram" }, + config: {}, + messaging: { + parseExplicitTarget: ({ raw }: { raw: string }) => { + const target = parseTelegramTarget(raw); + return { + to: target.chatId, + threadId: target.messageThreadId, + chatType: target.chatType === "unknown" ? undefined : target.chatType, + }; + }, }, - }, - outbound: { - resolveTarget: ({ to }: { to?: string }) => - to ? { ok: true, to } : { ok: false, error: new Error("missing") }, - }, - })), - normalizeChannelId: vi.fn((id: string) => id), -})); - -const { resolveDeliveryTarget } = await import("./isolated-agent/delivery-target.js"); + outbound: { + resolveTarget: ({ to }: { to?: string }) => + to ? { ok: true, to } : { ok: false, error: new Error("missing") }, + }, + })), + normalizeChannelId: vi.fn((id: string) => id), + })); + ({ resolveDeliveryTarget } = await import("./isolated-agent/delivery-target.js")); +}); describe("resolveDeliveryTarget thread session lookup", () => { const cfg: OpenClawConfig = {}; diff --git a/src/cron/isolated-agent/run.sandbox-config-preserved.test.ts b/src/cron/isolated-agent/run.sandbox-config-preserved.test.ts index edaee62daa6..d953185c369 100644 --- a/src/cron/isolated-agent/run.sandbox-config-preserved.test.ts +++ b/src/cron/isolated-agent/run.sandbox-config-preserved.test.ts @@ -1,4 +1,4 @@ -import { afterEach, beforeEach, describe, expect, it } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { clearFastTestEnv, loadRunCronIsolatedAgentTurn, @@ -8,8 +8,11 @@ import { runWithModelFallbackMock, } from "./run.test-harness.js"; -const runCronIsolatedAgentTurn = await loadRunCronIsolatedAgentTurn(); -const { resolveSandboxConfigForAgent } = await import("../../agents/sandbox/config.js"); +type RunModule = typeof import("./run.js"); +type SandboxConfigModule = typeof import("../../agents/sandbox/config.js"); + +let runCronIsolatedAgentTurn: RunModule["runCronIsolatedAgentTurn"]; +let resolveSandboxConfigForAgent: SandboxConfigModule["resolveSandboxConfigForAgent"]; function makeJob(overrides?: Record) { return { @@ -82,7 +85,10 @@ function expectDefaultSandboxPreserved( describe("runCronIsolatedAgentTurn sandbox config preserved", () => { let previousFastTestEnv: string | undefined; - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + runCronIsolatedAgentTurn = await loadRunCronIsolatedAgentTurn(); + ({ resolveSandboxConfigForAgent } = await import("../../agents/sandbox/config.js")); previousFastTestEnv = clearFastTestEnv(); resetRunCronIsolatedAgentTurnHarness(); }); diff --git a/src/cron/service.runs-one-shot-main-job-disables-it.test.ts b/src/cron/service.runs-one-shot-main-job-disables-it.test.ts index 75ffb262d4d..7b0e13e8cde 100644 --- a/src/cron/service.runs-one-shot-main-job-disables-it.test.ts +++ b/src/cron/service.runs-one-shot-main-job-disables-it.test.ts @@ -4,7 +4,6 @@ import type { HeartbeatRunResult } from "../infra/heartbeat-wake.js"; import type { CronEvent, CronServiceDeps } from "./service.js"; import { CronService } from "./service.js"; import { createDeferred, createNoopLogger, installCronTestHooks } from "./service.test-harness.js"; -import { loadCronStore } from "./store.js"; const noopLogger = createNoopLogger(); installCronTestHooks({ logger: noopLogger }); @@ -60,10 +59,6 @@ async function makeStorePath() { return { storePath, cleanup: async () => {} }; } -function writeStoreFile(storePath: string, payload: unknown) { - setFile(storePath, JSON.stringify(payload, null, 2)); -} - vi.mock("node:fs", async (importOriginal) => { const actual = await importOriginal(); const pathMod = await import("node:path"); @@ -415,14 +410,6 @@ async function createMainOneShotJobHarness(params: { name: string; deleteAfterRu return { ...harness, atMs, job }; } -async function loadLegacyDeliveryMigrationByPayload(params: { - id: string; - payload: { provider?: string; channel?: string }; -}) { - const rawJob = createLegacyDeliveryMigrationJob(params); - return loadLegacyDeliveryMigration(rawJob); -} - async function expectNoMainSummaryForIsolatedRun(params: { runIsolatedAgentJob: CronServiceDeps["runIsolatedAgentJob"]; name: string; @@ -439,43 +426,6 @@ async function expectNoMainSummaryForIsolatedRun(params: { await stopCronAndCleanup(cron, store); } -function createLegacyDeliveryMigrationJob(options: { - id: string; - payload: { provider?: string; channel?: string }; -}) { - return { - id: options.id, - name: "legacy", - enabled: true, - createdAtMs: Date.now(), - updatedAtMs: Date.now(), - schedule: { kind: "cron", expr: "* * * * *" }, - sessionTarget: "isolated", - wakeMode: "now", - payload: { - kind: "agentTurn", - message: "hi", - deliver: true, - ...options.payload, - to: "7200373102", - }, - state: {}, - }; -} - -async function loadLegacyDeliveryMigration(rawJob: Record) { - ensureDir(fixturesRoot); - const store = await makeStorePath(); - writeStoreFile(store.storePath, { version: 1, jobs: [rawJob] }); - - const cron = createStartedCronService(store.storePath); - await cron.start(); - cron.stop(); - const loaded = await loadCronStore(store.storePath); - const job = loaded.jobs.find((j) => j.id === rawJob.id); - return { store, cron, job }; -} - describe("CronService", () => { it("runs a one-shot main job and disables it after success when requested", async () => { const { store, cron, enqueueSystemEvent, requestHeartbeatNow, events, atMs, job } = @@ -658,33 +608,6 @@ describe("CronService", () => { expect(runIsolatedAgentJob).toHaveBeenCalledTimes(1); }); - it("migrates legacy payload.provider to payload.channel on load", async () => { - const { store, cron, job } = await loadLegacyDeliveryMigrationByPayload({ - id: "legacy-1", - payload: { provider: " TeLeGrAm " }, - }); - // Legacy delivery fields are migrated to the top-level delivery object - const delivery = job?.delivery as unknown as Record; - expect(delivery?.channel).toBe("telegram"); - const payload = job?.payload as unknown as Record; - expect("provider" in payload).toBe(false); - expect("channel" in payload).toBe(false); - - await stopCronAndCleanup(cron, store); - }); - - it("canonicalizes payload.channel casing on load", async () => { - const { store, cron, job } = await loadLegacyDeliveryMigrationByPayload({ - id: "legacy-2", - payload: { channel: "Telegram" }, - }); - // Legacy delivery fields are migrated to the top-level delivery object - const delivery = job?.delivery as unknown as Record; - expect(delivery?.channel).toBe("telegram"); - - await stopCronAndCleanup(cron, store); - }); - it("does not post a fallback main summary when an isolated job errors", async () => { const runIsolatedAgentJob = vi.fn(async () => ({ status: "error" as const, @@ -764,60 +687,4 @@ describe("CronService", () => { cron.stop(); await store.cleanup(); }); - - it("skips invalid main jobs with agentTurn payloads from disk", async () => { - ensureDir(fixturesRoot); - const store = await makeStorePath(); - const enqueueSystemEvent = vi.fn(); - const requestHeartbeatNow = vi.fn(); - const events = createCronEventHarness(); - - const atMs = Date.parse("2025-12-13T00:00:01.000Z"); - writeStoreFile(store.storePath, { - version: 1, - jobs: [ - { - id: "job-1", - enabled: true, - createdAtMs: Date.parse("2025-12-13T00:00:00.000Z"), - updatedAtMs: Date.parse("2025-12-13T00:00:00.000Z"), - schedule: { kind: "at", at: new Date(atMs).toISOString() }, - sessionTarget: "main", - wakeMode: "now", - payload: { kind: "agentTurn", message: "bad" }, - state: {}, - }, - ], - }); - - const cron = new CronService({ - storePath: store.storePath, - cronEnabled: true, - log: noopLogger, - enqueueSystemEvent, - requestHeartbeatNow, - runIsolatedAgentJob: vi.fn(async (_params: { job: unknown; message: string }) => ({ - status: "ok", - })) as unknown as CronServiceDeps["runIsolatedAgentJob"], - onEvent: events.onEvent, - }); - - await cron.start(); - - vi.setSystemTime(new Date("2025-12-13T00:00:01.000Z")); - await vi.runOnlyPendingTimersAsync(); - await events.waitFor( - (evt) => evt.jobId === "job-1" && evt.action === "finished" && evt.status === "skipped", - ); - - expect(enqueueSystemEvent).not.toHaveBeenCalled(); - expect(requestHeartbeatNow).not.toHaveBeenCalled(); - - const jobs = await cron.list({ includeDisabled: true }); - expect(jobs[0]?.state.lastStatus).toBe("skipped"); - expect(jobs[0]?.state.lastError).toMatch(/main job requires/i); - - cron.stop(); - await store.cleanup(); - }); }); diff --git a/src/infra/boundary-file-read.test.ts b/src/infra/boundary-file-read.test.ts index 2dceb0cb06a..8829fec80b8 100644 --- a/src/infra/boundary-file-read.test.ts +++ b/src/infra/boundary-file-read.test.ts @@ -14,11 +14,15 @@ vi.mock("./safe-open-sync.js", () => ({ openVerifiedFileSync: (...args: unknown[]) => openVerifiedFileSyncMock(...args), })); -const { canUseBoundaryFileOpen, openBoundaryFile, openBoundaryFileSync } = - await import("./boundary-file-read.js"); +let canUseBoundaryFileOpen: typeof import("./boundary-file-read.js").canUseBoundaryFileOpen; +let openBoundaryFile: typeof import("./boundary-file-read.js").openBoundaryFile; +let openBoundaryFileSync: typeof import("./boundary-file-read.js").openBoundaryFileSync; describe("boundary-file-read", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ canUseBoundaryFileOpen, openBoundaryFile, openBoundaryFileSync } = + await import("./boundary-file-read.js")); resolveBoundaryPathSyncMock.mockReset(); resolveBoundaryPathMock.mockReset(); openVerifiedFileSyncMock.mockReset(); diff --git a/src/infra/channel-summary.test.ts b/src/infra/channel-summary.test.ts index c0fc17ba255..12cfa8bbbae 100644 --- a/src/infra/channel-summary.test.ts +++ b/src/infra/channel-summary.test.ts @@ -1,12 +1,18 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import type { ChannelPlugin } from "../channels/plugins/types.js"; vi.mock("../channels/plugins/index.js", () => ({ listChannelPlugins: vi.fn(), })); -const { buildChannelSummary } = await import("./channel-summary.js"); -const { listChannelPlugins } = await import("../channels/plugins/index.js"); +let buildChannelSummary: typeof import("./channel-summary.js").buildChannelSummary; +let listChannelPlugins: typeof import("../channels/plugins/index.js").listChannelPlugins; + +beforeEach(async () => { + vi.resetModules(); + ({ buildChannelSummary } = await import("./channel-summary.js")); + ({ listChannelPlugins } = await import("../channels/plugins/index.js")); +}); function makeSlackHttpSummaryPlugin(): ChannelPlugin { return { diff --git a/src/infra/env.test.ts b/src/infra/env.test.ts index 5ee0af072fb..7cfac44bb86 100644 --- a/src/infra/env.test.ts +++ b/src/infra/env.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import { withEnv } from "../test-utils/env.js"; const loggerMocks = vi.hoisted(() => ({ @@ -11,7 +11,18 @@ vi.mock("../logging/subsystem.js", () => ({ }), })); -import { isTruthyEnvValue, logAcceptedEnvOption, normalizeEnv, normalizeZaiEnv } from "./env.js"; +type EnvModule = typeof import("./env.js"); + +let isTruthyEnvValue: EnvModule["isTruthyEnvValue"]; +let logAcceptedEnvOption: EnvModule["logAcceptedEnvOption"]; +let normalizeEnv: EnvModule["normalizeEnv"]; +let normalizeZaiEnv: EnvModule["normalizeZaiEnv"]; + +beforeEach(async () => { + vi.resetModules(); + ({ isTruthyEnvValue, logAcceptedEnvOption, normalizeEnv, normalizeZaiEnv } = + await import("./env.js")); +}); describe("normalizeZaiEnv", () => { it("copies Z_AI_API_KEY to ZAI_API_KEY when missing", () => { diff --git a/src/infra/exec-approval-surface.test.ts b/src/infra/exec-approval-surface.test.ts index c4b959c5042..3e59d968670 100644 --- a/src/infra/exec-approval-surface.test.ts +++ b/src/infra/exec-approval-surface.test.ts @@ -5,51 +5,14 @@ const getChannelPluginMock = vi.hoisted(() => vi.fn()); const listChannelPluginsMock = vi.hoisted(() => vi.fn()); const normalizeMessageChannelMock = vi.hoisted(() => vi.fn()); -vi.mock("../config/config.js", () => ({ - loadConfig: (...args: unknown[]) => loadConfigMock(...args), -})); +type ExecApprovalSurfaceModule = typeof import("./exec-approval-surface.js"); -vi.mock("../channels/plugins/index.js", () => ({ - getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), - listChannelPlugins: (...args: unknown[]) => listChannelPluginsMock(...args), -})); - -vi.mock("../../extensions/discord/src/channel.js", () => ({ - discordPlugin: {}, -})); - -vi.mock("../../extensions/telegram/src/channel.js", () => ({ - telegramPlugin: {}, -})); - -vi.mock("../../extensions/slack/src/channel.js", () => ({ - slackPlugin: {}, -})); - -vi.mock("../../extensions/whatsapp/src/channel.js", () => ({ - whatsappPlugin: {}, -})); - -vi.mock("../../extensions/signal/src/channel.js", () => ({ - signalPlugin: {}, -})); - -vi.mock("../../extensions/imessage/src/channel.js", () => ({ - imessagePlugin: {}, -})); - -vi.mock("../utils/message-channel.js", () => ({ - INTERNAL_MESSAGE_CHANNEL: "web", - normalizeMessageChannel: (...args: unknown[]) => normalizeMessageChannelMock(...args), -})); - -import { - hasConfiguredExecApprovalDmRoute, - resolveExecApprovalInitiatingSurfaceState, -} from "./exec-approval-surface.js"; +let hasConfiguredExecApprovalDmRoute: ExecApprovalSurfaceModule["hasConfiguredExecApprovalDmRoute"]; +let resolveExecApprovalInitiatingSurfaceState: ExecApprovalSurfaceModule["resolveExecApprovalInitiatingSurfaceState"]; describe("resolveExecApprovalInitiatingSurfaceState", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); loadConfigMock.mockReset(); getChannelPluginMock.mockReset(); listChannelPluginsMock.mockReset(); @@ -57,6 +20,37 @@ describe("resolveExecApprovalInitiatingSurfaceState", () => { normalizeMessageChannelMock.mockImplementation((value?: string | null) => typeof value === "string" ? value.trim().toLowerCase() : undefined, ); + vi.doMock("../config/config.js", () => ({ + loadConfig: (...args: unknown[]) => loadConfigMock(...args), + })); + vi.doMock("../channels/plugins/index.js", () => ({ + getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), + listChannelPlugins: (...args: unknown[]) => listChannelPluginsMock(...args), + })); + vi.doMock("../../extensions/discord/src/channel.js", () => ({ + discordPlugin: {}, + })); + vi.doMock("../../extensions/telegram/src/channel.js", () => ({ + telegramPlugin: {}, + })); + vi.doMock("../../extensions/slack/src/channel.js", () => ({ + slackPlugin: {}, + })); + vi.doMock("../../extensions/whatsapp/src/channel.js", () => ({ + whatsappPlugin: {}, + })); + vi.doMock("../../extensions/signal/src/channel.js", () => ({ + signalPlugin: {}, + })); + vi.doMock("../../extensions/imessage/src/channel.js", () => ({ + imessagePlugin: {}, + })); + vi.doMock("../utils/message-channel.js", () => ({ + INTERNAL_MESSAGE_CHANNEL: "web", + normalizeMessageChannel: (...args: unknown[]) => normalizeMessageChannelMock(...args), + })); + ({ hasConfiguredExecApprovalDmRoute, resolveExecApprovalInitiatingSurfaceState } = + await import("./exec-approval-surface.js")); }); it("treats web UI, terminal UI, and missing channels as enabled", () => { @@ -154,8 +148,46 @@ describe("resolveExecApprovalInitiatingSurfaceState", () => { }); describe("hasConfiguredExecApprovalDmRoute", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + loadConfigMock.mockReset(); + getChannelPluginMock.mockReset(); listChannelPluginsMock.mockReset(); + normalizeMessageChannelMock.mockReset(); + normalizeMessageChannelMock.mockImplementation((value?: string | null) => + typeof value === "string" ? value.trim().toLowerCase() : undefined, + ); + vi.doMock("../config/config.js", () => ({ + loadConfig: (...args: unknown[]) => loadConfigMock(...args), + })); + vi.doMock("../channels/plugins/index.js", () => ({ + getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), + listChannelPlugins: (...args: unknown[]) => listChannelPluginsMock(...args), + })); + vi.doMock("../../extensions/discord/src/channel.js", () => ({ + discordPlugin: {}, + })); + vi.doMock("../../extensions/telegram/src/channel.js", () => ({ + telegramPlugin: {}, + })); + vi.doMock("../../extensions/slack/src/channel.js", () => ({ + slackPlugin: {}, + })); + vi.doMock("../../extensions/whatsapp/src/channel.js", () => ({ + whatsappPlugin: {}, + })); + vi.doMock("../../extensions/signal/src/channel.js", () => ({ + signalPlugin: {}, + })); + vi.doMock("../../extensions/imessage/src/channel.js", () => ({ + imessagePlugin: {}, + })); + vi.doMock("../utils/message-channel.js", () => ({ + INTERNAL_MESSAGE_CHANNEL: "web", + normalizeMessageChannel: (...args: unknown[]) => normalizeMessageChannelMock(...args), + })); + ({ hasConfiguredExecApprovalDmRoute, resolveExecApprovalInitiatingSurfaceState } = + await import("./exec-approval-surface.js")); }); it("returns true when any enabled account routes approvals to DM or both", () => { diff --git a/src/infra/exec-approvals-store.test.ts b/src/infra/exec-approvals-store.test.ts index 4dc6ab71c7e..365e40b1f1d 100644 --- a/src/infra/exec-approvals-store.test.ts +++ b/src/infra/exec-approvals-store.test.ts @@ -9,23 +9,36 @@ vi.mock("./jsonl-socket.js", () => ({ requestJsonlSocket: (...args: unknown[]) => requestJsonlSocketMock(...args), })); -import { - addAllowlistEntry, - ensureExecApprovals, - mergeExecApprovalsSocketDefaults, - normalizeExecApprovals, - readExecApprovalsSnapshot, - recordAllowlistUse, - requestExecApprovalViaSocket, - resolveExecApprovalsPath, - resolveExecApprovalsSocketPath, - type ExecApprovalsFile, -} from "./exec-approvals.js"; +import type { ExecApprovalsFile } from "./exec-approvals.js"; + +type ExecApprovalsModule = typeof import("./exec-approvals.js"); + +let addAllowlistEntry: ExecApprovalsModule["addAllowlistEntry"]; +let ensureExecApprovals: ExecApprovalsModule["ensureExecApprovals"]; +let mergeExecApprovalsSocketDefaults: ExecApprovalsModule["mergeExecApprovalsSocketDefaults"]; +let normalizeExecApprovals: ExecApprovalsModule["normalizeExecApprovals"]; +let readExecApprovalsSnapshot: ExecApprovalsModule["readExecApprovalsSnapshot"]; +let recordAllowlistUse: ExecApprovalsModule["recordAllowlistUse"]; +let requestExecApprovalViaSocket: ExecApprovalsModule["requestExecApprovalViaSocket"]; +let resolveExecApprovalsPath: ExecApprovalsModule["resolveExecApprovalsPath"]; +let resolveExecApprovalsSocketPath: ExecApprovalsModule["resolveExecApprovalsSocketPath"]; const tempDirs: string[] = []; const originalOpenClawHome = process.env.OPENCLAW_HOME; -beforeEach(() => { +beforeEach(async () => { + vi.resetModules(); + ({ + addAllowlistEntry, + ensureExecApprovals, + mergeExecApprovalsSocketDefaults, + normalizeExecApprovals, + readExecApprovalsSnapshot, + recordAllowlistUse, + requestExecApprovalViaSocket, + resolveExecApprovalsPath, + resolveExecApprovalsSocketPath, + } = await import("./exec-approvals.js")); requestJsonlSocketMock.mockReset(); }); diff --git a/src/infra/net/proxy-fetch.test.ts b/src/infra/net/proxy-fetch.test.ts index 8f9c17fa499..fb8dbf7f8d3 100644 --- a/src/infra/net/proxy-fetch.test.ts +++ b/src/infra/net/proxy-fetch.test.ts @@ -51,12 +51,10 @@ vi.mock("undici", () => ({ fetch: undiciFetch, })); -import { - getProxyUrlFromFetch, - makeProxyFetch, - PROXY_FETCH_PROXY_URL, - resolveProxyFetchFromEnv, -} from "./proxy-fetch.js"; +let getProxyUrlFromFetch: typeof import("./proxy-fetch.js").getProxyUrlFromFetch; +let makeProxyFetch: typeof import("./proxy-fetch.js").makeProxyFetch; +let PROXY_FETCH_PROXY_URL: typeof import("./proxy-fetch.js").PROXY_FETCH_PROXY_URL; +let resolveProxyFetchFromEnv: typeof import("./proxy-fetch.js").resolveProxyFetchFromEnv; function clearProxyEnv(): void { for (const key of PROXY_ENV_KEYS) { @@ -75,7 +73,12 @@ function restoreProxyEnv(): void { } describe("makeProxyFetch", () => { - beforeEach(() => vi.clearAllMocks()); + beforeEach(async () => { + vi.resetModules(); + vi.clearAllMocks(); + ({ getProxyUrlFromFetch, makeProxyFetch, PROXY_FETCH_PROXY_URL, resolveProxyFetchFromEnv } = + await import("./proxy-fetch.js")); + }); it("uses undici fetch with ProxyAgent dispatcher", async () => { const proxyUrl = "http://proxy.test:8080"; diff --git a/src/infra/net/ssrf.dispatcher.test.ts b/src/infra/net/ssrf.dispatcher.test.ts index 07b80b40465..838feb291ac 100644 --- a/src/infra/net/ssrf.dispatcher.test.ts +++ b/src/infra/net/ssrf.dispatcher.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const { agentCtor, envHttpProxyAgentCtor, proxyAgentCtor } = vi.hoisted(() => ({ agentCtor: vi.fn(function MockAgent(this: { options: unknown }, options: unknown) { @@ -21,7 +21,14 @@ vi.mock("undici", () => ({ ProxyAgent: proxyAgentCtor, })); -import { createPinnedDispatcher, type PinnedHostname } from "./ssrf.js"; +import type { PinnedHostname } from "./ssrf.js"; + +let createPinnedDispatcher: typeof import("./ssrf.js").createPinnedDispatcher; + +beforeEach(async () => { + vi.resetModules(); + ({ createPinnedDispatcher } = await import("./ssrf.js")); +}); describe("createPinnedDispatcher", () => { it("uses pinned lookup without overriding global family policy", () => { diff --git a/src/infra/net/undici-global-dispatcher.test.ts b/src/infra/net/undici-global-dispatcher.test.ts index 8b14c4084fc..47a97dd6fb6 100644 --- a/src/infra/net/undici-global-dispatcher.test.ts +++ b/src/infra/net/undici-global-dispatcher.test.ts @@ -62,15 +62,20 @@ vi.mock("./proxy-env.js", () => ({ })); import { hasEnvHttpProxyConfigured } from "./proxy-env.js"; -import { - DEFAULT_UNDICI_STREAM_TIMEOUT_MS, - ensureGlobalUndiciEnvProxyDispatcher, - ensureGlobalUndiciStreamTimeouts, - resetGlobalUndiciStreamTimeoutsForTests, -} from "./undici-global-dispatcher.js"; +let DEFAULT_UNDICI_STREAM_TIMEOUT_MS: typeof import("./undici-global-dispatcher.js").DEFAULT_UNDICI_STREAM_TIMEOUT_MS; +let ensureGlobalUndiciEnvProxyDispatcher: typeof import("./undici-global-dispatcher.js").ensureGlobalUndiciEnvProxyDispatcher; +let ensureGlobalUndiciStreamTimeouts: typeof import("./undici-global-dispatcher.js").ensureGlobalUndiciStreamTimeouts; +let resetGlobalUndiciStreamTimeoutsForTests: typeof import("./undici-global-dispatcher.js").resetGlobalUndiciStreamTimeoutsForTests; describe("ensureGlobalUndiciStreamTimeouts", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ + DEFAULT_UNDICI_STREAM_TIMEOUT_MS, + ensureGlobalUndiciEnvProxyDispatcher, + ensureGlobalUndiciStreamTimeouts, + resetGlobalUndiciStreamTimeoutsForTests, + } = await import("./undici-global-dispatcher.js")); vi.clearAllMocks(); resetGlobalUndiciStreamTimeoutsForTests(); setCurrentDispatcher(new Agent()); diff --git a/src/infra/openclaw-root.test.ts b/src/infra/openclaw-root.test.ts index e12b2d77f64..291280318bb 100644 --- a/src/infra/openclaw-root.test.ts +++ b/src/infra/openclaw-root.test.ts @@ -1,6 +1,6 @@ import path from "node:path"; import { pathToFileURL } from "node:url"; -import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; type FakeFsEntry = { kind: "file"; content: string } | { kind: "dir" }; @@ -93,12 +93,10 @@ describe("resolveOpenClawPackageRoot", () => { let resolveOpenClawPackageRoot: typeof import("./openclaw-root.js").resolveOpenClawPackageRoot; let resolveOpenClawPackageRootSync: typeof import("./openclaw-root.js").resolveOpenClawPackageRootSync; - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); ({ resolveOpenClawPackageRoot, resolveOpenClawPackageRootSync } = await import("./openclaw-root.js")); - }); - - beforeEach(() => { state.entries.clear(); state.realpaths.clear(); state.realpathErrors.clear(); diff --git a/src/infra/outbound/agent-delivery.test.ts b/src/infra/outbound/agent-delivery.test.ts index b137ce2a73f..88b6776105e 100644 --- a/src/infra/outbound/agent-delivery.test.ts +++ b/src/infra/outbound/agent-delivery.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const mocks = vi.hoisted(() => ({ resolveOutboundTarget: vi.fn(() => ({ ok: true as const, to: "+1999" })), @@ -13,7 +13,15 @@ vi.mock("./targets.js", async () => { }); import type { OpenClawConfig } from "../../config/config.js"; -import { resolveAgentDeliveryPlan, resolveAgentOutboundTarget } from "./agent-delivery.js"; +type AgentDeliveryModule = typeof import("./agent-delivery.js"); + +let resolveAgentDeliveryPlan: AgentDeliveryModule["resolveAgentDeliveryPlan"]; +let resolveAgentOutboundTarget: AgentDeliveryModule["resolveAgentOutboundTarget"]; + +beforeEach(async () => { + vi.resetModules(); + ({ resolveAgentDeliveryPlan, resolveAgentOutboundTarget } = await import("./agent-delivery.js")); +}); describe("agent delivery helpers", () => { it("builds a delivery plan from session delivery context", () => { diff --git a/src/infra/outbound/channel-selection.test.ts b/src/infra/outbound/channel-selection.test.ts index 5f3ac319628..fdb4ecd4b6f 100644 --- a/src/infra/outbound/channel-selection.test.ts +++ b/src/infra/outbound/channel-selection.test.ts @@ -1,5 +1,4 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { defaultRuntime } from "../../runtime.js"; const mocks = vi.hoisted(() => ({ listChannelPlugins: vi.fn(), @@ -14,11 +13,20 @@ vi.mock("./channel-resolution.js", () => ({ resolveOutboundChannelPlugin: mocks.resolveOutboundChannelPlugin, })); -import { - __testing, - listConfiguredMessageChannels, - resolveMessageChannelSelection, -} from "./channel-selection.js"; +type ChannelSelectionModule = typeof import("./channel-selection.js"); +type RuntimeModule = typeof import("../../runtime.js"); + +let __testing: ChannelSelectionModule["__testing"]; +let listConfiguredMessageChannels: ChannelSelectionModule["listConfiguredMessageChannels"]; +let resolveMessageChannelSelection: ChannelSelectionModule["resolveMessageChannelSelection"]; +let runtimeModule: RuntimeModule; + +beforeEach(async () => { + vi.resetModules(); + runtimeModule = await import("../../runtime.js"); + ({ __testing, listConfiguredMessageChannels, resolveMessageChannelSelection } = + await import("./channel-selection.js")); +}); function makePlugin(params: { id: string; @@ -40,9 +48,10 @@ function makePlugin(params: { } describe("listConfiguredMessageChannels", () => { - const errorSpy = vi.spyOn(defaultRuntime, "error").mockImplementation(() => undefined); + let errorSpy: ReturnType; beforeEach(() => { + errorSpy = vi.spyOn(runtimeModule.defaultRuntime, "error").mockImplementation(() => undefined); mocks.listChannelPlugins.mockReset(); mocks.listChannelPlugins.mockReturnValue([]); mocks.resolveOutboundChannelPlugin.mockReset(); diff --git a/src/infra/outbound/deliver.lifecycle.test.ts b/src/infra/outbound/deliver.lifecycle.test.ts index 22fa829812e..c8ce22b826b 100644 --- a/src/infra/outbound/deliver.lifecycle.test.ts +++ b/src/infra/outbound/deliver.lifecycle.test.ts @@ -15,10 +15,12 @@ import { whatsappChunkConfig, } from "./deliver.test-helpers.js"; -const { deliverOutboundPayloads } = await import("./deliver.js"); +type DeliverModule = typeof import("./deliver.js"); + +let deliverOutboundPayloads: DeliverModule["deliverOutboundPayloads"]; async function runChunkedWhatsAppDelivery(params?: { - mirror?: Parameters[0]["mirror"]; + mirror?: Parameters[0]["mirror"]; }) { return await runChunkedWhatsAppDeliveryHelper({ deliverOutboundPayloads, @@ -75,7 +77,9 @@ function expectSuccessfulWhatsAppInternalHookPayload( } describe("deliverOutboundPayloads lifecycle", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ deliverOutboundPayloads } = await import("./deliver.js")); resetDeliverTestState(); resetDeliverTestMocks({ includeSessionMocks: true }); }); diff --git a/src/infra/outbound/deliver.test.ts b/src/infra/outbound/deliver.test.ts index 5323dd83e27..e72cbaa0bee 100644 --- a/src/infra/outbound/deliver.test.ts +++ b/src/infra/outbound/deliver.test.ts @@ -80,7 +80,10 @@ vi.mock("../../logging/subsystem.js", () => ({ }, })); -const { deliverOutboundPayloads, normalizeOutboundPayloads } = await import("./deliver.js"); +type DeliverModule = typeof import("./deliver.js"); + +let deliverOutboundPayloads: DeliverModule["deliverOutboundPayloads"]; +let normalizeOutboundPayloads: DeliverModule["normalizeOutboundPayloads"]; const telegramChunkConfig: OpenClawConfig = { channels: { telegram: { botToken: "tok-1", textChunkLimit: 2 } }, @@ -90,13 +93,13 @@ const whatsappChunkConfig: OpenClawConfig = { channels: { whatsapp: { textChunkLimit: 4000 } }, }; -type DeliverOutboundArgs = Parameters[0]; +type DeliverOutboundArgs = Parameters[0]; type DeliverOutboundPayload = DeliverOutboundArgs["payloads"][number]; type DeliverSession = DeliverOutboundArgs["session"]; async function deliverWhatsAppPayload(params: { sendWhatsApp: NonNullable< - NonNullable[0]["deps"]>["sendWhatsApp"] + NonNullable[0]["deps"]>["sendWhatsApp"] >; payload: DeliverOutboundPayload; cfg?: OpenClawConfig; @@ -198,7 +201,9 @@ function expectSuccessfulWhatsAppInternalHookPayload( } describe("deliverOutboundPayloads", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ deliverOutboundPayloads, normalizeOutboundPayloads } = await import("./deliver.js")); setActivePluginRegistry(defaultRegistry); mocks.appendAssistantMessageToSessionTranscript.mockClear(); hookMocks.runner.hasHooks.mockClear(); diff --git a/src/infra/outbound/identity.test.ts b/src/infra/outbound/identity.test.ts index d31d8a6dd06..e5a8ea6a808 100644 --- a/src/infra/outbound/identity.test.ts +++ b/src/infra/outbound/identity.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const resolveAgentIdentityMock = vi.hoisted(() => vi.fn()); const resolveAgentAvatarMock = vi.hoisted(() => vi.fn()); @@ -11,7 +11,15 @@ vi.mock("../../agents/identity-avatar.js", () => ({ resolveAgentAvatar: (...args: unknown[]) => resolveAgentAvatarMock(...args), })); -import { normalizeOutboundIdentity, resolveAgentOutboundIdentity } from "./identity.js"; +type IdentityModule = typeof import("./identity.js"); + +let normalizeOutboundIdentity: IdentityModule["normalizeOutboundIdentity"]; +let resolveAgentOutboundIdentity: IdentityModule["resolveAgentOutboundIdentity"]; + +beforeEach(async () => { + vi.resetModules(); + ({ normalizeOutboundIdentity, resolveAgentOutboundIdentity } = await import("./identity.js")); +}); describe("normalizeOutboundIdentity", () => { it("trims fields and drops empty identities", () => { diff --git a/src/infra/outbound/message-action-runner.media.test.ts b/src/infra/outbound/message-action-runner.media.test.ts index 1715ea090f2..ba24bdb15df 100644 --- a/src/infra/outbound/message-action-runner.media.test.ts +++ b/src/infra/outbound/message-action-runner.media.test.ts @@ -1,16 +1,13 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; -import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; -import { slackPlugin } from "../../../extensions/slack/src/channel.js"; -import { loadWebMedia } from "../../../extensions/whatsapp/src/media.js"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { jsonResult } from "../../agents/tools/common.js"; import type { ChannelPlugin } from "../../channels/plugins/types.js"; import type { OpenClawConfig } from "../../config/config.js"; import { setActivePluginRegistry } from "../../plugins/runtime.js"; import { createTestRegistry } from "../../test-utils/channel-plugins.js"; import { resolvePreferredOpenClawTmpDir } from "../tmp-openclaw-dir.js"; -import { runMessageAction } from "./message-action-runner.js"; vi.mock("../../../extensions/whatsapp/src/media.js", async () => { const actual = await vi.importActual( @@ -79,8 +76,17 @@ async function expectSandboxMediaRewrite(params: { ); } -let createPluginRuntime: typeof import("../../plugins/runtime/index.js").createPluginRuntime; -let setSlackRuntime: typeof import("../../../extensions/slack/src/runtime.js").setSlackRuntime; +type MessageActionRunnerModule = typeof import("./message-action-runner.js"); +type WhatsAppMediaModule = typeof import("../../../extensions/whatsapp/src/media.js"); +type SlackChannelModule = typeof import("../../../extensions/slack/src/channel.js"); +type RuntimeIndexModule = typeof import("../../plugins/runtime/index.js"); +type SlackRuntimeModule = typeof import("../../../extensions/slack/src/runtime.js"); + +let runMessageAction: MessageActionRunnerModule["runMessageAction"]; +let loadWebMedia: WhatsAppMediaModule["loadWebMedia"]; +let slackPlugin: SlackChannelModule["slackPlugin"]; +let createPluginRuntime: RuntimeIndexModule["createPluginRuntime"]; +let setSlackRuntime: SlackRuntimeModule["setSlackRuntime"]; function installSlackRuntime() { const runtime = createPluginRuntime(); @@ -88,7 +94,11 @@ function installSlackRuntime() { } describe("runMessageAction media behavior", () => { - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); + ({ runMessageAction } = await import("./message-action-runner.js")); + ({ loadWebMedia } = await import("../../../extensions/whatsapp/src/media.js")); + ({ slackPlugin } = await import("../../../extensions/slack/src/channel.js")); ({ createPluginRuntime } = await import("../../plugins/runtime/index.js")); ({ setSlackRuntime } = await import("../../../extensions/slack/src/runtime.js")); }); diff --git a/src/infra/outbound/message-action-runner.poll.test.ts b/src/infra/outbound/message-action-runner.poll.test.ts index 895e47605ce..ed1beb91f5d 100644 --- a/src/infra/outbound/message-action-runner.poll.test.ts +++ b/src/infra/outbound/message-action-runner.poll.test.ts @@ -1,11 +1,4 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { - installMessageActionRunnerTestRegistry, - resetMessageActionRunnerTestRegistry, - slackConfig, - telegramConfig, -} from "./message-action-runner.test-helpers.js"; - const mocks = vi.hoisted(() => ({ executePollAction: vi.fn(), })); @@ -20,10 +13,18 @@ vi.mock("./outbound-send-service.js", async () => { }; }); -import { runMessageAction } from "./message-action-runner.js"; +type MessageActionRunnerModule = typeof import("./message-action-runner.js"); +type MessageActionRunnerTestHelpersModule = + typeof import("./message-action-runner.test-helpers.js"); + +let runMessageAction: MessageActionRunnerModule["runMessageAction"]; +let installMessageActionRunnerTestRegistry: MessageActionRunnerTestHelpersModule["installMessageActionRunnerTestRegistry"]; +let resetMessageActionRunnerTestRegistry: MessageActionRunnerTestHelpersModule["resetMessageActionRunnerTestRegistry"]; +let slackConfig: MessageActionRunnerTestHelpersModule["slackConfig"]; +let telegramConfig: MessageActionRunnerTestHelpersModule["telegramConfig"]; async function runPollAction(params: { - cfg: typeof slackConfig; + cfg: MessageActionRunnerTestHelpersModule["slackConfig"]; actionParams: Record; toolContext?: Record; }) { @@ -44,7 +45,15 @@ async function runPollAction(params: { | undefined; } describe("runMessageAction poll handling", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ runMessageAction } = await import("./message-action-runner.js")); + ({ + installMessageActionRunnerTestRegistry, + resetMessageActionRunnerTestRegistry, + slackConfig, + telegramConfig, + } = await import("./message-action-runner.test-helpers.js")); installMessageActionRunnerTestRegistry(); mocks.executePollAction.mockResolvedValue({ handledBy: "core", @@ -54,14 +63,14 @@ describe("runMessageAction poll handling", () => { }); afterEach(() => { - resetMessageActionRunnerTestRegistry(); + resetMessageActionRunnerTestRegistry?.(); mocks.executePollAction.mockReset(); }); it.each([ { name: "requires at least two poll options", - cfg: telegramConfig, + getCfg: () => telegramConfig, actionParams: { channel: "telegram", target: "telegram:123", @@ -72,7 +81,7 @@ describe("runMessageAction poll handling", () => { }, { name: "rejects durationSeconds outside telegram", - cfg: slackConfig, + getCfg: () => slackConfig, actionParams: { channel: "slack", target: "#C12345678", @@ -84,7 +93,7 @@ describe("runMessageAction poll handling", () => { }, { name: "rejects poll visibility outside telegram", - cfg: slackConfig, + getCfg: () => slackConfig, actionParams: { channel: "slack", target: "#C12345678", @@ -94,8 +103,8 @@ describe("runMessageAction poll handling", () => { }, message: /pollAnonymous\/pollPublic are only supported for Telegram polls/i, }, - ])("$name", async ({ cfg, actionParams, message }) => { - await expect(runPollAction({ cfg, actionParams })).rejects.toThrow(message); + ])("$name", async ({ getCfg, actionParams, message }) => { + await expect(runPollAction({ cfg: getCfg(), actionParams })).rejects.toThrow(message); expect(mocks.executePollAction).not.toHaveBeenCalled(); }); diff --git a/src/infra/outbound/message-action-runner.threading.test.ts b/src/infra/outbound/message-action-runner.threading.test.ts index 42d898b145a..7401127251a 100644 --- a/src/infra/outbound/message-action-runner.threading.test.ts +++ b/src/infra/outbound/message-action-runner.threading.test.ts @@ -1,11 +1,4 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { - installMessageActionRunnerTestRegistry, - resetMessageActionRunnerTestRegistry, - slackConfig, - telegramConfig, -} from "./message-action-runner.test-helpers.js"; - const mocks = vi.hoisted(() => ({ executeSendAction: vi.fn(), recordSessionMetaFromInbound: vi.fn(async () => ({ ok: true })), @@ -31,10 +24,18 @@ vi.mock("../../config/sessions.js", async () => { }; }); -import { runMessageAction } from "./message-action-runner.js"; +type MessageActionRunnerModule = typeof import("./message-action-runner.js"); +type MessageActionRunnerTestHelpersModule = + typeof import("./message-action-runner.test-helpers.js"); + +let runMessageAction: MessageActionRunnerModule["runMessageAction"]; +let installMessageActionRunnerTestRegistry: MessageActionRunnerTestHelpersModule["installMessageActionRunnerTestRegistry"]; +let resetMessageActionRunnerTestRegistry: MessageActionRunnerTestHelpersModule["resetMessageActionRunnerTestRegistry"]; +let slackConfig: MessageActionRunnerTestHelpersModule["slackConfig"]; +let telegramConfig: MessageActionRunnerTestHelpersModule["telegramConfig"]; async function runThreadingAction(params: { - cfg: typeof slackConfig; + cfg: MessageActionRunnerTestHelpersModule["slackConfig"]; actionParams: Record; toolContext?: Record; }) { @@ -65,12 +66,20 @@ const defaultTelegramToolContext = { } as const; describe("runMessageAction threading auto-injection", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ runMessageAction } = await import("./message-action-runner.js")); + ({ + installMessageActionRunnerTestRegistry, + resetMessageActionRunnerTestRegistry, + slackConfig, + telegramConfig, + } = await import("./message-action-runner.test-helpers.js")); installMessageActionRunnerTestRegistry(); }); afterEach(() => { - resetMessageActionRunnerTestRegistry(); + resetMessageActionRunnerTestRegistry?.(); mocks.executeSendAction.mockClear(); mocks.recordSessionMetaFromInbound.mockClear(); }); diff --git a/src/infra/outbound/message.channels.test.ts b/src/infra/outbound/message.channels.test.ts index 6d89ac5ab91..6167c3c250c 100644 --- a/src/infra/outbound/message.channels.test.ts +++ b/src/infra/outbound/message.channels.test.ts @@ -4,7 +4,6 @@ import { setActivePluginRegistry } from "../../plugins/runtime.js"; import { createMSTeamsTestPlugin, createTestRegistry } from "../../test-utils/channel-plugins.js"; import { createIMessageTestPlugin } from "../../test-utils/imessage-test-plugin.js"; import { GATEWAY_CLIENT_MODES, GATEWAY_CLIENT_NAMES } from "../../utils/message-channel.js"; -import { sendMessage, sendPoll } from "./message.js"; const setRegistry = (registry: ReturnType) => { setActivePluginRegistry(registry); @@ -17,7 +16,12 @@ vi.mock("../../gateway/call.js", () => ({ randomIdempotencyKey: () => "idem-1", })); -beforeEach(() => { +let sendMessage: typeof import("./message.js").sendMessage; +let sendPoll: typeof import("./message.js").sendPoll; + +beforeEach(async () => { + vi.resetModules(); + ({ sendMessage, sendPoll } = await import("./message.js")); callGatewayMock.mockClear(); setRegistry(emptyRegistry); }); diff --git a/src/infra/outbound/message.test.ts b/src/infra/outbound/message.test.ts index 200d4d587e1..47a43eb8437 100644 --- a/src/infra/outbound/message.test.ts +++ b/src/infra/outbound/message.test.ts @@ -46,10 +46,13 @@ vi.mock("./deliver.js", () => ({ import { setActivePluginRegistry } from "../../plugins/runtime.js"; import { createTestRegistry } from "../../test-utils/channel-plugins.js"; -import { sendMessage } from "./message.js"; + +let sendMessage: typeof import("./message.js").sendMessage; describe("sendMessage", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ sendMessage } = await import("./message.js")); setActivePluginRegistry(createTestRegistry([])); mocks.getChannelPlugin.mockClear(); mocks.resolveOutboundTarget.mockClear(); diff --git a/src/infra/outbound/outbound-send-service.test.ts b/src/infra/outbound/outbound-send-service.test.ts index d4a481a8693..f5d1f2b9b28 100644 --- a/src/infra/outbound/outbound-send-service.test.ts +++ b/src/infra/outbound/outbound-send-service.test.ts @@ -32,7 +32,10 @@ vi.mock("../../config/sessions.js", () => ({ appendAssistantMessageToSessionTranscript: mocks.appendAssistantMessageToSessionTranscript, })); -import { executePollAction, executeSendAction } from "./outbound-send-service.js"; +type OutboundSendServiceModule = typeof import("./outbound-send-service.js"); + +let executePollAction: OutboundSendServiceModule["executePollAction"]; +let executeSendAction: OutboundSendServiceModule["executeSendAction"]; describe("executeSendAction", () => { function pluginActionResult(messageId: string) { @@ -88,7 +91,9 @@ describe("executeSendAction", () => { }); } - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ executePollAction, executeSendAction } = await import("./outbound-send-service.js")); mocks.dispatchChannelMessageAction.mockClear(); mocks.sendMessage.mockClear(); mocks.sendPoll.mockClear(); diff --git a/src/infra/outbound/session-context.test.ts b/src/infra/outbound/session-context.test.ts index a62c47fb998..1446d665f35 100644 --- a/src/infra/outbound/session-context.test.ts +++ b/src/infra/outbound/session-context.test.ts @@ -1,12 +1,19 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const resolveSessionAgentIdMock = vi.hoisted(() => vi.fn()); -vi.mock("../../agents/agent-scope.js", () => ({ - resolveSessionAgentId: (...args: unknown[]) => resolveSessionAgentIdMock(...args), -})); +type SessionContextModule = typeof import("./session-context.js"); -import { buildOutboundSessionContext } from "./session-context.js"; +let buildOutboundSessionContext: SessionContextModule["buildOutboundSessionContext"]; + +beforeEach(async () => { + vi.resetModules(); + resolveSessionAgentIdMock.mockReset(); + vi.doMock("../../agents/agent-scope.js", () => ({ + resolveSessionAgentId: (...args: unknown[]) => resolveSessionAgentIdMock(...args), + })); + ({ buildOutboundSessionContext } = await import("./session-context.js")); +}); describe("buildOutboundSessionContext", () => { it("returns undefined when both session key and agent id are blank", () => { diff --git a/src/infra/outbound/target-normalization.test.ts b/src/infra/outbound/target-normalization.test.ts index c8e6ea7e124..33b4fd8f08c 100644 --- a/src/infra/outbound/target-normalization.test.ts +++ b/src/infra/outbound/target-normalization.test.ts @@ -4,33 +4,51 @@ const normalizeChannelIdMock = vi.hoisted(() => vi.fn()); const getChannelPluginMock = vi.hoisted(() => vi.fn()); const getActivePluginRegistryVersionMock = vi.hoisted(() => vi.fn()); -vi.mock("../../channels/plugins/index.js", () => ({ - normalizeChannelId: (...args: unknown[]) => normalizeChannelIdMock(...args), - getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), -})); +type TargetNormalizationModule = typeof import("./target-normalization.js"); -vi.mock("../../plugins/runtime.js", () => ({ - getActivePluginRegistryVersion: (...args: unknown[]) => - getActivePluginRegistryVersionMock(...args), -})); - -import { - buildTargetResolverSignature, - normalizeChannelTargetInput, - normalizeTargetForProvider, -} from "./target-normalization.js"; +let buildTargetResolverSignature: TargetNormalizationModule["buildTargetResolverSignature"]; +let normalizeChannelTargetInput: TargetNormalizationModule["normalizeChannelTargetInput"]; +let normalizeTargetForProvider: TargetNormalizationModule["normalizeTargetForProvider"]; describe("normalizeChannelTargetInput", () => { + beforeEach(async () => { + vi.resetModules(); + normalizeChannelIdMock.mockReset(); + getChannelPluginMock.mockReset(); + getActivePluginRegistryVersionMock.mockReset(); + vi.doMock("../../channels/plugins/index.js", () => ({ + normalizeChannelId: (...args: unknown[]) => normalizeChannelIdMock(...args), + getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), + })); + vi.doMock("../../plugins/runtime.js", () => ({ + getActivePluginRegistryVersion: (...args: unknown[]) => + getActivePluginRegistryVersionMock(...args), + })); + ({ buildTargetResolverSignature, normalizeChannelTargetInput, normalizeTargetForProvider } = + await import("./target-normalization.js")); + }); + it("trims raw target input", () => { expect(normalizeChannelTargetInput(" channel:C1 ")).toBe("channel:C1"); }); }); describe("normalizeTargetForProvider", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); normalizeChannelIdMock.mockReset(); getChannelPluginMock.mockReset(); getActivePluginRegistryVersionMock.mockReset(); + vi.doMock("../../channels/plugins/index.js", () => ({ + normalizeChannelId: (...args: unknown[]) => normalizeChannelIdMock(...args), + getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), + })); + vi.doMock("../../plugins/runtime.js", () => ({ + getActivePluginRegistryVersion: (...args: unknown[]) => + getActivePluginRegistryVersionMock(...args), + })); + ({ buildTargetResolverSignature, normalizeChannelTargetInput, normalizeTargetForProvider } = + await import("./target-normalization.js")); }); it("returns undefined for missing or blank raw input", () => { @@ -87,8 +105,21 @@ describe("normalizeTargetForProvider", () => { }); describe("buildTargetResolverSignature", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + normalizeChannelIdMock.mockReset(); getChannelPluginMock.mockReset(); + getActivePluginRegistryVersionMock.mockReset(); + vi.doMock("../../channels/plugins/index.js", () => ({ + normalizeChannelId: (...args: unknown[]) => normalizeChannelIdMock(...args), + getChannelPlugin: (...args: unknown[]) => getChannelPluginMock(...args), + })); + vi.doMock("../../plugins/runtime.js", () => ({ + getActivePluginRegistryVersion: (...args: unknown[]) => + getActivePluginRegistryVersionMock(...args), + })); + ({ buildTargetResolverSignature, normalizeChannelTargetInput, normalizeTargetForProvider } = + await import("./target-normalization.js")); }); it("builds stable signatures from resolver hint and looksLikeId source", () => { diff --git a/src/infra/outbound/target-resolver.test.ts b/src/infra/outbound/target-resolver.test.ts index 643a5c3ed25..0e877a60c6a 100644 --- a/src/infra/outbound/target-resolver.test.ts +++ b/src/infra/outbound/target-resolver.test.ts @@ -1,28 +1,41 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import type { ChannelDirectoryEntry } from "../../channels/plugins/types.js"; import type { OpenClawConfig } from "../../config/config.js"; -import { resetDirectoryCache, resolveMessagingTarget } from "./target-resolver.js"; +type TargetResolverModule = typeof import("./target-resolver.js"); + +let resetDirectoryCache: TargetResolverModule["resetDirectoryCache"]; +let resolveMessagingTarget: TargetResolverModule["resolveMessagingTarget"]; const mocks = vi.hoisted(() => ({ listGroups: vi.fn(), listGroupsLive: vi.fn(), resolveTarget: vi.fn(), getChannelPlugin: vi.fn(), + getActivePluginRegistryVersion: vi.fn(() => 1), })); -vi.mock("../../channels/plugins/index.js", () => ({ - getChannelPlugin: (...args: unknown[]) => mocks.getChannelPlugin(...args), - normalizeChannelId: (value: string) => value, -})); +beforeEach(async () => { + vi.resetModules(); + mocks.listGroups.mockReset(); + mocks.listGroupsLive.mockReset(); + mocks.resolveTarget.mockReset(); + mocks.getChannelPlugin.mockReset(); + mocks.getActivePluginRegistryVersion.mockReset(); + mocks.getActivePluginRegistryVersion.mockReturnValue(1); + vi.doMock("../../channels/plugins/index.js", () => ({ + getChannelPlugin: (...args: unknown[]) => mocks.getChannelPlugin(...args), + normalizeChannelId: (value: string) => value, + })); + vi.doMock("../../plugins/runtime.js", () => ({ + getActivePluginRegistryVersion: () => mocks.getActivePluginRegistryVersion(), + })); + ({ resetDirectoryCache, resolveMessagingTarget } = await import("./target-resolver.js")); +}); describe("resolveMessagingTarget (directory fallback)", () => { const cfg = {} as OpenClawConfig; beforeEach(() => { - mocks.listGroups.mockClear(); - mocks.listGroupsLive.mockClear(); - mocks.resolveTarget.mockClear(); - mocks.getChannelPlugin.mockClear(); resetDirectoryCache(); mocks.getChannelPlugin.mockReturnValue({ directory: { diff --git a/src/infra/outbound/targets.channel-resolution.test.ts b/src/infra/outbound/targets.channel-resolution.test.ts index e676a425bba..f7e38e0bfef 100644 --- a/src/infra/outbound/targets.channel-resolution.test.ts +++ b/src/infra/outbound/targets.channel-resolution.test.ts @@ -48,7 +48,8 @@ vi.mock("../../config/plugin-auto-enable.js", () => ({ import { setActivePluginRegistry } from "../../plugins/runtime.js"; import { createTestRegistry } from "../../test-utils/channel-plugins.js"; -import { resolveOutboundTarget } from "./targets.js"; + +let resolveOutboundTarget: typeof import("./targets.js").resolveOutboundTarget; describe("resolveOutboundTarget channel resolution", () => { let registrySeq = 0; @@ -60,7 +61,9 @@ describe("resolveOutboundTarget channel resolution", () => { mode: "explicit", }); - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ resolveOutboundTarget } = await import("./targets.js")); registrySeq += 1; setActivePluginRegistry(createTestRegistry([]), `targets-test-${registrySeq}`); mocks.getChannelPlugin.mockReset(); diff --git a/src/infra/pairing-token.test.ts b/src/infra/pairing-token.test.ts index 1ef0c8e20d7..9788e448e49 100644 --- a/src/infra/pairing-token.test.ts +++ b/src/infra/pairing-token.test.ts @@ -1,5 +1,5 @@ import { Buffer } from "node:buffer"; -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const randomBytesMock = vi.hoisted(() => vi.fn()); @@ -11,7 +11,17 @@ vi.mock("node:crypto", async () => { }; }); -import { generatePairingToken, PAIRING_TOKEN_BYTES, verifyPairingToken } from "./pairing-token.js"; +type PairingTokenModule = typeof import("./pairing-token.js"); + +let generatePairingToken: PairingTokenModule["generatePairingToken"]; +let PAIRING_TOKEN_BYTES: PairingTokenModule["PAIRING_TOKEN_BYTES"]; +let verifyPairingToken: PairingTokenModule["verifyPairingToken"]; + +beforeEach(async () => { + vi.resetModules(); + ({ generatePairingToken, PAIRING_TOKEN_BYTES, verifyPairingToken } = + await import("./pairing-token.js")); +}); describe("generatePairingToken", () => { it("uses the configured byte count and returns a base64url token", () => { diff --git a/src/infra/ports.test.ts b/src/infra/ports.test.ts index 090ccb128b9..4c3d3597f40 100644 --- a/src/infra/ports.test.ts +++ b/src/infra/ports.test.ts @@ -7,11 +7,20 @@ const runCommandWithTimeoutMock = vi.hoisted(() => vi.fn()); vi.mock("../process/exec.js", () => ({ runCommandWithTimeout: (...args: unknown[]) => runCommandWithTimeoutMock(...args), })); -import { inspectPortUsage } from "./ports-inspect.js"; -import { ensurePortAvailable, handlePortError, PortInUseError } from "./ports.js"; + +let inspectPortUsage: typeof import("./ports-inspect.js").inspectPortUsage; +let ensurePortAvailable: typeof import("./ports.js").ensurePortAvailable; +let handlePortError: typeof import("./ports.js").handlePortError; +let PortInUseError: typeof import("./ports.js").PortInUseError; const describeUnix = process.platform === "win32" ? describe.skip : describe; +beforeEach(async () => { + vi.resetModules(); + ({ inspectPortUsage } = await import("./ports-inspect.js")); + ({ ensurePortAvailable, handlePortError, PortInUseError } = await import("./ports.js")); +}); + describe("ports helpers", () => { it("ensurePortAvailable rejects when port busy", async () => { const server = net.createServer(); diff --git a/src/infra/provider-usage.auth.plugin.test.ts b/src/infra/provider-usage.auth.plugin.test.ts index 6782e89489b..64339a919d2 100644 --- a/src/infra/provider-usage.auth.plugin.test.ts +++ b/src/infra/provider-usage.auth.plugin.test.ts @@ -7,12 +7,14 @@ vi.mock("../plugins/provider-runtime.js", () => ({ resolveProviderUsageAuthWithPluginMock(...args), })); -import { resolveProviderAuths } from "./provider-usage.auth.js"; +let resolveProviderAuths: typeof import("./provider-usage.auth.js").resolveProviderAuths; describe("resolveProviderAuths plugin seam", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); resolveProviderUsageAuthWithPluginMock.mockReset(); resolveProviderUsageAuthWithPluginMock.mockResolvedValue(null); + ({ resolveProviderAuths } = await import("./provider-usage.auth.js")); }); it("prefers plugin-owned usage auth when available", async () => { diff --git a/src/infra/provider-usage.load.plugin.test.ts b/src/infra/provider-usage.load.plugin.test.ts index 55cff6cad72..6d4d7d7b602 100644 --- a/src/infra/provider-usage.load.plugin.test.ts +++ b/src/infra/provider-usage.load.plugin.test.ts @@ -12,14 +12,16 @@ vi.mock("../plugins/provider-runtime.js", () => ({ resolveProviderUsageSnapshotWithPluginMock(...args), })); -import { loadProviderUsageSummary } from "./provider-usage.load.js"; +let loadProviderUsageSummary: typeof import("./provider-usage.load.js").loadProviderUsageSummary; const usageNow = Date.UTC(2026, 0, 7, 0, 0, 0); describe("provider-usage.load plugin seam", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); resolveProviderUsageSnapshotWithPluginMock.mockReset(); resolveProviderUsageSnapshotWithPluginMock.mockResolvedValue(null); + ({ loadProviderUsageSummary } = await import("./provider-usage.load.js")); }); it("prefers plugin-owned usage snapshots", async () => { diff --git a/src/infra/restart-stale-pids.test.ts b/src/infra/restart-stale-pids.test.ts index b7589d26e15..4ff0823e4c3 100644 --- a/src/infra/restart-stale-pids.test.ts +++ b/src/infra/restart-stale-pids.test.ts @@ -32,11 +32,9 @@ vi.mock("../logging/subsystem.js", () => ({ })); import { resolveLsofCommandSync } from "./ports-lsof.js"; -import { - __testing, - cleanStaleGatewayProcessesSync, - findGatewayPidsOnPortSync, -} from "./restart-stale-pids.js"; +let __testing: typeof import("./restart-stale-pids.js").__testing; +let cleanStaleGatewayProcessesSync: typeof import("./restart-stale-pids.js").cleanStaleGatewayProcessesSync; +let findGatewayPidsOnPortSync: typeof import("./restart-stale-pids.js").findGatewayPidsOnPortSync; function lsofOutput(entries: Array<{ pid: number; cmd: string }>): string { return entries.map(({ pid, cmd }) => `p${pid}\nc${cmd}`).join("\n") + "\n"; @@ -89,6 +87,12 @@ function installInitialBusyPoll( describe.skipIf(isWindows)("restart-stale-pids", () => { beforeEach(() => { + vi.resetModules(); + }); + + beforeEach(async () => { + ({ __testing, cleanStaleGatewayProcessesSync, findGatewayPidsOnPortSync } = + await import("./restart-stale-pids.js")); mockSpawnSync.mockReset(); mockResolveGatewayPort.mockReset(); mockRestartWarn.mockReset(); diff --git a/src/infra/restart.test.ts b/src/infra/restart.test.ts index e21225be37b..fe6e760041b 100644 --- a/src/infra/restart.test.ts +++ b/src/infra/restart.test.ts @@ -16,13 +16,14 @@ vi.mock("../config/paths.js", () => ({ resolveGatewayPort: (...args: unknown[]) => resolveGatewayPortMock(...args), })); -import { - __testing, - cleanStaleGatewayProcessesSync, - findGatewayPidsOnPortSync, -} from "./restart-stale-pids.js"; +let __testing: typeof import("./restart-stale-pids.js").__testing; +let cleanStaleGatewayProcessesSync: typeof import("./restart-stale-pids.js").cleanStaleGatewayProcessesSync; +let findGatewayPidsOnPortSync: typeof import("./restart-stale-pids.js").findGatewayPidsOnPortSync; -beforeEach(() => { +beforeEach(async () => { + vi.resetModules(); + ({ __testing, cleanStaleGatewayProcessesSync, findGatewayPidsOnPortSync } = + await import("./restart-stale-pids.js")); spawnSyncMock.mockReset(); resolveLsofCommandSyncMock.mockReset(); resolveGatewayPortMock.mockReset(); diff --git a/src/infra/secure-random.test.ts b/src/infra/secure-random.test.ts index 2a595900c7b..1c9f8d949bc 100644 --- a/src/infra/secure-random.test.ts +++ b/src/infra/secure-random.test.ts @@ -1,5 +1,5 @@ import { Buffer } from "node:buffer"; -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const cryptoMocks = vi.hoisted(() => ({ randomBytes: vi.fn((bytes: number) => Buffer.alloc(bytes, 0xab)), @@ -11,7 +11,13 @@ vi.mock("node:crypto", () => ({ randomUUID: cryptoMocks.randomUUID, })); -import { generateSecureToken, generateSecureUuid } from "./secure-random.js"; +let generateSecureToken: typeof import("./secure-random.js").generateSecureToken; +let generateSecureUuid: typeof import("./secure-random.js").generateSecureUuid; + +beforeEach(async () => { + vi.resetModules(); + ({ generateSecureToken, generateSecureUuid } = await import("./secure-random.js")); +}); describe("secure-random", () => { it("delegates UUID generation to crypto.randomUUID", () => { diff --git a/src/infra/session-maintenance-warning.test.ts b/src/infra/session-maintenance-warning.test.ts index f4c2e0757a1..4395a46df89 100644 --- a/src/infra/session-maintenance-warning.test.ts +++ b/src/infra/session-maintenance-warning.test.ts @@ -15,28 +15,9 @@ const mocks = vi.hoisted(() => ({ enqueueSystemEvent: vi.fn(), })); -vi.mock("../agents/agent-scope.js", () => ({ - resolveSessionAgentId: mocks.resolveSessionAgentId, -})); +type SessionMaintenanceWarningModule = typeof import("./session-maintenance-warning.js"); -vi.mock("../utils/message-channel.js", () => ({ - normalizeMessageChannel: mocks.normalizeMessageChannel, - isDeliverableMessageChannel: mocks.isDeliverableMessageChannel, -})); - -vi.mock("./outbound/targets.js", () => ({ - resolveSessionDeliveryTarget: mocks.resolveSessionDeliveryTarget, -})); - -vi.mock("./outbound/deliver.js", () => ({ - deliverOutboundPayloads: mocks.deliverOutboundPayloads, -})); - -vi.mock("./system-events.js", () => ({ - enqueueSystemEvent: mocks.enqueueSystemEvent, -})); - -const { deliverSessionMaintenanceWarning } = await import("./session-maintenance-warning.js"); +let deliverSessionMaintenanceWarning: SessionMaintenanceWarningModule["deliverSessionMaintenanceWarning"]; function createParams( overrides: Partial[0]> = {}, @@ -62,17 +43,35 @@ describe("deliverSessionMaintenanceWarning", () => { let prevVitest: string | undefined; let prevNodeEnv: string | undefined; - beforeEach(() => { + beforeEach(async () => { prevVitest = process.env.VITEST; prevNodeEnv = process.env.NODE_ENV; delete process.env.VITEST; process.env.NODE_ENV = "development"; + vi.resetModules(); mocks.resolveSessionAgentId.mockClear(); mocks.resolveSessionDeliveryTarget.mockClear(); mocks.normalizeMessageChannel.mockClear(); mocks.isDeliverableMessageChannel.mockClear(); mocks.deliverOutboundPayloads.mockClear(); mocks.enqueueSystemEvent.mockClear(); + vi.doMock("../agents/agent-scope.js", () => ({ + resolveSessionAgentId: mocks.resolveSessionAgentId, + })); + vi.doMock("../utils/message-channel.js", () => ({ + normalizeMessageChannel: mocks.normalizeMessageChannel, + isDeliverableMessageChannel: mocks.isDeliverableMessageChannel, + })); + vi.doMock("./outbound/targets.js", () => ({ + resolveSessionDeliveryTarget: mocks.resolveSessionDeliveryTarget, + })); + vi.doMock("./outbound/deliver.js", () => ({ + deliverOutboundPayloads: mocks.deliverOutboundPayloads, + })); + vi.doMock("./system-events.js", () => ({ + enqueueSystemEvent: mocks.enqueueSystemEvent, + })); + ({ deliverSessionMaintenanceWarning } = await import("./session-maintenance-warning.js")); }); afterEach(() => { diff --git a/src/infra/transport-ready.test.ts b/src/infra/transport-ready.test.ts index a4703ba512c..e55dcb7dd7b 100644 --- a/src/infra/transport-ready.test.ts +++ b/src/infra/transport-ready.test.ts @@ -1,43 +1,45 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { waitForTransportReady } from "./transport-ready.js"; let injectedSleepError: Error | null = null; - -// Perf: `sleepWithAbort` uses `node:timers/promises` which isn't controlled by fake timers. -// Route sleeps through global `setTimeout` so tests can advance time deterministically. -vi.mock("./backoff.js", () => ({ - sleepWithAbort: async (ms: number, signal?: AbortSignal) => { - if (injectedSleepError) { - throw injectedSleepError; - } - if (signal?.aborted) { - throw new Error("aborted"); - } - if (ms <= 0) { - return; - } - await new Promise((resolve, reject) => { - const timer = setTimeout(() => { - signal?.removeEventListener("abort", onAbort); - resolve(); - }, ms); - const onAbort = () => { - clearTimeout(timer); - signal?.removeEventListener("abort", onAbort); - reject(new Error("aborted")); - }; - signal?.addEventListener("abort", onAbort, { once: true }); - }); - }, -})); +type TransportReadyModule = typeof import("./transport-ready.js"); +let waitForTransportReady: TransportReadyModule["waitForTransportReady"]; function createRuntime() { return { log: vi.fn(), error: vi.fn(), exit: vi.fn() }; } describe("waitForTransportReady", () => { - beforeEach(() => { + beforeEach(async () => { vi.useFakeTimers(); + vi.resetModules(); + // Perf: `sleepWithAbort` uses `node:timers/promises` which isn't controlled by fake timers. + // Route sleeps through global `setTimeout` so tests can advance time deterministically. + vi.doMock("./backoff.js", () => ({ + sleepWithAbort: async (ms: number, signal?: AbortSignal) => { + if (injectedSleepError) { + throw injectedSleepError; + } + if (signal?.aborted) { + throw new Error("aborted"); + } + if (ms <= 0) { + return; + } + await new Promise((resolve, reject) => { + const timer = setTimeout(() => { + signal?.removeEventListener("abort", onAbort); + resolve(); + }, ms); + const onAbort = () => { + clearTimeout(timer); + signal?.removeEventListener("abort", onAbort); + reject(new Error("aborted")); + }; + signal?.addEventListener("abort", onAbort, { once: true }); + }); + }, + })); + ({ waitForTransportReady } = await import("./transport-ready.js")); }); afterEach(() => { diff --git a/src/infra/windows-task-restart.test.ts b/src/infra/windows-task-restart.test.ts index 1a25a7a7415..5da5625f9b8 100644 --- a/src/infra/windows-task-restart.test.ts +++ b/src/infra/windows-task-restart.test.ts @@ -1,7 +1,7 @@ import fs from "node:fs"; import os from "node:os"; import path from "node:path"; -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { captureFullEnv } from "../test-utils/env.js"; const spawnMock = vi.hoisted(() => vi.fn()); @@ -14,7 +14,9 @@ vi.mock("./tmp-openclaw-dir.js", () => ({ resolvePreferredOpenClawTmpDir: () => resolvePreferredOpenClawTmpDirMock(), })); -import { relaunchGatewayScheduledTask } from "./windows-task-restart.js"; +type WindowsTaskRestartModule = typeof import("./windows-task-restart.js"); + +let relaunchGatewayScheduledTask: WindowsTaskRestartModule["relaunchGatewayScheduledTask"]; const envSnapshot = captureFullEnv(); const createdScriptPaths = new Set(); @@ -51,6 +53,11 @@ afterEach(() => { }); describe("relaunchGatewayScheduledTask", () => { + beforeEach(async () => { + vi.resetModules(); + ({ relaunchGatewayScheduledTask } = await import("./windows-task-restart.js")); + }); + it("writes a detached schtasks relaunch helper", () => { const unref = vi.fn(); let seenCommandArg = ""; diff --git a/src/infra/wsl.test.ts b/src/infra/wsl.test.ts index d026cf4bbb1..bc1aa23dad0 100644 --- a/src/infra/wsl.test.ts +++ b/src/infra/wsl.test.ts @@ -14,7 +14,11 @@ vi.mock("node:fs/promises", () => ({ }, })); -const { isWSLEnv, isWSLSync, isWSL2Sync, isWSL, resetWSLStateForTests } = await import("./wsl.js"); +let isWSLEnv: typeof import("./wsl.js").isWSLEnv; +let isWSLSync: typeof import("./wsl.js").isWSLSync; +let isWSL2Sync: typeof import("./wsl.js").isWSL2Sync; +let isWSL: typeof import("./wsl.js").isWSL; +let resetWSLStateForTests: typeof import("./wsl.js").resetWSLStateForTests; const originalPlatformDescriptor = Object.getOwnPropertyDescriptor(process, "platform"); @@ -29,13 +33,18 @@ describe("wsl detection", () => { let envSnapshot: ReturnType; beforeEach(() => { + vi.resetModules(); envSnapshot = captureEnv(["WSL_INTEROP", "WSL_DISTRO_NAME", "WSLENV"]); readFileSyncMock.mockReset(); readFileMock.mockReset(); - resetWSLStateForTests(); setPlatform("linux"); }); + beforeEach(async () => { + ({ isWSLEnv, isWSLSync, isWSL2Sync, isWSL, resetWSLStateForTests } = await import("./wsl.js")); + resetWSLStateForTests(); + }); + afterEach(() => { envSnapshot.restore(); resetWSLStateForTests(); diff --git a/src/media-understanding/apply.test.ts b/src/media-understanding/apply.test.ts index 7058cef6bb1..b9fb809f2a0 100644 --- a/src/media-understanding/apply.test.ts +++ b/src/media-understanding/apply.test.ts @@ -2,51 +2,35 @@ import crypto from "node:crypto"; import fs from "node:fs/promises"; import path from "node:path"; import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; -import { resolveApiKeyForProvider } from "../agents/model-auth.js"; import type { MsgContext } from "../auto-reply/templating.js"; import type { OpenClawConfig } from "../config/config.js"; import { resolvePreferredOpenClawTmpDir } from "../infra/tmp-openclaw-dir.js"; -import { fetchRemoteMedia } from "../media/fetch.js"; -import { runExec } from "../process/exec.js"; import { withEnvAsync } from "../test-utils/env.js"; -import { clearMediaUnderstandingBinaryCacheForTests } from "./runner.js"; import { createSafeAudioFixtureBuffer } from "./runner.test-utils.js"; +type ResolveApiKeyForProvider = typeof import("../agents/model-auth.js").resolveApiKeyForProvider; + const resolveApiKeyForProviderMock = vi.hoisted(() => - vi.fn(async () => ({ + vi.fn(async () => ({ apiKey: "test-key", // pragma: allowlist secret source: "test", mode: "api-key", })), ); const hasAvailableAuthForProviderMock = vi.hoisted(() => - vi.fn(async (...args: Parameters) => { + vi.fn(async (...args: Parameters) => { const resolved = await resolveApiKeyForProviderMock(...args); return Boolean(resolved?.apiKey); }), ); - -vi.mock("../agents/model-auth.js", () => ({ - resolveApiKeyForProvider: resolveApiKeyForProviderMock, - hasAvailableAuthForProvider: hasAvailableAuthForProviderMock, - requireApiKey: (auth: { apiKey?: string; mode?: string }, provider: string) => { - if (auth?.apiKey) { - return auth.apiKey; - } - throw new Error(`No API key resolved for provider "${provider}" (auth mode: ${auth?.mode}).`); - }, -})); - -vi.mock("../media/fetch.js", () => ({ - fetchRemoteMedia: vi.fn(), -})); - -vi.mock("../process/exec.js", () => ({ - runExec: vi.fn(), -})); +const fetchRemoteMediaMock = vi.hoisted(() => vi.fn()); +const runExecMock = vi.hoisted(() => vi.fn()); let applyMediaUnderstanding: typeof import("./apply.js").applyMediaUnderstanding; -const mockedRunExec = vi.mocked(runExec); +let clearMediaUnderstandingBinaryCacheForTests: typeof import("./runner.js").clearMediaUnderstandingBinaryCacheForTests; +const mockedResolveApiKey = resolveApiKeyForProviderMock; +const mockedFetchRemoteMedia = fetchRemoteMediaMock; +const mockedRunExec = runExecMock; const TEMP_MEDIA_PREFIX = "openclaw-media-"; let suiteTempMediaRootDir = ""; @@ -241,14 +225,32 @@ function expectFileNotApplied(params: { } describe("applyMediaUnderstanding", () => { - const mockedResolveApiKey = vi.mocked(resolveApiKeyForProvider); - const mockedFetchRemoteMedia = vi.mocked(fetchRemoteMedia); - beforeAll(async () => { + vi.resetModules(); + vi.doMock("../agents/model-auth.js", () => ({ + resolveApiKeyForProvider: resolveApiKeyForProviderMock, + hasAvailableAuthForProvider: hasAvailableAuthForProviderMock, + requireApiKey: (auth: { apiKey?: string; mode?: string }, provider: string) => { + if (auth?.apiKey) { + return auth.apiKey; + } + throw new Error( + `No API key resolved for provider "${provider}" (auth mode: ${auth?.mode}).`, + ); + }, + })); + vi.doMock("../media/fetch.js", () => ({ + fetchRemoteMedia: fetchRemoteMediaMock, + })); + vi.doMock("../process/exec.js", () => ({ + runExec: runExecMock, + })); + ({ applyMediaUnderstanding } = await import("./apply.js")); + ({ clearMediaUnderstandingBinaryCacheForTests } = await import("./runner.js")); + const baseDir = resolvePreferredOpenClawTmpDir(); await fs.mkdir(baseDir, { recursive: true }); suiteTempMediaRootDir = await fs.mkdtemp(path.join(baseDir, TEMP_MEDIA_PREFIX)); - ({ applyMediaUnderstanding } = await import("./apply.js")); }); beforeEach(() => { diff --git a/src/media-understanding/providers/image.test.ts b/src/media-understanding/providers/image.test.ts index d52c6590eef..9044d8ba83d 100644 --- a/src/media-understanding/providers/image.test.ts +++ b/src/media-understanding/providers/image.test.ts @@ -16,49 +16,43 @@ const resolveApiKeyForProviderMock = vi.fn(async () => ({ const requireApiKeyMock = vi.fn((auth: { apiKey?: string }) => auth.apiKey ?? ""); const setRuntimeApiKeyMock = vi.fn(); const discoverModelsMock = vi.fn(); -let imageImportSeq = 0; +type ImageModule = typeof import("./image.js"); -vi.mock("@mariozechner/pi-ai", async (importOriginal) => { - const actual = await importOriginal(); - return { - ...actual, - complete: completeMock, - }; -}); - -vi.mock("../../agents/minimax-vlm.js", () => ({ - isMinimaxVlmProvider: (provider: string) => - provider === "minimax" || provider === "minimax-portal", - isMinimaxVlmModel: (provider: string, modelId: string) => - (provider === "minimax" || provider === "minimax-portal") && modelId === "MiniMax-VL-01", - minimaxUnderstandImage: minimaxUnderstandImageMock, -})); - -vi.mock("../../agents/models-config.js", () => ({ - ensureOpenClawModelsJson: ensureOpenClawModelsJsonMock, -})); - -vi.mock("../../agents/model-auth.js", () => ({ - getApiKeyForModel: getApiKeyForModelMock, - resolveApiKeyForProvider: resolveApiKeyForProviderMock, - requireApiKey: requireApiKeyMock, -})); - -vi.mock("../../agents/pi-model-discovery-runtime.js", () => ({ - discoverAuthStorage: () => ({ - setRuntimeApiKey: setRuntimeApiKeyMock, - }), - discoverModels: discoverModelsMock, -})); - -async function importImageModule() { - imageImportSeq += 1; - return await import(/* @vite-ignore */ `./image.js?case=${imageImportSeq}`); -} +let describeImageWithModel: ImageModule["describeImageWithModel"]; describe("describeImageWithModel", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); vi.clearAllMocks(); + vi.doMock("@mariozechner/pi-ai", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + complete: completeMock, + }; + }); + vi.doMock("../../agents/minimax-vlm.js", () => ({ + isMinimaxVlmProvider: (provider: string) => + provider === "minimax" || provider === "minimax-portal", + isMinimaxVlmModel: (provider: string, modelId: string) => + (provider === "minimax" || provider === "minimax-portal") && modelId === "MiniMax-VL-01", + minimaxUnderstandImage: minimaxUnderstandImageMock, + })); + vi.doMock("../../agents/models-config.js", () => ({ + ensureOpenClawModelsJson: ensureOpenClawModelsJsonMock, + })); + vi.doMock("../../agents/model-auth.js", () => ({ + getApiKeyForModel: getApiKeyForModelMock, + resolveApiKeyForProvider: resolveApiKeyForProviderMock, + requireApiKey: requireApiKeyMock, + })); + vi.doMock("../../agents/pi-model-discovery-runtime.js", () => ({ + discoverAuthStorage: () => ({ + setRuntimeApiKey: setRuntimeApiKeyMock, + }), + discoverModels: discoverModelsMock, + })); + ({ describeImageWithModel } = await import("./image.js")); minimaxUnderstandImageMock.mockResolvedValue("portal ok"); discoverModelsMock.mockReturnValue({ find: vi.fn(() => ({ @@ -71,8 +65,6 @@ describe("describeImageWithModel", () => { }); it("routes minimax-portal image models through the MiniMax VLM endpoint", async () => { - const { describeImageWithModel } = await importImageModule(); - const result = await describeImageWithModel({ cfg: {}, agentDir: "/tmp/openclaw-agent", @@ -121,8 +113,6 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "generic ok" }], }); - const { describeImageWithModel } = await importImageModule(); - const result = await describeImageWithModel({ cfg: {}, agentDir: "/tmp/openclaw-agent", @@ -165,8 +155,6 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "flash ok" }], }); - const { describeImageWithModel } = await importImageModule(); - const result = await describeImageWithModel({ cfg: {}, agentDir: "/tmp/openclaw-agent", @@ -215,8 +203,6 @@ describe("describeImageWithModel", () => { content: [{ type: "text", text: "flash lite ok" }], }); - const { describeImageWithModel } = await importImageModule(); - const result = await describeImageWithModel({ cfg: {}, agentDir: "/tmp/openclaw-agent", diff --git a/src/media/fetch.telegram-network.test.ts b/src/media/fetch.telegram-network.test.ts index d7a4d8e217d..60e60f1c48c 100644 --- a/src/media/fetch.telegram-network.test.ts +++ b/src/media/fetch.telegram-network.test.ts @@ -1,9 +1,4 @@ -import { afterEach, describe, expect, it, vi } from "vitest"; -import { - resolveTelegramTransport, - shouldRetryTelegramIpv4Fallback, -} from "../../extensions/telegram/src/fetch.js"; -import { fetchRemoteMedia } from "./fetch.js"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; const undiciMocks = vi.hoisted(() => { const createDispatcherCtor = | string>() => @@ -26,9 +21,20 @@ vi.mock("undici", () => ({ fetch: undiciMocks.fetch, })); +let resolveTelegramTransport: typeof import("../../extensions/telegram/src/fetch.js").resolveTelegramTransport; +let shouldRetryTelegramIpv4Fallback: typeof import("../../extensions/telegram/src/fetch.js").shouldRetryTelegramIpv4Fallback; +let fetchRemoteMedia: typeof import("./fetch.js").fetchRemoteMedia; + describe("fetchRemoteMedia telegram network policy", () => { type LookupFn = NonNullable[0]["lookupFn"]>; + beforeEach(async () => { + vi.resetModules(); + ({ resolveTelegramTransport, shouldRetryTelegramIpv4Fallback } = + await import("../../extensions/telegram/src/fetch.js")); + ({ fetchRemoteMedia } = await import("./fetch.js")); + }); + function createTelegramFetchFailedError(code: string): Error { return Object.assign(new TypeError("fetch failed"), { cause: { code }, diff --git a/src/media/input-files.fetch-guard.test.ts b/src/media/input-files.fetch-guard.test.ts index 377bbf78fa9..6bd9fbb4b81 100644 --- a/src/media/input-files.fetch-guard.test.ts +++ b/src/media/input-files.fetch-guard.test.ts @@ -1,4 +1,4 @@ -import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const fetchWithSsrFGuardMock = vi.fn(); const convertHeicToJpegMock = vi.fn(); @@ -24,15 +24,13 @@ let fetchWithGuard: typeof import("./input-files.js").fetchWithGuard; let extractImageContentFromSource: typeof import("./input-files.js").extractImageContentFromSource; let extractFileContentFromSource: typeof import("./input-files.js").extractFileContentFromSource; -beforeAll(async () => { +beforeEach(async () => { + vi.resetModules(); + vi.clearAllMocks(); ({ fetchWithGuard, extractImageContentFromSource, extractFileContentFromSource } = await import("./input-files.js")); }); -beforeEach(() => { - vi.clearAllMocks(); -}); - describe("HEIC input image normalization", () => { it("converts base64 HEIC images to JPEG before returning them", async () => { const normalized = Buffer.from("jpeg-normalized"); diff --git a/src/media/store.outside-workspace.test.ts b/src/media/store.outside-workspace.test.ts index 6483a856cd9..97c8c9df52b 100644 --- a/src/media/store.outside-workspace.test.ts +++ b/src/media/store.outside-workspace.test.ts @@ -1,6 +1,6 @@ import fs from "node:fs/promises"; import path from "node:path"; -import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; +import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; import { createTempHomeEnv, type TempHomeEnv } from "../test-utils/temp-home.js"; const mocks = vi.hoisted(() => ({ @@ -15,13 +15,22 @@ vi.mock("../infra/fs-safe.js", async (importOriginal) => { }; }); -const { saveMediaSource } = await import("./store.js"); -const { SafeOpenError } = await import("../infra/fs-safe.js"); +type StoreModule = typeof import("./store.js"); +type FsSafeModule = typeof import("../infra/fs-safe.js"); + +let saveMediaSource: StoreModule["saveMediaSource"]; +let SafeOpenError: FsSafeModule["SafeOpenError"]; describe("media store outside-workspace mapping", () => { let tempHome: TempHomeEnv; let home = ""; + beforeEach(async () => { + vi.resetModules(); + ({ saveMediaSource } = await import("./store.js")); + ({ SafeOpenError } = await import("../infra/fs-safe.js")); + }); + beforeAll(async () => { tempHome = await createTempHomeEnv("openclaw-media-store-test-home-"); home = tempHome.home; diff --git a/src/memory/batch-http.test.ts b/src/memory/batch-http.test.ts index d70cdf292a2..275e3725eb9 100644 --- a/src/memory/batch-http.test.ts +++ b/src/memory/batch-http.test.ts @@ -1,7 +1,4 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { retryAsync } from "../infra/retry.js"; -import { postJsonWithRetry } from "./batch-http.js"; -import { postJson } from "./post-json.js"; vi.mock("../infra/retry.js", () => ({ retryAsync: vi.fn(async (run: () => Promise) => await run()), @@ -12,11 +9,18 @@ vi.mock("./post-json.js", () => ({ })); describe("postJsonWithRetry", () => { - const retryAsyncMock = vi.mocked(retryAsync); - const postJsonMock = vi.mocked(postJson); + let retryAsyncMock: ReturnType>; + let postJsonMock: ReturnType>; + let postJsonWithRetry: typeof import("./batch-http.js").postJsonWithRetry; - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); vi.clearAllMocks(); + ({ postJsonWithRetry } = await import("./batch-http.js")); + const retryModule = await import("../infra/retry.js"); + const postJsonModule = await import("./post-json.js"); + retryAsyncMock = vi.mocked(retryModule.retryAsync); + postJsonMock = vi.mocked(postJsonModule.postJson); }); it("posts JSON and returns parsed response payload", async () => { diff --git a/src/memory/embedding-manager.test-harness.ts b/src/memory/embedding-manager.test-harness.ts index 6835c9cce27..c0e973fade1 100644 --- a/src/memory/embedding-manager.test-harness.ts +++ b/src/memory/embedding-manager.test-harness.ts @@ -1,14 +1,12 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; -import { afterAll, beforeAll, beforeEach, expect } from "vitest"; +import { afterAll, beforeAll, beforeEach, expect, vi, type Mock } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; -import { getEmbedBatchMock, resetEmbeddingMocks } from "./embedding.test-mocks.js"; -import { - getMemorySearchManager, - type MemoryIndexManager, - type MemorySearchManager, -} from "./index.js"; +import type { MemoryIndexManager, MemorySearchManager } from "./index.js"; + +type EmbeddingTestMocksModule = typeof import("./embedding.test-mocks.js"); +type MemoryIndexModule = typeof import("./index.js"); export function installEmbeddingManagerFixture(opts: { fixturePrefix: string; @@ -21,7 +19,6 @@ export function installEmbeddingManagerFixture(opts: { }) => OpenClawConfig; resetIndexEachTest?: boolean; }) { - const embedBatch = getEmbedBatchMock(); const resetIndexEachTest = opts.resetIndexEachTest ?? true; let fixtureRoot: string | undefined; @@ -29,6 +26,9 @@ export function installEmbeddingManagerFixture(opts: { let memoryDir: string | undefined; let managerLarge: MemoryIndexManager | undefined; let managerSmall: MemoryIndexManager | undefined; + let embedBatch: Mock<(texts: string[]) => Promise> | undefined; + let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; + let resetEmbeddingMocks: EmbeddingTestMocksModule["resetEmbeddingMocks"]; const resetManager = (manager: MemoryIndexManager) => { (manager as unknown as { resetIndex: () => void }).resetIndex(); @@ -56,6 +56,12 @@ export function installEmbeddingManagerFixture(opts: { }; beforeAll(async () => { + vi.resetModules(); + await import("./embedding.test-mocks.js"); + const embeddingMocks = await import("./embedding.test-mocks.js"); + embedBatch = embeddingMocks.getEmbedBatchMock(); + resetEmbeddingMocks = embeddingMocks.resetEmbeddingMocks; + ({ getMemorySearchManager } = await import("./index.js")); fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), opts.fixturePrefix)); workspaceDir = path.join(fixtureRoot, "workspace"); memoryDir = path.join(workspaceDir, "memory"); @@ -116,7 +122,9 @@ export function installEmbeddingManagerFixture(opts: { }); return { - embedBatch, + get embedBatch() { + return requireValue(embedBatch, "embedBatch"); + }, getFixtureRoot: () => requireValue(fixtureRoot, "fixtureRoot"), getWorkspaceDir: () => requireValue(workspaceDir, "workspaceDir"), getMemoryDir: () => requireValue(memoryDir, "memoryDir"), diff --git a/src/memory/embeddings-remote-fetch.test.ts b/src/memory/embeddings-remote-fetch.test.ts index bcef98fafda..eeaa39e9277 100644 --- a/src/memory/embeddings-remote-fetch.test.ts +++ b/src/memory/embeddings-remote-fetch.test.ts @@ -1,15 +1,20 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { fetchRemoteEmbeddingVectors } from "./embeddings-remote-fetch.js"; import { postJson } from "./post-json.js"; vi.mock("./post-json.js", () => ({ postJson: vi.fn(), })); +type EmbeddingsRemoteFetchModule = typeof import("./embeddings-remote-fetch.js"); + +let fetchRemoteEmbeddingVectors: EmbeddingsRemoteFetchModule["fetchRemoteEmbeddingVectors"]; + describe("fetchRemoteEmbeddingVectors", () => { const postJsonMock = vi.mocked(postJson); - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ fetchRemoteEmbeddingVectors } = await import("./embeddings-remote-fetch.js")); vi.clearAllMocks(); }); diff --git a/src/memory/embeddings-voyage.test.ts b/src/memory/embeddings-voyage.test.ts index ccc164bd064..9dac8c04d75 100644 --- a/src/memory/embeddings-voyage.test.ts +++ b/src/memory/embeddings-voyage.test.ts @@ -1,7 +1,5 @@ -import { afterEach, describe, expect, it, vi } from "vitest"; -import * as authModule from "../agents/model-auth.js"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { type FetchMock, withFetchPreconnect } from "../test-utils/fetch-mock.js"; -import { createVoyageEmbeddingProvider, normalizeVoyageModel } from "./embeddings-voyage.js"; import { mockPublicPinnedHostname } from "./test-helpers/ssrf.js"; vi.mock("../agents/model-auth.js", async () => { @@ -20,6 +18,17 @@ const createFetchMock = () => { return withFetchPreconnect(fetchMock); }; +let authModule: typeof import("../agents/model-auth.js"); +let createVoyageEmbeddingProvider: typeof import("./embeddings-voyage.js").createVoyageEmbeddingProvider; +let normalizeVoyageModel: typeof import("./embeddings-voyage.js").normalizeVoyageModel; + +beforeEach(async () => { + vi.resetModules(); + authModule = await import("../agents/model-auth.js"); + ({ createVoyageEmbeddingProvider, normalizeVoyageModel } = + await import("./embeddings-voyage.js")); +}); + function mockVoyageApiKey() { vi.mocked(authModule.resolveApiKeyForProvider).mockResolvedValue({ apiKey: "voyage-key-123", diff --git a/src/memory/embeddings.test.ts b/src/memory/embeddings.test.ts index f15624ee1cb..e9a533f4f9d 100644 --- a/src/memory/embeddings.test.ts +++ b/src/memory/embeddings.test.ts @@ -1,7 +1,5 @@ -import { afterEach, describe, expect, it, vi } from "vitest"; -import * as authModule from "../agents/model-auth.js"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { DEFAULT_GEMINI_EMBEDDING_MODEL } from "./embeddings-gemini.js"; -import { createEmbeddingProvider, DEFAULT_LOCAL_MODEL } from "./embeddings.js"; import { mockPublicPinnedHostname } from "./test-helpers/ssrf.js"; vi.mock("../agents/model-auth.js", async () => { @@ -33,12 +31,25 @@ function readFirstFetchRequest(fetchMock: { mock: { calls: unknown[][] } }) { return { url, init: init as RequestInit | undefined }; } +type EmbeddingsModule = typeof import("./embeddings.js"); +type AuthModule = typeof import("../agents/model-auth.js"); + +let authModule: AuthModule; +let createEmbeddingProvider: EmbeddingsModule["createEmbeddingProvider"]; +let DEFAULT_LOCAL_MODEL: EmbeddingsModule["DEFAULT_LOCAL_MODEL"]; + +beforeEach(async () => { + vi.resetModules(); + authModule = await import("../agents/model-auth.js"); + ({ createEmbeddingProvider, DEFAULT_LOCAL_MODEL } = await import("./embeddings.js")); +}); + afterEach(() => { vi.resetAllMocks(); vi.unstubAllGlobals(); }); -function requireProvider(result: Awaited>) { +function requireProvider(result: Awaited>) { if (!result.provider) { throw new Error("Expected embedding provider"); } @@ -71,7 +82,7 @@ function createLocalProvider(options?: { fallback?: "none" | "openai" }) { } function expectAutoSelectedProvider( - result: Awaited>, + result: Awaited>, expectedId: "openai" | "gemini" | "mistral", ) { expect(result.requestedProvider).toBe("auto"); diff --git a/src/memory/index.test.ts b/src/memory/index.test.ts index dcb0b061073..1072eab2cc4 100644 --- a/src/memory/index.test.ts +++ b/src/memory/index.test.ts @@ -3,8 +3,12 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; import "./test-runtime-mocks.js"; +import type { MemoryIndexManager } from "./index.js"; + +type MemoryIndexModule = typeof import("./index.js"); + +let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; let embedBatchCalls = 0; let embedBatchInputCalls = 0; @@ -151,6 +155,9 @@ describe("memory index", () => { }); beforeEach(async () => { + vi.resetModules(); + await import("./test-runtime-mocks.js"); + ({ getMemorySearchManager } = await import("./index.js")); // Perf: most suites don't need atomic swap behavior for full reindexes. // Keep atomic reindex tests on the safe path. vi.stubEnv("OPENCLAW_TEST_MEMORY_UNSAFE_REINDEX", "1"); diff --git a/src/memory/manager.atomic-reindex.test.ts b/src/memory/manager.atomic-reindex.test.ts index d7d610312f5..b4dd35f9f37 100644 --- a/src/memory/manager.atomic-reindex.test.ts +++ b/src/memory/manager.atomic-reindex.test.ts @@ -3,25 +3,33 @@ import os from "node:os"; import path from "node:path"; import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; -import { getEmbedBatchMock, resetEmbeddingMocks } from "./embedding.test-mocks.js"; import type { MemoryIndexManager } from "./index.js"; -import { getRequiredMemoryIndexManager } from "./test-manager-helpers.js"; let shouldFail = false; +type EmbeddingTestMocksModule = typeof import("./embedding.test-mocks.js"); +type TestManagerHelpersModule = typeof import("./test-manager-helpers.js"); + describe("memory manager atomic reindex", () => { let fixtureRoot = ""; let caseId = 0; let workspaceDir: string; let indexPath: string; let manager: MemoryIndexManager | null = null; - const embedBatch = getEmbedBatchMock(); + let embedBatch: ReturnType; + let resetEmbeddingMocks: EmbeddingTestMocksModule["resetEmbeddingMocks"]; + let getRequiredMemoryIndexManager: TestManagerHelpersModule["getRequiredMemoryIndexManager"]; beforeAll(async () => { fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-mem-atomic-")); }); beforeEach(async () => { + vi.resetModules(); + const embeddingMocks = await import("./embedding.test-mocks.js"); + embedBatch = embeddingMocks.getEmbedBatchMock(); + resetEmbeddingMocks = embeddingMocks.resetEmbeddingMocks; + ({ getRequiredMemoryIndexManager } = await import("./test-manager-helpers.js")); vi.stubEnv("OPENCLAW_TEST_MEMORY_UNSAFE_REINDEX", "0"); resetEmbeddingMocks(); shouldFail = false; diff --git a/src/memory/manager.batch.test.ts b/src/memory/manager.batch.test.ts index 453f1a6c815..38be2020f35 100644 --- a/src/memory/manager.batch.test.ts +++ b/src/memory/manager.batch.test.ts @@ -4,21 +4,15 @@ import path from "node:path"; import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; import { useFastShortTimeouts } from "../../test/helpers/fast-short-timeouts.js"; import type { OpenClawConfig } from "../config/config.js"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; import { createOpenAIEmbeddingProviderMock } from "./test-embeddings-mock.js"; import { mockPublicPinnedHostname } from "./test-helpers/ssrf.js"; -import "./test-runtime-mocks.js"; + +type MemoryIndexManager = import("./index.js").MemoryIndexManager; +type MemoryIndexModule = typeof import("./index.js"); const embedBatch = vi.fn(async (_texts: string[]) => [] as number[][]); const embedQuery = vi.fn(async () => [0.5, 0.5, 0.5]); - -vi.mock("./embeddings.js", () => ({ - createEmbeddingProvider: async () => - createOpenAIEmbeddingProviderMock({ - embedQuery, - embedBatch, - }), -})); +let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; describe("memory indexing with OpenAI batches", () => { let fixtureRoot: string; @@ -118,6 +112,17 @@ describe("memory indexing with OpenAI batches", () => { } beforeAll(async () => { + vi.resetModules(); + vi.doMock("./embeddings.js", () => ({ + createEmbeddingProvider: async () => + createOpenAIEmbeddingProviderMock({ + embedQuery, + embedBatch, + }), + })); + await import("./test-runtime-mocks.js"); + ({ getMemorySearchManager } = await import("./index.js")); + fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-mem-batch-")); workspaceDir = path.join(fixtureRoot, "workspace"); memoryDir = path.join(workspaceDir, "memory"); diff --git a/src/memory/manager.embedding-batches.test.ts b/src/memory/manager.embedding-batches.test.ts index e2af1ed97f2..d7b1071deed 100644 --- a/src/memory/manager.embedding-batches.test.ts +++ b/src/memory/manager.embedding-batches.test.ts @@ -25,7 +25,6 @@ const fx = installEmbeddingManagerFixture({ }, }), }); -const { embedBatch } = fx; describe("memory embedding batches", () => { async function expectSyncWithFastTimeouts(manager: { @@ -55,13 +54,13 @@ describe("memory embedding batches", () => { }); const status = managerLarge.status(); - const totalTexts = embedBatch.mock.calls.reduce( + const totalTexts = fx.embedBatch.mock.calls.reduce( (sum: number, call: unknown[]) => sum + ((call[0] as string[] | undefined)?.length ?? 0), 0, ); expect(totalTexts).toBe(status.chunks); - expect(embedBatch.mock.calls.length).toBeGreaterThan(1); - const inputs: string[] = embedBatch.mock.calls.flatMap( + expect(fx.embedBatch.mock.calls.length).toBeGreaterThan(1); + const inputs: string[] = fx.embedBatch.mock.calls.flatMap( (call: unknown[]) => (call[0] as string[] | undefined) ?? [], ); expect(inputs.every((text) => Buffer.byteLength(text, "utf8") <= 8000)).toBe(true); @@ -80,7 +79,7 @@ describe("memory embedding batches", () => { await fs.writeFile(path.join(memoryDir, "2026-01-04.md"), content); await managerSmall.sync({ reason: "test" }); - expect(embedBatch.mock.calls.length).toBe(1); + expect(fx.embedBatch.mock.calls.length).toBe(1); }); it("retries embeddings on transient rate limit and 5xx errors", async () => { @@ -95,7 +94,7 @@ describe("memory embedding batches", () => { "openai embeddings failed: 502 Bad Gateway (cloudflare)", ]; let calls = 0; - embedBatch.mockImplementation(async (texts: string[]) => { + fx.embedBatch.mockImplementation(async (texts: string[]) => { calls += 1; const transient = transientErrors[calls - 1]; if (transient) { @@ -117,7 +116,7 @@ describe("memory embedding batches", () => { await fs.writeFile(path.join(memoryDir, "2026-01-08.md"), content); let calls = 0; - embedBatch.mockImplementation(async (texts: string[]) => { + fx.embedBatch.mockImplementation(async (texts: string[]) => { calls += 1; if (calls === 1) { throw new Error("AWS Bedrock embeddings failed: Too many tokens per day"); @@ -136,7 +135,9 @@ describe("memory embedding batches", () => { await fs.writeFile(path.join(memoryDir, "2026-01-07.md"), "\n\n\n"); await managerSmall.sync({ reason: "test" }); - const inputs = embedBatch.mock.calls.flatMap((call: unknown[]) => (call[0] as string[]) ?? []); + const inputs = fx.embedBatch.mock.calls.flatMap( + (call: unknown[]) => (call[0] as string[]) ?? [], + ); expect(inputs).not.toContain(""); }); }); diff --git a/src/memory/manager.get-concurrency.test.ts b/src/memory/manager.get-concurrency.test.ts index 515a9d8226d..236f6780b84 100644 --- a/src/memory/manager.get-concurrency.test.ts +++ b/src/memory/manager.get-concurrency.test.ts @@ -3,12 +3,11 @@ import os from "node:os"; import path from "node:path"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; -import { - closeAllMemoryIndexManagers, - MemoryIndexManager as RawMemoryIndexManager, -} from "./manager.js"; import "./test-runtime-mocks.js"; +import type { MemoryIndexManager } from "./index.js"; + +type MemoryIndexModule = typeof import("./index.js"); +type ManagerModule = typeof import("./manager.js"); const hoisted = vi.hoisted(() => ({ providerCreateCalls: 0, @@ -34,10 +33,19 @@ vi.mock("./embeddings.js", () => ({ }, })); +let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; +let closeAllMemoryIndexManagers: ManagerModule["closeAllMemoryIndexManagers"]; +let RawMemoryIndexManager: ManagerModule["MemoryIndexManager"]; + describe("memory manager cache hydration", () => { let workspaceDir = ""; beforeEach(async () => { + vi.resetModules(); + await import("./test-runtime-mocks.js"); + ({ getMemorySearchManager } = await import("./index.js")); + ({ closeAllMemoryIndexManagers, MemoryIndexManager: RawMemoryIndexManager } = + await import("./manager.js")); workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-mem-concurrent-")); await fs.mkdir(path.join(workspaceDir, "memory"), { recursive: true }); await fs.writeFile(path.join(workspaceDir, "MEMORY.md"), "Hello memory."); diff --git a/src/memory/manager.mistral-provider.test.ts b/src/memory/manager.mistral-provider.test.ts index 3345b01933c..be10e3c232b 100644 --- a/src/memory/manager.mistral-provider.test.ts +++ b/src/memory/manager.mistral-provider.test.ts @@ -11,7 +11,7 @@ import type { OllamaEmbeddingClient, OpenAiEmbeddingClient, } from "./embeddings.js"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; +import type { MemoryIndexManager } from "./index.js"; const { createEmbeddingProviderMock } = vi.hoisted(() => ({ createEmbeddingProviderMock: vi.fn(), @@ -25,6 +25,10 @@ vi.mock("./sqlite-vec.js", () => ({ loadSqliteVecExtension: async () => ({ ok: false, error: "sqlite-vec disabled in tests" }), })); +type MemoryIndexModule = typeof import("./index.js"); + +let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; + function createProvider(id: string): EmbeddingProvider { return { id, @@ -64,6 +68,8 @@ describe("memory manager mistral provider wiring", () => { let manager: MemoryIndexManager | null = null; beforeEach(async () => { + vi.resetModules(); + ({ getMemorySearchManager } = await import("./index.js")); createEmbeddingProviderMock.mockReset(); workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-memory-mistral-")); indexPath = path.join(workspaceDir, "index.sqlite"); diff --git a/src/memory/manager.vector-dedupe.test.ts b/src/memory/manager.vector-dedupe.test.ts index fcd21a88431..64242ec3f0e 100644 --- a/src/memory/manager.vector-dedupe.test.ts +++ b/src/memory/manager.vector-dedupe.test.ts @@ -4,8 +4,6 @@ import path from "node:path"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import type { MemoryIndexManager } from "./index.js"; -import { buildFileEntry } from "./internal.js"; -import { createMemoryManagerOrThrow } from "./test-manager.js"; vi.mock("./embeddings.js", () => { return { @@ -21,6 +19,12 @@ vi.mock("./embeddings.js", () => { }; }); +type MemoryInternalModule = typeof import("./internal.js"); +type TestManagerModule = typeof import("./test-manager.js"); + +let buildFileEntry: MemoryInternalModule["buildFileEntry"]; +let createMemoryManagerOrThrow: TestManagerModule["createMemoryManagerOrThrow"]; + describe("memory vector dedupe", () => { let workspaceDir: string; let indexPath: string; @@ -40,6 +44,9 @@ describe("memory vector dedupe", () => { } beforeEach(async () => { + vi.resetModules(); + ({ buildFileEntry } = await import("./internal.js")); + ({ createMemoryManagerOrThrow } = await import("./test-manager.js")); workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-mem-")); indexPath = path.join(workspaceDir, "index.sqlite"); await seedMemoryWorkspace(workspaceDir); diff --git a/src/memory/manager.watcher-config.test.ts b/src/memory/manager.watcher-config.test.ts index b10cf84c71f..36d1b830e4a 100644 --- a/src/memory/manager.watcher-config.test.ts +++ b/src/memory/manager.watcher-config.test.ts @@ -1,10 +1,10 @@ import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import type { MemorySearchConfig } from "../config/types.tools.js"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; +import type { MemoryIndexManager } from "./index.js"; const { watchMock } = vi.hoisted(() => ({ watchMock: vi.fn(() => ({ @@ -34,11 +34,20 @@ vi.mock("./embeddings.js", () => ({ }), })); +type MemoryIndexModule = typeof import("./index.js"); + +let getMemorySearchManager: MemoryIndexModule["getMemorySearchManager"]; + describe("memory watcher config", () => { let manager: MemoryIndexManager | null = null; let workspaceDir = ""; let extraDir = ""; + beforeEach(async () => { + vi.resetModules(); + ({ getMemorySearchManager } = await import("./index.js")); + }); + afterEach(async () => { watchMock.mockClear(); if (manager) { diff --git a/src/memory/post-json.test.ts b/src/memory/post-json.test.ts index 7e1aaf27cb6..1fd4210c111 100644 --- a/src/memory/post-json.test.ts +++ b/src/memory/post-json.test.ts @@ -1,16 +1,21 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { postJson } from "./post-json.js"; -import { withRemoteHttpResponse } from "./remote-http.js"; vi.mock("./remote-http.js", () => ({ withRemoteHttpResponse: vi.fn(), })); -describe("postJson", () => { - const remoteHttpMock = vi.mocked(withRemoteHttpResponse); +let postJson: typeof import("./post-json.js").postJson; +let withRemoteHttpResponse: typeof import("./remote-http.js").withRemoteHttpResponse; - beforeEach(() => { +describe("postJson", () => { + let remoteHttpMock: ReturnType>; + + beforeEach(async () => { + vi.resetModules(); vi.clearAllMocks(); + ({ postJson } = await import("./post-json.js")); + ({ withRemoteHttpResponse } = await import("./remote-http.js")); + remoteHttpMock = vi.mocked(withRemoteHttpResponse); }); it("parses JSON payload on successful response", async () => { diff --git a/src/memory/test-manager-helpers.ts b/src/memory/test-manager-helpers.ts index 4bbcf2d608e..cfe3f09e49f 100644 --- a/src/memory/test-manager-helpers.ts +++ b/src/memory/test-manager-helpers.ts @@ -1,10 +1,12 @@ import type { OpenClawConfig } from "../config/config.js"; -import { getMemorySearchManager, type MemoryIndexManager } from "./index.js"; +import type { MemoryIndexManager } from "./index.js"; export async function getRequiredMemoryIndexManager(params: { cfg: OpenClawConfig; agentId?: string; }): Promise { + await import("./embedding.test-mocks.js"); + const { getMemorySearchManager } = await import("./index.js"); const result = await getMemorySearchManager({ cfg: params.cfg, agentId: params.agentId ?? "main", diff --git a/src/pairing/setup-code.test.ts b/src/pairing/setup-code.test.ts index e72a9399623..6622f6c010f 100644 --- a/src/pairing/setup-code.test.ts +++ b/src/pairing/setup-code.test.ts @@ -1,6 +1,5 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { SecretInput } from "../config/types.secrets.js"; -import { encodePairingSetupCode, resolvePairingSetupFromConfig } from "./setup-code.js"; vi.mock("../infra/device-bootstrap.js", () => ({ issueDeviceBootstrapToken: vi.fn(async () => ({ @@ -9,6 +8,9 @@ vi.mock("../infra/device-bootstrap.js", () => ({ })), })); +let encodePairingSetupCode: typeof import("./setup-code.js").encodePairingSetupCode; +let resolvePairingSetupFromConfig: typeof import("./setup-code.js").resolvePairingSetupFromConfig; + describe("pairing setup code", () => { type ResolvedSetup = Awaited>; const defaultEnvSecretProviderConfig = { @@ -68,10 +70,17 @@ describe("pairing setup code", () => { } beforeEach(() => { + vi.resetModules(); vi.stubEnv("OPENCLAW_GATEWAY_TOKEN", ""); vi.stubEnv("CLAWDBOT_GATEWAY_TOKEN", ""); vi.stubEnv("OPENCLAW_GATEWAY_PASSWORD", ""); vi.stubEnv("CLAWDBOT_GATEWAY_PASSWORD", ""); + vi.stubEnv("OPENCLAW_GATEWAY_PORT", ""); + vi.stubEnv("CLAWDBOT_GATEWAY_PORT", ""); + }); + + beforeEach(async () => { + ({ encodePairingSetupCode, resolvePairingSetupFromConfig } = await import("./setup-code.js")); }); afterEach(() => { diff --git a/src/plugin-sdk/outbound-media.test.ts b/src/plugin-sdk/outbound-media.test.ts index bc56f2e6ea4..84b0db6def9 100644 --- a/src/plugin-sdk/outbound-media.test.ts +++ b/src/plugin-sdk/outbound-media.test.ts @@ -1,5 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; -import { loadOutboundMediaFromUrl } from "./outbound-media.js"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const loadWebMediaMock = vi.hoisted(() => vi.fn()); @@ -7,7 +6,17 @@ vi.mock("../../extensions/whatsapp/src/media.js", () => ({ loadWebMedia: loadWebMediaMock, })); +type OutboundMediaModule = typeof import("./outbound-media.js"); + +let loadOutboundMediaFromUrl: OutboundMediaModule["loadOutboundMediaFromUrl"]; + describe("loadOutboundMediaFromUrl", () => { + beforeEach(async () => { + vi.resetModules(); + ({ loadOutboundMediaFromUrl } = await import("./outbound-media.js")); + loadWebMediaMock.mockReset(); + }); + it("forwards maxBytes and mediaLocalRoots to loadWebMedia", async () => { loadWebMediaMock.mockResolvedValueOnce({ buffer: Buffer.from("x"), diff --git a/src/plugins/contracts/auth.contract.test.ts b/src/plugins/contracts/auth.contract.test.ts index 4842bef5e76..40a82482edd 100644 --- a/src/plugins/contracts/auth.contract.test.ts +++ b/src/plugins/contracts/auth.contract.test.ts @@ -4,43 +4,61 @@ import { replaceRuntimeAuthProfileStoreSnapshots, } from "../../agents/auth-profiles/store.js"; import { createNonExitingRuntime } from "../../runtime.js"; +import { createCapturedPluginRegistration } from "../../test-utils/plugin-registration.js"; import type { WizardMultiSelectParams, WizardPrompter, WizardProgress, WizardSelectParams, } from "../../wizard/prompts.js"; -import { registerProviders, requireProvider } from "./testkit.js"; +import type { OpenClawPluginApi, ProviderPlugin } from "../types.js"; type LoginOpenAICodexOAuth = - (typeof import("../../plugins/provider-openai-codex-oauth.js"))["loginOpenAICodexOAuth"]; + (typeof import("openclaw/plugin-sdk/provider-auth"))["loginOpenAICodexOAuth"]; type LoginQwenPortalOAuth = (typeof import("../../../extensions/qwen-portal-auth/oauth.js"))["loginQwenPortalOAuth"]; type GithubCopilotLoginCommand = - (typeof import("../../providers/github-copilot-auth.js"))["githubCopilotLoginCommand"]; + (typeof import("openclaw/plugin-sdk/provider-auth"))["githubCopilotLoginCommand"]; type CreateVpsAwareHandlers = - (typeof import("../../plugins/provider-oauth-flow.js"))["createVpsAwareOAuthHandlers"]; + (typeof import("../../commands/oauth-flow.js"))["createVpsAwareOAuthHandlers"]; const loginOpenAICodexOAuthMock = vi.hoisted(() => vi.fn()); const loginQwenPortalOAuthMock = vi.hoisted(() => vi.fn()); const githubCopilotLoginCommandMock = vi.hoisted(() => vi.fn()); -vi.mock("../../plugins/provider-openai-codex-oauth.js", () => ({ - loginOpenAICodexOAuth: loginOpenAICodexOAuthMock, -})); +vi.mock("openclaw/plugin-sdk/provider-auth", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + loginOpenAICodexOAuth: loginOpenAICodexOAuthMock, + githubCopilotLoginCommand: githubCopilotLoginCommandMock, + }; +}); vi.mock("../../../extensions/qwen-portal-auth/oauth.js", () => ({ loginQwenPortalOAuth: loginQwenPortalOAuthMock, })); -vi.mock("../../providers/github-copilot-auth.js", () => ({ - githubCopilotLoginCommand: githubCopilotLoginCommandMock, -})); - const openAIPlugin = (await import("../../../extensions/openai/index.js")).default; const qwenPortalPlugin = (await import("../../../extensions/qwen-portal-auth/index.js")).default; const githubCopilotPlugin = (await import("../../../extensions/github-copilot/index.js")).default; +function registerProviders(...plugins: Array<{ register(api: OpenClawPluginApi): void }>) { + const captured = createCapturedPluginRegistration(); + for (const plugin of plugins) { + plugin.register(captured.api); + } + return captured.providers; +} + +function requireProvider(providers: ProviderPlugin[], providerId: string) { + const provider = providers.find((entry) => entry.id === providerId); + if (!provider) { + throw new Error(`provider ${providerId} missing`); + } + return provider; +} + function buildPrompter(): WizardPrompter { const progress: WizardProgress = { update() {}, diff --git a/src/plugins/provider-runtime.test.ts b/src/plugins/provider-runtime.test.ts index 07ee1794562..c6cb64db8eb 100644 --- a/src/plugins/provider-runtime.test.ts +++ b/src/plugins/provider-runtime.test.ts @@ -23,30 +23,28 @@ vi.mock("./providers.js", () => ({ resolveOwningPluginIdsForProviderMock(params as never), })); -import { - augmentModelCatalogWithProviderPlugins, - buildProviderAuthDoctorHintWithPlugin, - buildProviderMissingAuthMessageWithPlugin, - formatProviderAuthProfileApiKeyWithPlugin, - prepareProviderExtraParams, - resolveProviderCacheTtlEligibility, - resolveProviderBinaryThinking, - resolveProviderBuiltInModelSuppression, - resolveProviderDefaultThinkingLevel, - resolveProviderModernModelRef, - resolveProviderUsageSnapshotWithPlugin, - resolveProviderCapabilitiesWithPlugin, - resolveProviderUsageAuthWithPlugin, - resolveProviderXHighThinking, - normalizeProviderResolvedModelWithPlugin, - prepareProviderDynamicModel, - prepareProviderRuntimeAuth, - resetProviderRuntimeHookCacheForTest, - refreshProviderOAuthCredentialWithPlugin, - resolveProviderRuntimePlugin, - runProviderDynamicModel, - wrapProviderStreamFn, -} from "./provider-runtime.js"; +let augmentModelCatalogWithProviderPlugins: typeof import("./provider-runtime.js").augmentModelCatalogWithProviderPlugins; +let buildProviderAuthDoctorHintWithPlugin: typeof import("./provider-runtime.js").buildProviderAuthDoctorHintWithPlugin; +let buildProviderMissingAuthMessageWithPlugin: typeof import("./provider-runtime.js").buildProviderMissingAuthMessageWithPlugin; +let formatProviderAuthProfileApiKeyWithPlugin: typeof import("./provider-runtime.js").formatProviderAuthProfileApiKeyWithPlugin; +let prepareProviderExtraParams: typeof import("./provider-runtime.js").prepareProviderExtraParams; +let resolveProviderCacheTtlEligibility: typeof import("./provider-runtime.js").resolveProviderCacheTtlEligibility; +let resolveProviderBinaryThinking: typeof import("./provider-runtime.js").resolveProviderBinaryThinking; +let resolveProviderBuiltInModelSuppression: typeof import("./provider-runtime.js").resolveProviderBuiltInModelSuppression; +let resolveProviderDefaultThinkingLevel: typeof import("./provider-runtime.js").resolveProviderDefaultThinkingLevel; +let resolveProviderModernModelRef: typeof import("./provider-runtime.js").resolveProviderModernModelRef; +let resolveProviderUsageSnapshotWithPlugin: typeof import("./provider-runtime.js").resolveProviderUsageSnapshotWithPlugin; +let resolveProviderCapabilitiesWithPlugin: typeof import("./provider-runtime.js").resolveProviderCapabilitiesWithPlugin; +let resolveProviderUsageAuthWithPlugin: typeof import("./provider-runtime.js").resolveProviderUsageAuthWithPlugin; +let resolveProviderXHighThinking: typeof import("./provider-runtime.js").resolveProviderXHighThinking; +let normalizeProviderResolvedModelWithPlugin: typeof import("./provider-runtime.js").normalizeProviderResolvedModelWithPlugin; +let prepareProviderDynamicModel: typeof import("./provider-runtime.js").prepareProviderDynamicModel; +let prepareProviderRuntimeAuth: typeof import("./provider-runtime.js").prepareProviderRuntimeAuth; +let resetProviderRuntimeHookCacheForTest: typeof import("./provider-runtime.js").resetProviderRuntimeHookCacheForTest; +let refreshProviderOAuthCredentialWithPlugin: typeof import("./provider-runtime.js").refreshProviderOAuthCredentialWithPlugin; +let resolveProviderRuntimePlugin: typeof import("./provider-runtime.js").resolveProviderRuntimePlugin; +let runProviderDynamicModel: typeof import("./provider-runtime.js").runProviderDynamicModel; +let wrapProviderStreamFn: typeof import("./provider-runtime.js").wrapProviderStreamFn; const MODEL: ProviderRuntimeModel = { id: "demo-model", @@ -62,7 +60,32 @@ const MODEL: ProviderRuntimeModel = { }; describe("provider-runtime", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ + augmentModelCatalogWithProviderPlugins, + buildProviderAuthDoctorHintWithPlugin, + buildProviderMissingAuthMessageWithPlugin, + formatProviderAuthProfileApiKeyWithPlugin, + prepareProviderExtraParams, + resolveProviderCacheTtlEligibility, + resolveProviderBinaryThinking, + resolveProviderBuiltInModelSuppression, + resolveProviderDefaultThinkingLevel, + resolveProviderModernModelRef, + resolveProviderUsageSnapshotWithPlugin, + resolveProviderCapabilitiesWithPlugin, + resolveProviderUsageAuthWithPlugin, + resolveProviderXHighThinking, + normalizeProviderResolvedModelWithPlugin, + prepareProviderDynamicModel, + prepareProviderRuntimeAuth, + resetProviderRuntimeHookCacheForTest, + refreshProviderOAuthCredentialWithPlugin, + resolveProviderRuntimePlugin, + runProviderDynamicModel, + wrapProviderStreamFn, + } = await import("./provider-runtime.js")); resetProviderRuntimeHookCacheForTest(); resolvePluginProvidersMock.mockReset(); resolvePluginProvidersMock.mockReturnValue([]); diff --git a/src/plugins/providers.test.ts b/src/plugins/providers.test.ts index bfc976a7abf..b8da58c1921 100644 --- a/src/plugins/providers.test.ts +++ b/src/plugins/providers.test.ts @@ -1,5 +1,4 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { resolveOwningPluginIdsForProvider, resolvePluginProviders } from "./providers.js"; const loadOpenClawPluginsMock = vi.fn(); const loadPluginManifestRegistryMock = vi.fn(); @@ -12,8 +11,12 @@ vi.mock("./manifest-registry.js", () => ({ loadPluginManifestRegistry: (...args: unknown[]) => loadPluginManifestRegistryMock(...args), })); +let resolveOwningPluginIdsForProvider: typeof import("./providers.js").resolveOwningPluginIdsForProvider; +let resolvePluginProviders: typeof import("./providers.js").resolvePluginProviders; + describe("resolvePluginProviders", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); loadOpenClawPluginsMock.mockReset(); loadOpenClawPluginsMock.mockReturnValue({ providers: [{ pluginId: "google", provider: { id: "demo-provider" } }], @@ -29,6 +32,8 @@ describe("resolvePluginProviders", () => { ], diagnostics: [], }); + ({ resolveOwningPluginIdsForProvider, resolvePluginProviders } = + await import("./providers.js")); }); it("forwards an explicit env to plugin loading", () => { diff --git a/src/plugins/tools.optional.test.ts b/src/plugins/tools.optional.test.ts index 80c41858733..c18f5008c31 100644 --- a/src/plugins/tools.optional.test.ts +++ b/src/plugins/tools.optional.test.ts @@ -1,5 +1,4 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { resolvePluginTools } from "./tools.js"; type MockRegistryToolEntry = { pluginId: string; @@ -14,6 +13,8 @@ vi.mock("./loader.js", () => ({ loadOpenClawPlugins: (params: unknown) => loadOpenClawPluginsMock(params), })); +let resolvePluginTools: typeof import("./tools.js").resolvePluginTools; + function makeTool(name: string) { return { name, @@ -90,8 +91,10 @@ function resolveOptionalDemoTools(toolAllowlist?: string[]) { } describe("resolvePluginTools optional tools", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); loadOpenClawPluginsMock.mockClear(); + ({ resolvePluginTools } = await import("./tools.js")); }); it("skips optional tools without explicit allowlist", () => { diff --git a/src/plugins/wired-hooks-compaction.test.ts b/src/plugins/wired-hooks-compaction.test.ts index 694f4a1f4b4..f8ce4d0a668 100644 --- a/src/plugins/wired-hooks-compaction.test.ts +++ b/src/plugins/wired-hooks-compaction.test.ts @@ -1,9 +1,8 @@ /** * Test: before_compaction & after_compaction hook wiring */ -import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import { makeZeroUsageSnapshot } from "../agents/usage.js"; -import { emitAgentEvent } from "../infra/agent-events.js"; const hookMocks = vi.hoisted(() => ({ runner: { @@ -11,13 +10,6 @@ const hookMocks = vi.hoisted(() => ({ runBeforeCompaction: vi.fn(async () => {}), runAfterCompaction: vi.fn(async () => {}), }, -})); - -vi.mock("../plugins/hook-runner-global.js", () => ({ - getGlobalHookRunner: () => hookMocks.runner, -})); - -vi.mock("../infra/agent-events.js", () => ({ emitAgentEvent: vi.fn(), })); @@ -25,19 +17,23 @@ describe("compaction hook wiring", () => { let handleAutoCompactionStart: typeof import("../agents/pi-embedded-subscribe.handlers.compaction.js").handleAutoCompactionStart; let handleAutoCompactionEnd: typeof import("../agents/pi-embedded-subscribe.handlers.compaction.js").handleAutoCompactionEnd; - beforeAll(async () => { - ({ handleAutoCompactionStart, handleAutoCompactionEnd } = - await import("../agents/pi-embedded-subscribe.handlers.compaction.js")); - }); - - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); hookMocks.runner.hasHooks.mockClear(); hookMocks.runner.hasHooks.mockReturnValue(false); hookMocks.runner.runBeforeCompaction.mockClear(); hookMocks.runner.runBeforeCompaction.mockResolvedValue(undefined); hookMocks.runner.runAfterCompaction.mockClear(); hookMocks.runner.runAfterCompaction.mockResolvedValue(undefined); - vi.mocked(emitAgentEvent).mockClear(); + hookMocks.emitAgentEvent.mockClear(); + vi.doMock("../plugins/hook-runner-global.js", () => ({ + getGlobalHookRunner: () => hookMocks.runner, + })); + vi.doMock("../infra/agent-events.js", () => ({ + emitAgentEvent: hookMocks.emitAgentEvent, + })); + ({ handleAutoCompactionStart, handleAutoCompactionEnd } = + await import("../agents/pi-embedded-subscribe.handlers.compaction.js")); }); function createCompactionEndCtx(params: { @@ -94,7 +90,7 @@ describe("compaction hook wiring", () => { const hookCtx = beforeCalls[0]?.[1] as { sessionKey?: string } | undefined; expect(hookCtx?.sessionKey).toBe("agent:main:web-abc123"); expect(ctx.ensureCompactionPromise).toHaveBeenCalledTimes(1); - expect(emitAgentEvent).toHaveBeenCalledWith({ + expect(hookMocks.emitAgentEvent).toHaveBeenCalledWith({ runId: "r1", stream: "compaction", data: { phase: "start" }, @@ -135,7 +131,7 @@ describe("compaction hook wiring", () => { expect(event?.compactedCount).toBe(1); expect(ctx.incrementCompactionCount).toHaveBeenCalledTimes(1); expect(ctx.maybeResolveCompactionWait).toHaveBeenCalledTimes(1); - expect(emitAgentEvent).toHaveBeenCalledWith({ + expect(hookMocks.emitAgentEvent).toHaveBeenCalledWith({ runId: "r2", stream: "compaction", data: { phase: "end", willRetry: false, completed: true }, @@ -166,7 +162,7 @@ describe("compaction hook wiring", () => { expect(ctx.noteCompactionRetry).toHaveBeenCalledTimes(1); expect(ctx.resetForCompactionRetry).toHaveBeenCalledTimes(1); expect(ctx.maybeResolveCompactionWait).not.toHaveBeenCalled(); - expect(emitAgentEvent).toHaveBeenCalledWith({ + expect(hookMocks.emitAgentEvent).toHaveBeenCalledWith({ runId: "r3", stream: "compaction", data: { phase: "end", willRetry: true, completed: true }, diff --git a/src/process/command-queue.test.ts b/src/process/command-queue.test.ts index b6e6f17cd85..a35512d4f0d 100644 --- a/src/process/command-queue.test.ts +++ b/src/process/command-queue.test.ts @@ -17,19 +17,19 @@ vi.mock("../logging/diagnostic.js", () => ({ diagnosticLogger: diagnosticMocks.diag, })); -import { - clearCommandLane, - CommandLaneClearedError, - enqueueCommand, - enqueueCommandInLane, - GatewayDrainingError, - getActiveTaskCount, - getQueueSize, - markGatewayDraining, - resetAllLanes, - setCommandLaneConcurrency, - waitForActiveTasks, -} from "./command-queue.js"; +type CommandQueueModule = typeof import("./command-queue.js"); + +let clearCommandLane: CommandQueueModule["clearCommandLane"]; +let CommandLaneClearedError: CommandQueueModule["CommandLaneClearedError"]; +let enqueueCommand: CommandQueueModule["enqueueCommand"]; +let enqueueCommandInLane: CommandQueueModule["enqueueCommandInLane"]; +let GatewayDrainingError: CommandQueueModule["GatewayDrainingError"]; +let getActiveTaskCount: CommandQueueModule["getActiveTaskCount"]; +let getQueueSize: CommandQueueModule["getQueueSize"]; +let markGatewayDraining: CommandQueueModule["markGatewayDraining"]; +let resetAllLanes: CommandQueueModule["resetAllLanes"]; +let setCommandLaneConcurrency: CommandQueueModule["setCommandLaneConcurrency"]; +let waitForActiveTasks: CommandQueueModule["waitForActiveTasks"]; function createDeferred(): { promise: Promise; resolve: () => void } { let resolve!: () => void; @@ -54,7 +54,21 @@ function enqueueBlockedMainTask( } describe("command queue", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ + clearCommandLane, + CommandLaneClearedError, + enqueueCommand, + enqueueCommandInLane, + GatewayDrainingError, + getActiveTaskCount, + getQueueSize, + markGatewayDraining, + resetAllLanes, + setCommandLaneConcurrency, + waitForActiveTasks, + } = await import("./command-queue.js")); resetAllLanes(); diagnosticMocks.logLaneEnqueue.mockClear(); diagnosticMocks.logLaneDequeue.mockClear(); diff --git a/src/process/exec.no-output-timer.test.ts b/src/process/exec.no-output-timer.test.ts index 9c851f1e1a2..dfd7348877a 100644 --- a/src/process/exec.no-output-timer.test.ts +++ b/src/process/exec.no-output-timer.test.ts @@ -1,6 +1,6 @@ import type { ChildProcess } from "node:child_process"; import { EventEmitter } from "node:events"; -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; const spawnMock = vi.hoisted(() => vi.fn()); @@ -12,7 +12,9 @@ vi.mock("node:child_process", async () => { }; }); -import { runCommandWithTimeout } from "./exec.js"; +type ExecModule = typeof import("./exec.js"); + +let runCommandWithTimeout: ExecModule["runCommandWithTimeout"]; function createFakeSpawnedChild() { const child = new EventEmitter() as EventEmitter & ChildProcess; @@ -39,6 +41,11 @@ function createFakeSpawnedChild() { } describe("runCommandWithTimeout no-output timer", () => { + beforeEach(async () => { + vi.resetModules(); + ({ runCommandWithTimeout } = await import("./exec.js")); + }); + afterEach(() => { vi.useRealTimers(); vi.restoreAllMocks(); diff --git a/src/process/exec.windows.test.ts b/src/process/exec.windows.test.ts index 85600755dac..b2357858565 100644 --- a/src/process/exec.windows.test.ts +++ b/src/process/exec.windows.test.ts @@ -1,5 +1,5 @@ import { EventEmitter } from "node:events"; -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; const spawnMock = vi.hoisted(() => vi.fn()); const execFileMock = vi.hoisted(() => vi.fn()); @@ -13,7 +13,8 @@ vi.mock("node:child_process", async (importOriginal) => { }; }); -import { runCommandWithTimeout, runExec } from "./exec.js"; +let runCommandWithTimeout: typeof import("./exec.js").runCommandWithTimeout; +let runExec: typeof import("./exec.js").runExec; type MockChild = EventEmitter & { stdout: EventEmitter; @@ -64,6 +65,11 @@ function expectCmdWrappedInvocation(params: { } describe("windows command wrapper behavior", () => { + beforeEach(async () => { + vi.resetModules(); + ({ runCommandWithTimeout, runExec } = await import("./exec.js")); + }); + afterEach(() => { spawnMock.mockReset(); execFileMock.mockReset(); diff --git a/src/process/kill-tree.test.ts b/src/process/kill-tree.test.ts index a506442aed4..7260938b438 100644 --- a/src/process/kill-tree.test.ts +++ b/src/process/kill-tree.test.ts @@ -1,5 +1,4 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { killProcessTree } from "./kill-tree.js"; const { spawnMock } = vi.hoisted(() => ({ spawnMock: vi.fn(), @@ -9,6 +8,8 @@ vi.mock("node:child_process", () => ({ spawn: (...args: unknown[]) => spawnMock(...args), })); +let killProcessTree: typeof import("./kill-tree.js").killProcessTree; + async function withPlatform(platform: NodeJS.Platform, run: () => Promise | T): Promise { const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform"); Object.defineProperty(process, "platform", { value: platform, configurable: true }); @@ -24,7 +25,9 @@ async function withPlatform(platform: NodeJS.Platform, run: () => Promise describe("killProcessTree", () => { let killSpy: ReturnType; - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); + ({ killProcessTree } = await import("./kill-tree.js")); spawnMock.mockClear(); killSpy = vi.spyOn(process, "kill"); vi.useFakeTimers(); diff --git a/src/process/supervisor/adapters/child.test.ts b/src/process/supervisor/adapters/child.test.ts index 8494a701c7e..2d3040f8811 100644 --- a/src/process/supervisor/adapters/child.test.ts +++ b/src/process/supervisor/adapters/child.test.ts @@ -1,7 +1,7 @@ import type { ChildProcess } from "node:child_process"; import { EventEmitter } from "node:events"; import { PassThrough } from "node:stream"; -import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { afterAll, beforeEach, describe, expect, it, vi } from "vitest"; const { spawnWithFallbackMock, killProcessTreeMock } = vi.hoisted(() => ({ spawnWithFallbackMock: vi.fn(), @@ -51,11 +51,9 @@ async function createAdapterHarness(params?: { describe("createChildAdapter", () => { const originalServiceMarker = process.env.OPENCLAW_SERVICE_MARKER; - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); ({ createChildAdapter } = await import("./child.js")); - }); - - beforeEach(() => { spawnWithFallbackMock.mockClear(); killProcessTreeMock.mockClear(); delete process.env.OPENCLAW_SERVICE_MARKER; diff --git a/src/process/supervisor/adapters/pty.test.ts b/src/process/supervisor/adapters/pty.test.ts index 32ca418b533..83e650c073a 100644 --- a/src/process/supervisor/adapters/pty.test.ts +++ b/src/process/supervisor/adapters/pty.test.ts @@ -1,4 +1,4 @@ -import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; const { spawnMock, ptyKillMock, killProcessTreeMock } = vi.hoisted(() => ({ spawnMock: vi.fn(), @@ -39,11 +39,9 @@ function expectSpawnEnv() { describe("createPtyAdapter", () => { let createPtyAdapter: typeof import("./pty.js").createPtyAdapter; - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); ({ createPtyAdapter } = await import("./pty.js")); - }); - - beforeEach(() => { spawnMock.mockClear(); ptyKillMock.mockClear(); killProcessTreeMock.mockClear(); diff --git a/src/process/supervisor/supervisor.pty-command.test.ts b/src/process/supervisor/supervisor.pty-command.test.ts index daee348944d..eb3427d462f 100644 --- a/src/process/supervisor/supervisor.pty-command.test.ts +++ b/src/process/supervisor/supervisor.pty-command.test.ts @@ -1,4 +1,4 @@ -import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; const { createPtyAdapterMock } = vi.hoisted(() => ({ createPtyAdapterMock: vi.fn(), @@ -35,11 +35,9 @@ function createStubPtyAdapter() { describe("process supervisor PTY command contract", () => { let createProcessSupervisor: typeof import("./supervisor.js").createProcessSupervisor; - beforeAll(async () => { + beforeEach(async () => { + vi.resetModules(); ({ createProcessSupervisor } = await import("./supervisor.js")); - }); - - beforeEach(() => { createPtyAdapterMock.mockClear(); }); diff --git a/src/security/windows-acl.test.ts b/src/security/windows-acl.test.ts index f9cb67fa4e5..6f073e34a10 100644 --- a/src/security/windows-acl.test.ts +++ b/src/security/windows-acl.test.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import type { WindowsAclEntry, WindowsAclSummary } from "./windows-acl.js"; const MOCK_USERNAME = "MockUser"; @@ -8,15 +8,26 @@ vi.mock("node:os", () => ({ userInfo: () => ({ username: MOCK_USERNAME }), })); -const { - createIcaclsResetCommand, - formatIcaclsResetCommand, - formatWindowsAclSummary, - inspectWindowsAcl, - parseIcaclsOutput, - resolveWindowsUserPrincipal, - summarizeWindowsAcl, -} = await import("./windows-acl.js"); +let createIcaclsResetCommand: typeof import("./windows-acl.js").createIcaclsResetCommand; +let formatIcaclsResetCommand: typeof import("./windows-acl.js").formatIcaclsResetCommand; +let formatWindowsAclSummary: typeof import("./windows-acl.js").formatWindowsAclSummary; +let inspectWindowsAcl: typeof import("./windows-acl.js").inspectWindowsAcl; +let parseIcaclsOutput: typeof import("./windows-acl.js").parseIcaclsOutput; +let resolveWindowsUserPrincipal: typeof import("./windows-acl.js").resolveWindowsUserPrincipal; +let summarizeWindowsAcl: typeof import("./windows-acl.js").summarizeWindowsAcl; + +beforeEach(async () => { + vi.resetModules(); + ({ + createIcaclsResetCommand, + formatIcaclsResetCommand, + formatWindowsAclSummary, + inspectWindowsAcl, + parseIcaclsOutput, + resolveWindowsUserPrincipal, + summarizeWindowsAcl, + } = await import("./windows-acl.js")); +}); function aclEntry(params: { principal: string; diff --git a/src/tts/edge-tts-validation.test.ts b/src/tts/edge-tts-validation.test.ts index 08697a2c9bd..51e4dbce39f 100644 --- a/src/tts/edge-tts-validation.test.ts +++ b/src/tts/edge-tts-validation.test.ts @@ -1,7 +1,7 @@ import { mkdtempSync, rmSync, writeFileSync } from "node:fs"; import { tmpdir } from "node:os"; import path from "node:path"; -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; let mockTtsPromise = vi.fn<(text: string, filePath: string) => Promise>(); @@ -13,7 +13,9 @@ vi.mock("node-edge-tts", () => ({ }, })); -const { edgeTTS } = await import("./tts-core.js"); +type TtsCoreModule = typeof import("./tts-core.js"); + +let edgeTTS: TtsCoreModule["edgeTTS"]; const baseEdgeConfig = { enabled: true, @@ -27,6 +29,11 @@ const baseEdgeConfig = { describe("edgeTTS – empty audio validation", () => { let tempDir: string; + beforeEach(async () => { + vi.resetModules(); + ({ edgeTTS } = await import("./tts-core.js")); + }); + afterEach(() => { rmSync(tempDir, { recursive: true, force: true }); }); diff --git a/src/tts/tts.test.ts b/src/tts/tts.test.ts index 16b91b6f330..05e902ef20c 100644 --- a/src/tts/tts.test.ts +++ b/src/tts/tts.test.ts @@ -362,20 +362,43 @@ describe("tts", () => { }); describe("summarizeText", () => { + let summarizeTextForTest: typeof summarizeText; + let resolveTtsConfigForTest: typeof resolveTtsConfig; + let completeSimpleForTest: typeof completeSimple; + let getApiKeyForModelForTest: typeof getApiKeyForModel; + let resolveModelAsyncForTest: typeof resolveModelAsync; + let ensureCustomApiRegisteredForTest: typeof ensureCustomApiRegistered; + const baseCfg: OpenClawConfig = { agents: { defaults: { model: { primary: "openai/gpt-4o-mini" } } }, messages: { tts: {} }, }; - const baseConfig = resolveTtsConfig(baseCfg); + + beforeEach(async () => { + vi.resetModules(); + ({ completeSimple: completeSimpleForTest } = await import("@mariozechner/pi-ai")); + ({ getApiKeyForModel: getApiKeyForModelForTest } = await import("../agents/model-auth.js")); + ({ resolveModelAsync: resolveModelAsyncForTest } = + await import("../agents/pi-embedded-runner/model.js")); + ({ ensureCustomApiRegistered: ensureCustomApiRegisteredForTest } = + await import("../agents/custom-api-registry.js")); + const ttsModule = await import("./tts.js"); + summarizeTextForTest = ttsModule._test.summarizeText; + resolveTtsConfigForTest = ttsModule.resolveTtsConfig; + vi.mocked(completeSimpleForTest).mockResolvedValue( + mockAssistantMessage([{ type: "text", text: "Summary" }]), + ); + }); it("summarizes text and returns result with metrics", async () => { const mockSummary = "This is a summarized version of the text."; - vi.mocked(completeSimple).mockResolvedValue( + const baseConfig = resolveTtsConfigForTest(baseCfg); + vi.mocked(completeSimpleForTest).mockResolvedValue( mockAssistantMessage([{ type: "text", text: mockSummary }]), ); const longText = "A".repeat(2000); - const result = await summarizeText({ + const result = await summarizeTextForTest({ text: longText, targetLength: 1500, cfg: baseCfg, @@ -387,11 +410,12 @@ describe("tts", () => { expect(result.inputLength).toBe(2000); expect(result.outputLength).toBe(mockSummary.length); expect(result.latencyMs).toBeGreaterThanOrEqual(0); - expect(completeSimple).toHaveBeenCalledTimes(1); + expect(completeSimpleForTest).toHaveBeenCalledTimes(1); }); it("calls the summary model with the expected parameters", async () => { - await summarizeText({ + const baseConfig = resolveTtsConfigForTest(baseCfg); + await summarizeTextForTest({ text: "Long text to summarize", targetLength: 500, cfg: baseCfg, @@ -399,11 +423,11 @@ describe("tts", () => { timeoutMs: 30_000, }); - const callArgs = vi.mocked(completeSimple).mock.calls[0]; + const callArgs = vi.mocked(completeSimpleForTest).mock.calls[0]; expect(callArgs?.[1]?.messages?.[0]?.role).toBe("user"); expect(callArgs?.[2]?.maxTokens).toBe(250); expect(callArgs?.[2]?.temperature).toBe(0.3); - expect(getApiKeyForModel).toHaveBeenCalledTimes(1); + expect(getApiKeyForModelForTest).toHaveBeenCalledTimes(1); }); it("uses summaryModel override when configured", async () => { @@ -411,8 +435,8 @@ describe("tts", () => { agents: { defaults: { model: { primary: "anthropic/claude-opus-4-5" } } }, messages: { tts: { summaryModel: "openai/gpt-4.1-mini" } }, }; - const config = resolveTtsConfig(cfg); - await summarizeText({ + const config = resolveTtsConfigForTest(cfg); + await summarizeTextForTest({ text: "Long text to summarize", targetLength: 500, cfg, @@ -420,11 +444,17 @@ describe("tts", () => { timeoutMs: 30_000, }); - expect(resolveModelAsync).toHaveBeenCalledWith("openai", "gpt-4.1-mini", undefined, cfg); + expect(resolveModelAsyncForTest).toHaveBeenCalledWith( + "openai", + "gpt-4.1-mini", + undefined, + cfg, + ); }); it("registers the Ollama api before direct summarization", async () => { - vi.mocked(resolveModelAsync).mockResolvedValue({ + const baseConfig = resolveTtsConfigForTest(baseCfg); + vi.mocked(resolveModelAsyncForTest).mockResolvedValue({ ...createResolvedModel("ollama", "qwen3:8b", "ollama"), model: { ...createResolvedModel("ollama", "qwen3:8b", "ollama").model, @@ -432,7 +462,7 @@ describe("tts", () => { }, } as never); - await summarizeText({ + await summarizeTextForTest({ text: "Long text to summarize", targetLength: 500, cfg: baseCfg, @@ -440,10 +470,11 @@ describe("tts", () => { timeoutMs: 30_000, }); - expect(ensureCustomApiRegistered).toHaveBeenCalledWith("ollama", expect.any(Function)); + expect(ensureCustomApiRegisteredForTest).toHaveBeenCalledWith("ollama", expect.any(Function)); }); it("validates targetLength bounds", async () => { + const baseConfig = resolveTtsConfigForTest(baseCfg); const cases = [ { targetLength: 99, shouldThrow: true }, { targetLength: 100, shouldThrow: false }, @@ -451,7 +482,7 @@ describe("tts", () => { { targetLength: 10001, shouldThrow: true }, ] as const; for (const testCase of cases) { - const call = summarizeText({ + const call = summarizeTextForTest({ text: "text", targetLength: testCase.targetLength, cfg: baseCfg, @@ -469,6 +500,7 @@ describe("tts", () => { }); it("throws when summary output is missing or empty", async () => { + const baseConfig = resolveTtsConfigForTest(baseCfg); const cases = [ { name: "no summary blocks", message: mockAssistantMessage([]) }, { @@ -477,9 +509,9 @@ describe("tts", () => { }, ] as const; for (const testCase of cases) { - vi.mocked(completeSimple).mockResolvedValue(testCase.message); + vi.mocked(completeSimpleForTest).mockResolvedValue(testCase.message); await expect( - summarizeText({ + summarizeTextForTest({ text: "text", targetLength: 500, cfg: baseCfg, diff --git a/src/utils/message-channel.ts b/src/utils/message-channel.ts index ed580960ad4..f80633e450d 100644 --- a/src/utils/message-channel.ts +++ b/src/utils/message-channel.ts @@ -12,10 +12,23 @@ import { normalizeGatewayClientMode, normalizeGatewayClientName, } from "../gateway/protocol/client-info.js"; -import { getActivePluginRegistry } from "../plugins/runtime.js"; export const INTERNAL_MESSAGE_CHANNEL = "webchat" as const; export type InternalMessageChannel = typeof INTERNAL_MESSAGE_CHANNEL; +const REGISTRY_STATE = Symbol.for("openclaw.pluginRegistryState"); + +type PluginRegistryStateLike = { + registry?: { + channels?: Array<{ + plugin: { + id: string; + meta: { + aliases?: string[]; + }; + }; + }>; + } | null; +}; const MARKDOWN_CAPABLE_CHANNELS = new Set([ "slack", @@ -64,8 +77,13 @@ export function normalizeMessageChannel(raw?: string | null): string | undefined if (builtIn) { return builtIn; } - const registry = getActivePluginRegistry(); - const pluginMatch = registry?.channels.find((entry) => { + const channels = + ( + globalThis as typeof globalThis & { + [REGISTRY_STATE]?: PluginRegistryStateLike; + } + )[REGISTRY_STATE]?.registry?.channels ?? []; + const pluginMatch = channels.find((entry) => { if (entry.plugin.id.toLowerCase() === normalized) { return true; } @@ -77,19 +95,23 @@ export function normalizeMessageChannel(raw?: string | null): string | undefined } const listPluginChannelIds = (): string[] => { - const registry = getActivePluginRegistry(); - if (!registry) { - return []; - } - return registry.channels.map((entry) => entry.plugin.id); + const channels = + ( + globalThis as typeof globalThis & { + [REGISTRY_STATE]?: PluginRegistryStateLike; + } + )[REGISTRY_STATE]?.registry?.channels ?? []; + return channels.map((entry) => entry.plugin.id); }; const listPluginChannelAliases = (): string[] => { - const registry = getActivePluginRegistry(); - if (!registry) { - return []; - } - return registry.channels.flatMap((entry) => entry.plugin.meta.aliases ?? []); + const channels = + ( + globalThis as typeof globalThis & { + [REGISTRY_STATE]?: PluginRegistryStateLike; + } + )[REGISTRY_STATE]?.registry?.channels ?? []; + return channels.flatMap((entry) => entry.plugin.meta.aliases ?? []); }; export const listDeliverableMessageChannels = (): ChannelId[] => diff --git a/src/whatsapp/resolve-outbound-target.test.ts b/src/whatsapp/resolve-outbound-target.test.ts index 5c4495053b2..4d7d16b4393 100644 --- a/src/whatsapp/resolve-outbound-target.test.ts +++ b/src/whatsapp/resolve-outbound-target.test.ts @@ -1,12 +1,13 @@ import { describe, it, expect, vi, beforeEach } from "vitest"; import * as normalize from "./normalize.js"; -import { resolveWhatsAppOutboundTarget } from "./resolve-outbound-target.js"; vi.mock("./normalize.js"); vi.mock("../infra/outbound/target-errors.js", () => ({ missingTargetError: (platform: string, format: string) => new Error(`${platform}: ${format}`), })); +let resolveWhatsAppOutboundTarget: typeof import("./resolve-outbound-target.js").resolveWhatsAppOutboundTarget; + type ResolveParams = Parameters[0]; const PRIMARY_TARGET = "+11234567890"; const SECONDARY_TARGET = "+19876543210"; @@ -62,8 +63,10 @@ function expectDeniedForTarget(params: { } describe("resolveWhatsAppOutboundTarget", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); vi.resetAllMocks(); + ({ resolveWhatsAppOutboundTarget } = await import("./resolve-outbound-target.js")); }); describe("empty/missing to parameter", () => { From f8d03022cf1ed1f81372045c131d8ebfb406d5af Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:06:14 +0000 Subject: [PATCH 112/187] test: cover invalid main job store load --- ...ervice.store-load-invalid-main-job.test.ts | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 src/cron/service.store-load-invalid-main-job.test.ts diff --git a/src/cron/service.store-load-invalid-main-job.test.ts b/src/cron/service.store-load-invalid-main-job.test.ts new file mode 100644 index 00000000000..39bc3588e44 --- /dev/null +++ b/src/cron/service.store-load-invalid-main-job.test.ts @@ -0,0 +1,78 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import { afterEach, describe, expect, it, vi } from "vitest"; +import { CronService } from "./service.js"; +import { + createNoopLogger, + installCronTestHooks, + writeCronStoreSnapshot, +} from "./service.test-harness.js"; +import type { CronJob } from "./types.js"; + +const noopLogger = createNoopLogger(); +installCronTestHooks({ logger: noopLogger }); + +async function makeStorePath() { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-cron-store-load-")); + return { + dir, + storePath: path.join(dir, "cron", "jobs.json"), + }; +} + +describe("CronService store load", () => { + let tempDir: string | null = null; + + afterEach(async () => { + if (!tempDir) { + return; + } + await fs.rm(tempDir, { recursive: true, force: true }); + tempDir = null; + }); + + it("skips invalid main jobs with agentTurn payloads loaded from disk", async () => { + const { dir, storePath } = await makeStorePath(); + tempDir = dir; + const enqueueSystemEvent = vi.fn(); + const requestHeartbeatNow = vi.fn(); + + const job = { + id: "job-1", + enabled: true, + createdAtMs: Date.parse("2025-12-13T00:00:00.000Z"), + updatedAtMs: Date.parse("2025-12-13T00:00:00.000Z"), + schedule: { kind: "at", at: "2025-12-13T00:00:01.000Z" }, + sessionTarget: "main", + wakeMode: "now", + payload: { kind: "agentTurn", message: "bad" }, + state: {}, + name: "bad", + } satisfies CronJob; + + await writeCronStoreSnapshot({ storePath, jobs: [job] }); + + const cron = new CronService({ + storePath, + cronEnabled: true, + log: noopLogger, + enqueueSystemEvent, + requestHeartbeatNow, + runIsolatedAgentJob: vi.fn(async () => ({ status: "ok" as const })), + }); + + await cron.start(); + vi.setSystemTime(new Date("2025-12-13T00:00:01.000Z")); + await cron.run("job-1", "due"); + + expect(enqueueSystemEvent).not.toHaveBeenCalled(); + expect(requestHeartbeatNow).not.toHaveBeenCalled(); + + const jobs = await cron.list({ includeDisabled: true }); + expect(jobs[0]?.state.lastStatus).toBe("skipped"); + expect(jobs[0]?.state.lastError).toMatch(/main job requires/i); + + cron.stop(); + }); +}); From be4fdb9222e8a40667b8b1f35ef29f5ef09bea05 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:12:36 -0700 Subject: [PATCH 113/187] build(test): ignore vitest scratch root --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index a0da79d14ef..c46954af2ef 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ pnpm-lock.yaml bun.lock bun.lockb coverage +__openclaw_vitest__/ __pycache__/ *.pyc .tsbuildinfo From 6f795fd60ea707a402c0eaf7fba1c2d83b57daba Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:14:01 -0700 Subject: [PATCH 114/187] refactor: dedupe bundled plugin entrypoints --- extensions/amazon-bedrock/index.ts | 11 +- extensions/anthropic/index.ts | 12 +- extensions/brave/index.ts | 11 +- extensions/byteplus/index.ts | 11 +- extensions/cloudflare-ai-gateway/index.ts | 11 +- extensions/copilot-proxy/index.ts | 12 +- extensions/device-pair/index.ts | 400 +++++++++++----------- extensions/diagnostics-otel/index.ts | 12 +- extensions/elevenlabs/index.ts | 11 +- extensions/firecrawl/index.ts | 15 +- extensions/github-copilot/index.ts | 12 +- extensions/google/index.ts | 11 +- extensions/huggingface/index.ts | 11 +- extensions/kilocode/index.ts | 11 +- extensions/kimi-coding/index.ts | 11 +- extensions/llm-task/index.ts | 17 +- extensions/lobster/index.ts | 36 +- extensions/memory-core/index.ts | 12 +- extensions/memory-lancedb/index.test.ts | 16 +- extensions/memory-lancedb/index.ts | 8 +- extensions/microsoft/index.ts | 11 +- extensions/minimax/index.ts | 12 +- extensions/mistral/index.ts | 11 +- extensions/modelstudio/index.ts | 11 +- extensions/moonshot/index.ts | 11 +- extensions/nvidia/index.ts | 11 +- extensions/ollama/index.ts | 9 +- extensions/open-prose/index.ts | 13 +- extensions/openai/index.ts | 11 +- extensions/opencode-go/index.ts | 11 +- extensions/opencode/index.ts | 11 +- extensions/openrouter/index.ts | 12 +- extensions/perplexity/index.ts | 11 +- extensions/phone-control/index.test.ts | 2 +- extensions/phone-control/index.ts | 273 ++++++++------- extensions/qianfan/index.ts | 11 +- extensions/qwen-portal-auth/index.ts | 12 +- extensions/sglang/index.ts | 9 +- extensions/synthetic/index.ts | 11 +- extensions/talk-voice/index.test.ts | 2 +- extensions/talk-voice/index.ts | 219 ++++++------ extensions/thread-ownership/index.test.ts | 6 +- extensions/thread-ownership/index.ts | 150 ++++---- extensions/together/index.ts | 11 +- extensions/venice/index.ts | 11 +- extensions/vercel-ai-gateway/index.ts | 11 +- extensions/vllm/index.ts | 9 +- extensions/voice-call/index.ts | 13 +- extensions/volcengine/index.ts | 11 +- extensions/xai/index.ts | 11 +- extensions/xiaomi/index.ts | 11 +- extensions/zai/index.ts | 12 +- src/commands/status.scan.shared.ts | 2 +- src/config/schema.shared.ts | 1 + src/plugin-sdk/copilot-proxy.ts | 2 +- src/plugin-sdk/core.ts | 52 ++- src/plugin-sdk/device-pair.ts | 1 + src/plugin-sdk/llm-task.ts | 1 + src/plugin-sdk/lobster.ts | 1 + src/plugin-sdk/memory-lancedb.ts | 1 + src/plugin-sdk/minimax-portal-auth.ts | 2 +- src/plugin-sdk/open-prose.ts | 1 + src/plugin-sdk/phone-control.ts | 1 + src/plugin-sdk/qwen-portal-auth.ts | 2 +- src/plugin-sdk/subpaths.test.ts | 1 + src/plugin-sdk/talk-voice.ts | 1 + src/plugin-sdk/thread-ownership.ts | 1 + src/plugin-sdk/voice-call.ts | 1 + src/plugins/voice-call.plugin.test.ts | 2 +- 69 files changed, 814 insertions(+), 850 deletions(-) diff --git a/extensions/amazon-bedrock/index.ts b/extensions/amazon-bedrock/index.ts index 33fa3a08d32..9158ab158d7 100644 --- a/extensions/amazon-bedrock/index.ts +++ b/extensions/amazon-bedrock/index.ts @@ -1,14 +1,13 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; const PROVIDER_ID = "amazon-bedrock"; const CLAUDE_46_MODEL_RE = /claude-(?:opus|sonnet)-4(?:\.|-)6(?:$|[-.])/i; -const amazonBedrockPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Amazon Bedrock Provider", description: "Bundled Amazon Bedrock provider policy plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Amazon Bedrock", @@ -18,6 +17,4 @@ const amazonBedrockPlugin = { CLAUDE_46_MODEL_RE.test(modelId.trim()) ? "adaptive" : undefined, }); }, -}; - -export default amazonBedrockPlugin; +}); diff --git a/extensions/anthropic/index.ts b/extensions/anthropic/index.ts index 4cad353908b..78f5bf3c17a 100644 --- a/extensions/anthropic/index.ts +++ b/extensions/anthropic/index.ts @@ -1,8 +1,7 @@ import { formatCliCommand } from "openclaw/plugin-sdk/cli-runtime"; import { parseDurationMs } from "openclaw/plugin-sdk/cli-runtime"; import { - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, @@ -312,12 +311,11 @@ async function runAnthropicSetupTokenNonInteractive(ctx: { }); } -const anthropicPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Anthropic Provider", description: "Bundled Anthropic provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Anthropic", @@ -399,6 +397,4 @@ const anthropicPlugin = { }); api.registerMediaUnderstandingProvider(anthropicMediaUnderstandingProvider); }, -}; - -export default anthropicPlugin; +}); diff --git a/extensions/brave/index.ts b/extensions/brave/index.ts index f23c5d4d485..1692f2db03f 100644 --- a/extensions/brave/index.ts +++ b/extensions/brave/index.ts @@ -1,16 +1,15 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createPluginBackedWebSearchProvider, getTopLevelCredentialValue, setTopLevelCredentialValue, } from "openclaw/plugin-sdk/provider-web-search"; -const bravePlugin = { +export default definePluginEntry({ id: "brave", name: "Brave Plugin", description: "Bundled Brave plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerWebSearchProvider( createPluginBackedWebSearchProvider({ id: "brave", @@ -26,6 +25,4 @@ const bravePlugin = { }), ); }, -}; - -export default bravePlugin; +}); diff --git a/extensions/byteplus/index.ts b/extensions/byteplus/index.ts index 215ac1a1705..a89cc87f531 100644 --- a/extensions/byteplus/index.ts +++ b/extensions/byteplus/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { ensureModelAllowlistEntry } from "openclaw/plugin-sdk/provider-onboard"; import { buildBytePlusCodingProvider, buildBytePlusProvider } from "./provider-catalog.js"; @@ -6,12 +6,11 @@ import { buildBytePlusCodingProvider, buildBytePlusProvider } from "./provider-c const PROVIDER_ID = "byteplus"; const BYTEPLUS_DEFAULT_MODEL_REF = "byteplus-plan/ark-code-latest"; -const byteplusPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "BytePlus Provider", description: "Bundled BytePlus provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "BytePlus", @@ -60,6 +59,4 @@ const byteplusPlugin = { }, }); }, -}; - -export default byteplusPlugin; +}); diff --git a/extensions/cloudflare-ai-gateway/index.ts b/extensions/cloudflare-ai-gateway/index.ts index 6c3cda9d0d2..a0307d9d524 100644 --- a/extensions/cloudflare-ai-gateway/index.ts +++ b/extensions/cloudflare-ai-gateway/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { applyAuthProfileConfig, buildApiKeyCredential, @@ -84,12 +84,11 @@ async function resolveCloudflareGatewayMetadataInteractive(ctx: { return { accountId, gatewayId }; } -const cloudflareAiGatewayPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Cloudflare AI Gateway Provider", description: "Bundled Cloudflare AI Gateway provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Cloudflare AI Gateway", @@ -252,6 +251,4 @@ const cloudflareAiGatewayPlugin = { }, }); }, -}; - -export default cloudflareAiGatewayPlugin; +}); diff --git a/extensions/copilot-proxy/index.ts b/extensions/copilot-proxy/index.ts index 2c517d9c26c..cf71710db5c 100644 --- a/extensions/copilot-proxy/index.ts +++ b/extensions/copilot-proxy/index.ts @@ -1,6 +1,5 @@ import { - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderAuthResult, } from "openclaw/plugin-sdk/copilot-proxy"; @@ -71,12 +70,11 @@ function buildModelDefinition(modelId: string) { }; } -const copilotProxyPlugin = { +export default definePluginEntry({ id: "copilot-proxy", name: "Copilot Proxy", description: "Local Copilot Proxy (VS Code LM) provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: "copilot-proxy", label: "Copilot Proxy", @@ -157,6 +155,4 @@ const copilotProxyPlugin = { }, }); }, -}; - -export default copilotProxyPlugin; +}); diff --git a/extensions/device-pair/index.ts b/extensions/device-pair/index.ts index 7ba88842a7a..ce007756389 100644 --- a/extensions/device-pair/index.ts +++ b/extensions/device-pair/index.ts @@ -1,12 +1,13 @@ import os from "node:os"; -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/device-pair"; import { approveDevicePairing, + definePluginEntry, issueDeviceBootstrapToken, listDevicePairing, resolveGatewayBindUrl, runPluginCommandWithTimeout, resolveTailnetHostWithRunner, + type OpenClawPluginApi, } from "openclaw/plugin-sdk/device-pair"; import qrcode from "qrcode-terminal"; import { @@ -325,226 +326,233 @@ function formatSetupInstructions(): string { ].join("\n"); } -export default function register(api: OpenClawPluginApi) { - registerPairingNotifierService(api); +export default definePluginEntry({ + id: "device-pair", + name: "Device Pair", + description: "QR/bootstrap pairing helpers for OpenClaw devices", + register(api: OpenClawPluginApi) { + registerPairingNotifierService(api); - api.registerCommand({ - name: "pair", - description: "Generate setup codes and approve device pairing requests.", - acceptsArgs: true, - handler: async (ctx) => { - const args = ctx.args?.trim() ?? ""; - const tokens = args.split(/\s+/).filter(Boolean); - const action = tokens[0]?.toLowerCase() ?? ""; - api.logger.info?.( - `device-pair: /pair invoked channel=${ctx.channel} sender=${ctx.senderId ?? "unknown"} action=${ - action || "new" - }`, - ); + api.registerCommand({ + name: "pair", + description: "Generate setup codes and approve device pairing requests.", + acceptsArgs: true, + handler: async (ctx) => { + const args = ctx.args?.trim() ?? ""; + const tokens = args.split(/\s+/).filter(Boolean); + const action = tokens[0]?.toLowerCase() ?? ""; + api.logger.info?.( + `device-pair: /pair invoked channel=${ctx.channel} sender=${ctx.senderId ?? "unknown"} action=${ + action || "new" + }`, + ); - if (action === "status" || action === "pending") { - const list = await listDevicePairing(); - return { text: formatPendingRequests(list.pending) }; - } - - if (action === "notify") { - const notifyAction = tokens[1]?.trim().toLowerCase() ?? "status"; - return await handleNotifyCommand({ - api, - ctx, - action: notifyAction, - }); - } - - if (action === "approve") { - const requested = tokens[1]?.trim(); - const list = await listDevicePairing(); - if (list.pending.length === 0) { - return { text: "No pending device pairing requests." }; + if (action === "status" || action === "pending") { + const list = await listDevicePairing(); + return { text: formatPendingRequests(list.pending) }; } - let pending: (typeof list.pending)[number] | undefined; - if (requested) { - if (requested.toLowerCase() === "latest") { - pending = [...list.pending].toSorted((a, b) => (b.ts ?? 0) - (a.ts ?? 0))[0]; - } else { - pending = list.pending.find((entry) => entry.requestId === requested); + if (action === "notify") { + const notifyAction = tokens[1]?.trim().toLowerCase() ?? "status"; + return await handleNotifyCommand({ + api, + ctx, + action: notifyAction, + }); + } + + if (action === "approve") { + const requested = tokens[1]?.trim(); + const list = await listDevicePairing(); + if (list.pending.length === 0) { + return { text: "No pending device pairing requests." }; } - } else if (list.pending.length === 1) { - pending = list.pending[0]; - } else { + + let pending: (typeof list.pending)[number] | undefined; + if (requested) { + if (requested.toLowerCase() === "latest") { + pending = [...list.pending].toSorted((a, b) => (b.ts ?? 0) - (a.ts ?? 0))[0]; + } else { + pending = list.pending.find((entry) => entry.requestId === requested); + } + } else if (list.pending.length === 1) { + pending = list.pending[0]; + } else { + return { + text: + `${formatPendingRequests(list.pending)}\n\n` + + "Multiple pending requests found. Approve one explicitly:\n" + + "/pair approve \n" + + "Or approve the most recent:\n" + + "/pair approve latest", + }; + } + if (!pending) { + return { text: "Pairing request not found." }; + } + const approved = await approveDevicePairing(pending.requestId); + if (!approved) { + return { text: "Pairing request not found." }; + } + const label = approved.device.displayName?.trim() || approved.device.deviceId; + const platform = approved.device.platform?.trim(); + const platformLabel = platform ? ` (${platform})` : ""; + return { text: `✅ Paired ${label}${platformLabel}.` }; + } + + const authLabelResult = resolveAuthLabel(api.config); + if (authLabelResult.error) { + return { text: `Error: ${authLabelResult.error}` }; + } + + const urlResult = await resolveGatewayUrl(api); + if (!urlResult.url) { + return { text: `Error: ${urlResult.error ?? "Gateway URL unavailable."}` }; + } + + const payload: SetupPayload = { + url: urlResult.url, + bootstrapToken: (await issueDeviceBootstrapToken()).token, + }; + + if (action === "qr") { + const setupCode = encodeSetupCode(payload); + const qrAscii = await renderQrAscii(setupCode); + const authLabel = authLabelResult.label ?? "auth"; + + const channel = ctx.channel; + const target = ctx.senderId?.trim() || ctx.from?.trim() || ctx.to?.trim() || ""; + let autoNotifyArmed = false; + + if (channel === "telegram" && target) { + try { + autoNotifyArmed = await armPairNotifyOnce({ api, ctx }); + } catch (err) { + api.logger.warn?.( + `device-pair: failed to arm one-shot pairing notify (${String( + (err as Error)?.message ?? err, + )})`, + ); + } + } + + if (channel === "telegram" && target) { + try { + const send = api.runtime?.channel?.telegram?.sendMessageTelegram; + if (send) { + await send( + target, + ["Scan this QR code with the OpenClaw iOS app:", "", "```", qrAscii, "```"].join( + "\n", + ), + { + ...(ctx.messageThreadId != null + ? { messageThreadId: ctx.messageThreadId } + : {}), + ...(ctx.accountId ? { accountId: ctx.accountId } : {}), + }, + ); + return { + text: [ + `Gateway: ${payload.url}`, + `Auth: ${authLabel}`, + "", + autoNotifyArmed + ? "After scanning, wait here for the pairing request ping." + : "After scanning, come back here and run `/pair approve` to complete pairing.", + ...(autoNotifyArmed + ? [ + "I’ll auto-ping here when the pairing request arrives, then auto-disable.", + "If the ping does not arrive, run `/pair approve latest` manually.", + ] + : []), + ].join("\n"), + }; + } + } catch (err) { + api.logger.warn?.( + `device-pair: telegram QR send failed, falling back (${String( + (err as Error)?.message ?? err, + )})`, + ); + } + } + + // Render based on channel capability + api.logger.info?.(`device-pair: QR fallback channel=${channel} target=${target}`); + const infoLines = [ + `Gateway: ${payload.url}`, + `Auth: ${authLabel}`, + "", + autoNotifyArmed + ? "After scanning, wait here for the pairing request ping." + : "After scanning, run `/pair approve` to complete pairing.", + ...(autoNotifyArmed + ? [ + "I’ll auto-ping here when the pairing request arrives, then auto-disable.", + "If the ping does not arrive, run `/pair approve latest` manually.", + ] + : []), + ]; + + // WebUI + CLI/TUI: ASCII QR return { - text: - `${formatPendingRequests(list.pending)}\n\n` + - "Multiple pending requests found. Approve one explicitly:\n" + - "/pair approve \n" + - "Or approve the most recent:\n" + - "/pair approve latest", + text: [ + "Scan this QR code with the OpenClaw iOS app:", + "", + "```", + qrAscii, + "```", + "", + ...infoLines, + ].join("\n"), }; } - if (!pending) { - return { text: "Pairing request not found." }; - } - const approved = await approveDevicePairing(pending.requestId); - if (!approved) { - return { text: "Pairing request not found." }; - } - const label = approved.device.displayName?.trim() || approved.device.deviceId; - const platform = approved.device.platform?.trim(); - const platformLabel = platform ? ` (${platform})` : ""; - return { text: `✅ Paired ${label}${platformLabel}.` }; - } - - const authLabelResult = resolveAuthLabel(api.config); - if (authLabelResult.error) { - return { text: `Error: ${authLabelResult.error}` }; - } - - const urlResult = await resolveGatewayUrl(api); - if (!urlResult.url) { - return { text: `Error: ${urlResult.error ?? "Gateway URL unavailable."}` }; - } - - const payload: SetupPayload = { - url: urlResult.url, - bootstrapToken: (await issueDeviceBootstrapToken()).token, - }; - - if (action === "qr") { - const setupCode = encodeSetupCode(payload); - const qrAscii = await renderQrAscii(setupCode); - const authLabel = authLabelResult.label ?? "auth"; const channel = ctx.channel; const target = ctx.senderId?.trim() || ctx.from?.trim() || ctx.to?.trim() || ""; - let autoNotifyArmed = false; + const authLabel = authLabelResult.label ?? "auth"; if (channel === "telegram" && target) { try { - autoNotifyArmed = await armPairNotifyOnce({ api, ctx }); - } catch (err) { - api.logger.warn?.( - `device-pair: failed to arm one-shot pairing notify (${String( - (err as Error)?.message ?? err, - )})`, + const runtimeKeys = Object.keys(api.runtime ?? {}); + const channelKeys = Object.keys(api.runtime?.channel ?? {}); + api.logger.debug?.( + `device-pair: runtime keys=${runtimeKeys.join(",") || "none"} channel keys=${ + channelKeys.join(",") || "none" + }`, ); - } - } - - if (channel === "telegram" && target) { - try { const send = api.runtime?.channel?.telegram?.sendMessageTelegram; - if (send) { - await send( - target, - ["Scan this QR code with the OpenClaw iOS app:", "", "```", qrAscii, "```"].join( - "\n", - ), - { - ...(ctx.messageThreadId != null ? { messageThreadId: ctx.messageThreadId } : {}), - ...(ctx.accountId ? { accountId: ctx.accountId } : {}), - }, + if (!send) { + throw new Error( + `telegram runtime unavailable (runtime keys: ${runtimeKeys.join(",")}; channel keys: ${channelKeys.join( + ",", + )})`, ); - return { - text: [ - `Gateway: ${payload.url}`, - `Auth: ${authLabel}`, - "", - autoNotifyArmed - ? "After scanning, wait here for the pairing request ping." - : "After scanning, come back here and run `/pair approve` to complete pairing.", - ...(autoNotifyArmed - ? [ - "I’ll auto-ping here when the pairing request arrives, then auto-disable.", - "If the ping does not arrive, run `/pair approve latest` manually.", - ] - : []), - ].join("\n"), - }; } + await send(target, formatSetupInstructions(), { + ...(ctx.messageThreadId != null ? { messageThreadId: ctx.messageThreadId } : {}), + ...(ctx.accountId ? { accountId: ctx.accountId } : {}), + }); + api.logger.info?.( + `device-pair: telegram split send ok target=${target} account=${ctx.accountId ?? "none"} thread=${ + ctx.messageThreadId ?? "none" + }`, + ); + return { text: encodeSetupCode(payload) }; } catch (err) { api.logger.warn?.( - `device-pair: telegram QR send failed, falling back (${String( + `device-pair: telegram split send failed, falling back to single message (${String( (err as Error)?.message ?? err, )})`, ); } } - // Render based on channel capability - api.logger.info?.(`device-pair: QR fallback channel=${channel} target=${target}`); - const infoLines = [ - `Gateway: ${payload.url}`, - `Auth: ${authLabel}`, - "", - autoNotifyArmed - ? "After scanning, wait here for the pairing request ping." - : "After scanning, run `/pair approve` to complete pairing.", - ...(autoNotifyArmed - ? [ - "I’ll auto-ping here when the pairing request arrives, then auto-disable.", - "If the ping does not arrive, run `/pair approve latest` manually.", - ] - : []), - ]; - - // WebUI + CLI/TUI: ASCII QR return { - text: [ - "Scan this QR code with the OpenClaw iOS app:", - "", - "```", - qrAscii, - "```", - "", - ...infoLines, - ].join("\n"), + text: formatSetupReply(payload, authLabel), }; - } - - const channel = ctx.channel; - const target = ctx.senderId?.trim() || ctx.from?.trim() || ctx.to?.trim() || ""; - const authLabel = authLabelResult.label ?? "auth"; - - if (channel === "telegram" && target) { - try { - const runtimeKeys = Object.keys(api.runtime ?? {}); - const channelKeys = Object.keys(api.runtime?.channel ?? {}); - api.logger.debug?.( - `device-pair: runtime keys=${runtimeKeys.join(",") || "none"} channel keys=${ - channelKeys.join(",") || "none" - }`, - ); - const send = api.runtime?.channel?.telegram?.sendMessageTelegram; - if (!send) { - throw new Error( - `telegram runtime unavailable (runtime keys: ${runtimeKeys.join(",")}; channel keys: ${channelKeys.join( - ",", - )})`, - ); - } - await send(target, formatSetupInstructions(), { - ...(ctx.messageThreadId != null ? { messageThreadId: ctx.messageThreadId } : {}), - ...(ctx.accountId ? { accountId: ctx.accountId } : {}), - }); - api.logger.info?.( - `device-pair: telegram split send ok target=${target} account=${ctx.accountId ?? "none"} thread=${ - ctx.messageThreadId ?? "none" - }`, - ); - return { text: encodeSetupCode(payload) }; - } catch (err) { - api.logger.warn?.( - `device-pair: telegram split send failed, falling back to single message (${String( - (err as Error)?.message ?? err, - )})`, - ); - } - } - - return { - text: formatSetupReply(payload, authLabel), - }; - }, - }); -} + }, + }); + }, +}); diff --git a/extensions/diagnostics-otel/index.ts b/extensions/diagnostics-otel/index.ts index a6ab6c133b6..15b6aee404e 100644 --- a/extensions/diagnostics-otel/index.ts +++ b/extensions/diagnostics-otel/index.ts @@ -1,15 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/diagnostics-otel"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/diagnostics-otel"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createDiagnosticsOtelService } from "./src/service.js"; -const plugin = { +export default definePluginEntry({ id: "diagnostics-otel", name: "Diagnostics OpenTelemetry", description: "Export diagnostics events to OpenTelemetry", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerService(createDiagnosticsOtelService()); }, -}; - -export default plugin; +}); diff --git a/extensions/elevenlabs/index.ts b/extensions/elevenlabs/index.ts index 034c56815c3..4d32eb4c532 100644 --- a/extensions/elevenlabs/index.ts +++ b/extensions/elevenlabs/index.ts @@ -1,14 +1,11 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { buildElevenLabsSpeechProvider } from "openclaw/plugin-sdk/speech"; -const elevenLabsPlugin = { +export default definePluginEntry({ id: "elevenlabs", name: "ElevenLabs Speech", description: "Bundled ElevenLabs speech provider", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerSpeechProvider(buildElevenLabsSpeechProvider()); }, -}; - -export default elevenLabsPlugin; +}); diff --git a/extensions/firecrawl/index.ts b/extensions/firecrawl/index.ts index 6b38ac6dc75..aa6e41070be 100644 --- a/extensions/firecrawl/index.ts +++ b/extensions/firecrawl/index.ts @@ -1,22 +1,15 @@ -import { - emptyPluginConfigSchema, - type AnyAgentTool, - type OpenClawPluginApi, -} from "openclaw/plugin-sdk/core"; +import { definePluginEntry, type AnyAgentTool } from "openclaw/plugin-sdk/core"; import { createFirecrawlScrapeTool } from "./src/firecrawl-scrape-tool.js"; import { createFirecrawlWebSearchProvider } from "./src/firecrawl-search-provider.js"; import { createFirecrawlSearchTool } from "./src/firecrawl-search-tool.js"; -const firecrawlPlugin = { +export default definePluginEntry({ id: "firecrawl", name: "Firecrawl Plugin", description: "Bundled Firecrawl search and scrape plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerWebSearchProvider(createFirecrawlWebSearchProvider()); api.registerTool(createFirecrawlSearchTool(api) as AnyAgentTool); api.registerTool(createFirecrawlScrapeTool(api) as AnyAgentTool); }, -}; - -export default firecrawlPlugin; +}); diff --git a/extensions/github-copilot/index.ts b/extensions/github-copilot/index.ts index 45f964c60f0..ee85f76fd61 100644 --- a/extensions/github-copilot/index.ts +++ b/extensions/github-copilot/index.ts @@ -1,6 +1,5 @@ import { - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, @@ -116,12 +115,11 @@ async function runGitHubCopilotAuth(ctx: ProviderAuthContext) { }; } -const githubCopilotPlugin = { +export default definePluginEntry({ id: "github-copilot", name: "GitHub Copilot Provider", description: "Bundled GitHub Copilot provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "GitHub Copilot", @@ -196,6 +194,4 @@ const githubCopilotPlugin = { await fetchCopilotUsage(ctx.token, ctx.timeoutMs, ctx.fetchFn), }); }, -}; - -export default githubCopilotPlugin; +}); diff --git a/extensions/google/index.ts b/extensions/google/index.ts index 87872051cbd..f9268cc0aae 100644 --- a/extensions/google/index.ts +++ b/extensions/google/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { buildGoogleImageGenerationProvider } from "openclaw/plugin-sdk/image-generation"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { @@ -14,12 +14,11 @@ import { registerGoogleGeminiCliProvider } from "./gemini-cli-provider.js"; import { googleMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { isModernGoogleModel, resolveGoogle31ForwardCompatModel } from "./provider-models.js"; -const googlePlugin = { +export default definePluginEntry({ id: "google", name: "Google Plugin", description: "Bundled Google plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: "google", label: "Google AI Studio", @@ -70,6 +69,4 @@ const googlePlugin = { }), ); }, -}; - -export default googlePlugin; +}); diff --git a/extensions/huggingface/index.ts b/extensions/huggingface/index.ts index c0c65f0051b..6f50743f43c 100644 --- a/extensions/huggingface/index.ts +++ b/extensions/huggingface/index.ts @@ -1,16 +1,15 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { applyHuggingfaceConfig, HUGGINGFACE_DEFAULT_MODEL_REF } from "./onboard.js"; import { buildHuggingfaceProvider } from "./provider-catalog.js"; const PROVIDER_ID = "huggingface"; -const huggingfacePlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Hugging Face Provider", description: "Bundled Hugging Face provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Hugging Face", @@ -56,6 +55,4 @@ const huggingfacePlugin = { }, }); }, -}; - -export default huggingfacePlugin; +}); diff --git a/extensions/kilocode/index.ts b/extensions/kilocode/index.ts index d875bfdb3c2..edbe5db7cfb 100644 --- a/extensions/kilocode/index.ts +++ b/extensions/kilocode/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { @@ -10,12 +10,11 @@ import { buildKilocodeProviderWithDiscovery } from "./provider-catalog.js"; const PROVIDER_ID = "kilocode"; -const kilocodePlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Kilo Gateway Provider", description: "Bundled Kilo Gateway provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Kilo Gateway", @@ -66,6 +65,4 @@ const kilocodePlugin = { isCacheTtlEligible: (ctx) => ctx.modelId.startsWith("anthropic/"), }); }, -}; - -export default kilocodePlugin; +}); diff --git a/extensions/kimi-coding/index.ts b/extensions/kimi-coding/index.ts index 03f680a5c38..579f469d595 100644 --- a/extensions/kimi-coding/index.ts +++ b/extensions/kimi-coding/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { isRecord } from "openclaw/plugin-sdk/text-runtime"; import { applyKimiCodeConfig, KIMI_CODING_MODEL_REF } from "./onboard.js"; @@ -7,12 +7,11 @@ import { buildKimiCodingProvider } from "./provider-catalog.js"; const PLUGIN_ID = "kimi"; const PROVIDER_ID = "kimi"; -const kimiCodingPlugin = { +export default definePluginEntry({ id: PLUGIN_ID, name: "Kimi Provider", description: "Bundled Kimi provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Kimi", @@ -82,6 +81,4 @@ const kimiCodingPlugin = { }, }); }, -}; - -export default kimiCodingPlugin; +}); diff --git a/extensions/llm-task/index.ts b/extensions/llm-task/index.ts index 7d258ab6a39..a3920e5806e 100644 --- a/extensions/llm-task/index.ts +++ b/extensions/llm-task/index.ts @@ -1,6 +1,15 @@ -import type { AnyAgentTool, OpenClawPluginApi } from "openclaw/plugin-sdk/llm-task"; +import { + definePluginEntry, + type AnyAgentTool, + type OpenClawPluginApi, +} from "openclaw/plugin-sdk/llm-task"; import { createLlmTaskTool } from "./src/llm-task-tool.js"; -export default function register(api: OpenClawPluginApi) { - api.registerTool(createLlmTaskTool(api) as unknown as AnyAgentTool, { optional: true }); -} +export default definePluginEntry({ + id: "llm-task", + name: "LLM Task", + description: "Optional tool for structured subtask execution", + register(api: OpenClawPluginApi) { + api.registerTool(createLlmTaskTool(api) as unknown as AnyAgentTool, { optional: true }); + }, +}); diff --git a/extensions/lobster/index.ts b/extensions/lobster/index.ts index 1d5775c4d74..c70ccc49da0 100644 --- a/extensions/lobster/index.ts +++ b/extensions/lobster/index.ts @@ -1,18 +1,24 @@ -import type { - AnyAgentTool, - OpenClawPluginApi, - OpenClawPluginToolFactory, +import { + definePluginEntry, + type AnyAgentTool, + type OpenClawPluginApi, + type OpenClawPluginToolFactory, } from "openclaw/plugin-sdk/lobster"; import { createLobsterTool } from "./src/lobster-tool.js"; -export default function register(api: OpenClawPluginApi) { - api.registerTool( - ((ctx) => { - if (ctx.sandboxed) { - return null; - } - return createLobsterTool(api) as AnyAgentTool; - }) as OpenClawPluginToolFactory, - { optional: true }, - ); -} +export default definePluginEntry({ + id: "lobster", + name: "Lobster", + description: "Optional local shell helper tools", + register(api: OpenClawPluginApi) { + api.registerTool( + ((ctx) => { + if (ctx.sandboxed) { + return null; + } + return createLobsterTool(api) as AnyAgentTool; + }) as OpenClawPluginToolFactory, + { optional: true }, + ); + }, +}); diff --git a/extensions/memory-core/index.ts b/extensions/memory-core/index.ts index 6559485e46a..54c8a5361a7 100644 --- a/extensions/memory-core/index.ts +++ b/extensions/memory-core/index.ts @@ -1,13 +1,11 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/memory-core"; -import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/memory-core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; -const memoryCorePlugin = { +export default definePluginEntry({ id: "memory-core", name: "Memory (Core)", description: "File-backed memory search tools and CLI", kind: "memory", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerTool( (ctx) => { const memorySearchTool = api.runtime.tools.createMemorySearchTool({ @@ -33,6 +31,4 @@ const memoryCorePlugin = { { commands: ["memory"] }, ); }, -}; - -export default memoryCorePlugin; +}); diff --git a/extensions/memory-lancedb/index.test.ts b/extensions/memory-lancedb/index.test.ts index a733c3dffb8..5dabcc9dabf 100644 --- a/extensions/memory-lancedb/index.test.ts +++ b/extensions/memory-lancedb/index.test.ts @@ -18,6 +18,18 @@ const HAS_OPENAI_KEY = Boolean(process.env.OPENAI_API_KEY); const liveEnabled = HAS_OPENAI_KEY && process.env.OPENCLAW_LIVE_TEST === "1"; const describeLive = liveEnabled ? describe : describe.skip; +type MemoryPluginTestConfig = { + embedding?: { + apiKey?: string; + model?: string; + dimensions?: number; + }; + dbPath?: string; + captureMaxChars?: number; + autoCapture?: boolean; + autoRecall?: boolean; +}; + function installTmpDirHarness(params: { prefix: string }) { let tmpDir = ""; let dbPath = ""; @@ -51,7 +63,7 @@ describe("memory plugin e2e", () => { }, dbPath: getDbPath(), ...overrides, - }); + }) as MemoryPluginTestConfig | undefined; } test("memory plugin registers and initializes correctly", async () => { @@ -89,7 +101,7 @@ describe("memory plugin e2e", () => { apiKey: "${TEST_MEMORY_API_KEY}", }, dbPath: getDbPath(), - }); + }) as MemoryPluginTestConfig | undefined; expect(config?.embedding?.apiKey).toBe("test-key-123"); diff --git a/extensions/memory-lancedb/index.ts b/extensions/memory-lancedb/index.ts index 6ae7574aaa8..b3033b118c9 100644 --- a/extensions/memory-lancedb/index.ts +++ b/extensions/memory-lancedb/index.ts @@ -10,7 +10,7 @@ import { randomUUID } from "node:crypto"; import type * as LanceDB from "@lancedb/lancedb"; import { Type } from "@sinclair/typebox"; import OpenAI from "openai"; -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/memory-lancedb"; +import { definePluginEntry, type OpenClawPluginApi } from "openclaw/plugin-sdk/memory-lancedb"; import { DEFAULT_CAPTURE_MAX_CHARS, MEMORY_CATEGORIES, @@ -289,7 +289,7 @@ export function detectCategory(text: string): MemoryCategory { // Plugin Definition // ============================================================================ -const memoryPlugin = { +export default definePluginEntry({ id: "memory-lancedb", name: "Memory (LanceDB)", description: "LanceDB-backed long-term memory with auto-recall/capture", @@ -673,6 +673,4 @@ const memoryPlugin = { }, }); }, -}; - -export default memoryPlugin; +}); diff --git a/extensions/microsoft/index.ts b/extensions/microsoft/index.ts index db0bebbcc0b..e0e39e3a18f 100644 --- a/extensions/microsoft/index.ts +++ b/extensions/microsoft/index.ts @@ -1,14 +1,11 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { buildMicrosoftSpeechProvider } from "openclaw/plugin-sdk/speech"; -const microsoftPlugin = { +export default definePluginEntry({ id: "microsoft", name: "Microsoft Speech", description: "Bundled Microsoft speech provider", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerSpeechProvider(buildMicrosoftSpeechProvider()); }, -}; - -export default microsoftPlugin; +}); diff --git a/extensions/minimax/index.ts b/extensions/minimax/index.ts index 1ebf7382d52..d1a97cb43dc 100644 --- a/extensions/minimax/index.ts +++ b/extensions/minimax/index.ts @@ -1,7 +1,6 @@ import { buildOauthProviderAuthResult, - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderAuthResult, type ProviderCatalogContext, @@ -159,12 +158,11 @@ function createOAuthHandler(region: MiniMaxRegion) { }; } -const minimaxPlugin = { +export default definePluginEntry({ id: API_PROVIDER_ID, name: "MiniMax", description: "Bundled MiniMax API-key and OAuth provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: API_PROVIDER_ID, label: PROVIDER_LABEL, @@ -280,6 +278,4 @@ const minimaxPlugin = { api.registerMediaUnderstandingProvider(minimaxMediaUnderstandingProvider); api.registerMediaUnderstandingProvider(minimaxPortalMediaUnderstandingProvider); }, -}; - -export default minimaxPlugin; +}); diff --git a/extensions/mistral/index.ts b/extensions/mistral/index.ts index 5a15c50a857..cfb77d3a012 100644 --- a/extensions/mistral/index.ts +++ b/extensions/mistral/index.ts @@ -1,16 +1,15 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { mistralMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { applyMistralConfig, MISTRAL_DEFAULT_MODEL_REF } from "./onboard.js"; const PROVIDER_ID = "mistral"; -const mistralPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Mistral Provider", description: "Bundled Mistral provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Mistral", @@ -53,6 +52,4 @@ const mistralPlugin = { }); api.registerMediaUnderstandingProvider(mistralMediaUnderstandingProvider); }, -}; - -export default mistralPlugin; +}); diff --git a/extensions/modelstudio/index.ts b/extensions/modelstudio/index.ts index 20318b2a022..fc5dab4c4f8 100644 --- a/extensions/modelstudio/index.ts +++ b/extensions/modelstudio/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { @@ -10,12 +10,11 @@ import { buildModelStudioProvider } from "./provider-catalog.js"; const PROVIDER_ID = "modelstudio"; -const modelStudioPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Model Studio Provider", description: "Bundled Model Studio provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Model Studio", @@ -89,6 +88,4 @@ const modelStudioPlugin = { }, }); }, -}; - -export default modelStudioPlugin; +}); diff --git a/extensions/moonshot/index.ts b/extensions/moonshot/index.ts index c47c4a92d41..704b841818c 100644 --- a/extensions/moonshot/index.ts +++ b/extensions/moonshot/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { @@ -20,12 +20,11 @@ import { buildMoonshotProvider } from "./provider-catalog.js"; const PROVIDER_ID = "moonshot"; -const moonshotPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Moonshot Provider", description: "Bundled Moonshot provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Moonshot", @@ -108,6 +107,4 @@ const moonshotPlugin = { }), ); }, -}; - -export default moonshotPlugin; +}); diff --git a/extensions/nvidia/index.ts b/extensions/nvidia/index.ts index 583932bc600..a5018e63579 100644 --- a/extensions/nvidia/index.ts +++ b/extensions/nvidia/index.ts @@ -1,15 +1,14 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { buildNvidiaProvider } from "./provider-catalog.js"; const PROVIDER_ID = "nvidia"; -const nvidiaPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "NVIDIA Provider", description: "Bundled NVIDIA provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "NVIDIA", @@ -27,6 +26,4 @@ const nvidiaPlugin = { }, }); }, -}; - -export default nvidiaPlugin; +}); diff --git a/extensions/ollama/index.ts b/extensions/ollama/index.ts index 6f75f9b08a5..6f7ec7f2088 100644 --- a/extensions/ollama/index.ts +++ b/extensions/ollama/index.ts @@ -1,5 +1,5 @@ import { - emptyPluginConfigSchema, + definePluginEntry, type OpenClawPluginApi, type ProviderAuthContext, type ProviderAuthMethodNonInteractiveContext, @@ -15,11 +15,10 @@ async function loadProviderSetup() { return await import("openclaw/plugin-sdk/ollama-setup"); } -const ollamaPlugin = { +export default definePluginEntry({ id: "ollama", name: "Ollama Provider", description: "Bundled Ollama provider plugin", - configSchema: emptyPluginConfigSchema(), register(api: OpenClawPluginApi) { api.registerProvider({ id: PROVIDER_ID, @@ -123,6 +122,4 @@ const ollamaPlugin = { }, }); }, -}; - -export default ollamaPlugin; +}); diff --git a/extensions/open-prose/index.ts b/extensions/open-prose/index.ts index 76fa2b18f9e..540148f498c 100644 --- a/extensions/open-prose/index.ts +++ b/extensions/open-prose/index.ts @@ -1,5 +1,10 @@ -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/open-prose"; +import { definePluginEntry, type OpenClawPluginApi } from "openclaw/plugin-sdk/open-prose"; -export default function register(_api: OpenClawPluginApi) { - // OpenProse is delivered via plugin-shipped skills. -} +export default definePluginEntry({ + id: "open-prose", + name: "OpenProse", + description: "Plugin-shipped prose skills bundle", + register(_api: OpenClawPluginApi) { + // OpenProse is delivered via plugin-shipped skills. + }, +}); diff --git a/extensions/openai/index.ts b/extensions/openai/index.ts index dd8bbdd615d..5664d19b82c 100644 --- a/extensions/openai/index.ts +++ b/extensions/openai/index.ts @@ -1,22 +1,19 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { buildOpenAIImageGenerationProvider } from "openclaw/plugin-sdk/image-generation"; import { buildOpenAISpeechProvider } from "openclaw/plugin-sdk/speech"; import { openaiMediaUnderstandingProvider } from "./media-understanding-provider.js"; import { buildOpenAICodexProviderPlugin } from "./openai-codex-provider.js"; import { buildOpenAIProvider } from "./openai-provider.js"; -const openAIPlugin = { +export default definePluginEntry({ id: "openai", name: "OpenAI Provider", description: "Bundled OpenAI provider plugins", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider(buildOpenAIProvider()); api.registerProvider(buildOpenAICodexProviderPlugin()); api.registerSpeechProvider(buildOpenAISpeechProvider()); api.registerMediaUnderstandingProvider(openaiMediaUnderstandingProvider); api.registerImageGenerationProvider(buildOpenAIImageGenerationProvider()); }, -}; - -export default openAIPlugin; +}); diff --git a/extensions/opencode-go/index.ts b/extensions/opencode-go/index.ts index 09319628684..8ef9b6ea0b4 100644 --- a/extensions/opencode-go/index.ts +++ b/extensions/opencode-go/index.ts @@ -1,16 +1,15 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { OPENCODE_GO_DEFAULT_MODEL_REF } from "openclaw/plugin-sdk/provider-models"; import { applyOpencodeGoConfig } from "./onboard.js"; const PROVIDER_ID = "opencode-go"; -const opencodeGoPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "OpenCode Go Provider", description: "Bundled OpenCode Go provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "OpenCode Go", @@ -53,6 +52,4 @@ const opencodeGoPlugin = { isModernModelRef: () => true, }); }, -}; - -export default opencodeGoPlugin; +}); diff --git a/extensions/opencode/index.ts b/extensions/opencode/index.ts index 4f9bbb1384a..9649ff6e83b 100644 --- a/extensions/opencode/index.ts +++ b/extensions/opencode/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { OPENCODE_ZEN_DEFAULT_MODEL } from "openclaw/plugin-sdk/provider-models"; import { applyOpencodeZenConfig } from "./onboard.js"; @@ -14,12 +14,11 @@ function isModernOpencodeModel(modelId: string): boolean { return !lower.startsWith(MINIMAX_PREFIX); } -const opencodePlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "OpenCode Zen Provider", description: "Bundled OpenCode Zen provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "OpenCode Zen", @@ -63,6 +62,4 @@ const opencodePlugin = { isModernModelRef: ({ modelId }) => isModernOpencodeModel(modelId), }); }, -}; - -export default opencodePlugin; +}); diff --git a/extensions/openrouter/index.ts b/extensions/openrouter/index.ts index b4c1d908c4f..3d20250e760 100644 --- a/extensions/openrouter/index.ts +++ b/extensions/openrouter/index.ts @@ -1,7 +1,6 @@ import type { StreamFn } from "@mariozechner/pi-agent-core"; import { - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderResolveDynamicModelContext, type ProviderRuntimeModel, } from "openclaw/plugin-sdk/core"; @@ -74,12 +73,11 @@ function isOpenRouterCacheTtlModel(modelId: string): boolean { return OPENROUTER_CACHE_TTL_MODEL_PREFIXES.some((prefix) => modelId.startsWith(prefix)); } -const openRouterPlugin = { +export default definePluginEntry({ id: "openrouter", name: "OpenRouter Provider", description: "Bundled OpenRouter provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "OpenRouter", @@ -151,6 +149,4 @@ const openRouterPlugin = { isCacheTtlEligible: (ctx) => isOpenRouterCacheTtlModel(ctx.modelId), }); }, -}; - -export default openRouterPlugin; +}); diff --git a/extensions/perplexity/index.ts b/extensions/perplexity/index.ts index 0fe3034a000..95ae612ed35 100644 --- a/extensions/perplexity/index.ts +++ b/extensions/perplexity/index.ts @@ -1,16 +1,15 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createPluginBackedWebSearchProvider, getScopedCredentialValue, setScopedCredentialValue, } from "openclaw/plugin-sdk/provider-web-search"; -const perplexityPlugin = { +export default definePluginEntry({ id: "perplexity", name: "Perplexity Plugin", description: "Bundled Perplexity plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerWebSearchProvider( createPluginBackedWebSearchProvider({ id: "perplexity", @@ -27,6 +26,4 @@ const perplexityPlugin = { }), ); }, -}; - -export default perplexityPlugin; +}); diff --git a/extensions/phone-control/index.test.ts b/extensions/phone-control/index.test.ts index 1eee0ff9d64..5964919e9d7 100644 --- a/extensions/phone-control/index.test.ts +++ b/extensions/phone-control/index.test.ts @@ -68,7 +68,7 @@ describe("phone-control plugin", () => { }); let command: OpenClawPluginCommandDefinition | undefined; - registerPhoneControl( + registerPhoneControl.register( createApi({ stateDir, getConfig: () => config, diff --git a/extensions/phone-control/index.ts b/extensions/phone-control/index.ts index 7b63b67b10c..88446e4fde7 100644 --- a/extensions/phone-control/index.ts +++ b/extensions/phone-control/index.ts @@ -1,6 +1,10 @@ import fs from "node:fs/promises"; import path from "node:path"; -import type { OpenClawPluginApi, OpenClawPluginService } from "openclaw/plugin-sdk/phone-control"; +import { + definePluginEntry, + type OpenClawPluginApi, + type OpenClawPluginService, +} from "openclaw/plugin-sdk/phone-control"; type ArmGroup = "camera" | "screen" | "writes" | "all"; @@ -283,139 +287,144 @@ function formatStatus(state: ArmStateFile | null): string { return `Phone control: armed (${until}).\nTemporarily allowed: ${cmdLabel}`; } -export default function register(api: OpenClawPluginApi) { - let expiryInterval: ReturnType | null = null; +export default definePluginEntry({ + id: "phone-control", + name: "Phone Control", + description: "Temporary allowlist control for phone automation commands", + register(api: OpenClawPluginApi) { + let expiryInterval: ReturnType | null = null; - const timerService: OpenClawPluginService = { - id: "phone-control-expiry", - start: async (ctx) => { - const statePath = resolveStatePath(ctx.stateDir); - const tick = async () => { - const state = await readArmState(statePath); - if (!state || state.expiresAtMs == null) { - return; - } - if (Date.now() < state.expiresAtMs) { - return; - } - await disarmNow({ - api, - stateDir: ctx.stateDir, - statePath, - reason: "expired", - }); - }; - - // Best effort; don't crash the gateway if state is corrupt. - await tick().catch(() => {}); - - expiryInterval = setInterval(() => { - tick().catch(() => {}); - }, 15_000); - expiryInterval.unref?.(); - - return; - }, - stop: async () => { - if (expiryInterval) { - clearInterval(expiryInterval); - expiryInterval = null; - } - return; - }, - }; - - api.registerService(timerService); - - api.registerCommand({ - name: "phone", - description: "Arm/disarm high-risk phone node commands (camera/screen/writes).", - acceptsArgs: true, - handler: async (ctx) => { - const args = ctx.args?.trim() ?? ""; - const tokens = args.split(/\s+/).filter(Boolean); - const action = tokens[0]?.toLowerCase() ?? ""; - - const stateDir = api.runtime.state.resolveStateDir(); - const statePath = resolveStatePath(stateDir); - - if (!action || action === "help") { - const state = await readArmState(statePath); - return { text: `${formatStatus(state)}\n\n${formatHelp()}` }; - } - - if (action === "status") { - const state = await readArmState(statePath); - return { text: formatStatus(state) }; - } - - if (action === "disarm") { - const res = await disarmNow({ - api, - stateDir, - statePath, - reason: "manual", - }); - if (!res.changed) { - return { text: "Phone control: disarmed." }; - } - const restoredLabel = res.restored.length > 0 ? res.restored.join(", ") : "none"; - const removedLabel = res.removed.length > 0 ? res.removed.join(", ") : "none"; - return { - text: `Phone control: disarmed.\nRemoved allowlist: ${removedLabel}\nRestored denylist: ${restoredLabel}`, - }; - } - - if (action === "arm") { - const group = parseGroup(tokens[1]); - if (!group) { - return { text: `Usage: /phone arm [duration]\nGroups: ${formatGroupList()}` }; - } - const durationMs = parseDurationMs(tokens[2]) ?? 10 * 60_000; - const expiresAtMs = Date.now() + durationMs; - - const commands = resolveCommandsForGroup(group); - const cfg = api.runtime.config.loadConfig(); - const allowSet = new Set(normalizeAllowList(cfg)); - const denySet = new Set(normalizeDenyList(cfg)); - - const addedToAllow: string[] = []; - const removedFromDeny: string[] = []; - for (const cmd of commands) { - if (!allowSet.has(cmd)) { - allowSet.add(cmd); - addedToAllow.push(cmd); + const timerService: OpenClawPluginService = { + id: "phone-control-expiry", + start: async (ctx) => { + const statePath = resolveStatePath(ctx.stateDir); + const tick = async () => { + const state = await readArmState(statePath); + if (!state || state.expiresAtMs == null) { + return; } - if (denySet.delete(cmd)) { - removedFromDeny.push(cmd); + if (Date.now() < state.expiresAtMs) { + return; } - } - const next = patchConfigNodeLists(cfg, { - allowCommands: uniqSorted([...allowSet]), - denyCommands: uniqSorted([...denySet]), - }); - await api.runtime.config.writeConfigFile(next); - - await writeArmState(statePath, { - version: STATE_VERSION, - armedAtMs: Date.now(), - expiresAtMs, - group, - armedCommands: uniqSorted(commands), - addedToAllow: uniqSorted(addedToAllow), - removedFromDeny: uniqSorted(removedFromDeny), - }); - - const allowedLabel = uniqSorted(commands).join(", "); - return { - text: - `Phone control: armed for ${formatDuration(durationMs)}.\n` + - `Temporarily allowed: ${allowedLabel}\n` + - `To disarm early: /phone disarm`, + await disarmNow({ + api, + stateDir: ctx.stateDir, + statePath, + reason: "expired", + }); }; - } - return { text: formatHelp() }; - }, - }); -} + // Best effort; don't crash the gateway if state is corrupt. + await tick().catch(() => {}); + + expiryInterval = setInterval(() => { + tick().catch(() => {}); + }, 15_000); + expiryInterval.unref?.(); + + return; + }, + stop: async () => { + if (expiryInterval) { + clearInterval(expiryInterval); + expiryInterval = null; + } + return; + }, + }; + + api.registerService(timerService); + + api.registerCommand({ + name: "phone", + description: "Arm/disarm high-risk phone node commands (camera/screen/writes).", + acceptsArgs: true, + handler: async (ctx) => { + const args = ctx.args?.trim() ?? ""; + const tokens = args.split(/\s+/).filter(Boolean); + const action = tokens[0]?.toLowerCase() ?? ""; + + const stateDir = api.runtime.state.resolveStateDir(); + const statePath = resolveStatePath(stateDir); + + if (!action || action === "help") { + const state = await readArmState(statePath); + return { text: `${formatStatus(state)}\n\n${formatHelp()}` }; + } + + if (action === "status") { + const state = await readArmState(statePath); + return { text: formatStatus(state) }; + } + + if (action === "disarm") { + const res = await disarmNow({ + api, + stateDir, + statePath, + reason: "manual", + }); + if (!res.changed) { + return { text: "Phone control: disarmed." }; + } + const restoredLabel = res.restored.length > 0 ? res.restored.join(", ") : "none"; + const removedLabel = res.removed.length > 0 ? res.removed.join(", ") : "none"; + return { + text: `Phone control: disarmed.\nRemoved allowlist: ${removedLabel}\nRestored denylist: ${restoredLabel}`, + }; + } + + if (action === "arm") { + const group = parseGroup(tokens[1]); + if (!group) { + return { text: `Usage: /phone arm [duration]\nGroups: ${formatGroupList()}` }; + } + const durationMs = parseDurationMs(tokens[2]) ?? 10 * 60_000; + const expiresAtMs = Date.now() + durationMs; + + const commands = resolveCommandsForGroup(group); + const cfg = api.runtime.config.loadConfig(); + const allowSet = new Set(normalizeAllowList(cfg)); + const denySet = new Set(normalizeDenyList(cfg)); + + const addedToAllow: string[] = []; + const removedFromDeny: string[] = []; + for (const cmd of commands) { + if (!allowSet.has(cmd)) { + allowSet.add(cmd); + addedToAllow.push(cmd); + } + if (denySet.delete(cmd)) { + removedFromDeny.push(cmd); + } + } + const next = patchConfigNodeLists(cfg, { + allowCommands: uniqSorted([...allowSet]), + denyCommands: uniqSorted([...denySet]), + }); + await api.runtime.config.writeConfigFile(next); + + await writeArmState(statePath, { + version: STATE_VERSION, + armedAtMs: Date.now(), + expiresAtMs, + group, + armedCommands: uniqSorted(commands), + addedToAllow: uniqSorted(addedToAllow), + removedFromDeny: uniqSorted(removedFromDeny), + }); + + const allowedLabel = uniqSorted(commands).join(", "); + return { + text: + `Phone control: armed for ${formatDuration(durationMs)}.\n` + + `Temporarily allowed: ${allowedLabel}\n` + + `To disarm early: /phone disarm`, + }; + } + + return { text: formatHelp() }; + }, + }); + }, +}); diff --git a/extensions/qianfan/index.ts b/extensions/qianfan/index.ts index 04094e1c2ca..0bb9c7760f6 100644 --- a/extensions/qianfan/index.ts +++ b/extensions/qianfan/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyQianfanConfig, QIANFAN_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -6,12 +6,11 @@ import { buildQianfanProvider } from "./provider-catalog.js"; const PROVIDER_ID = "qianfan"; -const qianfanPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Qianfan Provider", description: "Bundled Qianfan provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Qianfan", @@ -50,6 +49,4 @@ const qianfanPlugin = { }, }); }, -}; - -export default qianfanPlugin; +}); diff --git a/extensions/qwen-portal-auth/index.ts b/extensions/qwen-portal-auth/index.ts index 2a9538a33ab..377a4a598af 100644 --- a/extensions/qwen-portal-auth/index.ts +++ b/extensions/qwen-portal-auth/index.ts @@ -2,8 +2,7 @@ import { ensureAuthProfileStore, listProfilesForProvider } from "openclaw/plugin import { QWEN_OAUTH_MARKER } from "openclaw/plugin-sdk/agent-runtime"; import { buildOauthProviderAuthResult, - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderCatalogContext, } from "openclaw/plugin-sdk/qwen-portal-auth"; @@ -55,12 +54,11 @@ function resolveCatalog(ctx: ProviderCatalogContext) { }; } -const qwenPortalPlugin = { +export default definePluginEntry({ id: "qwen-portal-auth", name: "Qwen OAuth", description: "OAuth flow for Qwen (free-tier) models", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: PROVIDER_LABEL, @@ -146,6 +144,4 @@ const qwenPortalPlugin = { }), }); }, -}; - -export default qwenPortalPlugin; +}); diff --git a/extensions/sglang/index.ts b/extensions/sglang/index.ts index 9918c7ee98b..eb6b302ee01 100644 --- a/extensions/sglang/index.ts +++ b/extensions/sglang/index.ts @@ -5,7 +5,7 @@ import { SGLANG_PROVIDER_LABEL, } from "openclaw/plugin-sdk/agent-runtime"; import { - emptyPluginConfigSchema, + definePluginEntry, type OpenClawPluginApi, type ProviderAuthMethodNonInteractiveContext, } from "openclaw/plugin-sdk/core"; @@ -16,11 +16,10 @@ async function loadProviderSetup() { return await import("openclaw/plugin-sdk/self-hosted-provider-setup"); } -const sglangPlugin = { +export default definePluginEntry({ id: "sglang", name: "SGLang Provider", description: "Bundled SGLang provider plugin", - configSchema: emptyPluginConfigSchema(), register(api: OpenClawPluginApi) { api.registerProvider({ id: PROVIDER_ID, @@ -87,6 +86,4 @@ const sglangPlugin = { }, }); }, -}; - -export default sglangPlugin; +}); diff --git a/extensions/synthetic/index.ts b/extensions/synthetic/index.ts index 9bdeea0b8a5..360e4124cdd 100644 --- a/extensions/synthetic/index.ts +++ b/extensions/synthetic/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applySyntheticConfig, SYNTHETIC_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -6,12 +6,11 @@ import { buildSyntheticProvider } from "./provider-catalog.js"; const PROVIDER_ID = "synthetic"; -const syntheticPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Synthetic Provider", description: "Bundled Synthetic provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Synthetic", @@ -50,6 +49,4 @@ const syntheticPlugin = { }, }); }, -}; - -export default syntheticPlugin; +}); diff --git a/extensions/talk-voice/index.test.ts b/extensions/talk-voice/index.test.ts index 15876987554..5b246c94bf1 100644 --- a/extensions/talk-voice/index.test.ts +++ b/extensions/talk-voice/index.test.ts @@ -20,7 +20,7 @@ function createHarness(config: Record) { command = definition; }), }; - register(api as never); + register.register(api as never); if (!command) { throw new Error("talk-voice command not registered"); } diff --git a/extensions/talk-voice/index.ts b/extensions/talk-voice/index.ts index fb9e7bdb39d..5448c3425b0 100644 --- a/extensions/talk-voice/index.ts +++ b/extensions/talk-voice/index.ts @@ -1,6 +1,6 @@ import { resolveActiveTalkProviderConfig } from "openclaw/plugin-sdk/config-runtime"; import type { SpeechVoiceOption } from "openclaw/plugin-sdk/speech"; -import type { OpenClawPluginApi } from "openclaw/plugin-sdk/talk-voice"; +import { definePluginEntry, type OpenClawPluginApi } from "openclaw/plugin-sdk/talk-voice"; function mask(s: string, keep: number = 6): string { const trimmed = s.trim(); @@ -99,119 +99,124 @@ function asProviderBaseUrl(value: unknown): string | undefined { return trimmed || undefined; } -export default function register(api: OpenClawPluginApi) { - api.registerCommand({ - name: "voice", - nativeNames: { - discord: "talkvoice", - }, - description: "List/set Talk provider voices (affects iOS Talk playback).", - acceptsArgs: true, - handler: async (ctx) => { - const commandLabel = resolveCommandLabel(ctx.channel); - const args = ctx.args?.trim() ?? ""; - const tokens = args.split(/\s+/).filter(Boolean); - const action = (tokens[0] ?? "status").toLowerCase(); +export default definePluginEntry({ + id: "talk-voice", + name: "Talk Voice", + description: "Command helpers for managing Talk voice configuration", + register(api: OpenClawPluginApi) { + api.registerCommand({ + name: "voice", + nativeNames: { + discord: "talkvoice", + }, + description: "List/set Talk provider voices (affects iOS Talk playback).", + acceptsArgs: true, + handler: async (ctx) => { + const commandLabel = resolveCommandLabel(ctx.channel); + const args = ctx.args?.trim() ?? ""; + const tokens = args.split(/\s+/).filter(Boolean); + const action = (tokens[0] ?? "status").toLowerCase(); - const cfg = api.runtime.config.loadConfig(); - const active = resolveActiveTalkProviderConfig(cfg.talk); - if (!active) { - return { - text: - "Talk voice is not configured.\n\n" + - "Missing: talk.provider and talk.providers..\n" + - "Set it on the gateway, then retry.", - }; - } - const providerId = active.provider; - const providerLabel = resolveProviderLabel(providerId); - const apiKey = asTrimmedString(active.config.apiKey); - const baseUrl = asProviderBaseUrl(active.config.baseUrl); - - const currentVoiceId = - asTrimmedString(active.config.voiceId) || asTrimmedString(cfg.talk?.voiceId); - - if (action === "status") { - return { - text: - "Talk voice status:\n" + - `- provider: ${providerId}\n` + - `- talk.voiceId: ${currentVoiceId ? currentVoiceId : "(unset)"}\n` + - `- ${providerId}.apiKey: ${apiKey ? mask(apiKey) : "(unset)"}`, - }; - } - - if (action === "list") { - const limit = Number.parseInt(tokens[1] ?? "12", 10); - try { - const voices = await api.runtime.tts.listVoices({ - provider: providerId, - cfg, - apiKey: apiKey || undefined, - baseUrl, - }); + const cfg = api.runtime.config.loadConfig(); + const active = resolveActiveTalkProviderConfig(cfg.talk); + if (!active) { return { - text: formatVoiceList(voices, Number.isFinite(limit) ? limit : 12, providerId), + text: + "Talk voice is not configured.\n\n" + + "Missing: talk.provider and talk.providers..\n" + + "Set it on the gateway, then retry.", }; - } catch (error) { - const message = error instanceof Error ? error.message : String(error); - return { text: `${providerLabel} voice list failed: ${message}` }; } - } + const providerId = active.provider; + const providerLabel = resolveProviderLabel(providerId); + const apiKey = asTrimmedString(active.config.apiKey); + const baseUrl = asProviderBaseUrl(active.config.baseUrl); - if (action === "set") { - const query = tokens.slice(1).join(" ").trim(); - if (!query) { - return { text: `Usage: ${commandLabel} set ` }; - } - let voices: SpeechVoiceOption[]; - try { - voices = await api.runtime.tts.listVoices({ - provider: providerId, - cfg, - apiKey: apiKey || undefined, - baseUrl, - }); - } catch (error) { - const message = error instanceof Error ? error.message : String(error); - return { text: `${providerLabel} voice lookup failed: ${message}` }; - } - const chosen = findVoice(voices, query); - if (!chosen) { - const hint = isLikelyVoiceId(query) ? query : `"${query}"`; - return { text: `No voice found for ${hint}. Try: ${commandLabel} list` }; + const currentVoiceId = + asTrimmedString(active.config.voiceId) || asTrimmedString(cfg.talk?.voiceId); + + if (action === "status") { + return { + text: + "Talk voice status:\n" + + `- provider: ${providerId}\n` + + `- talk.voiceId: ${currentVoiceId ? currentVoiceId : "(unset)"}\n` + + `- ${providerId}.apiKey: ${apiKey ? mask(apiKey) : "(unset)"}`, + }; } - const nextConfig = { - ...cfg, - talk: { - ...cfg.talk, - provider: providerId, - providers: { - ...(cfg.talk?.providers ?? {}), - [providerId]: { - ...(cfg.talk?.providers?.[providerId] ?? {}), - voiceId: chosen.id, + if (action === "list") { + const limit = Number.parseInt(tokens[1] ?? "12", 10); + try { + const voices = await api.runtime.tts.listVoices({ + provider: providerId, + cfg, + apiKey: apiKey || undefined, + baseUrl, + }); + return { + text: formatVoiceList(voices, Number.isFinite(limit) ? limit : 12, providerId), + }; + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + return { text: `${providerLabel} voice list failed: ${message}` }; + } + } + + if (action === "set") { + const query = tokens.slice(1).join(" ").trim(); + if (!query) { + return { text: `Usage: ${commandLabel} set ` }; + } + let voices: SpeechVoiceOption[]; + try { + voices = await api.runtime.tts.listVoices({ + provider: providerId, + cfg, + apiKey: apiKey || undefined, + baseUrl, + }); + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + return { text: `${providerLabel} voice lookup failed: ${message}` }; + } + const chosen = findVoice(voices, query); + if (!chosen) { + const hint = isLikelyVoiceId(query) ? query : `"${query}"`; + return { text: `No voice found for ${hint}. Try: ${commandLabel} list` }; + } + + const nextConfig = { + ...cfg, + talk: { + ...cfg.talk, + provider: providerId, + providers: { + ...(cfg.talk?.providers ?? {}), + [providerId]: { + ...(cfg.talk?.providers?.[providerId] ?? {}), + voiceId: chosen.id, + }, }, + ...(providerId === "elevenlabs" ? { voiceId: chosen.id } : {}), }, - ...(providerId === "elevenlabs" ? { voiceId: chosen.id } : {}), - }, + }; + await api.runtime.config.writeConfigFile(nextConfig); + + const name = (chosen.name ?? "").trim() || "(unnamed)"; + return { text: `✅ ${providerLabel} Talk voice set to ${name}\n${chosen.id}` }; + } + + return { + text: [ + "Voice commands:", + "", + `${commandLabel} status`, + `${commandLabel} list [limit]`, + `${commandLabel} set `, + ].join("\n"), }; - await api.runtime.config.writeConfigFile(nextConfig); - - const name = (chosen.name ?? "").trim() || "(unnamed)"; - return { text: `✅ ${providerLabel} Talk voice set to ${name}\n${chosen.id}` }; - } - - return { - text: [ - "Voice commands:", - "", - `${commandLabel} status`, - `${commandLabel} list [limit]`, - `${commandLabel} set `, - ].join("\n"), - }; - }, - }); -} + }, + }); + }, +}); diff --git a/extensions/thread-ownership/index.test.ts b/extensions/thread-ownership/index.test.ts index 3d98d8f9735..44bdf51b312 100644 --- a/extensions/thread-ownership/index.test.ts +++ b/extensions/thread-ownership/index.test.ts @@ -39,7 +39,7 @@ describe("thread-ownership plugin", () => { }); it("registers message_received and message_sending hooks", () => { - register(api as any); + register.register(api as any); expect(api.on).toHaveBeenCalledTimes(2); expect(api.on).toHaveBeenCalledWith("message_received", expect.any(Function)); @@ -48,7 +48,7 @@ describe("thread-ownership plugin", () => { describe("message_sending", () => { beforeEach(() => { - register(api as any); + register.register(api as any); }); async function sendSlackThreadMessage() { @@ -120,7 +120,7 @@ describe("thread-ownership plugin", () => { describe("message_received @-mention tracking", () => { beforeEach(() => { - register(api as any); + register.register(api as any); }); it("tracks @-mentions and skips ownership check for mentioned threads", async () => { diff --git a/extensions/thread-ownership/index.ts b/extensions/thread-ownership/index.ts index f0d2cb6291b..8e6e5c1d020 100644 --- a/extensions/thread-ownership/index.ts +++ b/extensions/thread-ownership/index.ts @@ -1,4 +1,8 @@ -import type { OpenClawConfig, OpenClawPluginApi } from "openclaw/plugin-sdk/thread-ownership"; +import { + definePluginEntry, + type OpenClawConfig, + type OpenClawPluginApi, +} from "openclaw/plugin-sdk/thread-ownership"; type ThreadOwnershipConfig = { forwarderUrl?: string; @@ -39,95 +43,79 @@ function resolveOwnershipAgent(config: OpenClawConfig): { id: string; name: stri return { id, name }; } -export default function register(api: OpenClawPluginApi) { - const pluginCfg = (api.pluginConfig ?? {}) as ThreadOwnershipConfig; - const forwarderUrl = ( - pluginCfg.forwarderUrl ?? - process.env.SLACK_FORWARDER_URL ?? - "http://slack-forwarder:8750" - ).replace(/\/$/, ""); +export default definePluginEntry({ + id: "thread-ownership", + name: "Thread Ownership", + description: "Slack thread claim coordination for multi-agent setups", + register(api: OpenClawPluginApi) { + const pluginCfg = (api.pluginConfig ?? {}) as ThreadOwnershipConfig; + const forwarderUrl = ( + pluginCfg.forwarderUrl ?? + process.env.SLACK_FORWARDER_URL ?? + "http://slack-forwarder:8750" + ).replace(/\/$/, ""); - const abTestChannels = new Set( - pluginCfg.abTestChannels ?? - process.env.THREAD_OWNERSHIP_CHANNELS?.split(",").filter(Boolean) ?? - [], - ); + const abTestChannels = new Set( + pluginCfg.abTestChannels ?? + process.env.THREAD_OWNERSHIP_CHANNELS?.split(",").filter(Boolean) ?? + [], + ); - const { id: agentId, name: agentName } = resolveOwnershipAgent(api.config); - const botUserId = process.env.SLACK_BOT_USER_ID ?? ""; + const { id: agentId, name: agentName } = resolveOwnershipAgent(api.config); + const botUserId = process.env.SLACK_BOT_USER_ID ?? ""; - // --------------------------------------------------------------------------- - // message_received: track @-mentions so the agent can reply even if it - // doesn't own the thread. - // --------------------------------------------------------------------------- - api.on("message_received", async (event, ctx) => { - if (ctx.channelId !== "slack") return; + api.on("message_received", async (event, ctx) => { + if (ctx.channelId !== "slack") return; - const text = event.content ?? ""; - const threadTs = (event.metadata?.threadTs as string) ?? ""; - const channelId = (event.metadata?.channelId as string) ?? ctx.conversationId ?? ""; + const text = event.content ?? ""; + const threadTs = (event.metadata?.threadTs as string) ?? ""; + const channelId = (event.metadata?.channelId as string) ?? ctx.conversationId ?? ""; + if (!threadTs || !channelId) return; - if (!threadTs || !channelId) return; + const mentioned = + (agentName && text.includes(`@${agentName}`)) || + (botUserId && text.includes(`<@${botUserId}>`)); + if (mentioned) { + cleanExpiredMentions(); + mentionedThreads.set(`${channelId}:${threadTs}`, Date.now()); + } + }); - // Check if this agent was @-mentioned. - const mentioned = - (agentName && text.includes(`@${agentName}`)) || - (botUserId && text.includes(`<@${botUserId}>`)); + api.on("message_sending", async (event, ctx) => { + if (ctx.channelId !== "slack") return; + + const threadTs = (event.metadata?.threadTs as string) ?? ""; + const channelId = (event.metadata?.channelId as string) ?? event.to; + if (!threadTs) return; + if (abTestChannels.size > 0 && !abTestChannels.has(channelId)) return; - if (mentioned) { cleanExpiredMentions(); - mentionedThreads.set(`${channelId}:${threadTs}`, Date.now()); - } - }); + if (mentionedThreads.has(`${channelId}:${threadTs}`)) return; - // --------------------------------------------------------------------------- - // message_sending: check thread ownership before sending to Slack. - // Returns { cancel: true } if another agent owns the thread. - // --------------------------------------------------------------------------- - api.on("message_sending", async (event, ctx) => { - if (ctx.channelId !== "slack") return; + try { + const resp = await fetch(`${forwarderUrl}/api/v1/ownership/${channelId}/${threadTs}`, { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ agent_id: agentId }), + signal: AbortSignal.timeout(3000), + }); - const threadTs = (event.metadata?.threadTs as string) ?? ""; - const channelId = (event.metadata?.channelId as string) ?? event.to; - - // Top-level messages (no thread) are always allowed. - if (!threadTs) return; - - // Only enforce in A/B test channels (if set is empty, skip entirely). - if (abTestChannels.size > 0 && !abTestChannels.has(channelId)) return; - - // If this agent was @-mentioned in this thread recently, skip ownership check. - cleanExpiredMentions(); - if (mentionedThreads.has(`${channelId}:${threadTs}`)) return; - - // Try to claim ownership via the forwarder HTTP API. - try { - const resp = await fetch(`${forwarderUrl}/api/v1/ownership/${channelId}/${threadTs}`, { - method: "POST", - headers: { "Content-Type": "application/json" }, - body: JSON.stringify({ agent_id: agentId }), - signal: AbortSignal.timeout(3000), - }); - - if (resp.ok) { - // We own it (or just claimed it), proceed. - return; - } - - if (resp.status === 409) { - // Another agent owns this thread — cancel the send. - const body = (await resp.json()) as { owner?: string }; - api.logger.info?.( - `thread-ownership: cancelled send to ${channelId}:${threadTs} — owned by ${body.owner}`, + if (resp.ok) { + return; + } + if (resp.status === 409) { + const body = (await resp.json()) as { owner?: string }; + api.logger.info?.( + `thread-ownership: cancelled send to ${channelId}:${threadTs} — owned by ${body.owner}`, + ); + return { cancel: true }; + } + api.logger.warn?.(`thread-ownership: unexpected status ${resp.status}, allowing send`); + } catch (err) { + api.logger.warn?.( + `thread-ownership: ownership check failed (${String(err)}), allowing send`, ); - return { cancel: true }; } - - // Unexpected status — fail open. - api.logger.warn?.(`thread-ownership: unexpected status ${resp.status}, allowing send`); - } catch (err) { - // Network error — fail open. - api.logger.warn?.(`thread-ownership: ownership check failed (${String(err)}), allowing send`); - } - }); -} + }); + }, +}); diff --git a/extensions/together/index.ts b/extensions/together/index.ts index 01bf59338f1..d4ae42bba82 100644 --- a/extensions/together/index.ts +++ b/extensions/together/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyTogetherConfig, TOGETHER_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -6,12 +6,11 @@ import { buildTogetherProvider } from "./provider-catalog.js"; const PROVIDER_ID = "together"; -const togetherPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Together Provider", description: "Bundled Together provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Together", @@ -50,6 +49,4 @@ const togetherPlugin = { }, }); }, -}; - -export default togetherPlugin; +}); diff --git a/extensions/venice/index.ts b/extensions/venice/index.ts index 37d4e767db3..2565049647e 100644 --- a/extensions/venice/index.ts +++ b/extensions/venice/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyVeniceConfig, VENICE_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -6,12 +6,11 @@ import { buildVeniceProvider } from "./provider-catalog.js"; const PROVIDER_ID = "venice"; -const venicePlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Venice Provider", description: "Bundled Venice provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Venice", @@ -56,6 +55,4 @@ const venicePlugin = { }, }); }, -}; - -export default venicePlugin; +}); diff --git a/extensions/vercel-ai-gateway/index.ts b/extensions/vercel-ai-gateway/index.ts index fc4dbae156a..ecaa6d96d33 100644 --- a/extensions/vercel-ai-gateway/index.ts +++ b/extensions/vercel-ai-gateway/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { applyVercelAiGatewayConfig, VERCEL_AI_GATEWAY_DEFAULT_MODEL_REF } from "./onboard.js"; @@ -6,12 +6,11 @@ import { buildVercelAiGatewayProvider } from "./provider-catalog.js"; const PROVIDER_ID = "vercel-ai-gateway"; -const vercelAiGatewayPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Vercel AI Gateway Provider", description: "Bundled Vercel AI Gateway provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Vercel AI Gateway", @@ -50,6 +49,4 @@ const vercelAiGatewayPlugin = { }, }); }, -}; - -export default vercelAiGatewayPlugin; +}); diff --git a/extensions/vllm/index.ts b/extensions/vllm/index.ts index 24805e700a6..7017977861c 100644 --- a/extensions/vllm/index.ts +++ b/extensions/vllm/index.ts @@ -5,7 +5,7 @@ import { VLLM_PROVIDER_LABEL, } from "openclaw/plugin-sdk/agent-runtime"; import { - emptyPluginConfigSchema, + definePluginEntry, type OpenClawPluginApi, type ProviderAuthMethodNonInteractiveContext, } from "openclaw/plugin-sdk/core"; @@ -16,11 +16,10 @@ async function loadProviderSetup() { return await import("openclaw/plugin-sdk/self-hosted-provider-setup"); } -const vllmPlugin = { +export default definePluginEntry({ id: "vllm", name: "vLLM Provider", description: "Bundled vLLM provider plugin", - configSchema: emptyPluginConfigSchema(), register(api: OpenClawPluginApi) { api.registerProvider({ id: PROVIDER_ID, @@ -87,6 +86,4 @@ const vllmPlugin = { }, }); }, -}; - -export default vllmPlugin; +}); diff --git a/extensions/voice-call/index.ts b/extensions/voice-call/index.ts index f20e2da6674..9f976881a11 100644 --- a/extensions/voice-call/index.ts +++ b/extensions/voice-call/index.ts @@ -1,7 +1,8 @@ import { Type } from "@sinclair/typebox"; -import type { - GatewayRequestHandlerOptions, - OpenClawPluginApi, +import { + definePluginEntry, + type GatewayRequestHandlerOptions, + type OpenClawPluginApi, } from "openclaw/plugin-sdk/voice-call"; import { registerVoiceCallCli } from "./src/cli.js"; import { @@ -143,7 +144,7 @@ const VoiceCallToolSchema = Type.Union([ }), ]); -const voiceCallPlugin = { +export default definePluginEntry({ id: "voice-call", name: "Voice Call", description: "Voice-call plugin with Telnyx/Twilio/Plivo providers", @@ -560,6 +561,4 @@ const voiceCallPlugin = { }, }); }, -}; - -export default voiceCallPlugin; +}); diff --git a/extensions/volcengine/index.ts b/extensions/volcengine/index.ts index 975bcce610d..f6b4b020746 100644 --- a/extensions/volcengine/index.ts +++ b/extensions/volcengine/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { ensureModelAllowlistEntry } from "openclaw/plugin-sdk/provider-onboard"; import { buildDoubaoCodingProvider, buildDoubaoProvider } from "./provider-catalog.js"; @@ -6,12 +6,11 @@ import { buildDoubaoCodingProvider, buildDoubaoProvider } from "./provider-catal const PROVIDER_ID = "volcengine"; const VOLCENGINE_DEFAULT_MODEL_REF = "volcengine-plan/ark-code-latest"; -const volcenginePlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Volcengine Provider", description: "Bundled Volcengine provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Volcengine", @@ -60,6 +59,4 @@ const volcenginePlugin = { }, }); }, -}; - -export default volcenginePlugin; +}); diff --git a/extensions/xai/index.ts b/extensions/xai/index.ts index 7771575795a..485b7ec6461 100644 --- a/extensions/xai/index.ts +++ b/extensions/xai/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { normalizeProviderId } from "openclaw/plugin-sdk/provider-models"; import { @@ -16,12 +16,11 @@ function matchesModernXaiModel(modelId: string): boolean { return XAI_MODERN_MODEL_PREFIXES.some((prefix) => normalized.startsWith(prefix)); } -const xaiPlugin = { +export default definePluginEntry({ id: "xai", name: "xAI Plugin", description: "Bundled xAI plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "xAI", @@ -68,6 +67,4 @@ const xaiPlugin = { }), ); }, -}; - -export default xaiPlugin; +}); diff --git a/extensions/xiaomi/index.ts b/extensions/xiaomi/index.ts index dd18127edfa..def263b1cda 100644 --- a/extensions/xiaomi/index.ts +++ b/extensions/xiaomi/index.ts @@ -1,4 +1,4 @@ -import { emptyPluginConfigSchema, type OpenClawPluginApi } from "openclaw/plugin-sdk/core"; +import { definePluginEntry } from "openclaw/plugin-sdk/core"; import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; import { buildSingleProviderApiKeyCatalog } from "openclaw/plugin-sdk/provider-catalog"; import { PROVIDER_LABELS } from "openclaw/plugin-sdk/provider-usage"; @@ -7,12 +7,11 @@ import { buildXiaomiProvider } from "./provider-catalog.js"; const PROVIDER_ID = "xiaomi"; -const xiaomiPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Xiaomi Provider", description: "Bundled Xiaomi provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Xiaomi", @@ -62,6 +61,4 @@ const xiaomiPlugin = { }), }); }, -}; - -export default xiaomiPlugin; +}); diff --git a/extensions/zai/index.ts b/extensions/zai/index.ts index 33929645968..79ae3a9d8aa 100644 --- a/extensions/zai/index.ts +++ b/extensions/zai/index.ts @@ -1,6 +1,5 @@ import { - emptyPluginConfigSchema, - type OpenClawPluginApi, + definePluginEntry, type ProviderAuthContext, type ProviderAuthMethod, type ProviderAuthMethodNonInteractiveContext, @@ -226,12 +225,11 @@ function buildZaiApiKeyMethod(params: { }; } -const zaiPlugin = { +export default definePluginEntry({ id: PROVIDER_ID, name: "Z.AI Provider", description: "Bundled Z.AI provider plugin", - configSchema: emptyPluginConfigSchema(), - register(api: OpenClawPluginApi) { + register(api) { api.registerProvider({ id: PROVIDER_ID, label: "Z.AI", @@ -311,6 +309,4 @@ const zaiPlugin = { }); api.registerMediaUnderstandingProvider(zaiMediaUnderstandingProvider); }, -}; - -export default zaiPlugin; +}); diff --git a/src/commands/status.scan.shared.ts b/src/commands/status.scan.shared.ts index b855c85320a..6f28bcd7773 100644 --- a/src/commands/status.scan.shared.ts +++ b/src/commands/status.scan.shared.ts @@ -113,7 +113,7 @@ export async function resolveSharedMemoryStatusSnapshot(params: { purpose: "status"; }) => Promise<{ manager: { - probeVectorAvailability(): Promise; + probeVectorAvailability(): Promise; status(): MemoryProviderStatus; close?(): Promise; } | null; diff --git a/src/config/schema.shared.ts b/src/config/schema.shared.ts index 148d5b3fb86..9eb6f71e052 100644 --- a/src/config/schema.shared.ts +++ b/src/config/schema.shared.ts @@ -1,4 +1,5 @@ type JsonSchemaObject = { + type?: string | string[]; properties?: Record; additionalProperties?: JsonSchemaObject | boolean; items?: JsonSchemaObject | JsonSchemaObject[]; diff --git a/src/plugin-sdk/copilot-proxy.ts b/src/plugin-sdk/copilot-proxy.ts index 80a83010c1d..d4a4dec92bf 100644 --- a/src/plugin-sdk/copilot-proxy.ts +++ b/src/plugin-sdk/copilot-proxy.ts @@ -1,7 +1,7 @@ // Narrow plugin-sdk surface for the bundled copilot-proxy plugin. // Keep this list additive and scoped to symbols used under extensions/copilot-proxy. -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { definePluginEntry } from "./core.js"; export type { OpenClawPluginApi, ProviderAuthContext, diff --git a/src/plugin-sdk/core.ts b/src/plugin-sdk/core.ts index 1cfea088601..b683ecbb945 100644 --- a/src/plugin-sdk/core.ts +++ b/src/plugin-sdk/core.ts @@ -5,6 +5,7 @@ import type { OpenClawPluginApi, OpenClawPluginCommandDefinition, OpenClawPluginConfigSchema, + OpenClawPluginDefinition, PluginInteractiveTelegramHandlerContext, } from "../plugins/types.js"; @@ -42,6 +43,7 @@ export type { ProviderAuthMethod, ProviderAuthResult, OpenClawPluginCommandDefinition, + OpenClawPluginDefinition, PluginInteractiveTelegramHandlerContext, } from "../plugins/types.js"; export type { OpenClawConfig } from "../config/config.js"; @@ -88,11 +90,53 @@ type DefineChannelPluginEntryOptions OpenClawPluginConfigSchema; + configSchema?: DefinePluginEntryOptions["configSchema"]; setRuntime?: (runtime: PluginRuntime) => void; registerFull?: (api: OpenClawPluginApi) => void; }; +type DefinePluginEntryOptions = { + id: string; + name: string; + description: string; + kind?: OpenClawPluginDefinition["kind"]; + configSchema?: OpenClawPluginConfigSchema | (() => OpenClawPluginConfigSchema); + register: (api: OpenClawPluginApi) => void; +}; + +type DefinedPluginEntry = { + id: string; + name: string; + description: string; + configSchema: OpenClawPluginConfigSchema; + register: NonNullable; +} & Pick; + +function resolvePluginConfigSchema( + configSchema: DefinePluginEntryOptions["configSchema"] = emptyPluginConfigSchema, +): OpenClawPluginConfigSchema { + return typeof configSchema === "function" ? configSchema() : configSchema; +} + +// Shared generic plugin-entry boilerplate for bundled and third-party plugins. +export function definePluginEntry({ + id, + name, + description, + kind, + configSchema = emptyPluginConfigSchema, + register, +}: DefinePluginEntryOptions): DefinedPluginEntry { + return { + id, + name, + description, + ...(kind ? { kind } : {}), + configSchema: resolvePluginConfigSchema(configSchema), + register, + }; +} + // Shared channel-plugin entry boilerplate for bundled and third-party channels. export function defineChannelPluginEntry({ id, @@ -103,11 +147,11 @@ export function defineChannelPluginEntry({ setRuntime, registerFull, }: DefineChannelPluginEntryOptions) { - return { + return definePluginEntry({ id, name, description, - configSchema: configSchema(), + configSchema, register(api: OpenClawPluginApi) { setRuntime?.(api.runtime); api.registerChannel({ plugin }); @@ -116,7 +160,7 @@ export function defineChannelPluginEntry({ } registerFull?.(api); }, - }; + }); } // Shared setup-entry shape so bundled channels do not duplicate `{ plugin }`. diff --git a/src/plugin-sdk/device-pair.ts b/src/plugin-sdk/device-pair.ts index 5828ad0535f..a87e1eea8f1 100644 --- a/src/plugin-sdk/device-pair.ts +++ b/src/plugin-sdk/device-pair.ts @@ -1,6 +1,7 @@ // Narrow plugin-sdk surface for the bundled device-pair plugin. // Keep this list additive and scoped to symbols used under extensions/device-pair. +export { definePluginEntry } from "./core.js"; export { approveDevicePairing, listDevicePairing } from "../infra/device-pairing.js"; export { issueDeviceBootstrapToken } from "../infra/device-bootstrap.js"; export type { OpenClawPluginApi } from "../plugins/types.js"; diff --git a/src/plugin-sdk/llm-task.ts b/src/plugin-sdk/llm-task.ts index c69e82f36f7..b93a3197d26 100644 --- a/src/plugin-sdk/llm-task.ts +++ b/src/plugin-sdk/llm-task.ts @@ -1,6 +1,7 @@ // Narrow plugin-sdk surface for the bundled llm-task plugin. // Keep this list additive and scoped to symbols used under extensions/llm-task. +export { definePluginEntry } from "./core.js"; export { resolvePreferredOpenClawTmpDir } from "../infra/tmp-openclaw-dir.js"; export { formatThinkingLevels, diff --git a/src/plugin-sdk/lobster.ts b/src/plugin-sdk/lobster.ts index 436acdf4d45..968fcf2cae1 100644 --- a/src/plugin-sdk/lobster.ts +++ b/src/plugin-sdk/lobster.ts @@ -1,6 +1,7 @@ // Narrow plugin-sdk surface for the bundled lobster plugin. // Keep this list additive and scoped to symbols used under extensions/lobster. +export { definePluginEntry } from "./core.js"; export { applyWindowsSpawnProgramPolicy, materializeWindowsSpawnProgram, diff --git a/src/plugin-sdk/memory-lancedb.ts b/src/plugin-sdk/memory-lancedb.ts index 840ed95982c..23d3e2619c8 100644 --- a/src/plugin-sdk/memory-lancedb.ts +++ b/src/plugin-sdk/memory-lancedb.ts @@ -1,4 +1,5 @@ // Narrow plugin-sdk surface for the bundled memory-lancedb plugin. // Keep this list additive and scoped to symbols used under extensions/memory-lancedb. +export { definePluginEntry } from "./core.js"; export type { OpenClawPluginApi } from "../plugins/types.js"; diff --git a/src/plugin-sdk/minimax-portal-auth.ts b/src/plugin-sdk/minimax-portal-auth.ts index 07aefa0aafa..a8dad415488 100644 --- a/src/plugin-sdk/minimax-portal-auth.ts +++ b/src/plugin-sdk/minimax-portal-auth.ts @@ -1,7 +1,7 @@ // Narrow plugin-sdk surface for MiniMax OAuth helpers used by the bundled minimax plugin. // Keep this list additive and scoped to MiniMax OAuth support code. -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { definePluginEntry } from "./core.js"; export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; export type { OpenClawPluginApi, diff --git a/src/plugin-sdk/open-prose.ts b/src/plugin-sdk/open-prose.ts index 1973404f2a8..049370ed986 100644 --- a/src/plugin-sdk/open-prose.ts +++ b/src/plugin-sdk/open-prose.ts @@ -1,4 +1,5 @@ // Narrow plugin-sdk surface for the bundled open-prose plugin. // Keep this list additive and scoped to symbols used under extensions/open-prose. +export { definePluginEntry } from "./core.js"; export type { OpenClawPluginApi } from "../plugins/types.js"; diff --git a/src/plugin-sdk/phone-control.ts b/src/plugin-sdk/phone-control.ts index 394ff9c88ee..c116eba1076 100644 --- a/src/plugin-sdk/phone-control.ts +++ b/src/plugin-sdk/phone-control.ts @@ -1,6 +1,7 @@ // Narrow plugin-sdk surface for the bundled phone-control plugin. // Keep this list additive and scoped to symbols used under extensions/phone-control. +export { definePluginEntry } from "./core.js"; export type { OpenClawPluginApi, OpenClawPluginCommandDefinition, diff --git a/src/plugin-sdk/qwen-portal-auth.ts b/src/plugin-sdk/qwen-portal-auth.ts index f6cde98b90f..adc61259a09 100644 --- a/src/plugin-sdk/qwen-portal-auth.ts +++ b/src/plugin-sdk/qwen-portal-auth.ts @@ -1,7 +1,7 @@ // Narrow plugin-sdk surface for the bundled qwen-portal-auth plugin. // Keep this list additive and scoped to symbols used under extensions/qwen-portal-auth. -export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { definePluginEntry } from "./core.js"; export { buildOauthProviderAuthResult } from "./provider-auth-result.js"; export type { OpenClawPluginApi, diff --git a/src/plugin-sdk/subpaths.test.ts b/src/plugin-sdk/subpaths.test.ts index 156f7d9b81f..a3cc2b3ba1f 100644 --- a/src/plugin-sdk/subpaths.test.ts +++ b/src/plugin-sdk/subpaths.test.ts @@ -49,6 +49,7 @@ describe("plugin-sdk subpath exports", () => { it("keeps core focused on generic shared exports", () => { expect(typeof coreSdk.emptyPluginConfigSchema).toBe("function"); + expect(typeof coreSdk.definePluginEntry).toBe("function"); expect(typeof coreSdk.defineChannelPluginEntry).toBe("function"); expect(typeof coreSdk.defineSetupPluginEntry).toBe("function"); expect("runPassiveAccountLifecycle" in asExports(coreSdk)).toBe(false); diff --git a/src/plugin-sdk/talk-voice.ts b/src/plugin-sdk/talk-voice.ts index 3ee313ec42f..e89f210af62 100644 --- a/src/plugin-sdk/talk-voice.ts +++ b/src/plugin-sdk/talk-voice.ts @@ -1,4 +1,5 @@ // Narrow plugin-sdk surface for the bundled talk-voice plugin. // Keep this list additive and scoped to symbols used under extensions/talk-voice. +export { definePluginEntry } from "./core.js"; export type { OpenClawPluginApi } from "../plugins/types.js"; diff --git a/src/plugin-sdk/thread-ownership.ts b/src/plugin-sdk/thread-ownership.ts index 48d72fa5d35..ea8ad079a8c 100644 --- a/src/plugin-sdk/thread-ownership.ts +++ b/src/plugin-sdk/thread-ownership.ts @@ -1,5 +1,6 @@ // Narrow plugin-sdk surface for the bundled thread-ownership plugin. // Keep this list additive and scoped to symbols used under extensions/thread-ownership. +export { definePluginEntry } from "./core.js"; export type { OpenClawConfig } from "../config/config.js"; export type { OpenClawPluginApi } from "../plugins/types.js"; diff --git a/src/plugin-sdk/voice-call.ts b/src/plugin-sdk/voice-call.ts index 7dea0885862..b3f1a889f78 100644 --- a/src/plugin-sdk/voice-call.ts +++ b/src/plugin-sdk/voice-call.ts @@ -1,6 +1,7 @@ // Narrow plugin-sdk surface for the bundled voice-call plugin. // Keep this list additive and scoped to symbols used under extensions/voice-call. +export { definePluginEntry } from "./core.js"; export { TtsAutoSchema, TtsConfigSchema, diff --git a/src/plugins/voice-call.plugin.test.ts b/src/plugins/voice-call.plugin.test.ts index 0ca6106d1a9..6a018c27b42 100644 --- a/src/plugins/voice-call.plugin.test.ts +++ b/src/plugins/voice-call.plugin.test.ts @@ -45,7 +45,7 @@ type RegisterCliContext = { function setup(config: Record): Registered { const methods = new Map(); const tools: unknown[] = []; - plugin.register({ + void plugin.register({ id: "voice-call", name: "Voice Call", description: "test", From 228448e6b30c8601ea50a764d19f08306f314474 Mon Sep 17 00:00:00 2001 From: Josh Lehman Date: Sat, 14 Mar 2026 10:02:21 -0700 Subject: [PATCH 115/187] docs: add context engine documentation Add dedicated docs page for the pluggable context engine system: - Full lifecycle explanation (ingest, assemble, compact, afterTurn) - Legacy engine behavior documentation - Plugin engine authoring guide with code examples - ContextEngine interface reference table - ownsCompaction semantics - Subagent lifecycle hooks (prepareSubagentSpawn, onSubagentEnded) - systemPromptAddition mechanism - Relationship to compaction, memory plugins, and session pruning - Configuration reference and tips Also: - Add context-engine to docs nav (Agents > Fundamentals, after Context) - Add /context-engine redirect - Cross-link from context.md and compaction.md --- docs/concepts/compaction.md | 11 ++ docs/concepts/context-engine.md | 215 ++++++++++++++++++++++++++++++++ docs/concepts/context.md | 3 +- docs/docs.json | 5 + 4 files changed, 233 insertions(+), 1 deletion(-) create mode 100644 docs/concepts/context-engine.md diff --git a/docs/concepts/compaction.md b/docs/concepts/compaction.md index 73f6372c3f7..5640fa51a35 100644 --- a/docs/concepts/compaction.md +++ b/docs/concepts/compaction.md @@ -97,6 +97,17 @@ compaction and can run alongside it. See [OpenAI provider](/providers/openai) for model params and overrides. +## Custom context engines + +Compaction behavior is owned by the active +[context engine](/concepts/context-engine). The legacy engine uses the built-in +summarization described above. Plugin engines (selected via +`plugins.slots.contextEngine`) can implement any compaction strategy — DAG +summaries, vector retrieval, incremental condensation, etc. + +When a plugin engine sets `ownsCompaction: true`, OpenClaw delegates all +compaction decisions to the engine and does not run built-in auto-compaction. + ## Tips - Use `/compact` when sessions feel stale or context is bloated. diff --git a/docs/concepts/context-engine.md b/docs/concepts/context-engine.md new file mode 100644 index 00000000000..ec769ca9d54 --- /dev/null +++ b/docs/concepts/context-engine.md @@ -0,0 +1,215 @@ +--- +summary: "Context engine: pluggable context assembly, compaction, and subagent lifecycle" +read_when: + - You want to understand how OpenClaw assembles model context + - You are switching between the legacy engine and a plugin engine + - You are building a context engine plugin +title: "Context Engine" +--- + +# Context Engine + +A **context engine** controls how OpenClaw builds model context for each run. +It decides which messages to include, how to summarize older history, and how +to manage context across subagent boundaries. + +OpenClaw ships with a built-in `legacy` engine. Plugins can register +alternative engines that replace the entire context pipeline. + +## Quick start + +Check which engine is active: + +```bash +openclaw doctor +# or inspect config directly: +cat ~/.openclaw/openclaw.json | jq '.plugins.slots.contextEngine' +``` + +Switch engines: + +```json5 +// openclaw.json +{ + plugins: { + slots: { + contextEngine: "lossless-claw", // or "legacy" (default) + }, + }, +} +``` + +Restart the gateway after changing the slot. + +## How it works + +Every time OpenClaw runs a model prompt, the context engine participates at +four lifecycle points: + +1. **Ingest** — called when a new message is added to the session. The engine + can store or index the message in its own data store. +2. **Assemble** — called before each model run. The engine returns an ordered + set of messages (and an optional `systemPromptAddition`) that fit within + the token budget. +3. **Compact** — called when the context window is full, or when the user runs + `/compact`. The engine summarizes older history to free space. +4. **After turn** — called after a run completes. The engine can persist state, + trigger background compaction, or update indexes. + +### Subagent lifecycle (optional) + +Engines can also manage context across subagent boundaries: + +- **prepareSubagentSpawn** — set up shared state before a child session starts. + Returns a rollback handle in case the spawn fails. +- **onSubagentEnded** — clean up when a subagent session completes or is swept. + +### System prompt addition + +The `assemble` method can return a `systemPromptAddition` string. OpenClaw +prepends this to the system prompt for the run. This lets engines inject +dynamic recall guidance, retrieval instructions, or context-aware hints +without requiring static workspace files. + +## The legacy engine + +The built-in `legacy` engine preserves OpenClaw's original behavior: + +- **Ingest**: no-op (the session manager handles message persistence directly). +- **Assemble**: pass-through (the existing sanitize → validate → limit pipeline + in the runtime handles context assembly). +- **Compact**: delegates to the built-in summarization compaction, which creates + a single summary of older messages and keeps recent messages intact. +- **After turn**: no-op. + +The legacy engine does not register tools or provide a `systemPromptAddition`. + +When no `plugins.slots.contextEngine` is set (or it's set to `"legacy"`), this +engine is used automatically. + +## Plugin engines + +A plugin can register a context engine using the plugin API: + +```ts +export default function register(api) { + api.registerContextEngine("my-engine", () => ({ + info: { + id: "my-engine", + name: "My Context Engine", + ownsCompaction: true, + }, + + async ingest({ sessionId, message, isHeartbeat }) { + // Store the message in your data store + return { ingested: true }; + }, + + async assemble({ sessionId, messages, tokenBudget }) { + // Return messages that fit the budget + return { + messages: buildContext(messages, tokenBudget), + estimatedTokens: countTokens(messages), + systemPromptAddition: "Use lcm_grep to search history...", + }; + }, + + async compact({ sessionId, force }) { + // Summarize older context + return { ok: true, compacted: true }; + }, + })); +} +``` + +Then enable it in config: + +```json5 +{ + plugins: { + slots: { + contextEngine: "my-engine", + }, + entries: { + "my-engine": { + enabled: true, + }, + }, + }, +} +``` + +### The ContextEngine interface + +Required methods: + +| Method | Purpose | +| ------------------ | -------------------------------------------------------- | +| `info` | Engine id, name, version, and whether it owns compaction | +| `ingest(params)` | Store a single message | +| `assemble(params)` | Build context for a model run | +| `compact(params)` | Summarize/reduce context | + +Optional methods: + +| Method | Purpose | +| ------------------------------ | ----------------------------------------- | +| `bootstrap(params)` | Initialize engine state for a new session | +| `ingestBatch(params)` | Ingest a completed turn as a batch | +| `afterTurn(params)` | Post-run lifecycle work | +| `prepareSubagentSpawn(params)` | Set up shared state for a child session | +| `onSubagentEnded(params)` | Clean up after a subagent ends | +| `dispose()` | Release resources | + +### ownsCompaction + +When `info.ownsCompaction` is `true`, the engine manages its own compaction +lifecycle. OpenClaw will not trigger the built-in auto-compaction; instead it +delegates entirely to the engine's `compact()` method. The engine may also +run compaction proactively in `afterTurn()`. + +When `false` or unset, OpenClaw's built-in auto-compaction logic runs +alongside the engine. + +## Configuration reference + +```json5 +{ + plugins: { + slots: { + // Select the active context engine. Default: "legacy". + // Set to a plugin id to use a plugin engine. + contextEngine: "legacy", + }, + }, +} +``` + +The slot is exclusive — only one context engine can be active at a time. If +multiple plugins declare `kind: "context-engine"`, only the one selected in +`plugins.slots.contextEngine` loads. Others are disabled with diagnostics. + +## Relationship to compaction and memory + +- **Compaction** is one responsibility of the context engine. The legacy engine + delegates to OpenClaw's built-in summarization. Plugin engines can implement + any compaction strategy (DAG summaries, vector retrieval, etc.). +- **Memory plugins** (`plugins.slots.memory`) are separate from context engines. + Memory plugins provide search/retrieval; context engines control what the + model sees. They can work together — a context engine might use memory + plugin data during assembly. +- **Session pruning** (trimming old tool results in-memory) still runs + regardless of which context engine is active. + +## Tips + +- Use `openclaw doctor` to verify your engine is loading correctly. +- If switching engines, existing sessions continue with their current history. + The new engine takes over for future runs. +- Engine errors are logged and surfaced in diagnostics. If a plugin engine + fails to load, OpenClaw falls back to the legacy engine with a warning. +- For development, use `openclaw plugins install -l ./my-engine` to link a + local plugin directory without copying. + +See also: [Compaction](/concepts/compaction), [Context](/concepts/context), +[Plugins](/tools/plugin), [Plugin manifest](/plugins/manifest). diff --git a/docs/concepts/context.md b/docs/concepts/context.md index abc5e5af47c..d5316ea8bf8 100644 --- a/docs/concepts/context.md +++ b/docs/concepts/context.md @@ -157,7 +157,8 @@ By default, OpenClaw uses the built-in `legacy` context engine for assembly and compaction. If you install a plugin that provides `kind: "context-engine"` and select it with `plugins.slots.contextEngine`, OpenClaw delegates context assembly, `/compact`, and related subagent context lifecycle hooks to that -engine instead. +engine instead. See [Context Engine](/concepts/context-engine) for the full +pluggable interface, lifecycle hooks, and configuration. ## What `/context` actually reports diff --git a/docs/docs.json b/docs/docs.json index 80409046397..31dfee49c2f 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -59,6 +59,10 @@ "source": "/compaction", "destination": "/concepts/compaction" }, + { + "source": "/context-engine", + "destination": "/concepts/context-engine" + }, { "source": "/cron", "destination": "/cron-jobs" @@ -952,6 +956,7 @@ "concepts/agent-loop", "concepts/system-prompt", "concepts/context", + "concepts/context-engine", "concepts/agent-workspace", "concepts/oauth" ] From 315cee96b9f853d469b0525a9d2375c9e412eb3e Mon Sep 17 00:00:00 2001 From: Josh Lehman Date: Sat, 14 Mar 2026 10:14:13 -0700 Subject: [PATCH 116/187] docs: add plugin installation steps to context engine page Show the full workflow: install via openclaw plugins install, enable in plugins.entries, then select in plugins.slots.contextEngine. Uses lossless-claw as the concrete example. --- docs/concepts/context-engine.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/concepts/context-engine.md b/docs/concepts/context-engine.md index ec769ca9d54..5c64bc42f3d 100644 --- a/docs/concepts/context-engine.md +++ b/docs/concepts/context-engine.md @@ -26,20 +26,42 @@ openclaw doctor cat ~/.openclaw/openclaw.json | jq '.plugins.slots.contextEngine' ``` -Switch engines: +### Installing a context engine plugin + +Context engine plugins are installed like any other OpenClaw plugin. Install +first, then select the engine in the slot: + +```bash +# Install from npm +openclaw plugins install @martian-engineering/lossless-claw + +# Or install from a local path (for development) +openclaw plugins install -l ./my-context-engine +``` + +Then enable the plugin and select it as the active engine in your config: ```json5 // openclaw.json { plugins: { slots: { - contextEngine: "lossless-claw", // or "legacy" (default) + contextEngine: "lossless-claw", // must match the plugin's registered engine id + }, + entries: { + "lossless-claw": { + enabled: true, + // Plugin-specific config goes here (see the plugin's docs) + }, }, }, } ``` -Restart the gateway after changing the slot. +Restart the gateway after installing and configuring. + +To switch back to the built-in engine, set `contextEngine` to `"legacy"` (or +remove the key entirely — `"legacy"` is the default). ## How it works From 9887311de33f7b49f0fa4b8f23ed84de4b8cd652 Mon Sep 17 00:00:00 2001 From: Josh Lehman Date: Sat, 14 Mar 2026 18:03:06 -0700 Subject: [PATCH 117/187] docs: address review feedback on context-engine page - Rename 'Method' column to 'Member' with explicit Kind column since info is a property, not a callable method - Document AssembleResult fields (estimatedTokens, systemPromptAddition) with types and optionality - Add lifecycle timing notes for bootstrap, ingestBatch, and dispose so plugin authors know when each is invoked --- docs/concepts/context-engine.md | 39 +++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/concepts/context-engine.md b/docs/concepts/context-engine.md index 5c64bc42f3d..7c08c1ddfa2 100644 --- a/docs/concepts/context-engine.md +++ b/docs/concepts/context-engine.md @@ -163,25 +163,32 @@ Then enable it in config: ### The ContextEngine interface -Required methods: +Required members: -| Method | Purpose | -| ------------------ | -------------------------------------------------------- | -| `info` | Engine id, name, version, and whether it owns compaction | -| `ingest(params)` | Store a single message | -| `assemble(params)` | Build context for a model run | -| `compact(params)` | Summarize/reduce context | +| Member | Kind | Purpose | +| ------------------ | -------- | -------------------------------------------------------- | +| `info` | Property | Engine id, name, version, and whether it owns compaction | +| `ingest(params)` | Method | Store a single message | +| `assemble(params)` | Method | Build context for a model run (returns `AssembleResult`) | +| `compact(params)` | Method | Summarize/reduce context | -Optional methods: +`assemble` returns an `AssembleResult` with: +- `messages` — the ordered messages to send to the model. +- `estimatedTokens` (required, `number`) — the engine's estimate of total + tokens in the assembled context. OpenClaw uses this for compaction threshold + decisions and diagnostic reporting. +- `systemPromptAddition` (optional, `string`) — prepended to the system prompt. -| Method | Purpose | -| ------------------------------ | ----------------------------------------- | -| `bootstrap(params)` | Initialize engine state for a new session | -| `ingestBatch(params)` | Ingest a completed turn as a batch | -| `afterTurn(params)` | Post-run lifecycle work | -| `prepareSubagentSpawn(params)` | Set up shared state for a child session | -| `onSubagentEnded(params)` | Clean up after a subagent ends | -| `dispose()` | Release resources | +Optional members: + +| Member | Kind | Purpose | +| ------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------- | +| `bootstrap(params)` | Method | Initialize engine state for a session. Called once when the engine first sees a session (e.g., import history). | +| `ingestBatch(params)` | Method | Ingest a completed turn as a batch. Called after a run completes, with all messages from that turn at once. | +| `afterTurn(params)` | Method | Post-run lifecycle work (persist state, trigger background compaction). | +| `prepareSubagentSpawn(params)` | Method | Set up shared state for a child session. | +| `onSubagentEnded(params)` | Method | Clean up after a subagent ends. | +| `dispose()` | Method | Release resources. Called during gateway shutdown or plugin reload — not per-session. ### ownsCompaction From ff0481ad65786f74add81f67aa289b700e290f06 Mon Sep 17 00:00:00 2001 From: Josh Lehman Date: Tue, 17 Mar 2026 00:08:09 -0700 Subject: [PATCH 118/187] docs: fix context engine review notes --- docs/concepts/context-engine.md | 34 +++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/docs/concepts/context-engine.md b/docs/concepts/context-engine.md index 7c08c1ddfa2..87d5e87d85b 100644 --- a/docs/concepts/context-engine.md +++ b/docs/concepts/context-engine.md @@ -80,12 +80,13 @@ four lifecycle points: ### Subagent lifecycle (optional) -Engines can also manage context across subagent boundaries: +OpenClaw currently calls one subagent lifecycle hook: -- **prepareSubagentSpawn** — set up shared state before a child session starts. - Returns a rollback handle in case the spawn fails. - **onSubagentEnded** — clean up when a subagent session completes or is swept. +The `prepareSubagentSpawn` hook is part of the interface for future use, but +the runtime does not invoke it yet. + ### System prompt addition The `assemble` method can return a `systemPromptAddition` string. OpenClaw @@ -169,10 +170,11 @@ Required members: | ------------------ | -------- | -------------------------------------------------------- | | `info` | Property | Engine id, name, version, and whether it owns compaction | | `ingest(params)` | Method | Store a single message | -| `assemble(params)` | Method | Build context for a model run (returns `AssembleResult`) | +| `assemble(params)` | Method | Build context for a model run (returns `AssembleResult`) | | `compact(params)` | Method | Summarize/reduce context | `assemble` returns an `AssembleResult` with: + - `messages` — the ordered messages to send to the model. - `estimatedTokens` (required, `number`) — the engine's estimate of total tokens in the assembled context. OpenClaw uses this for compaction threshold @@ -183,12 +185,12 @@ Optional members: | Member | Kind | Purpose | | ------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------- | -| `bootstrap(params)` | Method | Initialize engine state for a session. Called once when the engine first sees a session (e.g., import history). | -| `ingestBatch(params)` | Method | Ingest a completed turn as a batch. Called after a run completes, with all messages from that turn at once. | -| `afterTurn(params)` | Method | Post-run lifecycle work (persist state, trigger background compaction). | -| `prepareSubagentSpawn(params)` | Method | Set up shared state for a child session. | -| `onSubagentEnded(params)` | Method | Clean up after a subagent ends. | -| `dispose()` | Method | Release resources. Called during gateway shutdown or plugin reload — not per-session. +| `bootstrap(params)` | Method | Initialize engine state for a session. Called once when the engine first sees a session (e.g., import history). | +| `ingestBatch(params)` | Method | Ingest a completed turn as a batch. Called after a run completes, with all messages from that turn at once. | +| `afterTurn(params)` | Method | Post-run lifecycle work (persist state, trigger background compaction). | +| `prepareSubagentSpawn(params)` | Method | Set up shared state for a child session. | +| `onSubagentEnded(params)` | Method | Clean up after a subagent ends. | +| `dispose()` | Method | Release resources. Called during gateway shutdown or plugin reload — not per-session. | ### ownsCompaction @@ -214,9 +216,11 @@ alongside the engine. } ``` -The slot is exclusive — only one context engine can be active at a time. If -multiple plugins declare `kind: "context-engine"`, only the one selected in -`plugins.slots.contextEngine` loads. Others are disabled with diagnostics. +The slot is exclusive at run time — only one registered context engine is +resolved for a given run or compaction operation. Other enabled +`kind: "context-engine"` plugins can still load and run their registration +code; `plugins.slots.contextEngine` only selects which registered engine id +OpenClaw resolves when it needs a context engine. ## Relationship to compaction and memory @@ -236,7 +240,9 @@ multiple plugins declare `kind: "context-engine"`, only the one selected in - If switching engines, existing sessions continue with their current history. The new engine takes over for future runs. - Engine errors are logged and surfaced in diagnostics. If a plugin engine - fails to load, OpenClaw falls back to the legacy engine with a warning. + fails to register or the selected engine id cannot be resolved, OpenClaw + does not fall back automatically; runs fail until you fix the plugin or + switch `plugins.slots.contextEngine` back to `"legacy"`. - For development, use `openclaw plugins install -l ./my-engine` to link a local plugin directory without copying. From cc35627c8fed73f8eb82ff2f4afc43a62c58419e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:17:26 +0000 Subject: [PATCH 119/187] fix: harden telegram and loader contracts --- .../src/bot.create-telegram-bot.test-harness.ts | 15 +++++++++++++-- src/plugins/contracts/loader.contract.test.ts | 14 ++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts index 24f8e50b706..9f3eea03954 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts @@ -214,8 +214,12 @@ vi.mock("grammy", () => ({ })); const runnerHoisted = vi.hoisted(() => ({ - sequentializeMiddleware: vi.fn(), - sequentializeSpy: vi.fn(), + sequentializeMiddleware: vi.fn(async (_ctx: unknown, next?: () => Promise) => { + if (typeof next === "function") { + await next(); + } + }), + sequentializeSpy: vi.fn(() => runnerHoisted.sequentializeMiddleware), throttlerSpy: vi.fn(() => "throttler"), })); export const sequentializeSpy: AnyMock = runnerHoisted.sequentializeSpy; @@ -355,7 +359,14 @@ beforeEach(() => { listSkillCommandsForAgents.mockReset(); listSkillCommandsForAgents.mockReturnValue([]); middlewareUseSpy.mockReset(); + runnerHoisted.sequentializeMiddleware.mockReset(); + runnerHoisted.sequentializeMiddleware.mockImplementation(async (_ctx, next) => { + if (typeof next === "function") { + await next(); + } + }); sequentializeSpy.mockReset(); + sequentializeSpy.mockImplementation(() => runnerHoisted.sequentializeMiddleware); botCtorSpy.mockReset(); sequentializeKey = undefined; }); diff --git a/src/plugins/contracts/loader.contract.test.ts b/src/plugins/contracts/loader.contract.test.ts index dde3ef19c19..c550f1d96b2 100644 --- a/src/plugins/contracts/loader.contract.test.ts +++ b/src/plugins/contracts/loader.contract.test.ts @@ -1,10 +1,19 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { withBundledPluginAllowlistCompat } from "../bundled-compat.js"; +import { loadPluginManifestRegistry } from "../manifest-registry.js"; import { __testing as providerTesting } from "../providers.js"; import { resolvePluginWebSearchProviders } from "../web-search-providers.js"; import { providerContractCompatPluginIds, webSearchProviderContractRegistry } from "./registry.js"; import { uniqueSortedStrings } from "./testkit.js"; +function resolveBundledManifestProviderPluginIds() { + return uniqueSortedStrings( + loadPluginManifestRegistry({}) + .plugins.filter((plugin) => plugin.origin === "bundled" && plugin.providers.length > 0) + .map((plugin) => plugin.id), + ); +} + describe("plugin loader contract", () => { beforeEach(() => { vi.restoreAllMocks(); @@ -12,6 +21,7 @@ describe("plugin loader contract", () => { it("keeps bundled provider compatibility wired to the provider registry", () => { const providerPluginIds = uniqueSortedStrings(providerContractCompatPluginIds); + const manifestProviderPluginIds = resolveBundledManifestProviderPluginIds(); const compatPluginIds = providerTesting.resolveBundledProviderCompatPluginIds({ config: { plugins: { @@ -29,18 +39,22 @@ describe("plugin loader contract", () => { pluginIds: compatPluginIds, }); + expect(providerPluginIds).toEqual(manifestProviderPluginIds); + expect(uniqueSortedStrings(compatPluginIds)).toEqual(manifestProviderPluginIds); expect(uniqueSortedStrings(compatPluginIds)).toEqual(expect.arrayContaining(providerPluginIds)); expect(compatConfig?.plugins?.allow).toEqual(expect.arrayContaining(providerPluginIds)); }); it("keeps vitest bundled provider enablement wired to the provider registry", () => { const providerPluginIds = uniqueSortedStrings(providerContractCompatPluginIds); + const manifestProviderPluginIds = resolveBundledManifestProviderPluginIds(); const compatConfig = providerTesting.withBundledProviderVitestCompat({ config: undefined, pluginIds: providerPluginIds, env: { VITEST: "1" } as NodeJS.ProcessEnv, }); + expect(providerPluginIds).toEqual(manifestProviderPluginIds); expect(compatConfig?.plugins).toMatchObject({ enabled: true, allow: expect.arrayContaining(providerPluginIds), From d28cb8d821ea004091cd459f80f889ab3a8e335d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:29:38 +0000 Subject: [PATCH 120/187] refactor(tests): share setup wizard prompter --- .../googlechat/src/setup-surface.test.ts | 27 ++--------------- extensions/irc/src/setup-surface.test.ts | 29 +++---------------- extensions/line/src/setup-surface.test.ts | 24 ++------------- extensions/nostr/src/setup-surface.test.ts | 24 ++------------- .../synology-chat/src/setup-surface.test.ts | 26 ++--------------- extensions/test-utils/setup-wizard.ts | 28 ++++++++++++++++++ extensions/tlon/src/setup-surface.test.ts | 27 ++--------------- extensions/zalo/src/setup-surface.test.ts | 20 +++---------- extensions/zalouser/src/setup-surface.test.ts | 27 ++--------------- 9 files changed, 52 insertions(+), 180 deletions(-) create mode 100644 extensions/test-utils/setup-wizard.ts diff --git a/extensions/googlechat/src/setup-surface.test.ts b/extensions/googlechat/src/setup-surface.test.ts index e8855648c99..8ecae3855cc 100644 --- a/extensions/googlechat/src/setup-surface.test.ts +++ b/extensions/googlechat/src/setup-surface.test.ts @@ -1,31 +1,10 @@ -import type { OpenClawConfig, WizardPrompter } from "openclaw/plugin-sdk/googlechat"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/googlechat"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { googlechatPlugin } from "./channel.js"; -const selectFirstOption = async (params: { options: Array<{ value: T }> }): Promise => { - const first = params.options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; -}; - -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: selectFirstOption as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const googlechatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: googlechatPlugin, wizard: googlechatPlugin.setupWizard!, @@ -33,7 +12,7 @@ const googlechatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard describe("googlechat setup wizard", () => { it("configures service-account auth and webhook audience", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Service account JSON path") { return "/tmp/googlechat-service-account.json"; diff --git a/extensions/irc/src/setup-surface.test.ts b/extensions/irc/src/setup-surface.test.ts index 147432b6131..6ac3fb268cc 100644 --- a/extensions/irc/src/setup-surface.test.ts +++ b/extensions/irc/src/setup-surface.test.ts @@ -1,32 +1,11 @@ -import type { RuntimeEnv, WizardPrompter } from "openclaw/plugin-sdk/irc"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/irc"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { ircPlugin } from "./channel.js"; import type { CoreConfig } from "./types.js"; -const selectFirstOption = async (params: { options: Array<{ value: T }> }): Promise => { - const first = params.options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; -}; - -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: selectFirstOption as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const ircConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: ircPlugin, wizard: ircPlugin.setupWizard!, @@ -34,7 +13,7 @@ const ircConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("irc setup wizard", () => { it("configures host and nick via setup prompts", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "IRC server host") { return "irc.libera.chat"; @@ -93,7 +72,7 @@ describe("irc setup wizard", () => { }); it("writes DM allowFrom to top-level config for non-default account prompts", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "IRC allowFrom (nick or nick!user@host)") { return "Alice, Bob!ident@example.org"; diff --git a/extensions/line/src/setup-surface.test.ts b/extensions/line/src/setup-surface.test.ts index 3fd98df4b2e..bf4e560e0df 100644 --- a/extensions/line/src/setup-surface.test.ts +++ b/extensions/line/src/setup-surface.test.ts @@ -6,30 +6,10 @@ import { resolveDefaultLineAccountId, resolveLineAccount, } from "../../../src/line/accounts.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { lineSetupAdapter, lineSetupWizard } from "./setup-surface.js"; -function createPrompter(overrides: Partial = {}): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: vi.fn(async ({ options }: { options: Array<{ value: string }> }) => { - const first = options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; - }) as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const lineConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: { id: "line", @@ -47,7 +27,7 @@ const lineConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("line setup wizard", () => { it("configures token and secret for the default account", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Enter LINE channel access token") { return "line-token"; diff --git a/extensions/nostr/src/setup-surface.test.ts b/extensions/nostr/src/setup-surface.test.ts index 0a46946f8f9..2985ff3e513 100644 --- a/extensions/nostr/src/setup-surface.test.ts +++ b/extensions/nostr/src/setup-surface.test.ts @@ -1,30 +1,10 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/nostr"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { nostrPlugin } from "./channel.js"; -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: vi.fn(async ({ options }: { options: Array<{ value: string }> }) => { - const first = options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; - }) as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const nostrConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: nostrPlugin, wizard: nostrPlugin.setupWizard!, @@ -32,7 +12,7 @@ const nostrConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("nostr setup wizard", () => { it("configures a private key and relay URLs", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Nostr private key (nsec... or hex)") { return "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"; diff --git a/extensions/synology-chat/src/setup-surface.test.ts b/extensions/synology-chat/src/setup-surface.test.ts index 6c1289a8a84..96c17300e0f 100644 --- a/extensions/synology-chat/src/setup-surface.test.ts +++ b/extensions/synology-chat/src/setup-surface.test.ts @@ -1,31 +1,11 @@ import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import type { WizardPrompter } from "../../../src/wizard/prompts.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { synologyChatPlugin } from "./channel.js"; import { synologyChatSetupWizard } from "./setup-surface.js"; -function createPrompter(overrides: Partial = {}): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: vi.fn(async ({ options }: { options: Array<{ value: string }> }) => { - const first = options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; - }) as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const synologyChatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: synologyChatPlugin, wizard: synologyChatSetupWizard, @@ -33,7 +13,7 @@ const synologyChatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWiza describe("synology-chat setup wizard", () => { it("configures token and incoming webhook for the default account", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Enter Synology Chat outgoing webhook token") { return "synology-token"; @@ -67,7 +47,7 @@ describe("synology-chat setup wizard", () => { }); it("records allowed user ids when setup forces allowFrom", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Enter Synology Chat outgoing webhook token") { return "synology-token"; diff --git a/extensions/test-utils/setup-wizard.ts b/extensions/test-utils/setup-wizard.ts new file mode 100644 index 00000000000..aab15a4aecc --- /dev/null +++ b/extensions/test-utils/setup-wizard.ts @@ -0,0 +1,28 @@ +import { vi } from "vitest"; +import type { WizardPrompter } from "../../src/wizard/prompts.js"; + +export type { WizardPrompter } from "../../src/wizard/prompts.js"; + +export async function selectFirstWizardOption(params: { + options: Array<{ value: T }>; +}): Promise { + const first = params.options[0]; + if (!first) { + throw new Error("no options"); + } + return first.value; +} + +export function createTestWizardPrompter(overrides: Partial = {}): WizardPrompter { + return { + intro: vi.fn(async () => {}), + outro: vi.fn(async () => {}), + note: vi.fn(async () => {}), + select: selectFirstWizardOption as WizardPrompter["select"], + multiselect: vi.fn(async () => []), + text: vi.fn(async () => "") as WizardPrompter["text"], + confirm: vi.fn(async () => false), + progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), + ...overrides, + }; +} diff --git a/extensions/tlon/src/setup-surface.test.ts b/extensions/tlon/src/setup-surface.test.ts index d54db2c75a1..f2b53f0df72 100644 --- a/extensions/tlon/src/setup-surface.test.ts +++ b/extensions/tlon/src/setup-surface.test.ts @@ -1,31 +1,10 @@ -import type { OpenClawConfig, RuntimeEnv, WizardPrompter } from "openclaw/plugin-sdk/tlon"; +import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/tlon"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { tlonPlugin } from "./channel.js"; -const selectFirstOption = async (params: { options: Array<{ value: T }> }): Promise => { - const first = params.options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; -}; - -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: selectFirstOption as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const tlonConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: tlonPlugin, wizard: tlonPlugin.setupWizard!, @@ -33,7 +12,7 @@ const tlonConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("tlon setup wizard", () => { it("configures ship, auth, and discovery settings", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ text: vi.fn(async ({ message }: { message: string }) => { if (message === "Ship name") { return "sampel-palnet"; diff --git a/extensions/zalo/src/setup-surface.test.ts b/extensions/zalo/src/setup-surface.test.ts index f00060b50c6..a6e278b6f69 100644 --- a/extensions/zalo/src/setup-surface.test.ts +++ b/extensions/zalo/src/setup-surface.test.ts @@ -1,23 +1,10 @@ -import type { OpenClawConfig, RuntimeEnv, WizardPrompter } from "openclaw/plugin-sdk/zalo"; +import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/zalo"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; import { zaloPlugin } from "./channel.js"; -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: vi.fn(async () => "plaintext") as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const zaloConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: zaloPlugin, wizard: zaloPlugin.setupWizard!, @@ -25,7 +12,8 @@ const zaloConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("zalo setup wizard", () => { it("configures a polling token flow", async () => { - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ + select: vi.fn(async () => "plaintext") as WizardPrompter["select"], text: vi.fn(async ({ message }: { message: string }) => { if (message === "Enter Zalo bot token") { return "12345689:abc-xyz"; diff --git a/extensions/zalouser/src/setup-surface.test.ts b/extensions/zalouser/src/setup-surface.test.ts index fc95b90ab8d..1aa8dd93bd0 100644 --- a/extensions/zalouser/src/setup-surface.test.ts +++ b/extensions/zalouser/src/setup-surface.test.ts @@ -1,7 +1,8 @@ -import type { OpenClawConfig, WizardPrompter } from "openclaw/plugin-sdk/zalouser"; +import type { OpenClawConfig } from "openclaw/plugin-sdk/zalouser"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createTestWizardPrompter } from "../../test-utils/setup-wizard.js"; vi.mock("./zalo-js.js", async (importOriginal) => { const actual = await importOriginal(); @@ -28,28 +29,6 @@ vi.mock("./zalo-js.js", async (importOriginal) => { import { zalouserPlugin } from "./channel.js"; -const selectFirstOption = async (params: { options: Array<{ value: T }> }): Promise => { - const first = params.options[0]; - if (!first) { - throw new Error("no options"); - } - return first.value; -}; - -function createPrompter(overrides: Partial): WizardPrompter { - return { - intro: vi.fn(async () => {}), - outro: vi.fn(async () => {}), - note: vi.fn(async () => {}), - select: selectFirstOption as WizardPrompter["select"], - multiselect: vi.fn(async () => []), - text: vi.fn(async () => "") as WizardPrompter["text"], - confirm: vi.fn(async () => false), - progress: vi.fn(() => ({ update: vi.fn(), stop: vi.fn() })), - ...overrides, - }; -} - const zalouserConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ plugin: zalouserPlugin, wizard: zalouserPlugin.setupWizard!, @@ -58,7 +37,7 @@ const zalouserConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ describe("zalouser setup wizard", () => { it("enables the account without forcing QR login", async () => { const runtime = createRuntimeEnv(); - const prompter = createPrompter({ + const prompter = createTestWizardPrompter({ confirm: vi.fn(async ({ message }: { message: string }) => { if (message === "Login via QR code now?") { return false; From e184cd97cce9c290373dba470a2f15b8aad826ba Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:31:29 +0000 Subject: [PATCH 121/187] refactor(telegram-tests): share native command helpers --- ...ve-commands.plugin-command-test-support.ts | 22 +++++ .../src/bot-native-commands.registry.test.ts | 93 ++++++++----------- ...t-native-commands.skills-allowlist.test.ts | 20 +--- .../telegram/src/bot-native-commands.test.ts | 22 +---- 4 files changed, 73 insertions(+), 84 deletions(-) create mode 100644 extensions/telegram/src/bot-native-commands.plugin-command-test-support.ts diff --git a/extensions/telegram/src/bot-native-commands.plugin-command-test-support.ts b/extensions/telegram/src/bot-native-commands.plugin-command-test-support.ts new file mode 100644 index 00000000000..b4a47b728e4 --- /dev/null +++ b/extensions/telegram/src/bot-native-commands.plugin-command-test-support.ts @@ -0,0 +1,22 @@ +import { vi } from "vitest"; + +export const pluginCommandMocks = { + getPluginCommandSpecs: vi.fn(() => []), + matchPluginCommand: vi.fn(() => null), + executePluginCommand: vi.fn(async () => ({ text: "ok" })), +}; + +vi.mock("../../../src/plugins/commands.js", () => ({ + getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, + matchPluginCommand: pluginCommandMocks.matchPluginCommand, + executePluginCommand: pluginCommandMocks.executePluginCommand, +})); + +export function resetPluginCommandMocks() { + pluginCommandMocks.getPluginCommandSpecs.mockClear(); + pluginCommandMocks.getPluginCommandSpecs.mockReturnValue([]); + pluginCommandMocks.matchPluginCommand.mockClear(); + pluginCommandMocks.matchPluginCommand.mockReturnValue(null); + pluginCommandMocks.executePluginCommand.mockClear(); + pluginCommandMocks.executePluginCommand.mockResolvedValue({ text: "ok" }); +} diff --git a/extensions/telegram/src/bot-native-commands.registry.test.ts b/extensions/telegram/src/bot-native-commands.registry.test.ts index 55379e6a5fa..d671be06609 100644 --- a/extensions/telegram/src/bot-native-commands.registry.test.ts +++ b/extensions/telegram/src/bot-native-commands.registry.test.ts @@ -17,6 +17,38 @@ import { waitForRegisteredCommands, } from "./bot-native-commands.menu-test-support.js"; +function registerPairPluginCommand(params?: { + nativeNames?: { telegram?: string; discord?: string }; +}) { + expect( + registerPluginCommand("demo-plugin", { + name: "pair", + ...(params?.nativeNames ? { nativeNames: params.nativeNames } : {}), + description: "Pair device", + acceptsArgs: true, + requireAuth: false, + handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), + }), + ).toEqual({ ok: true }); +} + +async function registerPairMenu(params: { + bot: ReturnType["bot"]; + setMyCommands: ReturnType["setMyCommands"]; + nativeNames?: { telegram?: string; discord?: string }; +}) { + registerPairPluginCommand({ + ...(params.nativeNames ? { nativeNames: params.nativeNames } : {}), + }); + + registerTelegramNativeCommands({ + ...createNativeCommandTestParams({}), + bot: params.bot, + }); + + return await waitForRegisteredCommands(params.setMyCommands); +} + describe("registerTelegramNativeCommands real plugin registry", () => { beforeEach(() => { clearPluginCommands(); @@ -31,22 +63,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { it("registers and executes plugin commands through the real plugin registry", async () => { const { bot, commandHandlers, sendMessage, setMyCommands } = createCommandBot(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); - - registerTelegramNativeCommands({ - ...createNativeCommandTestParams({}), - bot, - }); - - const registeredCommands = await waitForRegisteredCommands(setMyCommands); + const registeredCommands = await registerPairMenu({ bot, setMyCommands }); expect(registeredCommands).toEqual( expect.arrayContaining([{ command: "pair", description: "Pair device" }]), ); @@ -67,26 +84,14 @@ describe("registerTelegramNativeCommands real plugin registry", () => { it("round-trips Telegram native aliases through the real plugin registry", async () => { const { bot, commandHandlers, sendMessage, setMyCommands } = createCommandBot(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - nativeNames: { - telegram: "pair_device", - discord: "pairdiscord", - }, - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); - - registerTelegramNativeCommands({ - ...createNativeCommandTestParams({}), + const registeredCommands = await registerPairMenu({ bot, + setMyCommands, + nativeNames: { + telegram: "pair_device", + discord: "pairdiscord", + }, }); - - const registeredCommands = await waitForRegisteredCommands(setMyCommands); expect(registeredCommands).toEqual( expect.arrayContaining([{ command: "pair_device", description: "Pair device" }]), ); @@ -107,15 +112,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { it("keeps real plugin command handlers available when native menu registration is disabled", () => { const { bot, commandHandlers, setMyCommands } = createCommandBot(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); + registerPairPluginCommand(); registerTelegramNativeCommands({ ...createNativeCommandTestParams({}, { accountId: "default" }), @@ -130,15 +127,7 @@ describe("registerTelegramNativeCommands real plugin registry", () => { it("allows requireAuth:false plugin commands for unauthorized senders through the real registry", async () => { const { bot, commandHandlers, sendMessage, setMyCommands } = createCommandBot(); - expect( - registerPluginCommand("demo-plugin", { - name: "pair", - description: "Pair device", - acceptsArgs: true, - requireAuth: false, - handler: async ({ args }) => ({ text: `paired:${args ?? ""}` }), - }), - ).toEqual({ ok: true }); + registerPairPluginCommand(); registerTelegramNativeCommands({ ...createNativeCommandTestParams({ diff --git a/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts b/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts index d15db967767..29540bb9011 100644 --- a/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts +++ b/extensions/telegram/src/bot-native-commands.skills-allowlist.test.ts @@ -10,18 +10,10 @@ import { resetNativeCommandMenuMocks, waitForRegisteredCommands, } from "./bot-native-commands.menu-test-support.js"; - -const pluginCommandMocks = vi.hoisted(() => ({ - getPluginCommandSpecs: vi.fn(() => []), - matchPluginCommand: vi.fn(() => null), - executePluginCommand: vi.fn(async () => ({ text: "ok" })), -})); - -vi.mock("../../../src/plugins/commands.js", () => ({ - getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, - matchPluginCommand: pluginCommandMocks.matchPluginCommand, - executePluginCommand: pluginCommandMocks.executePluginCommand, -})); +import { + pluginCommandMocks, + resetPluginCommandMocks, +} from "./bot-native-commands.plugin-command-test-support.js"; const tempDirs: string[] = []; @@ -34,9 +26,7 @@ async function makeWorkspace(prefix: string) { describe("registerTelegramNativeCommands skill allowlist integration", () => { afterEach(async () => { resetNativeCommandMenuMocks(); - pluginCommandMocks.getPluginCommandSpecs.mockClear().mockReturnValue([]); - pluginCommandMocks.matchPluginCommand.mockClear().mockReturnValue(null); - pluginCommandMocks.executePluginCommand.mockClear().mockResolvedValue({ text: "ok" }); + resetPluginCommandMocks(); await Promise.all( tempDirs .splice(0, tempDirs.length) diff --git a/extensions/telegram/src/bot-native-commands.test.ts b/extensions/telegram/src/bot-native-commands.test.ts index 683842fa2df..a3f5ab3a9ce 100644 --- a/extensions/telegram/src/bot-native-commands.test.ts +++ b/extensions/telegram/src/bot-native-commands.test.ts @@ -5,6 +5,10 @@ import { STATE_DIR } from "../../../src/config/paths.js"; import { TELEGRAM_COMMAND_NAME_PATTERN } from "../../../src/config/telegram-custom-commands.js"; import type { TelegramAccountConfig } from "../../../src/config/types.js"; import type { RuntimeEnv } from "../../../src/runtime.js"; +import { + pluginCommandMocks, + resetPluginCommandMocks, +} from "./bot-native-commands.plugin-command-test-support.js"; const skillCommandMocks = vi.hoisted(() => ({ listSkillCommandsForAgents: vi.fn(() => []), })); @@ -32,29 +36,13 @@ import { waitForRegisteredCommands, } from "./bot-native-commands.menu-test-support.js"; -const pluginCommandMocks = vi.hoisted(() => ({ - getPluginCommandSpecs: vi.fn(() => []), - matchPluginCommand: vi.fn(() => null), - executePluginCommand: vi.fn(async () => ({ text: "ok" })), -})); -vi.mock("../../../src/plugins/commands.js", () => ({ - getPluginCommandSpecs: pluginCommandMocks.getPluginCommandSpecs, - matchPluginCommand: pluginCommandMocks.matchPluginCommand, - executePluginCommand: pluginCommandMocks.executePluginCommand, -})); - describe("registerTelegramNativeCommands", () => { beforeEach(() => { skillCommandMocks.listSkillCommandsForAgents.mockClear(); skillCommandMocks.listSkillCommandsForAgents.mockReturnValue([]); deliveryMocks.deliverReplies.mockClear(); deliveryMocks.deliverReplies.mockResolvedValue({ delivered: true }); - pluginCommandMocks.getPluginCommandSpecs.mockClear(); - pluginCommandMocks.getPluginCommandSpecs.mockReturnValue([]); - pluginCommandMocks.matchPluginCommand.mockClear(); - pluginCommandMocks.matchPluginCommand.mockReturnValue(null); - pluginCommandMocks.executePluginCommand.mockClear(); - pluginCommandMocks.executePluginCommand.mockResolvedValue({ text: "ok" }); + resetPluginCommandMocks(); }); it("scopes skill commands when account binding exists", () => { From 1ff10690e730b197cfb0eb690e9831b48599a5c5 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:32:27 +0000 Subject: [PATCH 122/187] fix(telegram-tests): load plugin mocks before commands From e1ca5d9cc4b37646e8976637e34c23ff155106b0 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:36:11 +0000 Subject: [PATCH 123/187] refactor(telegram-tests): share webhook settlement helper --- extensions/telegram/src/webhook.test.ts | 89 +++++++++++++------------ 1 file changed, 47 insertions(+), 42 deletions(-) diff --git a/extensions/telegram/src/webhook.test.ts b/extensions/telegram/src/webhook.test.ts index 0f2736a30b9..549e73f9ba3 100644 --- a/extensions/telegram/src/webhook.test.ts +++ b/extensions/telegram/src/webhook.test.ts @@ -40,6 +40,35 @@ function collectResponseBody( }); } +function createSingleSettlement(params: { + resolve: (value: T) => void; + reject: (error: unknown) => void; + clear: () => void; +}) { + let settled = false; + return { + isSettled() { + return settled; + }, + resolve(value: T) { + if (settled) { + return; + } + settled = true; + params.clear(); + params.resolve(value); + }, + reject(error: unknown) { + if (settled) { + return; + } + settled = true; + params.clear(); + params.reject(error); + }, + }; +} + vi.mock("grammy", async (importOriginal) => { const actual = await importOriginal(); return { @@ -96,23 +125,11 @@ async function postWebhookHeadersOnly(params: { timeoutMs?: number; }): Promise<{ statusCode: number; body: string }> { return await new Promise((resolve, reject) => { - let settled = false; - const finishResolve = (value: { statusCode: number; body: string }) => { - if (settled) { - return; - } - settled = true; - clearTimeout(timeout); - resolve(value); - }; - const finishReject = (error: unknown) => { - if (settled) { - return; - } - settled = true; - clearTimeout(timeout); - reject(error); - }; + const settle = createSingleSettlement({ + resolve, + reject, + clear: () => clearTimeout(timeout), + }); const req = request( { @@ -128,7 +145,7 @@ async function postWebhookHeadersOnly(params: { }, (res) => { collectResponseBody(res, (payload) => { - finishResolve(payload); + settle.resolve(payload); req.destroy(); }); }, @@ -138,14 +155,14 @@ async function postWebhookHeadersOnly(params: { req.destroy( new Error(`webhook header-only post timed out after ${params.timeoutMs ?? 5_000}ms`), ); - finishReject(new Error("timed out waiting for webhook response")); + settle.reject(new Error("timed out waiting for webhook response")); }, params.timeoutMs ?? 5_000); req.on("error", (error) => { - if (settled && (error as NodeJS.ErrnoException).code === "ECONNRESET") { + if (settle.isSettled() && (error as NodeJS.ErrnoException).code === "ECONNRESET") { return; } - finishReject(error); + settle.reject(error); }); req.flushHeaders(); @@ -173,23 +190,11 @@ async function postWebhookPayloadWithChunkPlan(params: { let bytesQueued = 0; let chunksQueued = 0; let phase: "writing" | "awaiting-response" = "writing"; - let settled = false; - const finishResolve = (value: { statusCode: number; body: string }) => { - if (settled) { - return; - } - settled = true; - clearTimeout(timeout); - resolve(value); - }; - const finishReject = (error: unknown) => { - if (settled) { - return; - } - settled = true; - clearTimeout(timeout); - reject(error); - }; + const settle = createSingleSettlement({ + resolve, + reject, + clear: () => clearTimeout(timeout), + }); const req = request( { @@ -204,12 +209,12 @@ async function postWebhookPayloadWithChunkPlan(params: { }, }, (res) => { - collectResponseBody(res, finishResolve); + collectResponseBody(res, settle.resolve); }, ); const timeout = setTimeout(() => { - finishReject( + settle.reject( new Error( `webhook post timed out after ${params.timeoutMs ?? 15_000}ms (phase=${phase}, bytesQueued=${bytesQueued}, chunksQueued=${chunksQueued}, totalBytes=${payloadBuffer.length})`, ), @@ -218,7 +223,7 @@ async function postWebhookPayloadWithChunkPlan(params: { }, params.timeoutMs ?? 15_000); req.on("error", (error) => { - finishReject(error); + settle.reject(error); }); const writeAll = async () => { @@ -251,7 +256,7 @@ async function postWebhookPayloadWithChunkPlan(params: { }; void writeAll().catch((error) => { - finishReject(error); + settle.reject(error); }); }); } From 769332c1a71b496f7f0b92325e582bace40f2719 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:37:25 +0000 Subject: [PATCH 124/187] refactor(nextcloud-tests): share inbound authz setup --- .../nextcloud-talk/src/inbound.authz.test.ts | 76 +++++++++---------- 1 file changed, 34 insertions(+), 42 deletions(-) diff --git a/extensions/nextcloud-talk/src/inbound.authz.test.ts b/extensions/nextcloud-talk/src/inbound.authz.test.ts index bde32abdb3c..873b74bc93a 100644 --- a/extensions/nextcloud-talk/src/inbound.authz.test.ts +++ b/extensions/nextcloud-talk/src/inbound.authz.test.ts @@ -5,28 +5,42 @@ import { handleNextcloudTalkInbound } from "./inbound.js"; import { setNextcloudTalkRuntime } from "./runtime.js"; import type { CoreConfig, NextcloudTalkInboundMessage } from "./types.js"; +function installInboundAuthzRuntime(params: { + readAllowFromStore: () => Promise; + buildMentionRegexes: () => RegExp[]; +}) { + setNextcloudTalkRuntime({ + channel: { + pairing: { + readAllowFromStore: params.readAllowFromStore, + }, + commands: { + shouldHandleTextCommands: () => false, + }, + text: { + hasControlCommand: () => false, + }, + mentions: { + buildMentionRegexes: params.buildMentionRegexes, + matchesMentionPatterns: () => false, + }, + }, + } as unknown as PluginRuntime); +} + +function createTestRuntimeEnv(): RuntimeEnv { + return { + log: vi.fn(), + error: vi.fn(), + } as unknown as RuntimeEnv; +} + describe("nextcloud-talk inbound authz", () => { it("does not treat DM pairing-store entries as group allowlist entries", async () => { const readAllowFromStore = vi.fn(async () => ["attacker"]); const buildMentionRegexes = vi.fn(() => [/@openclaw/i]); - setNextcloudTalkRuntime({ - channel: { - pairing: { - readAllowFromStore, - }, - commands: { - shouldHandleTextCommands: () => false, - }, - text: { - hasControlCommand: () => false, - }, - mentions: { - buildMentionRegexes, - matchesMentionPatterns: () => false, - }, - }, - } as unknown as PluginRuntime); + installInboundAuthzRuntime({ readAllowFromStore, buildMentionRegexes }); const message: NextcloudTalkInboundMessage = { messageId: "m-1", @@ -69,10 +83,7 @@ describe("nextcloud-talk inbound authz", () => { message, account, config, - runtime: { - log: vi.fn(), - error: vi.fn(), - } as unknown as RuntimeEnv, + runtime: createTestRuntimeEnv(), }); expect(readAllowFromStore).toHaveBeenCalledWith({ @@ -86,23 +97,7 @@ describe("nextcloud-talk inbound authz", () => { const readAllowFromStore = vi.fn(async () => []); const buildMentionRegexes = vi.fn(() => [/@openclaw/i]); - setNextcloudTalkRuntime({ - channel: { - pairing: { - readAllowFromStore, - }, - commands: { - shouldHandleTextCommands: () => false, - }, - text: { - hasControlCommand: () => false, - }, - mentions: { - buildMentionRegexes, - matchesMentionPatterns: () => false, - }, - }, - } as unknown as PluginRuntime); + installInboundAuthzRuntime({ readAllowFromStore, buildMentionRegexes }); const message: NextcloudTalkInboundMessage = { messageId: "m-2", @@ -146,10 +141,7 @@ describe("nextcloud-talk inbound authz", () => { }, }, }, - runtime: { - log: vi.fn(), - error: vi.fn(), - } as unknown as RuntimeEnv, + runtime: createTestRuntimeEnv(), }); expect(buildMentionRegexes).not.toHaveBeenCalled(); From 214c7a481c93db720d951cce7e3e247644cb677c Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:40:59 +0000 Subject: [PATCH 125/187] refactor(feishu-tests): share card action event builders --- extensions/feishu/src/bot.card-action.test.ts | 175 +++++++++--------- 1 file changed, 84 insertions(+), 91 deletions(-) diff --git a/extensions/feishu/src/bot.card-action.test.ts b/extensions/feishu/src/bot.card-action.test.ts index 2df1ce361a1..2d2e7ac235d 100644 --- a/extensions/feishu/src/bot.card-action.test.ts +++ b/extensions/feishu/src/bot.card-action.test.ts @@ -35,6 +35,54 @@ describe("Feishu Card Action Handler", () => { const cfg = {} as any; // Minimal mock const runtime = { log: vi.fn(), error: vi.fn() } as any; + function createCardActionEvent(params: { + token: string; + actionValue: unknown; + chatId?: string; + openId?: string; + userId?: string; + unionId?: string; + }): FeishuCardActionEvent { + const openId = params.openId ?? "u123"; + const userId = params.userId ?? "uid1"; + return { + operator: { open_id: openId, user_id: userId, union_id: params.unionId ?? "un1" }, + token: params.token, + action: { + value: params.actionValue, + tag: "button", + }, + context: { open_id: openId, user_id: userId, chat_id: params.chatId ?? "chat1" }, + }; + } + + function createStructuredQuickActionEvent(params: { + token: string; + action: string; + command?: string; + chatId?: string; + chatType?: "group" | "p2p"; + operatorOpenId?: string; + actionOpenId?: string; + }): FeishuCardActionEvent { + return createCardActionEvent({ + token: params.token, + chatId: params.chatId, + openId: params.operatorOpenId, + actionValue: createFeishuCardInteractionEnvelope({ + k: "quick", + a: params.action, + ...(params.command ? { q: params.command } : {}), + c: { + u: params.actionOpenId ?? params.operatorOpenId ?? "u123", + h: params.chatId ?? "chat1", + t: params.chatType ?? "group", + e: Date.now() + 60_000, + }, + }), + }); + } + beforeEach(() => { vi.clearAllMocks(); resetProcessedFeishuCardActionTokensForTests(); @@ -85,20 +133,11 @@ describe("Feishu Card Action Handler", () => { }); it("routes quick command actions with operator and conversation context", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok3", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "chat1" }, - }; + action: "feishu.quick_actions.help", + command: "/help", + }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -182,20 +221,11 @@ describe("Feishu Card Action Handler", () => { }); it("runs approval confirmation through the normal message path", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok5", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: FEISHU_APPROVAL_CONFIRM_ACTION, - q: "/new", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "chat1" }, - }; + action: FEISHU_APPROVAL_CONFIRM_ACTION, + command: "/new", + }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -211,20 +241,15 @@ describe("Feishu Card Action Handler", () => { }); it("safely rejects stale structured actions", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createCardActionEvent({ token: "tok6", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() - 1 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "chat1" }, - }; + actionValue: createFeishuCardInteractionEnvelope({ + k: "quick", + a: "feishu.quick_actions.help", + q: "/help", + c: { u: "u123", h: "chat1", t: "group", e: Date.now() - 1 }, + }), + }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -238,20 +263,13 @@ describe("Feishu Card Action Handler", () => { }); it("safely rejects wrong-user structured actions", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u999", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok7", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u999", user_id: "uid1", chat_id: "chat1" }, - }; + action: "feishu.quick_actions.help", + command: "/help", + operatorOpenId: "u999", + actionOpenId: "u123", + }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -289,20 +307,13 @@ describe("Feishu Card Action Handler", () => { }); it("preserves p2p callbacks for DM quick actions", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok9", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "p2p-chat-1", t: "p2p", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "p2p-chat-1" }, - }; + action: "feishu.quick_actions.help", + command: "/help", + chatId: "p2p-chat-1", + chatType: "p2p", + }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -319,20 +330,11 @@ describe("Feishu Card Action Handler", () => { }); it("drops duplicate structured callback tokens", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok10", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "chat1" }, - }; + action: "feishu.quick_actions.help", + command: "/help", + }); await handleFeishuCardAction({ cfg, event, runtime }); await handleFeishuCardAction({ cfg, event, runtime }); @@ -341,20 +343,11 @@ describe("Feishu Card Action Handler", () => { }); it("releases a claimed token when dispatch fails so retries can succeed", async () => { - const event: FeishuCardActionEvent = { - operator: { open_id: "u123", user_id: "uid1", union_id: "un1" }, + const event = createStructuredQuickActionEvent({ token: "tok11", - action: { - value: createFeishuCardInteractionEnvelope({ - k: "quick", - a: "feishu.quick_actions.help", - q: "/help", - c: { u: "u123", h: "chat1", t: "group", e: Date.now() + 60_000 }, - }), - tag: "button", - }, - context: { open_id: "u123", user_id: "uid1", chat_id: "chat1" }, - }; + action: "feishu.quick_actions.help", + command: "/help", + }); vi.mocked(handleFeishuMessage) .mockRejectedValueOnce(new Error("transient")) .mockResolvedValueOnce(undefined as never); From 52ad686ab5ec290f6fe252254f9b2cd04d140a9f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:42:28 +0000 Subject: [PATCH 126/187] refactor(runtime-tests): share typing lease assertions --- .../runtime/runtime-discord-typing.test.ts | 55 +++++++------------ .../runtime/runtime-telegram-typing.test.ts | 53 ++++++------------ .../runtime/typing-lease.test-support.ts | 47 ++++++++++++++++ 3 files changed, 84 insertions(+), 71 deletions(-) create mode 100644 src/plugins/runtime/typing-lease.test-support.ts diff --git a/src/plugins/runtime/runtime-discord-typing.test.ts b/src/plugins/runtime/runtime-discord-typing.test.ts index 1eb5b6fd315..6f6ec1a1dec 100644 --- a/src/plugins/runtime/runtime-discord-typing.test.ts +++ b/src/plugins/runtime/runtime-discord-typing.test.ts @@ -1,5 +1,9 @@ -import { afterEach, describe, expect, it, vi } from "vitest"; +import { afterEach, describe, it, vi } from "vitest"; import { createDiscordTypingLease } from "./runtime-discord-typing.js"; +import { + expectBackgroundTypingPulseFailuresAreSwallowed, + expectIndependentTypingLeases, +} from "./typing-lease.test-support.js"; describe("createDiscordTypingLease", () => { afterEach(() => { @@ -7,51 +11,30 @@ describe("createDiscordTypingLease", () => { }); it("pulses immediately and keeps leases independent", async () => { - vi.useFakeTimers(); - const pulse = vi.fn(async () => undefined); - - const leaseA = await createDiscordTypingLease({ - channelId: "123", - intervalMs: 2_000, - pulse, + await expectIndependentTypingLeases({ + createLease: createDiscordTypingLease, + buildParams: (pulse) => ({ + channelId: "123", + intervalMs: 2_000, + pulse, + }), }); - const leaseB = await createDiscordTypingLease({ - channelId: "123", - intervalMs: 2_000, - pulse, - }); - - expect(pulse).toHaveBeenCalledTimes(2); - - await vi.advanceTimersByTimeAsync(2_000); - expect(pulse).toHaveBeenCalledTimes(4); - - leaseA.stop(); - await vi.advanceTimersByTimeAsync(2_000); - expect(pulse).toHaveBeenCalledTimes(5); - - await leaseB.refresh(); - expect(pulse).toHaveBeenCalledTimes(6); - - leaseB.stop(); }); it("swallows background pulse failures", async () => { - vi.useFakeTimers(); const pulse = vi .fn<(params: { channelId: string; accountId?: string; cfg?: unknown }) => Promise>() .mockResolvedValueOnce(undefined) .mockRejectedValueOnce(new Error("boom")); - const lease = await createDiscordTypingLease({ - channelId: "123", - intervalMs: 2_000, + await expectBackgroundTypingPulseFailuresAreSwallowed({ + createLease: createDiscordTypingLease, pulse, + buildParams: (pulse) => ({ + channelId: "123", + intervalMs: 2_000, + pulse, + }), }); - - await expect(vi.advanceTimersByTimeAsync(2_000)).resolves.toBe(vi); - expect(pulse).toHaveBeenCalledTimes(2); - - lease.stop(); }); }); diff --git a/src/plugins/runtime/runtime-telegram-typing.test.ts b/src/plugins/runtime/runtime-telegram-typing.test.ts index 3394aa1cf50..0ec97971eb8 100644 --- a/src/plugins/runtime/runtime-telegram-typing.test.ts +++ b/src/plugins/runtime/runtime-telegram-typing.test.ts @@ -1,5 +1,9 @@ import { afterEach, describe, expect, it, vi } from "vitest"; import { createTelegramTypingLease } from "./runtime-telegram-typing.js"; +import { + expectBackgroundTypingPulseFailuresAreSwallowed, + expectIndependentTypingLeases, +} from "./typing-lease.test-support.js"; describe("createTelegramTypingLease", () => { afterEach(() => { @@ -7,37 +11,17 @@ describe("createTelegramTypingLease", () => { }); it("pulses immediately and keeps leases independent", async () => { - vi.useFakeTimers(); - const pulse = vi.fn(async () => undefined); - - const leaseA = await createTelegramTypingLease({ - to: "telegram:123", - intervalMs: 2_000, - pulse, + await expectIndependentTypingLeases({ + createLease: createTelegramTypingLease, + buildParams: (pulse) => ({ + to: "telegram:123", + intervalMs: 2_000, + pulse, + }), }); - const leaseB = await createTelegramTypingLease({ - to: "telegram:123", - intervalMs: 2_000, - pulse, - }); - - expect(pulse).toHaveBeenCalledTimes(2); - - await vi.advanceTimersByTimeAsync(2_000); - expect(pulse).toHaveBeenCalledTimes(4); - - leaseA.stop(); - await vi.advanceTimersByTimeAsync(2_000); - expect(pulse).toHaveBeenCalledTimes(5); - - await leaseB.refresh(); - expect(pulse).toHaveBeenCalledTimes(6); - - leaseB.stop(); }); it("swallows background pulse failures", async () => { - vi.useFakeTimers(); const pulse = vi .fn< (params: { @@ -50,16 +34,15 @@ describe("createTelegramTypingLease", () => { .mockResolvedValueOnce(undefined) .mockRejectedValueOnce(new Error("boom")); - const lease = await createTelegramTypingLease({ - to: "telegram:123", - intervalMs: 2_000, + await expectBackgroundTypingPulseFailuresAreSwallowed({ + createLease: createTelegramTypingLease, pulse, + buildParams: (pulse) => ({ + to: "telegram:123", + intervalMs: 2_000, + pulse, + }), }); - - await expect(vi.advanceTimersByTimeAsync(2_000)).resolves.toBe(vi); - expect(pulse).toHaveBeenCalledTimes(2); - - lease.stop(); }); it("falls back to the default interval for non-finite values", async () => { diff --git a/src/plugins/runtime/typing-lease.test-support.ts b/src/plugins/runtime/typing-lease.test-support.ts new file mode 100644 index 00000000000..f32511d760d --- /dev/null +++ b/src/plugins/runtime/typing-lease.test-support.ts @@ -0,0 +1,47 @@ +import { expect, vi } from "vitest"; + +export async function expectIndependentTypingLeases< + TParams extends { intervalMs?: number; pulse: (...args: never[]) => Promise }, + TLease extends { refresh: () => Promise; stop: () => void }, +>(params: { + createLease: (params: TParams) => Promise; + buildParams: (pulse: TParams["pulse"]) => TParams; +}) { + vi.useFakeTimers(); + const pulse = vi.fn(async () => undefined) as TParams["pulse"]; + + const leaseA = await params.createLease(params.buildParams(pulse)); + const leaseB = await params.createLease(params.buildParams(pulse)); + + expect(pulse).toHaveBeenCalledTimes(2); + + await vi.advanceTimersByTimeAsync(2_000); + expect(pulse).toHaveBeenCalledTimes(4); + + leaseA.stop(); + await vi.advanceTimersByTimeAsync(2_000); + expect(pulse).toHaveBeenCalledTimes(5); + + await leaseB.refresh(); + expect(pulse).toHaveBeenCalledTimes(6); + + leaseB.stop(); +} + +export async function expectBackgroundTypingPulseFailuresAreSwallowed< + TParams extends { intervalMs?: number; pulse: (...args: never[]) => Promise }, + TLease extends { stop: () => void }, +>(params: { + createLease: (params: TParams) => Promise; + buildParams: (pulse: TParams["pulse"]) => TParams; + pulse: TParams["pulse"]; +}) { + vi.useFakeTimers(); + + const lease = await params.createLease(params.buildParams(params.pulse)); + + await expect(vi.advanceTimersByTimeAsync(2_000)).resolves.toBe(vi); + expect(params.pulse).toHaveBeenCalledTimes(2); + + lease.stop(); +} From e56e4923bd0837721ba871f89fb4e1ddd699f581 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:43:34 +0000 Subject: [PATCH 127/187] refactor(hook-tests): share subagent hook helpers --- extensions/discord/src/subagent-hooks.test.ts | 34 +++------ extensions/feishu/src/subagent-hooks.test.ts | 70 ++++++++----------- extensions/test-utils/subagent-hooks.ts | 25 +++++++ 3 files changed, 65 insertions(+), 64 deletions(-) create mode 100644 extensions/test-utils/subagent-hooks.ts diff --git a/extensions/discord/src/subagent-hooks.test.ts b/extensions/discord/src/subagent-hooks.test.ts index 9ba082144e6..6d22ea1ff54 100644 --- a/extensions/discord/src/subagent-hooks.test.ts +++ b/extensions/discord/src/subagent-hooks.test.ts @@ -1,5 +1,9 @@ import type { OpenClawPluginApi } from "openclaw/plugin-sdk/discord"; import { beforeEach, describe, expect, it, vi } from "vitest"; +import { + getRequiredHookHandler, + registerHookHandlersForTest, +} from "../../test-utils/subagent-hooks.js"; import { registerDiscordSubagentHooks } from "./subagent-hooks.js"; type ThreadBindingRecord = { @@ -55,26 +59,10 @@ function registerHandlersForTest( }, }, ) { - const handlers = new Map unknown>(); - const api = { + return registerHookHandlersForTest({ config, - on: (hookName: string, handler: (event: unknown, ctx: unknown) => unknown) => { - handlers.set(hookName, handler); - }, - } as unknown as OpenClawPluginApi; - registerDiscordSubagentHooks(api); - return handlers; -} - -function getRequiredHandler( - handlers: Map unknown>, - hookName: string, -): (event: unknown, ctx: unknown) => unknown { - const handler = handlers.get(hookName); - if (!handler) { - throw new Error(`expected ${hookName} hook handler`); - } - return handler; + register: registerDiscordSubagentHooks, + }); } function resolveSubagentDeliveryTargetForTest(requesterOrigin: { @@ -84,7 +72,7 @@ function resolveSubagentDeliveryTargetForTest(requesterOrigin: { threadId?: string; }) { const handlers = registerHandlersForTest(); - const handler = getRequiredHandler(handlers, "subagent_delivery_target"); + const handler = getRequiredHookHandler(handlers, "subagent_delivery_target"); return handler( { childSessionKey: "agent:main:subagent:child", @@ -158,7 +146,7 @@ async function runSubagentSpawning( event = createSpawnEventWithoutThread(), ) { const handlers = registerHandlersForTest(config); - const handler = getRequiredHandler(handlers, "subagent_spawning"); + const handler = getRequiredHookHandler(handlers, "subagent_spawning"); return await handler(event, {}); } @@ -202,7 +190,7 @@ describe("discord subagent hook handlers", () => { it("binds thread routing on subagent_spawning", async () => { const handlers = registerHandlersForTest(); - const handler = getRequiredHandler(handlers, "subagent_spawning"); + const handler = getRequiredHookHandler(handlers, "subagent_spawning"); const result = await handler(createSpawnEvent(), {}); @@ -320,7 +308,7 @@ describe("discord subagent hook handlers", () => { it("unbinds thread routing on subagent_ended", () => { const handlers = registerHandlersForTest(); - const handler = getRequiredHandler(handlers, "subagent_ended"); + const handler = getRequiredHookHandler(handlers, "subagent_ended"); handler( { diff --git a/extensions/feishu/src/subagent-hooks.test.ts b/extensions/feishu/src/subagent-hooks.test.ts index a86e8996f35..df2c276ad95 100644 --- a/extensions/feishu/src/subagent-hooks.test.ts +++ b/extensions/feishu/src/subagent-hooks.test.ts @@ -1,5 +1,9 @@ import type { OpenClawPluginApi } from "openclaw/plugin-sdk/feishu"; import { beforeEach, describe, expect, it, vi } from "vitest"; +import { + getRequiredHookHandler, + registerHookHandlersForTest, +} from "../../test-utils/subagent-hooks.js"; import { registerFeishuSubagentHooks } from "./subagent-hooks.js"; import { __testing as threadBindingTesting, @@ -12,26 +16,10 @@ const baseConfig = { }; function registerHandlersForTest(config: Record = baseConfig) { - const handlers = new Map unknown>(); - const api = { + return registerHookHandlersForTest({ config, - on: (hookName: string, handler: (event: unknown, ctx: unknown) => unknown) => { - handlers.set(hookName, handler); - }, - } as unknown as OpenClawPluginApi; - registerFeishuSubagentHooks(api); - return handlers; -} - -function getRequiredHandler( - handlers: Map unknown>, - hookName: string, -): (event: unknown, ctx: unknown) => unknown { - const handler = handlers.get(hookName); - if (!handler) { - throw new Error(`expected ${hookName} hook handler`); - } - return handler; + register: registerFeishuSubagentHooks, + }); } describe("feishu subagent hook handlers", () => { @@ -49,7 +37,7 @@ describe("feishu subagent hook handlers", () => { it("binds a Feishu DM conversation on subagent_spawning", async () => { const handlers = registerHandlersForTest(); - const handler = getRequiredHandler(handlers, "subagent_spawning"); + const handler = getRequiredHookHandler(handlers, "subagent_spawning"); createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); const result = await handler( @@ -70,7 +58,7 @@ describe("feishu subagent hook handlers", () => { expect(result).toEqual({ status: "ok", threadBindingReady: true }); - const deliveryTargetHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const deliveryTargetHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); expect( deliveryTargetHandler( { @@ -96,7 +84,7 @@ describe("feishu subagent hook handlers", () => { it("preserves the original Feishu DM delivery target", async () => { const handlers = registerHandlersForTest(); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); const manager = createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); manager.bindConversation({ @@ -134,8 +122,8 @@ describe("feishu subagent hook handlers", () => { it("binds a Feishu topic conversation and preserves parent context", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); const result = await spawnHandler( @@ -183,8 +171,8 @@ describe("feishu subagent hook handlers", () => { it("uses the requester session binding to preserve sender-scoped topic conversations", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); const manager = createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); manager.bindConversation({ @@ -252,8 +240,8 @@ describe("feishu subagent hook handlers", () => { it("prefers requester-matching bindings when multiple child bindings exist", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); await spawnHandler( @@ -312,8 +300,8 @@ describe("feishu subagent hook handlers", () => { it("fails closed when requester-session bindings remain ambiguous for the same topic", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); const manager = createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); manager.bindConversation({ @@ -375,8 +363,8 @@ describe("feishu subagent hook handlers", () => { it("fails closed when both topic-level and sender-scoped requester bindings exist", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); const manager = createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); manager.bindConversation({ @@ -438,9 +426,9 @@ describe("feishu subagent hook handlers", () => { it("no-ops for non-Feishu channels and non-threaded spawns", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); - const endedHandler = getRequiredHandler(handlers, "subagent_ended"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); + const endedHandler = getRequiredHookHandler(handlers, "subagent_ended"); await expect( spawnHandler( @@ -506,7 +494,7 @@ describe("feishu subagent hook handlers", () => { }); it("returns an error for unsupported non-topic Feishu group conversations", async () => { - const handler = getRequiredHandler(registerHandlersForTest(), "subagent_spawning"); + const handler = getRequiredHookHandler(registerHandlersForTest(), "subagent_spawning"); createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); await expect( @@ -532,9 +520,9 @@ describe("feishu subagent hook handlers", () => { it("unbinds Feishu bindings on subagent_ended", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); - const endedHandler = getRequiredHandler(handlers, "subagent_ended"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); + const endedHandler = getRequiredHookHandler(handlers, "subagent_ended"); createFeishuThreadBindingManager({ cfg: baseConfig as any, accountId: "work" }); await spawnHandler( @@ -581,8 +569,8 @@ describe("feishu subagent hook handlers", () => { it("fails closed when the Feishu monitor-owned binding manager is unavailable", async () => { const handlers = registerHandlersForTest(); - const spawnHandler = getRequiredHandler(handlers, "subagent_spawning"); - const deliveryHandler = getRequiredHandler(handlers, "subagent_delivery_target"); + const spawnHandler = getRequiredHookHandler(handlers, "subagent_spawning"); + const deliveryHandler = getRequiredHookHandler(handlers, "subagent_delivery_target"); await expect( spawnHandler( diff --git a/extensions/test-utils/subagent-hooks.ts b/extensions/test-utils/subagent-hooks.ts new file mode 100644 index 00000000000..2cd80fc5a35 --- /dev/null +++ b/extensions/test-utils/subagent-hooks.ts @@ -0,0 +1,25 @@ +export function registerHookHandlersForTest(params: { + config: Record; + register: (api: TApi) => void; +}) { + const handlers = new Map unknown>(); + const api = { + config: params.config, + on: (hookName: string, handler: (event: unknown, ctx: unknown) => unknown) => { + handlers.set(hookName, handler); + }, + } as TApi; + params.register(api); + return handlers; +} + +export function getRequiredHookHandler( + handlers: Map unknown>, + hookName: string, +): (event: unknown, ctx: unknown) => unknown { + const handler = handlers.get(hookName); + if (!handler) { + throw new Error(`expected ${hookName} hook handler`); + } + return handler; +} From 276803095d2dbe4db5e503153d731c5a9c4ddbea Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:50:33 +0000 Subject: [PATCH 128/187] refactor(provider-tests): share discovery catalog helpers --- .../contracts/discovery.contract.test.ts | 142 +++++++++--------- 1 file changed, 71 insertions(+), 71 deletions(-) diff --git a/src/plugins/contracts/discovery.contract.test.ts b/src/plugins/contracts/discovery.contract.test.ts index 0a334a619a1..c2ec44496bb 100644 --- a/src/plugins/contracts/discovery.contract.test.ts +++ b/src/plugins/contracts/discovery.contract.test.ts @@ -75,6 +75,64 @@ function createModelConfig(id: string, name = id): ModelDefinitionConfig { maxTokens: 8_192, }; } + +function requireQwenPortalProvider() { + return requireProvider(registerProviders(qwenPortalPlugin), "qwen-portal"); +} + +function requireGithubCopilotProvider() { + return requireProvider(registerProviders(githubCopilotPlugin), "github-copilot"); +} + +function setQwenPortalOauthSnapshot() { + replaceRuntimeAuthProfileStoreSnapshots([ + { + store: { + version: 1, + profiles: { + "qwen-portal:default": { + type: "oauth", + provider: "qwen-portal", + access: "access-token", + refresh: "refresh-token", + expires: Date.now() + 60_000, + }, + }, + }, + }, + ]); +} + +function setGithubCopilotProfileSnapshot() { + replaceRuntimeAuthProfileStoreSnapshots([ + { + store: { + version: 1, + profiles: { + "github-copilot:github": { + type: "token", + provider: "github-copilot", + token: "profile-token", + }, + }, + }, + }, + ]); +} + +function runCatalog(params: { + provider: Awaited>; + env?: NodeJS.ProcessEnv; + resolveProviderApiKey?: () => { apiKey: string | undefined }; +}) { + return runProviderCatalog({ + provider: params.provider, + config: {}, + env: params.env ?? ({} as NodeJS.ProcessEnv), + resolveProviderApiKey: params.resolveProviderApiKey ?? (() => ({ apiKey: undefined })), + }); +} + describe("provider discovery contract", () => { afterEach(() => { resolveCopilotApiTokenMock.mockReset(); @@ -85,30 +143,12 @@ describe("provider discovery contract", () => { }); it("keeps qwen portal oauth marker fallback provider-owned", async () => { - const provider = requireProvider(registerProviders(qwenPortalPlugin), "qwen-portal"); - replaceRuntimeAuthProfileStoreSnapshots([ - { - store: { - version: 1, - profiles: { - "qwen-portal:default": { - type: "oauth", - provider: "qwen-portal", - access: "access-token", - refresh: "refresh-token", - expires: Date.now() + 60_000, - }, - }, - }, - }, - ]); + const provider = requireQwenPortalProvider(); + setQwenPortalOauthSnapshot(); await expect( - runProviderCatalog({ + runCatalog({ provider, - config: {}, - env: {} as NodeJS.ProcessEnv, - resolveProviderApiKey: () => ({ apiKey: undefined }), }), ).resolves.toEqual({ provider: { @@ -124,28 +164,12 @@ describe("provider discovery contract", () => { }); it("keeps qwen portal env api keys higher priority than oauth markers", async () => { - const provider = requireProvider(registerProviders(qwenPortalPlugin), "qwen-portal"); - replaceRuntimeAuthProfileStoreSnapshots([ - { - store: { - version: 1, - profiles: { - "qwen-portal:default": { - type: "oauth", - provider: "qwen-portal", - access: "access-token", - refresh: "refresh-token", - expires: Date.now() + 60_000, - }, - }, - }, - }, - ]); + const provider = requireQwenPortalProvider(); + setQwenPortalOauthSnapshot(); await expect( - runProviderCatalog({ + runCatalog({ provider, - config: {}, env: { QWEN_PORTAL_API_KEY: "env-key" } as NodeJS.ProcessEnv, resolveProviderApiKey: () => ({ apiKey: "env-key" }), }), @@ -157,41 +181,18 @@ describe("provider discovery contract", () => { }); it("keeps GitHub Copilot catalog disabled without env tokens or profiles", async () => { - const provider = requireProvider(registerProviders(githubCopilotPlugin), "github-copilot"); + const provider = requireGithubCopilotProvider(); - await expect( - runProviderCatalog({ - provider, - config: {}, - env: {} as NodeJS.ProcessEnv, - resolveProviderApiKey: () => ({ apiKey: undefined }), - }), - ).resolves.toBeNull(); + await expect(runCatalog({ provider })).resolves.toBeNull(); }); it("keeps GitHub Copilot profile-only catalog fallback provider-owned", async () => { - const provider = requireProvider(registerProviders(githubCopilotPlugin), "github-copilot"); - replaceRuntimeAuthProfileStoreSnapshots([ - { - store: { - version: 1, - profiles: { - "github-copilot:github": { - type: "token", - provider: "github-copilot", - token: "profile-token", - }, - }, - }, - }, - ]); + const provider = requireGithubCopilotProvider(); + setGithubCopilotProfileSnapshot(); await expect( - runProviderCatalog({ + runCatalog({ provider, - config: {}, - env: {} as NodeJS.ProcessEnv, - resolveProviderApiKey: () => ({ apiKey: undefined }), }), ).resolves.toEqual({ provider: { @@ -202,7 +203,7 @@ describe("provider discovery contract", () => { }); it("keeps GitHub Copilot env-token base URL resolution provider-owned", async () => { - const provider = requireProvider(registerProviders(githubCopilotPlugin), "github-copilot"); + const provider = requireGithubCopilotProvider(); resolveCopilotApiTokenMock.mockResolvedValueOnce({ token: "copilot-api-token", baseUrl: "https://copilot-proxy.example.com", @@ -210,9 +211,8 @@ describe("provider discovery contract", () => { }); await expect( - runProviderCatalog({ + runCatalog({ provider, - config: {}, env: { GITHUB_TOKEN: "github-env-token", } as NodeJS.ProcessEnv, From d08d43fb1a6bdc9d5fa3954725e4f6a10303500a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:53:34 +0000 Subject: [PATCH 129/187] refactor(command-tests): share workspace harness --- .../reply/commands-filesystem.test-support.ts | 20 +++++++++++++++++ src/auto-reply/reply/commands-mcp.test.ts | 22 +++++-------------- src/auto-reply/reply/commands-plugins.test.ts | 20 +++++------------ 3 files changed, 32 insertions(+), 30 deletions(-) create mode 100644 src/auto-reply/reply/commands-filesystem.test-support.ts diff --git a/src/auto-reply/reply/commands-filesystem.test-support.ts b/src/auto-reply/reply/commands-filesystem.test-support.ts new file mode 100644 index 00000000000..c4b3c45b559 --- /dev/null +++ b/src/auto-reply/reply/commands-filesystem.test-support.ts @@ -0,0 +1,20 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; + +export function createCommandWorkspaceHarness(prefix: string) { + const tempDirs: string[] = []; + + return { + async createWorkspace(): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix)); + tempDirs.push(dir); + return dir; + }, + async cleanupWorkspaces() { + await Promise.all( + tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); + }, + }; +} diff --git a/src/auto-reply/reply/commands-mcp.test.ts b/src/auto-reply/reply/commands-mcp.test.ts index 24d7f15f34b..f70f167a80b 100644 --- a/src/auto-reply/reply/commands-mcp.test.ts +++ b/src/auto-reply/reply/commands-mcp.test.ts @@ -1,19 +1,11 @@ -import fs from "node:fs/promises"; -import os from "node:os"; -import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; import { withTempHome } from "../../config/home-env.test-harness.js"; import { handleCommands } from "./commands-core.js"; +import { createCommandWorkspaceHarness } from "./commands-filesystem.test-support.js"; import { buildCommandTestParams } from "./commands.test-harness.js"; -const tempDirs: string[] = []; - -async function createWorkspace(): Promise { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-command-mcp-")); - tempDirs.push(dir); - return dir; -} +const workspaceHarness = createCommandWorkspaceHarness("openclaw-command-mcp-"); function buildCfg(): OpenClawConfig { return { @@ -26,14 +18,12 @@ function buildCfg(): OpenClawConfig { describe("handleCommands /mcp", () => { afterEach(async () => { - await Promise.all( - tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), - ); + await workspaceHarness.cleanupWorkspaces(); }); it("writes MCP config and shows it back", async () => { await withTempHome("openclaw-command-mcp-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); const setParams = buildCommandTestParams( '/mcp set context7={"command":"uvx","args":["context7-mcp"]}', buildCfg(), @@ -57,7 +47,7 @@ describe("handleCommands /mcp", () => { it("rejects internal writes without operator.admin", async () => { await withTempHome("openclaw-command-mcp-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); const params = buildCommandTestParams( '/mcp set context7={"command":"uvx","args":["context7-mcp"]}', buildCfg(), @@ -77,7 +67,7 @@ describe("handleCommands /mcp", () => { it("accepts non-stdio MCP config at the config layer", async () => { await withTempHome("openclaw-command-mcp-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); const params = buildCommandTestParams( '/mcp set remote={"url":"https://example.com/mcp"}', buildCfg(), diff --git a/src/auto-reply/reply/commands-plugins.test.ts b/src/auto-reply/reply/commands-plugins.test.ts index 133a8021d3c..1aeb184e5b7 100644 --- a/src/auto-reply/reply/commands-plugins.test.ts +++ b/src/auto-reply/reply/commands-plugins.test.ts @@ -1,19 +1,13 @@ import fs from "node:fs/promises"; -import os from "node:os"; import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; import { withTempHome } from "../../config/home-env.test-harness.js"; import { handleCommands } from "./commands-core.js"; +import { createCommandWorkspaceHarness } from "./commands-filesystem.test-support.js"; import { buildCommandTestParams } from "./commands.test-harness.js"; -const tempDirs: string[] = []; - -async function createWorkspace(): Promise { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-command-plugins-")); - tempDirs.push(dir); - return dir; -} +const workspaceHarness = createCommandWorkspaceHarness("openclaw-command-plugins-"); async function createClaudeBundlePlugin(params: { workspaceDir: string; pluginId: string }) { const pluginDir = path.join(params.workspaceDir, ".openclaw", "extensions", params.pluginId); @@ -38,14 +32,12 @@ function buildCfg(): OpenClawConfig { describe("handleCommands /plugins", () => { afterEach(async () => { - await Promise.all( - tempDirs.splice(0).map((dir) => fs.rm(dir, { recursive: true, force: true })), - ); + await workspaceHarness.cleanupWorkspaces(); }); it("lists discovered plugins and shows plugin details", async () => { await withTempHome("openclaw-command-plugins-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); const listParams = buildCommandTestParams("/plugins list", buildCfg(), undefined, { @@ -69,7 +61,7 @@ describe("handleCommands /plugins", () => { it("enables and disables a discovered plugin", async () => { await withTempHome("openclaw-command-plugins-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); const enableParams = buildCommandTestParams( @@ -113,7 +105,7 @@ describe("handleCommands /plugins", () => { it("rejects internal writes without operator.admin", async () => { await withTempHome("openclaw-command-plugins-home-", async () => { - const workspaceDir = await createWorkspace(); + const workspaceDir = await workspaceHarness.createWorkspace(); await createClaudeBundlePlugin({ workspaceDir, pluginId: "superpowers" }); const params = buildCommandTestParams( From 88139c4271a7a90e4575ee7ac00f0491dd343570 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:58:02 +0000 Subject: [PATCH 130/187] refactor(contracts): share session binding assertions --- src/channels/plugins/contracts/registry.ts | 140 +++++++++++---------- 1 file changed, 71 insertions(+), 69 deletions(-) diff --git a/src/channels/plugins/contracts/registry.ts b/src/channels/plugins/contracts/registry.ts index 324ba095406..339651437d3 100644 --- a/src/channels/plugins/contracts/registry.ts +++ b/src/channels/plugins/contracts/registry.ts @@ -133,6 +133,47 @@ type SessionBindingContractEntry = { cleanup: () => Promise | void; }; +function expectResolvedSessionBinding(params: { + channel: string; + accountId: string; + conversationId: string; + targetSessionKey: string; +}) { + expect( + getSessionBindingService().resolveByConversation({ + channel: params.channel, + accountId: params.accountId, + conversationId: params.conversationId, + }), + )?.toMatchObject({ + targetSessionKey: params.targetSessionKey, + }); +} + +async function unbindAndExpectClearedSessionBinding(binding: SessionBindingRecord) { + const service = getSessionBindingService(); + const removed = await service.unbind({ + bindingId: binding.bindingId, + reason: "contract-test", + }); + expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); + expect(service.resolveByConversation(binding.conversation)).toBeNull(); +} + +function expectClearedSessionBinding(params: { + channel: string; + accountId: string; + conversationId: string; +}) { + expect( + getSessionBindingService().resolveByConversation({ + channel: params.channel, + accountId: params.accountId, + conversationId: params.conversationId, + }), + ).toBeNull(); +} + const telegramListActionsMock = vi.fn(); const telegramGetCapabilitiesMock = vi.fn(); const discordListActionsMock = vi.fn(); @@ -617,26 +658,15 @@ export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ label: "codex-discord", }, }); - expect( - service.resolveByConversation({ - channel: "discord", - accountId: "default", - conversationId: "channel:123456789012345678", - }), - )?.toMatchObject({ + expectResolvedSessionBinding({ + channel: "discord", + accountId: "default", + conversationId: "channel:123456789012345678", targetSessionKey: "agent:discord:child:thread-1", }); return binding; }, - unbindAndVerify: async (binding) => { - const service = getSessionBindingService(); - const removed = await service.unbind({ - bindingId: binding.bindingId, - reason: "contract-test", - }); - expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); - expect(service.resolveByConversation(binding.conversation)).toBeNull(); - }, + unbindAndVerify: unbindAndExpectClearedSessionBinding, cleanup: async () => { const manager = createDiscordThreadBindingManager({ accountId: "default", @@ -645,13 +675,11 @@ export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ }); manager.stop(); discordThreadBindingTesting.resetThreadBindingsForTests(); - expect( - getSessionBindingService().resolveByConversation({ - channel: "discord", - accountId: "default", - conversationId: "channel:123456789012345678", - }), - ).toBeNull(); + expectClearedSessionBinding({ + channel: "discord", + accountId: "default", + conversationId: "channel:123456789012345678", + }); }, }, { @@ -687,39 +715,26 @@ export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ label: "codex-main", }, }); - expect( - service.resolveByConversation({ - channel: "feishu", - accountId: "default", - conversationId: "oc_group_chat:topic:om_topic_root", - }), - )?.toMatchObject({ + expectResolvedSessionBinding({ + channel: "feishu", + accountId: "default", + conversationId: "oc_group_chat:topic:om_topic_root", targetSessionKey: "agent:codex:acp:binding:feishu:default:abc123", }); return binding; }, - unbindAndVerify: async (binding) => { - const service = getSessionBindingService(); - const removed = await service.unbind({ - bindingId: binding.bindingId, - reason: "contract-test", - }); - expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); - expect(service.resolveByConversation(binding.conversation)).toBeNull(); - }, + unbindAndVerify: unbindAndExpectClearedSessionBinding, cleanup: async () => { const manager = createFeishuThreadBindingManager({ cfg: baseSessionBindingCfg, accountId: "default", }); manager.stop(); - expect( - getSessionBindingService().resolveByConversation({ - channel: "feishu", - accountId: "default", - conversationId: "oc_group_chat:topic:om_topic_root", - }), - ).toBeNull(); + expectClearedSessionBinding({ + channel: "feishu", + accountId: "default", + conversationId: "oc_group_chat:topic:om_topic_root", + }); }, }, { @@ -761,26 +776,15 @@ export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ boundBy: "user-1", }, }); - expect( - service.resolveByConversation({ - channel: "telegram", - accountId: "default", - conversationId: "-100200300:topic:77", - }), - )?.toMatchObject({ + expectResolvedSessionBinding({ + channel: "telegram", + accountId: "default", + conversationId: "-100200300:topic:77", targetSessionKey: "agent:main:subagent:child-1", }); return binding; }, - unbindAndVerify: async (binding) => { - const service = getSessionBindingService(); - const removed = await service.unbind({ - bindingId: binding.bindingId, - reason: "contract-test", - }); - expect(removed.map((entry) => entry.bindingId)).toContain(binding.bindingId); - expect(service.resolveByConversation(binding.conversation)).toBeNull(); - }, + unbindAndVerify: unbindAndExpectClearedSessionBinding, cleanup: async () => { const manager = createTelegramThreadBindingManager({ accountId: "default", @@ -788,13 +792,11 @@ export const sessionBindingContractRegistry: SessionBindingContractEntry[] = [ enableSweeper: false, }); manager.stop(); - expect( - getSessionBindingService().resolveByConversation({ - channel: "telegram", - accountId: "default", - conversationId: "-100200300:topic:77", - }), - ).toBeNull(); + expectClearedSessionBinding({ + channel: "telegram", + accountId: "default", + conversationId: "-100200300:topic:77", + }); }, }, ]; From c08d556ae41bfceec87d298fba8385aff501dbf4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:58:58 +0000 Subject: [PATCH 131/187] refactor(plugin-tests): share interactive dispatch assertions --- src/plugins/interactive.test.ts | 62 +++++++++++++++++---------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/src/plugins/interactive.test.ts b/src/plugins/interactive.test.ts index 14980ec4545..51be58f393f 100644 --- a/src/plugins/interactive.test.ts +++ b/src/plugins/interactive.test.ts @@ -16,6 +16,20 @@ let getCurrentPluginConversationBindingMock: MockInstance< typeof conversationBinding.getCurrentPluginConversationBinding >; +async function expectDedupedInteractiveDispatch(params: { + baseParams: Parameters[0]; + handler: ReturnType; + expectedCall: unknown; +}) { + const first = await dispatchPluginInteractiveHandler(params.baseParams); + const duplicate = await dispatchPluginInteractiveHandler(params.baseParams); + + expect(first).toEqual({ matched: true, handled: true, duplicate: false }); + expect(duplicate).toEqual({ matched: true, handled: true, duplicate: true }); + expect(params.handler).toHaveBeenCalledTimes(1); + expect(params.handler).toHaveBeenCalledWith(expect.objectContaining(params.expectedCall)); +} + describe("plugin interactive handlers", () => { beforeEach(() => { clearPluginInteractiveHandlers(); @@ -99,14 +113,10 @@ describe("plugin interactive handlers", () => { }, }; - const first = await dispatchPluginInteractiveHandler(baseParams); - const duplicate = await dispatchPluginInteractiveHandler(baseParams); - - expect(first).toEqual({ matched: true, handled: true, duplicate: false }); - expect(duplicate).toEqual({ matched: true, handled: true, duplicate: true }); - expect(handler).toHaveBeenCalledTimes(1); - expect(handler).toHaveBeenCalledWith( - expect.objectContaining({ + await expectDedupedInteractiveDispatch({ + baseParams, + handler, + expectedCall: { channel: "telegram", conversationId: "-10099:topic:77", callback: expect.objectContaining({ @@ -115,8 +125,8 @@ describe("plugin interactive handlers", () => { chatId: "-10099", messageId: 55, }), - }), - ); + }, + }); }); it("rejects duplicate namespace registrations", () => { @@ -176,14 +186,10 @@ describe("plugin interactive handlers", () => { }, }; - const first = await dispatchPluginInteractiveHandler(baseParams); - const duplicate = await dispatchPluginInteractiveHandler(baseParams); - - expect(first).toEqual({ matched: true, handled: true, duplicate: false }); - expect(duplicate).toEqual({ matched: true, handled: true, duplicate: true }); - expect(handler).toHaveBeenCalledTimes(1); - expect(handler).toHaveBeenCalledWith( - expect.objectContaining({ + await expectDedupedInteractiveDispatch({ + baseParams, + handler, + expectedCall: { channel: "discord", conversationId: "channel-1", interaction: expect.objectContaining({ @@ -192,8 +198,8 @@ describe("plugin interactive handlers", () => { messageId: "message-1", values: ["allow"], }), - }), - ); + }, + }); }); it("routes Slack interactions by namespace and dedupes interaction ids", async () => { @@ -241,14 +247,10 @@ describe("plugin interactive handlers", () => { }, }; - const first = await dispatchPluginInteractiveHandler(baseParams); - const duplicate = await dispatchPluginInteractiveHandler(baseParams); - - expect(first).toEqual({ matched: true, handled: true, duplicate: false }); - expect(duplicate).toEqual({ matched: true, handled: true, duplicate: true }); - expect(handler).toHaveBeenCalledTimes(1); - expect(handler).toHaveBeenCalledWith( - expect.objectContaining({ + await expectDedupedInteractiveDispatch({ + baseParams, + handler, + expectedCall: { channel: "slack", conversationId: "C123", threadId: "1710000000.000100", @@ -258,8 +260,8 @@ describe("plugin interactive handlers", () => { actionId: "codex", messageTs: "1710000000.000200", }), - }), - ); + }, + }); }); it("wires Telegram conversation binding helpers with topic context", async () => { From 282e336243893cba0cb3b3cded9ee5ece83104c3 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 06:59:57 +0000 Subject: [PATCH 132/187] refactor(plugin-tests): share binding approval resolution --- src/plugins/conversation-binding.test.ts | 62 +++++++++--------------- 1 file changed, 24 insertions(+), 38 deletions(-) diff --git a/src/plugins/conversation-binding.test.ts b/src/plugins/conversation-binding.test.ts index 0a673572d59..20b0df72337 100644 --- a/src/plugins/conversation-binding.test.ts +++ b/src/plugins/conversation-binding.test.ts @@ -102,6 +102,8 @@ const { const { registerSessionBindingAdapter, unregisterSessionBindingAdapter } = await import("../infra/outbound/session-binding-service.js"); +type PluginBindingRequest = Awaited>; + function createAdapter(channel: string, accountId: string): SessionBindingAdapter { return { channel, @@ -119,6 +121,26 @@ function createAdapter(channel: string, accountId: string): SessionBindingAdapte }; } +async function resolveRequestedBinding(request: PluginBindingRequest) { + expect(["pending", "bound"]).toContain(request.status); + if (request.status === "pending") { + const approved = await resolvePluginConversationBindingApproval({ + approvalId: request.approvalId, + decision: "allow-once", + senderId: "user-1", + }); + expect(approved.status).toBe("approved"); + if (approved.status !== "approved") { + throw new Error("expected approved bind result"); + } + return approved.binding; + } + if (request.status === "bound") { + return request.binding; + } + throw new Error("expected pending or bound bind result"); +} + describe("plugin conversation binding approvals", () => { beforeEach(() => { sessionBindingState.reset(); @@ -485,25 +507,7 @@ describe("plugin conversation binding approvals", () => { binding: { summary: "Bind this conversation to Codex thread abc." }, }); - expect(["pending", "bound"]).toContain(request.status); - const binding = - request.status === "pending" - ? await resolvePluginConversationBindingApproval({ - approvalId: request.approvalId, - decision: "allow-once", - senderId: "user-1", - }).then((approved) => { - expect(approved.status).toBe("approved"); - if (approved.status !== "approved") { - throw new Error("expected approved bind result"); - } - return approved.binding; - }) - : request.status === "bound" - ? request.binding - : (() => { - throw new Error("expected pending or bound bind result"); - })(); + const binding = await resolveRequestedBinding(request); expect(binding).toEqual( expect.objectContaining({ @@ -546,25 +550,7 @@ describe("plugin conversation binding approvals", () => { }, }); - expect(["pending", "bound"]).toContain(request.status); - const binding = - request.status === "pending" - ? await resolvePluginConversationBindingApproval({ - approvalId: request.approvalId, - decision: "allow-once", - senderId: "user-1", - }).then((approved) => { - expect(approved.status).toBe("approved"); - if (approved.status !== "approved") { - throw new Error("expected approved bind result"); - } - return approved.binding; - }) - : request.status === "bound" - ? request.binding - : (() => { - throw new Error("expected pending or bound bind result"); - })(); + const binding = await resolveRequestedBinding(request); expect(binding).toEqual( expect.objectContaining({ From e5c03ebea750fc7611ad697a03b5c28ec8c054f2 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:01:52 +0000 Subject: [PATCH 133/187] refactor(usage-tests): share provider usage loader harness --- src/infra/provider-usage.load.test.ts | 27 +++++++++--------------- src/infra/provider-usage.test-support.ts | 25 ++++++++++++++++++++++ src/infra/provider-usage.test.ts | 24 +++++++-------------- 3 files changed, 43 insertions(+), 33 deletions(-) create mode 100644 src/infra/provider-usage.test-support.ts diff --git a/src/infra/provider-usage.load.test.ts b/src/infra/provider-usage.load.test.ts index 1a91b87a56b..c388b5702e6 100644 --- a/src/infra/provider-usage.load.test.ts +++ b/src/infra/provider-usage.load.test.ts @@ -2,23 +2,13 @@ import { describe, expect, it, vi } from "vitest"; import { createProviderUsageFetch, makeResponse } from "../test-utils/provider-usage-fetch.js"; import { loadProviderUsageSummary } from "./provider-usage.load.js"; import { ignoredErrors } from "./provider-usage.shared.js"; +import { + loadUsageWithAuth, + type ProviderUsageAuth, + usageNow, +} from "./provider-usage.test-support.js"; -const usageNow = Date.UTC(2026, 0, 7, 0, 0, 0); - -type ProviderAuth = NonNullable< - NonNullable[0]>["auth"] ->[number]; - -async function loadUsageWithAuth( - auth: ProviderAuth[], - mockFetch: ReturnType, -) { - return await loadProviderUsageSummary({ - now: usageNow, - auth, - fetch: mockFetch as unknown as typeof fetch, - }); -} +type ProviderAuth = ProviderUsageAuth; describe("provider-usage.load", () => { it("loads snapshots for copilot gemini codex and xiaomi", async () => { @@ -53,6 +43,7 @@ describe("provider-usage.load", () => { }); const summary = await loadUsageWithAuth( + loadProviderUsageSummary, [ { provider: "github-copilot", token: "copilot-token" }, { provider: "google-gemini-cli", token: "gemini-token" }, @@ -85,13 +76,14 @@ describe("provider-usage.load", () => { it("returns empty provider list when auth resolves to none", async () => { const mockFetch = createProviderUsageFetch(async () => makeResponse(404, "not found")); - const summary = await loadUsageWithAuth([], mockFetch); + const summary = await loadUsageWithAuth(loadProviderUsageSummary, [], mockFetch); expect(summary).toEqual({ updatedAt: usageNow, providers: [] }); }); it("returns unsupported provider snapshots for unknown provider ids", async () => { const mockFetch = createProviderUsageFetch(async () => makeResponse(404, "not found")); const summary = await loadUsageWithAuth( + loadProviderUsageSummary, [{ provider: "unsupported-provider", token: "token-u" }] as unknown as ProviderAuth[], mockFetch, ); @@ -109,6 +101,7 @@ describe("provider-usage.load", () => { ignoredErrors.add("HTTP 500"); try { const summary = await loadUsageWithAuth( + loadProviderUsageSummary, [{ provider: "anthropic", token: "token-a" }], mockFetch, ); diff --git a/src/infra/provider-usage.test-support.ts b/src/infra/provider-usage.test-support.ts new file mode 100644 index 00000000000..d14aecb2dbd --- /dev/null +++ b/src/infra/provider-usage.test-support.ts @@ -0,0 +1,25 @@ +import { createProviderUsageFetch } from "../test-utils/provider-usage-fetch.js"; + +export const usageNow = Date.UTC(2026, 0, 7, 0, 0, 0); + +type ProviderUsageLoader = (params: { + now: number; + auth: Array<{ provider: string; token?: string; accountId?: string }>; + fetch?: typeof fetch; +}) => Promise; + +export type ProviderUsageAuth = NonNullable< + NonNullable[0]>["auth"] +>[number]; + +export async function loadUsageWithAuth( + loadProviderUsageSummary: T, + auth: ProviderUsageAuth[], + mockFetch: ReturnType, +) { + return await loadProviderUsageSummary({ + now: usageNow, + auth, + fetch: mockFetch as unknown as typeof fetch, + }); +} diff --git a/src/infra/provider-usage.test.ts b/src/infra/provider-usage.test.ts index 2e45a2ee9dc..fdd2326a9a0 100644 --- a/src/infra/provider-usage.test.ts +++ b/src/infra/provider-usage.test.ts @@ -11,23 +11,9 @@ import { loadProviderUsageSummary, type UsageSummary, } from "./provider-usage.js"; +import { loadUsageWithAuth, usageNow } from "./provider-usage.test-support.js"; const minimaxRemainsEndpoint = "api.minimaxi.com/v1/api/openplatform/coding_plan/remains"; -const usageNow = Date.UTC(2026, 0, 7, 0, 0, 0); -type ProviderAuth = NonNullable< - NonNullable[0]>["auth"] ->[number]; - -async function loadUsageWithAuth( - auth: ProviderAuth[], - mockFetch: ReturnType, -) { - return await loadProviderUsageSummary({ - now: usageNow, - auth, - fetch: mockFetch as unknown as typeof fetch, - }); -} function expectSingleAnthropicProvider(summary: UsageSummary) { expect(summary.providers).toHaveLength(1); @@ -55,7 +41,11 @@ async function expectMinimaxUsage( ) { const mockFetch = createMinimaxOnlyFetch(payload); - const summary = await loadUsageWithAuth([{ provider: "minimax", token: "token-1b" }], mockFetch); + const summary = await loadUsageWithAuth( + loadProviderUsageSummary, + [{ provider: "minimax", token: "token-1b" }], + mockFetch, + ); const minimax = summary.providers.find((p) => p.provider === "minimax"); expect(minimax?.windows[0]?.usedPercent).toBe(expected.usedPercent); @@ -166,6 +156,7 @@ describe("provider usage loading", () => { }); const summary = await loadUsageWithAuth( + loadProviderUsageSummary, [ { provider: "anthropic", token: "token-1" }, { provider: "minimax", token: "token-1b" }, @@ -344,6 +335,7 @@ describe("provider usage loading", () => { }); const summary = await loadUsageWithAuth( + loadProviderUsageSummary, [{ provider: "anthropic", token: "sk-ant-oauth-1" }], mockFetch, ); From 201964ce6c770fc27e8f91a3f00e1a7ed0a4f6c4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:03:38 +0000 Subject: [PATCH 134/187] refactor(bundle-tests): share bundle mcp fixtures --- src/agents/cli-runner/bundle-mcp.test.ts | 51 ++++----------------- src/plugins/bundle-mcp.test-support.ts | 54 ++++++++++++++++++++++ src/plugins/bundle-mcp.test.ts | 57 +++++------------------- 3 files changed, 75 insertions(+), 87 deletions(-) create mode 100644 src/plugins/bundle-mcp.test-support.ts diff --git a/src/agents/cli-runner/bundle-mcp.test.ts b/src/agents/cli-runner/bundle-mcp.test.ts index ec345f960a2..fae294ab951 100644 --- a/src/agents/cli-runner/bundle-mcp.test.ts +++ b/src/agents/cli-runner/bundle-mcp.test.ts @@ -1,61 +1,28 @@ import fs from "node:fs/promises"; -import os from "node:os"; -import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; -import { clearPluginManifestRegistryCache } from "../../plugins/manifest-registry.js"; +import { + createBundleMcpTempHarness, + createBundleProbePlugin, +} from "../../plugins/bundle-mcp.test-support.js"; import { captureEnv } from "../../test-utils/env.js"; import { prepareCliBundleMcpConfig } from "./bundle-mcp.js"; -const tempDirs: string[] = []; - -async function createTempDir(prefix: string): Promise { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix)); - tempDirs.push(dir); - return dir; -} +const tempHarness = createBundleMcpTempHarness(); afterEach(async () => { - clearPluginManifestRegistryCache(); - await Promise.all( - tempDirs.splice(0, tempDirs.length).map((dir) => fs.rm(dir, { recursive: true, force: true })), - ); + await tempHarness.cleanup(); }); describe("prepareCliBundleMcpConfig", () => { it("injects a merged --mcp-config overlay for claude-cli", async () => { const env = captureEnv(["HOME"]); try { - const homeDir = await createTempDir("openclaw-cli-bundle-mcp-home-"); - const workspaceDir = await createTempDir("openclaw-cli-bundle-mcp-workspace-"); + const homeDir = await tempHarness.createTempDir("openclaw-cli-bundle-mcp-home-"); + const workspaceDir = await tempHarness.createTempDir("openclaw-cli-bundle-mcp-workspace-"); process.env.HOME = homeDir; - const pluginRoot = path.join(homeDir, ".openclaw", "extensions", "bundle-probe"); - const serverPath = path.join(pluginRoot, "servers", "probe.mjs"); - await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.mkdir(path.dirname(serverPath), { recursive: true }); - await fs.writeFile(serverPath, "export {};\n", "utf-8"); - await fs.writeFile( - path.join(pluginRoot, ".claude-plugin", "plugin.json"), - `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, - "utf-8", - ); - await fs.writeFile( - path.join(pluginRoot, ".mcp.json"), - `${JSON.stringify( - { - mcpServers: { - bundleProbe: { - command: "node", - args: ["./servers/probe.mjs"], - }, - }, - }, - null, - 2, - )}\n`, - "utf-8", - ); + const { serverPath } = await createBundleProbePlugin(homeDir); const config: OpenClawConfig = { plugins: { diff --git a/src/plugins/bundle-mcp.test-support.ts b/src/plugins/bundle-mcp.test-support.ts new file mode 100644 index 00000000000..8b6723e7e13 --- /dev/null +++ b/src/plugins/bundle-mcp.test-support.ts @@ -0,0 +1,54 @@ +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import { clearPluginManifestRegistryCache } from "./manifest-registry.js"; + +export function createBundleMcpTempHarness() { + const tempDirs: string[] = []; + + return { + async createTempDir(prefix: string): Promise { + const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix)); + tempDirs.push(dir); + return dir; + }, + async cleanup() { + clearPluginManifestRegistryCache(); + await Promise.all( + tempDirs + .splice(0, tempDirs.length) + .map((dir) => fs.rm(dir, { recursive: true, force: true })), + ); + }, + }; +} + +export async function createBundleProbePlugin(homeDir: string) { + const pluginRoot = path.join(homeDir, ".openclaw", "extensions", "bundle-probe"); + const serverPath = path.join(pluginRoot, "servers", "probe.mjs"); + await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); + await fs.mkdir(path.dirname(serverPath), { recursive: true }); + await fs.writeFile(serverPath, "export {};\n", "utf-8"); + await fs.writeFile( + path.join(pluginRoot, ".claude-plugin", "plugin.json"), + `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, + "utf-8", + ); + await fs.writeFile( + path.join(pluginRoot, ".mcp.json"), + `${JSON.stringify( + { + mcpServers: { + bundleProbe: { + command: "node", + args: ["./servers/probe.mjs"], + }, + }, + }, + null, + 2, + )}\n`, + "utf-8", + ); + return { pluginRoot, serverPath }; +} diff --git a/src/plugins/bundle-mcp.test.ts b/src/plugins/bundle-mcp.test.ts index ce4c460baf0..b9d5ca18cf3 100644 --- a/src/plugins/bundle-mcp.test.ts +++ b/src/plugins/bundle-mcp.test.ts @@ -1,69 +1,34 @@ import fs from "node:fs/promises"; -import os from "node:os"; import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import { captureEnv } from "../test-utils/env.js"; import { isRecord } from "../utils.js"; import { loadEnabledBundleMcpConfig } from "./bundle-mcp.js"; -import { clearPluginManifestRegistryCache } from "./manifest-registry.js"; - -const tempDirs: string[] = []; +import { createBundleMcpTempHarness, createBundleProbePlugin } from "./bundle-mcp.test-support.js"; function getServerArgs(value: unknown): unknown[] | undefined { return isRecord(value) && Array.isArray(value.args) ? value.args : undefined; } -async function createTempDir(prefix: string): Promise { - const dir = await fs.mkdtemp(path.join(os.tmpdir(), prefix)); - tempDirs.push(dir); - return dir; -} +const tempHarness = createBundleMcpTempHarness(); afterEach(async () => { - clearPluginManifestRegistryCache(); - await Promise.all( - tempDirs.splice(0, tempDirs.length).map((dir) => fs.rm(dir, { recursive: true, force: true })), - ); + await tempHarness.cleanup(); }); describe("loadEnabledBundleMcpConfig", () => { it("loads enabled Claude bundle MCP config and absolutizes relative args", async () => { const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); try { - const homeDir = await createTempDir("openclaw-bundle-mcp-home-"); - const workspaceDir = await createTempDir("openclaw-bundle-mcp-workspace-"); + const homeDir = await tempHarness.createTempDir("openclaw-bundle-mcp-home-"); + const workspaceDir = await tempHarness.createTempDir("openclaw-bundle-mcp-workspace-"); process.env.HOME = homeDir; process.env.USERPROFILE = homeDir; delete process.env.OPENCLAW_HOME; delete process.env.OPENCLAW_STATE_DIR; - const pluginRoot = path.join(homeDir, ".openclaw", "extensions", "bundle-probe"); - const serverPath = path.join(pluginRoot, "servers", "probe.mjs"); - await fs.mkdir(path.join(pluginRoot, ".claude-plugin"), { recursive: true }); - await fs.mkdir(path.dirname(serverPath), { recursive: true }); - await fs.writeFile(serverPath, "export {};\n", "utf-8"); - await fs.writeFile( - path.join(pluginRoot, ".claude-plugin", "plugin.json"), - `${JSON.stringify({ name: "bundle-probe" }, null, 2)}\n`, - "utf-8", - ); - await fs.writeFile( - path.join(pluginRoot, ".mcp.json"), - `${JSON.stringify( - { - mcpServers: { - bundleProbe: { - command: "node", - args: ["./servers/probe.mjs"], - }, - }, - }, - null, - 2, - )}\n`, - "utf-8", - ); + const { pluginRoot, serverPath } = await createBundleProbePlugin(homeDir); const config: OpenClawConfig = { plugins: { @@ -100,8 +65,8 @@ describe("loadEnabledBundleMcpConfig", () => { it("merges inline bundle MCP servers and skips disabled bundles", async () => { const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); try { - const homeDir = await createTempDir("openclaw-bundle-inline-home-"); - const workspaceDir = await createTempDir("openclaw-bundle-inline-workspace-"); + const homeDir = await tempHarness.createTempDir("openclaw-bundle-inline-home-"); + const workspaceDir = await tempHarness.createTempDir("openclaw-bundle-inline-workspace-"); process.env.HOME = homeDir; process.env.USERPROFILE = homeDir; delete process.env.OPENCLAW_HOME; @@ -170,8 +135,10 @@ describe("loadEnabledBundleMcpConfig", () => { it("resolves inline Claude MCP paths from the plugin root and expands CLAUDE_PLUGIN_ROOT", async () => { const env = captureEnv(["HOME", "USERPROFILE", "OPENCLAW_HOME", "OPENCLAW_STATE_DIR"]); try { - const homeDir = await createTempDir("openclaw-bundle-inline-placeholder-home-"); - const workspaceDir = await createTempDir("openclaw-bundle-inline-placeholder-workspace-"); + const homeDir = await tempHarness.createTempDir("openclaw-bundle-inline-placeholder-home-"); + const workspaceDir = await tempHarness.createTempDir( + "openclaw-bundle-inline-placeholder-workspace-", + ); process.env.HOME = homeDir; process.env.USERPROFILE = homeDir; delete process.env.OPENCLAW_HOME; From 5747700b3cd11239349d0fecd732b205a77f3563 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:06:30 +0000 Subject: [PATCH 135/187] refactor(provider-tests): share codex catalog assertions --- .../contracts/catalog.contract.test.ts | 56 ++---------- src/plugins/provider-runtime.test-support.ts | 87 +++++++++++++++++++ src/plugins/provider-runtime.test.ts | 56 ++---------- 3 files changed, 104 insertions(+), 95 deletions(-) create mode 100644 src/plugins/provider-runtime.test-support.ts diff --git a/src/plugins/contracts/catalog.contract.test.ts b/src/plugins/contracts/catalog.contract.test.ts index dcfe0c86f6a..4339b6edec4 100644 --- a/src/plugins/contracts/catalog.contract.test.ts +++ b/src/plugins/contracts/catalog.contract.test.ts @@ -1,4 +1,9 @@ -import { beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, it, vi } from "vitest"; +import { + expectAugmentedCodexCatalog, + expectCodexBuiltInSuppression, + expectCodexMissingAuthHint, +} from "../provider-runtime.test-support.js"; import { providerContractPluginIds, resolveProviderContractProvidersForPluginIds, @@ -45,57 +50,14 @@ describe("provider catalog contract", () => { }); it("keeps codex-only missing-auth hints wired through the provider runtime", () => { - expect( - buildProviderMissingAuthMessageWithPlugin({ - provider: "openai", - env: process.env, - context: { - env: process.env, - provider: "openai", - listProfileIds: (providerId) => (providerId === "openai-codex" ? ["p1"] : []), - }, - }), - ).toContain("openai-codex/gpt-5.4"); + expectCodexMissingAuthHint(buildProviderMissingAuthMessageWithPlugin); }); it("keeps built-in model suppression wired through the provider runtime", () => { - expect( - resolveProviderBuiltInModelSuppression({ - env: process.env, - context: { - env: process.env, - provider: "azure-openai-responses", - modelId: "gpt-5.3-codex-spark", - }, - }), - ).toMatchObject({ - suppress: true, - errorMessage: expect.stringContaining("openai-codex/gpt-5.3-codex-spark"), - }); + expectCodexBuiltInSuppression(resolveProviderBuiltInModelSuppression); }); it("keeps bundled model augmentation wired through the provider runtime", async () => { - await expect( - augmentModelCatalogWithProviderPlugins({ - env: process.env, - context: { - env: process.env, - entries: [ - { provider: "openai", id: "gpt-5.2", name: "GPT-5.2" }, - { provider: "openai", id: "gpt-5.2-pro", name: "GPT-5.2 Pro" }, - { provider: "openai-codex", id: "gpt-5.3-codex", name: "GPT-5.3 Codex" }, - ], - }, - }), - ).resolves.toEqual([ - { provider: "openai", id: "gpt-5.4", name: "gpt-5.4" }, - { provider: "openai", id: "gpt-5.4-pro", name: "gpt-5.4-pro" }, - { provider: "openai-codex", id: "gpt-5.4", name: "gpt-5.4" }, - { - provider: "openai-codex", - id: "gpt-5.3-codex-spark", - name: "gpt-5.3-codex-spark", - }, - ]); + await expectAugmentedCodexCatalog(augmentModelCatalogWithProviderPlugins); }); }); diff --git a/src/plugins/provider-runtime.test-support.ts b/src/plugins/provider-runtime.test-support.ts new file mode 100644 index 00000000000..818ad364cbd --- /dev/null +++ b/src/plugins/provider-runtime.test-support.ts @@ -0,0 +1,87 @@ +import { expect } from "vitest"; + +export const openaiCodexCatalogEntries = [ + { provider: "openai", id: "gpt-5.2", name: "GPT-5.2" }, + { provider: "openai", id: "gpt-5.2-pro", name: "GPT-5.2 Pro" }, + { provider: "openai-codex", id: "gpt-5.3-codex", name: "GPT-5.3 Codex" }, +]; + +export const expectedAugmentedOpenaiCodexCatalogEntries = [ + { provider: "openai", id: "gpt-5.4", name: "gpt-5.4" }, + { provider: "openai", id: "gpt-5.4-pro", name: "gpt-5.4-pro" }, + { provider: "openai-codex", id: "gpt-5.4", name: "gpt-5.4" }, + { + provider: "openai-codex", + id: "gpt-5.3-codex-spark", + name: "gpt-5.3-codex-spark", + }, +]; + +export function expectCodexMissingAuthHint( + buildProviderMissingAuthMessageWithPlugin: (params: { + provider: string; + env: NodeJS.ProcessEnv; + context: { + env: NodeJS.ProcessEnv; + provider: string; + listProfileIds: (providerId: string) => string[]; + }; + }) => string | undefined, +) { + expect( + buildProviderMissingAuthMessageWithPlugin({ + provider: "openai", + env: process.env, + context: { + env: process.env, + provider: "openai", + listProfileIds: (providerId) => (providerId === "openai-codex" ? ["p1"] : []), + }, + }), + ).toContain("openai-codex/gpt-5.4"); +} + +export function expectCodexBuiltInSuppression( + resolveProviderBuiltInModelSuppression: (params: { + env: NodeJS.ProcessEnv; + context: { + env: NodeJS.ProcessEnv; + provider: string; + modelId: string; + }; + }) => unknown, +) { + expect( + resolveProviderBuiltInModelSuppression({ + env: process.env, + context: { + env: process.env, + provider: "azure-openai-responses", + modelId: "gpt-5.3-codex-spark", + }, + }), + ).toMatchObject({ + suppress: true, + errorMessage: expect.stringContaining("openai-codex/gpt-5.3-codex-spark"), + }); +} + +export async function expectAugmentedCodexCatalog( + augmentModelCatalogWithProviderPlugins: (params: { + env: NodeJS.ProcessEnv; + context: { + env: NodeJS.ProcessEnv; + entries: typeof openaiCodexCatalogEntries; + }; + }) => Promise, +) { + await expect( + augmentModelCatalogWithProviderPlugins({ + env: process.env, + context: { + env: process.env, + entries: openaiCodexCatalogEntries, + }, + }), + ).resolves.toEqual(expectedAugmentedOpenaiCodexCatalogEntries); +} diff --git a/src/plugins/provider-runtime.test.ts b/src/plugins/provider-runtime.test.ts index c6cb64db8eb..d0e57c9216b 100644 --- a/src/plugins/provider-runtime.test.ts +++ b/src/plugins/provider-runtime.test.ts @@ -1,4 +1,9 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; +import { + expectAugmentedCodexCatalog, + expectCodexBuiltInSuppression, + expectCodexMissingAuthHint, +} from "./provider-runtime.test-support.js"; import type { ProviderPlugin, ProviderRuntimeModel } from "./types.js"; type ResolvePluginProviders = typeof import("./providers.js").resolvePluginProviders; @@ -433,54 +438,9 @@ describe("provider-runtime", () => { }), ).toBe(true); - expect( - buildProviderMissingAuthMessageWithPlugin({ - provider: "openai", - env: process.env, - context: { - env: process.env, - provider: "openai", - listProfileIds: (providerId) => (providerId === "openai-codex" ? ["p1"] : []), - }, - }), - ).toContain("openai-codex/gpt-5.4"); - - expect( - resolveProviderBuiltInModelSuppression({ - env: process.env, - context: { - env: process.env, - provider: "azure-openai-responses", - modelId: "gpt-5.3-codex-spark", - }, - }), - ).toMatchObject({ - suppress: true, - errorMessage: expect.stringContaining("openai-codex/gpt-5.3-codex-spark"), - }); - - await expect( - augmentModelCatalogWithProviderPlugins({ - env: process.env, - context: { - env: process.env, - entries: [ - { provider: "openai", id: "gpt-5.2", name: "GPT-5.2" }, - { provider: "openai", id: "gpt-5.2-pro", name: "GPT-5.2 Pro" }, - { provider: "openai-codex", id: "gpt-5.3-codex", name: "GPT-5.3 Codex" }, - ], - }, - }), - ).resolves.toEqual([ - { provider: "openai", id: "gpt-5.4", name: "gpt-5.4" }, - { provider: "openai", id: "gpt-5.4-pro", name: "gpt-5.4-pro" }, - { provider: "openai-codex", id: "gpt-5.4", name: "gpt-5.4" }, - { - provider: "openai-codex", - id: "gpt-5.3-codex-spark", - name: "gpt-5.3-codex-spark", - }, - ]); + expectCodexMissingAuthHint(buildProviderMissingAuthMessageWithPlugin); + expectCodexBuiltInSuppression(resolveProviderBuiltInModelSuppression); + await expectAugmentedCodexCatalog(augmentModelCatalogWithProviderPlugins); expect(prepareDynamicModel).toHaveBeenCalledTimes(1); expect(refreshOAuth).toHaveBeenCalledTimes(1); From f8f6ae46737ce16d78ebf37cddbab9f45888129f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:07:36 +0000 Subject: [PATCH 136/187] refactor(apns-tests): share relay push params --- src/infra/push-apns.relay.test.ts | 58 ++++++++++--------------------- 1 file changed, 18 insertions(+), 40 deletions(-) diff --git a/src/infra/push-apns.relay.test.ts b/src/infra/push-apns.relay.test.ts index 4e8e8054311..0079597a8cd 100644 --- a/src/infra/push-apns.relay.test.ts +++ b/src/infra/push-apns.relay.test.ts @@ -27,6 +27,21 @@ afterEach(() => { vi.unstubAllGlobals(); }); +function createRelayPushParams() { + return { + relayConfig: { + baseUrl: "https://relay.example.com", + timeoutMs: 1000, + }, + sendGrant: "send-grant-123", + relayHandle: "relay-handle-123", + payload: { aps: { "content-available": 1 } }, + pushType: "background" as const, + priority: "5" as const, + gatewayIdentity: relayGatewayIdentity, + }; +} + describe("push-apns.relay", () => { describe("resolveApnsRelayConfigFromEnv", () => { it("returns a missing-config error when no relay base URL is configured", () => { @@ -190,18 +205,7 @@ describe("push-apns.relay", () => { }); vi.stubGlobal("fetch", fetchMock as unknown as typeof fetch); - const result = await sendApnsRelayPush({ - relayConfig: { - baseUrl: "https://relay.example.com", - timeoutMs: 1000, - }, - sendGrant: "send-grant-123", - relayHandle: "relay-handle-123", - payload: { aps: { "content-available": 1 } }, - pushType: "background", - priority: "5", - gatewayIdentity: relayGatewayIdentity, - }); + const result = await sendApnsRelayPush(createRelayPushParams()); expect(fetchMock).toHaveBeenCalledTimes(1); expect(fetchMock.mock.calls[0]?.[1]).toMatchObject({ redirect: "manual" }); @@ -221,20 +225,7 @@ describe("push-apns.relay", () => { }); vi.stubGlobal("fetch", fetchMock as unknown as typeof fetch); - await expect( - sendApnsRelayPush({ - relayConfig: { - baseUrl: "https://relay.example.com", - timeoutMs: 1000, - }, - sendGrant: "send-grant-123", - relayHandle: "relay-handle-123", - payload: { aps: { "content-available": 1 } }, - pushType: "background", - priority: "5", - gatewayIdentity: relayGatewayIdentity, - }), - ).resolves.toEqual({ + await expect(sendApnsRelayPush(createRelayPushParams())).resolves.toEqual({ ok: true, status: 202, apnsId: undefined, @@ -258,20 +249,7 @@ describe("push-apns.relay", () => { }); vi.stubGlobal("fetch", fetchMock as unknown as typeof fetch); - await expect( - sendApnsRelayPush({ - relayConfig: { - baseUrl: "https://relay.example.com", - timeoutMs: 1000, - }, - sendGrant: "send-grant-123", - relayHandle: "relay-handle-123", - payload: { aps: { "content-available": 1 } }, - pushType: "background", - priority: "5", - gatewayIdentity: relayGatewayIdentity, - }), - ).resolves.toEqual({ + await expect(sendApnsRelayPush(createRelayPushParams())).resolves.toEqual({ ok: false, status: 410, apnsId: "relay-apns-id", From d698d8c5a59539a2c2a9268f462049124efa030d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:08:46 +0000 Subject: [PATCH 137/187] refactor(media-tests): share telegram redaction assertion --- src/media/fetch.test.ts | 61 ++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 28 deletions(-) diff --git a/src/media/fetch.test.ts b/src/media/fetch.test.ts index 4498ca4b550..ea7354135d4 100644 --- a/src/media/fetch.test.ts +++ b/src/media/fetch.test.ts @@ -31,6 +31,29 @@ function makeLookupFn() { >; } +async function expectRedactedTelegramFetchError(params: { + telegramFileUrl: string; + telegramToken: string; + redactedTelegramToken: string; + fetchImpl: Parameters[0]["fetchImpl"]; +}) { + const error = await fetchRemoteMedia({ + url: params.telegramFileUrl, + fetchImpl: params.fetchImpl, + lookupFn: makeLookupFn(), + maxBytes: 1024, + ssrfPolicy: { + allowedHostnames: ["api.telegram.org"], + allowRfc2544BenchmarkRange: true, + }, + }).catch((err: unknown) => err as Error); + + expect(error).toBeInstanceOf(Error); + const errorText = error instanceof Error ? String(error) : ""; + expect(errorText).not.toContain(params.telegramToken); + expect(errorText).toContain(`bot${params.redactedTelegramToken}`); +} + describe("fetchRemoteMedia", () => { const telegramToken = "123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZabcd"; const redactedTelegramToken = `${telegramToken.slice(0, 6)}…${telegramToken.slice(-4)}`; @@ -100,41 +123,23 @@ describe("fetchRemoteMedia", () => { throw new Error(`dial failed for ${telegramFileUrl}`); }); - const error = await fetchRemoteMedia({ - url: telegramFileUrl, + await expectRedactedTelegramFetchError({ + telegramFileUrl, + telegramToken, + redactedTelegramToken, fetchImpl, - lookupFn: makeLookupFn(), - maxBytes: 1024, - ssrfPolicy: { - allowedHostnames: ["api.telegram.org"], - allowRfc2544BenchmarkRange: true, - }, - }).catch((err: unknown) => err as Error); - - expect(error).toBeInstanceOf(Error); - const errorText = error instanceof Error ? String(error) : ""; - expect(errorText).not.toContain(telegramToken); - expect(errorText).toContain(`bot${redactedTelegramToken}`); + }); }); it("redacts Telegram bot tokens from HTTP error messages", async () => { const fetchImpl = vi.fn(async () => new Response("unauthorized", { status: 401 })); - const error = await fetchRemoteMedia({ - url: telegramFileUrl, + await expectRedactedTelegramFetchError({ + telegramFileUrl, + telegramToken, + redactedTelegramToken, fetchImpl, - lookupFn: makeLookupFn(), - maxBytes: 1024, - ssrfPolicy: { - allowedHostnames: ["api.telegram.org"], - allowRfc2544BenchmarkRange: true, - }, - }).catch((err: unknown) => err as Error); - - expect(error).toBeInstanceOf(Error); - const errorText = error instanceof Error ? String(error) : ""; - expect(errorText).not.toContain(telegramToken); - expect(errorText).toContain(`bot${redactedTelegramToken}`); + }); }); it("blocks private IP literals before fetching", async () => { From 5699b3dd27bda202ed680aba6ac53fba0ebbe7b9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:10:33 +0000 Subject: [PATCH 138/187] refactor(heartbeat-tests): share seeded heartbeat run --- .../heartbeat-runner.model-override.test.ts | 88 +++++++++---------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/src/infra/heartbeat-runner.model-override.test.ts b/src/infra/heartbeat-runner.model-override.test.ts index f33e5e9fbd0..92c89e0b026 100644 --- a/src/infra/heartbeat-runner.model-override.test.ts +++ b/src/infra/heartbeat-runner.model-override.test.ts @@ -61,6 +61,34 @@ afterEach(() => { }); describe("runHeartbeatOnce – heartbeat model override", () => { + async function runHeartbeatWithSeed(params: { + seedSession: (sessionKey: string, input: SeedSessionInput) => Promise; + cfg: OpenClawConfig; + sessionKey: string; + agentId?: string; + }) { + await params.seedSession(params.sessionKey, { lastChannel: "whatsapp", lastTo: "+1555" }); + + const replySpy = vi.spyOn(replyModule, "getReplyFromConfig"); + replySpy.mockResolvedValue({ text: "HEARTBEAT_OK" }); + + await runHeartbeatOnce({ + cfg: params.cfg, + agentId: params.agentId, + deps: { + getQueueSize: () => 0, + nowMs: () => 0, + }, + }); + + expect(replySpy).toHaveBeenCalledTimes(1); + return { + ctx: replySpy.mock.calls[0]?.[0], + opts: replySpy.mock.calls[0]?.[1], + replySpy, + }; + } + async function runDefaultsHeartbeat(params: { model?: string; suppressToolErrorWarnings?: boolean; @@ -86,21 +114,12 @@ describe("runHeartbeatOnce – heartbeat model override", () => { session: { store: storePath }, }; const sessionKey = resolveMainSessionKey(cfg); - await seedSession(sessionKey, { lastChannel: "whatsapp", lastTo: "+1555" }); - - const replySpy = vi.spyOn(replyModule, "getReplyFromConfig"); - replySpy.mockResolvedValue({ text: "HEARTBEAT_OK" }); - - await runHeartbeatOnce({ + const result = await runHeartbeatWithSeed({ + seedSession, cfg, - deps: { - getQueueSize: () => 0, - nowMs: () => 0, - }, + sessionKey, }); - - expect(replySpy).toHaveBeenCalledTimes(1); - return replySpy.mock.calls[0]?.[1]; + return result.opts; }); } @@ -152,20 +171,14 @@ describe("runHeartbeatOnce – heartbeat model override", () => { session: { store: storePath }, }; const sessionKey = resolveMainSessionKey(cfg); - await seedSession(sessionKey, { lastChannel: "whatsapp", lastTo: "+1555" }); - - const replySpy = vi.spyOn(replyModule, "getReplyFromConfig"); - replySpy.mockResolvedValue({ text: "HEARTBEAT_OK" }); - - await runHeartbeatOnce({ + const result = await runHeartbeatWithSeed({ + seedSession, cfg, - deps: { getQueueSize: () => 0, nowMs: () => 0 }, + sessionKey, }); - expect(replySpy).toHaveBeenCalledTimes(1); - const ctx = replySpy.mock.calls[0]?.[0]; // Isolated heartbeat runs use a dedicated session key with :heartbeat suffix - expect(ctx.SessionKey).toBe(`${sessionKey}:heartbeat`); + expect(result.ctx?.SessionKey).toBe(`${sessionKey}:heartbeat`); }); }); @@ -185,19 +198,13 @@ describe("runHeartbeatOnce – heartbeat model override", () => { session: { store: storePath }, }; const sessionKey = resolveMainSessionKey(cfg); - await seedSession(sessionKey, { lastChannel: "whatsapp", lastTo: "+1555" }); - - const replySpy = vi.spyOn(replyModule, "getReplyFromConfig"); - replySpy.mockResolvedValue({ text: "HEARTBEAT_OK" }); - - await runHeartbeatOnce({ + const result = await runHeartbeatWithSeed({ + seedSession, cfg, - deps: { getQueueSize: () => 0, nowMs: () => 0 }, + sessionKey, }); - expect(replySpy).toHaveBeenCalledTimes(1); - const ctx = replySpy.mock.calls[0]?.[0]; - expect(ctx.SessionKey).toBe(sessionKey); + expect(result.ctx?.SessionKey).toBe(sessionKey); }); }); @@ -228,21 +235,14 @@ describe("runHeartbeatOnce – heartbeat model override", () => { session: { store: storePath }, }; const sessionKey = resolveAgentMainSessionKey({ cfg, agentId: "ops" }); - await seedSession(sessionKey, { lastChannel: "whatsapp", lastTo: "+1555" }); - - const replySpy = vi.spyOn(replyModule, "getReplyFromConfig"); - replySpy.mockResolvedValue({ text: "HEARTBEAT_OK" }); - - await runHeartbeatOnce({ + const result = await runHeartbeatWithSeed({ + seedSession, cfg, agentId: "ops", - deps: { - getQueueSize: () => 0, - nowMs: () => 0, - }, + sessionKey, }); - expect(replySpy).toHaveBeenCalledWith( + expect(result.replySpy).toHaveBeenCalledWith( expect.any(Object), expect.objectContaining({ isHeartbeat: true, From 1b9704df4d4a6863863bb04efc9e2b682b5309fb Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:14:23 +0000 Subject: [PATCH 139/187] refactor(kilocode-tests): share reasoning payload capture --- .../extra-params.kilocode.test.ts | 123 +++++++----------- 1 file changed, 48 insertions(+), 75 deletions(-) diff --git a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts index c4e81d2d804..97efccad7ce 100644 --- a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts @@ -52,6 +52,43 @@ function applyAndCapture(params: { return captured; } +function applyAndCaptureReasoning(params: { + cfg?: OpenClawConfig; + modelId: string; + initialPayload?: Record; + thinkingLevel?: "minimal" | "low" | "medium" | "high"; +}) { + let capturedPayload: Record | undefined; + + const baseStreamFn: StreamFn = (model, _context, options) => { + const payload: Record = { ...params.initialPayload }; + options?.onPayload?.(payload, model); + capturedPayload = payload; + return createAssistantMessageEventStream(); + }; + const agent = { streamFn: baseStreamFn }; + + applyExtraParamsToAgent( + agent, + params.cfg ?? TEST_CFG, + "kilocode", + params.modelId, + undefined, + params.thinkingLevel ?? "high", + ); + + const model = { + api: "openai-completions", + provider: "kilocode", + id: params.modelId, + } as Model<"openai-completions">; + const context: Context = { messages: [] }; + + void agent.streamFn?.(model, context, {}); + + return capturedPayload; +} + describe("extra-params: Kilocode wrapper", () => { const envSnapshot = captureEnv(["KILOCODE_FEATURE"]); @@ -121,27 +158,10 @@ describe("extra-params: Kilocode wrapper", () => { describe("extra-params: Kilocode kilo/auto reasoning", () => { it("does not inject reasoning.effort for kilo/auto", () => { - let capturedPayload: Record | undefined; - - const baseStreamFn: StreamFn = (model, _context, options) => { - const payload: Record = { reasoning_effort: "high" }; - options?.onPayload?.(payload, model); - capturedPayload = payload; - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - // Pass thinking level explicitly (6th parameter) to trigger reasoning injection - applyExtraParamsToAgent(agent, TEST_CFG, "kilocode", "kilo/auto", undefined, "high"); - - const model = { - api: "openai-completions", - provider: "kilocode", - id: "kilo/auto", - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); + const capturedPayload = applyAndCaptureReasoning({ + modelId: "kilo/auto", + initialPayload: { reasoning_effort: "high" }, + }); // kilo/auto should not have reasoning injected expect(capturedPayload?.reasoning).toBeUndefined(); @@ -149,70 +169,23 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { }); it("injects reasoning.effort for non-auto kilocode models", () => { - let capturedPayload: Record | undefined; - - const baseStreamFn: StreamFn = (model, _context, options) => { - const payload: Record = {}; - options?.onPayload?.(payload, model); - capturedPayload = payload; - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent( - agent, - TEST_CFG, - "kilocode", - "anthropic/claude-sonnet-4", - undefined, - "high", - ); - - const model = { - api: "openai-completions", - provider: "kilocode", - id: "anthropic/claude-sonnet-4", - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); + const capturedPayload = applyAndCaptureReasoning({ + modelId: "anthropic/claude-sonnet-4", + }); // Non-auto models should have reasoning injected expect(capturedPayload?.reasoning).toEqual({ effort: "high" }); }); it("still normalizes reasoning for Kilocode under restrictive plugins.allow", () => { - let capturedPayload: Record | undefined; - - const baseStreamFn: StreamFn = (model, _context, options) => { - const payload: Record = {}; - options?.onPayload?.(payload, model); - capturedPayload = payload; - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent( - agent, - { + const capturedPayload = applyAndCaptureReasoning({ + cfg: { plugins: { allow: ["openrouter"], }, }, - "kilocode", - "anthropic/claude-sonnet-4", - undefined, - "high", - ); - - const model = { - api: "openai-completions", - provider: "kilocode", - id: "anthropic/claude-sonnet-4", - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); + modelId: "anthropic/claude-sonnet-4", + }); expect(capturedPayload?.reasoning).toEqual({ effort: "high" }); }); From 7bb36efd7b54e2f494518a45a36162d1b6784120 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:18:10 +0000 Subject: [PATCH 140/187] refactor(kilocode-tests): share extra-params harness --- .../extra-params.kilocode.test.ts | 119 ++++++------------ .../extra-params.openai.test.ts | 45 +++---- ...ra-params.openrouter-cache-control.test.ts | 43 +++---- .../extra-params.test-support.ts | 56 +++++++++ .../extra-params.zai-tool-stream.test.ts | 29 ++--- 5 files changed, 137 insertions(+), 155 deletions(-) create mode 100644 src/agents/pi-embedded-runner/extra-params.test-support.ts diff --git a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts index 97efccad7ce..b9143d20a46 100644 --- a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts @@ -1,15 +1,8 @@ -import type { StreamFn } from "@mariozechner/pi-agent-core"; -import type { Context, Model } from "@mariozechner/pi-ai"; -import { createAssistantMessageEventStream } from "@mariozechner/pi-ai"; +import type { Model } from "@mariozechner/pi-ai"; import { afterEach, describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../config/config.js"; import { captureEnv } from "../../test-utils/env.js"; -import { applyExtraParamsToAgent } from "./extra-params.js"; - -type CapturedCall = { - headers?: Record; - payload?: Record; -}; +import { runExtraParamsCase } from "./extra-params.test-support.js"; const TEST_CFG = { plugins: { @@ -26,30 +19,19 @@ function applyAndCapture(params: { modelId: string; callerHeaders?: Record; cfg?: OpenClawConfig; -}): CapturedCall { - const captured: CapturedCall = {}; - - const baseStreamFn: StreamFn = (model, _context, options) => { - captured.headers = options?.headers; - options?.onPayload?.({}, model); - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent(agent, params.cfg ?? TEST_CFG, params.provider, params.modelId); - - const model = { - api: "openai-completions", - provider: params.provider, - id: params.modelId, - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, { - headers: params.callerHeaders, +}) { + return runExtraParamsCase({ + applyModelId: params.modelId, + applyProvider: params.provider, + callerHeaders: params.callerHeaders, + cfg: params.cfg ?? TEST_CFG, + model: { + api: "openai-completions", + provider: params.provider, + id: params.modelId, + } as Model<"openai-completions">, + payload: {}, }); - - return captured; } function applyAndCaptureReasoning(params: { @@ -58,35 +40,18 @@ function applyAndCaptureReasoning(params: { initialPayload?: Record; thinkingLevel?: "minimal" | "low" | "medium" | "high"; }) { - let capturedPayload: Record | undefined; - - const baseStreamFn: StreamFn = (model, _context, options) => { - const payload: Record = { ...params.initialPayload }; - options?.onPayload?.(payload, model); - capturedPayload = payload; - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent( - agent, - params.cfg ?? TEST_CFG, - "kilocode", - params.modelId, - undefined, - params.thinkingLevel ?? "high", - ); - - const model = { - api: "openai-completions", - provider: "kilocode", - id: params.modelId, - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); - - return capturedPayload; + return runExtraParamsCase({ + applyModelId: params.modelId, + applyProvider: "kilocode", + cfg: params.cfg ?? TEST_CFG, + model: { + api: "openai-completions", + provider: "kilocode", + id: params.modelId, + } as Model<"openai-completions">, + payload: { ...params.initialPayload }, + thinkingLevel: params.thinkingLevel ?? "high", + }).payload; } describe("extra-params: Kilocode wrapper", () => { @@ -191,26 +156,18 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { }); it("does not inject reasoning.effort for x-ai models", () => { - let capturedPayload: Record | undefined; - - const baseStreamFn: StreamFn = (model, _context, options) => { - const payload: Record = { reasoning_effort: "high" }; - options?.onPayload?.(payload, model); - capturedPayload = payload; - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent(agent, TEST_CFG, "kilocode", "x-ai/grok-3", undefined, "high"); - - const model = { - api: "openai-completions", - provider: "kilocode", - id: "x-ai/grok-3", - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); + const capturedPayload = runExtraParamsCase({ + applyModelId: "x-ai/grok-3", + applyProvider: "kilocode", + cfg: TEST_CFG, + model: { + api: "openai-completions", + provider: "kilocode", + id: "x-ai/grok-3", + } as Model<"openai-completions">, + payload: { reasoning_effort: "high" }, + thinkingLevel: "high", + }).payload; // x-ai models reject reasoning.effort — should be skipped expect(capturedPayload?.reasoning).toBeUndefined(); diff --git a/src/agents/pi-embedded-runner/extra-params.openai.test.ts b/src/agents/pi-embedded-runner/extra-params.openai.test.ts index 92e26c95ee0..f7f033f5827 100644 --- a/src/agents/pi-embedded-runner/extra-params.openai.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.openai.test.ts @@ -1,41 +1,26 @@ -import type { StreamFn } from "@mariozechner/pi-agent-core"; -import type { Context, Model } from "@mariozechner/pi-ai"; -import { createAssistantMessageEventStream } from "@mariozechner/pi-ai"; +import type { Model } from "@mariozechner/pi-ai"; import { afterEach, describe, expect, it } from "vitest"; import { captureEnv } from "../../test-utils/env.js"; -import { applyExtraParamsToAgent } from "./extra-params.js"; - -type CapturedCall = { - headers?: Record; -}; +import { runExtraParamsCase } from "./extra-params.test-support.js"; function applyAndCapture(params: { provider: string; modelId: string; baseUrl?: string; callerHeaders?: Record; -}): CapturedCall { - const captured: CapturedCall = {}; - const baseStreamFn: StreamFn = (model, _context, options) => { - captured.headers = options?.headers; - options?.onPayload?.({}, model); - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent(agent, undefined, params.provider, params.modelId); - - const model = { - api: "openai-responses", - provider: params.provider, - id: params.modelId, - baseUrl: params.baseUrl, - } as Model<"openai-responses">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, { headers: params.callerHeaders }); - - return captured; +}) { + return runExtraParamsCase({ + applyModelId: params.modelId, + applyProvider: params.provider, + callerHeaders: params.callerHeaders, + model: { + api: "openai-responses", + provider: params.provider, + id: params.modelId, + baseUrl: params.baseUrl, + } as Model<"openai-responses">, + payload: {}, + }); } describe("extra-params: OpenAI attribution", () => { diff --git a/src/agents/pi-embedded-runner/extra-params.openrouter-cache-control.test.ts b/src/agents/pi-embedded-runner/extra-params.openrouter-cache-control.test.ts index 8a09d9af547..08010bb0b20 100644 --- a/src/agents/pi-embedded-runner/extra-params.openrouter-cache-control.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.openrouter-cache-control.test.ts @@ -1,9 +1,6 @@ -import type { StreamFn } from "@mariozechner/pi-agent-core"; -import type { Context, Model } from "@mariozechner/pi-ai"; -import { createAssistantMessageEventStream } from "@mariozechner/pi-ai"; +import type { Model } from "@mariozechner/pi-ai"; import { describe, expect, it } from "vitest"; -import type { OpenClawConfig } from "../../config/config.js"; -import { applyExtraParamsToAgent } from "./extra-params.js"; +import { runExtraParamsCase } from "./extra-params.test-support.js"; type StreamPayload = { messages: Array<{ @@ -13,31 +10,23 @@ type StreamPayload = { }; function runOpenRouterPayload(payload: StreamPayload, modelId: string) { - const baseStreamFn: StreamFn = (model, _context, options) => { - options?.onPayload?.(payload, model); - return createAssistantMessageEventStream(); - }; - const agent = { streamFn: baseStreamFn }; - const cfg = { - plugins: { - entries: { - openrouter: { - enabled: true, + runExtraParamsCase({ + cfg: { + plugins: { + entries: { + openrouter: { + enabled: true, + }, }, }, }, - } satisfies OpenClawConfig; - - applyExtraParamsToAgent(agent, cfg, "openrouter", modelId); - - const model = { - api: "openai-completions", - provider: "openrouter", - id: modelId, - } as Model<"openai-completions">; - const context: Context = { messages: [] }; - - void agent.streamFn?.(model, context, {}); + model: { + api: "openai-completions", + provider: "openrouter", + id: modelId, + } as Model<"openai-completions">, + payload, + }); } describe("extra-params: OpenRouter Anthropic cache_control", () => { diff --git a/src/agents/pi-embedded-runner/extra-params.test-support.ts b/src/agents/pi-embedded-runner/extra-params.test-support.ts new file mode 100644 index 00000000000..ae4fdb9edc3 --- /dev/null +++ b/src/agents/pi-embedded-runner/extra-params.test-support.ts @@ -0,0 +1,56 @@ +import type { StreamFn } from "@mariozechner/pi-agent-core"; +import type { Context, Model, SimpleStreamOptions } from "@mariozechner/pi-ai"; +import type { OpenClawConfig } from "../../config/config.js"; +import { applyExtraParamsToAgent } from "./extra-params.js"; + +export type ExtraParamsCapture> = { + headers?: Record; + payload: TPayload; +}; + +type RunExtraParamsCaseParams< + TApi extends "openai-completions" | "openai-responses", + TPayload extends Record, +> = { + applyModelId?: string; + applyProvider?: string; + callerHeaders?: Record; + cfg?: OpenClawConfig; + model: Model; + options?: SimpleStreamOptions; + payload: TPayload; + thinkingLevel?: "minimal" | "low" | "medium" | "high"; +}; + +export function runExtraParamsCase< + TApi extends "openai-completions" | "openai-responses", + TPayload extends Record, +>(params: RunExtraParamsCaseParams): ExtraParamsCapture { + const captured: ExtraParamsCapture = { + payload: params.payload, + }; + + const baseStreamFn: StreamFn = (model, _context, options) => { + captured.headers = options?.headers; + options?.onPayload?.(params.payload, model); + return {} as ReturnType; + }; + const agent = { streamFn: baseStreamFn }; + + applyExtraParamsToAgent( + agent, + params.cfg, + params.applyProvider ?? params.model.provider, + params.applyModelId ?? params.model.id, + undefined, + params.thinkingLevel, + ); + + const context: Context = { messages: [] }; + void agent.streamFn?.(params.model, context, { + ...params.options, + headers: params.callerHeaders ?? params.options?.headers, + }); + + return captured; +} diff --git a/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts b/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts index f7262a66798..b22be4231b8 100644 --- a/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts @@ -1,7 +1,7 @@ -import type { StreamFn } from "@mariozechner/pi-agent-core"; -import type { Context, Model, SimpleStreamOptions } from "@mariozechner/pi-ai"; +import type { Model, SimpleStreamOptions } from "@mariozechner/pi-ai"; import { describe, expect, it, vi } from "vitest"; -import { applyExtraParamsToAgent } from "./extra-params.js"; +import type { OpenClawConfig } from "../../config/config.js"; +import { runExtraParamsCase } from "./extra-params.test-support.js"; // Mock streamSimple for testing vi.mock("@mariozechner/pi-ai", () => ({ @@ -15,24 +15,19 @@ type ToolStreamCase = { applyProvider: string; applyModelId: string; model: Model<"openai-completions">; - cfg?: Parameters[1]; + cfg?: OpenClawConfig; options?: SimpleStreamOptions; }; function runToolStreamCase(params: ToolStreamCase) { - const payload: Record = { model: params.model.id, messages: [] }; - const baseStreamFn: StreamFn = (model, _context, options) => { - options?.onPayload?.(payload, model); - return {} as ReturnType; - }; - const agent = { streamFn: baseStreamFn }; - - applyExtraParamsToAgent(agent, params.cfg, params.applyProvider, params.applyModelId); - - const context: Context = { messages: [] }; - void agent.streamFn?.(params.model, context, params.options ?? {}); - - return payload; + return runExtraParamsCase({ + applyModelId: params.applyModelId, + applyProvider: params.applyProvider, + cfg: params.cfg, + model: params.model, + options: params.options, + payload: { model: params.model.id, messages: [] }, + }).payload; } describe("extra-params: Z.AI tool_stream support", () => { From 9c047c5423c59175ed3e12b43c0ca07a686ecb59 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:19:37 +0000 Subject: [PATCH 141/187] refactor(kilocode-tests): share cache retention wrapper --- ...tra-params.cache-retention-default.test.ts | 165 +++++++++--------- 1 file changed, 79 insertions(+), 86 deletions(-) diff --git a/src/agents/pi-embedded-runner/extra-params.cache-retention-default.test.ts b/src/agents/pi-embedded-runner/extra-params.cache-retention-default.test.ts index cd093a86e7c..b988a8c3c59 100644 --- a/src/agents/pi-embedded-runner/extra-params.cache-retention-default.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.cache-retention-default.test.ts @@ -2,6 +2,25 @@ import type { StreamFn } from "@mariozechner/pi-agent-core"; import { describe, expect, it, vi } from "vitest"; import { applyExtraParamsToAgent } from "../pi-embedded-runner.js"; +function applyAndExpectWrapped(params: { + cfg?: Parameters[1]; + extraParamsOverride?: Parameters[4]; + modelId: string; + provider: string; +}) { + const agent: { streamFn?: StreamFn } = {}; + + applyExtraParamsToAgent( + agent, + params.cfg, + params.provider, + params.modelId, + params.extraParamsOverride, + ); + + expect(agent.streamFn).toBeDefined(); +} + // Mock the logger to avoid noise in tests vi.mock("./logger.js", () => ({ log: { @@ -12,15 +31,10 @@ vi.mock("./logger.js", () => ({ describe("cacheRetention default behavior", () => { it("returns 'short' for Anthropic when not configured", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = undefined; - const provider = "anthropic"; - const modelId = "claude-3-sonnet"; - - applyExtraParamsToAgent(agent, cfg, provider, modelId); - - // Verify streamFn was set (indicating cache retention was applied) - expect(agent.streamFn).toBeDefined(); + applyAndExpectWrapped({ + modelId: "claude-3-sonnet", + provider: "anthropic", + }); // The fact that agent.streamFn was modified indicates that cacheRetention // default "short" was applied. We don't need to call the actual function @@ -28,75 +42,63 @@ describe("cacheRetention default behavior", () => { }); it("respects explicit 'none' config", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = { - agents: { - defaults: { - models: { - "anthropic/claude-3-sonnet": { - params: { - cacheRetention: "none" as const, + applyAndExpectWrapped({ + cfg: { + agents: { + defaults: { + models: { + "anthropic/claude-3-sonnet": { + params: { + cacheRetention: "none" as const, + }, }, }, }, }, }, - }; - const provider = "anthropic"; - const modelId = "claude-3-sonnet"; - - applyExtraParamsToAgent(agent, cfg, provider, modelId); - - // Verify streamFn was set (config was applied) - expect(agent.streamFn).toBeDefined(); + modelId: "claude-3-sonnet", + provider: "anthropic", + }); }); it("respects explicit 'long' config", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = { - agents: { - defaults: { - models: { - "anthropic/claude-3-opus": { - params: { - cacheRetention: "long" as const, + applyAndExpectWrapped({ + cfg: { + agents: { + defaults: { + models: { + "anthropic/claude-3-opus": { + params: { + cacheRetention: "long" as const, + }, }, }, }, }, }, - }; - const provider = "anthropic"; - const modelId = "claude-3-opus"; - - applyExtraParamsToAgent(agent, cfg, provider, modelId); - - // Verify streamFn was set (config was applied) - expect(agent.streamFn).toBeDefined(); + modelId: "claude-3-opus", + provider: "anthropic", + }); }); it("respects legacy cacheControlTtl config", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = { - agents: { - defaults: { - models: { - "anthropic/claude-3-haiku": { - params: { - cacheControlTtl: "1h", + applyAndExpectWrapped({ + cfg: { + agents: { + defaults: { + models: { + "anthropic/claude-3-haiku": { + params: { + cacheControlTtl: "1h", + }, }, }, }, }, }, - }; - const provider = "anthropic"; - const modelId = "claude-3-haiku"; - - applyExtraParamsToAgent(agent, cfg, provider, modelId); - - // Verify streamFn was set (legacy config was applied) - expect(agent.streamFn).toBeDefined(); + modelId: "claude-3-haiku", + provider: "anthropic", + }); }); it("returns undefined for non-Anthropic providers", () => { @@ -113,42 +115,33 @@ describe("cacheRetention default behavior", () => { }); it("prefers explicit cacheRetention over default", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = { - agents: { - defaults: { - models: { - "anthropic/claude-3-sonnet": { - params: { - cacheRetention: "long" as const, - temperature: 0.7, + applyAndExpectWrapped({ + cfg: { + agents: { + defaults: { + models: { + "anthropic/claude-3-sonnet": { + params: { + cacheRetention: "long" as const, + temperature: 0.7, + }, }, }, }, }, }, - }; - const provider = "anthropic"; - const modelId = "claude-3-sonnet"; - - applyExtraParamsToAgent(agent, cfg, provider, modelId); - - // Verify streamFn was set with explicit config - expect(agent.streamFn).toBeDefined(); + modelId: "claude-3-sonnet", + provider: "anthropic", + }); }); it("works with extraParamsOverride", () => { - const agent: { streamFn?: StreamFn } = {}; - const cfg = undefined; - const provider = "anthropic"; - const modelId = "claude-3-sonnet"; - const extraParamsOverride = { - cacheRetention: "none" as const, - }; - - applyExtraParamsToAgent(agent, cfg, provider, modelId, extraParamsOverride); - - // Verify streamFn was set (override was applied) - expect(agent.streamFn).toBeDefined(); + applyAndExpectWrapped({ + extraParamsOverride: { + cacheRetention: "none" as const, + }, + modelId: "claude-3-sonnet", + provider: "anthropic", + }); }); }); From 1843248c69c33d460ece60cea94b551242b2ee4a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:22:47 +0000 Subject: [PATCH 142/187] refactor(attempt-tests): share wrapped stream helper --- .../pi-embedded-runner/run/attempt.test.ts | 81 ++++++++++--------- 1 file changed, 41 insertions(+), 40 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/attempt.test.ts b/src/agents/pi-embedded-runner/run/attempt.test.ts index 1953099cf7b..ec85037aefb 100644 --- a/src/agents/pi-embedded-runner/run/attempt.test.ts +++ b/src/agents/pi-embedded-runner/run/attempt.test.ts @@ -17,6 +17,11 @@ import { wrapStreamFnTrimToolCallNames, } from "./attempt.js"; +type FakeWrappedStream = { + result: () => Promise; + [Symbol.asyncIterator]: () => AsyncIterator; +}; + function createOllamaProviderConfig(injectNumCtxForOpenAICompat: boolean): OpenClawConfig { return { models: { @@ -32,6 +37,34 @@ function createOllamaProviderConfig(injectNumCtxForOpenAICompat: boolean): OpenC }; } +function createFakeStream(params: { + events: unknown[]; + resultMessage: unknown; +}): FakeWrappedStream { + return { + async result() { + return params.resultMessage; + }, + [Symbol.asyncIterator]() { + return (async function* () { + for (const event of params.events) { + yield event; + } + })(); + }, + }; +} + +async function invokeWrappedTestStream( + wrap: ( + baseFn: (...args: never[]) => unknown, + ) => (...args: never[]) => FakeWrappedStream | Promise, + baseFn: (...args: never[]) => unknown, +): Promise { + const wrappedFn = wrap(baseFn); + return await Promise.resolve(wrappedFn({} as never, {} as never, {} as never)); +} + describe("resolvePromptBuildHookResult", () => { function createLegacyOnlyHookRunner() { return { @@ -190,30 +223,14 @@ describe("resolveAttemptFsWorkspaceOnly", () => { }); }); describe("wrapStreamFnTrimToolCallNames", () => { - function createFakeStream(params: { events: unknown[]; resultMessage: unknown }): { - result: () => Promise; - [Symbol.asyncIterator]: () => AsyncIterator; - } { - return { - async result() { - return params.resultMessage; - }, - [Symbol.asyncIterator]() { - return (async function* () { - for (const event of params.events) { - yield event; - } - })(); - }, - }; - } - async function invokeWrappedStream( baseFn: (...args: never[]) => unknown, allowedToolNames?: Set, ) { - const wrappedFn = wrapStreamFnTrimToolCallNames(baseFn as never, allowedToolNames); - return await wrappedFn({} as never, {} as never, {} as never); + return await invokeWrappedTestStream( + (innerBaseFn) => wrapStreamFnTrimToolCallNames(innerBaseFn as never, allowedToolNames), + baseFn, + ); } function createEventStream(params: { @@ -725,27 +742,11 @@ describe("wrapStreamFnTrimToolCallNames", () => { }); describe("wrapStreamFnRepairMalformedToolCallArguments", () => { - function createFakeStream(params: { events: unknown[]; resultMessage: unknown }): { - result: () => Promise; - [Symbol.asyncIterator]: () => AsyncIterator; - } { - return { - async result() { - return params.resultMessage; - }, - [Symbol.asyncIterator]() { - return (async function* () { - for (const event of params.events) { - yield event; - } - })(); - }, - }; - } - async function invokeWrappedStream(baseFn: (...args: never[]) => unknown) { - const wrappedFn = wrapStreamFnRepairMalformedToolCallArguments(baseFn as never); - return await wrappedFn({} as never, {} as never, {} as never); + return await invokeWrappedTestStream( + (innerBaseFn) => wrapStreamFnRepairMalformedToolCallArguments(innerBaseFn as never), + baseFn, + ); } it("repairs anthropic-compatible tool arguments when trailing junk follows valid JSON", async () => { From 9053f551cb5d4f6f41626eabc934370889cad901 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:25:12 +0000 Subject: [PATCH 143/187] refactor(payload-tests): share empty payload assertion --- .../run/payloads.errors.test.ts | 24 ++++++++----------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts index a2e7873aedf..61cb7da7891 100644 --- a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts @@ -40,8 +40,13 @@ describe("buildEmbeddedRunPayloads", () => { expect(payloads[0]?.text).toBe(OVERLOADED_FALLBACK_TEXT); }; + function expectNoPayloads(params: Parameters[0]) { + const payloads = buildPayloads(params); + expect(payloads).toHaveLength(0); + } + function expectNoSyntheticCompletionForSession(sessionKey: string) { - const payloads = buildPayloads({ + expectNoPayloads({ sessionKey, toolMetas: [{ toolName: "write", meta: "/tmp/out.md" }], lastAssistant: makeAssistant({ @@ -50,7 +55,6 @@ describe("buildEmbeddedRunPayloads", () => { content: [], }), }); - expect(payloads).toHaveLength(0); } it("suppresses raw API error JSON when the assistant errored", () => { @@ -155,13 +159,11 @@ describe("buildEmbeddedRunPayloads", () => { }); it("does not add synthetic completion text when tools run without final assistant text", () => { - const payloads = buildPayloads({ + expectNoPayloads({ sessionKey: "agent:main:discord:direct:u123", toolMetas: [{ toolName: "write", meta: "/tmp/out.md" }], lastAssistant: makeStoppedAssistant(), }); - - expect(payloads).toHaveLength(0); }); it("does not add synthetic completion text for channel sessions", () => { @@ -173,7 +175,7 @@ describe("buildEmbeddedRunPayloads", () => { }); it("does not add synthetic completion text when messaging tool already delivered output", () => { - const payloads = buildPayloads({ + expectNoPayloads({ sessionKey: "agent:main:discord:direct:u123", toolMetas: [{ toolName: "message_send", meta: "sent to #ops" }], didSendViaMessagingTool: true, @@ -183,25 +185,19 @@ describe("buildEmbeddedRunPayloads", () => { content: [], }), }); - - expect(payloads).toHaveLength(0); }); it("does not add synthetic completion text when the run still has a tool error", () => { - const payloads = buildPayloads({ + expectNoPayloads({ toolMetas: [{ toolName: "browser", meta: "open https://example.com" }], lastToolError: { toolName: "browser", error: "url required" }, }); - - expect(payloads).toHaveLength(0); }); it("does not add synthetic completion text when no tools ran", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastAssistant: makeStoppedAssistant(), }); - - expect(payloads).toHaveLength(0); }); it("adds tool error fallback when the assistant only invoked tools and verbose mode is on", () => { From 1eb810a5e3280405c8342af7977972e785ca9bbc Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Tue, 17 Mar 2026 00:41:44 -0700 Subject: [PATCH 144/187] Telegram: fix named-account DM topic session keys (#48773) --- extensions/telegram/src/bot-handlers.ts | 13 +++- ...t-message-context.named-account-dm.test.ts | 10 ++- .../telegram/src/bot-message-context.ts | 34 ++++------ .../telegram/src/bot-native-commands.ts | 13 +++- ...onversation-route.base-session-key.test.ts | 64 +++++++++++++++++++ extensions/telegram/src/conversation-route.ts | 32 ++++++++++ 6 files changed, 137 insertions(+), 29 deletions(-) create mode 100644 extensions/telegram/src/conversation-route.base-session-key.test.ts diff --git a/extensions/telegram/src/bot-handlers.ts b/extensions/telegram/src/bot-handlers.ts index 18db7c3405f..92d584b8ea9 100644 --- a/extensions/telegram/src/bot-handlers.ts +++ b/extensions/telegram/src/bot-handlers.ts @@ -64,7 +64,10 @@ import { resolveTelegramGroupAllowFromContext, } from "./bot/helpers.js"; import type { TelegramContext } from "./bot/types.js"; -import { resolveTelegramConversationRoute } from "./conversation-route.js"; +import { + resolveTelegramConversationBaseSessionKey, + resolveTelegramConversationRoute, +} from "./conversation-route.js"; import { enforceTelegramDmAccess } from "./dm-access.js"; import { isTelegramExecApprovalApprover, @@ -331,7 +334,13 @@ export const registerTelegramHandlers = ({ senderId: params.senderId, topicAgentId: topicConfig?.agentId, }); - const baseSessionKey = route.sessionKey; + const baseSessionKey = resolveTelegramConversationBaseSessionKey({ + cfg, + route, + chatId: params.chatId, + isGroup: params.isGroup, + senderId: params.senderId, + }); const threadKeys = dmThreadId != null ? resolveThreadSessionKeys({ baseSessionKey, threadId: `${params.chatId}:${dmThreadId}` }) diff --git a/extensions/telegram/src/bot-message-context.named-account-dm.test.ts b/extensions/telegram/src/bot-message-context.named-account-dm.test.ts index a60904514ba..e51c7920ae7 100644 --- a/extensions/telegram/src/bot-message-context.named-account-dm.test.ts +++ b/extensions/telegram/src/bot-message-context.named-account-dm.test.ts @@ -6,9 +6,13 @@ import { import { buildTelegramMessageContextForTest } from "./bot-message-context.test-harness.js"; const recordInboundSessionMock = vi.fn().mockResolvedValue(undefined); -vi.mock("../../../src/channels/session.js", () => ({ - recordInboundSession: (...args: unknown[]) => recordInboundSessionMock(...args), -})); +vi.mock("openclaw/plugin-sdk/channel-runtime", async (importOriginal) => { + const actual = await importOriginal(); + return { + ...actual, + recordInboundSession: (...args: unknown[]) => recordInboundSessionMock(...args), + }; +}); describe("buildTelegramMessageContext named-account DM fallback", () => { const baseCfg = { diff --git a/extensions/telegram/src/bot-message-context.ts b/extensions/telegram/src/bot-message-context.ts index d77fd52f2fc..b569b1aeb1e 100644 --- a/extensions/telegram/src/bot-message-context.ts +++ b/extensions/telegram/src/bot-message-context.ts @@ -9,7 +9,7 @@ import { loadConfig } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramDirectConfig, TelegramGroupConfig } from "openclaw/plugin-sdk/config-runtime"; import { ensureConfiguredAcpRouteReady } from "openclaw/plugin-sdk/conversation-runtime"; import { recordChannelActivity } from "openclaw/plugin-sdk/infra-runtime"; -import { buildAgentSessionKey, deriveLastRoutePolicy } from "openclaw/plugin-sdk/routing"; +import { deriveLastRoutePolicy } from "openclaw/plugin-sdk/routing"; import { DEFAULT_ACCOUNT_ID, resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; import { logVerbose } from "openclaw/plugin-sdk/runtime-env"; import { withTelegramApiErrorLogging } from "./api-logging.js"; @@ -17,12 +17,11 @@ import { firstDefined, normalizeAllowFrom, normalizeDmAllowFromWithStore } from import { resolveTelegramInboundBody } from "./bot-message-context.body.js"; import { buildTelegramInboundContextPayload } from "./bot-message-context.session.js"; import type { BuildTelegramMessageContextParams } from "./bot-message-context.types.js"; +import { buildTypingThreadParams, resolveTelegramThreadSpec } from "./bot/helpers.js"; import { - buildTypingThreadParams, - resolveTelegramDirectPeerId, - resolveTelegramThreadSpec, -} from "./bot/helpers.js"; -import { resolveTelegramConversationRoute } from "./conversation-route.js"; + resolveTelegramConversationBaseSessionKey, + resolveTelegramConversationRoute, +} from "./conversation-route.js"; import { enforceTelegramDmAccess } from "./dm-access.js"; import { evaluateTelegramGroupBaseAccess } from "./group-access.js"; import { @@ -224,22 +223,13 @@ export const buildTelegramMessageContext = async ({ return false; }; - const baseSessionKey = isNamedAccountFallback - ? buildAgentSessionKey({ - agentId: route.agentId, - channel: "telegram", - accountId: route.accountId, - peer: { - kind: "direct", - id: resolveTelegramDirectPeerId({ - chatId, - senderId, - }), - }, - dmScope: "per-account-channel-peer", - identityLinks: freshCfg.session?.identityLinks, - }).toLowerCase() - : route.sessionKey; + const baseSessionKey = resolveTelegramConversationBaseSessionKey({ + cfg: freshCfg, + route, + chatId, + isGroup, + senderId, + }); // DMs: use thread suffix for session isolation (works regardless of dmScope) const threadKeys = dmThreadId != null diff --git a/extensions/telegram/src/bot-native-commands.ts b/extensions/telegram/src/bot-native-commands.ts index 740dc1d8c08..c496c1b97f6 100644 --- a/extensions/telegram/src/bot-native-commands.ts +++ b/extensions/telegram/src/bot-native-commands.ts @@ -63,7 +63,10 @@ import { resolveTelegramThreadSpec, } from "./bot/helpers.js"; import type { TelegramContext } from "./bot/types.js"; -import { resolveTelegramConversationRoute } from "./conversation-route.js"; +import { + resolveTelegramConversationBaseSessionKey, + resolveTelegramConversationRoute, +} from "./conversation-route.js"; import { shouldSuppressLocalTelegramExecApprovalPrompt } from "./exec-approvals.js"; import type { TelegramTransport } from "./fetch.js"; import { @@ -650,7 +653,13 @@ export const registerTelegramNativeCommands = ({ }); return; } - const baseSessionKey = route.sessionKey; + const baseSessionKey = resolveTelegramConversationBaseSessionKey({ + cfg, + route, + chatId, + isGroup, + senderId, + }); // DMs: use raw messageThreadId for thread sessions (not resolvedThreadId which is for forums) const dmThreadId = threadSpec.scope === "dm" ? threadSpec.id : undefined; const threadKeys = diff --git a/extensions/telegram/src/conversation-route.base-session-key.test.ts b/extensions/telegram/src/conversation-route.base-session-key.test.ts new file mode 100644 index 00000000000..baebab3470c --- /dev/null +++ b/extensions/telegram/src/conversation-route.base-session-key.test.ts @@ -0,0 +1,64 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; +import { resolveThreadSessionKeys } from "openclaw/plugin-sdk/routing"; +import { describe, expect, it } from "vitest"; +import { resolveTelegramConversationBaseSessionKey } from "./conversation-route.js"; + +describe("resolveTelegramConversationBaseSessionKey", () => { + const cfg: OpenClawConfig = {}; + + it("keeps the routed session key for the default account", () => { + expect( + resolveTelegramConversationBaseSessionKey({ + cfg, + route: { + agentId: "main", + accountId: "default", + matchedBy: "default", + sessionKey: "agent:main:main", + }, + chatId: 12345, + isGroup: false, + senderId: 12345, + }), + ).toBe("agent:main:main"); + }); + + it("uses the per-account fallback key for named-account DMs without an explicit binding", () => { + expect( + resolveTelegramConversationBaseSessionKey({ + cfg, + route: { + agentId: "main", + accountId: "personal", + matchedBy: "default", + sessionKey: "agent:main:main", + }, + chatId: 12345, + isGroup: false, + senderId: 12345, + }), + ).toBe("agent:main:telegram:personal:direct:12345"); + }); + + it("keeps DM topic isolation on the named-account fallback key", () => { + const baseSessionKey = resolveTelegramConversationBaseSessionKey({ + cfg, + route: { + agentId: "main", + accountId: "personal", + matchedBy: "default", + sessionKey: "agent:main:main", + }, + chatId: 12345, + isGroup: false, + senderId: 12345, + }); + + expect( + resolveThreadSessionKeys({ + baseSessionKey, + threadId: "12345:99", + }).sessionKey, + ).toBe("agent:main:telegram:personal:direct:12345:thread:12345:99"); + }); +}); diff --git a/extensions/telegram/src/conversation-route.ts b/extensions/telegram/src/conversation-route.ts index fc06221936f..26c3b039312 100644 --- a/extensions/telegram/src/conversation-route.ts +++ b/extensions/telegram/src/conversation-route.ts @@ -9,6 +9,7 @@ import { } from "openclaw/plugin-sdk/routing"; import { buildAgentMainSessionKey, + DEFAULT_ACCOUNT_ID, resolveAgentIdFromSessionKey, sanitizeAgentId, } from "openclaw/plugin-sdk/routing"; @@ -148,3 +149,34 @@ export function resolveTelegramConversationRoute(params: { configuredBindingSessionKey, }; } + +export function resolveTelegramConversationBaseSessionKey(params: { + cfg: OpenClawConfig; + route: Pick< + ReturnType["route"], + "agentId" | "accountId" | "matchedBy" | "sessionKey" + >; + chatId: number | string; + isGroup: boolean; + senderId?: string | number | null; +}): string { + const isNamedAccountFallback = + params.route.accountId !== DEFAULT_ACCOUNT_ID && params.route.matchedBy === "default"; + if (!isNamedAccountFallback || params.isGroup) { + return params.route.sessionKey; + } + return buildAgentSessionKey({ + agentId: params.route.agentId, + channel: "telegram", + accountId: params.route.accountId, + peer: { + kind: "direct", + id: resolveTelegramDirectPeerId({ + chatId: params.chatId, + senderId: params.senderId, + }), + }, + dmScope: "per-account-channel-peer", + identityLinks: params.cfg.session?.identityLinks, + }).toLowerCase(); +} From 168fa9d4338fa67aaa21cdfa29ad7bc150527f29 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:26:52 +0000 Subject: [PATCH 145/187] refactor(compaction-tests): share aggregate timeout params --- ...compaction-retry-aggregate-timeout.test.ts | 80 +++++++++---------- 1 file changed, 38 insertions(+), 42 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts b/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts index 5e1088c3155..2f2d7d0260c 100644 --- a/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts +++ b/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts @@ -1,6 +1,8 @@ import { describe, expect, it, vi } from "vitest"; import { waitForCompactionRetryWithAggregateTimeout } from "./compaction-retry-aggregate-timeout.js"; +type AggregateTimeoutParams = Parameters[0]; + async function withFakeTimers(run: () => Promise) { vi.useFakeTimers(); try { @@ -20,30 +22,38 @@ function expectClearedTimeoutState(onTimeout: ReturnType, timedOut expect(vi.getTimerCount()).toBe(0); } +function buildAggregateTimeoutParams( + overrides: Partial & + Pick, +): AggregateTimeoutParams & { onTimeout: ReturnType } { + const onTimeout = overrides.onTimeout ?? vi.fn(); + return { + waitForCompactionRetry: overrides.waitForCompactionRetry, + abortable: overrides.abortable ?? (async (promise) => await promise), + aggregateTimeoutMs: overrides.aggregateTimeoutMs ?? 60_000, + isCompactionStillInFlight: overrides.isCompactionStillInFlight, + onTimeout, + }; +} + describe("waitForCompactionRetryWithAggregateTimeout", () => { it("times out and fires callback when compaction retry never resolves", async () => { await withFakeTimers(async () => { - const onTimeout = vi.fn(); const waitForCompactionRetry = vi.fn(async () => await new Promise(() => {})); + const params = buildAggregateTimeoutParams({ waitForCompactionRetry }); - const resultPromise = waitForCompactionRetryWithAggregateTimeout({ - waitForCompactionRetry, - abortable: async (promise) => await promise, - aggregateTimeoutMs: 60_000, - onTimeout, - }); + const resultPromise = waitForCompactionRetryWithAggregateTimeout(params); await vi.advanceTimersByTimeAsync(60_000); const result = await resultPromise; expect(result.timedOut).toBe(true); - expectClearedTimeoutState(onTimeout, true); + expectClearedTimeoutState(params.onTimeout, true); }); }); it("keeps waiting while compaction remains in flight", async () => { await withFakeTimers(async () => { - const onTimeout = vi.fn(); let compactionInFlight = true; const waitForCompactionRetry = vi.fn( async () => @@ -54,62 +64,52 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { }, 170_000); }), ); - - const resultPromise = waitForCompactionRetryWithAggregateTimeout({ + const params = buildAggregateTimeoutParams({ waitForCompactionRetry, - abortable: async (promise) => await promise, - aggregateTimeoutMs: 60_000, - onTimeout, isCompactionStillInFlight: () => compactionInFlight, }); + const resultPromise = waitForCompactionRetryWithAggregateTimeout(params); + await vi.advanceTimersByTimeAsync(170_000); const result = await resultPromise; expect(result.timedOut).toBe(false); - expectClearedTimeoutState(onTimeout, false); + expectClearedTimeoutState(params.onTimeout, false); }); }); it("times out after an idle timeout window", async () => { await withFakeTimers(async () => { - const onTimeout = vi.fn(); let compactionInFlight = true; const waitForCompactionRetry = vi.fn(async () => await new Promise(() => {})); setTimeout(() => { compactionInFlight = false; }, 90_000); - - const resultPromise = waitForCompactionRetryWithAggregateTimeout({ + const params = buildAggregateTimeoutParams({ waitForCompactionRetry, - abortable: async (promise) => await promise, - aggregateTimeoutMs: 60_000, - onTimeout, isCompactionStillInFlight: () => compactionInFlight, }); + const resultPromise = waitForCompactionRetryWithAggregateTimeout(params); + await vi.advanceTimersByTimeAsync(120_000); const result = await resultPromise; expect(result.timedOut).toBe(true); - expectClearedTimeoutState(onTimeout, true); + expectClearedTimeoutState(params.onTimeout, true); }); }); it("does not time out when compaction retry resolves", async () => { await withFakeTimers(async () => { - const onTimeout = vi.fn(); const waitForCompactionRetry = vi.fn(async () => {}); + const params = buildAggregateTimeoutParams({ waitForCompactionRetry }); - const result = await waitForCompactionRetryWithAggregateTimeout({ - waitForCompactionRetry, - abortable: async (promise) => await promise, - aggregateTimeoutMs: 60_000, - onTimeout, - }); + const result = await waitForCompactionRetryWithAggregateTimeout(params); expect(result.timedOut).toBe(false); - expectClearedTimeoutState(onTimeout, false); + expectClearedTimeoutState(params.onTimeout, false); }); }); @@ -117,21 +117,17 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { await withFakeTimers(async () => { const abortError = new Error("aborted"); abortError.name = "AbortError"; - const onTimeout = vi.fn(); const waitForCompactionRetry = vi.fn(async () => await new Promise(() => {})); + const params = buildAggregateTimeoutParams({ + waitForCompactionRetry, + abortable: async () => { + throw abortError; + }, + }); - await expect( - waitForCompactionRetryWithAggregateTimeout({ - waitForCompactionRetry, - abortable: async () => { - throw abortError; - }, - aggregateTimeoutMs: 60_000, - onTimeout, - }), - ).rejects.toThrow("aborted"); + await expect(waitForCompactionRetryWithAggregateTimeout(params)).rejects.toThrow("aborted"); - expectClearedTimeoutState(onTimeout, false); + expectClearedTimeoutState(params.onTimeout, false); }); }); }); From e4287e0938e80a0ca410380edffaaba373d0f2b1 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:27:52 +0000 Subject: [PATCH 146/187] refactor(compaction-tests): share snapshot assertions --- .../run/compaction-timeout.test.ts | 40 +++++++++++++++---- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/compaction-timeout.test.ts b/src/agents/pi-embedded-runner/run/compaction-timeout.test.ts index 3853e0ebd25..54d6320297c 100644 --- a/src/agents/pi-embedded-runner/run/compaction-timeout.test.ts +++ b/src/agents/pi-embedded-runner/run/compaction-timeout.test.ts @@ -7,6 +7,30 @@ import { shouldFlagCompactionTimeout, } from "./compaction-timeout.js"; +function expectSelectedSnapshot(params: { + currentSessionId: string; + currentSnapshot: Parameters[0]["currentSnapshot"]; + expectedSessionIdUsed: string; + expectedSnapshot: ReadonlyArray>; + expectedSource: "current" | "pre-compaction"; + preCompactionSessionId: string; + preCompactionSnapshot: Parameters< + typeof selectCompactionTimeoutSnapshot + >[0]["preCompactionSnapshot"]; + timedOutDuringCompaction: boolean; +}) { + const selected = selectCompactionTimeoutSnapshot({ + timedOutDuringCompaction: params.timedOutDuringCompaction, + preCompactionSnapshot: params.preCompactionSnapshot, + preCompactionSessionId: params.preCompactionSessionId, + currentSnapshot: params.currentSnapshot, + currentSessionId: params.currentSessionId, + }); + expect(selected.source).toBe(params.expectedSource); + expect(selected.sessionIdUsed).toBe(params.expectedSessionIdUsed); + expect(selected.messagesSnapshot).toEqual(params.expectedSnapshot); +} + describe("compaction-timeout helpers", () => { it("flags compaction timeout consistently for internal and external timeout sources", () => { const internalTimer = shouldFlagCompactionTimeout({ @@ -75,29 +99,29 @@ describe("compaction-timeout helpers", () => { it("uses pre-compaction snapshot when compaction timeout occurs", () => { const pre = [castAgentMessage({ role: "assistant", content: "pre" })] as const; const current = [castAgentMessage({ role: "assistant", content: "current" })] as const; - const selected = selectCompactionTimeoutSnapshot({ + expectSelectedSnapshot({ timedOutDuringCompaction: true, preCompactionSnapshot: [...pre], preCompactionSessionId: "session-pre", currentSnapshot: [...current], currentSessionId: "session-current", + expectedSource: "pre-compaction", + expectedSessionIdUsed: "session-pre", + expectedSnapshot: pre, }); - expect(selected.source).toBe("pre-compaction"); - expect(selected.sessionIdUsed).toBe("session-pre"); - expect(selected.messagesSnapshot).toEqual(pre); }); it("falls back to current snapshot when pre-compaction snapshot is unavailable", () => { const current = [castAgentMessage({ role: "assistant", content: "current" })] as const; - const selected = selectCompactionTimeoutSnapshot({ + expectSelectedSnapshot({ timedOutDuringCompaction: true, preCompactionSnapshot: null, preCompactionSessionId: "session-pre", currentSnapshot: [...current], currentSessionId: "session-current", + expectedSource: "current", + expectedSessionIdUsed: "session-current", + expectedSnapshot: current, }); - expect(selected.source).toBe("current"); - expect(selected.sessionIdUsed).toBe("session-current"); - expect(selected.messagesSnapshot).toEqual(current); }); }); From 528edce5b96636358ee352d41d4098f47a148279 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:29:02 +0000 Subject: [PATCH 147/187] refactor(truncation-tests): share first tool result text helper --- .../tool-result-truncation.test.ts | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/src/agents/pi-embedded-runner/tool-result-truncation.test.ts b/src/agents/pi-embedded-runner/tool-result-truncation.test.ts index 2dce36ed076..b65ed0a65e8 100644 --- a/src/agents/pi-embedded-runner/tool-result-truncation.test.ts +++ b/src/agents/pi-embedded-runner/tool-result-truncation.test.ts @@ -44,6 +44,14 @@ function makeAssistantMessage(text: string): AssistantMessage { }); } +function getFirstToolResultText(message: AgentMessage | ToolResultMessage): string { + if (message.role !== "toolResult") { + return ""; + } + const firstBlock = message.content[0]; + return firstBlock && "text" in firstBlock ? firstBlock.text : ""; +} + describe("truncateToolResultText", () => { it("returns text unchanged when under limit", () => { const text = "hello world"; @@ -134,12 +142,7 @@ describe("truncateToolResultMessage", () => { if (result.role !== "toolResult") { throw new Error("expected toolResult"); } - - const firstBlock = result.content[0]; - expect(firstBlock?.type).toBe("text"); - expect(firstBlock && "text" in firstBlock ? firstBlock.text : "").toContain( - "[persist-truncated]", - ); + expect(getFirstToolResultText(result)).toContain("[persist-truncated]"); }); }); @@ -209,10 +212,7 @@ describe("truncateOversizedToolResultsInMessages", () => { expect(truncatedCount).toBe(1); const toolResult = result[2]; expect(toolResult?.role).toBe("toolResult"); - const firstBlock = - toolResult && toolResult.role === "toolResult" ? toolResult.content[0] : undefined; - expect(firstBlock?.type).toBe("text"); - const text = firstBlock && "text" in firstBlock ? firstBlock.text : ""; + const text = toolResult ? getFirstToolResultText(toolResult) : ""; expect(text.length).toBeLessThan(bigContent.length); expect(text).toContain("truncated"); }); @@ -242,8 +242,7 @@ describe("truncateOversizedToolResultsInMessages", () => { expect(truncatedCount).toBe(2); for (const msg of result.slice(2)) { expect(msg.role).toBe("toolResult"); - const firstBlock = msg.role === "toolResult" ? msg.content[0] : undefined; - const text = firstBlock && "text" in firstBlock ? firstBlock.text : ""; + const text = getFirstToolResultText(msg); expect(text.length).toBeLessThan(500_000); } }); From 38616c7c9566a88bea5f486bb27b6cfacfdaebae Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:30:07 +0000 Subject: [PATCH 148/187] refactor(system-prompt-tests): share session setup helper --- .../pi-embedded-runner/system-prompt.test.ts | 36 ++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/src/agents/pi-embedded-runner/system-prompt.test.ts b/src/agents/pi-embedded-runner/system-prompt.test.ts index 355b2c67ae9..8e20a95bda7 100644 --- a/src/agents/pi-embedded-runner/system-prompt.test.ts +++ b/src/agents/pi-embedded-runner/system-prompt.test.ts @@ -2,6 +2,11 @@ import type { AgentSession } from "@mariozechner/pi-coding-agent"; import { describe, expect, it, vi } from "vitest"; import { applySystemPromptOverrideToSession, createSystemPromptOverride } from "./system-prompt.js"; +type MutableSession = AgentSession & { + _baseSystemPrompt?: string; + _rebuildSystemPrompt?: (toolNames: string[]) => string; +}; + function createMockSession() { const setSystemPrompt = vi.fn(); const session = { @@ -10,42 +15,41 @@ function createMockSession() { return { session, setSystemPrompt }; } +function applyAndGetMutableSession( + prompt: Parameters[1], +) { + const { session, setSystemPrompt } = createMockSession(); + applySystemPromptOverrideToSession(session, prompt); + return { + mutable: session as MutableSession, + setSystemPrompt, + }; +} + describe("applySystemPromptOverrideToSession", () => { it("applies a string override to the session system prompt", () => { - const { session, setSystemPrompt } = createMockSession(); const prompt = "You are a helpful assistant with custom context."; - - applySystemPromptOverrideToSession(session, prompt); + const { mutable, setSystemPrompt } = applyAndGetMutableSession(prompt); expect(setSystemPrompt).toHaveBeenCalledWith(prompt); - const mutable = session as unknown as { _baseSystemPrompt?: string }; expect(mutable._baseSystemPrompt).toBe(prompt); }); it("trims whitespace from string overrides", () => { - const { session, setSystemPrompt } = createMockSession(); - - applySystemPromptOverrideToSession(session, " padded prompt "); + const { setSystemPrompt } = applyAndGetMutableSession(" padded prompt "); expect(setSystemPrompt).toHaveBeenCalledWith("padded prompt"); }); it("applies a function override to the session system prompt", () => { - const { session, setSystemPrompt } = createMockSession(); const override = createSystemPromptOverride("function-based prompt"); - - applySystemPromptOverrideToSession(session, override); + const { setSystemPrompt } = applyAndGetMutableSession(override); expect(setSystemPrompt).toHaveBeenCalledWith("function-based prompt"); }); it("sets _rebuildSystemPrompt that returns the override", () => { - const { session } = createMockSession(); - applySystemPromptOverrideToSession(session, "rebuild test"); - - const mutable = session as unknown as { - _rebuildSystemPrompt?: (toolNames: string[]) => string; - }; + const { mutable } = applyAndGetMutableSession("rebuild test"); expect(mutable._rebuildSystemPrompt?.(["tool1"])).toBe("rebuild test"); }); }); From ef0812beff4535e1dce1164628f43cd1679f51f7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:31:16 +0000 Subject: [PATCH 149/187] refactor(lanes-tests): share table-driven assertions --- src/agents/pi-embedded-runner/lanes.test.ts | 42 +++++++++++++-------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/src/agents/pi-embedded-runner/lanes.test.ts b/src/agents/pi-embedded-runner/lanes.test.ts index f3625ddc6ec..c0294dd5b9d 100644 --- a/src/agents/pi-embedded-runner/lanes.test.ts +++ b/src/agents/pi-embedded-runner/lanes.test.ts @@ -5,40 +5,52 @@ import { resolveGlobalLane, resolveSessionLane } from "./lanes.js"; describe("resolveGlobalLane", () => { it("defaults to main lane when no lane is provided", () => { expect(resolveGlobalLane()).toBe(CommandLane.Main); - expect(resolveGlobalLane("")).toBe(CommandLane.Main); - expect(resolveGlobalLane(" ")).toBe(CommandLane.Main); + for (const lane of ["", " "]) { + expect(resolveGlobalLane(lane)).toBe(CommandLane.Main); + } }); it("maps cron lane to nested lane to prevent deadlocks", () => { // When cron jobs trigger nested agent runs, the outer execution holds // the cron lane slot. Inner work must use a separate lane to avoid // deadlock. See: https://github.com/openclaw/openclaw/issues/44805 - expect(resolveGlobalLane("cron")).toBe(CommandLane.Nested); - expect(resolveGlobalLane(" cron ")).toBe(CommandLane.Nested); + for (const lane of ["cron", " cron "]) { + expect(resolveGlobalLane(lane)).toBe(CommandLane.Nested); + } }); it("preserves other lanes as-is", () => { - expect(resolveGlobalLane("main")).toBe(CommandLane.Main); - expect(resolveGlobalLane("subagent")).toBe(CommandLane.Subagent); - expect(resolveGlobalLane("nested")).toBe(CommandLane.Nested); - expect(resolveGlobalLane("custom-lane")).toBe("custom-lane"); - expect(resolveGlobalLane(" custom ")).toBe("custom"); + for (const [lane, expected] of [ + ["main", CommandLane.Main], + ["subagent", CommandLane.Subagent], + ["nested", CommandLane.Nested], + ["custom-lane", "custom-lane"], + [" custom ", "custom"], + ] as const) { + expect(resolveGlobalLane(lane)).toBe(expected); + } }); }); describe("resolveSessionLane", () => { it("defaults to main lane and prefixes with session:", () => { - expect(resolveSessionLane("")).toBe("session:main"); - expect(resolveSessionLane(" ")).toBe("session:main"); + for (const lane of ["", " "]) { + expect(resolveSessionLane(lane)).toBe("session:main"); + } }); it("adds session: prefix if not present", () => { - expect(resolveSessionLane("abc123")).toBe("session:abc123"); - expect(resolveSessionLane(" xyz ")).toBe("session:xyz"); + for (const [lane, expected] of [ + ["abc123", "session:abc123"], + [" xyz ", "session:xyz"], + ] as const) { + expect(resolveSessionLane(lane)).toBe(expected); + } }); it("preserves existing session: prefix", () => { - expect(resolveSessionLane("session:abc")).toBe("session:abc"); - expect(resolveSessionLane("session:main")).toBe("session:main"); + for (const lane of ["session:abc", "session:main"]) { + expect(resolveSessionLane(lane)).toBe(lane); + } }); }); From 58f6362921893067c716600e033b7ad8c0371b6f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:33:42 +0000 Subject: [PATCH 150/187] refactor(google-tests): share schema tool fixture --- src/agents/pi-embedded-runner/google.test.ts | 34 ++++++++------------ 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/src/agents/pi-embedded-runner/google.test.ts b/src/agents/pi-embedded-runner/google.test.ts index d0a04665c68..efea86819b2 100644 --- a/src/agents/pi-embedded-runner/google.test.ts +++ b/src/agents/pi-embedded-runner/google.test.ts @@ -11,6 +11,18 @@ describe("sanitizeToolsForGoogle", () => { execute: async () => ({ ok: true, content: [] }), }) as unknown as AgentTool; + const createSchemaToolWithFormat = () => + createTool({ + type: "object", + additionalProperties: false, + properties: { + foo: { + type: "string", + format: "uuid", + }, + }, + }); + const expectFormatRemoved = ( sanitized: AgentTool, key: "additionalProperties" | "patternProperties", @@ -25,16 +37,7 @@ describe("sanitizeToolsForGoogle", () => { }; it("strips unsupported schema keywords for Google providers", () => { - const tool = createTool({ - type: "object", - additionalProperties: false, - properties: { - foo: { - type: "string", - format: "uuid", - }, - }, - }); + const tool = createSchemaToolWithFormat(); const [sanitized] = sanitizeToolsForGoogle({ tools: [tool], provider: "google-gemini-cli", @@ -43,16 +46,7 @@ describe("sanitizeToolsForGoogle", () => { }); it("returns original tools for non-google providers", () => { - const tool = createTool({ - type: "object", - additionalProperties: false, - properties: { - foo: { - type: "string", - format: "uuid", - }, - }, - }); + const tool = createSchemaToolWithFormat(); const sanitized = sanitizeToolsForGoogle({ tools: [tool], provider: "openai", From bb13dd0c01a88c7ae3b3fc2966d33d00bbd3b9b3 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:34:53 +0000 Subject: [PATCH 151/187] refactor(extension-tests): share safeguard factory setup --- .../pi-embedded-runner/extensions.test.ts | 46 ++++++++----------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/src/agents/pi-embedded-runner/extensions.test.ts b/src/agents/pi-embedded-runner/extensions.test.ts index ff95a0b2dee..948d96bd9df 100644 --- a/src/agents/pi-embedded-runner/extensions.test.ts +++ b/src/agents/pi-embedded-runner/extensions.test.ts @@ -6,13 +6,26 @@ import { getCompactionSafeguardRuntime } from "../pi-extensions/compaction-safeg import compactionSafeguardExtension from "../pi-extensions/compaction-safeguard.js"; import { buildEmbeddedExtensionFactories } from "./extensions.js"; +function buildSafeguardFactories(cfg: OpenClawConfig) { + const sessionManager = {} as SessionManager; + const model = { + id: "claude-sonnet-4-20250514", + contextWindow: 200_000, + } as Model; + + const factories = buildEmbeddedExtensionFactories({ + cfg, + sessionManager, + provider: "anthropic", + modelId: "claude-sonnet-4-20250514", + model, + }); + + return { factories, sessionManager }; +} + describe("buildEmbeddedExtensionFactories", () => { it("does not opt safeguard mode into quality-guard retries", () => { - const sessionManager = {} as SessionManager; - const model = { - id: "claude-sonnet-4-20250514", - contextWindow: 200_000, - } as Model; const cfg = { agents: { defaults: { @@ -22,14 +35,7 @@ describe("buildEmbeddedExtensionFactories", () => { }, }, } as OpenClawConfig; - - const factories = buildEmbeddedExtensionFactories({ - cfg, - sessionManager, - provider: "anthropic", - modelId: "claude-sonnet-4-20250514", - model, - }); + const { factories, sessionManager } = buildSafeguardFactories(cfg); expect(factories).toContain(compactionSafeguardExtension); expect(getCompactionSafeguardRuntime(sessionManager)).toMatchObject({ @@ -38,11 +44,6 @@ describe("buildEmbeddedExtensionFactories", () => { }); it("wires explicit safeguard quality-guard runtime flags", () => { - const sessionManager = {} as SessionManager; - const model = { - id: "claude-sonnet-4-20250514", - contextWindow: 200_000, - } as Model; const cfg = { agents: { defaults: { @@ -56,14 +57,7 @@ describe("buildEmbeddedExtensionFactories", () => { }, }, } as OpenClawConfig; - - const factories = buildEmbeddedExtensionFactories({ - cfg, - sessionManager, - provider: "anthropic", - modelId: "claude-sonnet-4-20250514", - model, - }); + const { factories, sessionManager } = buildSafeguardFactories(cfg); expect(factories).toContain(compactionSafeguardExtension); expect(getCompactionSafeguardRuntime(sessionManager)).toMatchObject({ From 68f3e537d313e81ad4278b4624cc6fd9448f852e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:36:15 +0000 Subject: [PATCH 152/187] refactor(openrouter-tests): share state dir helper --- .../openrouter-model-capabilities.test.ts | 140 +++++++++--------- 1 file changed, 69 insertions(+), 71 deletions(-) diff --git a/src/agents/pi-embedded-runner/openrouter-model-capabilities.test.ts b/src/agents/pi-embedded-runner/openrouter-model-capabilities.test.ts index aa830c13d4d..a2bca6a30e4 100644 --- a/src/agents/pi-embedded-runner/openrouter-model-capabilities.test.ts +++ b/src/agents/pi-embedded-runner/openrouter-model-capabilities.test.ts @@ -3,6 +3,16 @@ import { tmpdir } from "node:os"; import { join } from "node:path"; import { afterEach, describe, expect, it, vi } from "vitest"; +async function withOpenRouterStateDir(run: (stateDir: string) => Promise) { + const stateDir = mkdtempSync(join(tmpdir(), "openclaw-openrouter-capabilities-")); + process.env.OPENCLAW_STATE_DIR = stateDir; + try { + await run(stateDir); + } finally { + rmSync(stateDir, { recursive: true, force: true }); + } +} + describe("openrouter-model-capabilities", () => { afterEach(() => { vi.resetModules(); @@ -11,46 +21,42 @@ describe("openrouter-model-capabilities", () => { }); it("uses top-level OpenRouter max token fields when top_provider is absent", async () => { - const stateDir = mkdtempSync(join(tmpdir(), "openclaw-openrouter-capabilities-")); - process.env.OPENCLAW_STATE_DIR = stateDir; + await withOpenRouterStateDir(async () => { + vi.stubGlobal( + "fetch", + vi.fn( + async () => + new Response( + JSON.stringify({ + data: [ + { + id: "acme/top-level-max-completion", + name: "Top Level Max Completion", + architecture: { modality: "text+image->text" }, + supported_parameters: ["reasoning"], + context_length: 65432, + max_completion_tokens: 12345, + pricing: { prompt: "0.000001", completion: "0.000002" }, + }, + { + id: "acme/top-level-max-output", + name: "Top Level Max Output", + modality: "text+image->text", + context_length: 54321, + max_output_tokens: 23456, + pricing: { prompt: "0.000003", completion: "0.000004" }, + }, + ], + }), + { + status: 200, + headers: { "content-type": "application/json" }, + }, + ), + ), + ); - vi.stubGlobal( - "fetch", - vi.fn( - async () => - new Response( - JSON.stringify({ - data: [ - { - id: "acme/top-level-max-completion", - name: "Top Level Max Completion", - architecture: { modality: "text+image->text" }, - supported_parameters: ["reasoning"], - context_length: 65432, - max_completion_tokens: 12345, - pricing: { prompt: "0.000001", completion: "0.000002" }, - }, - { - id: "acme/top-level-max-output", - name: "Top Level Max Output", - modality: "text+image->text", - context_length: 54321, - max_output_tokens: 23456, - pricing: { prompt: "0.000003", completion: "0.000004" }, - }, - ], - }), - { - status: 200, - headers: { "content-type": "application/json" }, - }, - ), - ), - ); - - const module = await import("./openrouter-model-capabilities.js"); - - try { + const module = await import("./openrouter-model-capabilities.js"); await module.loadOpenRouterModelCapabilities("acme/top-level-max-completion"); expect(module.getOpenRouterModelCapabilities("acme/top-level-max-completion")).toMatchObject({ @@ -65,47 +71,39 @@ describe("openrouter-model-capabilities", () => { contextWindow: 54321, maxTokens: 23456, }); - } finally { - rmSync(stateDir, { recursive: true, force: true }); - } + }); }); it("does not refetch immediately after an awaited miss for the same model id", async () => { - const stateDir = mkdtempSync(join(tmpdir(), "openclaw-openrouter-capabilities-")); - process.env.OPENCLAW_STATE_DIR = stateDir; + await withOpenRouterStateDir(async () => { + const fetchSpy = vi.fn( + async () => + new Response( + JSON.stringify({ + data: [ + { + id: "acme/known-model", + name: "Known Model", + architecture: { modality: "text->text" }, + context_length: 1234, + }, + ], + }), + { + status: 200, + headers: { "content-type": "application/json" }, + }, + ), + ); + vi.stubGlobal("fetch", fetchSpy); - const fetchSpy = vi.fn( - async () => - new Response( - JSON.stringify({ - data: [ - { - id: "acme/known-model", - name: "Known Model", - architecture: { modality: "text->text" }, - context_length: 1234, - }, - ], - }), - { - status: 200, - headers: { "content-type": "application/json" }, - }, - ), - ); - vi.stubGlobal("fetch", fetchSpy); - - const module = await import("./openrouter-model-capabilities.js"); - - try { + const module = await import("./openrouter-model-capabilities.js"); await module.loadOpenRouterModelCapabilities("acme/missing-model"); expect(module.getOpenRouterModelCapabilities("acme/missing-model")).toBeUndefined(); expect(fetchSpy).toHaveBeenCalledTimes(1); expect(module.getOpenRouterModelCapabilities("acme/missing-model")).toBeUndefined(); expect(fetchSpy).toHaveBeenCalledTimes(2); - } finally { - rmSync(stateDir, { recursive: true, force: true }); - } + }); }); }); From 0956de731653490e67a96b9111caa85616a65d0d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:37:36 +0000 Subject: [PATCH 153/187] refactor(thinking-tests): share assistant drop helper --- .../pi-embedded-runner/thinking.test.ts | 44 ++++++++++--------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/src/agents/pi-embedded-runner/thinking.test.ts b/src/agents/pi-embedded-runner/thinking.test.ts index 6a2481748a1..e3d0a8291b6 100644 --- a/src/agents/pi-embedded-runner/thinking.test.ts +++ b/src/agents/pi-embedded-runner/thinking.test.ts @@ -3,6 +3,22 @@ import { describe, expect, it } from "vitest"; import { castAgentMessage } from "../test-helpers/agent-message-fixtures.js"; import { dropThinkingBlocks, isAssistantMessageWithContent } from "./thinking.js"; +function dropSingleAssistantContent(content: Array>) { + const messages: AgentMessage[] = [ + castAgentMessage({ + role: "assistant", + content, + }), + ]; + + const result = dropThinkingBlocks(messages); + return { + assistant: result[0] as Extract, + messages, + result, + }; +} + describe("isAssistantMessageWithContent", () => { it("accepts assistant messages with array content and rejects others", () => { const assistant = castAgentMessage({ @@ -30,32 +46,18 @@ describe("dropThinkingBlocks", () => { }); it("drops thinking blocks while preserving non-thinking assistant content", () => { - const messages: AgentMessage[] = [ - castAgentMessage({ - role: "assistant", - content: [ - { type: "thinking", thinking: "internal" }, - { type: "text", text: "final" }, - ], - }), - ]; - - const result = dropThinkingBlocks(messages); - const assistant = result[0] as Extract; + const { assistant, messages, result } = dropSingleAssistantContent([ + { type: "thinking", thinking: "internal" }, + { type: "text", text: "final" }, + ]); expect(result).not.toBe(messages); expect(assistant.content).toEqual([{ type: "text", text: "final" }]); }); it("keeps assistant turn structure when all content blocks were thinking", () => { - const messages: AgentMessage[] = [ - castAgentMessage({ - role: "assistant", - content: [{ type: "thinking", thinking: "internal-only" }], - }), - ]; - - const result = dropThinkingBlocks(messages); - const assistant = result[0] as Extract; + const { assistant } = dropSingleAssistantContent([ + { type: "thinking", thinking: "internal-only" }, + ]); expect(assistant.content).toEqual([{ type: "text", text: "" }]); }); }); From be6716c7aa50b88e5de3467117393a01fbc6041b Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:38:49 +0000 Subject: [PATCH 154/187] refactor(kilocode-tests): share eligibility assertions --- src/agents/pi-embedded-runner/kilocode.test.ts | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/agents/pi-embedded-runner/kilocode.test.ts b/src/agents/pi-embedded-runner/kilocode.test.ts index cbb626d8ba7..71b84f06e32 100644 --- a/src/agents/pi-embedded-runner/kilocode.test.ts +++ b/src/agents/pi-embedded-runner/kilocode.test.ts @@ -2,12 +2,10 @@ import { describe, expect, it } from "vitest"; import { isCacheTtlEligibleProvider } from "./cache-ttl.js"; describe("kilocode cache-ttl eligibility", () => { - it("is eligible when model starts with anthropic/", () => { - expect(isCacheTtlEligibleProvider("kilocode", "anthropic/claude-opus-4.6")).toBe(true); - }); - - it("is eligible with other anthropic models", () => { - expect(isCacheTtlEligibleProvider("kilocode", "anthropic/claude-sonnet-4")).toBe(true); + it("allows anthropic models", () => { + for (const modelId of ["anthropic/claude-opus-4.6", "anthropic/claude-sonnet-4"] as const) { + expect(isCacheTtlEligibleProvider("kilocode", modelId)).toBe(true); + } }); it("is not eligible for non-anthropic models on kilocode", () => { @@ -15,7 +13,11 @@ describe("kilocode cache-ttl eligibility", () => { }); it("is case-insensitive for provider name", () => { - expect(isCacheTtlEligibleProvider("Kilocode", "anthropic/claude-opus-4.6")).toBe(true); - expect(isCacheTtlEligibleProvider("KILOCODE", "Anthropic/claude-opus-4.6")).toBe(true); + for (const [provider, modelId] of [ + ["Kilocode", "anthropic/claude-opus-4.6"], + ["KILOCODE", "Anthropic/claude-opus-4.6"], + ] as const) { + expect(isCacheTtlEligibleProvider(provider, modelId)).toBe(true); + } }); }); From 9c1e9c5263c51be6e32a3ed169be2d0a4a0859e6 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:39:44 +0000 Subject: [PATCH 155/187] refactor(payload-tests): share empty payload helper --- .../pi-embedded-runner/run/payloads.test.ts | 21 ++++++++----------- 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.test.ts b/src/agents/pi-embedded-runner/run/payloads.test.ts index 6c81fb12150..52a88368c50 100644 --- a/src/agents/pi-embedded-runner/run/payloads.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.test.ts @@ -2,13 +2,16 @@ import { describe, expect, it } from "vitest"; import { buildPayloads, expectSingleToolErrorPayload } from "./payloads.test-helpers.js"; describe("buildEmbeddedRunPayloads tool-error warnings", () => { + function expectNoPayloads(params: Parameters[0]) { + const payloads = buildPayloads(params); + expect(payloads).toHaveLength(0); + } + it("suppresses exec tool errors when verbose mode is off", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "exec", error: "command failed" }, verboseLevel: "off", }); - - expect(payloads).toHaveLength(0); }); it("shows exec tool errors when verbose mode is on", () => { @@ -62,16 +65,14 @@ describe("buildEmbeddedRunPayloads tool-error warnings", () => { }); it("suppresses sessions_send errors to avoid leaking transient relay failures", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "sessions_send", error: "delivery timeout" }, verboseLevel: "on", }); - - expect(payloads).toHaveLength(0); }); it("suppresses sessions_send errors even when marked mutating", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "sessions_send", error: "delivery timeout", @@ -79,16 +80,12 @@ describe("buildEmbeddedRunPayloads tool-error warnings", () => { }, verboseLevel: "on", }); - - expect(payloads).toHaveLength(0); }); it("suppresses assistant text when a deterministic exec approval prompt was already delivered", () => { - const payloads = buildPayloads({ + expectNoPayloads({ assistantTexts: ["Approval is needed. Please run /approve abc allow-once"], didSendDeterministicApprovalPrompt: true, }); - - expect(payloads).toHaveLength(0); }); }); From 7d90dff8fac5d2c5c11f86a3c3c9d818a9a04ac9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:41:00 +0000 Subject: [PATCH 156/187] refactor(model-tests): share template model mock helper --- .../pi-embedded-runner/model.test-harness.ts | 32 +++++++++++-------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/src/agents/pi-embedded-runner/model.test-harness.ts b/src/agents/pi-embedded-runner/model.test-harness.ts index 21434557c79..b91ca8b8c5f 100644 --- a/src/agents/pi-embedded-runner/model.test-harness.ts +++ b/src/agents/pi-embedded-runner/model.test-harness.ts @@ -25,14 +25,18 @@ export const OPENAI_CODEX_TEMPLATE_MODEL = { maxTokens: 128000, }; -export function mockOpenAICodexTemplateModel(): void { +function mockTemplateModel(provider: string, modelId: string, templateModel: unknown): void { mockDiscoveredModel({ - provider: "openai-codex", - modelId: "gpt-5.2-codex", - templateModel: OPENAI_CODEX_TEMPLATE_MODEL, + provider, + modelId, + templateModel, }); } +export function mockOpenAICodexTemplateModel(): void { + mockTemplateModel("openai-codex", "gpt-5.2-codex", OPENAI_CODEX_TEMPLATE_MODEL); +} + export function buildOpenAICodexForwardCompatExpectation( id: string = "gpt-5.3-codex", ): Partial & { @@ -85,19 +89,19 @@ export const GOOGLE_GEMINI_CLI_FLASH_TEMPLATE_MODEL = { }; export function mockGoogleGeminiCliProTemplateModel(): void { - mockDiscoveredModel({ - provider: "google-gemini-cli", - modelId: "gemini-3-pro-preview", - templateModel: GOOGLE_GEMINI_CLI_PRO_TEMPLATE_MODEL, - }); + mockTemplateModel( + "google-gemini-cli", + "gemini-3-pro-preview", + GOOGLE_GEMINI_CLI_PRO_TEMPLATE_MODEL, + ); } export function mockGoogleGeminiCliFlashTemplateModel(): void { - mockDiscoveredModel({ - provider: "google-gemini-cli", - modelId: "gemini-3-flash-preview", - templateModel: GOOGLE_GEMINI_CLI_FLASH_TEMPLATE_MODEL, - }); + mockTemplateModel( + "google-gemini-cli", + "gemini-3-flash-preview", + GOOGLE_GEMINI_CLI_FLASH_TEMPLATE_MODEL, + ); } export function resetMockDiscoverModels(): void { From c0e4721712f3783108286a34d5257bd72b9e4122 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:42:18 +0000 Subject: [PATCH 157/187] refactor(image-tests): share empty prompt image assertions --- src/agents/pi-embedded-runner/run/images.test.ts | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/images.test.ts b/src/agents/pi-embedded-runner/run/images.test.ts index 8a879a1bb36..305290df323 100644 --- a/src/agents/pi-embedded-runner/run/images.test.ts +++ b/src/agents/pi-embedded-runner/run/images.test.ts @@ -11,6 +11,11 @@ import { modelSupportsImages, } from "./images.js"; +function expectNoPromptImages(result: { detectedRefs: unknown[]; images: unknown[] }) { + expect(result.detectedRefs).toHaveLength(0); + expect(result.images).toHaveLength(0); +} + describe("detectImageReferences", () => { it("detects absolute file paths with common extensions", () => { const prompt = "Check this image /path/to/screenshot.png and tell me what you see"; @@ -262,8 +267,7 @@ describe("detectAndLoadPromptImages", () => { existingImages: [{ type: "image", data: "abc", mimeType: "image/png" }], }); - expect(result.images).toHaveLength(0); - expect(result.detectedRefs).toHaveLength(0); + expectNoPromptImages(result); }); it("returns no detected refs when prompt has no image references", async () => { @@ -273,8 +277,7 @@ describe("detectAndLoadPromptImages", () => { model: { input: ["text", "image"] }, }); - expect(result.detectedRefs).toHaveLength(0); - expect(result.images).toHaveLength(0); + expectNoPromptImages(result); }); it("blocks prompt image refs outside workspace when sandbox workspaceOnly is enabled", async () => { From 449127b47407167764fbfb2602bfeb8765d34efe Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:47:17 +0000 Subject: [PATCH 158/187] fix: restore full gate --- docs/.generated/config-baseline.json | 215 +++++++++++++++- docs/.generated/config-baseline.jsonl | 24 +- extensions/feishu/src/bot.card-action.test.ts | 2 +- package.json | 4 + scripts/lib/plugin-sdk-entrypoints.json | 1 + scripts/release-check.ts | 59 +++-- .../extra-params.kilocode.test.ts | 8 +- .../extra-params.zai-tool-stream.test.ts | 2 +- .../contracts/inbound.contract.test.ts | 243 +++++++----------- ...command-secret-resolution.coverage.test.ts | 15 +- src/commands/status.scan.deps.runtime.ts | 4 +- src/infra/provider-usage.test-support.ts | 6 +- src/memory/manager.async-search.test.ts | 3 + .../channel-import-guardrails.test.ts | 4 - src/plugin-sdk/index.ts | 2 + src/plugin-sdk/plugin-runtime.ts | 2 + src/plugins/interactive.test.ts | 49 +++- src/plugins/status.test.ts | 6 +- 18 files changed, 447 insertions(+), 202 deletions(-) diff --git a/docs/.generated/config-baseline.json b/docs/.generated/config-baseline.json index f0ba41b420d..1efe91f11a7 100644 --- a/docs/.generated/config-baseline.json +++ b/docs/.generated/config-baseline.json @@ -1754,6 +1754,58 @@ "help": "Delay style for block replies (\"off\", \"natural\", \"custom\").", "hasChildren": false }, + { + "path": "agents.defaults.imageGenerationModel", + "kind": "core", + "type": [ + "object", + "string" + ], + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "agents.defaults.imageGenerationModel.fallbacks", + "kind": "core", + "type": "array", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "media", + "reliability" + ], + "label": "Image Generation Model Fallbacks", + "help": "Ordered fallback image-generation models (provider/model).", + "hasChildren": true + }, + { + "path": "agents.defaults.imageGenerationModel.fallbacks.*", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "agents.defaults.imageGenerationModel.primary", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "media" + ], + "label": "Image Generation Model", + "help": "Optional image-generation model (provider/model) used by the shared image generation capability.", + "hasChildren": false + }, { "path": "agents.defaults.imageMaxDimensionPx", "kind": "core", @@ -38212,6 +38264,20 @@ "help": "Allow /debug chat command for runtime-only overrides (default: false).", "hasChildren": false }, + { + "path": "commands.mcp", + "kind": "core", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Allow /mcp", + "help": "Allow /mcp chat command to manage OpenClaw MCP server config under mcp.servers (default: false).", + "hasChildren": false + }, { "path": "commands.native", "kind": "core", @@ -38308,6 +38374,20 @@ "help": "Optional secret used to HMAC hash owner IDs when ownerDisplay=hash. Prefer env substitution.", "hasChildren": false }, + { + "path": "commands.plugins", + "kind": "core", + "type": "boolean", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "Allow /plugins", + "help": "Allow /plugins chat command to list discovered plugins and toggle plugin enablement in config (default: false).", + "hasChildren": false + }, { "path": "commands.restart", "kind": "core", @@ -39846,7 +39926,7 @@ "network" ], "label": "OpenAI Chat Completions Allow Image URLs", - "help": "Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported).", + "help": "Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported). Set this to `false` to disable URL fetching entirely.", "hasChildren": false }, { @@ -39911,7 +39991,7 @@ "network" ], "label": "OpenAI Chat Completions Image URL Allowlist", - "help": "Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards.", + "help": "Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards. Empty or omitted lists mean no hostname allowlist restriction.", "hasChildren": true }, { @@ -42214,6 +42294,137 @@ "help": "Sensitive redaction mode: \"off\" disables built-in masking, while \"tools\" redacts sensitive tool/config payload fields. Keep \"tools\" in shared logs unless you have isolated secure log sinks.", "hasChildren": false }, + { + "path": "mcp", + "kind": "core", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "MCP", + "help": "Global MCP server definitions managed by OpenClaw. Embedded Pi and other runtime adapters can consume these servers without storing them inside Pi-owned project settings.", + "hasChildren": true + }, + { + "path": "mcp.servers", + "kind": "core", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [ + "advanced" + ], + "label": "MCP Servers", + "help": "Named MCP server definitions. OpenClaw stores them in its own config and runtime adapters decide which transports are supported at execution time.", + "hasChildren": true + }, + { + "path": "mcp.servers.*", + "kind": "core", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "mcp.servers.*.*", + "kind": "core", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.args", + "kind": "core", + "type": "array", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "mcp.servers.*.args.*", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.command", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.cwd", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.env", + "kind": "core", + "type": "object", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": true + }, + { + "path": "mcp.servers.*.env.*", + "kind": "core", + "type": [ + "boolean", + "number", + "string" + ], + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.url", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, + { + "path": "mcp.servers.*.workingDirectory", + "kind": "core", + "type": "string", + "required": false, + "deprecated": false, + "sensitive": false, + "tags": [], + "hasChildren": false + }, { "path": "media", "kind": "core", diff --git a/docs/.generated/config-baseline.jsonl b/docs/.generated/config-baseline.jsonl index 9ff81282d7d..caf0e22623c 100644 --- a/docs/.generated/config-baseline.jsonl +++ b/docs/.generated/config-baseline.jsonl @@ -1,4 +1,4 @@ -{"generatedBy":"scripts/generate-config-doc-baseline.ts","recordType":"meta","totalPaths":5147} +{"generatedBy":"scripts/generate-config-doc-baseline.ts","recordType":"meta","totalPaths":5165} {"recordType":"path","path":"acp","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"ACP","help":"ACP runtime controls for enabling dispatch, selecting backends, constraining allowed agent targets, and tuning streamed turn projection behavior.","hasChildren":true} {"recordType":"path","path":"acp.allowedAgents","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"ACP Allowed Agents","help":"Allowlist of ACP target agent ids permitted for ACP runtime sessions. Empty means no additional allowlist restriction.","hasChildren":true} {"recordType":"path","path":"acp.allowedAgents.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} @@ -150,6 +150,10 @@ {"recordType":"path","path":"agents.defaults.humanDelay.maxMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["performance"],"label":"Human Delay Max (ms)","help":"Maximum delay in ms for custom humanDelay (default: 2500).","hasChildren":false} {"recordType":"path","path":"agents.defaults.humanDelay.minMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Human Delay Min (ms)","help":"Minimum delay in ms for custom humanDelay (default: 800).","hasChildren":false} {"recordType":"path","path":"agents.defaults.humanDelay.mode","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Human Delay Mode","help":"Delay style for block replies (\"off\", \"natural\", \"custom\").","hasChildren":false} +{"recordType":"path","path":"agents.defaults.imageGenerationModel","kind":"core","type":["object","string"],"required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"agents.defaults.imageGenerationModel.fallbacks","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["media","reliability"],"label":"Image Generation Model Fallbacks","help":"Ordered fallback image-generation models (provider/model).","hasChildren":true} +{"recordType":"path","path":"agents.defaults.imageGenerationModel.fallbacks.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"agents.defaults.imageGenerationModel.primary","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":["media"],"label":"Image Generation Model","help":"Optional image-generation model (provider/model) used by the shared image generation capability.","hasChildren":false} {"recordType":"path","path":"agents.defaults.imageMaxDimensionPx","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["media","performance"],"label":"Image Max Dimension (px)","help":"Max image side length in pixels when sanitizing transcript/tool-result image payloads (default: 1200).","hasChildren":false} {"recordType":"path","path":"agents.defaults.imageModel","kind":"core","type":["object","string"],"required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} {"recordType":"path","path":"agents.defaults.imageModel.fallbacks","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["media","models","reliability"],"label":"Image Model Fallbacks","help":"Ordered fallback image models (provider/model).","hasChildren":true} @@ -3453,12 +3457,14 @@ {"recordType":"path","path":"commands.bashForegroundMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Bash Foreground Window (ms)","help":"How long bash waits before backgrounding (default: 2000; 0 backgrounds immediately).","hasChildren":false} {"recordType":"path","path":"commands.config","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Allow /config","help":"Allow /config chat command to read/write config on disk (default: false).","hasChildren":false} {"recordType":"path","path":"commands.debug","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Allow /debug","help":"Allow /debug chat command for runtime-only overrides (default: false).","hasChildren":false} +{"recordType":"path","path":"commands.mcp","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Allow /mcp","help":"Allow /mcp chat command to manage OpenClaw MCP server config under mcp.servers (default: false).","hasChildren":false} {"recordType":"path","path":"commands.native","kind":"core","type":["boolean","string"],"required":true,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Native Commands","help":"Registers native slash/menu commands with channels that support command registration (Discord, Slack, Telegram). Keep enabled for discoverability unless you intentionally run text-only command workflows.","hasChildren":false} {"recordType":"path","path":"commands.nativeSkills","kind":"core","type":["boolean","string"],"required":true,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Native Skill Commands","help":"Registers native skill commands so users can invoke skills directly from provider command menus where supported. Keep aligned with your skill policy so exposed commands match what operators expect.","hasChildren":false} {"recordType":"path","path":"commands.ownerAllowFrom","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Command Owners","help":"Explicit owner allowlist for owner-only tools/commands. Use channel-native IDs (optionally prefixed like \"whatsapp:+15551234567\"). '*' is ignored.","hasChildren":true} {"recordType":"path","path":"commands.ownerAllowFrom.*","kind":"core","type":["number","string"],"required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"commands.ownerDisplay","kind":"core","type":"string","required":true,"enumValues":["raw","hash"],"defaultValue":"raw","deprecated":false,"sensitive":false,"tags":["access"],"label":"Owner ID Display","help":"Controls how owner IDs are rendered in the system prompt. Allowed values: raw, hash. Default: raw.","hasChildren":false} {"recordType":"path","path":"commands.ownerDisplaySecret","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":true,"tags":["access","auth","security"],"label":"Owner ID Hash Secret","help":"Optional secret used to HMAC hash owner IDs when ownerDisplay=hash. Prefer env substitution.","hasChildren":false} +{"recordType":"path","path":"commands.plugins","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Allow /plugins","help":"Allow /plugins chat command to list discovered plugins and toggle plugin enablement in config (default: false).","hasChildren":false} {"recordType":"path","path":"commands.restart","kind":"core","type":"boolean","required":true,"defaultValue":true,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Allow Restart","help":"Allow /restart and gateway restart tool actions (default: true).","hasChildren":false} {"recordType":"path","path":"commands.text","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Text Commands","help":"Enables text-command parsing in chat input in addition to native command surfaces where available. Keep this enabled for compatibility across channels that do not support native command registration.","hasChildren":false} {"recordType":"path","path":"commands.useAccessGroups","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access"],"label":"Use Access Groups","help":"Enforce access-group allowlists/policies for commands.","hasChildren":false} @@ -3573,11 +3579,11 @@ {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["media","network"],"label":"OpenAI Chat Completions Image Limits","help":"Image fetch/validation controls for OpenAI-compatible `image_url` parts.","hasChildren":true} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.allowedMimes","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access","media","network"],"label":"OpenAI Chat Completions Image MIME Allowlist","help":"Allowed MIME types for `image_url` parts (case-insensitive list).","hasChildren":true} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.allowedMimes.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} -{"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.allowUrl","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access","media","network"],"label":"OpenAI Chat Completions Allow Image URLs","help":"Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported).","hasChildren":false} +{"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.allowUrl","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["access","media","network"],"label":"OpenAI Chat Completions Allow Image URLs","help":"Allow server-side URL fetches for `image_url` parts (default: false; data URIs remain supported). Set this to `false` to disable URL fetching entirely.","hasChildren":false} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.maxBytes","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["media","network","performance"],"label":"OpenAI Chat Completions Image Max Bytes","help":"Max bytes per fetched/decoded `image_url` image (default: 10MB).","hasChildren":false} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.maxRedirects","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["media","network","performance","storage"],"label":"OpenAI Chat Completions Image Max Redirects","help":"Max HTTP redirects allowed when fetching `image_url` URLs (default: 3).","hasChildren":false} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.timeoutMs","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["media","network","performance"],"label":"OpenAI Chat Completions Image Timeout (ms)","help":"Timeout in milliseconds for `image_url` URL fetches (default: 10000).","hasChildren":false} -{"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.urlAllowlist","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access","media","network"],"label":"OpenAI Chat Completions Image URL Allowlist","help":"Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards.","hasChildren":true} +{"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.urlAllowlist","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["access","media","network"],"label":"OpenAI Chat Completions Image URL Allowlist","help":"Optional hostname allowlist for `image_url` URL fetches; supports exact hosts and `*.example.com` wildcards. Empty or omitted lists mean no hostname allowlist restriction.","hasChildren":true} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.images.urlAllowlist.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.maxBodyBytes","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["network","performance"],"label":"OpenAI Chat Completions Max Body Bytes","help":"Max request body size in bytes for `/v1/chat/completions` (default: 20MB).","hasChildren":false} {"recordType":"path","path":"gateway.http.endpoints.chatCompletions.maxImageParts","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["media","network","performance"],"label":"OpenAI Chat Completions Max Image Parts","help":"Max number of `image_url` parts accepted from the latest user message (default: 8).","hasChildren":false} @@ -3759,6 +3765,18 @@ {"recordType":"path","path":"logging.redactPatterns","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":["observability","privacy"],"label":"Custom Redaction Patterns","help":"Additional custom redact regex patterns applied to log output before emission/storage. Use this to mask org-specific tokens and identifiers not covered by built-in redaction rules.","hasChildren":true} {"recordType":"path","path":"logging.redactPatterns.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"logging.redactSensitive","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":["observability","privacy"],"label":"Sensitive Data Redaction Mode","help":"Sensitive redaction mode: \"off\" disables built-in masking, while \"tools\" redacts sensitive tool/config payload fields. Keep \"tools\" in shared logs unless you have isolated secure log sinks.","hasChildren":false} +{"recordType":"path","path":"mcp","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"MCP","help":"Global MCP server definitions managed by OpenClaw. Embedded Pi and other runtime adapters can consume these servers without storing them inside Pi-owned project settings.","hasChildren":true} +{"recordType":"path","path":"mcp.servers","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"MCP Servers","help":"Named MCP server definitions. OpenClaw stores them in its own config and runtime adapters decide which transports are supported at execution time.","hasChildren":true} +{"recordType":"path","path":"mcp.servers.*","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"mcp.servers.*.*","kind":"core","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.args","kind":"core","type":"array","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"mcp.servers.*.args.*","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.command","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.cwd","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.env","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":true} +{"recordType":"path","path":"mcp.servers.*.env.*","kind":"core","type":["boolean","number","string"],"required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.url","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} +{"recordType":"path","path":"mcp.servers.*.workingDirectory","kind":"core","type":"string","required":false,"deprecated":false,"sensitive":false,"tags":[],"hasChildren":false} {"recordType":"path","path":"media","kind":"core","type":"object","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Media","help":"Top-level media behavior shared across providers and tools that handle inbound files. Keep defaults unless you need stable filenames for external processing pipelines or longer-lived inbound media retention.","hasChildren":true} {"recordType":"path","path":"media.preserveFilenames","kind":"core","type":"boolean","required":false,"deprecated":false,"sensitive":false,"tags":["storage"],"label":"Preserve Media Filenames","help":"When enabled, uploaded media keeps its original filename instead of a generated temp-safe name. Turn this on when downstream automations depend on stable names, and leave off to reduce accidental filename leakage.","hasChildren":false} {"recordType":"path","path":"media.ttlHours","kind":"core","type":"integer","required":false,"deprecated":false,"sensitive":false,"tags":["advanced"],"label":"Media Retention TTL (hours)","help":"Optional retention window in hours for persisted inbound media cleanup across the full media tree. Leave unset to preserve legacy behavior, or set values like 24 (1 day) or 168 (7 days) when you want automatic cleanup.","hasChildren":false} diff --git a/extensions/feishu/src/bot.card-action.test.ts b/extensions/feishu/src/bot.card-action.test.ts index 2d2e7ac235d..0dd3cf8730c 100644 --- a/extensions/feishu/src/bot.card-action.test.ts +++ b/extensions/feishu/src/bot.card-action.test.ts @@ -37,7 +37,7 @@ describe("Feishu Card Action Handler", () => { function createCardActionEvent(params: { token: string; - actionValue: unknown; + actionValue: Record; chatId?: string; openId?: string; userId?: string; diff --git a/package.json b/package.json index 08acac5db40..e1e9379c1a8 100644 --- a/package.json +++ b/package.json @@ -338,6 +338,10 @@ "types": "./dist/plugin-sdk/channel-config-schema.d.ts", "default": "./dist/plugin-sdk/channel-config-schema.js" }, + "./plugin-sdk/channel-lifecycle": { + "types": "./dist/plugin-sdk/channel-lifecycle.d.ts", + "default": "./dist/plugin-sdk/channel-lifecycle.js" + }, "./plugin-sdk/channel-policy": { "types": "./dist/plugin-sdk/channel-policy.d.ts", "default": "./dist/plugin-sdk/channel-policy.js" diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index 205982588fd..801cebcd462 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -74,6 +74,7 @@ "boolean-param", "channel-config-helpers", "channel-config-schema", + "channel-lifecycle", "channel-policy", "group-access", "directory-runtime", diff --git a/scripts/release-check.ts b/scripts/release-check.ts index 9b67303b4a6..fba6d197357 100755 --- a/scripts/release-check.ts +++ b/scripts/release-check.ts @@ -341,31 +341,47 @@ const requiredPluginSdkExports = [ "DEFAULT_GROUP_HISTORY_LIMIT", ]; -function checkPluginSdkExports() { - const distPath = resolve("dist", "plugin-sdk", "index.js"); - let content: string; +async function collectDistPluginSdkExports(): Promise> { + const pluginSdkDir = resolve("dist", "plugin-sdk"); + let entries: string[]; try { - content = readFileSync(distPath, "utf8"); + entries = readdirSync(pluginSdkDir) + .filter((entry) => entry.endsWith(".js")) + .toSorted(); } catch { - console.error("release-check: dist/plugin-sdk/index.js not found (build missing?)."); + console.error("release-check: dist/plugin-sdk directory not found (build missing?)."); process.exit(1); - return; + return new Set(); } - const exportMatch = content.match(/export\s*\{([^}]+)\}\s*;?\s*$/); - if (!exportMatch) { - console.error("release-check: could not find export statement in dist/plugin-sdk/index.js."); - process.exit(1); - return; + const exportedNames = new Set(); + for (const entry of entries) { + const content = readFileSync(join(pluginSdkDir, entry), "utf8"); + for (const match of content.matchAll(/export\s*\{([^}]+)\}(?:\s*from\s*["'][^"']+["'])?/g)) { + const names = match[1]?.split(",") ?? []; + for (const name of names) { + const parts = name.trim().split(/\s+as\s+/); + const exportName = (parts[parts.length - 1] || "").trim(); + if (exportName) { + exportedNames.add(exportName); + } + } + } + for (const match of content.matchAll( + /export\s+(?:const|function|class|let|var)\s+([A-Za-z0-9_$]+)/g, + )) { + const exportName = match[1]?.trim(); + if (exportName) { + exportedNames.add(exportName); + } + } } - const exportedNames = new Set( - exportMatch[1].split(",").map((s) => { - const parts = s.trim().split(/\s+as\s+/); - return (parts[parts.length - 1] || "").trim(); - }), - ); + return exportedNames; +} +async function checkPluginSdkExports() { + const exportedNames = await collectDistPluginSdkExports(); const missingExports = requiredPluginSdkExports.filter((name) => !exportedNames.has(name)); if (missingExports.length > 0) { console.error("release-check: missing critical plugin-sdk exports (#27569):"); @@ -376,10 +392,10 @@ function checkPluginSdkExports() { } } -function main() { +async function main() { checkPluginVersions(); checkAppcastSparkleVersions(); - checkPluginSdkExports(); + await checkPluginSdkExports(); checkBundledExtensionRootDependencyMirrors(); const results = runPackDry(); @@ -423,5 +439,8 @@ function main() { } if (import.meta.url === pathToFileURL(process.argv[1] ?? "").href) { - main(); + void main().catch((error: unknown) => { + console.error(error); + process.exit(1); + }); } diff --git a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts index b9143d20a46..4ebd56c5d05 100644 --- a/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.kilocode.test.ts @@ -126,7 +126,7 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { const capturedPayload = applyAndCaptureReasoning({ modelId: "kilo/auto", initialPayload: { reasoning_effort: "high" }, - }); + }) as Record; // kilo/auto should not have reasoning injected expect(capturedPayload?.reasoning).toBeUndefined(); @@ -136,7 +136,7 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { it("injects reasoning.effort for non-auto kilocode models", () => { const capturedPayload = applyAndCaptureReasoning({ modelId: "anthropic/claude-sonnet-4", - }); + }) as Record; // Non-auto models should have reasoning injected expect(capturedPayload?.reasoning).toEqual({ effort: "high" }); @@ -150,7 +150,7 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { }, }, modelId: "anthropic/claude-sonnet-4", - }); + }) as Record; expect(capturedPayload?.reasoning).toEqual({ effort: "high" }); }); @@ -167,7 +167,7 @@ describe("extra-params: Kilocode kilo/auto reasoning", () => { } as Model<"openai-completions">, payload: { reasoning_effort: "high" }, thinkingLevel: "high", - }).payload; + }).payload as Record; // x-ai models reject reasoning.effort — should be skipped expect(capturedPayload?.reasoning).toBeUndefined(); diff --git a/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts b/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts index b22be4231b8..ca22149990f 100644 --- a/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts +++ b/src/agents/pi-embedded-runner/extra-params.zai-tool-stream.test.ts @@ -27,7 +27,7 @@ function runToolStreamCase(params: ToolStreamCase) { model: params.model, options: params.options, payload: { model: params.model.id, messages: [] }, - }).payload; + }).payload as Record; } describe("extra-params: Z.AI tool_stream support", () => { diff --git a/src/channels/plugins/contracts/inbound.contract.test.ts b/src/channels/plugins/contracts/inbound.contract.test.ts index eadb1913544..aeb231cb628 100644 --- a/src/channels/plugins/contracts/inbound.contract.test.ts +++ b/src/channels/plugins/contracts/inbound.contract.test.ts @@ -1,50 +1,42 @@ -import fs from "node:fs/promises"; -import os from "node:os"; -import path from "node:path"; -import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, expect, it, vi } from "vitest"; import type { ResolvedSlackAccount } from "../../../../extensions/slack/src/accounts.js"; -import { prepareSlackMessage } from "../../../../extensions/slack/src/monitor/message-handler/prepare.js"; -import { createInboundSlackTestContext } from "../../../../extensions/slack/src/monitor/message-handler/prepare.test-helpers.js"; import type { SlackMessageEvent } from "../../../../extensions/slack/src/types.js"; import type { MsgContext } from "../../../auto-reply/templating.js"; import type { OpenClawConfig } from "../../../config/config.js"; import { inboundCtxCapture } from "./inbound-testkit.js"; import { expectChannelInboundContextContract } from "./suites.js"; -const signalCapture = vi.hoisted(() => ({ ctx: undefined as MsgContext | undefined })); -const bufferedReplyCapture = vi.hoisted(() => ({ - ctx: undefined as MsgContext | undefined, -})); const dispatchInboundMessageMock = vi.hoisted(() => vi.fn( async (params: { ctx: MsgContext; replyOptions?: { onReplyStart?: () => void | Promise }; }) => { - signalCapture.ctx = params.ctx; await Promise.resolve(params.replyOptions?.onReplyStart?.()); return { queuedFinal: false, counts: { tool: 0, block: 0, final: 0 } }; }, ), ); -vi.mock("../../../auto-reply/dispatch.js", async (importOriginal) => { - const actual = await importOriginal(); +vi.mock("openclaw/plugin-sdk/reply-runtime", async (importOriginal) => { + const actual = await importOriginal(); return { ...actual, - dispatchInboundMessage: dispatchInboundMessageMock, - dispatchInboundMessageWithDispatcher: dispatchInboundMessageMock, - dispatchInboundMessageWithBufferedDispatcher: dispatchInboundMessageMock, + dispatchInboundMessage: vi.fn(async (params: { ctx: MsgContext }) => { + inboundCtxCapture.ctx = params.ctx; + return await dispatchInboundMessageMock(params); + }), + dispatchInboundMessageWithDispatcher: vi.fn(async (params: { ctx: MsgContext }) => { + inboundCtxCapture.ctx = params.ctx; + return await dispatchInboundMessageMock(params); + }), + dispatchInboundMessageWithBufferedDispatcher: vi.fn(async (params: { ctx: MsgContext }) => { + inboundCtxCapture.ctx = params.ctx; + return await dispatchInboundMessageMock(params); + }), }; }); -vi.mock("../../../auto-reply/reply/provider-dispatcher.js", () => ({ - dispatchReplyWithBufferedBlockDispatcher: vi.fn(async (params: { ctx: MsgContext }) => { - bufferedReplyCapture.ctx = params.ctx; - return { queuedFinal: false }; - }), -})); - vi.mock("../../../../extensions/signal/src/send.js", () => ({ sendMessageSignal: vi.fn(), sendTypingSignal: vi.fn(async () => true), @@ -70,17 +62,6 @@ vi.mock("../../../../extensions/whatsapp/src/auto-reply/deliver-reply.js", () => deliverWebReply: vi.fn(async () => {}), })); -const { processDiscordMessage } = - await import("../../../../extensions/discord/src/monitor/message-handler.process.js"); -const { createBaseDiscordMessageContext, createDiscordDirectMessageContextOverrides } = - await import("../../../../extensions/discord/src/monitor/message-handler.test-harness.js"); -const { createSignalEventHandler } = - await import("../../../../extensions/signal/src/monitor/event-handler.js"); -const { createBaseSignalEventHandlerDeps, createSignalReceiveEvent } = - await import("../../../../extensions/signal/src/monitor/event-handler.test-harness.js"); -const { processMessage } = - await import("../../../../extensions/whatsapp/src/auto-reply/monitor/process-message.js"); - function createSlackAccount(config: ResolvedSlackAccount["config"] = {}): ResolvedSlackAccount { return { accountId: "default", @@ -106,81 +87,17 @@ function createSlackMessage(overrides: Partial): SlackMessage } as SlackMessageEvent; } -function makeWhatsAppProcessArgs(sessionStorePath: string) { - return { - // oxlint-disable-next-line typescript/no-explicit-any - cfg: { messages: {}, session: { store: sessionStorePath } } as any, - // oxlint-disable-next-line typescript/no-explicit-any - msg: { - id: "msg1", - from: "123@g.us", - to: "+15550001111", - chatType: "group", - body: "hi", - senderName: "Alice", - senderJid: "alice@s.whatsapp.net", - senderE164: "+15550002222", - groupSubject: "Test Group", - groupParticipants: [], - } as unknown as Record, - route: { - agentId: "main", - accountId: "default", - sessionKey: "agent:main:whatsapp:group:123", - // oxlint-disable-next-line typescript/no-explicit-any - } as any, - groupHistoryKey: "123@g.us", - groupHistories: new Map(), - groupMemberNames: new Map(), - connectionId: "conn", - verbose: false, - maxMediaBytes: 1, - // oxlint-disable-next-line typescript/no-explicit-any - replyResolver: (async () => undefined) as any, - // oxlint-disable-next-line typescript/no-explicit-any - replyLogger: { info: () => {}, warn: () => {}, error: () => {}, debug: () => {} } as any, - backgroundTasks: new Set>(), - rememberSentText: () => {}, - echoHas: () => false, - echoForget: () => {}, - buildCombinedEchoKey: () => "echo", - groupHistory: [], - // oxlint-disable-next-line typescript/no-explicit-any - } as any; -} - -async function removeDirEventually(dir: string) { - for (let attempt = 0; attempt < 3; attempt += 1) { - try { - await fs.rm(dir, { recursive: true, force: true }); - return; - } catch (error) { - if ((error as NodeJS.ErrnoException).code !== "ENOTEMPTY" || attempt === 2) { - throw error; - } - await new Promise((resolve) => setTimeout(resolve, 25)); - } - } -} - describe("channel inbound contract", () => { - let whatsappSessionDir = ""; - beforeEach(() => { inboundCtxCapture.ctx = undefined; - signalCapture.ctx = undefined; - bufferedReplyCapture.ctx = undefined; dispatchInboundMessageMock.mockClear(); }); - afterEach(async () => { - if (whatsappSessionDir) { - await removeDirEventually(whatsappSessionDir); - whatsappSessionDir = ""; - } - }); - it("keeps Discord inbound context finalized", async () => { + const { processDiscordMessage } = + await import("../../../../extensions/discord/src/monitor/message-handler.process.js"); + const { createBaseDiscordMessageContext, createDiscordDirectMessageContextOverrides } = + await import("../../../../extensions/discord/src/monitor/message-handler.test-harness.js"); const messageCtx = await createBaseDiscordMessageContext({ cfg: { messages: {} }, ackReactionScope: "direct", @@ -194,29 +111,38 @@ describe("channel inbound contract", () => { }); it("keeps Signal inbound context finalized", async () => { - const handler = createSignalEventHandler( - createBaseSignalEventHandlerDeps({ - // oxlint-disable-next-line typescript/no-explicit-any - cfg: { messages: { inbound: { debounceMs: 0 } } } as any, - historyLimit: 0, - }), - ); + const { finalizeInboundContext } = await import("../../../auto-reply/reply/inbound-context.js"); + const ctx = finalizeInboundContext({ + Body: "Alice: hi", + BodyForAgent: "hi", + RawBody: "hi", + CommandBody: "hi", + BodyForCommands: "hi", + From: "group:g1", + To: "group:g1", + SessionKey: "agent:main:signal:group:g1", + AccountId: "default", + ChatType: "group", + ConversationLabel: "Alice", + GroupSubject: "Test Group", + SenderName: "Alice", + SenderId: "+15550001111", + Provider: "signal", + Surface: "signal", + MessageSid: "1700000000000", + OriginatingChannel: "signal", + OriginatingTo: "group:g1", + CommandAuthorized: true, + }); - await handler( - createSignalReceiveEvent({ - dataMessage: { - message: "hi", - attachments: [], - groupInfo: { groupId: "g1", groupName: "Test Group" }, - }, - }), - ); - - expect(signalCapture.ctx).toBeTruthy(); - expectChannelInboundContextContract(signalCapture.ctx!); + expectChannelInboundContextContract(ctx); }); it("keeps Slack inbound context finalized", async () => { + const { prepareSlackMessage } = + await import("../../../../extensions/slack/src/monitor/message-handler/prepare.js"); + const { createInboundSlackTestContext } = + await import("../../../../extensions/slack/src/monitor/message-handler/prepare.test-helpers.js"); const ctx = createInboundSlackTestContext({ cfg: { channels: { slack: { enabled: true } }, @@ -237,35 +163,23 @@ describe("channel inbound contract", () => { }); it("keeps Telegram inbound context finalized", async () => { - const { getLoadConfigMock, getOnHandler, onSpy, sendMessageSpy } = - await import("../../../../extensions/telegram/src/bot.create-telegram-bot.test-harness.js"); - const { resetInboundDedupe } = await import("../../../auto-reply/reply/inbound-dedupe.js"); + const { buildTelegramMessageContextForTest } = + await import("../../../../extensions/telegram/src/bot-message-context.test-harness.js"); - resetInboundDedupe(); - onSpy.mockReset(); - sendMessageSpy.mockReset(); - sendMessageSpy.mockResolvedValue({ message_id: 77 }); - getLoadConfigMock().mockReset(); - getLoadConfigMock().mockReturnValue({ - agents: { - defaults: { - envelopeTimezone: "utc", + const context = await buildTelegramMessageContextForTest({ + cfg: { + agents: { + defaults: { + envelopeTimezone: "utc", + }, }, - }, - channels: { - telegram: { - groupPolicy: "open", - groups: { "*": { requireMention: false } }, + channels: { + telegram: { + groupPolicy: "open", + groups: { "*": { requireMention: false } }, + }, }, - }, - } satisfies OpenClawConfig); - - const { createTelegramBot } = await import("../../../../extensions/telegram/src/bot.js"); - - createTelegramBot({ token: "tok" }); - const handler = getOnHandler("message") as (ctx: Record) => Promise; - - await handler({ + } satisfies OpenClawConfig, message: { chat: { id: 42, type: "group", title: "Ops" }, text: "hello", @@ -278,22 +192,39 @@ describe("channel inbound contract", () => { username: "ada", }, }, - me: { username: "openclaw_bot" }, - getFile: async () => ({ download: async () => new Uint8Array() }), }); - const payload = bufferedReplyCapture.ctx; + const payload = context?.ctxPayload; expect(payload).toBeTruthy(); expectChannelInboundContextContract(payload!); }); it("keeps WhatsApp inbound context finalized", async () => { - whatsappSessionDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-whatsapp-contract-")); - const sessionStorePath = path.join(whatsappSessionDir, "sessions.json"); + const { finalizeInboundContext } = await import("../../../auto-reply/reply/inbound-context.js"); + const ctx = finalizeInboundContext({ + Body: "Alice: hi", + BodyForAgent: "hi", + RawBody: "hi", + CommandBody: "hi", + BodyForCommands: "hi", + From: "123@g.us", + To: "+15550001111", + SessionKey: "agent:main:whatsapp:group:123", + AccountId: "default", + ChatType: "group", + ConversationLabel: "123@g.us", + GroupSubject: "Test Group", + SenderName: "Alice", + SenderId: "alice@s.whatsapp.net", + SenderE164: "+15550002222", + Provider: "whatsapp", + Surface: "whatsapp", + MessageSid: "msg1", + OriginatingChannel: "whatsapp", + OriginatingTo: "123@g.us", + CommandAuthorized: true, + }); - await processMessage(makeWhatsAppProcessArgs(sessionStorePath)); - - expect(bufferedReplyCapture.ctx).toBeTruthy(); - expectChannelInboundContextContract(bufferedReplyCapture.ctx!); + expectChannelInboundContextContract(ctx); }); }); diff --git a/src/cli/command-secret-resolution.coverage.test.ts b/src/cli/command-secret-resolution.coverage.test.ts index fea0fb35eec..362bd3b0b55 100644 --- a/src/cli/command-secret-resolution.coverage.test.ts +++ b/src/cli/command-secret-resolution.coverage.test.ts @@ -14,6 +14,18 @@ const SECRET_TARGET_CALLSITES = [ "src/commands/status.scan.ts", ] as const; +async function readCommandSource(relativePath: string): Promise { + const absolutePath = path.join(process.cwd(), relativePath); + const source = await fs.readFile(absolutePath, "utf8"); + const reexportMatch = source.match(/^export \* from "(?[^"]+)";$/m)?.groups?.target; + if (!reexportMatch) { + return source; + } + const resolvedTarget = path.join(path.dirname(absolutePath), reexportMatch); + const tsResolvedTarget = resolvedTarget.replace(/\.js$/u, ".ts"); + return await fs.readFile(tsResolvedTarget, "utf8"); +} + function hasSupportedTargetIdsWiring(source: string): boolean { return ( /targetIds:\s*get[A-Za-z0-9_]+\(\)/m.test(source) || @@ -25,8 +37,7 @@ describe("command secret resolution coverage", () => { it.each(SECRET_TARGET_CALLSITES)( "routes target-id command path through shared gateway resolver: %s", async (relativePath) => { - const absolutePath = path.join(process.cwd(), relativePath); - const source = await fs.readFile(absolutePath, "utf8"); + const source = await readCommandSource(relativePath); expect(source).toContain("resolveCommandSecretRefsViaGateway"); expect(hasSupportedTargetIdsWiring(source)).toBe(true); expect(source).toContain("resolveCommandSecretRefsViaGateway({"); diff --git a/src/commands/status.scan.deps.runtime.ts b/src/commands/status.scan.deps.runtime.ts index ce318085541..722bcfc1599 100644 --- a/src/commands/status.scan.deps.runtime.ts +++ b/src/commands/status.scan.deps.runtime.ts @@ -6,7 +6,7 @@ import type { MemoryProviderStatus } from "../memory/types.js"; export { getTailnetHostname }; type StatusMemoryManager = { - probeVectorAvailability(): Promise; + probeVectorAvailability(): Promise; status(): MemoryProviderStatus; close?(): Promise; }; @@ -23,7 +23,7 @@ export async function getMemorySearchManager(params: { return { manager: { async probeVectorAvailability() { - await manager.probeVectorAvailability(); + return await manager.probeVectorAvailability(); }, status() { return manager.status(); diff --git a/src/infra/provider-usage.test-support.ts b/src/infra/provider-usage.test-support.ts index d14aecb2dbd..2d2609a29d6 100644 --- a/src/infra/provider-usage.test-support.ts +++ b/src/infra/provider-usage.test-support.ts @@ -1,12 +1,14 @@ import { createProviderUsageFetch } from "../test-utils/provider-usage-fetch.js"; +import type { ProviderAuth } from "./provider-usage.auth.js"; +import type { UsageSummary } from "./provider-usage.types.js"; export const usageNow = Date.UTC(2026, 0, 7, 0, 0, 0); type ProviderUsageLoader = (params: { now: number; - auth: Array<{ provider: string; token?: string; accountId?: string }>; + auth?: ProviderAuth[]; fetch?: typeof fetch; -}) => Promise; +}) => Promise; export type ProviderUsageAuth = NonNullable< NonNullable[0]>["auth"] diff --git a/src/memory/manager.async-search.test.ts b/src/memory/manager.async-search.test.ts index 22ecd91b267..dca8cc52892 100644 --- a/src/memory/manager.async-search.test.ts +++ b/src/memory/manager.async-search.test.ts @@ -88,6 +88,9 @@ describe("memory search async sync", () => { manager = await createMemoryManagerOrThrow(cfg); await manager.search("hello"); + await vi.waitFor(() => { + expect((manager as unknown as { syncing: Promise | null }).syncing).toBeTruthy(); + }); let closed = false; const closePromise = manager.close().then(() => { diff --git a/src/plugin-sdk/channel-import-guardrails.test.ts b/src/plugin-sdk/channel-import-guardrails.test.ts index 447489b1a0f..3f3e0d0033a 100644 --- a/src/plugin-sdk/channel-import-guardrails.test.ts +++ b/src/plugin-sdk/channel-import-guardrails.test.ts @@ -11,10 +11,6 @@ type GuardedSource = { }; const SAME_CHANNEL_SDK_GUARDS: GuardedSource[] = [ - { - path: "extensions/discord/src/plugin-shared.ts", - forbiddenPatterns: [/openclaw\/plugin-sdk\/discord/, /plugin-sdk-internal\/discord/], - }, { path: "extensions/discord/src/shared.ts", forbiddenPatterns: [/openclaw\/plugin-sdk\/discord/, /plugin-sdk-internal\/discord/], diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index 1f9198d4e7f..45465f2f68e 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -40,11 +40,13 @@ export type { export type { OpenClawConfig } from "../config/config.js"; /** @deprecated Use OpenClawConfig instead */ export type { OpenClawConfig as ClawdbotConfig } from "../config/config.js"; +export { registerContextEngine } from "../context-engine/index.js"; export * from "./image-generation.js"; export type { SecretInput, SecretRef } from "../config/types.secrets.js"; export type { RuntimeEnv } from "../runtime.js"; export type { HookEntry } from "../hooks/types.js"; export type { ReplyPayload } from "../auto-reply/types.js"; export type { WizardPrompter } from "../wizard/prompts.js"; +export type { ContextEngineFactory } from "../context-engine/index.js"; export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; diff --git a/src/plugin-sdk/plugin-runtime.ts b/src/plugin-sdk/plugin-runtime.ts index ecc80f8f224..7286beae159 100644 --- a/src/plugin-sdk/plugin-runtime.ts +++ b/src/plugin-sdk/plugin-runtime.ts @@ -2,5 +2,7 @@ export * from "../plugins/commands.js"; export * from "../plugins/hook-runner-global.js"; +export * from "../plugins/http-path.js"; +export * from "../plugins/http-registry.js"; export * from "../plugins/interactive.js"; export * from "../plugins/types.js"; diff --git a/src/plugins/interactive.test.ts b/src/plugins/interactive.test.ts index 51be58f393f..2b595e856f8 100644 --- a/src/plugins/interactive.test.ts +++ b/src/plugins/interactive.test.ts @@ -1,10 +1,20 @@ import { afterEach, beforeEach, describe, expect, it, vi, type MockInstance } from "vitest"; import * as conversationBinding from "./conversation-binding.js"; +import type { + DiscordInteractiveDispatchContext, + SlackInteractiveDispatchContext, + TelegramInteractiveDispatchContext, +} from "./interactive-dispatch-adapters.js"; import { clearPluginInteractiveHandlers, dispatchPluginInteractiveHandler, registerPluginInteractiveHandler, } from "./interactive.js"; +import type { + PluginInteractiveDiscordHandlerContext, + PluginInteractiveSlackHandlerContext, + PluginInteractiveTelegramHandlerContext, +} from "./types.js"; let requestPluginConversationBindingMock: MockInstance< typeof conversationBinding.requestPluginConversationBinding @@ -16,13 +26,46 @@ let getCurrentPluginConversationBindingMock: MockInstance< typeof conversationBinding.getCurrentPluginConversationBinding >; +type InteractiveDispatchParams = + | { + channel: "telegram"; + data: string; + callbackId: string; + ctx: TelegramInteractiveDispatchContext; + respond: PluginInteractiveTelegramHandlerContext["respond"]; + } + | { + channel: "discord"; + data: string; + interactionId: string; + ctx: DiscordInteractiveDispatchContext; + respond: PluginInteractiveDiscordHandlerContext["respond"]; + } + | { + channel: "slack"; + data: string; + interactionId: string; + ctx: SlackInteractiveDispatchContext; + respond: PluginInteractiveSlackHandlerContext["respond"]; + }; + async function expectDedupedInteractiveDispatch(params: { - baseParams: Parameters[0]; + baseParams: InteractiveDispatchParams; handler: ReturnType; expectedCall: unknown; }) { - const first = await dispatchPluginInteractiveHandler(params.baseParams); - const duplicate = await dispatchPluginInteractiveHandler(params.baseParams); + const dispatch = async (baseParams: InteractiveDispatchParams) => { + if (baseParams.channel === "telegram") { + return await dispatchPluginInteractiveHandler(baseParams); + } + if (baseParams.channel === "discord") { + return await dispatchPluginInteractiveHandler(baseParams); + } + return await dispatchPluginInteractiveHandler(baseParams); + }; + + const first = await dispatch(params.baseParams); + const duplicate = await dispatch(params.baseParams); expect(first).toEqual({ matched: true, handled: true, duplicate: false }); expect(duplicate).toEqual({ matched: true, handled: true, duplicate: true }); diff --git a/src/plugins/status.test.ts b/src/plugins/status.test.ts index c93ce5ef37b..3c7bc35cba6 100644 --- a/src/plugins/status.test.ts +++ b/src/plugins/status.test.ts @@ -1,8 +1,8 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { buildPluginStatusReport } from "./status.js"; const loadConfigMock = vi.fn(); const loadOpenClawPluginsMock = vi.fn(); +let buildPluginStatusReport: typeof import("./status.js").buildPluginStatusReport; vi.mock("../config/config.js", () => ({ loadConfig: () => loadConfigMock(), @@ -22,7 +22,8 @@ vi.mock("../agents/workspace.js", () => ({ })); describe("buildPluginStatusReport", () => { - beforeEach(() => { + beforeEach(async () => { + vi.resetModules(); loadConfigMock.mockReset(); loadOpenClawPluginsMock.mockReset(); loadConfigMock.mockReturnValue({}); @@ -38,6 +39,7 @@ describe("buildPluginStatusReport", () => { services: [], commands: [], }); + ({ buildPluginStatusReport } = await import("./status.js")); }); it("forwards an explicit env to plugin loading", () => { From 9648e7fecb282a5ea7d7b28c0760afafe07cb0b7 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:58:46 -0700 Subject: [PATCH 159/187] refactor: consolidate lazy runtime surfaces --- extensions/bluebubbles/src/actions.runtime.ts | 98 ++------- extensions/bluebubbles/src/actions.ts | 11 +- extensions/bluebubbles/src/channel.runtime.ts | 54 +---- extensions/bluebubbles/src/channel.ts | 11 +- extensions/feishu/src/channel.runtime.ts | 120 ++--------- extensions/feishu/src/channel.test.ts | 38 ++-- extensions/feishu/src/channel.ts | 10 +- extensions/googlechat/src/channel.runtime.ts | 40 +--- extensions/googlechat/src/channel.ts | 10 +- extensions/matrix/src/channel.runtime.ts | 55 +---- extensions/matrix/src/channel.ts | 10 +- extensions/msteams/src/channel.runtime.ts | 47 +---- extensions/msteams/src/channel.ts | 10 +- extensions/zalo/src/actions.runtime.ts | 8 +- extensions/zalo/src/actions.ts | 11 +- src/agents/auth-profiles.runtime.ts | 10 +- src/agents/command-poll-backoff.runtime.ts | 10 +- src/agents/model-suppression.runtime.ts | 11 +- .../pi-embedded-runner/compact.runtime.ts | 10 +- .../pi-tools.before-tool-call.runtime.ts | 14 +- src/agents/pi-tools.before-tool-call.ts | 12 +- src/agents/skills/env-overrides.runtime.ts | 10 +- .../plugins/setup-wizard-helpers.runtime.ts | 9 +- src/cli/deps.ts | 4 +- src/commands/model-picker.runtime.ts | 14 +- src/commands/model-picker.test.ts | 12 +- src/commands/model-picker.ts | 14 +- .../auth-choice.plugin-providers.runtime.ts | 10 +- .../auth-choice.plugin-providers.test.ts | 9 +- .../local/auth-choice.plugin-providers.ts | 8 +- src/commands/status.scan.runtime.ts | 9 +- src/commands/status.scan.test.ts | 6 +- src/commands/status.scan.ts | 16 +- src/commands/status.summary.runtime.ts | 10 +- src/commands/status.summary.ts | 12 +- src/plugin-sdk/index.ts | 4 +- src/plugins/provider-api-key-auth.runtime.ts | 2 +- src/plugins/provider-api-key-auth.ts | 13 +- src/plugins/runtime/runtime-discord.ts | 188 +++++++++--------- src/plugins/runtime/runtime-slack.ts | 95 +++++---- src/plugins/runtime/runtime-telegram.ts | 154 +++++++------- src/plugins/runtime/runtime-whatsapp.ts | 58 +++--- src/security/audit-channel.collect.runtime.ts | 11 +- src/security/audit-channel.runtime.ts | 20 +- src/security/audit-channel.ts | 13 +- src/security/audit.runtime.ts | 10 +- src/shared/lazy-runtime.ts | 21 ++ 47 files changed, 602 insertions(+), 730 deletions(-) create mode 100644 src/shared/lazy-runtime.ts diff --git a/extensions/bluebubbles/src/actions.runtime.ts b/extensions/bluebubbles/src/actions.runtime.ts index 00d0bc00efd..6b4112547d1 100644 --- a/extensions/bluebubbles/src/actions.runtime.ts +++ b/extensions/bluebubbles/src/actions.runtime.ts @@ -15,87 +15,17 @@ import { sendMessageBlueBubbles as sendMessageBlueBubblesImpl, } from "./send.js"; -type SendBlueBubblesAttachment = typeof import("./attachments.js").sendBlueBubblesAttachment; -type AddBlueBubblesParticipant = typeof import("./chat.js").addBlueBubblesParticipant; -type EditBlueBubblesMessage = typeof import("./chat.js").editBlueBubblesMessage; -type LeaveBlueBubblesChat = typeof import("./chat.js").leaveBlueBubblesChat; -type RemoveBlueBubblesParticipant = typeof import("./chat.js").removeBlueBubblesParticipant; -type RenameBlueBubblesChat = typeof import("./chat.js").renameBlueBubblesChat; -type SetGroupIconBlueBubbles = typeof import("./chat.js").setGroupIconBlueBubbles; -type UnsendBlueBubblesMessage = typeof import("./chat.js").unsendBlueBubblesMessage; -type ResolveBlueBubblesMessageId = typeof import("./monitor.js").resolveBlueBubblesMessageId; -type SendBlueBubblesReaction = typeof import("./reactions.js").sendBlueBubblesReaction; -type ResolveChatGuidForTarget = typeof import("./send.js").resolveChatGuidForTarget; -type SendMessageBlueBubbles = typeof import("./send.js").sendMessageBlueBubbles; - -export function sendBlueBubblesAttachment( - ...args: Parameters -): ReturnType { - return sendBlueBubblesAttachmentImpl(...args); -} - -export function addBlueBubblesParticipant( - ...args: Parameters -): ReturnType { - return addBlueBubblesParticipantImpl(...args); -} - -export function editBlueBubblesMessage( - ...args: Parameters -): ReturnType { - return editBlueBubblesMessageImpl(...args); -} - -export function leaveBlueBubblesChat( - ...args: Parameters -): ReturnType { - return leaveBlueBubblesChatImpl(...args); -} - -export function removeBlueBubblesParticipant( - ...args: Parameters -): ReturnType { - return removeBlueBubblesParticipantImpl(...args); -} - -export function renameBlueBubblesChat( - ...args: Parameters -): ReturnType { - return renameBlueBubblesChatImpl(...args); -} - -export function setGroupIconBlueBubbles( - ...args: Parameters -): ReturnType { - return setGroupIconBlueBubblesImpl(...args); -} - -export function unsendBlueBubblesMessage( - ...args: Parameters -): ReturnType { - return unsendBlueBubblesMessageImpl(...args); -} - -export function resolveBlueBubblesMessageId( - ...args: Parameters -): ReturnType { - return resolveBlueBubblesMessageIdImpl(...args); -} - -export function sendBlueBubblesReaction( - ...args: Parameters -): ReturnType { - return sendBlueBubblesReactionImpl(...args); -} - -export function resolveChatGuidForTarget( - ...args: Parameters -): ReturnType { - return resolveChatGuidForTargetImpl(...args); -} - -export function sendMessageBlueBubbles( - ...args: Parameters -): ReturnType { - return sendMessageBlueBubblesImpl(...args); -} +export const blueBubblesActionsRuntime = { + sendBlueBubblesAttachment: sendBlueBubblesAttachmentImpl, + addBlueBubblesParticipant: addBlueBubblesParticipantImpl, + editBlueBubblesMessage: editBlueBubblesMessageImpl, + leaveBlueBubblesChat: leaveBlueBubblesChatImpl, + removeBlueBubblesParticipant: removeBlueBubblesParticipantImpl, + renameBlueBubblesChat: renameBlueBubblesChatImpl, + setGroupIconBlueBubbles: setGroupIconBlueBubblesImpl, + unsendBlueBubblesMessage: unsendBlueBubblesMessageImpl, + resolveBlueBubblesMessageId: resolveBlueBubblesMessageIdImpl, + sendBlueBubblesReaction: sendBlueBubblesReactionImpl, + resolveChatGuidForTarget: resolveChatGuidForTargetImpl, + sendMessageBlueBubbles: sendMessageBlueBubblesImpl, +}; diff --git a/extensions/bluebubbles/src/actions.ts b/extensions/bluebubbles/src/actions.ts index 4e6476afa3f..47eedf97511 100644 --- a/extensions/bluebubbles/src/actions.ts +++ b/extensions/bluebubbles/src/actions.ts @@ -11,18 +11,19 @@ import { type ChannelMessageActionAdapter, type ChannelMessageActionName, } from "openclaw/plugin-sdk/bluebubbles"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { resolveBlueBubblesAccount } from "./accounts.js"; import { getCachedBlueBubblesPrivateApiStatus, isMacOS26OrHigher } from "./probe.js"; import { normalizeSecretInputString } from "./secret-input.js"; import { normalizeBlueBubblesHandle, parseBlueBubblesTarget } from "./targets.js"; import type { BlueBubblesSendTarget } from "./types.js"; -let actionsRuntimePromise: Promise | null = null; +type BlueBubblesActionsRuntime = typeof import("./actions.runtime.js").blueBubblesActionsRuntime; -function loadBlueBubblesActionsRuntime() { - actionsRuntimePromise ??= import("./actions.runtime.js"); - return actionsRuntimePromise; -} +const loadBlueBubblesActionsRuntime = createLazyRuntimeSurface( + () => import("./actions.runtime.js"), + ({ blueBubblesActionsRuntime }) => blueBubblesActionsRuntime, +); const providerId = "bluebubbles"; diff --git a/extensions/bluebubbles/src/channel.runtime.ts b/extensions/bluebubbles/src/channel.runtime.ts index d318943d3f2..b8b4066c4cd 100644 --- a/extensions/bluebubbles/src/channel.runtime.ts +++ b/extensions/bluebubbles/src/channel.runtime.ts @@ -6,52 +6,14 @@ import { } from "./monitor.js"; import { probeBlueBubbles as probeBlueBubblesImpl } from "./probe.js"; import { sendMessageBlueBubbles as sendMessageBlueBubblesImpl } from "./send.js"; -import { blueBubblesSetupWizard as blueBubblesSetupWizardImpl } from "./setup-surface.js"; export type { BlueBubblesProbe } from "./probe.js"; -type SendBlueBubblesMedia = typeof import("./media-send.js").sendBlueBubblesMedia; -type ResolveBlueBubblesMessageId = typeof import("./monitor.js").resolveBlueBubblesMessageId; -type MonitorBlueBubblesProvider = typeof import("./monitor.js").monitorBlueBubblesProvider; -type ResolveWebhookPathFromConfig = typeof import("./monitor.js").resolveWebhookPathFromConfig; -type ProbeBlueBubbles = typeof import("./probe.js").probeBlueBubbles; -type SendMessageBlueBubbles = typeof import("./send.js").sendMessageBlueBubbles; -type BlueBubblesSetupWizard = typeof import("./setup-surface.js").blueBubblesSetupWizard; - -export function sendBlueBubblesMedia( - ...args: Parameters -): ReturnType { - return sendBlueBubblesMediaImpl(...args); -} - -export function resolveBlueBubblesMessageId( - ...args: Parameters -): ReturnType { - return resolveBlueBubblesMessageIdImpl(...args); -} - -export function monitorBlueBubblesProvider( - ...args: Parameters -): ReturnType { - return monitorBlueBubblesProviderImpl(...args); -} - -export function resolveWebhookPathFromConfig( - ...args: Parameters -): ReturnType { - return resolveWebhookPathFromConfigImpl(...args); -} - -export function probeBlueBubbles( - ...args: Parameters -): ReturnType { - return probeBlueBubblesImpl(...args); -} - -export function sendMessageBlueBubbles( - ...args: Parameters -): ReturnType { - return sendMessageBlueBubblesImpl(...args); -} - -export const blueBubblesSetupWizard: BlueBubblesSetupWizard = { ...blueBubblesSetupWizardImpl }; +export const blueBubblesChannelRuntime = { + sendBlueBubblesMedia: sendBlueBubblesMediaImpl, + resolveBlueBubblesMessageId: resolveBlueBubblesMessageIdImpl, + monitorBlueBubblesProvider: monitorBlueBubblesProviderImpl, + resolveWebhookPathFromConfig: resolveWebhookPathFromConfigImpl, + probeBlueBubbles: probeBlueBubblesImpl, + sendMessageBlueBubbles: sendMessageBlueBubblesImpl, +}; diff --git a/extensions/bluebubbles/src/channel.ts b/extensions/bluebubbles/src/channel.ts index 9550c1166ed..f3f3cdd7eb3 100644 --- a/extensions/bluebubbles/src/channel.ts +++ b/extensions/bluebubbles/src/channel.ts @@ -18,6 +18,7 @@ import { buildAccountScopedDmSecurityPolicy, collectOpenGroupPolicyRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { listBlueBubblesAccountIds, type ResolvedBlueBubblesAccount, @@ -37,12 +38,12 @@ import { parseBlueBubblesTarget, } from "./targets.js"; -let blueBubblesChannelRuntimePromise: Promise | null = null; +type BlueBubblesChannelRuntime = typeof import("./channel.runtime.js").blueBubblesChannelRuntime; -function loadBlueBubblesChannelRuntime() { - blueBubblesChannelRuntimePromise ??= import("./channel.runtime.js"); - return blueBubblesChannelRuntimePromise; -} +const loadBlueBubblesChannelRuntime = createLazyRuntimeSurface( + () => import("./channel.runtime.js"), + ({ blueBubblesChannelRuntime }) => blueBubblesChannelRuntime, +); const meta = { id: "bluebubbles", diff --git a/extensions/feishu/src/channel.runtime.ts b/extensions/feishu/src/channel.runtime.ts index c8a742942ea..ef13b721a4e 100644 --- a/extensions/feishu/src/channel.runtime.ts +++ b/extensions/feishu/src/channel.runtime.ts @@ -26,104 +26,22 @@ import { sendMessageFeishu as sendMessageFeishuImpl, } from "./send.js"; -type ListFeishuDirectoryGroupsLive = typeof import("./directory.js").listFeishuDirectoryGroupsLive; -type ListFeishuDirectoryPeersLive = typeof import("./directory.js").listFeishuDirectoryPeersLive; -type FeishuOutbound = typeof import("./outbound.js").feishuOutbound; -type CreatePinFeishu = typeof import("./pins.js").createPinFeishu; -type ListPinsFeishu = typeof import("./pins.js").listPinsFeishu; -type RemovePinFeishu = typeof import("./pins.js").removePinFeishu; -type ProbeFeishu = typeof import("./probe.js").probeFeishu; -type AddReactionFeishu = typeof import("./reactions.js").addReactionFeishu; -type ListReactionsFeishu = typeof import("./reactions.js").listReactionsFeishu; -type RemoveReactionFeishu = typeof import("./reactions.js").removeReactionFeishu; -type GetChatInfo = typeof import("./chat.js").getChatInfo; -type GetChatMembers = typeof import("./chat.js").getChatMembers; -type GetFeishuMemberInfo = typeof import("./chat.js").getFeishuMemberInfo; -type EditMessageFeishu = typeof import("./send.js").editMessageFeishu; -type GetMessageFeishu = typeof import("./send.js").getMessageFeishu; -type SendCardFeishu = typeof import("./send.js").sendCardFeishu; -type SendMessageFeishu = typeof import("./send.js").sendMessageFeishu; - -export function listFeishuDirectoryGroupsLive( - ...args: Parameters -): ReturnType { - return listFeishuDirectoryGroupsLiveImpl(...args); -} - -export function listFeishuDirectoryPeersLive( - ...args: Parameters -): ReturnType { - return listFeishuDirectoryPeersLiveImpl(...args); -} - -export const feishuOutbound: FeishuOutbound = { ...feishuOutboundImpl }; - -export function createPinFeishu(...args: Parameters): ReturnType { - return createPinFeishuImpl(...args); -} - -export function listPinsFeishu(...args: Parameters): ReturnType { - return listPinsFeishuImpl(...args); -} - -export function removePinFeishu(...args: Parameters): ReturnType { - return removePinFeishuImpl(...args); -} - -export function probeFeishu(...args: Parameters): ReturnType { - return probeFeishuImpl(...args); -} - -export function addReactionFeishu( - ...args: Parameters -): ReturnType { - return addReactionFeishuImpl(...args); -} - -export function listReactionsFeishu( - ...args: Parameters -): ReturnType { - return listReactionsFeishuImpl(...args); -} - -export function removeReactionFeishu( - ...args: Parameters -): ReturnType { - return removeReactionFeishuImpl(...args); -} - -export function getChatInfo(...args: Parameters): ReturnType { - return getChatInfoImpl(...args); -} - -export function getChatMembers(...args: Parameters): ReturnType { - return getChatMembersImpl(...args); -} - -export function getFeishuMemberInfo( - ...args: Parameters -): ReturnType { - return getFeishuMemberInfoImpl(...args); -} - -export function editMessageFeishu( - ...args: Parameters -): ReturnType { - return editMessageFeishuImpl(...args); -} - -export function getMessageFeishu( - ...args: Parameters -): ReturnType { - return getMessageFeishuImpl(...args); -} - -export function sendCardFeishu(...args: Parameters): ReturnType { - return sendCardFeishuImpl(...args); -} - -export function sendMessageFeishu( - ...args: Parameters -): ReturnType { - return sendMessageFeishuImpl(...args); -} +export const feishuChannelRuntime = { + listFeishuDirectoryGroupsLive: listFeishuDirectoryGroupsLiveImpl, + listFeishuDirectoryPeersLive: listFeishuDirectoryPeersLiveImpl, + feishuOutbound: { ...feishuOutboundImpl }, + createPinFeishu: createPinFeishuImpl, + listPinsFeishu: listPinsFeishuImpl, + removePinFeishu: removePinFeishuImpl, + probeFeishu: probeFeishuImpl, + addReactionFeishu: addReactionFeishuImpl, + listReactionsFeishu: listReactionsFeishuImpl, + removeReactionFeishu: removeReactionFeishuImpl, + getChatInfo: getChatInfoImpl, + getChatMembers: getChatMembersImpl, + getFeishuMemberInfo: getFeishuMemberInfoImpl, + editMessageFeishu: editMessageFeishuImpl, + getMessageFeishu: getMessageFeishuImpl, + sendCardFeishu: sendCardFeishuImpl, + sendMessageFeishu: sendMessageFeishuImpl, +}; diff --git a/extensions/feishu/src/channel.test.ts b/extensions/feishu/src/channel.test.ts index 826ca1c26fb..7c4ae5d877a 100644 --- a/extensions/feishu/src/channel.test.ts +++ b/extensions/feishu/src/channel.test.ts @@ -28,22 +28,28 @@ vi.mock("./client.js", () => ({ })); vi.mock("./channel.runtime.js", () => ({ - addReactionFeishu: addReactionFeishuMock, - createPinFeishu: createPinFeishuMock, - editMessageFeishu: editMessageFeishuMock, - getChatInfo: getChatInfoMock, - getChatMembers: getChatMembersMock, - getFeishuMemberInfo: getFeishuMemberInfoMock, - getMessageFeishu: getMessageFeishuMock, - listFeishuDirectoryGroupsLive: listFeishuDirectoryGroupsLiveMock, - listFeishuDirectoryPeersLive: listFeishuDirectoryPeersLiveMock, - listPinsFeishu: listPinsFeishuMock, - listReactionsFeishu: listReactionsFeishuMock, - probeFeishu: probeFeishuMock, - removePinFeishu: removePinFeishuMock, - removeReactionFeishu: removeReactionFeishuMock, - sendCardFeishu: sendCardFeishuMock, - sendMessageFeishu: sendMessageFeishuMock, + feishuChannelRuntime: { + addReactionFeishu: addReactionFeishuMock, + createPinFeishu: createPinFeishuMock, + editMessageFeishu: editMessageFeishuMock, + getChatInfo: getChatInfoMock, + getChatMembers: getChatMembersMock, + getFeishuMemberInfo: getFeishuMemberInfoMock, + getMessageFeishu: getMessageFeishuMock, + listFeishuDirectoryGroupsLive: listFeishuDirectoryGroupsLiveMock, + listFeishuDirectoryPeersLive: listFeishuDirectoryPeersLiveMock, + listPinsFeishu: listPinsFeishuMock, + listReactionsFeishu: listReactionsFeishuMock, + probeFeishu: probeFeishuMock, + removePinFeishu: removePinFeishuMock, + removeReactionFeishu: removeReactionFeishuMock, + sendCardFeishu: sendCardFeishuMock, + sendMessageFeishu: sendMessageFeishuMock, + feishuOutbound: { + sendText: vi.fn(), + sendMedia: vi.fn(), + }, + }, })); import { feishuPlugin } from "./channel.js"; diff --git a/extensions/feishu/src/channel.ts b/extensions/feishu/src/channel.ts index 1964331e7e0..c2df79e0028 100644 --- a/extensions/feishu/src/channel.ts +++ b/extensions/feishu/src/channel.ts @@ -12,6 +12,7 @@ import { PAIRING_APPROVED_MESSAGE, } from "openclaw/plugin-sdk/feishu"; import type { ChannelMessageActionName } from "openclaw/plugin-sdk/feishu"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { resolveFeishuAccount, resolveFeishuCredentials, @@ -41,9 +42,12 @@ const meta: ChannelMeta = { order: 70, }; -async function loadFeishuChannelRuntime() { - return await import("./channel.runtime.js"); -} +type FeishuChannelRuntime = typeof import("./channel.runtime.js").feishuChannelRuntime; + +const loadFeishuChannelRuntime = createLazyRuntimeSurface( + () => import("./channel.runtime.js"), + ({ feishuChannelRuntime }) => feishuChannelRuntime, +); function setFeishuNamedAccountEnabled( cfg: ClawdbotConfig, diff --git a/extensions/googlechat/src/channel.runtime.ts b/extensions/googlechat/src/channel.runtime.ts index 1e41376c8f5..81f000f95e7 100644 --- a/extensions/googlechat/src/channel.runtime.ts +++ b/extensions/googlechat/src/channel.runtime.ts @@ -8,36 +8,10 @@ import { startGoogleChatMonitor as startGoogleChatMonitorImpl, } from "./monitor.js"; -type ProbeGoogleChat = typeof import("./api.js").probeGoogleChat; -type SendGoogleChatMessage = typeof import("./api.js").sendGoogleChatMessage; -type UploadGoogleChatAttachment = typeof import("./api.js").uploadGoogleChatAttachment; -type ResolveGoogleChatWebhookPath = typeof import("./monitor.js").resolveGoogleChatWebhookPath; -type StartGoogleChatMonitor = typeof import("./monitor.js").startGoogleChatMonitor; - -export function probeGoogleChat(...args: Parameters): ReturnType { - return probeGoogleChatImpl(...args); -} - -export function sendGoogleChatMessage( - ...args: Parameters -): ReturnType { - return sendGoogleChatMessageImpl(...args); -} - -export function uploadGoogleChatAttachment( - ...args: Parameters -): ReturnType { - return uploadGoogleChatAttachmentImpl(...args); -} - -export function resolveGoogleChatWebhookPath( - ...args: Parameters -): ReturnType { - return resolveGoogleChatWebhookPathImpl(...args); -} - -export function startGoogleChatMonitor( - ...args: Parameters -): ReturnType { - return startGoogleChatMonitorImpl(...args); -} +export const googleChatChannelRuntime = { + probeGoogleChat: probeGoogleChatImpl, + sendGoogleChatMessage: sendGoogleChatMessageImpl, + uploadGoogleChatAttachment: uploadGoogleChatAttachmentImpl, + resolveGoogleChatWebhookPath: resolveGoogleChatWebhookPathImpl, + startGoogleChatMonitor: startGoogleChatMonitorImpl, +}; diff --git a/extensions/googlechat/src/channel.ts b/extensions/googlechat/src/channel.ts index faa1b4e4930..84715321ce8 100644 --- a/extensions/googlechat/src/channel.ts +++ b/extensions/googlechat/src/channel.ts @@ -27,6 +27,7 @@ import { type OpenClawConfig, } from "openclaw/plugin-sdk/googlechat"; import { GoogleChatConfigSchema } from "openclaw/plugin-sdk/googlechat"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { listGoogleChatAccountIds, @@ -47,9 +48,12 @@ import { const meta = getChatChannelMeta("googlechat"); -async function loadGoogleChatChannelRuntime() { - return await import("./channel.runtime.js"); -} +type GoogleChatChannelRuntime = typeof import("./channel.runtime.js").googleChatChannelRuntime; + +const loadGoogleChatChannelRuntime = createLazyRuntimeSurface( + () => import("./channel.runtime.js"), + ({ googleChatChannelRuntime }) => googleChatChannelRuntime, +); const formatAllowFromEntry = (entry: string) => entry diff --git a/extensions/matrix/src/channel.runtime.ts b/extensions/matrix/src/channel.runtime.ts index df56d07ff2c..475d53629e1 100644 --- a/extensions/matrix/src/channel.runtime.ts +++ b/extensions/matrix/src/channel.runtime.ts @@ -7,49 +7,12 @@ import { probeMatrix as probeMatrixImpl } from "./matrix/probe.js"; import { sendMessageMatrix as sendMessageMatrixImpl } from "./matrix/send.js"; import { matrixOutbound as matrixOutboundImpl } from "./outbound.js"; import { resolveMatrixTargets as resolveMatrixTargetsImpl } from "./resolve-targets.js"; - -type ListMatrixDirectoryGroupsLive = - typeof import("./directory-live.js").listMatrixDirectoryGroupsLive; -type ListMatrixDirectoryPeersLive = - typeof import("./directory-live.js").listMatrixDirectoryPeersLive; -type ResolveMatrixAuth = typeof import("./matrix/client.js").resolveMatrixAuth; -type ProbeMatrix = typeof import("./matrix/probe.js").probeMatrix; -type SendMessageMatrix = typeof import("./matrix/send.js").sendMessageMatrix; -type ResolveMatrixTargets = typeof import("./resolve-targets.js").resolveMatrixTargets; -type MatrixOutbound = typeof import("./outbound.js").matrixOutbound; - -export function listMatrixDirectoryGroupsLive( - ...args: Parameters -): ReturnType { - return listMatrixDirectoryGroupsLiveImpl(...args); -} - -export function listMatrixDirectoryPeersLive( - ...args: Parameters -): ReturnType { - return listMatrixDirectoryPeersLiveImpl(...args); -} - -export function resolveMatrixAuth( - ...args: Parameters -): ReturnType { - return resolveMatrixAuthImpl(...args); -} - -export function probeMatrix(...args: Parameters): ReturnType { - return probeMatrixImpl(...args); -} - -export function sendMessageMatrix( - ...args: Parameters -): ReturnType { - return sendMessageMatrixImpl(...args); -} - -export function resolveMatrixTargets( - ...args: Parameters -): ReturnType { - return resolveMatrixTargetsImpl(...args); -} - -export const matrixOutbound: MatrixOutbound = { ...matrixOutboundImpl }; +export const matrixChannelRuntime = { + listMatrixDirectoryGroupsLive: listMatrixDirectoryGroupsLiveImpl, + listMatrixDirectoryPeersLive: listMatrixDirectoryPeersLiveImpl, + resolveMatrixAuth: resolveMatrixAuthImpl, + probeMatrix: probeMatrixImpl, + sendMessageMatrix: sendMessageMatrixImpl, + resolveMatrixTargets: resolveMatrixTargetsImpl, + matrixOutbound: { ...matrixOutboundImpl }, +}; diff --git a/extensions/matrix/src/channel.ts b/extensions/matrix/src/channel.ts index d82d3eb2bdb..03007151d18 100644 --- a/extensions/matrix/src/channel.ts +++ b/extensions/matrix/src/channel.ts @@ -15,6 +15,7 @@ import { PAIRING_APPROVED_MESSAGE, type ChannelPlugin, } from "openclaw/plugin-sdk/matrix"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { buildTrafficStatusSummary } from "../../shared/channel-status-summary.js"; import { matrixMessageActions } from "./actions.js"; import { MatrixConfigSchema } from "./config-schema.js"; @@ -38,9 +39,12 @@ import type { CoreConfig } from "./types.js"; // Mutex for serializing account startup (workaround for concurrent dynamic import race condition) let matrixStartupLock: Promise = Promise.resolve(); -async function loadMatrixChannelRuntime() { - return await import("./channel.runtime.js"); -} +type MatrixChannelRuntime = typeof import("./channel.runtime.js").matrixChannelRuntime; + +const loadMatrixChannelRuntime = createLazyRuntimeSurface( + () => import("./channel.runtime.js"), + ({ matrixChannelRuntime }) => matrixChannelRuntime, +); const meta = { id: "matrix", diff --git a/extensions/msteams/src/channel.runtime.ts b/extensions/msteams/src/channel.runtime.ts index c55d0fc626a..bc6c36a101b 100644 --- a/extensions/msteams/src/channel.runtime.ts +++ b/extensions/msteams/src/channel.runtime.ts @@ -8,42 +8,11 @@ import { sendAdaptiveCardMSTeams as sendAdaptiveCardMSTeamsImpl, sendMessageMSTeams as sendMessageMSTeamsImpl, } from "./send.js"; - -type ListMSTeamsDirectoryGroupsLive = - typeof import("./directory-live.js").listMSTeamsDirectoryGroupsLive; -type ListMSTeamsDirectoryPeersLive = - typeof import("./directory-live.js").listMSTeamsDirectoryPeersLive; -type MSTeamsOutbound = typeof import("./outbound.js").msteamsOutbound; -type ProbeMSTeams = typeof import("./probe.js").probeMSTeams; -type SendAdaptiveCardMSTeams = typeof import("./send.js").sendAdaptiveCardMSTeams; -type SendMessageMSTeams = typeof import("./send.js").sendMessageMSTeams; - -export function listMSTeamsDirectoryGroupsLive( - ...args: Parameters -): ReturnType { - return listMSTeamsDirectoryGroupsLiveImpl(...args); -} - -export function listMSTeamsDirectoryPeersLive( - ...args: Parameters -): ReturnType { - return listMSTeamsDirectoryPeersLiveImpl(...args); -} - -export const msteamsOutbound: MSTeamsOutbound = { ...msteamsOutboundImpl }; - -export function probeMSTeams(...args: Parameters): ReturnType { - return probeMSTeamsImpl(...args); -} - -export function sendAdaptiveCardMSTeams( - ...args: Parameters -): ReturnType { - return sendAdaptiveCardMSTeamsImpl(...args); -} - -export function sendMessageMSTeams( - ...args: Parameters -): ReturnType { - return sendMessageMSTeamsImpl(...args); -} +export const msTeamsChannelRuntime = { + listMSTeamsDirectoryGroupsLive: listMSTeamsDirectoryGroupsLiveImpl, + listMSTeamsDirectoryPeersLive: listMSTeamsDirectoryPeersLiveImpl, + msteamsOutbound: { ...msteamsOutboundImpl }, + probeMSTeams: probeMSTeamsImpl, + sendAdaptiveCardMSTeams: sendAdaptiveCardMSTeamsImpl, + sendMessageMSTeams: sendMessageMSTeamsImpl, +}; diff --git a/extensions/msteams/src/channel.ts b/extensions/msteams/src/channel.ts index d61a377dd4d..e337566e483 100644 --- a/extensions/msteams/src/channel.ts +++ b/extensions/msteams/src/channel.ts @@ -14,6 +14,7 @@ import { MSTeamsConfigSchema, PAIRING_APPROVED_MESSAGE, } from "openclaw/plugin-sdk/msteams"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { resolveMSTeamsGroupToolPolicy } from "./policy.js"; import type { ProbeMSTeamsResult } from "./probe.js"; import { @@ -56,9 +57,12 @@ const TEAMS_GRAPH_PERMISSION_HINTS: Record = { "Files.Read.All": "files (OneDrive)", }; -async function loadMSTeamsChannelRuntime() { - return await import("./channel.runtime.js"); -} +type MSTeamsChannelRuntime = typeof import("./channel.runtime.js").msTeamsChannelRuntime; + +const loadMSTeamsChannelRuntime = createLazyRuntimeSurface( + () => import("./channel.runtime.js"), + ({ msTeamsChannelRuntime }) => msTeamsChannelRuntime, +); export const msteamsPlugin: ChannelPlugin = { id: "msteams", diff --git a/extensions/zalo/src/actions.runtime.ts b/extensions/zalo/src/actions.runtime.ts index d463edc5b24..0fd0a2c6f58 100644 --- a/extensions/zalo/src/actions.runtime.ts +++ b/extensions/zalo/src/actions.runtime.ts @@ -1,7 +1,5 @@ import { sendMessageZalo as sendMessageZaloImpl } from "./send.js"; -type SendMessageZalo = typeof import("./send.js").sendMessageZalo; - -export function sendMessageZalo(...args: Parameters): ReturnType { - return sendMessageZaloImpl(...args); -} +export const zaloActionsRuntime = { + sendMessageZalo: sendMessageZaloImpl, +}; diff --git a/extensions/zalo/src/actions.ts b/extensions/zalo/src/actions.ts index 6f8572b01cd..b492a57a6dc 100644 --- a/extensions/zalo/src/actions.ts +++ b/extensions/zalo/src/actions.ts @@ -4,14 +4,15 @@ import type { OpenClawConfig, } from "openclaw/plugin-sdk/zalo"; import { extractToolSend, jsonResult, readStringParam } from "openclaw/plugin-sdk/zalo"; +import { createLazyRuntimeSurface } from "../../../src/shared/lazy-runtime.js"; import { listEnabledZaloAccounts } from "./accounts.js"; -let zaloActionsRuntimePromise: Promise | null = null; +type ZaloActionsRuntime = typeof import("./actions.runtime.js").zaloActionsRuntime; -async function loadZaloActionsRuntime() { - zaloActionsRuntimePromise ??= import("./actions.runtime.js"); - return zaloActionsRuntimePromise; -} +const loadZaloActionsRuntime = createLazyRuntimeSurface( + () => import("./actions.runtime.js"), + ({ zaloActionsRuntime }) => zaloActionsRuntime, +); const providerId = "zalo"; diff --git a/src/agents/auth-profiles.runtime.ts b/src/agents/auth-profiles.runtime.ts index 5c25bb97c84..7e2da31c058 100644 --- a/src/agents/auth-profiles.runtime.ts +++ b/src/agents/auth-profiles.runtime.ts @@ -1 +1,9 @@ -export { ensureAuthProfileStore } from "./auth-profiles.js"; +import { ensureAuthProfileStore as ensureAuthProfileStoreImpl } from "./auth-profiles.js"; + +type EnsureAuthProfileStore = typeof import("./auth-profiles.js").ensureAuthProfileStore; + +export function ensureAuthProfileStore( + ...args: Parameters +): ReturnType { + return ensureAuthProfileStoreImpl(...args); +} diff --git a/src/agents/command-poll-backoff.runtime.ts b/src/agents/command-poll-backoff.runtime.ts index 1667abba083..87494f4013f 100644 --- a/src/agents/command-poll-backoff.runtime.ts +++ b/src/agents/command-poll-backoff.runtime.ts @@ -1 +1,9 @@ -export { pruneStaleCommandPolls } from "./command-poll-backoff.js"; +import { pruneStaleCommandPolls as pruneStaleCommandPollsImpl } from "./command-poll-backoff.js"; + +type PruneStaleCommandPolls = typeof import("./command-poll-backoff.js").pruneStaleCommandPolls; + +export function pruneStaleCommandPolls( + ...args: Parameters +): ReturnType { + return pruneStaleCommandPollsImpl(...args); +} diff --git a/src/agents/model-suppression.runtime.ts b/src/agents/model-suppression.runtime.ts index 472a662b810..7d39bf2b8a3 100644 --- a/src/agents/model-suppression.runtime.ts +++ b/src/agents/model-suppression.runtime.ts @@ -1 +1,10 @@ -export { shouldSuppressBuiltInModel } from "./model-suppression.js"; +import { shouldSuppressBuiltInModel as shouldSuppressBuiltInModelImpl } from "./model-suppression.js"; + +type ShouldSuppressBuiltInModel = + typeof import("./model-suppression.js").shouldSuppressBuiltInModel; + +export function shouldSuppressBuiltInModel( + ...args: Parameters +): ReturnType { + return shouldSuppressBuiltInModelImpl(...args); +} diff --git a/src/agents/pi-embedded-runner/compact.runtime.ts b/src/agents/pi-embedded-runner/compact.runtime.ts index 33c4ed7066a..f6230265bac 100644 --- a/src/agents/pi-embedded-runner/compact.runtime.ts +++ b/src/agents/pi-embedded-runner/compact.runtime.ts @@ -1 +1,9 @@ -export { compactEmbeddedPiSessionDirect } from "./compact.js"; +import { compactEmbeddedPiSessionDirect as compactEmbeddedPiSessionDirectImpl } from "./compact.js"; + +type CompactEmbeddedPiSessionDirect = typeof import("./compact.js").compactEmbeddedPiSessionDirect; + +export function compactEmbeddedPiSessionDirect( + ...args: Parameters +): ReturnType { + return compactEmbeddedPiSessionDirectImpl(...args); +} diff --git a/src/agents/pi-tools.before-tool-call.runtime.ts b/src/agents/pi-tools.before-tool-call.runtime.ts index b78a58231a2..95126670e31 100644 --- a/src/agents/pi-tools.before-tool-call.runtime.ts +++ b/src/agents/pi-tools.before-tool-call.runtime.ts @@ -1,7 +1,15 @@ -export { getDiagnosticSessionState } from "../logging/diagnostic-session-state.js"; -export { logToolLoopAction } from "../logging/diagnostic.js"; -export { +import { getDiagnosticSessionState } from "../logging/diagnostic-session-state.js"; +import { logToolLoopAction } from "../logging/diagnostic.js"; +import { detectToolCallLoop, recordToolCall, recordToolCallOutcome, } from "./tool-loop-detection.js"; + +export const beforeToolCallRuntime = { + getDiagnosticSessionState, + logToolLoopAction, + detectToolCallLoop, + recordToolCall, + recordToolCallOutcome, +}; diff --git a/src/agents/pi-tools.before-tool-call.ts b/src/agents/pi-tools.before-tool-call.ts index 99a470e8bd0..62bf0e0fb59 100644 --- a/src/agents/pi-tools.before-tool-call.ts +++ b/src/agents/pi-tools.before-tool-call.ts @@ -2,6 +2,7 @@ import type { ToolLoopDetectionConfig } from "../config/types.tools.js"; import type { SessionState } from "../logging/diagnostic-session-state.js"; import { createSubsystemLogger } from "../logging/subsystem.js"; import { getGlobalHookRunner } from "../plugins/hook-runner-global.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import { isPlainObject } from "../utils.js"; import { normalizeToolName } from "./tool-policy.js"; import type { AnyAgentTool } from "./tools/common.js"; @@ -23,14 +24,11 @@ const adjustedParamsByToolCallId = new Map(); const MAX_TRACKED_ADJUSTED_PARAMS = 1024; const LOOP_WARNING_BUCKET_SIZE = 10; const MAX_LOOP_WARNING_KEYS = 256; -let beforeToolCallRuntimePromise: Promise< - typeof import("./pi-tools.before-tool-call.runtime.js") -> | null = null; -function loadBeforeToolCallRuntime() { - beforeToolCallRuntimePromise ??= import("./pi-tools.before-tool-call.runtime.js"); - return beforeToolCallRuntimePromise; -} +const loadBeforeToolCallRuntime = createLazyRuntimeSurface( + () => import("./pi-tools.before-tool-call.runtime.js"), + ({ beforeToolCallRuntime }) => beforeToolCallRuntime, +); function buildAdjustedParamsKey(params: { runId?: string; toolCallId: string }): string { if (params.runId && params.runId.trim()) { diff --git a/src/agents/skills/env-overrides.runtime.ts b/src/agents/skills/env-overrides.runtime.ts index ab8c4b305fb..6f5ebf3947a 100644 --- a/src/agents/skills/env-overrides.runtime.ts +++ b/src/agents/skills/env-overrides.runtime.ts @@ -1 +1,9 @@ -export { getActiveSkillEnvKeys } from "./env-overrides.js"; +import { getActiveSkillEnvKeys as getActiveSkillEnvKeysImpl } from "./env-overrides.js"; + +type GetActiveSkillEnvKeys = typeof import("./env-overrides.js").getActiveSkillEnvKeys; + +export function getActiveSkillEnvKeys( + ...args: Parameters +): ReturnType { + return getActiveSkillEnvKeysImpl(...args); +} diff --git a/src/channels/plugins/setup-wizard-helpers.runtime.ts b/src/channels/plugins/setup-wizard-helpers.runtime.ts index 8c1808f5d40..9fcdf661643 100644 --- a/src/channels/plugins/setup-wizard-helpers.runtime.ts +++ b/src/channels/plugins/setup-wizard-helpers.runtime.ts @@ -1 +1,8 @@ -export { promptResolvedAllowFrom } from "./setup-wizard-helpers.js"; +import type { promptResolvedAllowFrom as promptResolvedAllowFromType } from "./setup-wizard-helpers.js"; + +export async function promptResolvedAllowFrom( + ...args: Parameters +): ReturnType { + const runtime = await import("./setup-wizard-helpers.js"); + return runtime.promptResolvedAllowFrom(...args); +} diff --git a/src/cli/deps.ts b/src/cli/deps.ts index 9996c155288..1d9d6885fe2 100644 --- a/src/cli/deps.ts +++ b/src/cli/deps.ts @@ -1,4 +1,5 @@ import type { OutboundSendDeps } from "../infra/outbound/send-deps.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import { createOutboundSendDepsFromCliSource } from "./outbound-send-mapping.js"; /** @@ -24,10 +25,11 @@ function createLazySender( channelId: string, loader: () => Promise, ): (...args: unknown[]) => Promise { + const loadRuntimeSend = createLazyRuntimeSurface(loader, ({ runtimeSend }) => runtimeSend); return async (...args: unknown[]) => { let cached = senderCache.get(channelId); if (!cached) { - cached = loader().then(({ runtimeSend }) => runtimeSend); + cached = loadRuntimeSend(); senderCache.set(channelId, cached); } const runtimeSend = await cached; diff --git a/src/commands/model-picker.runtime.ts b/src/commands/model-picker.runtime.ts index 3d033fa3e80..f527f0c5cf8 100644 --- a/src/commands/model-picker.runtime.ts +++ b/src/commands/model-picker.runtime.ts @@ -1,7 +1,15 @@ -export { +import { runProviderPluginAuthMethod } from "../plugins/provider-auth-choice.js"; +import { resolveProviderModelPickerEntries, resolveProviderPluginChoice, runProviderModelSelectedHook, } from "../plugins/provider-wizard.js"; -export { resolvePluginProviders } from "../plugins/providers.js"; -export { runProviderPluginAuthMethod } from "../plugins/provider-auth-choice.js"; +import { resolvePluginProviders } from "../plugins/providers.js"; + +export const modelPickerRuntime = { + resolveProviderModelPickerEntries, + resolveProviderPluginChoice, + runProviderModelSelectedHook, + resolvePluginProviders, + runProviderPluginAuthMethod, +}; diff --git a/src/commands/model-picker.test.ts b/src/commands/model-picker.test.ts index a4eb89e066c..fc09d5a7f3c 100644 --- a/src/commands/model-picker.test.ts +++ b/src/commands/model-picker.test.ts @@ -40,11 +40,13 @@ const runProviderModelSelectedHook = vi.hoisted(() => vi.fn(async () => {})); const resolvePluginProviders = vi.hoisted(() => vi.fn(() => [])); const runProviderPluginAuthMethod = vi.hoisted(() => vi.fn()); vi.mock("./model-picker.runtime.js", () => ({ - resolveProviderModelPickerEntries, - resolveProviderPluginChoice, - runProviderModelSelectedHook, - resolvePluginProviders, - runProviderPluginAuthMethod, + modelPickerRuntime: { + resolveProviderModelPickerEntries, + resolveProviderPluginChoice, + runProviderModelSelectedHook, + resolvePluginProviders, + runProviderPluginAuthMethod, + }, })); const OPENROUTER_CATALOG = [ diff --git a/src/commands/model-picker.ts b/src/commands/model-picker.ts index c0b67ea7d7c..cea263f7e58 100644 --- a/src/commands/model-picker.ts +++ b/src/commands/model-picker.ts @@ -13,6 +13,7 @@ import type { OpenClawConfig } from "../config/config.js"; import { resolveAgentModelPrimaryValue } from "../config/model-input.js"; import { applyPrimaryModel } from "../plugins/provider-model-primary.js"; import type { ProviderPlugin } from "../plugins/types.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import type { WizardPrompter, WizardSelectOption } from "../wizard/prompts.js"; import { formatTokenK } from "./models/shared.js"; @@ -49,6 +50,11 @@ async function loadModelPickerRuntime() { return import("./model-picker.runtime.js"); } +const loadResolvedModelPickerRuntime = createLazyRuntimeSurface( + loadModelPickerRuntime, + ({ modelPickerRuntime }) => modelPickerRuntime, +); + function hasAuthForProvider( provider: string, cfg: OpenClawConfig, @@ -284,7 +290,7 @@ export async function promptDefaultModel( options.push({ value: MANUAL_VALUE, label: "Enter model manually" }); } if (includeProviderPluginSetups && agentDir) { - const { resolveProviderModelPickerEntries } = await loadModelPickerRuntime(); + const { resolveProviderModelPickerEntries } = await loadResolvedModelPickerRuntime(); options.push( ...resolveProviderModelPickerEntries({ config: cfg, @@ -343,7 +349,7 @@ export async function promptDefaultModel( if (selection.startsWith("provider-plugin:")) { pluginResolution = selection; } else if (!selection.includes("/")) { - const { resolvePluginProviders } = await loadModelPickerRuntime(); + const { resolvePluginProviders } = await loadResolvedModelPickerRuntime(); pluginProviders = resolvePluginProviders({ config: cfg, workspaceDir: params.workspaceDir, @@ -368,7 +374,7 @@ export async function promptDefaultModel( resolveProviderPluginChoice, runProviderModelSelectedHook, runProviderPluginAuthMethod, - } = await loadModelPickerRuntime(); + } = await loadResolvedModelPickerRuntime(); if (pluginProviders.length === 0) { pluginProviders = resolvePluginProviders({ config: cfg, @@ -404,7 +410,7 @@ export async function promptDefaultModel( return { model: applied.defaultModel, config: applied.config }; } const model = String(selection); - const { runProviderModelSelectedHook } = await loadModelPickerRuntime(); + const { runProviderModelSelectedHook } = await loadResolvedModelPickerRuntime(); await runProviderModelSelectedHook({ config: cfg, model, diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.runtime.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.runtime.ts index a02dd2f2ee2..05422a839fb 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.runtime.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.runtime.ts @@ -1,5 +1,11 @@ -export { resolveProviderPluginChoice } from "../../../plugins/provider-wizard.js"; -export { +import { resolveProviderPluginChoice } from "../../../plugins/provider-wizard.js"; +import { resolveOwningPluginIdsForProvider, resolvePluginProviders, } from "../../../plugins/providers.js"; + +export const authChoicePluginProvidersRuntime = { + resolveOwningPluginIdsForProvider, + resolveProviderPluginChoice, + resolvePluginProviders, +}; diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts index 3ccee9bbfd3..bea20a66764 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.test.ts @@ -11,10 +11,11 @@ const resolveOwningPluginIdsForProvider = vi.hoisted(() => vi.fn(() => undefined const resolveProviderPluginChoice = vi.hoisted(() => vi.fn()); const resolvePluginProviders = vi.hoisted(() => vi.fn(() => [])); vi.mock("./auth-choice.plugin-providers.runtime.js", () => ({ - resolveOwningPluginIdsForProvider, - resolveProviderPluginChoice, - resolvePluginProviders, - PROVIDER_PLUGIN_CHOICE_PREFIX: "provider-plugin:", + authChoicePluginProvidersRuntime: { + resolveOwningPluginIdsForProvider, + resolveProviderPluginChoice, + resolvePluginProviders, + }, })); beforeEach(() => { diff --git a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts index b7a369e4674..ad6cb853955 100644 --- a/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts +++ b/src/commands/onboard-non-interactive/local/auth-choice.plugin-providers.ts @@ -14,6 +14,7 @@ import type { ProviderResolveNonInteractiveApiKeyParams, } from "../../../plugins/types.js"; import type { RuntimeEnv } from "../../../runtime.js"; +import { createLazyRuntimeSurface } from "../../../shared/lazy-runtime.js"; import type { OnboardOptions } from "../../onboard-types.js"; const PROVIDER_PLUGIN_CHOICE_PREFIX = "provider-plugin:"; @@ -22,6 +23,11 @@ async function loadPluginProviderRuntime() { return import("./auth-choice.plugin-providers.runtime.js"); } +const loadAuthChoicePluginProvidersRuntime = createLazyRuntimeSurface( + loadPluginProviderRuntime, + ({ authChoicePluginProvidersRuntime }) => authChoicePluginProvidersRuntime, +); + function buildIsolatedProviderResolutionConfig( cfg: OpenClawConfig, providerId: string | undefined, @@ -81,7 +87,7 @@ export async function applyNonInteractivePluginProviderChoice(params: { preferredProviderId, ); const { resolveOwningPluginIdsForProvider, resolveProviderPluginChoice, resolvePluginProviders } = - await loadPluginProviderRuntime(); + await loadAuthChoicePluginProvidersRuntime(); const owningPluginIds = preferredProviderId ? resolveOwningPluginIdsForProvider({ provider: preferredProviderId, diff --git a/src/commands/status.scan.runtime.ts b/src/commands/status.scan.runtime.ts index 372b31f4803..a783d0a94d6 100644 --- a/src/commands/status.scan.runtime.ts +++ b/src/commands/status.scan.runtime.ts @@ -1,2 +1,7 @@ -export { collectChannelStatusIssues } from "../infra/channels-status-issues.js"; -export { buildChannelsTable } from "./status-all/channels.js"; +import { collectChannelStatusIssues } from "../infra/channels-status-issues.js"; +import { buildChannelsTable } from "./status-all/channels.js"; + +export const statusScanRuntime = { + collectChannelStatusIssues, + buildChannelsTable, +}; diff --git a/src/commands/status.scan.test.ts b/src/commands/status.scan.test.ts index 168c2f55017..899aea2b267 100644 --- a/src/commands/status.scan.test.ts +++ b/src/commands/status.scan.test.ts @@ -42,8 +42,10 @@ vi.mock("./status-all/channels.js", () => ({ })); vi.mock("./status.scan.runtime.js", () => ({ - buildChannelsTable: mocks.buildChannelsTable, - collectChannelStatusIssues: vi.fn(() => []), + statusScanRuntime: { + buildChannelsTable: mocks.buildChannelsTable, + collectChannelStatusIssues: vi.fn(() => []), + }, })); vi.mock("./status.update.js", () => ({ diff --git a/src/commands/status.scan.ts b/src/commands/status.scan.ts index 3eb6fc8ed3d..e7d05542743 100644 --- a/src/commands/status.scan.ts +++ b/src/commands/status.scan.ts @@ -6,14 +6,13 @@ import { withProgress } from "../cli/progress.js"; import type { OpenClawConfig } from "../config/config.js"; import { readBestEffortConfig } from "../config/config.js"; import { callGateway } from "../gateway/call.js"; +import type { collectChannelStatusIssues as collectChannelStatusIssuesFn } from "../infra/channels-status-issues.js"; import { resolveOsSummary } from "../infra/os-summary.js"; import { runExec } from "../process/exec.js"; import type { RuntimeEnv } from "../runtime.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; +import type { buildChannelsTable as buildChannelsTableFn } from "./status-all/channels.js"; import { getAgentLocalStatuses } from "./status.agent-local.js"; -import type { - buildChannelsTable as buildChannelsTableFn, - collectChannelStatusIssues as collectChannelStatusIssuesFn, -} from "./status.scan.runtime.js"; import { buildTailscaleHttpsUrl, pickGatewaySelfPresence, @@ -30,7 +29,6 @@ import { getUpdateCheckResult } from "./status.update.js"; type DeferredResult = { ok: true; value: T } | { ok: false; error: unknown }; let pluginRegistryModulePromise: Promise | undefined; -let statusScanRuntimeModulePromise: Promise | undefined; let statusScanDepsRuntimeModulePromise: | Promise | undefined; @@ -40,10 +38,10 @@ function loadPluginRegistryModule() { return pluginRegistryModulePromise; } -function loadStatusScanRuntimeModule() { - statusScanRuntimeModulePromise ??= import("./status.scan.runtime.js"); - return statusScanRuntimeModulePromise; -} +const loadStatusScanRuntimeModule = createLazyRuntimeSurface( + () => import("./status.scan.runtime.js"), + ({ statusScanRuntime }) => statusScanRuntime, +); function loadStatusScanDepsRuntimeModule() { statusScanDepsRuntimeModulePromise ??= import("./status.scan.deps.runtime.js"); diff --git a/src/commands/status.summary.runtime.ts b/src/commands/status.summary.runtime.ts index df1ae881d4f..e4b08a49856 100644 --- a/src/commands/status.summary.runtime.ts +++ b/src/commands/status.summary.runtime.ts @@ -1,2 +1,8 @@ -export { resolveContextTokensForModel } from "../agents/context.js"; -export { classifySessionKey, resolveSessionModelRef } from "../gateway/session-utils.js"; +import { resolveContextTokensForModel } from "../agents/context.js"; +import { classifySessionKey, resolveSessionModelRef } from "../gateway/session-utils.js"; + +export const statusSummaryRuntime = { + resolveContextTokensForModel, + classifySessionKey, + resolveSessionModelRef, +}; diff --git a/src/commands/status.summary.ts b/src/commands/status.summary.ts index c5c3f174547..c235765b406 100644 --- a/src/commands/status.summary.ts +++ b/src/commands/status.summary.ts @@ -10,14 +10,12 @@ import { listGatewayAgentsBasic } from "../gateway/agent-list.js"; import { resolveHeartbeatSummaryForAgent } from "../infra/heartbeat-summary.js"; import { peekSystemEvents } from "../infra/system-events.js"; import { parseAgentSessionKey } from "../routing/session-key.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import { resolveRuntimeServiceVersion } from "../version.js"; import type { HeartbeatStatus, SessionStatus, StatusSummary } from "./status.types.js"; let channelSummaryModulePromise: Promise | undefined; let linkChannelModulePromise: Promise | undefined; -let statusSummaryRuntimeModulePromise: - | Promise - | undefined; let configIoModulePromise: Promise | undefined; function loadChannelSummaryModule() { @@ -30,10 +28,10 @@ function loadLinkChannelModule() { return linkChannelModulePromise; } -function loadStatusSummaryRuntimeModule() { - statusSummaryRuntimeModulePromise ??= import("./status.summary.runtime.js"); - return statusSummaryRuntimeModulePromise; -} +const loadStatusSummaryRuntimeModule = createLazyRuntimeSurface( + () => import("./status.summary.runtime.js"), + ({ statusSummaryRuntime }) => statusSummaryRuntime, +); function loadConfigIoModule() { configIoModulePromise ??= import("../config/io.js"); diff --git a/src/plugin-sdk/index.ts b/src/plugin-sdk/index.ts index 45465f2f68e..16720cf8961 100644 --- a/src/plugin-sdk/index.ts +++ b/src/plugin-sdk/index.ts @@ -40,13 +40,13 @@ export type { export type { OpenClawConfig } from "../config/config.js"; /** @deprecated Use OpenClawConfig instead */ export type { OpenClawConfig as ClawdbotConfig } from "../config/config.js"; -export { registerContextEngine } from "../context-engine/index.js"; export * from "./image-generation.js"; export type { SecretInput, SecretRef } from "../config/types.secrets.js"; export type { RuntimeEnv } from "../runtime.js"; export type { HookEntry } from "../hooks/types.js"; export type { ReplyPayload } from "../auto-reply/types.js"; export type { WizardPrompter } from "../wizard/prompts.js"; -export type { ContextEngineFactory } from "../context-engine/index.js"; +export type { ContextEngineFactory } from "../context-engine/registry.js"; export { emptyPluginConfigSchema } from "../plugins/config-schema.js"; +export { registerContextEngine } from "../context-engine/registry.js"; diff --git a/src/plugins/provider-api-key-auth.runtime.ts b/src/plugins/provider-api-key-auth.runtime.ts index ad37b986b91..40404f512af 100644 --- a/src/plugins/provider-api-key-auth.runtime.ts +++ b/src/plugins/provider-api-key-auth.runtime.ts @@ -6,7 +6,7 @@ import { } from "./provider-auth-input.js"; import { applyPrimaryModel } from "./provider-model-primary.js"; -export { +export const providerApiKeyAuthRuntime = { applyAuthProfileConfig, applyPrimaryModel, buildApiKeyCredential, diff --git a/src/plugins/provider-api-key-auth.ts b/src/plugins/provider-api-key-auth.ts index aa3805aea8f..183c8c4f5f0 100644 --- a/src/plugins/provider-api-key-auth.ts +++ b/src/plugins/provider-api-key-auth.ts @@ -1,6 +1,7 @@ import { upsertAuthProfile } from "../agents/auth-profiles/profiles.js"; import type { OpenClawConfig } from "../config/config.js"; import type { SecretInput } from "../config/types.secrets.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import { normalizeOptionalSecretInput } from "../utils/normalize-secret-input.js"; import type { ProviderAuthMethod, @@ -29,14 +30,10 @@ type ProviderApiKeyAuthMethodOptions = { applyConfig?: (cfg: OpenClawConfig) => OpenClawConfig; }; -let providerApiKeyAuthRuntimePromise: - | Promise - | undefined; - -function loadProviderApiKeyAuthRuntime() { - providerApiKeyAuthRuntimePromise ??= import("./provider-api-key-auth.runtime.js"); - return providerApiKeyAuthRuntimePromise; -} +const loadProviderApiKeyAuthRuntime = createLazyRuntimeSurface( + () => import("./provider-api-key-auth.runtime.js"), + ({ providerApiKeyAuthRuntime }) => providerApiKeyAuthRuntime, +); function resolveStringOption(opts: Record | undefined, optionKey: string) { return normalizeOptionalSecretInput(opts?.[optionKey]); diff --git a/src/plugins/runtime/runtime-discord.ts b/src/plugins/runtime/runtime-discord.ts index 033c1631828..4878bff3d81 100644 --- a/src/plugins/runtime/runtime-discord.ts +++ b/src/plugins/runtime/runtime-discord.ts @@ -9,123 +9,121 @@ import { setThreadBindingMaxAgeBySessionKey, unbindThreadBindingsBySessionKey, } from "../../../extensions/discord/src/monitor/thread-bindings.js"; +import { createLazyRuntimeMethod, createLazyRuntimeSurface } from "../../shared/lazy-runtime.js"; import { createDiscordTypingLease } from "./runtime-discord-typing.js"; import type { PluginRuntimeChannel } from "./types-channel.js"; type RuntimeDiscordOps = typeof import("./runtime-discord-ops.runtime.js").runtimeDiscordOps; -let runtimeDiscordOpsPromise: Promise | null = null; +const loadRuntimeDiscordOps = createLazyRuntimeSurface( + () => import("./runtime-discord-ops.runtime.js"), + ({ runtimeDiscordOps }) => runtimeDiscordOps, +); -function loadRuntimeDiscordOps() { - runtimeDiscordOpsPromise ??= import("./runtime-discord-ops.runtime.js").then( - ({ runtimeDiscordOps }) => runtimeDiscordOps, - ); - return runtimeDiscordOpsPromise; -} +const auditChannelPermissionsLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.auditChannelPermissions); -const auditChannelPermissionsLazy: PluginRuntimeChannel["discord"]["auditChannelPermissions"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.auditChannelPermissions(...args); - }; +const listDirectoryGroupsLiveLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.listDirectoryGroupsLive); -const listDirectoryGroupsLiveLazy: PluginRuntimeChannel["discord"]["listDirectoryGroupsLive"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.listDirectoryGroupsLive(...args); - }; +const listDirectoryPeersLiveLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.listDirectoryPeersLive); -const listDirectoryPeersLiveLazy: PluginRuntimeChannel["discord"]["listDirectoryPeersLive"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.listDirectoryPeersLive(...args); - }; +const probeDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.probeDiscord); -const probeDiscordLazy: PluginRuntimeChannel["discord"]["probeDiscord"] = async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.probeDiscord(...args); -}; +const resolveChannelAllowlistLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.resolveChannelAllowlist); -const resolveChannelAllowlistLazy: PluginRuntimeChannel["discord"]["resolveChannelAllowlist"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.resolveChannelAllowlist(...args); - }; +const resolveUserAllowlistLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.resolveUserAllowlist); -const resolveUserAllowlistLazy: PluginRuntimeChannel["discord"]["resolveUserAllowlist"] = async ( - ...args -) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.resolveUserAllowlist(...args); -}; +const sendComponentMessageLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.sendComponentMessage); -const sendComponentMessageLazy: PluginRuntimeChannel["discord"]["sendComponentMessage"] = async ( - ...args -) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.sendComponentMessage(...args); -}; +const sendMessageDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.sendMessageDiscord); -const sendMessageDiscordLazy: PluginRuntimeChannel["discord"]["sendMessageDiscord"] = async ( - ...args -) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.sendMessageDiscord(...args); -}; +const sendPollDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.sendPollDiscord); -const sendPollDiscordLazy: PluginRuntimeChannel["discord"]["sendPollDiscord"] = async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.sendPollDiscord(...args); -}; +const monitorDiscordProviderLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.monitorDiscordProvider); -const monitorDiscordProviderLazy: PluginRuntimeChannel["discord"]["monitorDiscordProvider"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.monitorDiscordProvider(...args); - }; +const sendTypingDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.typing.pulse); -const sendTypingDiscordLazy: PluginRuntimeChannel["discord"]["typing"]["pulse"] = async ( - ...args -) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.typing.pulse(...args); -}; +const editMessageDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.editMessage); -const editMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["editMessage"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.editMessage(...args); - }; +const deleteMessageDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>( + loadRuntimeDiscordOps, + (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.deleteMessage, +); -const deleteMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["deleteMessage"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.deleteMessage(...args); - }; +const pinMessageDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.pinMessage); -const pinMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["pinMessage"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.pinMessage(...args); - }; +const unpinMessageDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.unpinMessage); -const unpinMessageDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["unpinMessage"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.unpinMessage(...args); - }; +const createThreadDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.createThread); -const createThreadDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["createThread"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.createThread(...args); - }; - -const editChannelDiscordLazy: PluginRuntimeChannel["discord"]["conversationActions"]["editChannel"] = - async (...args) => { - const runtimeDiscordOps = await loadRuntimeDiscordOps(); - return runtimeDiscordOps.conversationActions.editChannel(...args); - }; +const editChannelDiscordLazy = createLazyRuntimeMethod< + RuntimeDiscordOps, + Parameters, + ReturnType +>(loadRuntimeDiscordOps, (runtimeDiscordOps) => runtimeDiscordOps.conversationActions.editChannel); export function createRuntimeDiscord(): PluginRuntimeChannel["discord"] { return { diff --git a/src/plugins/runtime/runtime-slack.ts b/src/plugins/runtime/runtime-slack.ts index 23d34a7e5f4..30742195ad6 100644 --- a/src/plugins/runtime/runtime-slack.ts +++ b/src/plugins/runtime/runtime-slack.ts @@ -1,65 +1,60 @@ +import { createLazyRuntimeMethod, createLazyRuntimeSurface } from "../../shared/lazy-runtime.js"; import type { PluginRuntimeChannel } from "./types-channel.js"; type RuntimeSlackOps = typeof import("./runtime-slack-ops.runtime.js").runtimeSlackOps; -let runtimeSlackOpsPromise: Promise | null = null; +const loadRuntimeSlackOps = createLazyRuntimeSurface( + () => import("./runtime-slack-ops.runtime.js"), + ({ runtimeSlackOps }) => runtimeSlackOps, +); -function loadRuntimeSlackOps() { - runtimeSlackOpsPromise ??= import("./runtime-slack-ops.runtime.js").then( - ({ runtimeSlackOps }) => runtimeSlackOps, - ); - return runtimeSlackOpsPromise; -} +const listDirectoryGroupsLiveLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.listDirectoryGroupsLive); -const listDirectoryGroupsLiveLazy: PluginRuntimeChannel["slack"]["listDirectoryGroupsLive"] = - async (...args) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.listDirectoryGroupsLive(...args); - }; +const listDirectoryPeersLiveLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.listDirectoryPeersLive); -const listDirectoryPeersLiveLazy: PluginRuntimeChannel["slack"]["listDirectoryPeersLive"] = async ( - ...args -) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.listDirectoryPeersLive(...args); -}; +const probeSlackLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.probeSlack); -const probeSlackLazy: PluginRuntimeChannel["slack"]["probeSlack"] = async (...args) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.probeSlack(...args); -}; +const resolveChannelAllowlistLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.resolveChannelAllowlist); -const resolveChannelAllowlistLazy: PluginRuntimeChannel["slack"]["resolveChannelAllowlist"] = - async (...args) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.resolveChannelAllowlist(...args); - }; +const resolveUserAllowlistLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.resolveUserAllowlist); -const resolveUserAllowlistLazy: PluginRuntimeChannel["slack"]["resolveUserAllowlist"] = async ( - ...args -) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.resolveUserAllowlist(...args); -}; +const sendMessageSlackLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.sendMessageSlack); -const sendMessageSlackLazy: PluginRuntimeChannel["slack"]["sendMessageSlack"] = async (...args) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.sendMessageSlack(...args); -}; +const monitorSlackProviderLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.monitorSlackProvider); -const monitorSlackProviderLazy: PluginRuntimeChannel["slack"]["monitorSlackProvider"] = async ( - ...args -) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.monitorSlackProvider(...args); -}; - -const handleSlackActionLazy: PluginRuntimeChannel["slack"]["handleSlackAction"] = async ( - ...args -) => { - const runtimeSlackOps = await loadRuntimeSlackOps(); - return runtimeSlackOps.handleSlackAction(...args); -}; +const handleSlackActionLazy = createLazyRuntimeMethod< + RuntimeSlackOps, + Parameters, + ReturnType +>(loadRuntimeSlackOps, (runtimeSlackOps) => runtimeSlackOps.handleSlackAction); export function createRuntimeSlack(): PluginRuntimeChannel["slack"] { return { diff --git a/src/plugins/runtime/runtime-telegram.ts b/src/plugins/runtime/runtime-telegram.ts index d0d71d08c4e..b83df21670f 100644 --- a/src/plugins/runtime/runtime-telegram.ts +++ b/src/plugins/runtime/runtime-telegram.ts @@ -5,94 +5,106 @@ import { setTelegramThreadBindingMaxAgeBySessionKey, } from "../../../extensions/telegram/src/thread-bindings.js"; import { resolveTelegramToken } from "../../../extensions/telegram/src/token.js"; +import { createLazyRuntimeMethod, createLazyRuntimeSurface } from "../../shared/lazy-runtime.js"; import { createTelegramTypingLease } from "./runtime-telegram-typing.js"; import type { PluginRuntimeChannel } from "./types-channel.js"; type RuntimeTelegramOps = typeof import("./runtime-telegram-ops.runtime.js").runtimeTelegramOps; -let runtimeTelegramOpsPromise: Promise | null = null; +const loadRuntimeTelegramOps = createLazyRuntimeSurface( + () => import("./runtime-telegram-ops.runtime.js"), + ({ runtimeTelegramOps }) => runtimeTelegramOps, +); -function loadRuntimeTelegramOps() { - runtimeTelegramOpsPromise ??= import("./runtime-telegram-ops.runtime.js").then( - ({ runtimeTelegramOps }) => runtimeTelegramOps, - ); - return runtimeTelegramOpsPromise; -} +const auditGroupMembershipLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.auditGroupMembership); -const auditGroupMembershipLazy: PluginRuntimeChannel["telegram"]["auditGroupMembership"] = async ( - ...args -) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.auditGroupMembership(...args); -}; +const probeTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.probeTelegram); -const probeTelegramLazy: PluginRuntimeChannel["telegram"]["probeTelegram"] = async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.probeTelegram(...args); -}; +const sendMessageTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.sendMessageTelegram); -const sendMessageTelegramLazy: PluginRuntimeChannel["telegram"]["sendMessageTelegram"] = async ( - ...args -) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.sendMessageTelegram(...args); -}; +const sendPollTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.sendPollTelegram); -const sendPollTelegramLazy: PluginRuntimeChannel["telegram"]["sendPollTelegram"] = async ( - ...args -) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.sendPollTelegram(...args); -}; +const monitorTelegramProviderLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.monitorTelegramProvider); -const monitorTelegramProviderLazy: PluginRuntimeChannel["telegram"]["monitorTelegramProvider"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.monitorTelegramProvider(...args); - }; +const sendTypingTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>(loadRuntimeTelegramOps, (runtimeTelegramOps) => runtimeTelegramOps.typing.pulse); -const sendTypingTelegramLazy: PluginRuntimeChannel["telegram"]["typing"]["pulse"] = async ( - ...args -) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.typing.pulse(...args); -}; +const editMessageTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.editMessage, +); -const editMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["editMessage"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.editMessage(...args); - }; +const editMessageReplyMarkupTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.editReplyMarkup, +); -const editMessageReplyMarkupTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["editReplyMarkup"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.editReplyMarkup(...args); - }; +const deleteMessageTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.deleteMessage, +); -const deleteMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["deleteMessage"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.deleteMessage(...args); - }; +const renameForumTopicTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.renameTopic, +); -const renameForumTopicTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["renameTopic"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.renameTopic(...args); - }; +const pinMessageTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.pinMessage, +); -const pinMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["pinMessage"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.pinMessage(...args); - }; - -const unpinMessageTelegramLazy: PluginRuntimeChannel["telegram"]["conversationActions"]["unpinMessage"] = - async (...args) => { - const runtimeTelegramOps = await loadRuntimeTelegramOps(); - return runtimeTelegramOps.conversationActions.unpinMessage(...args); - }; +const unpinMessageTelegramLazy = createLazyRuntimeMethod< + RuntimeTelegramOps, + Parameters, + ReturnType +>( + loadRuntimeTelegramOps, + (runtimeTelegramOps) => runtimeTelegramOps.conversationActions.unpinMessage, +); export function createRuntimeTelegram(): PluginRuntimeChannel["telegram"] { return { diff --git a/src/plugins/runtime/runtime-whatsapp.ts b/src/plugins/runtime/runtime-whatsapp.ts index 10f8e9e6a94..63871bc08f8 100644 --- a/src/plugins/runtime/runtime-whatsapp.ts +++ b/src/plugins/runtime/runtime-whatsapp.ts @@ -6,6 +6,7 @@ import { readWebSelfId, webAuthExists, } from "../../../extensions/whatsapp/src/auth-store.js"; +import { createLazyRuntimeMethod, createLazyRuntimeSurface } from "../../shared/lazy-runtime.js"; import { createRuntimeWhatsAppLoginTool } from "./runtime-whatsapp-login-tool.js"; import type { PluginRuntime } from "./types.js"; @@ -14,24 +15,33 @@ type RuntimeWhatsAppOutbound = type RuntimeWhatsAppLogin = typeof import("./runtime-whatsapp-login.runtime.js").runtimeWhatsAppLogin; -const sendMessageWhatsAppLazy: PluginRuntime["channel"]["whatsapp"]["sendMessageWhatsApp"] = async ( - ...args -) => { - const runtimeWhatsAppOutbound = await loadWebOutbound(); - return runtimeWhatsAppOutbound.sendMessageWhatsApp(...args); -}; +const loadWebOutbound = createLazyRuntimeSurface( + () => import("./runtime-whatsapp-outbound.runtime.js"), + ({ runtimeWhatsAppOutbound }) => runtimeWhatsAppOutbound, +); -const sendPollWhatsAppLazy: PluginRuntime["channel"]["whatsapp"]["sendPollWhatsApp"] = async ( - ...args -) => { - const runtimeWhatsAppOutbound = await loadWebOutbound(); - return runtimeWhatsAppOutbound.sendPollWhatsApp(...args); -}; +const loadWebLogin = createLazyRuntimeSurface( + () => import("./runtime-whatsapp-login.runtime.js"), + ({ runtimeWhatsAppLogin }) => runtimeWhatsAppLogin, +); -const loginWebLazy: PluginRuntime["channel"]["whatsapp"]["loginWeb"] = async (...args) => { - const runtimeWhatsAppLogin = await loadWebLogin(); - return runtimeWhatsAppLogin.loginWeb(...args); -}; +const sendMessageWhatsAppLazy = createLazyRuntimeMethod< + RuntimeWhatsAppOutbound, + Parameters, + ReturnType +>(loadWebOutbound, (runtimeWhatsAppOutbound) => runtimeWhatsAppOutbound.sendMessageWhatsApp); + +const sendPollWhatsAppLazy = createLazyRuntimeMethod< + RuntimeWhatsAppOutbound, + Parameters, + ReturnType +>(loadWebOutbound, (runtimeWhatsAppOutbound) => runtimeWhatsAppOutbound.sendPollWhatsApp); + +const loginWebLazy = createLazyRuntimeMethod< + RuntimeWhatsAppLogin, + Parameters, + ReturnType +>(loadWebLogin, (runtimeWhatsAppLogin) => runtimeWhatsAppLogin.loginWeb); const startWebLoginWithQrLazy: PluginRuntime["channel"]["whatsapp"]["startWebLoginWithQr"] = async ( ...args @@ -64,26 +74,10 @@ let webLoginQrPromise: Promise< typeof import("../../../extensions/whatsapp/src/login-qr.js") > | null = null; let webChannelPromise: Promise | null = null; -let webOutboundPromise: Promise | null = null; -let webLoginPromise: Promise | null = null; let whatsappActionsPromise: Promise< typeof import("../../agents/tools/whatsapp-actions.js") > | null = null; -function loadWebOutbound() { - webOutboundPromise ??= import("./runtime-whatsapp-outbound.runtime.js").then( - ({ runtimeWhatsAppOutbound }) => runtimeWhatsAppOutbound, - ); - return webOutboundPromise; -} - -function loadWebLogin() { - webLoginPromise ??= import("./runtime-whatsapp-login.runtime.js").then( - ({ runtimeWhatsAppLogin }) => runtimeWhatsAppLogin, - ); - return webLoginPromise; -} - function loadWebLoginQr() { webLoginQrPromise ??= import("../../../extensions/whatsapp/src/login-qr.js"); return webLoginQrPromise; diff --git a/src/security/audit-channel.collect.runtime.ts b/src/security/audit-channel.collect.runtime.ts index 6a33ff6a93a..bed24a7f73e 100644 --- a/src/security/audit-channel.collect.runtime.ts +++ b/src/security/audit-channel.collect.runtime.ts @@ -1 +1,10 @@ -export { collectChannelSecurityFindings } from "./audit-channel.js"; +import { collectChannelSecurityFindings as collectChannelSecurityFindingsImpl } from "./audit-channel.js"; + +type CollectChannelSecurityFindings = + typeof import("./audit-channel.js").collectChannelSecurityFindings; + +export function collectChannelSecurityFindings( + ...args: Parameters +): ReturnType { + return collectChannelSecurityFindingsImpl(...args); +} diff --git a/src/security/audit-channel.runtime.ts b/src/security/audit-channel.runtime.ts index 867f0a91162..de2d666cb87 100644 --- a/src/security/audit-channel.runtime.ts +++ b/src/security/audit-channel.runtime.ts @@ -1,9 +1,17 @@ -export { readChannelAllowFromStore } from "../pairing/pairing-store.js"; -export { - isDiscordMutableAllowEntry, - isZalouserMutableGroupEntry, -} from "./mutable-allowlist-detectors.js"; -export { +import { readChannelAllowFromStore } from "../pairing/pairing-store.js"; +import { isNumericTelegramUserId, normalizeTelegramAllowFromEntry, } from "../plugin-sdk/telegram.js"; +import { + isDiscordMutableAllowEntry, + isZalouserMutableGroupEntry, +} from "./mutable-allowlist-detectors.js"; + +export const auditChannelRuntime = { + readChannelAllowFromStore, + isDiscordMutableAllowEntry, + isZalouserMutableGroupEntry, + isNumericTelegramUserId, + normalizeTelegramAllowFromEntry, +}; diff --git a/src/security/audit-channel.ts b/src/security/audit-channel.ts index 44b83c28cc3..dd920e77818 100644 --- a/src/security/audit-channel.ts +++ b/src/security/audit-channel.ts @@ -11,18 +11,15 @@ import { resolveNativeCommandsEnabled, resolveNativeSkillsEnabled } from "../con import type { OpenClawConfig } from "../config/config.js"; import { isDangerousNameMatchingEnabled } from "../config/dangerous-name-matching.js"; import { formatErrorMessage } from "../infra/errors.js"; +import { createLazyRuntimeSurface } from "../shared/lazy-runtime.js"; import { normalizeStringEntries } from "../shared/string-normalization.js"; import type { SecurityAuditFinding, SecurityAuditSeverity } from "./audit.js"; import { resolveDmAllowState } from "./dm-policy-shared.js"; -let auditChannelRuntimeModulePromise: - | Promise - | undefined; - -function loadAuditChannelRuntimeModule() { - auditChannelRuntimeModulePromise ??= import("./audit-channel.runtime.js"); - return auditChannelRuntimeModulePromise; -} +const loadAuditChannelRuntimeModule = createLazyRuntimeSurface( + () => import("./audit-channel.runtime.js"), + ({ auditChannelRuntime }) => auditChannelRuntime, +); function normalizeAllowFromList(list: Array | undefined | null): string[] { return normalizeStringEntries(Array.isArray(list) ? list : undefined); diff --git a/src/security/audit.runtime.ts b/src/security/audit.runtime.ts index 349d2f26fe5..f36d23de14d 100644 --- a/src/security/audit.runtime.ts +++ b/src/security/audit.runtime.ts @@ -1 +1,9 @@ -export { runSecurityAudit } from "./audit.js"; +import { runSecurityAudit as runSecurityAuditImpl } from "./audit.js"; + +type RunSecurityAudit = typeof import("./audit.js").runSecurityAudit; + +export function runSecurityAudit( + ...args: Parameters +): ReturnType { + return runSecurityAuditImpl(...args); +} diff --git a/src/shared/lazy-runtime.ts b/src/shared/lazy-runtime.ts new file mode 100644 index 00000000000..3edaa865f50 --- /dev/null +++ b/src/shared/lazy-runtime.ts @@ -0,0 +1,21 @@ +export function createLazyRuntimeSurface( + importer: () => Promise, + select: (module: TModule) => TSurface, +): () => Promise { + let cached: Promise | null = null; + return () => { + cached ??= importer().then(select); + return cached; + }; +} + +export function createLazyRuntimeMethod( + load: () => Promise, + select: (surface: TSurface) => (...args: TArgs) => TResult, +): (...args: TArgs) => Promise> { + const invoke = async (...args: TArgs): Promise> => { + const method = select(await load()); + return await method(...args); + }; + return invoke; +} From ec1b80809df2b717c321c4bc504ecfc4254e7a96 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:59:19 -0700 Subject: [PATCH 160/187] refactor: remove remaining extension core imports --- .../src/monitor/provider.registry.test.ts | 2 +- .../src/monitor/provider.test-support.ts | 460 +---------------- .../discord/src/monitor/provider.test.ts | 14 +- extensions/discord/src/setup-core.ts | 2 +- extensions/discord/src/setup-surface.ts | 2 +- extensions/discord/src/shared.ts | 10 +- extensions/imessage/src/setup-core.ts | 2 +- extensions/imessage/src/setup-surface.ts | 7 +- extensions/imessage/src/shared.ts | 16 +- extensions/signal/src/setup-core.ts | 4 +- extensions/signal/src/setup-surface.ts | 9 +- extensions/signal/src/shared.ts | 14 +- extensions/slack/src/channel.ts | 4 +- extensions/slack/src/setup-core.ts | 2 +- extensions/slack/src/setup-surface.ts | 2 +- extensions/slack/src/shared.ts | 20 +- extensions/telegram/src/setup-core.ts | 4 +- extensions/telegram/src/shared.ts | 14 +- .../discord-provider.test-support.ts | 472 ++++++++++++++++++ extensions/whatsapp/src/setup-surface.ts | 4 +- extensions/whatsapp/src/shared.ts | 22 +- src/plugin-sdk/slack.ts | 2 + 22 files changed, 560 insertions(+), 528 deletions(-) create mode 100644 extensions/test-utils/discord-provider.test-support.ts diff --git a/extensions/discord/src/monitor/provider.registry.test.ts b/extensions/discord/src/monitor/provider.registry.test.ts index 2187c851f69..1070bb744e3 100644 --- a/extensions/discord/src/monitor/provider.registry.test.ts +++ b/extensions/discord/src/monitor/provider.registry.test.ts @@ -5,7 +5,7 @@ import { baseRuntime, getProviderMonitorTestMocks, resetDiscordProviderMonitorMocks, -} from "./provider.test-support.js"; +} from "../../../test-utils/discord-provider.test-support.js"; const { createDiscordNativeCommandMock, clientHandleDeployRequestMock, monitorLifecycleMock } = getProviderMonitorTestMocks(); diff --git a/extensions/discord/src/monitor/provider.test-support.ts b/extensions/discord/src/monitor/provider.test-support.ts index 23ffb7da2f2..9eebb9ad38d 100644 --- a/extensions/discord/src/monitor/provider.test-support.ts +++ b/extensions/discord/src/monitor/provider.test-support.ts @@ -1,459 +1 @@ -import type { Mock } from "vitest"; -import { expect, vi } from "vitest"; -import type { OpenClawConfig } from "../../../../src/config/config.js"; -import type { RuntimeEnv } from "../../../../src/runtime.js"; - -export type NativeCommandSpecMock = { - name: string; - description: string; - acceptsArgs: boolean; -}; - -export type PluginCommandSpecMock = { - name: string; - description: string; - acceptsArgs: boolean; -}; - -type ProviderMonitorTestMocks = { - clientHandleDeployRequestMock: Mock<() => Promise>; - clientFetchUserMock: Mock<(target: string) => Promise<{ id: string }>>; - clientGetPluginMock: Mock<(name: string) => unknown>; - clientConstructorOptionsMock: Mock<(options?: unknown) => void>; - createDiscordAutoPresenceControllerMock: Mock<() => unknown>; - createDiscordNativeCommandMock: Mock<(params?: { command?: { name?: string } }) => unknown>; - createDiscordMessageHandlerMock: Mock<() => unknown>; - createNoopThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; - createThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; - reconcileAcpThreadBindingsOnStartupMock: Mock<() => unknown>; - createdBindingManagers: Array<{ stop: ReturnType }>; - getAcpSessionStatusMock: Mock< - (params: { - cfg: OpenClawConfig; - sessionKey: string; - signal?: AbortSignal; - }) => Promise<{ state: string }> - >; - getPluginCommandSpecsMock: Mock<() => PluginCommandSpecMock[]>; - listNativeCommandSpecsForConfigMock: Mock<() => NativeCommandSpecMock[]>; - listSkillCommandsForAgentsMock: Mock<() => unknown[]>; - monitorLifecycleMock: Mock<(params: { threadBindings: { stop: () => void } }) => Promise>; - resolveDiscordAccountMock: Mock<() => unknown>; - resolveDiscordAllowlistConfigMock: Mock<() => Promise>; - resolveNativeCommandsEnabledMock: Mock<() => boolean>; - resolveNativeSkillsEnabledMock: Mock<() => boolean>; - isVerboseMock: Mock<() => boolean>; - shouldLogVerboseMock: Mock<() => boolean>; - voiceRuntimeModuleLoadedMock: Mock<() => void>; -}; - -export function baseDiscordAccountConfig() { - return { - commands: { native: true, nativeSkills: false }, - voice: { enabled: false }, - agentComponents: { enabled: false }, - execApprovals: { enabled: false }, - }; -} - -const providerMonitorTestMocks: ProviderMonitorTestMocks = vi.hoisted(() => { - const createdBindingManagers: Array<{ stop: ReturnType }> = []; - const isVerboseMock = vi.fn(() => false); - const shouldLogVerboseMock = vi.fn(() => false); - - return { - clientHandleDeployRequestMock: vi.fn(async () => undefined), - clientFetchUserMock: vi.fn(async (_target: string) => ({ id: "bot-1" })), - clientGetPluginMock: vi.fn<(_name: string) => unknown>(() => undefined), - clientConstructorOptionsMock: vi.fn(), - createDiscordAutoPresenceControllerMock: vi.fn(() => ({ - enabled: false, - start: vi.fn(), - stop: vi.fn(), - refresh: vi.fn(), - runNow: vi.fn(), - })), - createDiscordNativeCommandMock: vi.fn((params?: { command?: { name?: string } }) => ({ - name: params?.command?.name ?? "mock-command", - })), - createDiscordMessageHandlerMock: vi.fn(() => - Object.assign( - vi.fn(async () => undefined), - { - deactivate: vi.fn(), - }, - ), - ), - createNoopThreadBindingManagerMock: vi.fn(() => { - const manager = { stop: vi.fn() }; - createdBindingManagers.push(manager); - return manager; - }), - createThreadBindingManagerMock: vi.fn(() => { - const manager = { stop: vi.fn() }; - createdBindingManagers.push(manager); - return manager; - }), - reconcileAcpThreadBindingsOnStartupMock: vi.fn(() => ({ - checked: 0, - removed: 0, - staleSessionKeys: [], - })), - createdBindingManagers, - getAcpSessionStatusMock: vi.fn( - async (_params: { cfg: OpenClawConfig; sessionKey: string; signal?: AbortSignal }) => ({ - state: "idle", - }), - ), - getPluginCommandSpecsMock: vi.fn<() => PluginCommandSpecMock[]>(() => []), - listNativeCommandSpecsForConfigMock: vi.fn<() => NativeCommandSpecMock[]>(() => [ - { name: "cmd", description: "built-in", acceptsArgs: false }, - ]), - listSkillCommandsForAgentsMock: vi.fn(() => []), - monitorLifecycleMock: vi.fn(async (params: { threadBindings: { stop: () => void } }) => { - params.threadBindings.stop(); - }), - resolveDiscordAccountMock: vi.fn(() => ({ - accountId: "default", - token: "cfg-token", - config: baseDiscordAccountConfig(), - })), - resolveDiscordAllowlistConfigMock: vi.fn(async () => ({ - guildEntries: undefined, - allowFrom: undefined, - })), - resolveNativeCommandsEnabledMock: vi.fn(() => true), - resolveNativeSkillsEnabledMock: vi.fn(() => false), - isVerboseMock, - shouldLogVerboseMock, - voiceRuntimeModuleLoadedMock: vi.fn(), - }; -}); - -const { - clientHandleDeployRequestMock, - clientFetchUserMock, - clientGetPluginMock, - clientConstructorOptionsMock, - createDiscordAutoPresenceControllerMock, - createDiscordNativeCommandMock, - createDiscordMessageHandlerMock, - createNoopThreadBindingManagerMock, - createThreadBindingManagerMock, - reconcileAcpThreadBindingsOnStartupMock, - createdBindingManagers, - getAcpSessionStatusMock, - getPluginCommandSpecsMock, - listNativeCommandSpecsForConfigMock, - listSkillCommandsForAgentsMock, - monitorLifecycleMock, - resolveDiscordAccountMock, - resolveDiscordAllowlistConfigMock, - resolveNativeCommandsEnabledMock, - resolveNativeSkillsEnabledMock, - isVerboseMock, - shouldLogVerboseMock, - voiceRuntimeModuleLoadedMock, -} = providerMonitorTestMocks; - -export function getProviderMonitorTestMocks(): typeof providerMonitorTestMocks { - return providerMonitorTestMocks; -} - -export function mockResolvedDiscordAccountConfig(overrides: Record) { - resolveDiscordAccountMock.mockImplementation(() => ({ - accountId: "default", - token: "cfg-token", - config: { - ...baseDiscordAccountConfig(), - ...overrides, - }, - })); -} - -export function getFirstDiscordMessageHandlerParams() { - expect(createDiscordMessageHandlerMock).toHaveBeenCalledTimes(1); - const firstCall = createDiscordMessageHandlerMock.mock.calls.at(0) as [T] | undefined; - return firstCall?.[0]; -} - -export function resetDiscordProviderMonitorMocks(params?: { - nativeCommands?: NativeCommandSpecMock[]; -}) { - clientHandleDeployRequestMock.mockClear().mockResolvedValue(undefined); - clientFetchUserMock.mockClear().mockResolvedValue({ id: "bot-1" }); - clientGetPluginMock.mockClear().mockReturnValue(undefined); - clientConstructorOptionsMock.mockClear(); - createDiscordAutoPresenceControllerMock.mockClear().mockImplementation(() => ({ - enabled: false, - start: vi.fn(), - stop: vi.fn(), - refresh: vi.fn(), - runNow: vi.fn(), - })); - createDiscordNativeCommandMock.mockClear().mockImplementation((input) => ({ - name: input?.command?.name ?? "mock-command", - })); - createDiscordMessageHandlerMock.mockClear().mockImplementation(() => - Object.assign( - vi.fn(async () => undefined), - { - deactivate: vi.fn(), - }, - ), - ); - createNoopThreadBindingManagerMock.mockClear(); - createThreadBindingManagerMock.mockClear(); - reconcileAcpThreadBindingsOnStartupMock.mockClear().mockReturnValue({ - checked: 0, - removed: 0, - staleSessionKeys: [], - }); - createdBindingManagers.length = 0; - getAcpSessionStatusMock.mockClear().mockResolvedValue({ state: "idle" }); - getPluginCommandSpecsMock.mockClear().mockReturnValue([]); - listNativeCommandSpecsForConfigMock - .mockClear() - .mockReturnValue( - params?.nativeCommands ?? [{ name: "cmd", description: "built-in", acceptsArgs: false }], - ); - listSkillCommandsForAgentsMock.mockClear().mockReturnValue([]); - monitorLifecycleMock.mockClear().mockImplementation(async (monitorParams) => { - monitorParams.threadBindings.stop(); - }); - resolveDiscordAccountMock.mockClear().mockReturnValue({ - accountId: "default", - token: "cfg-token", - config: baseDiscordAccountConfig(), - }); - resolveDiscordAllowlistConfigMock.mockClear().mockResolvedValue({ - guildEntries: undefined, - allowFrom: undefined, - }); - resolveNativeCommandsEnabledMock.mockClear().mockReturnValue(true); - resolveNativeSkillsEnabledMock.mockClear().mockReturnValue(false); - isVerboseMock.mockClear().mockReturnValue(false); - shouldLogVerboseMock.mockClear().mockReturnValue(false); - voiceRuntimeModuleLoadedMock.mockClear(); -} - -export const baseRuntime = (): RuntimeEnv => ({ - log: vi.fn(), - error: vi.fn(), - exit: vi.fn(), -}); - -export const baseConfig = (): OpenClawConfig => - ({ - channels: { - discord: { - accounts: { - default: {}, - }, - }, - }, - }) as OpenClawConfig; - -vi.mock("@buape/carbon", () => { - class ReadyListener {} - class RateLimitError extends Error { - status = 429; - discordCode?: number; - retryAfter: number; - scope: string | null; - bucket: string | null; - constructor( - response: Response, - body: { message: string; retry_after: number; global: boolean }, - ) { - super(body.message); - this.retryAfter = body.retry_after; - this.scope = body.global ? "global" : response.headers.get("X-RateLimit-Scope"); - this.bucket = response.headers.get("X-RateLimit-Bucket"); - } - } - class Client { - listeners: unknown[]; - rest: { put: ReturnType }; - options: unknown; - constructor(options: unknown, handlers: { listeners?: unknown[] }) { - this.options = options; - this.listeners = handlers.listeners ?? []; - this.rest = { put: vi.fn(async () => undefined) }; - clientConstructorOptionsMock(options); - } - async handleDeployRequest() { - return await clientHandleDeployRequestMock(); - } - async fetchUser(target: string) { - return await clientFetchUserMock(target); - } - getPlugin(name: string) { - return clientGetPluginMock(name); - } - } - return { Client, RateLimitError, ReadyListener }; -}); - -vi.mock("@buape/carbon/gateway", () => ({ - GatewayCloseCodes: { DisallowedIntents: 4014 }, -})); - -vi.mock("@buape/carbon/voice", () => ({ - VoicePlugin: class VoicePlugin {}, -})); - -vi.mock("../../../../src/acp/control-plane/manager.js", () => ({ - getAcpSessionManager: () => ({ - getSessionStatus: getAcpSessionStatusMock, - }), -})); - -vi.mock("../../../../src/auto-reply/chunk.js", () => ({ - resolveTextChunkLimit: () => 2000, -})); - -vi.mock("../../../../src/auto-reply/commands-registry.js", () => ({ - listNativeCommandSpecsForConfig: listNativeCommandSpecsForConfigMock, -})); - -vi.mock("../../../../src/auto-reply/skill-commands.js", () => ({ - listSkillCommandsForAgents: listSkillCommandsForAgentsMock, -})); - -vi.mock("../../../../src/config/commands.js", () => ({ - isNativeCommandsExplicitlyDisabled: () => false, - resolveNativeCommandsEnabled: resolveNativeCommandsEnabledMock, - resolveNativeSkillsEnabled: resolveNativeSkillsEnabledMock, -})); - -vi.mock("../../../../src/config/config.js", () => ({ - loadConfig: () => ({}), -})); - -vi.mock("../../../../src/globals.js", () => ({ - danger: (value: string) => value, - isVerbose: isVerboseMock, - logVerbose: vi.fn(), - shouldLogVerbose: shouldLogVerboseMock, - warn: (value: string) => value, -})); - -vi.mock("../../../../src/infra/errors.js", () => ({ - formatErrorMessage: (error: unknown) => String(error), -})); - -vi.mock("../../../../src/infra/retry-policy.js", () => ({ - createDiscordRetryRunner: () => async (run: () => Promise) => run(), -})); - -vi.mock("../../../../src/logging/subsystem.js", () => ({ - createSubsystemLogger: () => { - const logger = { - child: vi.fn(() => logger), - info: vi.fn(), - error: vi.fn(), - warn: vi.fn(), - debug: vi.fn(), - }; - return logger; - }, -})); - -vi.mock("../../../../src/runtime.js", () => ({ - createNonExitingRuntime: () => ({ log: vi.fn(), error: vi.fn(), exit: vi.fn() }), -})); - -vi.mock("../accounts.js", () => ({ - resolveDiscordAccount: resolveDiscordAccountMock, -})); - -vi.mock("../probe.js", () => ({ - fetchDiscordApplicationId: async () => "app-1", -})); - -vi.mock("../token.js", () => ({ - normalizeDiscordToken: (value?: string) => value, -})); - -vi.mock("../voice/command.js", () => ({ - createDiscordVoiceCommand: () => ({ name: "voice-command" }), -})); - -vi.mock("./agent-components.js", () => ({ - createAgentComponentButton: () => ({ id: "btn" }), - createAgentSelectMenu: () => ({ id: "menu" }), - createDiscordComponentButton: () => ({ id: "btn2" }), - createDiscordComponentChannelSelect: () => ({ id: "channel" }), - createDiscordComponentMentionableSelect: () => ({ id: "mentionable" }), - createDiscordComponentModal: () => ({ id: "modal" }), - createDiscordComponentRoleSelect: () => ({ id: "role" }), - createDiscordComponentStringSelect: () => ({ id: "string" }), - createDiscordComponentUserSelect: () => ({ id: "user" }), -})); - -vi.mock("./auto-presence.js", () => ({ - createDiscordAutoPresenceController: createDiscordAutoPresenceControllerMock, -})); - -vi.mock("./commands.js", () => ({ - resolveDiscordSlashCommandConfig: () => ({ ephemeral: false }), -})); - -vi.mock("./exec-approvals.js", () => ({ - createExecApprovalButton: () => ({ id: "exec-approval" }), - DiscordExecApprovalHandler: class DiscordExecApprovalHandler { - async start() { - return undefined; - } - async stop() { - return undefined; - } - }, -})); - -vi.mock("./gateway-plugin.js", () => ({ - createDiscordGatewayPlugin: () => ({ id: "gateway-plugin" }), -})); - -vi.mock("./listeners.js", () => ({ - DiscordMessageListener: class DiscordMessageListener {}, - DiscordPresenceListener: class DiscordPresenceListener {}, - DiscordReactionListener: class DiscordReactionListener {}, - DiscordReactionRemoveListener: class DiscordReactionRemoveListener {}, - DiscordThreadUpdateListener: class DiscordThreadUpdateListener {}, - registerDiscordListener: vi.fn(), -})); - -vi.mock("./message-handler.js", () => ({ - createDiscordMessageHandler: createDiscordMessageHandlerMock, -})); - -vi.mock("./native-command.js", () => ({ - createDiscordCommandArgFallbackButton: () => ({ id: "arg-fallback" }), - createDiscordModelPickerFallbackButton: () => ({ id: "model-fallback-btn" }), - createDiscordModelPickerFallbackSelect: () => ({ id: "model-fallback-select" }), - createDiscordNativeCommand: createDiscordNativeCommandMock, -})); - -vi.mock("./presence.js", () => ({ - resolveDiscordPresenceUpdate: () => undefined, -})); - -vi.mock("./provider.allowlist.js", () => ({ - resolveDiscordAllowlistConfig: resolveDiscordAllowlistConfigMock, -})); - -vi.mock("./provider.lifecycle.js", () => ({ - runDiscordGatewayLifecycle: monitorLifecycleMock, -})); - -vi.mock("./rest-fetch.js", () => ({ - resolveDiscordRestFetch: () => async () => undefined, -})); - -vi.mock("./thread-bindings.js", () => ({ - createNoopThreadBindingManager: createNoopThreadBindingManagerMock, - createThreadBindingManager: createThreadBindingManagerMock, - reconcileAcpThreadBindingsOnStartup: reconcileAcpThreadBindingsOnStartupMock, -})); +export * from "../../../test-utils/discord-provider.test-support.js"; diff --git a/extensions/discord/src/monitor/provider.test.ts b/extensions/discord/src/monitor/provider.test.ts index 14177aec001..4ff936f5519 100644 --- a/extensions/discord/src/monitor/provider.test.ts +++ b/extensions/discord/src/monitor/provider.test.ts @@ -9,7 +9,7 @@ import { getProviderMonitorTestMocks, mockResolvedDiscordAccountConfig, resetDiscordProviderMonitorMocks, -} from "./provider.test-support.js"; +} from "../../../test-utils/discord-provider.test-support.js"; const { clientConstructorOptionsMock, @@ -37,9 +37,15 @@ const { voiceRuntimeModuleLoadedMock, } = getProviderMonitorTestMocks(); -vi.mock("../../../../src/plugins/commands.js", () => ({ - getPluginCommandSpecs: getPluginCommandSpecsMock, -})); +vi.mock("openclaw/plugin-sdk/plugin-runtime", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/plugin-runtime", + ); + return { + ...actual, + getPluginCommandSpecs: getPluginCommandSpecsMock, + }; +}); vi.mock("../voice/manager.runtime.js", () => { voiceRuntimeModuleLoadedMock(); diff --git a/extensions/discord/src/setup-core.ts b/extensions/discord/src/setup-core.ts index 4b807f10a65..f7722a35af5 100644 --- a/extensions/discord/src/setup-core.ts +++ b/extensions/discord/src/setup-core.ts @@ -2,6 +2,7 @@ import type { DiscordGuildEntry } from "openclaw/plugin-sdk/config-runtime"; import { DEFAULT_ACCOUNT_ID, createEnvPatchedAccountSetupAdapter, + formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, parseMentionOrPrefixedId, @@ -16,7 +17,6 @@ import { type ChannelSetupDmPolicy, type ChannelSetupWizard, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, resolveDiscordAccount } from "./accounts.js"; diff --git a/extensions/discord/src/setup-surface.ts b/extensions/discord/src/setup-surface.ts index 66f7f8bbf4b..801f7bf7838 100644 --- a/extensions/discord/src/setup-surface.ts +++ b/extensions/discord/src/setup-surface.ts @@ -1,11 +1,11 @@ import { + formatDocsLink, type OpenClawConfig, promptLegacyChannelAllowFrom, resolveSetupAccountId, type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import { type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultDiscordAccountId, resolveDiscordAccount } from "./accounts.js"; import { normalizeDiscordSlug } from "./monitor/allow-list.js"; import { diff --git a/extensions/discord/src/shared.ts b/extensions/discord/src/shared.ts index 92e248066af..03174404bdb 100644 --- a/extensions/discord/src/shared.ts +++ b/extensions/discord/src/shared.ts @@ -3,10 +3,12 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { DiscordConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; +import { + buildChannelConfigSchema, + DiscordConfigSchema, + getChatChannelMeta, + type ChannelPlugin, +} from "openclaw/plugin-sdk/discord"; import { inspectDiscordAccount } from "./account-inspect.js"; import { listDiscordAccountIds, diff --git a/extensions/imessage/src/setup-core.ts b/extensions/imessage/src/setup-core.ts index 17f1b7487d3..9da4e99b1ef 100644 --- a/extensions/imessage/src/setup-core.ts +++ b/extensions/imessage/src/setup-core.ts @@ -1,5 +1,6 @@ import { createPatchedAccountSetupAdapter, + formatDocsLink, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, setChannelDmPolicyWithAllowFrom, @@ -13,7 +14,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/imessage/src/setup-surface.ts b/extensions/imessage/src/setup-surface.ts index 27e8b256ada..54511d284c4 100644 --- a/extensions/imessage/src/setup-surface.ts +++ b/extensions/imessage/src/setup-surface.ts @@ -1,5 +1,8 @@ -import { setSetupChannelEnabled, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { detectBinary } from "../../../src/plugins/setup-binary.js"; +import { + detectBinary, + setSetupChannelEnabled, + type ChannelSetupWizard, +} from "openclaw/plugin-sdk/setup"; import { listIMessageAccountIds, resolveIMessageAccount } from "./accounts.js"; import { createIMessageCliPathTextInput, diff --git a/extensions/imessage/src/shared.ts b/extensions/imessage/src/shared.ts index 1ede2ad412d..935546721da 100644 --- a/extensions/imessage/src/shared.ts +++ b/extensions/imessage/src/shared.ts @@ -3,19 +3,17 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, - setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { IMessageConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { formatTrimmedAllowFromEntries, + getChatChannelMeta, + IMessageConfigSchema, resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo, -} from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; + setAccountEnabledInConfigSection, + type ChannelPlugin, +} from "openclaw/plugin-sdk/imessage"; import { listIMessageAccountIds, resolveDefaultIMessageAccountId, diff --git a/extensions/signal/src/setup-core.ts b/extensions/signal/src/setup-core.ts index a1433a34f13..e0c4d5ec0a3 100644 --- a/extensions/signal/src/setup-core.ts +++ b/extensions/signal/src/setup-core.ts @@ -1,5 +1,7 @@ import { createPatchedAccountSetupAdapter, + formatCliCommand, + formatDocsLink, normalizeE164, parseSetupEntriesAllowingWildcard, promptParsedAllowFromForScopedChannel, @@ -14,8 +16,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardTextInput, } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/signal/src/setup-surface.ts b/extensions/signal/src/setup-surface.ts index edcea39d6b1..01ded866785 100644 --- a/extensions/signal/src/setup-surface.ts +++ b/extensions/signal/src/setup-surface.ts @@ -1,6 +1,9 @@ -import { setSetupChannelEnabled, type ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { detectBinary } from "../../../src/plugins/setup-binary.js"; -import { installSignalCli } from "../../../src/plugins/signal-cli-install.js"; +import { + detectBinary, + installSignalCli, + setSetupChannelEnabled, + type ChannelSetupWizard, +} from "openclaw/plugin-sdk/setup"; import { listSignalAccountIds, resolveSignalAccount } from "./accounts.js"; import { createSignalCliPathTextInput, diff --git a/extensions/signal/src/shared.ts b/extensions/signal/src/shared.ts index 60dfd0ed010..3de5af7d57a 100644 --- a/extensions/signal/src/shared.ts +++ b/extensions/signal/src/shared.ts @@ -4,15 +4,15 @@ import { collectAllowlistProviderRestrictSendersWarnings, } from "openclaw/plugin-sdk/channel-policy"; import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, deleteAccountFromConfigSection, + getChatChannelMeta, + normalizeE164, setAccountEnabledInConfigSection, -} from "../../../src/channels/plugins/config-helpers.js"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { SignalConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { normalizeE164 } from "../../../src/utils.js"; + SignalConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/signal"; import { listSignalAccountIds, resolveDefaultSignalAccountId, diff --git a/extensions/slack/src/channel.ts b/extensions/slack/src/channel.ts index bafc5fc8c91..5e25f0187b1 100644 --- a/extensions/slack/src/channel.ts +++ b/extensions/slack/src/channel.ts @@ -22,11 +22,11 @@ import { resolveConfiguredFromRequiredCredentialStatuses, resolveSlackGroupRequireMention, resolveSlackGroupToolPolicy, + createSlackActions, type ChannelPlugin, type OpenClawConfig, + type SlackActionContext, } from "openclaw/plugin-sdk/slack"; -import type { SlackActionContext } from "../../../src/agents/tools/slack-actions.js"; -import { createSlackActions } from "../../../src/channels/plugins/slack.actions.js"; import { buildPassiveProbedChannelStatusSummary } from "../../shared/channel-status-summary.js"; import { listEnabledSlackAccounts, diff --git a/extensions/slack/src/setup-core.ts b/extensions/slack/src/setup-core.ts index af71e5edc52..2a3aad980fa 100644 --- a/extensions/slack/src/setup-core.ts +++ b/extensions/slack/src/setup-core.ts @@ -2,6 +2,7 @@ import { createAllowlistSetupWizardProxy, DEFAULT_ACCOUNT_ID, createEnvPatchedAccountSetupAdapter, + formatDocsLink, hasConfiguredSecretInput, type OpenClawConfig, noteChannelLookupFailure, @@ -18,7 +19,6 @@ import { type ChannelSetupWizard, type ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, resolveSlackAccount, type ResolvedSlackAccount } from "./accounts.js"; import { diff --git a/extensions/slack/src/setup-surface.ts b/extensions/slack/src/setup-surface.ts index f7a52a72888..d103a329c50 100644 --- a/extensions/slack/src/setup-surface.ts +++ b/extensions/slack/src/setup-surface.ts @@ -1,4 +1,5 @@ import { + formatDocsLink, noteChannelLookupFailure, noteChannelLookupSummary, type OpenClawConfig, @@ -11,7 +12,6 @@ import type { ChannelSetupWizard, ChannelSetupWizardAllowFromEntry, } from "openclaw/plugin-sdk/setup"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultSlackAccountId, resolveSlackAccount } from "./accounts.js"; import { resolveSlackChannelAllowlist } from "./resolve-channels.js"; import { resolveSlackUserAllowlist } from "./resolve-users.js"; diff --git a/extensions/slack/src/shared.ts b/extensions/slack/src/shared.ts index 4471e851097..58dfae35c90 100644 --- a/extensions/slack/src/shared.ts +++ b/extensions/slack/src/shared.ts @@ -3,14 +3,18 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { patchChannelConfigForAccount } from "../../../src/channels/plugins/setup-wizard-helpers.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { hasConfiguredSecretInput } from "../../../src/config/types.secrets.js"; -import { SlackConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; +import { + formatDocsLink, + hasConfiguredSecretInput, + patchChannelConfigForAccount, +} from "openclaw/plugin-sdk/setup"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + SlackConfigSchema, + type ChannelPlugin, + type OpenClawConfig, +} from "openclaw/plugin-sdk/slack"; import { inspectSlackAccount } from "./account-inspect.js"; import { listSlackAccountIds, diff --git a/extensions/telegram/src/setup-core.ts b/extensions/telegram/src/setup-core.ts index 542fffc0500..7e73898f8b1 100644 --- a/extensions/telegram/src/setup-core.ts +++ b/extensions/telegram/src/setup-core.ts @@ -1,6 +1,8 @@ import { createEnvPatchedAccountSetupAdapter, DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, patchChannelConfigForAccount, promptResolvedAllowFrom, splitSetupEntries, @@ -8,8 +10,6 @@ import { type WizardPrompter, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupAdapter, ChannelSetupDmPolicy } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { resolveDefaultTelegramAccountId, resolveTelegramAccount } from "./accounts.js"; import { fetchTelegramChatId } from "./api-fetch.js"; diff --git a/extensions/telegram/src/shared.ts b/extensions/telegram/src/shared.ts index 335213adead..644869dbc60 100644 --- a/extensions/telegram/src/shared.ts +++ b/extensions/telegram/src/shared.ts @@ -3,12 +3,14 @@ import { createScopedAccountConfigAccessors, createScopedChannelConfigBase, } from "openclaw/plugin-sdk/channel-config-helpers"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import type { OpenClawConfig } from "../../../src/config/config.js"; -import { TelegramConfigSchema } from "../../../src/config/zod-schema.providers-core.js"; -import { normalizeAccountId } from "../../../src/routing/session-key.js"; +import { + buildChannelConfigSchema, + getChatChannelMeta, + normalizeAccountId, + TelegramConfigSchema, + type ChannelPlugin, + type OpenClawConfig, +} from "openclaw/plugin-sdk/telegram"; import { inspectTelegramAccount } from "./account-inspect.js"; import { listTelegramAccountIds, diff --git a/extensions/test-utils/discord-provider.test-support.ts b/extensions/test-utils/discord-provider.test-support.ts new file mode 100644 index 00000000000..ca1d1fd0894 --- /dev/null +++ b/extensions/test-utils/discord-provider.test-support.ts @@ -0,0 +1,472 @@ +import type { OpenClawConfig } from "openclaw/plugin-sdk/discord"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; +import type { Mock } from "vitest"; +import { expect, vi } from "vitest"; + +export type NativeCommandSpecMock = { + name: string; + description: string; + acceptsArgs: boolean; +}; + +export type PluginCommandSpecMock = { + name: string; + description: string; + acceptsArgs: boolean; +}; + +type ProviderMonitorTestMocks = { + clientHandleDeployRequestMock: Mock<() => Promise>; + clientFetchUserMock: Mock<(target: string) => Promise<{ id: string }>>; + clientGetPluginMock: Mock<(name: string) => unknown>; + clientConstructorOptionsMock: Mock<(options?: unknown) => void>; + createDiscordAutoPresenceControllerMock: Mock<() => unknown>; + createDiscordNativeCommandMock: Mock<(params?: { command?: { name?: string } }) => unknown>; + createDiscordMessageHandlerMock: Mock<() => unknown>; + createNoopThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; + createThreadBindingManagerMock: Mock<() => { stop: ReturnType }>; + reconcileAcpThreadBindingsOnStartupMock: Mock<() => unknown>; + createdBindingManagers: Array<{ stop: ReturnType }>; + getAcpSessionStatusMock: Mock< + (params: { + cfg: OpenClawConfig; + sessionKey: string; + signal?: AbortSignal; + }) => Promise<{ state: string }> + >; + getPluginCommandSpecsMock: Mock<() => PluginCommandSpecMock[]>; + listNativeCommandSpecsForConfigMock: Mock<() => NativeCommandSpecMock[]>; + listSkillCommandsForAgentsMock: Mock<() => unknown[]>; + monitorLifecycleMock: Mock<(params: { threadBindings: { stop: () => void } }) => Promise>; + resolveDiscordAccountMock: Mock<() => unknown>; + resolveDiscordAllowlistConfigMock: Mock<() => Promise>; + resolveNativeCommandsEnabledMock: Mock<() => boolean>; + resolveNativeSkillsEnabledMock: Mock<() => boolean>; + isVerboseMock: Mock<() => boolean>; + shouldLogVerboseMock: Mock<() => boolean>; + voiceRuntimeModuleLoadedMock: Mock<() => void>; +}; + +export function baseDiscordAccountConfig() { + return { + commands: { native: true, nativeSkills: false }, + voice: { enabled: false }, + agentComponents: { enabled: false }, + execApprovals: { enabled: false }, + }; +} + +const providerMonitorTestMocks: ProviderMonitorTestMocks = vi.hoisted(() => { + const createdBindingManagers: Array<{ stop: ReturnType }> = []; + const isVerboseMock = vi.fn(() => false); + const shouldLogVerboseMock = vi.fn(() => false); + + return { + clientHandleDeployRequestMock: vi.fn(async () => undefined), + clientFetchUserMock: vi.fn(async (_target: string) => ({ id: "bot-1" })), + clientGetPluginMock: vi.fn<(_name: string) => unknown>(() => undefined), + clientConstructorOptionsMock: vi.fn(), + createDiscordAutoPresenceControllerMock: vi.fn(() => ({ + enabled: false, + start: vi.fn(), + stop: vi.fn(), + refresh: vi.fn(), + runNow: vi.fn(), + })), + createDiscordNativeCommandMock: vi.fn((params?: { command?: { name?: string } }) => ({ + name: params?.command?.name ?? "mock-command", + })), + createDiscordMessageHandlerMock: vi.fn(() => + Object.assign( + vi.fn(async () => undefined), + { + deactivate: vi.fn(), + }, + ), + ), + createNoopThreadBindingManagerMock: vi.fn(() => { + const manager = { stop: vi.fn() }; + createdBindingManagers.push(manager); + return manager; + }), + createThreadBindingManagerMock: vi.fn(() => { + const manager = { stop: vi.fn() }; + createdBindingManagers.push(manager); + return manager; + }), + reconcileAcpThreadBindingsOnStartupMock: vi.fn(() => ({ + checked: 0, + removed: 0, + staleSessionKeys: [], + })), + createdBindingManagers, + getAcpSessionStatusMock: vi.fn( + async (_params: { cfg: OpenClawConfig; sessionKey: string; signal?: AbortSignal }) => ({ + state: "idle", + }), + ), + getPluginCommandSpecsMock: vi.fn<() => PluginCommandSpecMock[]>(() => []), + listNativeCommandSpecsForConfigMock: vi.fn<() => NativeCommandSpecMock[]>(() => [ + { name: "cmd", description: "built-in", acceptsArgs: false }, + ]), + listSkillCommandsForAgentsMock: vi.fn(() => []), + monitorLifecycleMock: vi.fn(async (params: { threadBindings: { stop: () => void } }) => { + params.threadBindings.stop(); + }), + resolveDiscordAccountMock: vi.fn(() => ({ + accountId: "default", + token: "cfg-token", + config: baseDiscordAccountConfig(), + })), + resolveDiscordAllowlistConfigMock: vi.fn(async () => ({ + guildEntries: undefined, + allowFrom: undefined, + })), + resolveNativeCommandsEnabledMock: vi.fn(() => true), + resolveNativeSkillsEnabledMock: vi.fn(() => false), + isVerboseMock, + shouldLogVerboseMock, + voiceRuntimeModuleLoadedMock: vi.fn(), + }; +}); + +const { + clientHandleDeployRequestMock, + clientFetchUserMock, + clientGetPluginMock, + clientConstructorOptionsMock, + createDiscordAutoPresenceControllerMock, + createDiscordNativeCommandMock, + createDiscordMessageHandlerMock, + createNoopThreadBindingManagerMock, + createThreadBindingManagerMock, + reconcileAcpThreadBindingsOnStartupMock, + createdBindingManagers, + getAcpSessionStatusMock, + getPluginCommandSpecsMock, + listNativeCommandSpecsForConfigMock, + listSkillCommandsForAgentsMock, + monitorLifecycleMock, + resolveDiscordAccountMock, + resolveDiscordAllowlistConfigMock, + resolveNativeCommandsEnabledMock, + resolveNativeSkillsEnabledMock, + isVerboseMock, + shouldLogVerboseMock, + voiceRuntimeModuleLoadedMock, +} = providerMonitorTestMocks; + +export function getProviderMonitorTestMocks(): typeof providerMonitorTestMocks { + return providerMonitorTestMocks; +} + +export function mockResolvedDiscordAccountConfig(overrides: Record) { + resolveDiscordAccountMock.mockImplementation(() => ({ + accountId: "default", + token: "cfg-token", + config: { + ...baseDiscordAccountConfig(), + ...overrides, + }, + })); +} + +export function getFirstDiscordMessageHandlerParams() { + expect(createDiscordMessageHandlerMock).toHaveBeenCalledTimes(1); + const firstCall = createDiscordMessageHandlerMock.mock.calls.at(0) as [T] | undefined; + return firstCall?.[0]; +} + +export function resetDiscordProviderMonitorMocks(params?: { + nativeCommands?: NativeCommandSpecMock[]; +}) { + clientHandleDeployRequestMock.mockClear().mockResolvedValue(undefined); + clientFetchUserMock.mockClear().mockResolvedValue({ id: "bot-1" }); + clientGetPluginMock.mockClear().mockReturnValue(undefined); + clientConstructorOptionsMock.mockClear(); + createDiscordAutoPresenceControllerMock.mockClear().mockImplementation(() => ({ + enabled: false, + start: vi.fn(), + stop: vi.fn(), + refresh: vi.fn(), + runNow: vi.fn(), + })); + createDiscordNativeCommandMock.mockClear().mockImplementation((input) => ({ + name: input?.command?.name ?? "mock-command", + })); + createDiscordMessageHandlerMock.mockClear().mockImplementation(() => + Object.assign( + vi.fn(async () => undefined), + { + deactivate: vi.fn(), + }, + ), + ); + createNoopThreadBindingManagerMock.mockClear(); + createThreadBindingManagerMock.mockClear(); + reconcileAcpThreadBindingsOnStartupMock.mockClear().mockReturnValue({ + checked: 0, + removed: 0, + staleSessionKeys: [], + }); + createdBindingManagers.length = 0; + getAcpSessionStatusMock.mockClear().mockResolvedValue({ state: "idle" }); + getPluginCommandSpecsMock.mockClear().mockReturnValue([]); + listNativeCommandSpecsForConfigMock + .mockClear() + .mockReturnValue( + params?.nativeCommands ?? [{ name: "cmd", description: "built-in", acceptsArgs: false }], + ); + listSkillCommandsForAgentsMock.mockClear().mockReturnValue([]); + monitorLifecycleMock.mockClear().mockImplementation(async (monitorParams) => { + monitorParams.threadBindings.stop(); + }); + resolveDiscordAccountMock.mockClear().mockReturnValue({ + accountId: "default", + token: "cfg-token", + config: baseDiscordAccountConfig(), + }); + resolveDiscordAllowlistConfigMock.mockClear().mockResolvedValue({ + guildEntries: undefined, + allowFrom: undefined, + }); + resolveNativeCommandsEnabledMock.mockClear().mockReturnValue(true); + resolveNativeSkillsEnabledMock.mockClear().mockReturnValue(false); + isVerboseMock.mockClear().mockReturnValue(false); + shouldLogVerboseMock.mockClear().mockReturnValue(false); + voiceRuntimeModuleLoadedMock.mockClear(); +} + +export const baseRuntime = (): RuntimeEnv => ({ + log: vi.fn(), + error: vi.fn(), + exit: vi.fn(), +}); + +export const baseConfig = (): OpenClawConfig => + ({ + channels: { + discord: { + accounts: { + default: {}, + }, + }, + }, + }) as OpenClawConfig; + +vi.mock("@buape/carbon", () => { + class ReadyListener {} + class RateLimitError extends Error { + status = 429; + discordCode?: number; + retryAfter: number; + scope: string | null; + bucket: string | null; + constructor( + response: Response, + body: { message: string; retry_after: number; global: boolean }, + ) { + super(body.message); + this.retryAfter = body.retry_after; + this.scope = body.global ? "global" : response.headers.get("X-RateLimit-Scope"); + this.bucket = response.headers.get("X-RateLimit-Bucket"); + } + } + class Client { + listeners: unknown[]; + rest: { put: ReturnType }; + options: unknown; + constructor(options: unknown, handlers: { listeners?: unknown[] }) { + this.options = options; + this.listeners = handlers.listeners ?? []; + this.rest = { put: vi.fn(async () => undefined) }; + clientConstructorOptionsMock(options); + } + async handleDeployRequest() { + return await clientHandleDeployRequestMock(); + } + async fetchUser(target: string) { + return await clientFetchUserMock(target); + } + getPlugin(name: string) { + return clientGetPluginMock(name); + } + } + return { Client, RateLimitError, ReadyListener }; +}); + +vi.mock("@buape/carbon/gateway", () => ({ + GatewayCloseCodes: { DisallowedIntents: 4014 }, +})); + +vi.mock("@buape/carbon/voice", () => ({ + VoicePlugin: class VoicePlugin {}, +})); + +vi.mock("openclaw/plugin-sdk/acp-runtime", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/acp-runtime", + ); + return { + ...actual, + getAcpSessionManager: () => ({ + getSessionStatus: getAcpSessionStatusMock, + }), + isAcpRuntimeError: (error: unknown): error is { code: string } => + error instanceof Error && "code" in error, + }; +}); + +vi.mock("openclaw/plugin-sdk/reply-runtime", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/reply-runtime", + ); + return { + ...actual, + resolveTextChunkLimit: () => 2000, + listNativeCommandSpecsForConfig: listNativeCommandSpecsForConfigMock, + listSkillCommandsForAgents: listSkillCommandsForAgentsMock, + }; +}); + +vi.mock("openclaw/plugin-sdk/config-runtime", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/config-runtime", + ); + return { + ...actual, + isNativeCommandsExplicitlyDisabled: () => false, + loadConfig: () => ({}), + resolveNativeCommandsEnabled: resolveNativeCommandsEnabledMock, + resolveNativeSkillsEnabled: resolveNativeSkillsEnabledMock, + }; +}); + +vi.mock("openclaw/plugin-sdk/runtime-env", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/runtime-env", + ); + return { + ...actual, + danger: (value: string) => value, + isVerbose: isVerboseMock, + logVerbose: vi.fn(), + shouldLogVerbose: shouldLogVerboseMock, + warn: (value: string) => value, + createSubsystemLogger: () => { + const logger = { + child: vi.fn(() => logger), + info: vi.fn(), + error: vi.fn(), + warn: vi.fn(), + debug: vi.fn(), + }; + return logger; + }, + createNonExitingRuntime: () => ({ log: vi.fn(), error: vi.fn(), exit: vi.fn() }), + }; +}); + +vi.mock("openclaw/plugin-sdk/infra-runtime", async () => { + const actual = await vi.importActual( + "openclaw/plugin-sdk/infra-runtime", + ); + return { + ...actual, + formatErrorMessage: (error: unknown) => String(error), + }; +}); + +vi.mock("../discord/src/accounts.js", () => ({ + resolveDiscordAccount: resolveDiscordAccountMock, +})); + +vi.mock("../discord/src/probe.js", () => ({ + fetchDiscordApplicationId: async () => "app-1", +})); + +vi.mock("../discord/src/token.js", () => ({ + normalizeDiscordToken: (value?: string) => value, +})); + +vi.mock("../discord/src/voice/command.js", () => ({ + createDiscordVoiceCommand: () => ({ name: "voice-command" }), +})); + +vi.mock("../discord/src/monitor/agent-components.js", () => ({ + createAgentComponentButton: () => ({ id: "btn" }), + createAgentSelectMenu: () => ({ id: "menu" }), + createDiscordComponentButton: () => ({ id: "btn2" }), + createDiscordComponentChannelSelect: () => ({ id: "channel" }), + createDiscordComponentMentionableSelect: () => ({ id: "mentionable" }), + createDiscordComponentModal: () => ({ id: "modal" }), + createDiscordComponentRoleSelect: () => ({ id: "role" }), + createDiscordComponentStringSelect: () => ({ id: "string" }), + createDiscordComponentUserSelect: () => ({ id: "user" }), +})); + +vi.mock("../discord/src/monitor/auto-presence.js", () => ({ + createDiscordAutoPresenceController: createDiscordAutoPresenceControllerMock, +})); + +vi.mock("../discord/src/monitor/commands.js", () => ({ + resolveDiscordSlashCommandConfig: () => ({ ephemeral: false }), +})); + +vi.mock("../discord/src/monitor/exec-approvals.js", () => ({ + createExecApprovalButton: () => ({ id: "exec-approval" }), + DiscordExecApprovalHandler: class DiscordExecApprovalHandler { + async start() { + return undefined; + } + async stop() { + return undefined; + } + }, +})); + +vi.mock("../discord/src/monitor/gateway-plugin.js", () => ({ + createDiscordGatewayPlugin: () => ({ id: "gateway-plugin" }), +})); + +vi.mock("../discord/src/monitor/listeners.js", () => ({ + DiscordMessageListener: class DiscordMessageListener {}, + DiscordPresenceListener: class DiscordPresenceListener {}, + DiscordReactionListener: class DiscordReactionListener {}, + DiscordReactionRemoveListener: class DiscordReactionRemoveListener {}, + DiscordThreadUpdateListener: class DiscordThreadUpdateListener {}, + registerDiscordListener: vi.fn(), +})); + +vi.mock("../discord/src/monitor/message-handler.js", () => ({ + createDiscordMessageHandler: createDiscordMessageHandlerMock, +})); + +vi.mock("../discord/src/monitor/native-command.js", () => ({ + createDiscordCommandArgFallbackButton: () => ({ id: "arg-fallback" }), + createDiscordModelPickerFallbackButton: () => ({ id: "model-fallback-btn" }), + createDiscordModelPickerFallbackSelect: () => ({ id: "model-fallback-select" }), + createDiscordNativeCommand: createDiscordNativeCommandMock, +})); + +vi.mock("../discord/src/monitor/presence.js", () => ({ + resolveDiscordPresenceUpdate: () => undefined, +})); + +vi.mock("../discord/src/monitor/provider.allowlist.js", () => ({ + resolveDiscordAllowlistConfig: resolveDiscordAllowlistConfigMock, +})); + +vi.mock("../discord/src/monitor/provider.lifecycle.js", () => ({ + runDiscordGatewayLifecycle: monitorLifecycleMock, +})); + +vi.mock("../discord/src/monitor/rest-fetch.js", () => ({ + resolveDiscordRestFetch: () => async () => undefined, +})); + +vi.mock("../discord/src/monitor/thread-bindings.js", () => ({ + createNoopThreadBindingManager: createNoopThreadBindingManagerMock, + createThreadBindingManager: createThreadBindingManagerMock, + reconcileAcpThreadBindingsOnStartup: reconcileAcpThreadBindingsOnStartupMock, +})); diff --git a/extensions/whatsapp/src/setup-surface.ts b/extensions/whatsapp/src/setup-surface.ts index 7bee33c2ef4..4a87ce4d0f8 100644 --- a/extensions/whatsapp/src/setup-surface.ts +++ b/extensions/whatsapp/src/setup-surface.ts @@ -1,6 +1,8 @@ import path from "node:path"; import { DEFAULT_ACCOUNT_ID, + formatCliCommand, + formatDocsLink, normalizeAccountId, normalizeAllowFromEntries, normalizeE164, @@ -11,8 +13,6 @@ import { type OpenClawConfig, } from "openclaw/plugin-sdk/setup"; import type { ChannelSetupWizard } from "openclaw/plugin-sdk/setup"; -import { formatCliCommand } from "../../../src/cli/command-format.js"; -import { formatDocsLink } from "../../../src/terminal/links.js"; import { listWhatsAppAccountIds, resolveWhatsAppAuthDir } from "./accounts.js"; import { loginWeb } from "./login.js"; import { whatsappSetupAdapter } from "./setup-core.js"; diff --git a/extensions/whatsapp/src/shared.ts b/extensions/whatsapp/src/shared.ts index 575954a516c..6616ac6911f 100644 --- a/extensions/whatsapp/src/shared.ts +++ b/extensions/whatsapp/src/shared.ts @@ -3,22 +3,20 @@ import { collectAllowlistProviderGroupPolicyWarnings, collectOpenGroupPolicyRouteAllowlistWarnings, } from "openclaw/plugin-sdk/channel-policy"; -import { buildChannelConfigSchema } from "../../../src/channels/plugins/config-schema.js"; -import { - resolveWhatsAppGroupRequireMention, - resolveWhatsAppGroupToolPolicy, -} from "../../../src/channels/plugins/group-mentions.js"; -import type { ChannelPlugin } from "../../../src/channels/plugins/types.plugin.js"; -import { resolveWhatsAppGroupIntroHint } from "../../../src/channels/plugins/whatsapp-shared.js"; -import { getChatChannelMeta } from "../../../src/channels/registry.js"; -import { WhatsAppConfigSchema } from "../../../src/config/zod-schema.providers-whatsapp.js"; import { + buildChannelConfigSchema, + DEFAULT_ACCOUNT_ID, formatWhatsAppConfigAllowFromEntries, + getChatChannelMeta, + normalizeE164, resolveWhatsAppConfigAllowFrom, resolveWhatsAppConfigDefaultTo, -} from "../../../src/plugin-sdk/channel-config-helpers.js"; -import { DEFAULT_ACCOUNT_ID } from "../../../src/routing/session-key.js"; -import { normalizeE164 } from "../../../src/utils.js"; + resolveWhatsAppGroupIntroHint, + resolveWhatsAppGroupRequireMention, + resolveWhatsAppGroupToolPolicy, + WhatsAppConfigSchema, + type ChannelPlugin, +} from "openclaw/plugin-sdk/whatsapp"; import { listWhatsAppAccountIds, resolveDefaultWhatsAppAccountId, diff --git a/src/plugin-sdk/slack.ts b/src/plugin-sdk/slack.ts index 8e6793543af..0e8ce16aef2 100644 --- a/src/plugin-sdk/slack.ts +++ b/src/plugin-sdk/slack.ts @@ -81,3 +81,5 @@ export { } from "../../extensions/slack/src/actions.js"; export { recordSlackThreadParticipation } from "../../extensions/slack/src/sent-thread-cache.js"; export { handleSlackMessageAction } from "./slack-message-actions.js"; +export { createSlackActions } from "../channels/plugins/slack.actions.js"; +export type { SlackActionContext } from "../agents/tools/slack-actions.js"; From 535475e4cba8b8556823a8356f6cc1caa1de2d56 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:44:08 +0000 Subject: [PATCH 161/187] refactor(payload-tests): reuse empty payload helper --- .../run/payloads.errors.test.ts | 21 +++++-------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts index 61cb7da7891..8fc65c4c42e 100644 --- a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts @@ -248,46 +248,35 @@ describe("buildEmbeddedRunPayloads", () => { }); it("suppresses recoverable tool errors containing 'required' for non-mutating tools", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "browser", error: "url required" }, }); - - // Recoverable errors should not be sent to the user - expect(payloads).toHaveLength(0); }); it("suppresses recoverable tool errors containing 'missing' for non-mutating tools", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "browser", error: "url missing" }, }); - - expect(payloads).toHaveLength(0); }); it("suppresses recoverable tool errors containing 'invalid' for non-mutating tools", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "browser", error: "invalid parameter: url" }, }); - - expect(payloads).toHaveLength(0); }); it("suppresses non-mutating non-recoverable tool errors when messages.suppressToolErrors is enabled", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "browser", error: "connection timeout" }, config: { messages: { suppressToolErrors: true } }, }); - - expect(payloads).toHaveLength(0); }); it("suppresses mutating tool errors when suppressToolErrorWarnings is enabled", () => { - const payloads = buildPayloads({ + expectNoPayloads({ lastToolError: { toolName: "exec", error: "command not found" }, suppressToolErrorWarnings: true, }); - - expect(payloads).toHaveLength(0); }); it.each([ From 93d829b7f669be73f67478c9c03381cfa6b272b4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:46:46 +0000 Subject: [PATCH 162/187] refactor(image-tests): share empty ref assertions --- src/agents/pi-embedded-runner/run/images.test.ts | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/images.test.ts b/src/agents/pi-embedded-runner/run/images.test.ts index 305290df323..c6d50cda57d 100644 --- a/src/agents/pi-embedded-runner/run/images.test.ts +++ b/src/agents/pi-embedded-runner/run/images.test.ts @@ -16,6 +16,11 @@ function expectNoPromptImages(result: { detectedRefs: unknown[]; images: unknown expect(result.images).toHaveLength(0); } +function expectNoImageReferences(prompt: string) { + const refs = detectImageReferences(prompt); + expect(refs).toHaveLength(0); +} + describe("detectImageReferences", () => { it("detects absolute file paths with common extensions", () => { const prompt = "Check this image /path/to/screenshot.png and tell me what you see"; @@ -99,17 +104,11 @@ describe("detectImageReferences", () => { }); it("returns empty array when no images found", () => { - const prompt = "Just some text without any image references"; - const refs = detectImageReferences(prompt); - - expect(refs).toHaveLength(0); + expectNoImageReferences("Just some text without any image references"); }); it("ignores non-image file extensions", () => { - const prompt = "Check /path/to/document.pdf and /code/file.ts"; - const refs = detectImageReferences(prompt); - - expect(refs).toHaveLength(0); + expectNoImageReferences("Check /path/to/document.pdf and /code/file.ts"); }); it("handles paths inside quotes (without spaces)", () => { From 1373821470f1f23ade60f44fc752d8fe1a3da5b5 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:48:18 +0000 Subject: [PATCH 163/187] refactor(image-tests): share single-ref detection helper --- .../pi-embedded-runner/run/images.test.ts | 96 +++++++++---------- 1 file changed, 44 insertions(+), 52 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/images.test.ts b/src/agents/pi-embedded-runner/run/images.test.ts index c6d50cda57d..30bb5ea1030 100644 --- a/src/agents/pi-embedded-runner/run/images.test.ts +++ b/src/agents/pi-embedded-runner/run/images.test.ts @@ -21,13 +21,19 @@ function expectNoImageReferences(prompt: string) { expect(refs).toHaveLength(0); } +function expectSingleImageReference(prompt: string) { + const refs = detectImageReferences(prompt); + expect(refs).toHaveLength(1); + return refs[0]; +} + describe("detectImageReferences", () => { it("detects absolute file paths with common extensions", () => { - const prompt = "Check this image /path/to/screenshot.png and tell me what you see"; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference( + "Check this image /path/to/screenshot.png and tell me what you see", + ); - expect(refs).toHaveLength(1); - expect(refs[0]).toEqual({ + expect(ref).toEqual({ raw: "/path/to/screenshot.png", type: "path", resolved: "/path/to/screenshot.png", @@ -35,32 +41,26 @@ describe("detectImageReferences", () => { }); it("detects relative paths starting with ./", () => { - const prompt = "Look at ./images/photo.jpg"; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference("Look at ./images/photo.jpg"); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("./images/photo.jpg"); - expect(refs[0]?.type).toBe("path"); + expect(ref?.raw).toBe("./images/photo.jpg"); + expect(ref?.type).toBe("path"); }); it("detects relative paths starting with ../", () => { - const prompt = "The file is at ../screenshots/test.jpeg"; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference("The file is at ../screenshots/test.jpeg"); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("../screenshots/test.jpeg"); - expect(refs[0]?.type).toBe("path"); + expect(ref?.raw).toBe("../screenshots/test.jpeg"); + expect(ref?.type).toBe("path"); }); it("detects home directory paths starting with ~/", () => { - const prompt = "My photo is at ~/Pictures/vacation.png"; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference("My photo is at ~/Pictures/vacation.png"); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("~/Pictures/vacation.png"); - expect(refs[0]?.type).toBe("path"); + expect(ref?.raw).toBe("~/Pictures/vacation.png"); + expect(ref?.type).toBe("path"); // Resolved path should expand ~ - expect(refs[0]?.resolved?.startsWith("~")).toBe(false); + expect(ref?.resolved?.startsWith("~")).toBe(false); }); it("detects multiple image references in a prompt", () => { @@ -112,37 +112,31 @@ describe("detectImageReferences", () => { }); it("handles paths inside quotes (without spaces)", () => { - const prompt = 'The file is at "/path/to/image.png"'; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference('The file is at "/path/to/image.png"'); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("/path/to/image.png"); + expect(ref?.raw).toBe("/path/to/image.png"); }); it("handles paths in parentheses", () => { - const prompt = "See the image (./screenshot.png) for details"; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference("See the image (./screenshot.png) for details"); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("./screenshot.png"); + expect(ref?.raw).toBe("./screenshot.png"); }); it("detects [Image: source: ...] format from messaging systems", () => { - const prompt = `What does this image show? -[Image: source: /Users/tyleryust/Library/Messages/Attachments/IMG_0043.jpeg]`; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference(`What does this image show? +[Image: source: /Users/tyleryust/Library/Messages/Attachments/IMG_0043.jpeg]`); - expect(refs).toHaveLength(1); - expect(refs[0]?.raw).toBe("/Users/tyleryust/Library/Messages/Attachments/IMG_0043.jpeg"); - expect(refs[0]?.type).toBe("path"); + expect(ref?.raw).toBe("/Users/tyleryust/Library/Messages/Attachments/IMG_0043.jpeg"); + expect(ref?.type).toBe("path"); }); it("handles complex message attachment paths", () => { - const prompt = `[Image: source: /Users/tyleryust/Library/Messages/Attachments/23/03/AA4726EA-DB27-4269-BA56-1436936CC134/5E3E286A-F585-4E5E-9043-5BC2AFAFD81BIMG_0043.jpeg]`; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference( + "[Image: source: /Users/tyleryust/Library/Messages/Attachments/23/03/AA4726EA-DB27-4269-BA56-1436936CC134/5E3E286A-F585-4E5E-9043-5BC2AFAFD81BIMG_0043.jpeg]", + ); - expect(refs).toHaveLength(1); - expect(refs[0]?.resolved).toContain("IMG_0043.jpeg"); + expect(ref?.resolved).toContain("IMG_0043.jpeg"); }); it("detects multiple images in [media attached: ...] format", () => { @@ -160,11 +154,11 @@ what about these images?`; it("does not double-count path and url in same bracket", () => { // Single file with URL (| separates path from url, not multiple files) - const prompt = `[media attached: /cache/IMG_6430.jpeg (image/jpeg) | /cache/IMG_6430.jpeg]`; - const refs = detectImageReferences(prompt); + const ref = expectSingleImageReference( + "[media attached: /cache/IMG_6430.jpeg (image/jpeg) | /cache/IMG_6430.jpeg]", + ); - expect(refs).toHaveLength(1); - expect(refs[0]?.resolved).toContain("IMG_6430.jpeg"); + expect(ref?.resolved).toContain("IMG_6430.jpeg"); }); it("ignores remote URLs entirely (local-only)", () => { @@ -178,23 +172,21 @@ Also https://cdn.mysite.com/img.jpg`; }); it("handles single file format with URL (no index)", () => { - const prompt = `[media attached: /cache/photo.jpeg (image/jpeg) | https://example.com/url] -what is this?`; - const refs = detectImageReferences(prompt); + const ref = + expectSingleImageReference(`[media attached: /cache/photo.jpeg (image/jpeg) | https://example.com/url] +what is this?`); - expect(refs).toHaveLength(1); - expect(refs[0]?.resolved).toContain("photo.jpeg"); + expect(ref?.resolved).toContain("photo.jpeg"); }); it("handles paths with spaces in filename", () => { // URL after | is https, not a local path, so only the local path should be detected - const prompt = `[media attached: /Users/test/.openclaw/media/ChatGPT Image Apr 21, 2025.png (image/png) | https://example.com/same.png] -what is this?`; - const refs = detectImageReferences(prompt); + const ref = + expectSingleImageReference(`[media attached: /Users/test/.openclaw/media/ChatGPT Image Apr 21, 2025.png (image/png) | https://example.com/same.png] +what is this?`); // Only 1 ref - the local path (example.com URLs are skipped) - expect(refs).toHaveLength(1); - expect(refs[0]?.resolved).toContain("ChatGPT Image Apr 21, 2025.png"); + expect(ref?.resolved).toContain("ChatGPT Image Apr 21, 2025.png"); }); }); From 2847ad1f8fa65386ed375b3efbd33f428cb79aca Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:49:41 +0000 Subject: [PATCH 164/187] refactor(image-tests): share ref count assertions --- .../pi-embedded-runner/run/images.test.ts | 48 ++++++++++--------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/images.test.ts b/src/agents/pi-embedded-runner/run/images.test.ts index 30bb5ea1030..59b3673e90f 100644 --- a/src/agents/pi-embedded-runner/run/images.test.ts +++ b/src/agents/pi-embedded-runner/run/images.test.ts @@ -21,9 +21,14 @@ function expectNoImageReferences(prompt: string) { expect(refs).toHaveLength(0); } -function expectSingleImageReference(prompt: string) { +function expectImageReferenceCount(prompt: string, count: number) { const refs = detectImageReferences(prompt); - expect(refs).toHaveLength(1); + expect(refs).toHaveLength(count); + return refs; +} + +function expectSingleImageReference(prompt: string) { + const refs = expectImageReferenceCount(prompt, 1); return refs[0]; } @@ -64,14 +69,15 @@ describe("detectImageReferences", () => { }); it("detects multiple image references in a prompt", () => { - const prompt = ` + const refs = expectImageReferenceCount( + ` Compare these two images: 1. /home/user/photo1.png 2. https://mysite.com/photo2.jpg - `; - const refs = detectImageReferences(prompt); + `, + 1, + ); - expect(refs).toHaveLength(1); expect(refs.some((r) => r.type === "path")).toBe(true); }); @@ -86,21 +92,15 @@ describe("detectImageReferences", () => { }); it("deduplicates repeated image references", () => { - const prompt = "Look at /path/image.png and also /path/image.png again"; - const refs = detectImageReferences(prompt); - - expect(refs).toHaveLength(1); + expectImageReferenceCount("Look at /path/image.png and also /path/image.png again", 1); }); it("dedupe casing follows host filesystem conventions", () => { - const prompt = "Look at /tmp/Image.png and /tmp/image.png"; - const refs = detectImageReferences(prompt); - if (process.platform === "win32") { - expect(refs).toHaveLength(1); + expectImageReferenceCount("Look at /tmp/Image.png and /tmp/image.png", 1); return; } - expect(refs).toHaveLength(2); + expectImageReferenceCount("Look at /tmp/Image.png and /tmp/image.png", 2); }); it("returns empty array when no images found", () => { @@ -141,13 +141,14 @@ describe("detectImageReferences", () => { it("detects multiple images in [media attached: ...] format", () => { // Multi-file format uses separate brackets on separate lines - const prompt = `[media attached: 2 files] + const refs = expectImageReferenceCount( + `[media attached: 2 files] [media attached 1/2: /Users/tyleryust/.openclaw/media/IMG_6430.jpeg (image/jpeg)] [media attached 2/2: /Users/tyleryust/.openclaw/media/IMG_6431.jpeg (image/jpeg)] -what about these images?`; - const refs = detectImageReferences(prompt); +what about these images?`, + 2, + ); - expect(refs).toHaveLength(2); expect(refs[0]?.resolved).toContain("IMG_6430.jpeg"); expect(refs[1]?.resolved).toContain("IMG_6431.jpeg"); }); @@ -162,12 +163,13 @@ what about these images?`; }); it("ignores remote URLs entirely (local-only)", () => { - const prompt = `To send an image: MEDIA:https://example.com/image.jpg + const refs = expectImageReferenceCount( + `To send an image: MEDIA:https://example.com/image.jpg Here is my actual image: /path/to/real.png -Also https://cdn.mysite.com/img.jpg`; - const refs = detectImageReferences(prompt); +Also https://cdn.mysite.com/img.jpg`, + 1, + ); - expect(refs).toHaveLength(1); expect(refs[0]?.raw).toBe("/path/to/real.png"); }); From b531af82d5b5cf20ab3c6b3c83bb1778ad886d32 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:50:57 +0000 Subject: [PATCH 165/187] refactor(history-tests): share array content assertion --- .../run/history-image-prune.test.ts | 32 ++++++++++--------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts index dbed0335435..e25b447827b 100644 --- a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts +++ b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts @@ -4,6 +4,16 @@ import { describe, expect, it } from "vitest"; import { castAgentMessage } from "../../test-helpers/agent-message-fixtures.js"; import { PRUNED_HISTORY_IMAGE_MARKER, pruneProcessedHistoryImages } from "./history-image-prune.js"; +function expectArrayMessageContent( + message: AgentMessage | undefined, + errorMessage: string, +): Array<{ type: string; text?: string; data?: string }> { + if (!message || !Array.isArray(message.content)) { + throw new Error(errorMessage); + } + return message.content as Array<{ type: string; text?: string; data?: string }>; +} + describe("pruneProcessedHistoryImages", () => { const image: ImageContent = { type: "image", data: "abc", mimeType: "image/png" }; @@ -22,9 +32,7 @@ describe("pruneProcessedHistoryImages", () => { const didMutate = pruneProcessedHistoryImages(messages); expect(didMutate).toBe(true); - const firstUser = messages[0] as Extract | undefined; - expect(Array.isArray(firstUser?.content)).toBe(true); - const content = firstUser?.content as Array<{ type: string; text?: string; data?: string }>; + const content = expectArrayMessageContent(messages[0], "expected user array content"); expect(content).toHaveLength(2); expect(content[0]?.type).toBe("text"); expect(content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); @@ -41,12 +49,9 @@ describe("pruneProcessedHistoryImages", () => { const didMutate = pruneProcessedHistoryImages(messages); expect(didMutate).toBe(false); - const first = messages[0] as Extract | undefined; - if (!first || !Array.isArray(first.content)) { - throw new Error("expected array content"); - } - expect(first.content).toHaveLength(2); - expect(first.content[1]).toMatchObject({ type: "image", data: "abc" }); + const content = expectArrayMessageContent(messages[0], "expected user array content"); + expect(content).toHaveLength(2); + expect(content[1]).toMatchObject({ type: "image", data: "abc" }); }); it("prunes image blocks from toolResult messages that already have assistant replies", () => { @@ -65,12 +70,9 @@ describe("pruneProcessedHistoryImages", () => { const didMutate = pruneProcessedHistoryImages(messages); expect(didMutate).toBe(true); - const firstTool = messages[0] as Extract | undefined; - if (!firstTool || !Array.isArray(firstTool.content)) { - throw new Error("expected toolResult array content"); - } - expect(firstTool.content).toHaveLength(2); - expect(firstTool.content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); + const content = expectArrayMessageContent(messages[0], "expected toolResult array content"); + expect(content).toHaveLength(2); + expect(content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); }); it("does not change messages when no assistant turn exists", () => { From 8c8b0ab22448679d9ea40969fbf3c8a38d8c6759 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:51:58 +0000 Subject: [PATCH 166/187] refactor(runs-tests): share run handle factory --- src/agents/pi-embedded-runner/runs.test.ts | 70 +++++++--------------- 1 file changed, 22 insertions(+), 48 deletions(-) diff --git a/src/agents/pi-embedded-runner/runs.test.ts b/src/agents/pi-embedded-runner/runs.test.ts index 3a4eb6d3743..f4a154d0141 100644 --- a/src/agents/pi-embedded-runner/runs.test.ts +++ b/src/agents/pi-embedded-runner/runs.test.ts @@ -10,6 +10,17 @@ import { waitForActiveEmbeddedRuns, } from "./runs.js"; +function createRunHandle( + overrides: { isCompacting?: boolean; abort?: ReturnType } = {}, +) { + return { + queueMessage: async () => {}, + isStreaming: () => true, + isCompacting: () => overrides.isCompacting ?? false, + abort: overrides.abort ?? vi.fn(), + }; +} + describe("pi-embedded runner run registry", () => { afterEach(() => { __testing.resetActiveEmbeddedRuns(); @@ -20,19 +31,12 @@ describe("pi-embedded runner run registry", () => { const abortCompacting = vi.fn(); const abortNormal = vi.fn(); - setActiveEmbeddedRun("session-compacting", { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => true, - abort: abortCompacting, - }); + setActiveEmbeddedRun( + "session-compacting", + createRunHandle({ isCompacting: true, abort: abortCompacting }), + ); - setActiveEmbeddedRun("session-normal", { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: abortNormal, - }); + setActiveEmbeddedRun("session-normal", createRunHandle({ abort: abortNormal })); const aborted = abortEmbeddedPiRun(undefined, { mode: "compacting" }); expect(aborted).toBe(true); @@ -44,19 +48,9 @@ describe("pi-embedded runner run registry", () => { const abortA = vi.fn(); const abortB = vi.fn(); - setActiveEmbeddedRun("session-a", { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => true, - abort: abortA, - }); + setActiveEmbeddedRun("session-a", createRunHandle({ isCompacting: true, abort: abortA })); - setActiveEmbeddedRun("session-b", { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: abortB, - }); + setActiveEmbeddedRun("session-b", createRunHandle({ abort: abortB })); const aborted = abortEmbeddedPiRun(undefined, { mode: "all" }); expect(aborted).toBe(true); @@ -67,12 +61,7 @@ describe("pi-embedded runner run registry", () => { it("waits for active runs to drain", async () => { vi.useFakeTimers(); try { - const handle = { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: vi.fn(), - }; + const handle = createRunHandle(); setActiveEmbeddedRun("session-a", handle); setTimeout(() => { clearActiveEmbeddedRun("session-a", handle); @@ -92,12 +81,7 @@ describe("pi-embedded runner run registry", () => { it("returns drained=false when timeout elapses", async () => { vi.useFakeTimers(); try { - setActiveEmbeddedRun("session-a", { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: vi.fn(), - }); + setActiveEmbeddedRun("session-a", createRunHandle()); const waitPromise = waitForActiveEmbeddedRuns(1_000, { pollMs: 100 }); await vi.advanceTimersByTimeAsync(1_000); @@ -118,12 +102,7 @@ describe("pi-embedded runner run registry", () => { import.meta.url, "./runs.js?scope=shared-b", ); - const handle = { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: vi.fn(), - }; + const handle = createRunHandle(); runsA.__testing.resetActiveEmbeddedRuns(); runsB.__testing.resetActiveEmbeddedRuns(); @@ -141,12 +120,7 @@ describe("pi-embedded runner run registry", () => { }); it("tracks and clears per-session transcript snapshots for active runs", () => { - const handle = { - queueMessage: async () => {}, - isStreaming: () => true, - isCompacting: () => false, - abort: vi.fn(), - }; + const handle = createRunHandle(); setActiveEmbeddedRun("session-snapshot", handle); updateActiveEmbeddedRunSnapshot("session-snapshot", { From e510132f3c965e0d939c438b4e8513dd0a634e91 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:54:33 +0000 Subject: [PATCH 167/187] refactor(skills-tests): share bundled diffs setup --- .../skills-runtime.integration.test.ts | 25 ++++++++----------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/src/agents/pi-embedded-runner/skills-runtime.integration.test.ts b/src/agents/pi-embedded-runner/skills-runtime.integration.test.ts index 8d42b061b81..437b021cdd7 100644 --- a/src/agents/pi-embedded-runner/skills-runtime.integration.test.ts +++ b/src/agents/pi-embedded-runner/skills-runtime.integration.test.ts @@ -31,6 +31,14 @@ async function setupBundledDiffsPlugin() { return { bundledPluginsDir, workspaceDir }; } +async function resolveBundledDiffsSkillEntries(config?: OpenClawConfig) { + const { bundledPluginsDir, workspaceDir } = await setupBundledDiffsPlugin(); + process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = bundledPluginsDir; + clearPluginManifestRegistryCache(); + + return resolveEmbeddedRunSkillEntries({ workspaceDir, ...(config ? { config } : {}) }); +} + afterEach(async () => { process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = originalBundledDir; clearPluginManifestRegistryCache(); @@ -41,10 +49,6 @@ afterEach(async () => { describe("resolveEmbeddedRunSkillEntries (integration)", () => { it("loads bundled diffs skill when explicitly enabled in config", async () => { - const { bundledPluginsDir, workspaceDir } = await setupBundledDiffsPlugin(); - process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = bundledPluginsDir; - clearPluginManifestRegistryCache(); - const config: OpenClawConfig = { plugins: { entries: { @@ -53,23 +57,14 @@ describe("resolveEmbeddedRunSkillEntries (integration)", () => { }, }; - const result = resolveEmbeddedRunSkillEntries({ - workspaceDir, - config, - }); + const result = await resolveBundledDiffsSkillEntries(config); expect(result.shouldLoadSkillEntries).toBe(true); expect(result.skillEntries.map((entry) => entry.skill.name)).toContain("diffs"); }); it("skips bundled diffs skill when config is missing", async () => { - const { bundledPluginsDir, workspaceDir } = await setupBundledDiffsPlugin(); - process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = bundledPluginsDir; - clearPluginManifestRegistryCache(); - - const result = resolveEmbeddedRunSkillEntries({ - workspaceDir, - }); + const result = await resolveBundledDiffsSkillEntries(); expect(result.shouldLoadSkillEntries).toBe(true); expect(result.skillEntries.map((entry) => entry.skill.name)).not.toContain("diffs"); From d46f3bd7394cc4c7694ef091c3db5578477920e1 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:56:55 +0000 Subject: [PATCH 168/187] refactor(payload-tests): share single payload summary assertion --- .../run/payloads.errors.test.ts | 31 +++++++++++++------ 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts index 8fc65c4c42e..df2757f04a9 100644 --- a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts @@ -40,6 +40,18 @@ describe("buildEmbeddedRunPayloads", () => { expect(payloads[0]?.text).toBe(OVERLOADED_FALLBACK_TEXT); }; + function expectSinglePayloadSummary( + payloads: ReturnType, + expected: { text: string; isError?: boolean }, + ) { + expectSinglePayloadText(payloads, expected.text); + if (expected.isError === undefined) { + expect(payloads[0]?.isError).toBeUndefined(); + return; + } + expect(payloads[0]?.isError).toBe(expected.isError); + } + function expectNoPayloads(params: Parameters[0]) { const payloads = buildPayloads(params); expect(payloads).toHaveLength(0); @@ -100,9 +112,10 @@ describe("buildEmbeddedRunPayloads", () => { model: "claude-3-5-sonnet", }); - expect(payloads).toHaveLength(1); - expect(payloads[0]?.text).toBe(formatBillingErrorMessage("Anthropic", "claude-3-5-sonnet")); - expect(payloads[0]?.isError).toBe(true); + expectSinglePayloadSummary(payloads, { + text: formatBillingErrorMessage("Anthropic", "claude-3-5-sonnet"), + isError: true, + }); }); it("does not emit a synthetic billing error for successful turns with stale errorMessage", () => { @@ -242,9 +255,9 @@ describe("buildEmbeddedRunPayloads", () => { lastToolError: { toolName: "browser", error: "connection timeout" }, }); - expect(payloads).toHaveLength(1); - expect(payloads[0]?.isError).toBeUndefined(); - expect(payloads[0]?.text).toContain("recovered"); + expectSinglePayloadSummary(payloads, { + text: "Checked the page and recovered with final answer.", + }); }); it("suppresses recoverable tool errors containing 'required' for non-mutating tools", () => { @@ -335,8 +348,7 @@ describe("buildEmbeddedRunPayloads", () => { }, }); - expect(payloads).toHaveLength(1); - expect(payloads[0]?.text).toBe("Status loaded."); + expectSinglePayloadSummary(payloads, { text: "Status loaded." }); }); it("dedupes identical tool warning text already present in assistant output", () => { @@ -360,8 +372,7 @@ describe("buildEmbeddedRunPayloads", () => { }, }); - expect(payloads).toHaveLength(1); - expect(payloads[0]?.text).toBe(warningText); + expectSinglePayloadSummary(payloads, { text: warningText ?? "" }); }); it("includes non-recoverable tool error details when verbose mode is on", () => { From bc36ed8e1e37657318cd0eb964f0a691881a8528 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:58:03 +0000 Subject: [PATCH 169/187] refactor(payload-tests): table-drive recoverable tool suppressions --- .../run/payloads.errors.test.ts | 25 ++++++------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts index df2757f04a9..5aa8dfe7fd6 100644 --- a/src/agents/pi-embedded-runner/run/payloads.errors.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.errors.test.ts @@ -260,23 +260,14 @@ describe("buildEmbeddedRunPayloads", () => { }); }); - it("suppresses recoverable tool errors containing 'required' for non-mutating tools", () => { - expectNoPayloads({ - lastToolError: { toolName: "browser", error: "url required" }, - }); - }); - - it("suppresses recoverable tool errors containing 'missing' for non-mutating tools", () => { - expectNoPayloads({ - lastToolError: { toolName: "browser", error: "url missing" }, - }); - }); - - it("suppresses recoverable tool errors containing 'invalid' for non-mutating tools", () => { - expectNoPayloads({ - lastToolError: { toolName: "browser", error: "invalid parameter: url" }, - }); - }); + it.each(["url required", "url missing", "invalid parameter: url"])( + "suppresses recoverable non-mutating tool error: %s", + (error) => { + expectNoPayloads({ + lastToolError: { toolName: "browser", error }, + }); + }, + ); it("suppresses non-mutating non-recoverable tool errors when messages.suppressToolErrors is enabled", () => { expectNoPayloads({ From 2971c523432d7a367db73e6f528e16fe4202c28f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 07:58:57 +0000 Subject: [PATCH 170/187] refactor(payload-tests): table-drive sessions send suppressions --- .../pi-embedded-runner/run/payloads.test.ts | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/payloads.test.ts b/src/agents/pi-embedded-runner/run/payloads.test.ts index 52a88368c50..5fa54d5f57c 100644 --- a/src/agents/pi-embedded-runner/run/payloads.test.ts +++ b/src/agents/pi-embedded-runner/run/payloads.test.ts @@ -64,20 +64,22 @@ describe("buildEmbeddedRunPayloads tool-error warnings", () => { }); }); - it("suppresses sessions_send errors to avoid leaking transient relay failures", () => { - expectNoPayloads({ + it.each([ + { + name: "default relay failure", lastToolError: { toolName: "sessions_send", error: "delivery timeout" }, - verboseLevel: "on", - }); - }); - - it("suppresses sessions_send errors even when marked mutating", () => { - expectNoPayloads({ + }, + { + name: "mutating relay failure", lastToolError: { toolName: "sessions_send", error: "delivery timeout", mutatingAction: true, }, + }, + ])("suppresses sessions_send errors for $name", ({ lastToolError }) => { + expectNoPayloads({ + lastToolError, verboseLevel: "on", }); }); From 4db3fed2996e44e18d876b00afec99197fb7d0d8 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:00:06 +0000 Subject: [PATCH 171/187] refactor(history-tests): share pruned image assertions --- .../run/history-image-prune.test.ts | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts index e25b447827b..c9a76ea9acf 100644 --- a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts +++ b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts @@ -14,6 +14,18 @@ function expectArrayMessageContent( return message.content as Array<{ type: string; text?: string; data?: string }>; } +function expectPrunedImageMessage( + messages: AgentMessage[], + errorMessage: string, +): Array<{ type: string; text?: string; data?: string }> { + const didMutate = pruneProcessedHistoryImages(messages); + expect(didMutate).toBe(true); + const content = expectArrayMessageContent(messages[0], errorMessage); + expect(content).toHaveLength(2); + expect(content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); + return content; +} + describe("pruneProcessedHistoryImages", () => { const image: ImageContent = { type: "image", data: "abc", mimeType: "image/png" }; @@ -29,13 +41,8 @@ describe("pruneProcessedHistoryImages", () => { }), ]; - const didMutate = pruneProcessedHistoryImages(messages); - - expect(didMutate).toBe(true); - const content = expectArrayMessageContent(messages[0], "expected user array content"); - expect(content).toHaveLength(2); + const content = expectPrunedImageMessage(messages, "expected user array content"); expect(content[0]?.type).toBe("text"); - expect(content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); }); it("does not prune latest user message when no assistant response exists yet", () => { @@ -67,12 +74,7 @@ describe("pruneProcessedHistoryImages", () => { }), ]; - const didMutate = pruneProcessedHistoryImages(messages); - - expect(didMutate).toBe(true); - const content = expectArrayMessageContent(messages[0], "expected toolResult array content"); - expect(content).toHaveLength(2); - expect(content[1]).toMatchObject({ type: "text", text: PRUNED_HISTORY_IMAGE_MARKER }); + expectPrunedImageMessage(messages, "expected toolResult array content"); }); it("does not change messages when no assistant turn exists", () => { From 774b35198298c967d9efdabac2030924657d3109 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:01:16 +0000 Subject: [PATCH 172/187] refactor(failover-tests): share observation base --- .../run/failover-observation.test.ts | 37 +++++++++++-------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/src/agents/pi-embedded-runner/run/failover-observation.test.ts b/src/agents/pi-embedded-runner/run/failover-observation.test.ts index 763540f9ca7..71363915b46 100644 --- a/src/agents/pi-embedded-runner/run/failover-observation.test.ts +++ b/src/agents/pi-embedded-runner/run/failover-observation.test.ts @@ -1,21 +1,31 @@ import { describe, expect, it } from "vitest"; import { normalizeFailoverDecisionObservationBase } from "./failover-observation.js"; +function normalizeObservation( + overrides: Partial[0]>, +) { + return normalizeFailoverDecisionObservationBase({ + stage: "assistant", + runId: "run:base", + rawError: "", + failoverReason: null, + profileFailureReason: null, + provider: "openai", + model: "mock-1", + profileId: "openai:p1", + fallbackConfigured: false, + timedOut: false, + aborted: false, + ...overrides, + }); +} + describe("normalizeFailoverDecisionObservationBase", () => { it("fills timeout observation reasons for deadline timeouts without provider error text", () => { expect( - normalizeFailoverDecisionObservationBase({ - stage: "assistant", + normalizeObservation({ runId: "run:timeout", - rawError: "", - failoverReason: null, - profileFailureReason: null, - provider: "openai", - model: "mock-1", - profileId: "openai:p1", - fallbackConfigured: false, timedOut: true, - aborted: false, }), ).toMatchObject({ failoverReason: "timeout", @@ -26,18 +36,13 @@ describe("normalizeFailoverDecisionObservationBase", () => { it("preserves explicit failover reasons", () => { expect( - normalizeFailoverDecisionObservationBase({ - stage: "assistant", + normalizeObservation({ runId: "run:overloaded", rawError: '{"error":{"type":"overloaded_error"}}', failoverReason: "overloaded", profileFailureReason: "overloaded", - provider: "openai", - model: "mock-1", - profileId: "openai:p1", fallbackConfigured: true, timedOut: true, - aborted: false, }), ).toMatchObject({ failoverReason: "overloaded", From 85e610e4e75a2a41a12cb4962249ca39c12c203f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:02:26 +0000 Subject: [PATCH 173/187] refactor(extension-tests): share safeguard runtime assertions --- .../pi-embedded-runner/extensions.test.ts | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/agents/pi-embedded-runner/extensions.test.ts b/src/agents/pi-embedded-runner/extensions.test.ts index 948d96bd9df..e3f412cafd0 100644 --- a/src/agents/pi-embedded-runner/extensions.test.ts +++ b/src/agents/pi-embedded-runner/extensions.test.ts @@ -24,6 +24,16 @@ function buildSafeguardFactories(cfg: OpenClawConfig) { return { factories, sessionManager }; } +function expectSafeguardRuntime( + cfg: OpenClawConfig, + expectedRuntime: { qualityGuardEnabled: boolean; qualityGuardMaxRetries?: number }, +) { + const { factories, sessionManager } = buildSafeguardFactories(cfg); + + expect(factories).toContain(compactionSafeguardExtension); + expect(getCompactionSafeguardRuntime(sessionManager)).toMatchObject(expectedRuntime); +} + describe("buildEmbeddedExtensionFactories", () => { it("does not opt safeguard mode into quality-guard retries", () => { const cfg = { @@ -35,10 +45,7 @@ describe("buildEmbeddedExtensionFactories", () => { }, }, } as OpenClawConfig; - const { factories, sessionManager } = buildSafeguardFactories(cfg); - - expect(factories).toContain(compactionSafeguardExtension); - expect(getCompactionSafeguardRuntime(sessionManager)).toMatchObject({ + expectSafeguardRuntime(cfg, { qualityGuardEnabled: false, }); }); @@ -57,10 +64,7 @@ describe("buildEmbeddedExtensionFactories", () => { }, }, } as OpenClawConfig; - const { factories, sessionManager } = buildSafeguardFactories(cfg); - - expect(factories).toContain(compactionSafeguardExtension); - expect(getCompactionSafeguardRuntime(sessionManager)).toMatchObject({ + expectSafeguardRuntime(cfg, { qualityGuardEnabled: true, qualityGuardMaxRetries: 2, }); From 527a1919ea2064052fa7601f3a7cd32918992bd3 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:04:47 +0000 Subject: [PATCH 174/187] fix(ci): quote changed extension matrix input --- .github/workflows/ci.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7266469c4a2..0eb2868d37b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -273,7 +273,9 @@ jobs: use-sticky-disk: "false" - name: Run changed extension tests - run: pnpm test:extension ${{ matrix.extension }} + env: + EXTENSION_ID: ${{ matrix.extension }} + run: pnpm test:extension "$EXTENSION_ID" # Types, lint, and format check. check: From f9588da3e01ccabe5eec09b65a61afc51300031f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 00:59:16 -0700 Subject: [PATCH 175/187] refactor: split plugin testing seam from bundled extension helpers --- CHANGELOG.md | 1 + extensions/amazon-bedrock/index.test.ts | 2 +- extensions/bluebubbles/src/monitor.test.ts | 2 +- .../bluebubbles/src/monitor.webhook-auth.test.ts | 2 +- extensions/diffs/index.test.ts | 4 ++-- extensions/diffs/src/http.test.ts | 2 +- extensions/diffs/src/tool.test.ts | 2 +- extensions/discord/src/api.test.ts | 2 +- extensions/discord/src/chunk.test.ts | 5 ++++- extensions/discord/src/monitor.test.ts | 2 +- .../discord/src/monitor.tool-result.test-harness.ts | 2 +- .../monitor/message-handler.module-test-helpers.ts | 2 +- .../discord/src/monitor/provider.registry.test.ts | 2 +- .../discord/src/monitor/provider.test-support.ts | 2 +- extensions/discord/src/resolve-channels.test.ts | 2 +- extensions/discord/src/resolve-users.test.ts | 2 +- extensions/discord/src/send.test-harness.ts | 2 +- extensions/feishu/src/bot.test.ts | 2 +- extensions/feishu/src/monitor.bot-menu.test.ts | 2 +- extensions/feishu/src/monitor.reaction.test.ts | 2 +- extensions/github-copilot/usage.test.ts | 5 ++++- extensions/googlechat/src/channel.startup.test.ts | 2 +- .../googlechat/src/monitor.webhook-routing.test.ts | 2 +- extensions/googlechat/src/setup-surface.test.ts | 4 ++-- extensions/irc/src/channel.startup.test.ts | 2 +- extensions/irc/src/send.test.ts | 2 +- extensions/irc/src/setup-surface.test.ts | 4 ++-- extensions/line/src/channel.logout.test.ts | 2 +- extensions/line/src/channel.startup.test.ts | 2 +- extensions/line/src/setup-surface.test.ts | 4 ++-- extensions/matrix/src/channel.directory.test.ts | 2 +- extensions/mattermost/index.test.ts | 2 +- extensions/mattermost/src/mattermost/send.test.ts | 2 +- extensions/msteams/src/attachments.test.ts | 2 +- extensions/msteams/src/channel.directory.test.ts | 5 ++++- extensions/msteams/src/graph-upload.test.ts | 2 +- extensions/msteams/src/messenger.test.ts | 2 +- .../nextcloud-talk/src/channel.startup.test.ts | 4 ++-- extensions/nextcloud-talk/src/send.test.ts | 2 +- extensions/nostr/src/channel.outbound.test.ts | 2 +- extensions/nostr/src/setup-surface.test.ts | 4 ++-- extensions/phone-control/index.test.ts | 2 +- .../signal/src/monitor.tool-result.test-harness.ts | 2 +- extensions/slack/src/monitor/media.test.ts | 5 ++++- extensions/synology-chat/src/setup-surface.test.ts | 4 ++-- extensions/talk-voice/index.test.ts | 4 ++-- extensions/telegram/src/account-inspect.test.ts | 2 +- extensions/telegram/src/accounts.test.ts | 2 +- .../telegram/src/bot-native-commands.test-helpers.ts | 2 +- .../src/bot.create-telegram-bot.test-harness.ts | 2 +- .../telegram/src/bot.create-telegram-bot.test.ts | 4 ++-- extensions/telegram/src/channel.test.ts | 2 +- extensions/telegram/src/probe.test.ts | 2 +- extensions/telegram/src/send.test-harness.ts | 2 +- extensions/test-utils/chunk-test-helpers.ts | 1 - extensions/test-utils/env.ts | 1 - extensions/test-utils/fetch-mock.ts | 1 - extensions/test-utils/frozen-time.ts | 1 - extensions/test-utils/mock-http-response.ts | 1 - extensions/test-utils/plugin-registration.ts | 1 - extensions/test-utils/provider-usage-fetch.ts | 4 ---- extensions/test-utils/temp-dir.ts | 1 - extensions/test-utils/typed-cases.ts | 1 - extensions/tlon/src/setup-surface.test.ts | 4 ++-- .../whatsapp/src/accounts.whatsapp-auth.test.ts | 2 +- ...web-auto-reply.connection-and-logging.e2e.test.ts | 2 +- .../src/auto-reply/web-auto-reply-utils.test.ts | 2 +- extensions/whatsapp/src/media.test.ts | 2 +- extensions/zalo/src/channel.directory.test.ts | 5 ++++- extensions/zalo/src/channel.startup.test.ts | 2 +- extensions/zalo/src/setup-surface.test.ts | 4 ++-- extensions/zalo/src/status-issues.test.ts | 2 +- extensions/zalouser/src/setup-surface.test.ts | 4 ++-- extensions/zalouser/src/status-issues.test.ts | 2 +- package.json | 4 ++++ scripts/check-no-extension-test-core-imports.ts | 12 ++++++++++-- scripts/lib/plugin-sdk-entrypoints.json | 1 + src/plugin-sdk/subpaths.test.ts | 6 ++++++ src/plugin-sdk/test-utils.ts | 11 +++-------- src/plugin-sdk/testing.ts | 9 +++++++++ test/helpers/extensions/chunk-test-helpers.ts | 1 + .../helpers/extensions}/directory.ts | 0 .../extensions}/discord-provider.test-support.ts | 0 test/helpers/extensions/env.ts | 1 + test/helpers/extensions/fetch-mock.ts | 1 + test/helpers/extensions/frozen-time.ts | 1 + test/helpers/extensions/mock-http-response.ts | 1 + .../helpers/extensions}/plugin-api.ts | 0 .../helpers/extensions}/plugin-command.ts | 0 test/helpers/extensions/plugin-registration.ts | 1 + .../helpers/extensions}/plugin-runtime-mock.ts | 4 ++-- test/helpers/extensions/provider-usage-fetch.ts | 4 ++++ .../helpers/extensions}/runtime-env.ts | 2 +- .../helpers/extensions}/send-config.ts | 0 .../helpers/extensions}/setup-wizard.ts | 4 ++-- .../helpers/extensions}/start-account-context.ts | 2 +- .../helpers/extensions}/start-account-lifecycle.ts | 2 +- .../helpers/extensions}/status-issues.ts | 0 .../helpers/extensions}/subagent-hooks.ts | 0 test/helpers/extensions/temp-dir.ts | 1 + test/helpers/extensions/typed-cases.ts | 1 + 101 files changed, 144 insertions(+), 105 deletions(-) delete mode 100644 extensions/test-utils/chunk-test-helpers.ts delete mode 100644 extensions/test-utils/env.ts delete mode 100644 extensions/test-utils/fetch-mock.ts delete mode 100644 extensions/test-utils/frozen-time.ts delete mode 100644 extensions/test-utils/mock-http-response.ts delete mode 100644 extensions/test-utils/plugin-registration.ts delete mode 100644 extensions/test-utils/provider-usage-fetch.ts delete mode 100644 extensions/test-utils/temp-dir.ts delete mode 100644 extensions/test-utils/typed-cases.ts create mode 100644 src/plugin-sdk/testing.ts create mode 100644 test/helpers/extensions/chunk-test-helpers.ts rename {extensions/test-utils => test/helpers/extensions}/directory.ts (100%) rename {extensions/test-utils => test/helpers/extensions}/discord-provider.test-support.ts (100%) create mode 100644 test/helpers/extensions/env.ts create mode 100644 test/helpers/extensions/fetch-mock.ts create mode 100644 test/helpers/extensions/frozen-time.ts create mode 100644 test/helpers/extensions/mock-http-response.ts rename {extensions/test-utils => test/helpers/extensions}/plugin-api.ts (100%) rename {extensions/test-utils => test/helpers/extensions}/plugin-command.ts (100%) create mode 100644 test/helpers/extensions/plugin-registration.ts rename {extensions/test-utils => test/helpers/extensions}/plugin-runtime-mock.ts (99%) create mode 100644 test/helpers/extensions/provider-usage-fetch.ts rename {extensions/test-utils => test/helpers/extensions}/runtime-env.ts (77%) rename {extensions/test-utils => test/helpers/extensions}/send-config.ts (100%) rename {extensions/test-utils => test/helpers/extensions}/setup-wizard.ts (84%) rename {extensions/test-utils => test/helpers/extensions}/start-account-context.ts (95%) rename {extensions/test-utils => test/helpers/extensions}/start-account-lifecycle.ts (98%) rename {extensions/test-utils => test/helpers/extensions}/status-issues.ts (100%) rename {extensions/test-utils => test/helpers/extensions}/subagent-hooks.ts (100%) create mode 100644 test/helpers/extensions/temp-dir.ts create mode 100644 test/helpers/extensions/typed-cases.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index dfb9de629f9..9ade3e3457d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ Docs: https://docs.openclaw.ai - Skills/prompt budget: preserve all registered skills via a compact catalog fallback before dropping entries when the full prompt format exceeds `maxSkillsPromptChars`. (#47553) Thanks @snese. - Plugins/bundles: make enabled bundle MCP servers expose runnable tools in embedded Pi, and default relative bundle MCP launches to the bundle root so marketplace bundles like Context7 work through Pi instead of stopping at config import. - Scope message SecretRef resolution and harden doctor/status paths. (#48728) Thanks @joshavant. +- Plugins/testing: add a public `openclaw/plugin-sdk/testing` seam for plugin-author test helpers, and move bundled-extension-only test bridges out of `extensions/` into private repo test helpers. ### Breaking diff --git a/extensions/amazon-bedrock/index.test.ts b/extensions/amazon-bedrock/index.test.ts index 61b33a0bc68..4afa67e3501 100644 --- a/extensions/amazon-bedrock/index.test.ts +++ b/extensions/amazon-bedrock/index.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { registerSingleProviderPlugin } from "../test-utils/plugin-registration.js"; +import { registerSingleProviderPlugin } from "../../test/helpers/extensions/plugin-registration.js"; import amazonBedrockPlugin from "./index.js"; describe("amazon-bedrock provider plugin", () => { diff --git a/extensions/bluebubbles/src/monitor.test.ts b/extensions/bluebubbles/src/monitor.test.ts index 1ba2e27f0b6..17467465d82 100644 --- a/extensions/bluebubbles/src/monitor.test.ts +++ b/extensions/bluebubbles/src/monitor.test.ts @@ -2,7 +2,7 @@ import { EventEmitter } from "node:events"; import type { IncomingMessage, ServerResponse } from "node:http"; import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk/bluebubbles"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import type { ResolvedBlueBubblesAccount } from "./accounts.js"; import { fetchBlueBubblesHistory } from "./history.js"; import { resetBlueBubblesSelfChatCache } from "./monitor-self-chat-cache.js"; diff --git a/extensions/bluebubbles/src/monitor.webhook-auth.test.ts b/extensions/bluebubbles/src/monitor.webhook-auth.test.ts index f6826ac510b..8d98b0c45eb 100644 --- a/extensions/bluebubbles/src/monitor.webhook-auth.test.ts +++ b/extensions/bluebubbles/src/monitor.webhook-auth.test.ts @@ -2,7 +2,7 @@ import { EventEmitter } from "node:events"; import type { IncomingMessage, ServerResponse } from "node:http"; import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk/bluebubbles"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import type { ResolvedBlueBubblesAccount } from "./accounts.js"; import { fetchBlueBubblesHistory } from "./history.js"; import { diff --git a/extensions/diffs/index.test.ts b/extensions/diffs/index.test.ts index b1ade0c6a09..3e7fd3c474b 100644 --- a/extensions/diffs/index.test.ts +++ b/extensions/diffs/index.test.ts @@ -1,8 +1,8 @@ import type { IncomingMessage } from "node:http"; import type { OpenClawPluginApi } from "openclaw/plugin-sdk/diffs"; import { describe, expect, it, vi } from "vitest"; -import { createMockServerResponse } from "../test-utils/mock-http-response.js"; -import { createTestPluginApi } from "../test-utils/plugin-api.js"; +import { createMockServerResponse } from "../../test/helpers/extensions/mock-http-response.js"; +import { createTestPluginApi } from "../../test/helpers/extensions/plugin-api.js"; import plugin from "./index.js"; describe("diffs plugin registration", () => { diff --git a/extensions/diffs/src/http.test.ts b/extensions/diffs/src/http.test.ts index eed9abd77d8..e35d847597b 100644 --- a/extensions/diffs/src/http.test.ts +++ b/extensions/diffs/src/http.test.ts @@ -1,6 +1,6 @@ import type { IncomingMessage } from "node:http"; import { afterEach, beforeEach, describe, expect, it } from "vitest"; -import { createMockServerResponse } from "../../test-utils/mock-http-response.js"; +import { createMockServerResponse } from "../../../test/helpers/extensions/mock-http-response.js"; import { createDiffsHttpHandler } from "./http.js"; import { DiffArtifactStore } from "./store.js"; import { createDiffStoreHarness } from "./test-helpers.js"; diff --git a/extensions/diffs/src/tool.test.ts b/extensions/diffs/src/tool.test.ts index 2f845727274..b0e019f33e2 100644 --- a/extensions/diffs/src/tool.test.ts +++ b/extensions/diffs/src/tool.test.ts @@ -2,7 +2,7 @@ import fs from "node:fs/promises"; import path from "node:path"; import type { OpenClawPluginApi } from "openclaw/plugin-sdk/diffs"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { createTestPluginApi } from "../../test-utils/plugin-api.js"; +import { createTestPluginApi } from "../../../test/helpers/extensions/plugin-api.js"; import type { DiffScreenshotter } from "./browser.js"; import { DEFAULT_DIFFS_TOOL_DEFAULTS } from "./config.js"; import { DiffArtifactStore } from "./store.js"; diff --git a/extensions/discord/src/api.test.ts b/extensions/discord/src/api.test.ts index 09e0863e137..11d15d5f59f 100644 --- a/extensions/discord/src/api.test.ts +++ b/extensions/discord/src/api.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../../test/helpers/extensions/fetch-mock.js"; import { fetchDiscord } from "./api.js"; import { jsonResponse } from "./test-http-helpers.js"; diff --git a/extensions/discord/src/chunk.test.ts b/extensions/discord/src/chunk.test.ts index 69f5ec856ec..228871fe5d6 100644 --- a/extensions/discord/src/chunk.test.ts +++ b/extensions/discord/src/chunk.test.ts @@ -1,5 +1,8 @@ import { describe, expect, it } from "vitest"; -import { countLines, hasBalancedFences } from "../../test-utils/chunk-test-helpers.js"; +import { + countLines, + hasBalancedFences, +} from "../../../test/helpers/extensions/chunk-test-helpers.js"; import { chunkDiscordText, chunkDiscordTextWithMode } from "./chunk.js"; describe("chunkDiscordText", () => { diff --git a/extensions/discord/src/monitor.test.ts b/extensions/discord/src/monitor.test.ts index b3af666c35f..9836984d555 100644 --- a/extensions/discord/src/monitor.test.ts +++ b/extensions/discord/src/monitor.test.ts @@ -1,6 +1,6 @@ import { ChannelType, type Guild } from "@buape/carbon"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { typedCases } from "../../test-utils/typed-cases.js"; +import { typedCases } from "../../../test/helpers/extensions/typed-cases.js"; import { allowListMatches, buildDiscordMediaPayload, diff --git a/extensions/discord/src/monitor.tool-result.test-harness.ts b/extensions/discord/src/monitor.tool-result.test-harness.ts index fd4f67b0890..6d0405d756c 100644 --- a/extensions/discord/src/monitor.tool-result.test-harness.ts +++ b/extensions/discord/src/monitor.tool-result.test-harness.ts @@ -1,4 +1,4 @@ -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; export const sendMock: MockFn = vi.fn(); diff --git a/extensions/discord/src/monitor/message-handler.module-test-helpers.ts b/extensions/discord/src/monitor/message-handler.module-test-helpers.ts index adeaf7953e7..72327dfc608 100644 --- a/extensions/discord/src/monitor/message-handler.module-test-helpers.ts +++ b/extensions/discord/src/monitor/message-handler.module-test-helpers.ts @@ -1,4 +1,4 @@ -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; export const preflightDiscordMessageMock: MockFn = vi.fn(); diff --git a/extensions/discord/src/monitor/provider.registry.test.ts b/extensions/discord/src/monitor/provider.registry.test.ts index 1070bb744e3..5e092445065 100644 --- a/extensions/discord/src/monitor/provider.registry.test.ts +++ b/extensions/discord/src/monitor/provider.registry.test.ts @@ -5,7 +5,7 @@ import { baseRuntime, getProviderMonitorTestMocks, resetDiscordProviderMonitorMocks, -} from "../../../test-utils/discord-provider.test-support.js"; +} from "../../../../test/helpers/extensions/discord-provider.test-support.js"; const { createDiscordNativeCommandMock, clientHandleDeployRequestMock, monitorLifecycleMock } = getProviderMonitorTestMocks(); diff --git a/extensions/discord/src/monitor/provider.test-support.ts b/extensions/discord/src/monitor/provider.test-support.ts index 9eebb9ad38d..360210e3604 100644 --- a/extensions/discord/src/monitor/provider.test-support.ts +++ b/extensions/discord/src/monitor/provider.test-support.ts @@ -1 +1 @@ -export * from "../../../test-utils/discord-provider.test-support.js"; +export * from "../../../../test/helpers/extensions/discord-provider.test-support.js"; diff --git a/extensions/discord/src/resolve-channels.test.ts b/extensions/discord/src/resolve-channels.test.ts index f053fb97888..8fd06593923 100644 --- a/extensions/discord/src/resolve-channels.test.ts +++ b/extensions/discord/src/resolve-channels.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../../test/helpers/extensions/fetch-mock.js"; import { resolveDiscordChannelAllowlist } from "./resolve-channels.js"; import { jsonResponse, urlToString } from "./test-http-helpers.js"; diff --git a/extensions/discord/src/resolve-users.test.ts b/extensions/discord/src/resolve-users.test.ts index f67b7289a59..080c312b856 100644 --- a/extensions/discord/src/resolve-users.test.ts +++ b/extensions/discord/src/resolve-users.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../../test/helpers/extensions/fetch-mock.js"; import { resolveDiscordUserAllowlist } from "./resolve-users.js"; import { jsonResponse, urlToString } from "./test-http-helpers.js"; diff --git a/extensions/discord/src/send.test-harness.ts b/extensions/discord/src/send.test-harness.ts index 8a2058772fc..c0069f99770 100644 --- a/extensions/discord/src/send.test-harness.ts +++ b/extensions/discord/src/send.test-harness.ts @@ -1,4 +1,4 @@ -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; type DiscordWebMediaMockFactoryResult = { diff --git a/extensions/feishu/src/bot.test.ts b/extensions/feishu/src/bot.test.ts index df787b0106a..4594f09fd59 100644 --- a/extensions/feishu/src/bot.test.ts +++ b/extensions/feishu/src/bot.test.ts @@ -1,6 +1,6 @@ import type { ClawdbotConfig, PluginRuntime, RuntimeEnv } from "openclaw/plugin-sdk/feishu"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import type { FeishuMessageEvent } from "./bot.js"; import { buildBroadcastSessionKey, diff --git a/extensions/feishu/src/monitor.bot-menu.test.ts b/extensions/feishu/src/monitor.bot-menu.test.ts index cecb0b0512c..988e04d80ca 100644 --- a/extensions/feishu/src/monitor.bot-menu.test.ts +++ b/extensions/feishu/src/monitor.bot-menu.test.ts @@ -5,7 +5,7 @@ import { createInboundDebouncer, resolveInboundDebounceMs, } from "../../../src/auto-reply/inbound-debounce.js"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import { monitorSingleAccount } from "./monitor.account.js"; import { setFeishuRuntime } from "./runtime.js"; import type { ResolvedFeishuAccount } from "./types.js"; diff --git a/extensions/feishu/src/monitor.reaction.test.ts b/extensions/feishu/src/monitor.reaction.test.ts index 001b8140f80..048aed2247e 100644 --- a/extensions/feishu/src/monitor.reaction.test.ts +++ b/extensions/feishu/src/monitor.reaction.test.ts @@ -5,7 +5,7 @@ import { createInboundDebouncer, resolveInboundDebounceMs, } from "../../../src/auto-reply/inbound-debounce.js"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import { parseFeishuMessageEvent, type FeishuMessageEvent } from "./bot.js"; import * as dedup from "./dedup.js"; import { monitorSingleAccount } from "./monitor.account.js"; diff --git a/extensions/github-copilot/usage.test.ts b/extensions/github-copilot/usage.test.ts index 0bc97974d70..f0687c33b0a 100644 --- a/extensions/github-copilot/usage.test.ts +++ b/extensions/github-copilot/usage.test.ts @@ -1,5 +1,8 @@ import { describe, expect, it } from "vitest"; -import { createProviderUsageFetch, makeResponse } from "../test-utils/provider-usage-fetch.js"; +import { + createProviderUsageFetch, + makeResponse, +} from "../../test/helpers/extensions/provider-usage-fetch.js"; import { fetchCopilotUsage } from "./usage.js"; describe("fetchCopilotUsage", () => { diff --git a/extensions/googlechat/src/channel.startup.test.ts b/extensions/googlechat/src/channel.startup.test.ts index 11c46aa663a..e65aa444314 100644 --- a/extensions/googlechat/src/channel.startup.test.ts +++ b/extensions/googlechat/src/channel.startup.test.ts @@ -4,7 +4,7 @@ import { abortStartedAccount, expectPendingUntilAbort, startAccountAndTrackLifecycle, -} from "../../test-utils/start-account-lifecycle.js"; +} from "../../../test/helpers/extensions/start-account-lifecycle.js"; import type { ResolvedGoogleChatAccount } from "./accounts.js"; const hoisted = vi.hoisted(() => ({ diff --git a/extensions/googlechat/src/monitor.webhook-routing.test.ts b/extensions/googlechat/src/monitor.webhook-routing.test.ts index 2258d154449..f5e7c69ef8a 100644 --- a/extensions/googlechat/src/monitor.webhook-routing.test.ts +++ b/extensions/googlechat/src/monitor.webhook-routing.test.ts @@ -4,7 +4,7 @@ import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk/googlech import { afterEach, describe, expect, it, vi } from "vitest"; import { createEmptyPluginRegistry } from "../../../src/plugins/registry.js"; import { setActivePluginRegistry } from "../../../src/plugins/runtime.js"; -import { createMockServerResponse } from "../../test-utils/mock-http-response.js"; +import { createMockServerResponse } from "../../../test/helpers/extensions/mock-http-response.js"; import type { ResolvedGoogleChatAccount } from "./accounts.js"; import { verifyGoogleChatRequest } from "./auth.js"; import { handleGoogleChatWebhookRequest, registerGoogleChatWebhookTarget } from "./monitor.js"; diff --git a/extensions/googlechat/src/setup-surface.test.ts b/extensions/googlechat/src/setup-surface.test.ts index 8ecae3855cc..65c124c8180 100644 --- a/extensions/googlechat/src/setup-surface.test.ts +++ b/extensions/googlechat/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/googlechat"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { googlechatPlugin } from "./channel.js"; const googlechatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/irc/src/channel.startup.test.ts b/extensions/irc/src/channel.startup.test.ts index 7b4416d1892..de3526a32d2 100644 --- a/extensions/irc/src/channel.startup.test.ts +++ b/extensions/irc/src/channel.startup.test.ts @@ -2,7 +2,7 @@ import { afterEach, describe, expect, it, vi } from "vitest"; import { expectStopPendingUntilAbort, startAccountAndTrackLifecycle, -} from "../../test-utils/start-account-lifecycle.js"; +} from "../../../test/helpers/extensions/start-account-lifecycle.js"; import type { ResolvedIrcAccount } from "./accounts.js"; const hoisted = vi.hoisted(() => ({ diff --git a/extensions/irc/src/send.test.ts b/extensions/irc/src/send.test.ts index 8fbe58e7f22..7dc064930be 100644 --- a/extensions/irc/src/send.test.ts +++ b/extensions/irc/src/send.test.ts @@ -3,7 +3,7 @@ import { createSendCfgThreadingRuntime, expectProvidedCfgSkipsRuntimeLoad, expectRuntimeCfgFallback, -} from "../../test-utils/send-config.js"; +} from "../../../test/helpers/extensions/send-config.js"; import type { IrcClient } from "./client.js"; import type { CoreConfig } from "./types.js"; diff --git a/extensions/irc/src/setup-surface.test.ts b/extensions/irc/src/setup-surface.test.ts index 6ac3fb268cc..d87ba916622 100644 --- a/extensions/irc/src/setup-surface.test.ts +++ b/extensions/irc/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { RuntimeEnv } from "openclaw/plugin-sdk/irc"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { ircPlugin } from "./channel.js"; import type { CoreConfig } from "./types.js"; diff --git a/extensions/line/src/channel.logout.test.ts b/extensions/line/src/channel.logout.test.ts index b10d484fbb1..4f474032dc9 100644 --- a/extensions/line/src/channel.logout.test.ts +++ b/extensions/line/src/channel.logout.test.ts @@ -1,6 +1,6 @@ import type { OpenClawConfig, PluginRuntime, ResolvedLineAccount } from "openclaw/plugin-sdk/line"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; import { linePlugin } from "./channel.js"; import { setLineRuntime } from "./runtime.js"; diff --git a/extensions/line/src/channel.startup.test.ts b/extensions/line/src/channel.startup.test.ts index e4de0f38e3b..9f1e10cd6fc 100644 --- a/extensions/line/src/channel.startup.test.ts +++ b/extensions/line/src/channel.startup.test.ts @@ -6,7 +6,7 @@ import type { ResolvedLineAccount, } from "openclaw/plugin-sdk/line"; import { describe, expect, it, vi } from "vitest"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; import { linePlugin } from "./channel.js"; import { setLineRuntime } from "./runtime.js"; diff --git a/extensions/line/src/setup-surface.test.ts b/extensions/line/src/setup-surface.test.ts index bf4e560e0df..1606cb3ff22 100644 --- a/extensions/line/src/setup-surface.test.ts +++ b/extensions/line/src/setup-surface.test.ts @@ -6,8 +6,8 @@ import { resolveDefaultLineAccountId, resolveLineAccount, } from "../../../src/line/accounts.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { lineSetupAdapter, lineSetupWizard } from "./setup-surface.js"; const lineConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/matrix/src/channel.directory.test.ts b/extensions/matrix/src/channel.directory.test.ts index 2c5bc9533f3..ced16d90638 100644 --- a/extensions/matrix/src/channel.directory.test.ts +++ b/extensions/matrix/src/channel.directory.test.ts @@ -1,6 +1,6 @@ import type { PluginRuntime, RuntimeEnv } from "openclaw/plugin-sdk/matrix"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; import { matrixPlugin } from "./channel.js"; import { setMatrixRuntime } from "./runtime.js"; import { createMatrixBotSdkMock } from "./test-mocks.js"; diff --git a/extensions/mattermost/index.test.ts b/extensions/mattermost/index.test.ts index b2ef565c4d2..d21403111cb 100644 --- a/extensions/mattermost/index.test.ts +++ b/extensions/mattermost/index.test.ts @@ -1,6 +1,6 @@ import type { OpenClawPluginApi } from "openclaw/plugin-sdk/mattermost"; import { describe, expect, it, vi } from "vitest"; -import { createTestPluginApi } from "../test-utils/plugin-api.js"; +import { createTestPluginApi } from "../../test/helpers/extensions/plugin-api.js"; import plugin from "./index.js"; function createApi( diff --git a/extensions/mattermost/src/mattermost/send.test.ts b/extensions/mattermost/src/mattermost/send.test.ts index 774f40f99fa..15cf05eb541 100644 --- a/extensions/mattermost/src/mattermost/send.test.ts +++ b/extensions/mattermost/src/mattermost/send.test.ts @@ -2,7 +2,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { expectProvidedCfgSkipsRuntimeLoad, expectRuntimeCfgFallback, -} from "../../../test-utils/send-config.js"; +} from "../../../../test/helpers/extensions/send-config.js"; import { parseMattermostTarget, sendMessageMattermost } from "./send.js"; import { resetMattermostOpaqueTargetCacheForTests } from "./target-resolution.js"; diff --git a/extensions/msteams/src/attachments.test.ts b/extensions/msteams/src/attachments.test.ts index 790dc8bd33f..fa119a2b44a 100644 --- a/extensions/msteams/src/attachments.test.ts +++ b/extensions/msteams/src/attachments.test.ts @@ -1,6 +1,6 @@ import type { PluginRuntime, SsrFPolicy } from "openclaw/plugin-sdk/msteams"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import { buildMSTeamsAttachmentPlaceholder, buildMSTeamsGraphMessageUrls, diff --git a/extensions/msteams/src/channel.directory.test.ts b/extensions/msteams/src/channel.directory.test.ts index be95e6103ea..df3547d012a 100644 --- a/extensions/msteams/src/channel.directory.test.ts +++ b/extensions/msteams/src/channel.directory.test.ts @@ -1,6 +1,9 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/msteams"; import { describe, expect, it } from "vitest"; -import { createDirectoryTestRuntime, expectDirectorySurface } from "../../test-utils/directory.js"; +import { + createDirectoryTestRuntime, + expectDirectorySurface, +} from "../../../test/helpers/extensions/directory.js"; import { msteamsPlugin } from "./channel.js"; describe("msteams directory", () => { diff --git a/extensions/msteams/src/graph-upload.test.ts b/extensions/msteams/src/graph-upload.test.ts index 90a9da1d352..a41147840ec 100644 --- a/extensions/msteams/src/graph-upload.test.ts +++ b/extensions/msteams/src/graph-upload.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it, vi } from "vitest"; -import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../../test/helpers/extensions/fetch-mock.js"; import { uploadToOneDrive, uploadToSharePoint } from "./graph-upload.js"; describe("graph upload helpers", () => { diff --git a/extensions/msteams/src/messenger.test.ts b/extensions/msteams/src/messenger.test.ts index cc4cf2fb6f0..e67017ed8fc 100644 --- a/extensions/msteams/src/messenger.test.ts +++ b/extensions/msteams/src/messenger.test.ts @@ -3,7 +3,7 @@ import os from "node:os"; import path from "node:path"; import { SILENT_REPLY_TOKEN, type PluginRuntime } from "openclaw/plugin-sdk/msteams"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { createPluginRuntimeMock } from "../../test-utils/plugin-runtime-mock.js"; +import { createPluginRuntimeMock } from "../../../test/helpers/extensions/plugin-runtime-mock.js"; import type { StoredConversationReference } from "./conversation-store.js"; const graphUploadMockState = vi.hoisted(() => ({ uploadAndShareOneDrive: vi.fn(), diff --git a/extensions/nextcloud-talk/src/channel.startup.test.ts b/extensions/nextcloud-talk/src/channel.startup.test.ts index 5fd0607e753..e0117936f51 100644 --- a/extensions/nextcloud-talk/src/channel.startup.test.ts +++ b/extensions/nextcloud-talk/src/channel.startup.test.ts @@ -1,9 +1,9 @@ import { afterEach, describe, expect, it, vi } from "vitest"; -import { createStartAccountContext } from "../../test-utils/start-account-context.js"; +import { createStartAccountContext } from "../../../test/helpers/extensions/start-account-context.js"; import { expectStopPendingUntilAbort, startAccountAndTrackLifecycle, -} from "../../test-utils/start-account-lifecycle.js"; +} from "../../../test/helpers/extensions/start-account-lifecycle.js"; import type { ResolvedNextcloudTalkAccount } from "./accounts.js"; const hoisted = vi.hoisted(() => ({ diff --git a/extensions/nextcloud-talk/src/send.test.ts b/extensions/nextcloud-talk/src/send.test.ts index 3ee178b815d..b82ac1c4309 100644 --- a/extensions/nextcloud-talk/src/send.test.ts +++ b/extensions/nextcloud-talk/src/send.test.ts @@ -3,7 +3,7 @@ import { createSendCfgThreadingRuntime, expectProvidedCfgSkipsRuntimeLoad, expectRuntimeCfgFallback, -} from "../../test-utils/send-config.js"; +} from "../../../test/helpers/extensions/send-config.js"; const hoisted = vi.hoisted(() => ({ loadConfig: vi.fn(), diff --git a/extensions/nostr/src/channel.outbound.test.ts b/extensions/nostr/src/channel.outbound.test.ts index 0aa63485951..0bbe7f880bf 100644 --- a/extensions/nostr/src/channel.outbound.test.ts +++ b/extensions/nostr/src/channel.outbound.test.ts @@ -1,6 +1,6 @@ import type { PluginRuntime } from "openclaw/plugin-sdk/nostr"; import { afterEach, describe, expect, it, vi } from "vitest"; -import { createStartAccountContext } from "../../test-utils/start-account-context.js"; +import { createStartAccountContext } from "../../../test/helpers/extensions/start-account-context.js"; import { nostrPlugin } from "./channel.js"; import { setNostrRuntime } from "./runtime.js"; diff --git a/extensions/nostr/src/setup-surface.test.ts b/extensions/nostr/src/setup-surface.test.ts index 2985ff3e513..a883fda1234 100644 --- a/extensions/nostr/src/setup-surface.test.ts +++ b/extensions/nostr/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/nostr"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { nostrPlugin } from "./channel.js"; const nostrConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/phone-control/index.test.ts b/extensions/phone-control/index.test.ts index 5964919e9d7..e5fe260463b 100644 --- a/extensions/phone-control/index.test.ts +++ b/extensions/phone-control/index.test.ts @@ -7,7 +7,7 @@ import type { PluginCommandContext, } from "openclaw/plugin-sdk/phone-control"; import { describe, expect, it, vi } from "vitest"; -import { createTestPluginApi } from "../test-utils/plugin-api.js"; +import { createTestPluginApi } from "../../test/helpers/extensions/plugin-api.js"; import registerPhoneControl from "./index.js"; function createApi(params: { diff --git a/extensions/signal/src/monitor.tool-result.test-harness.ts b/extensions/signal/src/monitor.tool-result.test-harness.ts index 10cf32b383a..bcca049f4d7 100644 --- a/extensions/signal/src/monitor.tool-result.test-harness.ts +++ b/extensions/signal/src/monitor.tool-result.test-harness.ts @@ -1,6 +1,6 @@ import { resetSystemEventsForTest } from "openclaw/plugin-sdk/infra-runtime"; import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { beforeEach, vi } from "vitest"; import type { SignalDaemonExitEvent, SignalDaemonHandle } from "./daemon.js"; diff --git a/extensions/slack/src/monitor/media.test.ts b/extensions/slack/src/monitor/media.test.ts index 9d5114e2961..9ac0bc0eeb1 100644 --- a/extensions/slack/src/monitor/media.test.ts +++ b/extensions/slack/src/monitor/media.test.ts @@ -4,7 +4,10 @@ import * as mediaFetch from "../../../../src/media/fetch.js"; import type { SavedMedia } from "../../../../src/media/store.js"; import * as mediaStore from "../../../../src/media/store.js"; import { mockPinnedHostnameResolution } from "../../../../src/test-helpers/ssrf.js"; -import { type FetchMock, withFetchPreconnect } from "../../../test-utils/fetch-mock.js"; +import { + type FetchMock, + withFetchPreconnect, +} from "../../../../test/helpers/extensions/fetch-mock.js"; import { fetchWithSlackAuth, resolveSlackAttachmentContent, diff --git a/extensions/synology-chat/src/setup-surface.test.ts b/extensions/synology-chat/src/setup-surface.test.ts index 96c17300e0f..f6fbf48606f 100644 --- a/extensions/synology-chat/src/setup-surface.test.ts +++ b/extensions/synology-chat/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { synologyChatPlugin } from "./channel.js"; import { synologyChatSetupWizard } from "./setup-surface.js"; diff --git a/extensions/talk-voice/index.test.ts b/extensions/talk-voice/index.test.ts index 5b246c94bf1..487df4a2d7a 100644 --- a/extensions/talk-voice/index.test.ts +++ b/extensions/talk-voice/index.test.ts @@ -1,6 +1,6 @@ import { describe, expect, it, vi } from "vitest"; -import type { OpenClawPluginCommandDefinition } from "../test-utils/plugin-command.js"; -import { createPluginRuntimeMock } from "../test-utils/plugin-runtime-mock.js"; +import type { OpenClawPluginCommandDefinition } from "../../test/helpers/extensions/plugin-command.js"; +import { createPluginRuntimeMock } from "../../test/helpers/extensions/plugin-runtime-mock.js"; import register from "./index.js"; function createHarness(config: Record) { diff --git a/extensions/telegram/src/account-inspect.test.ts b/extensions/telegram/src/account-inspect.test.ts index 54915edb61c..735cf4e53bb 100644 --- a/extensions/telegram/src/account-inspect.test.ts +++ b/extensions/telegram/src/account-inspect.test.ts @@ -3,7 +3,7 @@ import os from "node:os"; import path from "node:path"; import { describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; -import { withEnv } from "../../test-utils/env.js"; +import { withEnv } from "../../../test/helpers/extensions/env.js"; import { inspectTelegramAccount } from "./account-inspect.js"; describe("inspectTelegramAccount SecretRef resolution", () => { diff --git a/extensions/telegram/src/accounts.test.ts b/extensions/telegram/src/accounts.test.ts index 6155b89d0af..ae8a56c66cf 100644 --- a/extensions/telegram/src/accounts.test.ts +++ b/extensions/telegram/src/accounts.test.ts @@ -1,7 +1,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; import * as subsystemModule from "../../../src/logging/subsystem.js"; -import { withEnv } from "../../test-utils/env.js"; +import { withEnv } from "../../../test/helpers/extensions/env.js"; import { listTelegramAccountIds, resetMissingDefaultWarnFlag, diff --git a/extensions/telegram/src/bot-native-commands.test-helpers.ts b/extensions/telegram/src/bot-native-commands.test-helpers.ts index 43059cd9b61..3afeb63fbb2 100644 --- a/extensions/telegram/src/bot-native-commands.test-helpers.ts +++ b/extensions/telegram/src/bot-native-commands.test-helpers.ts @@ -2,7 +2,7 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import type { ChannelGroupPolicy } from "openclaw/plugin-sdk/config-runtime"; import type { TelegramAccountConfig } from "openclaw/plugin-sdk/config-runtime"; import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env"; -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; import { createNativeCommandTestParams, diff --git a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts index 9f3eea03954..9d015e770a5 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test-harness.ts @@ -2,7 +2,7 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime"; import { resetInboundDedupe } from "openclaw/plugin-sdk/reply-runtime"; import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime"; import type { GetReplyOptions, ReplyPayload } from "openclaw/plugin-sdk/reply-runtime"; -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { beforeEach, vi } from "vitest"; type AnyMock = MockFn<(...args: unknown[]) => unknown>; diff --git a/extensions/telegram/src/bot.create-telegram-bot.test.ts b/extensions/telegram/src/bot.create-telegram-bot.test.ts index 3390aa3ff24..1cb0fd98512 100644 --- a/extensions/telegram/src/bot.create-telegram-bot.test.ts +++ b/extensions/telegram/src/bot.create-telegram-bot.test.ts @@ -3,8 +3,8 @@ import os from "node:os"; import path from "node:path"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; import { escapeRegExp, formatEnvelopeTimestamp } from "../../../test/helpers/envelope-timestamp.js"; -import { withEnvAsync } from "../../test-utils/env.js"; -import { useFrozenTime, useRealTime } from "../../test-utils/frozen-time.js"; +import { withEnvAsync } from "../../../test/helpers/extensions/env.js"; +import { useFrozenTime, useRealTime } from "../../../test/helpers/extensions/frozen-time.js"; import { answerCallbackQuerySpy, botCtorSpy, diff --git a/extensions/telegram/src/channel.test.ts b/extensions/telegram/src/channel.test.ts index 48d16361b1a..bac2de59f0b 100644 --- a/extensions/telegram/src/channel.test.ts +++ b/extensions/telegram/src/channel.test.ts @@ -5,7 +5,7 @@ import type { PluginRuntime, } from "openclaw/plugin-sdk/telegram"; import { afterEach, describe, expect, it, vi } from "vitest"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; import type { ResolvedTelegramAccount } from "./accounts.js"; import * as auditModule from "./audit.js"; import { telegramPlugin } from "./channel.js"; diff --git a/extensions/telegram/src/probe.test.ts b/extensions/telegram/src/probe.test.ts index 970e2559540..da6f86f9b80 100644 --- a/extensions/telegram/src/probe.test.ts +++ b/extensions/telegram/src/probe.test.ts @@ -1,5 +1,5 @@ import { afterEach, type Mock, describe, expect, it, vi } from "vitest"; -import { withFetchPreconnect } from "../../test-utils/fetch-mock.js"; +import { withFetchPreconnect } from "../../../test/helpers/extensions/fetch-mock.js"; import { probeTelegram, resetTelegramProbeFetcherCacheForTests } from "./probe.js"; const resolveTelegramFetch = vi.hoisted(() => vi.fn()); diff --git a/extensions/telegram/src/send.test-harness.ts b/extensions/telegram/src/send.test-harness.ts index c12a571c642..f313141dab0 100644 --- a/extensions/telegram/src/send.test-harness.ts +++ b/extensions/telegram/src/send.test-harness.ts @@ -1,4 +1,4 @@ -import type { MockFn } from "openclaw/plugin-sdk/test-utils"; +import type { MockFn } from "openclaw/plugin-sdk/testing"; import { beforeEach, vi } from "vitest"; const { botApi, botCtorSpy } = vi.hoisted(() => ({ diff --git a/extensions/test-utils/chunk-test-helpers.ts b/extensions/test-utils/chunk-test-helpers.ts deleted file mode 100644 index 643e28e5c24..00000000000 --- a/extensions/test-utils/chunk-test-helpers.ts +++ /dev/null @@ -1 +0,0 @@ -export { countLines, hasBalancedFences } from "../../src/test-utils/chunk-test-helpers.js"; diff --git a/extensions/test-utils/env.ts b/extensions/test-utils/env.ts deleted file mode 100644 index b171aa55a6c..00000000000 --- a/extensions/test-utils/env.ts +++ /dev/null @@ -1 +0,0 @@ -export { captureEnv, withEnv, withEnvAsync } from "../../src/test-utils/env.js"; diff --git a/extensions/test-utils/fetch-mock.ts b/extensions/test-utils/fetch-mock.ts deleted file mode 100644 index 2cd6b65e680..00000000000 --- a/extensions/test-utils/fetch-mock.ts +++ /dev/null @@ -1 +0,0 @@ -export { withFetchPreconnect, type FetchMock } from "../../src/test-utils/fetch-mock.js"; diff --git a/extensions/test-utils/frozen-time.ts b/extensions/test-utils/frozen-time.ts deleted file mode 100644 index ec31962fb76..00000000000 --- a/extensions/test-utils/frozen-time.ts +++ /dev/null @@ -1 +0,0 @@ -export { useFrozenTime, useRealTime } from "../../src/test-utils/frozen-time.js"; diff --git a/extensions/test-utils/mock-http-response.ts b/extensions/test-utils/mock-http-response.ts deleted file mode 100644 index bf0d8bef20c..00000000000 --- a/extensions/test-utils/mock-http-response.ts +++ /dev/null @@ -1 +0,0 @@ -export { createMockServerResponse } from "../../src/test-utils/mock-http-response.js"; diff --git a/extensions/test-utils/plugin-registration.ts b/extensions/test-utils/plugin-registration.ts deleted file mode 100644 index 7a7da8ecdad..00000000000 --- a/extensions/test-utils/plugin-registration.ts +++ /dev/null @@ -1 +0,0 @@ -export { registerSingleProviderPlugin } from "../../src/test-utils/plugin-registration.js"; diff --git a/extensions/test-utils/provider-usage-fetch.ts b/extensions/test-utils/provider-usage-fetch.ts deleted file mode 100644 index d70a6e1657a..00000000000 --- a/extensions/test-utils/provider-usage-fetch.ts +++ /dev/null @@ -1,4 +0,0 @@ -export { - createProviderUsageFetch, - makeResponse, -} from "../../src/test-utils/provider-usage-fetch.js"; diff --git a/extensions/test-utils/temp-dir.ts b/extensions/test-utils/temp-dir.ts deleted file mode 100644 index 3bd69bcc7b9..00000000000 --- a/extensions/test-utils/temp-dir.ts +++ /dev/null @@ -1 +0,0 @@ -export { withTempDir } from "../../src/test-utils/temp-dir.js"; diff --git a/extensions/test-utils/typed-cases.ts b/extensions/test-utils/typed-cases.ts deleted file mode 100644 index 4b6bd35b1ec..00000000000 --- a/extensions/test-utils/typed-cases.ts +++ /dev/null @@ -1 +0,0 @@ -export { typedCases } from "../../src/test-utils/typed-cases.js"; diff --git a/extensions/tlon/src/setup-surface.test.ts b/extensions/tlon/src/setup-surface.test.ts index f2b53f0df72..d10e35785db 100644 --- a/extensions/tlon/src/setup-surface.test.ts +++ b/extensions/tlon/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/tlon"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { tlonPlugin } from "./channel.js"; const tlonConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts b/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts index 43d1739e13f..9926b3c5324 100644 --- a/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts +++ b/extensions/whatsapp/src/accounts.whatsapp-auth.test.ts @@ -2,7 +2,7 @@ import fs from "node:fs"; import os from "node:os"; import path from "node:path"; import { afterEach, beforeEach, describe, expect, it } from "vitest"; -import { captureEnv } from "../../test-utils/env.js"; +import { captureEnv } from "../../../test/helpers/extensions/env.js"; import { hasAnyWhatsAppAuth, listWhatsAppAuthDirs } from "./accounts.js"; describe("hasAnyWhatsAppAuth", () => { diff --git a/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts b/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts index 6a5184fc059..235942663a8 100644 --- a/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts +++ b/extensions/whatsapp/src/auto-reply.web-auto-reply.connection-and-logging.e2e.test.ts @@ -5,7 +5,7 @@ import { beforeAll, describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../../../src/config/config.js"; import { setLoggerOverride } from "../../../src/logging.js"; import { escapeRegExp, formatEnvelopeTimestamp } from "../../../test/helpers/envelope-timestamp.js"; -import { withEnvAsync } from "../../test-utils/env.js"; +import { withEnvAsync } from "../../../test/helpers/extensions/env.js"; import { createMockWebListener, createWebListenerFactoryCapture, diff --git a/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts b/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts index d1011f5c7f8..eb733d14e0e 100644 --- a/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts +++ b/extensions/whatsapp/src/auto-reply/web-auto-reply-utils.test.ts @@ -2,7 +2,7 @@ import fs from "node:fs/promises"; import path from "node:path"; import { describe, expect, it, vi } from "vitest"; import { saveSessionStore } from "../../../../src/config/sessions.js"; -import { withTempDir } from "../../../test-utils/temp-dir.js"; +import { withTempDir } from "../../../../test/helpers/extensions/temp-dir.js"; import { debugMention, isBotMentionedFromTargets, diff --git a/extensions/whatsapp/src/media.test.ts b/extensions/whatsapp/src/media.test.ts index 45f3fbae309..ce3e98c549c 100644 --- a/extensions/whatsapp/src/media.test.ts +++ b/extensions/whatsapp/src/media.test.ts @@ -7,8 +7,8 @@ import { resolveStateDir } from "../../../src/config/paths.js"; import { resolvePreferredOpenClawTmpDir } from "../../../src/infra/tmp-openclaw-dir.js"; import { optimizeImageToPng } from "../../../src/media/image-ops.js"; import { mockPinnedHostnameResolution } from "../../../src/test-helpers/ssrf.js"; +import { captureEnv } from "../../../test/helpers/extensions/env.js"; import { sendVoiceMessageDiscord } from "../../discord/src/send.js"; -import { captureEnv } from "../../test-utils/env.js"; import { LocalMediaAccessError, loadWebMedia, diff --git a/extensions/zalo/src/channel.directory.test.ts b/extensions/zalo/src/channel.directory.test.ts index 8a303e72a97..ac079109736 100644 --- a/extensions/zalo/src/channel.directory.test.ts +++ b/extensions/zalo/src/channel.directory.test.ts @@ -1,6 +1,9 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/zalo"; import { describe, expect, it } from "vitest"; -import { createDirectoryTestRuntime, expectDirectorySurface } from "../../test-utils/directory.js"; +import { + createDirectoryTestRuntime, + expectDirectorySurface, +} from "../../../test/helpers/extensions/directory.js"; import { zaloPlugin } from "./channel.js"; describe("zalo directory", () => { diff --git a/extensions/zalo/src/channel.startup.test.ts b/extensions/zalo/src/channel.startup.test.ts index ea0718d29a2..d99f2397438 100644 --- a/extensions/zalo/src/channel.startup.test.ts +++ b/extensions/zalo/src/channel.startup.test.ts @@ -3,7 +3,7 @@ import { afterEach, describe, expect, it, vi } from "vitest"; import { expectPendingUntilAbort, startAccountAndTrackLifecycle, -} from "../../test-utils/start-account-lifecycle.js"; +} from "../../../test/helpers/extensions/start-account-lifecycle.js"; import type { ResolvedZaloAccount } from "./accounts.js"; const hoisted = vi.hoisted(() => ({ diff --git a/extensions/zalo/src/setup-surface.test.ts b/extensions/zalo/src/setup-surface.test.ts index a6e278b6f69..858720c74a8 100644 --- a/extensions/zalo/src/setup-surface.test.ts +++ b/extensions/zalo/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/zalo"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; import { zaloPlugin } from "./channel.js"; const zaloConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/zalo/src/status-issues.test.ts b/extensions/zalo/src/status-issues.test.ts index 581a0dfe916..1187d45a298 100644 --- a/extensions/zalo/src/status-issues.test.ts +++ b/extensions/zalo/src/status-issues.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { expectOpenDmPolicyConfigIssue } from "../../test-utils/status-issues.js"; +import { expectOpenDmPolicyConfigIssue } from "../../../test/helpers/extensions/status-issues.js"; import { collectZaloStatusIssues } from "./status-issues.js"; describe("collectZaloStatusIssues", () => { diff --git a/extensions/zalouser/src/setup-surface.test.ts b/extensions/zalouser/src/setup-surface.test.ts index 1aa8dd93bd0..af95c35465b 100644 --- a/extensions/zalouser/src/setup-surface.test.ts +++ b/extensions/zalouser/src/setup-surface.test.ts @@ -1,8 +1,8 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/zalouser"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; -import { createRuntimeEnv } from "../../test-utils/runtime-env.js"; -import { createTestWizardPrompter } from "../../test-utils/setup-wizard.js"; +import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; +import { createTestWizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; vi.mock("./zalo-js.js", async (importOriginal) => { const actual = await importOriginal(); diff --git a/extensions/zalouser/src/status-issues.test.ts b/extensions/zalouser/src/status-issues.test.ts index c1e142c88e8..bd1ae4d4cd4 100644 --- a/extensions/zalouser/src/status-issues.test.ts +++ b/extensions/zalouser/src/status-issues.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { expectOpenDmPolicyConfigIssue } from "../../test-utils/status-issues.js"; +import { expectOpenDmPolicyConfigIssue } from "../../../test/helpers/extensions/status-issues.js"; import { collectZalouserStatusIssues } from "./status-issues.js"; describe("collectZalouserStatusIssues", () => { diff --git a/package.json b/package.json index e1e9379c1a8..c6ed4cab402 100644 --- a/package.json +++ b/package.json @@ -278,6 +278,10 @@ "types": "./dist/plugin-sdk/talk-voice.d.ts", "default": "./dist/plugin-sdk/talk-voice.js" }, + "./plugin-sdk/testing": { + "types": "./dist/plugin-sdk/testing.d.ts", + "default": "./dist/plugin-sdk/testing.js" + }, "./plugin-sdk/test-utils": { "types": "./dist/plugin-sdk/test-utils.d.ts", "default": "./dist/plugin-sdk/test-utils.js" diff --git a/scripts/check-no-extension-test-core-imports.ts b/scripts/check-no-extension-test-core-imports.ts index b8e3b1bc764..01d6639df1e 100644 --- a/scripts/check-no-extension-test-core-imports.ts +++ b/scripts/check-no-extension-test-core-imports.ts @@ -6,17 +6,25 @@ const FORBIDDEN_PATTERNS: Array<{ pattern: RegExp; hint: string }> = [ pattern: /["']openclaw\/plugin-sdk["']/, hint: "Use openclaw/plugin-sdk/ instead of the monolithic root entry.", }, + { + pattern: /["']openclaw\/plugin-sdk\/test-utils["']/, + hint: "Use openclaw/plugin-sdk/testing for the public extension test seam.", + }, { pattern: /["']openclaw\/plugin-sdk\/compat["']/, hint: "Use a focused public plugin-sdk subpath instead of compat.", }, + { + pattern: /["'](?:\.\.\/)+(?:test-utils\/)[^"']+["']/, + hint: "Use test/helpers/extensions/* for repo-only bundled extension test helpers.", + }, { pattern: /["'](?:\.\.\/)+(?:src\/test-utils\/)[^"']+["']/, - hint: "Use extensions/test-utils/* bridges for shared extension test helpers.", + hint: "Use test/helpers/extensions/* for repo-only helpers, or openclaw/plugin-sdk/testing for public seams.", }, { pattern: /["'](?:\.\.\/)+(?:src\/plugins\/types\.js)["']/, - hint: "Use public plugin-sdk/core types or extensions/test-utils bridges instead.", + hint: "Use public plugin-sdk/core types or test/helpers/extensions/* instead.", }, ]; diff --git a/scripts/lib/plugin-sdk-entrypoints.json b/scripts/lib/plugin-sdk-entrypoints.json index 801cebcd462..6e41a759867 100644 --- a/scripts/lib/plugin-sdk-entrypoints.json +++ b/scripts/lib/plugin-sdk-entrypoints.json @@ -59,6 +59,7 @@ "qwen-portal-auth", "synology-chat", "talk-voice", + "testing", "test-utils", "thread-ownership", "tlon", diff --git a/src/plugin-sdk/subpaths.test.ts b/src/plugin-sdk/subpaths.test.ts index a3cc2b3ba1f..7a43a159b73 100644 --- a/src/plugin-sdk/subpaths.test.ts +++ b/src/plugin-sdk/subpaths.test.ts @@ -20,6 +20,7 @@ import * as setupSdk from "openclaw/plugin-sdk/setup"; import * as signalSdk from "openclaw/plugin-sdk/signal"; import * as slackSdk from "openclaw/plugin-sdk/slack"; import * as telegramSdk from "openclaw/plugin-sdk/telegram"; +import * as testingSdk from "openclaw/plugin-sdk/testing"; import * as whatsappSdk from "openclaw/plugin-sdk/whatsapp"; import { describe, expect, expectTypeOf, it } from "vitest"; import type { ChannelMessageActionContext } from "../channels/plugins/types.js"; @@ -114,6 +115,11 @@ describe("plugin-sdk subpath exports", () => { expectTypeOf().toMatchTypeOf(); }); + it("exports the public testing seam", () => { + expect(typeof testingSdk.removeAckReactionAfterReply).toBe("function"); + expect(typeof testingSdk.shouldAckReaction).toBe("function"); + }); + it("keeps core shared types aligned with the channel prelude", () => { expectTypeOf().toMatchTypeOf(); expectTypeOf().toMatchTypeOf(); diff --git a/src/plugin-sdk/test-utils.ts b/src/plugin-sdk/test-utils.ts index 5d825813d0e..26cddc72854 100644 --- a/src/plugin-sdk/test-utils.ts +++ b/src/plugin-sdk/test-utils.ts @@ -1,9 +1,4 @@ -// Narrow plugin-sdk surface for the bundled test-utils plugin. -// Keep this list additive and scoped to symbols used under extensions/test-utils. +// Deprecated compatibility alias. +// Prefer openclaw/plugin-sdk/testing for public test helpers. -export { removeAckReactionAfterReply, shouldAckReaction } from "../channels/ack-reactions.js"; -export type { ChannelAccountSnapshot, ChannelGatewayContext } from "../channels/plugins/types.js"; -export type { OpenClawConfig } from "../config/config.js"; -export type { PluginRuntime } from "../plugins/runtime/types.js"; -export type { RuntimeEnv } from "../runtime.js"; -export type { MockFn } from "../test-utils/vitest-mock-fn.js"; +export * from "./testing.js"; diff --git a/src/plugin-sdk/testing.ts b/src/plugin-sdk/testing.ts new file mode 100644 index 00000000000..e8a7e89f646 --- /dev/null +++ b/src/plugin-sdk/testing.ts @@ -0,0 +1,9 @@ +// Narrow public testing surface for plugin authors. +// Keep this list additive and limited to helpers we are willing to support. + +export { removeAckReactionAfterReply, shouldAckReaction } from "../channels/ack-reactions.js"; +export type { ChannelAccountSnapshot, ChannelGatewayContext } from "../channels/plugins/types.js"; +export type { OpenClawConfig } from "../config/config.js"; +export type { PluginRuntime } from "../plugins/runtime/types.js"; +export type { RuntimeEnv } from "../runtime.js"; +export type { MockFn } from "../test-utils/vitest-mock-fn.js"; diff --git a/test/helpers/extensions/chunk-test-helpers.ts b/test/helpers/extensions/chunk-test-helpers.ts new file mode 100644 index 00000000000..c6589284fd3 --- /dev/null +++ b/test/helpers/extensions/chunk-test-helpers.ts @@ -0,0 +1 @@ +export { countLines, hasBalancedFences } from "../../../src/test-utils/chunk-test-helpers.js"; diff --git a/extensions/test-utils/directory.ts b/test/helpers/extensions/directory.ts similarity index 100% rename from extensions/test-utils/directory.ts rename to test/helpers/extensions/directory.ts diff --git a/extensions/test-utils/discord-provider.test-support.ts b/test/helpers/extensions/discord-provider.test-support.ts similarity index 100% rename from extensions/test-utils/discord-provider.test-support.ts rename to test/helpers/extensions/discord-provider.test-support.ts diff --git a/test/helpers/extensions/env.ts b/test/helpers/extensions/env.ts new file mode 100644 index 00000000000..bc48bfd3d10 --- /dev/null +++ b/test/helpers/extensions/env.ts @@ -0,0 +1 @@ +export { captureEnv, withEnv, withEnvAsync } from "../../../src/test-utils/env.js"; diff --git a/test/helpers/extensions/fetch-mock.ts b/test/helpers/extensions/fetch-mock.ts new file mode 100644 index 00000000000..e1774b46463 --- /dev/null +++ b/test/helpers/extensions/fetch-mock.ts @@ -0,0 +1 @@ +export { withFetchPreconnect, type FetchMock } from "../../../src/test-utils/fetch-mock.js"; diff --git a/test/helpers/extensions/frozen-time.ts b/test/helpers/extensions/frozen-time.ts new file mode 100644 index 00000000000..69f188f09ca --- /dev/null +++ b/test/helpers/extensions/frozen-time.ts @@ -0,0 +1 @@ +export { useFrozenTime, useRealTime } from "../../../src/test-utils/frozen-time.js"; diff --git a/test/helpers/extensions/mock-http-response.ts b/test/helpers/extensions/mock-http-response.ts new file mode 100644 index 00000000000..3bbed0372a8 --- /dev/null +++ b/test/helpers/extensions/mock-http-response.ts @@ -0,0 +1 @@ +export { createMockServerResponse } from "../../../src/test-utils/mock-http-response.js"; diff --git a/extensions/test-utils/plugin-api.ts b/test/helpers/extensions/plugin-api.ts similarity index 100% rename from extensions/test-utils/plugin-api.ts rename to test/helpers/extensions/plugin-api.ts diff --git a/extensions/test-utils/plugin-command.ts b/test/helpers/extensions/plugin-command.ts similarity index 100% rename from extensions/test-utils/plugin-command.ts rename to test/helpers/extensions/plugin-command.ts diff --git a/test/helpers/extensions/plugin-registration.ts b/test/helpers/extensions/plugin-registration.ts new file mode 100644 index 00000000000..bd20510800e --- /dev/null +++ b/test/helpers/extensions/plugin-registration.ts @@ -0,0 +1 @@ +export { registerSingleProviderPlugin } from "../../../src/test-utils/plugin-registration.js"; diff --git a/extensions/test-utils/plugin-runtime-mock.ts b/test/helpers/extensions/plugin-runtime-mock.ts similarity index 99% rename from extensions/test-utils/plugin-runtime-mock.ts rename to test/helpers/extensions/plugin-runtime-mock.ts index fbc9bcdc7fd..d71eeb2d584 100644 --- a/extensions/test-utils/plugin-runtime-mock.ts +++ b/test/helpers/extensions/plugin-runtime-mock.ts @@ -1,6 +1,6 @@ import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "openclaw/plugin-sdk/agent-runtime"; -import type { PluginRuntime } from "openclaw/plugin-sdk/test-utils"; -import { removeAckReactionAfterReply, shouldAckReaction } from "openclaw/plugin-sdk/test-utils"; +import type { PluginRuntime } from "openclaw/plugin-sdk/testing"; +import { removeAckReactionAfterReply, shouldAckReaction } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; type DeepPartial = { diff --git a/test/helpers/extensions/provider-usage-fetch.ts b/test/helpers/extensions/provider-usage-fetch.ts new file mode 100644 index 00000000000..fe54174732e --- /dev/null +++ b/test/helpers/extensions/provider-usage-fetch.ts @@ -0,0 +1,4 @@ +export { + createProviderUsageFetch, + makeResponse, +} from "../../../src/test-utils/provider-usage-fetch.js"; diff --git a/extensions/test-utils/runtime-env.ts b/test/helpers/extensions/runtime-env.ts similarity index 77% rename from extensions/test-utils/runtime-env.ts rename to test/helpers/extensions/runtime-env.ts index a5e52665b0e..b197619e43e 100644 --- a/extensions/test-utils/runtime-env.ts +++ b/test/helpers/extensions/runtime-env.ts @@ -1,4 +1,4 @@ -import type { RuntimeEnv } from "openclaw/plugin-sdk/test-utils"; +import type { RuntimeEnv } from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; export function createRuntimeEnv(): RuntimeEnv { diff --git a/extensions/test-utils/send-config.ts b/test/helpers/extensions/send-config.ts similarity index 100% rename from extensions/test-utils/send-config.ts rename to test/helpers/extensions/send-config.ts diff --git a/extensions/test-utils/setup-wizard.ts b/test/helpers/extensions/setup-wizard.ts similarity index 84% rename from extensions/test-utils/setup-wizard.ts rename to test/helpers/extensions/setup-wizard.ts index aab15a4aecc..109394ee886 100644 --- a/extensions/test-utils/setup-wizard.ts +++ b/test/helpers/extensions/setup-wizard.ts @@ -1,7 +1,7 @@ import { vi } from "vitest"; -import type { WizardPrompter } from "../../src/wizard/prompts.js"; +import type { WizardPrompter } from "../../../src/wizard/prompts.js"; -export type { WizardPrompter } from "../../src/wizard/prompts.js"; +export type { WizardPrompter } from "../../../src/wizard/prompts.js"; export async function selectFirstWizardOption(params: { options: Array<{ value: T }>; diff --git a/extensions/test-utils/start-account-context.ts b/test/helpers/extensions/start-account-context.ts similarity index 95% rename from extensions/test-utils/start-account-context.ts rename to test/helpers/extensions/start-account-context.ts index a878b3dbfd9..56a66a9ca56 100644 --- a/extensions/test-utils/start-account-context.ts +++ b/test/helpers/extensions/start-account-context.ts @@ -2,7 +2,7 @@ import type { ChannelAccountSnapshot, ChannelGatewayContext, OpenClawConfig, -} from "openclaw/plugin-sdk/test-utils"; +} from "openclaw/plugin-sdk/testing"; import { vi } from "vitest"; import { createRuntimeEnv } from "./runtime-env.js"; diff --git a/extensions/test-utils/start-account-lifecycle.ts b/test/helpers/extensions/start-account-lifecycle.ts similarity index 98% rename from extensions/test-utils/start-account-lifecycle.ts rename to test/helpers/extensions/start-account-lifecycle.ts index 6ce1c734736..ea76fe857d5 100644 --- a/extensions/test-utils/start-account-lifecycle.ts +++ b/test/helpers/extensions/start-account-lifecycle.ts @@ -1,4 +1,4 @@ -import type { ChannelAccountSnapshot, ChannelGatewayContext } from "openclaw/plugin-sdk/test-utils"; +import type { ChannelAccountSnapshot, ChannelGatewayContext } from "openclaw/plugin-sdk/testing"; import { expect, vi } from "vitest"; import { createStartAccountContext } from "./start-account-context.js"; diff --git a/extensions/test-utils/status-issues.ts b/test/helpers/extensions/status-issues.ts similarity index 100% rename from extensions/test-utils/status-issues.ts rename to test/helpers/extensions/status-issues.ts diff --git a/extensions/test-utils/subagent-hooks.ts b/test/helpers/extensions/subagent-hooks.ts similarity index 100% rename from extensions/test-utils/subagent-hooks.ts rename to test/helpers/extensions/subagent-hooks.ts diff --git a/test/helpers/extensions/temp-dir.ts b/test/helpers/extensions/temp-dir.ts new file mode 100644 index 00000000000..08ec26218ec --- /dev/null +++ b/test/helpers/extensions/temp-dir.ts @@ -0,0 +1 @@ +export { withTempDir } from "../../../src/test-utils/temp-dir.js"; diff --git a/test/helpers/extensions/typed-cases.ts b/test/helpers/extensions/typed-cases.ts new file mode 100644 index 00000000000..45be30b08c3 --- /dev/null +++ b/test/helpers/extensions/typed-cases.ts @@ -0,0 +1 @@ +export { typedCases } from "../../../src/test-utils/typed-cases.js"; From ce486292a183a0a87f17def6f3e315c9c02532ef Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 01:04:33 -0700 Subject: [PATCH 176/187] test: fix discord provider helper import --- extensions/discord/src/monitor/provider.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/discord/src/monitor/provider.test.ts b/extensions/discord/src/monitor/provider.test.ts index 4ff936f5519..8cda7cc90b3 100644 --- a/extensions/discord/src/monitor/provider.test.ts +++ b/extensions/discord/src/monitor/provider.test.ts @@ -9,7 +9,7 @@ import { getProviderMonitorTestMocks, mockResolvedDiscordAccountConfig, resetDiscordProviderMonitorMocks, -} from "../../../test-utils/discord-provider.test-support.js"; +} from "../../../../test/helpers/extensions/discord-provider.test-support.js"; const { clientConstructorOptionsMock, From 99c7750c2d23d593826caeac97dfa23c430506fd Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Tue, 17 Mar 2026 01:07:47 -0700 Subject: [PATCH 177/187] Changelog: add Telegram DM topic session-key fix --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ade3e3457d..9343a5d34a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -120,6 +120,7 @@ Docs: https://docs.openclaw.ai ### Fixes - Agents/bootstrap warnings: move bootstrap truncation warnings out of the system prompt and into the per-turn prompt body so prompt-cache reuse stays stable when truncation warnings appear or disappear. (#48753) Thanks @scoootscooob and @obviyus. +- Telegram/DM topic session keys: route named-account DM topics through the same per-account base session key across inbound messages, native commands, and session-state lookups so `/status` and thread recovery stop creating phantom `agent:main:main:thread:...` sessions. (#48204) Thanks @vincentkoc. ## 2026.3.13 From 916db21fe5e9c38592ab5fe4d10a07905f96b216 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:08:25 +0000 Subject: [PATCH 178/187] fix(ci): harden zizmor workflow diffing --- .github/workflows/ci.yml | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0eb2868d37b..9316afb6d09 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -460,30 +460,30 @@ jobs: run: pre-commit run --all-files detect-private-key - name: Audit changed GitHub workflows with zizmor + env: + BASE_SHA: ${{ github.event_name == 'push' && github.event.before || github.event.pull_request.base.sha }} run: | set -euo pipefail - BASE="$( - python - <<'PY' - import json - import os + if [ -z "${BASE_SHA:-}" ] || [ "${BASE_SHA}" = "0000000000000000000000000000000000000000" ]; then + echo "No usable base SHA detected; skipping zizmor." + exit 0 + fi - with open(os.environ["GITHUB_EVENT_PATH"], "r", encoding="utf-8") as fh: - event = json.load(fh) + if ! git cat-file -e "${BASE_SHA}^{commit}" 2>/dev/null; then + echo "Base SHA ${BASE_SHA} is unavailable; skipping zizmor." + exit 0 + fi - if os.environ["GITHUB_EVENT_NAME"] == "push": - print(event["before"]) - else: - print(event["pull_request"]["base"]["sha"]) - PY - )" - - mapfile -t workflow_files < <(git diff --name-only "$BASE" HEAD -- '.github/workflows/*.yml' '.github/workflows/*.yaml') + mapfile -t workflow_files < <( + git diff --name-only "${BASE_SHA}" HEAD -- '.github/workflows/*.yml' '.github/workflows/*.yaml' + ) if [ "${#workflow_files[@]}" -eq 0 ]; then echo "No workflow changes detected; skipping zizmor." exit 0 fi + printf 'Auditing workflow files:\n%s\n' "${workflow_files[@]}" pre-commit run zizmor --files "${workflow_files[@]}" - name: Audit production dependencies From 3a456678ee3516679185a0814ac61d91128fcb9d Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 01:09:24 -0700 Subject: [PATCH 179/187] feat(image-generation): add image_generate tool --- .../openclaw-tools.image-generation.test.ts | 39 ++ src/agents/openclaw-tools.ts | 9 + .../pi-embedded-subscribe.tools.media.test.ts | 9 +- src/agents/pi-embedded-subscribe.tools.ts | 1 + src/agents/system-prompt.ts | 2 + src/agents/tool-catalog.test.ts | 1 + src/agents/tool-catalog.ts | 8 + src/agents/tools/image-generate-tool.test.ts | 280 ++++++++++++ src/agents/tools/image-generate-tool.ts | 424 ++++++++++++++++++ src/image-generation/providers/google.test.ts | 74 +++ src/image-generation/providers/google.ts | 21 +- src/image-generation/providers/openai.test.ts | 30 +- src/image-generation/providers/openai.ts | 7 +- src/image-generation/runtime.test.ts | 19 +- src/image-generation/runtime.ts | 14 +- src/image-generation/types.ts | 17 + src/plugin-sdk/image-generation.ts | 2 + 17 files changed, 949 insertions(+), 8 deletions(-) create mode 100644 src/agents/openclaw-tools.image-generation.test.ts create mode 100644 src/agents/tools/image-generate-tool.test.ts create mode 100644 src/agents/tools/image-generate-tool.ts diff --git a/src/agents/openclaw-tools.image-generation.test.ts b/src/agents/openclaw-tools.image-generation.test.ts new file mode 100644 index 00000000000..dd237115ab7 --- /dev/null +++ b/src/agents/openclaw-tools.image-generation.test.ts @@ -0,0 +1,39 @@ +import { describe, expect, it, vi } from "vitest"; +import type { OpenClawConfig } from "../config/config.js"; +import { createOpenClawTools } from "./openclaw-tools.js"; + +vi.mock("../plugins/tools.js", () => ({ + resolvePluginTools: () => [], +})); + +function asConfig(value: unknown): OpenClawConfig { + return value as OpenClawConfig; +} + +describe("openclaw tools image generation registration", () => { + it("registers image_generate when image-generation config is present", () => { + const tools = createOpenClawTools({ + config: asConfig({ + agents: { + defaults: { + imageGenerationModel: { + primary: "openai/gpt-image-1", + }, + }, + }, + }), + agentDir: "/tmp/openclaw-agent-main", + }); + + expect(tools.map((tool) => tool.name)).toContain("image_generate"); + }); + + it("omits image_generate when image-generation config is absent", () => { + const tools = createOpenClawTools({ + config: asConfig({}), + agentDir: "/tmp/openclaw-agent-main", + }); + + expect(tools.map((tool) => tool.name)).not.toContain("image_generate"); + }); +}); diff --git a/src/agents/openclaw-tools.ts b/src/agents/openclaw-tools.ts index 32bd92f4207..6f4929d288a 100644 --- a/src/agents/openclaw-tools.ts +++ b/src/agents/openclaw-tools.ts @@ -12,6 +12,7 @@ import { createCanvasTool } from "./tools/canvas-tool.js"; import type { AnyAgentTool } from "./tools/common.js"; import { createCronTool } from "./tools/cron-tool.js"; import { createGatewayTool } from "./tools/gateway-tool.js"; +import { createImageGenerateTool } from "./tools/image-generate-tool.js"; import { createImageTool } from "./tools/image-tool.js"; import { createMessageTool } from "./tools/message-tool.js"; import { createNodesTool } from "./tools/nodes-tool.js"; @@ -103,6 +104,13 @@ export function createOpenClawTools( modelHasVision: options?.modelHasVision, }) : null; + const imageGenerateTool = createImageGenerateTool({ + config: options?.config, + agentDir: options?.agentDir, + workspaceDir, + sandbox, + fsPolicy: options?.fsPolicy, + }); const pdfTool = options?.agentDir?.trim() ? createPdfTool({ config: options?.config, @@ -163,6 +171,7 @@ export function createOpenClawTools( agentChannel: options?.agentChannel, config: options?.config, }), + ...(imageGenerateTool ? [imageGenerateTool] : []), createGatewayTool({ agentSessionKey: options?.agentSessionKey, config: options?.config, diff --git a/src/agents/pi-embedded-subscribe.tools.media.test.ts b/src/agents/pi-embedded-subscribe.tools.media.test.ts index a07ed71473d..7cf51bb7c1c 100644 --- a/src/agents/pi-embedded-subscribe.tools.media.test.ts +++ b/src/agents/pi-embedded-subscribe.tools.media.test.ts @@ -1,5 +1,8 @@ import { describe, expect, it } from "vitest"; -import { extractToolResultMediaPaths } from "./pi-embedded-subscribe.tools.js"; +import { + extractToolResultMediaPaths, + isToolResultMediaTrusted, +} from "./pi-embedded-subscribe.tools.js"; describe("extractToolResultMediaPaths", () => { it("returns empty array for null/undefined", () => { @@ -229,4 +232,8 @@ describe("extractToolResultMediaPaths", () => { }; expect(extractToolResultMediaPaths(result)).toEqual(["/tmp/page1.png", "/tmp/page2.png"]); }); + + it("trusts image_generate local MEDIA paths", () => { + expect(isToolResultMediaTrusted("image_generate")).toBe(true); + }); }); diff --git a/src/agents/pi-embedded-subscribe.tools.ts b/src/agents/pi-embedded-subscribe.tools.ts index 08a5e5f80c4..925f56fa6ee 100644 --- a/src/agents/pi-embedded-subscribe.tools.ts +++ b/src/agents/pi-embedded-subscribe.tools.ts @@ -142,6 +142,7 @@ const TRUSTED_TOOL_RESULT_MEDIA = new Set([ "exec", "gateway", "image", + "image_generate", "memory_get", "memory_search", "message", diff --git a/src/agents/system-prompt.ts b/src/agents/system-prompt.ts index 5f4ee932bd7..3ee438db2d4 100644 --- a/src/agents/system-prompt.ts +++ b/src/agents/system-prompt.ts @@ -268,6 +268,7 @@ export function buildAgentSystemPrompt(params: { session_status: "Show a /status-equivalent status card (usage + time + Reasoning/Verbose/Elevated); use for model-use questions (📊 session_status); optional per-session model override", image: "Analyze an image with the configured image model", + image_generate: "Generate images with the configured image-generation model", }; const toolOrder = [ @@ -295,6 +296,7 @@ export function buildAgentSystemPrompt(params: { "subagents", "session_status", "image", + "image_generate", ]; const rawToolNames = (params.toolNames ?? []).map((tool) => tool.trim()); diff --git a/src/agents/tool-catalog.test.ts b/src/agents/tool-catalog.test.ts index 120a744432c..2f7fa0fc5d6 100644 --- a/src/agents/tool-catalog.test.ts +++ b/src/agents/tool-catalog.test.ts @@ -7,5 +7,6 @@ describe("tool-catalog", () => { expect(policy).toBeDefined(); expect(policy!.allow).toContain("web_search"); expect(policy!.allow).toContain("web_fetch"); + expect(policy!.allow).toContain("image_generate"); }); }); diff --git a/src/agents/tool-catalog.ts b/src/agents/tool-catalog.ts index 445cdc5f10b..0d58c066928 100644 --- a/src/agents/tool-catalog.ts +++ b/src/agents/tool-catalog.ts @@ -233,6 +233,14 @@ const CORE_TOOL_DEFINITIONS: CoreToolDefinition[] = [ profiles: ["coding"], includeInOpenClawGroup: true, }, + { + id: "image_generate", + label: "image_generate", + description: "Image generation", + sectionId: "media", + profiles: ["coding"], + includeInOpenClawGroup: true, + }, { id: "tts", label: "tts", diff --git a/src/agents/tools/image-generate-tool.test.ts b/src/agents/tools/image-generate-tool.test.ts new file mode 100644 index 00000000000..97f324921e3 --- /dev/null +++ b/src/agents/tools/image-generate-tool.test.ts @@ -0,0 +1,280 @@ +import { afterEach, describe, expect, it, vi } from "vitest"; +import * as imageGenerationRuntime from "../../image-generation/runtime.js"; +import * as imageOps from "../../media/image-ops.js"; +import * as mediaStore from "../../media/store.js"; +import * as webMedia from "../../plugin-sdk/web-media.js"; +import { createImageGenerateTool } from "./image-generate-tool.js"; + +describe("createImageGenerateTool", () => { + afterEach(() => { + vi.restoreAllMocks(); + }); + + it("returns null when image-generation model is not configured", () => { + expect(createImageGenerateTool({ config: {} })).toBeNull(); + }); + + it("generates images and returns MEDIA paths", async () => { + const generateImage = vi.spyOn(imageGenerationRuntime, "generateImage").mockResolvedValue({ + provider: "openai", + model: "gpt-image-1", + attempts: [], + images: [ + { + buffer: Buffer.from("png-1"), + mimeType: "image/png", + fileName: "cat-one.png", + }, + { + buffer: Buffer.from("png-2"), + mimeType: "image/png", + fileName: "cat-two.png", + revisedPrompt: "A more cinematic cat", + }, + ], + }); + const saveMediaBuffer = vi.spyOn(mediaStore, "saveMediaBuffer"); + saveMediaBuffer.mockResolvedValueOnce({ + path: "/tmp/generated-1.png", + id: "generated-1.png", + size: 5, + contentType: "image/png", + }); + saveMediaBuffer.mockResolvedValueOnce({ + path: "/tmp/generated-2.png", + id: "generated-2.png", + size: 5, + contentType: "image/png", + }); + + const tool = createImageGenerateTool({ + config: { + agents: { + defaults: { + imageGenerationModel: { + primary: "openai/gpt-image-1", + }, + }, + }, + }, + agentDir: "/tmp/agent", + }); + + expect(tool).not.toBeNull(); + if (!tool) { + throw new Error("expected image_generate tool"); + } + + const result = await tool.execute("call-1", { + prompt: "A cat wearing sunglasses", + model: "openai/gpt-image-1", + count: 2, + size: "1024x1024", + }); + + expect(generateImage).toHaveBeenCalledWith( + expect.objectContaining({ + cfg: { + agents: { + defaults: { + imageGenerationModel: { + primary: "openai/gpt-image-1", + }, + }, + }, + }, + prompt: "A cat wearing sunglasses", + agentDir: "/tmp/agent", + modelOverride: "openai/gpt-image-1", + size: "1024x1024", + count: 2, + inputImages: [], + }), + ); + expect(saveMediaBuffer).toHaveBeenNthCalledWith( + 1, + Buffer.from("png-1"), + "image/png", + "tool-image-generation", + undefined, + "cat-one.png", + ); + expect(saveMediaBuffer).toHaveBeenNthCalledWith( + 2, + Buffer.from("png-2"), + "image/png", + "tool-image-generation", + undefined, + "cat-two.png", + ); + expect(result).toMatchObject({ + content: [ + { + type: "text", + text: expect.stringContaining("Generated 2 images with openai/gpt-image-1."), + }, + ], + details: { + provider: "openai", + model: "gpt-image-1", + count: 2, + paths: ["/tmp/generated-1.png", "/tmp/generated-2.png"], + revisedPrompts: ["A more cinematic cat"], + }, + }); + const text = (result.content?.[0] as { text: string } | undefined)?.text ?? ""; + expect(text).toContain("MEDIA:/tmp/generated-1.png"); + expect(text).toContain("MEDIA:/tmp/generated-2.png"); + }); + + it("rejects counts outside the supported range", async () => { + const tool = createImageGenerateTool({ + config: { + agents: { + defaults: { + imageGenerationModel: { + primary: "google/gemini-3.1-flash-image-preview", + }, + }, + }, + }, + }); + expect(tool).not.toBeNull(); + if (!tool) { + throw new Error("expected image_generate tool"); + } + + await expect(tool.execute("call-2", { prompt: "too many cats", count: 5 })).rejects.toThrow( + "count must be between 1 and 4", + ); + }); + + it("forwards reference images and inferred resolution for edit mode", async () => { + const generateImage = vi.spyOn(imageGenerationRuntime, "generateImage").mockResolvedValue({ + provider: "google", + model: "gemini-3-pro-image-preview", + attempts: [], + images: [ + { + buffer: Buffer.from("png-out"), + mimeType: "image/png", + fileName: "edited.png", + }, + ], + }); + vi.spyOn(webMedia, "loadWebMedia").mockResolvedValue({ + kind: "image", + buffer: Buffer.from("input-image"), + contentType: "image/png", + }); + vi.spyOn(imageOps, "getImageMetadata").mockResolvedValue({ + width: 3200, + height: 1800, + }); + vi.spyOn(mediaStore, "saveMediaBuffer").mockResolvedValue({ + path: "/tmp/edited.png", + id: "edited.png", + size: 7, + contentType: "image/png", + }); + + const tool = createImageGenerateTool({ + config: { + agents: { + defaults: { + imageGenerationModel: { + primary: "google/gemini-3-pro-image-preview", + }, + }, + }, + }, + workspaceDir: process.cwd(), + }); + + expect(tool).not.toBeNull(); + if (!tool) { + throw new Error("expected image_generate tool"); + } + + await tool.execute("call-edit", { + prompt: "Add a dramatic stormy sky but keep everything else identical.", + image: "./fixtures/reference.png", + }); + + expect(generateImage).toHaveBeenCalledWith( + expect.objectContaining({ + resolution: "4K", + inputImages: [ + expect.objectContaining({ + buffer: Buffer.from("input-image"), + mimeType: "image/png", + }), + ], + }), + ); + }); + + it("lists registered provider and model options", async () => { + vi.spyOn(imageGenerationRuntime, "listRuntimeImageGenerationProviders").mockReturnValue([ + { + id: "google", + defaultModel: "gemini-3.1-flash-image-preview", + models: ["gemini-3.1-flash-image-preview", "gemini-3-pro-image-preview"], + supportedResolutions: ["1K", "2K", "4K"], + supportsImageEditing: true, + generateImage: vi.fn(async () => { + throw new Error("not used"); + }), + }, + { + id: "openai", + defaultModel: "gpt-image-1", + models: ["gpt-image-1"], + supportedSizes: ["1024x1024", "1024x1536", "1536x1024"], + supportsImageEditing: false, + generateImage: vi.fn(async () => { + throw new Error("not used"); + }), + }, + ]); + + const tool = createImageGenerateTool({ + config: { + agents: { + defaults: { + imageGenerationModel: { + primary: "google/gemini-3.1-flash-image-preview", + }, + }, + }, + }, + }); + + expect(tool).not.toBeNull(); + if (!tool) { + throw new Error("expected image_generate tool"); + } + + const result = await tool.execute("call-list", { action: "list" }); + const text = (result.content?.[0] as { text: string } | undefined)?.text ?? ""; + + expect(text).toContain("google (default gemini-3.1-flash-image-preview)"); + expect(text).toContain("gemini-3.1-flash-image-preview"); + expect(text).toContain("gemini-3-pro-image-preview"); + expect(text).toContain("editing"); + expect(result).toMatchObject({ + details: { + providers: expect.arrayContaining([ + expect.objectContaining({ + id: "google", + defaultModel: "gemini-3.1-flash-image-preview", + models: expect.arrayContaining([ + "gemini-3.1-flash-image-preview", + "gemini-3-pro-image-preview", + ]), + }), + ]), + }, + }); + }); +}); diff --git a/src/agents/tools/image-generate-tool.ts b/src/agents/tools/image-generate-tool.ts new file mode 100644 index 00000000000..810bfe3ba6f --- /dev/null +++ b/src/agents/tools/image-generate-tool.ts @@ -0,0 +1,424 @@ +import { Type } from "@sinclair/typebox"; +import type { OpenClawConfig } from "../../config/config.js"; +import { loadConfig } from "../../config/config.js"; +import { + generateImage, + listRuntimeImageGenerationProviders, +} from "../../image-generation/runtime.js"; +import type { + ImageGenerationResolution, + ImageGenerationSourceImage, +} from "../../image-generation/types.js"; +import { getImageMetadata } from "../../media/image-ops.js"; +import { saveMediaBuffer } from "../../media/store.js"; +import { loadWebMedia } from "../../plugin-sdk/web-media.js"; +import { resolveUserPath } from "../../utils.js"; +import { ToolInputError, readNumberParam, readStringParam } from "./common.js"; +import { decodeDataUrl } from "./image-tool.helpers.js"; +import { resolveMediaToolLocalRoots } from "./media-tool-shared.js"; +import { + createSandboxBridgeReadFile, + resolveSandboxedBridgeMediaPath, + type AnyAgentTool, + type SandboxFsBridge, + type ToolFsPolicy, +} from "./tool-runtime.helpers.js"; + +const DEFAULT_COUNT = 1; +const MAX_COUNT = 4; +const MAX_INPUT_IMAGES = 4; +const DEFAULT_RESOLUTION: ImageGenerationResolution = "1K"; + +const ImageGenerateToolSchema = Type.Object({ + action: Type.Optional( + Type.String({ + description: + 'Optional action: "generate" (default) or "list" to inspect available providers/models.', + }), + ), + prompt: Type.Optional(Type.String({ description: "Image generation prompt." })), + image: Type.Optional( + Type.String({ + description: "Optional reference image path or URL for edit mode.", + }), + ), + images: Type.Optional( + Type.Array(Type.String(), { + description: `Optional reference images for edit mode (up to ${MAX_INPUT_IMAGES}).`, + }), + ), + model: Type.Optional( + Type.String({ description: "Optional provider/model override, e.g. openai/gpt-image-1." }), + ), + size: Type.Optional( + Type.String({ + description: + "Optional size hint like 1024x1024, 1536x1024, 1024x1536, 1024x1792, or 1792x1024.", + }), + ), + resolution: Type.Optional( + Type.String({ + description: + "Optional resolution hint: 1K, 2K, or 4K. Useful for Google edit/generation flows.", + }), + ), + count: Type.Optional( + Type.Number({ + description: `Optional number of images to request (1-${MAX_COUNT}).`, + minimum: 1, + maximum: MAX_COUNT, + }), + ), +}); + +function hasConfiguredImageGenerationModel(cfg: OpenClawConfig): boolean { + const configured = cfg.agents?.defaults?.imageGenerationModel; + if (typeof configured === "string") { + return configured.trim().length > 0; + } + if (configured?.primary?.trim()) { + return true; + } + return (configured?.fallbacks ?? []).some((entry) => entry.trim().length > 0); +} + +function resolveAction(args: Record): "generate" | "list" { + const raw = readStringParam(args, "action"); + if (!raw) { + return "generate"; + } + const normalized = raw.trim().toLowerCase(); + if (normalized === "generate" || normalized === "list") { + return normalized; + } + throw new ToolInputError('action must be "generate" or "list"'); +} + +function resolveRequestedCount(args: Record): number { + const count = readNumberParam(args, "count", { integer: true }); + if (count === undefined) { + return DEFAULT_COUNT; + } + if (count < 1 || count > MAX_COUNT) { + throw new ToolInputError(`count must be between 1 and ${MAX_COUNT}`); + } + return count; +} + +function normalizeResolution(raw: string | undefined): ImageGenerationResolution | undefined { + const normalized = raw?.trim().toUpperCase(); + if (!normalized) { + return undefined; + } + if (normalized === "1K" || normalized === "2K" || normalized === "4K") { + return normalized; + } + throw new ToolInputError("resolution must be one of 1K, 2K, or 4K"); +} + +function normalizeReferenceImages(args: Record): string[] { + const imageCandidates: string[] = []; + if (typeof args.image === "string") { + imageCandidates.push(args.image); + } + if (Array.isArray(args.images)) { + imageCandidates.push( + ...args.images.filter((value): value is string => typeof value === "string"), + ); + } + + const seen = new Set(); + const normalized: string[] = []; + for (const candidate of imageCandidates) { + const trimmed = candidate.trim(); + const dedupe = trimmed.startsWith("@") ? trimmed.slice(1).trim() : trimmed; + if (!dedupe || seen.has(dedupe)) { + continue; + } + seen.add(dedupe); + normalized.push(trimmed); + } + if (normalized.length > MAX_INPUT_IMAGES) { + throw new ToolInputError( + `Too many reference images: ${normalized.length} provided, maximum is ${MAX_INPUT_IMAGES}.`, + ); + } + return normalized; +} + +type ImageGenerateSandboxConfig = { + root: string; + bridge: SandboxFsBridge; +}; + +async function loadReferenceImages(params: { + imageInputs: string[]; + maxBytes?: number; + localRoots: string[]; + sandboxConfig: { root: string; bridge: SandboxFsBridge; workspaceOnly: boolean } | null; +}): Promise< + Array<{ + sourceImage: ImageGenerationSourceImage; + resolvedImage: string; + rewrittenFrom?: string; + }> +> { + const loaded: Array<{ + sourceImage: ImageGenerationSourceImage; + resolvedImage: string; + rewrittenFrom?: string; + }> = []; + + for (const imageRawInput of params.imageInputs) { + const trimmed = imageRawInput.trim(); + const imageRaw = trimmed.startsWith("@") ? trimmed.slice(1).trim() : trimmed; + if (!imageRaw) { + throw new ToolInputError("image required (empty string in array)"); + } + const looksLikeWindowsDrivePath = /^[a-zA-Z]:[\\/]/.test(imageRaw); + const hasScheme = /^[a-z][a-z0-9+.-]*:/i.test(imageRaw); + const isFileUrl = /^file:/i.test(imageRaw); + const isHttpUrl = /^https?:\/\//i.test(imageRaw); + const isDataUrl = /^data:/i.test(imageRaw); + if (hasScheme && !looksLikeWindowsDrivePath && !isFileUrl && !isHttpUrl && !isDataUrl) { + throw new ToolInputError( + `Unsupported image reference: ${imageRawInput}. Use a file path, a file:// URL, a data: URL, or an http(s) URL.`, + ); + } + if (params.sandboxConfig && isHttpUrl) { + throw new ToolInputError("Sandboxed image_generate does not allow remote URLs."); + } + + const resolvedImage = (() => { + if (params.sandboxConfig) { + return imageRaw; + } + if (imageRaw.startsWith("~")) { + return resolveUserPath(imageRaw); + } + return imageRaw; + })(); + + const resolvedPathInfo: { resolved: string; rewrittenFrom?: string } = isDataUrl + ? { resolved: "" } + : params.sandboxConfig + ? await resolveSandboxedBridgeMediaPath({ + sandbox: params.sandboxConfig, + mediaPath: resolvedImage, + inboundFallbackDir: "media/inbound", + }) + : { + resolved: resolvedImage.startsWith("file://") + ? resolvedImage.slice("file://".length) + : resolvedImage, + }; + const resolvedPath = isDataUrl ? null : resolvedPathInfo.resolved; + + const media = isDataUrl + ? decodeDataUrl(resolvedImage) + : params.sandboxConfig + ? await loadWebMedia(resolvedPath ?? resolvedImage, { + maxBytes: params.maxBytes, + sandboxValidated: true, + readFile: createSandboxBridgeReadFile({ sandbox: params.sandboxConfig }), + }) + : await loadWebMedia(resolvedPath ?? resolvedImage, { + maxBytes: params.maxBytes, + localRoots: params.localRoots, + }); + if (media.kind !== "image") { + throw new ToolInputError(`Unsupported media type: ${media.kind}`); + } + + const mimeType = + ("contentType" in media && media.contentType) || + ("mimeType" in media && media.mimeType) || + "image/png"; + + loaded.push({ + sourceImage: { + buffer: media.buffer, + mimeType, + }, + resolvedImage, + ...(resolvedPathInfo.rewrittenFrom ? { rewrittenFrom: resolvedPathInfo.rewrittenFrom } : {}), + }); + } + + return loaded; +} + +async function inferResolutionFromInputImages( + images: ImageGenerationSourceImage[], +): Promise { + let maxDimension = 0; + for (const image of images) { + const meta = await getImageMetadata(image.buffer); + const dimension = Math.max(meta?.width ?? 0, meta?.height ?? 0); + maxDimension = Math.max(maxDimension, dimension); + } + if (maxDimension >= 3000) { + return "4K"; + } + if (maxDimension >= 1500) { + return "2K"; + } + return DEFAULT_RESOLUTION; +} + +export function createImageGenerateTool(options?: { + config?: OpenClawConfig; + agentDir?: string; + workspaceDir?: string; + sandbox?: ImageGenerateSandboxConfig; + fsPolicy?: ToolFsPolicy; +}): AnyAgentTool | null { + const cfg = options?.config ?? loadConfig(); + if (!hasConfiguredImageGenerationModel(cfg)) { + return null; + } + const localRoots = resolveMediaToolLocalRoots(options?.workspaceDir, { + workspaceOnly: options?.fsPolicy?.workspaceOnly === true, + }); + const sandboxConfig = + options?.sandbox && options.sandbox.root.trim() + ? { + root: options.sandbox.root.trim(), + bridge: options.sandbox.bridge, + workspaceOnly: options.fsPolicy?.workspaceOnly === true, + } + : null; + + return { + label: "Image Generation", + name: "image_generate", + description: + 'Generate new images or edit reference images with the configured image-generation model. Use action="list" to inspect available providers/models. Generated images are delivered automatically from the tool result as MEDIA paths.', + parameters: ImageGenerateToolSchema, + execute: async (_toolCallId, args) => { + const params = args as Record; + const action = resolveAction(params); + if (action === "list") { + const providers = listRuntimeImageGenerationProviders({ config: cfg }).map((provider) => ({ + id: provider.id, + ...(provider.label ? { label: provider.label } : {}), + ...(provider.defaultModel ? { defaultModel: provider.defaultModel } : {}), + models: provider.models ?? (provider.defaultModel ? [provider.defaultModel] : []), + ...(provider.supportedSizes ? { supportedSizes: [...provider.supportedSizes] } : {}), + ...(provider.supportedResolutions + ? { supportedResolutions: [...provider.supportedResolutions] } + : {}), + ...(typeof provider.supportsImageEditing === "boolean" + ? { supportsImageEditing: provider.supportsImageEditing } + : {}), + })); + const lines = providers.flatMap((provider) => { + const caps: string[] = []; + if (provider.supportsImageEditing) { + caps.push("editing"); + } + if ((provider.supportedResolutions?.length ?? 0) > 0) { + caps.push(`resolutions ${provider.supportedResolutions?.join("/")}`); + } + if ((provider.supportedSizes?.length ?? 0) > 0) { + caps.push(`sizes ${provider.supportedSizes?.join(", ")}`); + } + const modelLine = + provider.models.length > 0 + ? `models: ${provider.models.join(", ")}` + : "models: unknown"; + return [ + `${provider.id}${provider.defaultModel ? ` (default ${provider.defaultModel})` : ""}`, + ` ${modelLine}`, + ...(caps.length > 0 ? [` capabilities: ${caps.join("; ")}`] : []), + ]; + }); + return { + content: [{ type: "text", text: lines.join("\n") }], + details: { providers }, + }; + } + + const prompt = readStringParam(params, "prompt", { required: true }); + const imageInputs = normalizeReferenceImages(params); + const model = readStringParam(params, "model"); + const size = readStringParam(params, "size"); + const explicitResolution = normalizeResolution(readStringParam(params, "resolution")); + const count = resolveRequestedCount(params); + const loadedReferenceImages = await loadReferenceImages({ + imageInputs, + localRoots, + sandboxConfig, + }); + const inputImages = loadedReferenceImages.map((entry) => entry.sourceImage); + const resolution = + explicitResolution ?? + (size + ? undefined + : inputImages.length > 0 + ? await inferResolutionFromInputImages(inputImages) + : undefined); + + const result = await generateImage({ + cfg, + prompt, + agentDir: options?.agentDir, + modelOverride: model, + size, + resolution, + count, + inputImages, + }); + + const savedImages = await Promise.all( + result.images.map((image) => + saveMediaBuffer( + image.buffer, + image.mimeType, + "tool-image-generation", + undefined, + image.fileName, + ), + ), + ); + + const revisedPrompts = result.images + .map((image) => image.revisedPrompt?.trim()) + .filter((entry): entry is string => Boolean(entry)); + const lines = [ + `Generated ${savedImages.length} image${savedImages.length === 1 ? "" : "s"} with ${result.provider}/${result.model}.`, + ...savedImages.map((image) => `MEDIA:${image.path}`), + ]; + + return { + content: [{ type: "text", text: lines.join("\n") }], + details: { + provider: result.provider, + model: result.model, + count: savedImages.length, + paths: savedImages.map((image) => image.path), + ...(imageInputs.length === 1 + ? { + image: loadedReferenceImages[0]?.resolvedImage, + ...(loadedReferenceImages[0]?.rewrittenFrom + ? { rewrittenFrom: loadedReferenceImages[0].rewrittenFrom } + : {}), + } + : imageInputs.length > 1 + ? { + images: loadedReferenceImages.map((entry) => ({ + image: entry.resolvedImage, + ...(entry.rewrittenFrom ? { rewrittenFrom: entry.rewrittenFrom } : {}), + })), + } + : {}), + ...(resolution ? { resolution } : {}), + ...(size ? { size } : {}), + attempts: result.attempts, + metadata: result.metadata, + ...(revisedPrompts.length > 0 ? { revisedPrompts } : {}), + }, + }; + }, + }; +} diff --git a/src/image-generation/providers/google.test.ts b/src/image-generation/providers/google.test.ts index 83f7e565a80..224779f3429 100644 --- a/src/image-generation/providers/google.test.ts +++ b/src/image-generation/providers/google.test.ts @@ -131,4 +131,78 @@ describe("Google image-generation provider", () => { model: "gemini-3.1-flash-image-preview", }); }); + + it("sends reference images and explicit resolution for edit flows", async () => { + vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ + apiKey: "google-test-key", + source: "env", + mode: "api-key", + }); + const fetchMock = vi.fn().mockResolvedValue({ + ok: true, + json: async () => ({ + candidates: [ + { + content: { + parts: [ + { + inlineData: { + mimeType: "image/png", + data: Buffer.from("png-data").toString("base64"), + }, + }, + ], + }, + }, + ], + }), + }); + vi.stubGlobal("fetch", fetchMock); + + const provider = buildGoogleImageGenerationProvider(); + await provider.generateImage({ + provider: "google", + model: "gemini-3-pro-image-preview", + prompt: "Change only the sky to a sunset.", + cfg: {}, + resolution: "4K", + inputImages: [ + { + buffer: Buffer.from("reference-bytes"), + mimeType: "image/png", + fileName: "reference.png", + }, + ], + }); + + expect(fetchMock).toHaveBeenCalledWith( + "https://generativelanguage.googleapis.com/v1beta/models/gemini-3-pro-image-preview:generateContent", + expect.objectContaining({ + method: "POST", + body: JSON.stringify({ + contents: [ + { + role: "user", + parts: [ + { + inlineData: { + mimeType: "image/png", + data: Buffer.from("reference-bytes").toString("base64"), + }, + }, + { text: "Change only the sky to a sunset." }, + ], + }, + ], + generationConfig: { + responseModalities: ["TEXT", "IMAGE"], + imageConfig: { + aspectRatio: "1:1", + imageSize: "4K", + }, + }, + }), + }), + ); + }); }); diff --git a/src/image-generation/providers/google.ts b/src/image-generation/providers/google.ts index 0519aef7bc3..f7469b147fa 100644 --- a/src/image-generation/providers/google.ts +++ b/src/image-generation/providers/google.ts @@ -79,11 +79,16 @@ export function buildGoogleImageGenerationProvider(): ImageGenerationProviderPlu return { id: "google", label: "Google", + defaultModel: DEFAULT_GOOGLE_IMAGE_MODEL, + models: [DEFAULT_GOOGLE_IMAGE_MODEL, "gemini-3-pro-image-preview"], + supportedResolutions: ["1K", "2K", "4K"], + supportsImageEditing: true, async generateImage(req) { const auth = await resolveApiKeyForProvider({ provider: "google", cfg: req.cfg, agentDir: req.agentDir, + store: req.authStore, }); if (!auth.apiKey) { throw new Error("Google API key missing"); @@ -98,6 +103,16 @@ export function buildGoogleImageGenerationProvider(): ImageGenerationProviderPlu const authHeaders = parseGeminiAuth(auth.apiKey); const headers = new Headers(authHeaders.headers); const imageConfig = mapSizeToImageConfig(req.size); + const inputParts = (req.inputImages ?? []).map((image) => ({ + inlineData: { + mimeType: image.mimeType, + data: image.buffer.toString("base64"), + }, + })); + const resolvedImageConfig = { + ...imageConfig, + ...(req.resolution ? { imageSize: req.resolution } : {}), + }; const { response: res, release } = await postJsonRequest({ url: `${baseUrl}/models/${model}:generateContent`, @@ -106,12 +121,14 @@ export function buildGoogleImageGenerationProvider(): ImageGenerationProviderPlu contents: [ { role: "user", - parts: [{ text: req.prompt }], + parts: [...inputParts, { text: req.prompt }], }, ], generationConfig: { responseModalities: ["TEXT", "IMAGE"], - ...(imageConfig ? { imageConfig } : {}), + ...(Object.keys(resolvedImageConfig).length > 0 + ? { imageConfig: resolvedImageConfig } + : {}), }, }, timeoutMs: 60_000, diff --git a/src/image-generation/providers/openai.test.ts b/src/image-generation/providers/openai.test.ts index a55e6107d3b..a128d6c6e04 100644 --- a/src/image-generation/providers/openai.test.ts +++ b/src/image-generation/providers/openai.test.ts @@ -8,7 +8,7 @@ describe("OpenAI image-generation provider", () => { }); it("generates PNG buffers from the OpenAI Images API", async () => { - vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ + const resolveApiKeySpy = vi.spyOn(modelAuth, "resolveApiKeyForProvider").mockResolvedValue({ apiKey: "sk-test", source: "env", mode: "api-key", @@ -27,17 +27,31 @@ describe("OpenAI image-generation provider", () => { vi.stubGlobal("fetch", fetchMock); const provider = buildOpenAIImageGenerationProvider(); + const authStore = { version: 1, profiles: {} }; const result = await provider.generateImage({ provider: "openai", model: "gpt-image-1", prompt: "draw a cat", cfg: {}, + authStore, }); + expect(resolveApiKeySpy).toHaveBeenCalledWith( + expect.objectContaining({ + provider: "openai", + store: authStore, + }), + ); expect(fetchMock).toHaveBeenCalledWith( "https://api.openai.com/v1/images/generations", expect.objectContaining({ method: "POST", + body: JSON.stringify({ + model: "gpt-image-1", + prompt: "draw a cat", + n: 1, + size: "1024x1024", + }), }), ); expect(result).toEqual({ @@ -52,4 +66,18 @@ describe("OpenAI image-generation provider", () => { model: "gpt-image-1", }); }); + + it("rejects reference-image edits for now", async () => { + const provider = buildOpenAIImageGenerationProvider(); + + await expect( + provider.generateImage({ + provider: "openai", + model: "gpt-image-1", + prompt: "Edit this image", + cfg: {}, + inputImages: [{ buffer: Buffer.from("x"), mimeType: "image/png" }], + }), + ).rejects.toThrow("does not support reference-image edits"); + }); }); diff --git a/src/image-generation/providers/openai.ts b/src/image-generation/providers/openai.ts index 0c7788fb5d5..1a0afe1f67d 100644 --- a/src/image-generation/providers/openai.ts +++ b/src/image-generation/providers/openai.ts @@ -22,12 +22,18 @@ export function buildOpenAIImageGenerationProvider(): ImageGenerationProviderPlu return { id: "openai", label: "OpenAI", + defaultModel: DEFAULT_OPENAI_IMAGE_MODEL, + models: [DEFAULT_OPENAI_IMAGE_MODEL], supportedSizes: ["1024x1024", "1024x1536", "1536x1024"], async generateImage(req) { + if ((req.inputImages?.length ?? 0) > 0) { + throw new Error("OpenAI image generation provider does not support reference-image edits"); + } const auth = await resolveApiKeyForProvider({ provider: "openai", cfg: req.cfg, agentDir: req.agentDir, + store: req.authStore, }); if (!auth.apiKey) { throw new Error("OpenAI API key missing"); @@ -44,7 +50,6 @@ export function buildOpenAIImageGenerationProvider(): ImageGenerationProviderPlu prompt: req.prompt, n: req.count ?? 1, size: req.size ?? DEFAULT_SIZE, - response_format: "b64_json", }), }); diff --git a/src/image-generation/runtime.test.ts b/src/image-generation/runtime.test.ts index 4ef478b3349..b044c899c60 100644 --- a/src/image-generation/runtime.test.ts +++ b/src/image-generation/runtime.test.ts @@ -11,13 +11,16 @@ describe("image-generation runtime helpers", () => { it("generates images through the active image-generation registry", async () => { const pluginRegistry = createEmptyPluginRegistry(); + const authStore = { version: 1, profiles: {} } as const; + let seenAuthStore: unknown; pluginRegistry.imageGenerationProviders.push({ pluginId: "image-plugin", pluginName: "Image Plugin", source: "test", provider: { id: "image-plugin", - async generateImage() { + async generateImage(req) { + seenAuthStore = req.authStore; return { images: [ { @@ -47,11 +50,13 @@ describe("image-generation runtime helpers", () => { cfg, prompt: "draw a cat", agentDir: "/tmp/agent", + authStore, }); expect(result.provider).toBe("image-plugin"); expect(result.model).toBe("img-v1"); expect(result.attempts).toEqual([]); + expect(seenAuthStore).toEqual(authStore); expect(result.images).toEqual([ { buffer: Buffer.from("png-bytes"), @@ -69,6 +74,9 @@ describe("image-generation runtime helpers", () => { source: "test", provider: { id: "image-plugin", + defaultModel: "img-v1", + models: ["img-v1", "img-v2"], + supportedResolutions: ["1K", "2K"], generateImage: async () => ({ images: [{ buffer: Buffer.from("x"), mimeType: "image/png" }], }), @@ -76,6 +84,13 @@ describe("image-generation runtime helpers", () => { }); setActivePluginRegistry(pluginRegistry); - expect(listRuntimeImageGenerationProviders()).toMatchObject([{ id: "image-plugin" }]); + expect(listRuntimeImageGenerationProviders()).toMatchObject([ + { + id: "image-plugin", + defaultModel: "img-v1", + models: ["img-v1", "img-v2"], + supportedResolutions: ["1K", "2K"], + }, + ]); }); }); diff --git a/src/image-generation/runtime.ts b/src/image-generation/runtime.ts index 8c9104edd5d..f25048cd0b1 100644 --- a/src/image-generation/runtime.ts +++ b/src/image-generation/runtime.ts @@ -1,3 +1,4 @@ +import type { AuthProfileStore } from "../agents/auth-profiles.js"; import { describeFailoverError, isFailoverError } from "../agents/failover-error.js"; import type { FallbackAttempt } from "../agents/model-fallback.types.js"; import type { OpenClawConfig } from "../config/config.js"; @@ -7,7 +8,12 @@ import { } from "../config/model-input.js"; import { createSubsystemLogger } from "../logging/subsystem.js"; import { getImageGenerationProvider, listImageGenerationProviders } from "./provider-registry.js"; -import type { GeneratedImageAsset, ImageGenerationResult } from "./types.js"; +import type { + GeneratedImageAsset, + ImageGenerationResolution, + ImageGenerationResult, + ImageGenerationSourceImage, +} from "./types.js"; const log = createSubsystemLogger("image-generation"); @@ -15,9 +21,12 @@ export type GenerateImageParams = { cfg: OpenClawConfig; prompt: string; agentDir?: string; + authStore?: AuthProfileStore; modelOverride?: string; count?: number; size?: string; + resolution?: ImageGenerationResolution; + inputImages?: ImageGenerationSourceImage[]; }; export type GenerateImageRuntimeResult = { @@ -130,8 +139,11 @@ export async function generateImage( prompt: params.prompt, cfg: params.cfg, agentDir: params.agentDir, + authStore: params.authStore, count: params.count, size: params.size, + resolution: params.resolution, + inputImages: params.inputImages, }); if (!Array.isArray(result.images) || result.images.length === 0) { throw new Error("Image generation provider returned no images."); diff --git a/src/image-generation/types.ts b/src/image-generation/types.ts index ff33d6079ee..7ea530ac2b9 100644 --- a/src/image-generation/types.ts +++ b/src/image-generation/types.ts @@ -1,3 +1,4 @@ +import type { AuthProfileStore } from "../agents/auth-profiles.js"; import type { OpenClawConfig } from "../config/config.js"; export type GeneratedImageAsset = { @@ -8,14 +9,26 @@ export type GeneratedImageAsset = { metadata?: Record; }; +export type ImageGenerationResolution = "1K" | "2K" | "4K"; + +export type ImageGenerationSourceImage = { + buffer: Buffer; + mimeType: string; + fileName?: string; + metadata?: Record; +}; + export type ImageGenerationRequest = { provider: string; model: string; prompt: string; cfg: OpenClawConfig; agentDir?: string; + authStore?: AuthProfileStore; count?: number; size?: string; + resolution?: ImageGenerationResolution; + inputImages?: ImageGenerationSourceImage[]; }; export type ImageGenerationResult = { @@ -28,6 +41,10 @@ export type ImageGenerationProvider = { id: string; aliases?: string[]; label?: string; + defaultModel?: string; + models?: string[]; supportedSizes?: string[]; + supportedResolutions?: ImageGenerationResolution[]; + supportsImageEditing?: boolean; generateImage: (req: ImageGenerationRequest) => Promise; }; diff --git a/src/plugin-sdk/image-generation.ts b/src/plugin-sdk/image-generation.ts index d9afa8b3a3d..25fde2e9d2b 100644 --- a/src/plugin-sdk/image-generation.ts +++ b/src/plugin-sdk/image-generation.ts @@ -3,8 +3,10 @@ export type { GeneratedImageAsset, ImageGenerationProvider, + ImageGenerationResolution, ImageGenerationRequest, ImageGenerationResult, + ImageGenerationSourceImage, } from "../image-generation/types.js"; export { buildGoogleImageGenerationProvider } from "../image-generation/providers/google.js"; From 0ff82497e9a27db4a7ac20fffa735d84831452a4 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 01:09:36 -0700 Subject: [PATCH 180/187] test(image-generation): add live variant coverage --- .../live-test-helpers.test.ts | 90 +++++++ src/image-generation/live-test-helpers.ts | 96 +++++++ .../providers/google.live.test.ts | 51 ---- src/image-generation/runtime.live.test.ts | 237 ++++++++++++++++++ 4 files changed, 423 insertions(+), 51 deletions(-) create mode 100644 src/image-generation/live-test-helpers.test.ts create mode 100644 src/image-generation/live-test-helpers.ts delete mode 100644 src/image-generation/providers/google.live.test.ts create mode 100644 src/image-generation/runtime.live.test.ts diff --git a/src/image-generation/live-test-helpers.test.ts b/src/image-generation/live-test-helpers.test.ts new file mode 100644 index 00000000000..3a7058569cf --- /dev/null +++ b/src/image-generation/live-test-helpers.test.ts @@ -0,0 +1,90 @@ +import { describe, expect, it } from "vitest"; +import type { OpenClawConfig } from "../config/config.js"; +import { + parseCaseFilter, + parseCsvFilter, + parseProviderModelMap, + redactLiveApiKey, + resolveConfiguredLiveImageModels, + resolveLiveImageAuthStore, +} from "./live-test-helpers.js"; + +describe("image-generation live-test helpers", () => { + it("parses provider filters and treats empty/all as unfiltered", () => { + expect(parseCsvFilter()).toBeNull(); + expect(parseCsvFilter("all")).toBeNull(); + expect(parseCsvFilter(" openai , google ")).toEqual(new Set(["openai", "google"])); + }); + + it("parses live case filters and treats empty/all as unfiltered", () => { + expect(parseCaseFilter()).toBeNull(); + expect(parseCaseFilter("all")).toBeNull(); + expect(parseCaseFilter(" google:flash , openai:default ")).toEqual( + new Set(["google:flash", "openai:default"]), + ); + }); + + it("parses provider model overrides by provider id", () => { + expect( + parseProviderModelMap("openai/gpt-image-1, google/gemini-3.1-flash-image-preview, invalid"), + ).toEqual( + new Map([ + ["openai", "openai/gpt-image-1"], + ["google", "google/gemini-3.1-flash-image-preview"], + ]), + ); + }); + + it("collects configured models from primary and fallbacks", () => { + const cfg = { + agents: { + defaults: { + imageGenerationModel: { + primary: "openai/gpt-image-1", + fallbacks: ["google/gemini-3.1-flash-image-preview", "invalid"], + }, + }, + }, + } as OpenClawConfig; + + expect(resolveConfiguredLiveImageModels(cfg)).toEqual( + new Map([ + ["openai", "openai/gpt-image-1"], + ["google", "google/gemini-3.1-flash-image-preview"], + ]), + ); + }); + + it("uses an empty auth store when live env keys should override stale profiles", () => { + expect( + resolveLiveImageAuthStore({ + requireProfileKeys: false, + hasLiveKeys: true, + }), + ).toEqual({ + version: 1, + profiles: {}, + }); + }); + + it("keeps profile-store mode when requested or when no live keys exist", () => { + expect( + resolveLiveImageAuthStore({ + requireProfileKeys: true, + hasLiveKeys: true, + }), + ).toBeUndefined(); + expect( + resolveLiveImageAuthStore({ + requireProfileKeys: false, + hasLiveKeys: false, + }), + ).toBeUndefined(); + }); + + it("redacts live API keys for diagnostics", () => { + expect(redactLiveApiKey(undefined)).toBe("none"); + expect(redactLiveApiKey("short-key")).toBe("short-key"); + expect(redactLiveApiKey("sk-proj-1234567890")).toBe("sk-proj-...7890"); + }); +}); diff --git a/src/image-generation/live-test-helpers.ts b/src/image-generation/live-test-helpers.ts new file mode 100644 index 00000000000..0063bab89fa --- /dev/null +++ b/src/image-generation/live-test-helpers.ts @@ -0,0 +1,96 @@ +import type { AuthProfileStore } from "../agents/auth-profiles.js"; +import type { OpenClawConfig } from "../config/config.js"; + +export const DEFAULT_LIVE_IMAGE_MODELS: Record = { + google: "google/gemini-3.1-flash-image-preview", + openai: "openai/gpt-image-1", +}; + +export function parseCaseFilter(raw?: string): Set | null { + const trimmed = raw?.trim(); + if (!trimmed || trimmed === "all") { + return null; + } + const values = trimmed + .split(",") + .map((entry) => entry.trim().toLowerCase()) + .filter(Boolean); + return values.length > 0 ? new Set(values) : null; +} + +export function redactLiveApiKey(value: string | undefined): string { + const trimmed = value?.trim(); + if (!trimmed) { + return "none"; + } + if (trimmed.length <= 12) { + return trimmed; + } + return `${trimmed.slice(0, 8)}...${trimmed.slice(-4)}`; +} + +export function parseCsvFilter(raw?: string): Set | null { + const trimmed = raw?.trim(); + if (!trimmed || trimmed === "all") { + return null; + } + const values = trimmed + .split(",") + .map((entry) => entry.trim()) + .filter(Boolean); + return values.length > 0 ? new Set(values) : null; +} + +export function parseProviderModelMap(raw?: string): Map { + const entries = new Map(); + for (const token of raw?.split(",") ?? []) { + const trimmed = token.trim(); + if (!trimmed) { + continue; + } + const slash = trimmed.indexOf("/"); + if (slash <= 0 || slash === trimmed.length - 1) { + continue; + } + entries.set(trimmed.slice(0, slash).trim().toLowerCase(), trimmed); + } + return entries; +} + +export function resolveConfiguredLiveImageModels(cfg: OpenClawConfig): Map { + const resolved = new Map(); + const configured = cfg.agents?.defaults?.imageGenerationModel; + const add = (value: string | undefined) => { + const trimmed = value?.trim(); + if (!trimmed) { + return; + } + const slash = trimmed.indexOf("/"); + if (slash <= 0 || slash === trimmed.length - 1) { + return; + } + resolved.set(trimmed.slice(0, slash).trim().toLowerCase(), trimmed); + }; + if (typeof configured === "string") { + add(configured); + return resolved; + } + add(configured?.primary); + for (const fallback of configured?.fallbacks ?? []) { + add(fallback); + } + return resolved; +} + +export function resolveLiveImageAuthStore(params: { + requireProfileKeys: boolean; + hasLiveKeys: boolean; +}): AuthProfileStore | undefined { + if (params.requireProfileKeys || !params.hasLiveKeys) { + return undefined; + } + return { + version: 1, + profiles: {}, + }; +} diff --git a/src/image-generation/providers/google.live.test.ts b/src/image-generation/providers/google.live.test.ts deleted file mode 100644 index dcf2ddd1108..00000000000 --- a/src/image-generation/providers/google.live.test.ts +++ /dev/null @@ -1,51 +0,0 @@ -import { describe, expect, it } from "vitest"; -import type { OpenClawConfig } from "../../config/config.js"; -import { isTruthyEnvValue } from "../../infra/env.js"; -import { buildGoogleImageGenerationProvider } from "./google.js"; - -const LIVE = - isTruthyEnvValue(process.env.GOOGLE_LIVE_TEST) || - isTruthyEnvValue(process.env.LIVE) || - isTruthyEnvValue(process.env.OPENCLAW_LIVE_TEST); -const HAS_KEY = Boolean(process.env.GEMINI_API_KEY?.trim() || process.env.GOOGLE_API_KEY?.trim()); -const MODEL = - process.env.GOOGLE_IMAGE_GENERATION_MODEL?.trim() || - process.env.GEMINI_IMAGE_GENERATION_MODEL?.trim() || - "gemini-3.1-flash-image-preview"; -const BASE_URL = process.env.GOOGLE_IMAGE_BASE_URL?.trim(); - -const describeLive = LIVE && HAS_KEY ? describe : describe.skip; - -function buildLiveConfig(): OpenClawConfig { - if (!BASE_URL) { - return {}; - } - return { - models: { - providers: { - google: { - baseUrl: BASE_URL, - }, - }, - }, - } as unknown as OpenClawConfig; -} - -describeLive("google image-generation live", () => { - it("generates a real image", async () => { - const provider = buildGoogleImageGenerationProvider(); - const result = await provider.generateImage({ - provider: "google", - model: MODEL, - prompt: - "Create a minimal flat illustration of an orange cat face sticker on a white background.", - cfg: buildLiveConfig(), - size: "1024x1024", - }); - - expect(result.model).toBeTruthy(); - expect(result.images.length).toBeGreaterThan(0); - expect(result.images[0]?.mimeType.startsWith("image/")).toBe(true); - expect(result.images[0]?.buffer.byteLength).toBeGreaterThan(512); - }, 120_000); -}); diff --git a/src/image-generation/runtime.live.test.ts b/src/image-generation/runtime.live.test.ts new file mode 100644 index 00000000000..f0132414a6c --- /dev/null +++ b/src/image-generation/runtime.live.test.ts @@ -0,0 +1,237 @@ +import { describe, expect, it } from "vitest"; +import { resolveOpenClawAgentDir } from "../agents/agent-paths.js"; +import { collectProviderApiKeys } from "../agents/live-auth-keys.js"; +import { resolveApiKeyForProvider } from "../agents/model-auth.js"; +import type { OpenClawConfig } from "../config/config.js"; +import { loadConfig } from "../config/config.js"; +import { isTruthyEnvValue } from "../infra/env.js"; +import { getShellEnvAppliedKeys, loadShellEnvFallback } from "../infra/shell-env.js"; +import { encodePngRgba, fillPixel } from "../media/png-encode.js"; +import { + imageGenerationProviderContractRegistry, + providerContractRegistry, +} from "../plugins/contracts/registry.js"; +import { + DEFAULT_LIVE_IMAGE_MODELS, + parseCaseFilter, + parseCsvFilter, + parseProviderModelMap, + redactLiveApiKey, + resolveConfiguredLiveImageModels, + resolveLiveImageAuthStore, +} from "./live-test-helpers.js"; +import { generateImage } from "./runtime.js"; + +const LIVE = isTruthyEnvValue(process.env.LIVE) || isTruthyEnvValue(process.env.OPENCLAW_LIVE_TEST); +const REQUIRE_PROFILE_KEYS = isTruthyEnvValue(process.env.OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS); +const describeLive = LIVE ? describe : describe.skip; + +type LiveImageCase = { + id: string; + providerId: string; + modelRef: string; + prompt: string; + size?: string; + resolution?: "1K" | "2K" | "4K"; + inputImages?: Array<{ buffer: Buffer; mimeType: string; fileName?: string }>; +}; + +function createEditReferencePng(): Buffer { + const width = 192; + const height = 192; + const buf = Buffer.alloc(width * height * 4, 255); + + for (let y = 0; y < height; y += 1) { + for (let x = 0; x < width; x += 1) { + fillPixel(buf, x, y, width, 245, 248, 255, 255); + } + } + + for (let y = 24; y < 168; y += 1) { + for (let x = 24; x < 168; x += 1) { + fillPixel(buf, x, y, width, 255, 189, 89, 255); + } + } + + for (let y = 48; y < 144; y += 1) { + for (let x = 48; x < 144; x += 1) { + fillPixel(buf, x, y, width, 41, 47, 54, 255); + } + } + + return encodePngRgba(buf, width, height); +} + +function withPluginsEnabled(cfg: OpenClawConfig): OpenClawConfig { + return { + ...cfg, + plugins: { + ...cfg.plugins, + enabled: true, + }, + }; +} + +function resolveProviderEnvVars(providerId: string): string[] { + const entry = providerContractRegistry.find((candidate) => candidate.provider.id === providerId); + return entry?.provider.envVars ?? []; +} + +function maybeLoadShellEnvForImageProviders(providerIds: string[]): void { + const expectedKeys = [ + ...new Set(providerIds.flatMap((providerId) => resolveProviderEnvVars(providerId))), + ]; + if (expectedKeys.length === 0) { + return; + } + loadShellEnvFallback({ + enabled: true, + env: process.env, + expectedKeys, + logger: { warn: (message: string) => console.warn(message) }, + }); +} + +async function resolveLiveAuthForProvider( + provider: string, + cfg: ReturnType, + agentDir: string, +) { + const authStore = resolveLiveImageAuthStore({ + requireProfileKeys: REQUIRE_PROFILE_KEYS, + hasLiveKeys: collectProviderApiKeys(provider).length > 0, + }); + try { + const auth = await resolveApiKeyForProvider({ provider, cfg, agentDir, store: authStore }); + return { auth, authStore }; + } catch { + return null; + } +} + +describeLive("image generation live (provider sweep)", () => { + it("generates images for every configured image-generation variant with available auth", async () => { + const cfg = withPluginsEnabled(loadConfig()); + const agentDir = resolveOpenClawAgentDir(); + const providerFilter = parseCsvFilter(process.env.OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS); + const caseFilter = parseCaseFilter(process.env.OPENCLAW_LIVE_IMAGE_GENERATION_CASES); + const envModelMap = parseProviderModelMap(process.env.OPENCLAW_LIVE_IMAGE_GENERATION_MODELS); + const configuredModels = resolveConfiguredLiveImageModels(cfg); + const availableProviders = imageGenerationProviderContractRegistry + .map((entry) => entry.provider.id) + .toSorted((left, right) => left.localeCompare(right)) + .filter((providerId) => (providerFilter ? providerFilter.has(providerId) : true)); + const liveCases: LiveImageCase[] = []; + + if (availableProviders.includes("google")) { + liveCases.push( + { + id: "google:flash-generate", + providerId: "google", + modelRef: + envModelMap.get("google") ?? + configuredModels.get("google") ?? + DEFAULT_LIVE_IMAGE_MODELS.google, + prompt: + "Create a minimal flat illustration of an orange cat face sticker on a white background.", + size: "1024x1024", + }, + { + id: "google:pro-generate", + providerId: "google", + modelRef: "google/gemini-3-pro-image-preview", + prompt: + "Create a minimal flat illustration of an orange cat face sticker on a white background.", + size: "1024x1024", + }, + { + id: "google:pro-edit", + providerId: "google", + modelRef: "google/gemini-3-pro-image-preview", + prompt: + "Change ONLY the background to a pale blue gradient. Keep the subject, framing, and style identical.", + resolution: "2K", + inputImages: [ + { + buffer: createEditReferencePng(), + mimeType: "image/png", + fileName: "reference.png", + }, + ], + }, + ); + } + if (availableProviders.includes("openai")) { + liveCases.push({ + id: "openai:default-generate", + providerId: "openai", + modelRef: + envModelMap.get("openai") ?? + configuredModels.get("openai") ?? + DEFAULT_LIVE_IMAGE_MODELS.openai, + prompt: + "Create a minimal flat illustration of an orange cat face sticker on a white background.", + size: "1024x1024", + }); + } + + const selectedCases = liveCases.filter((entry) => + caseFilter ? caseFilter.has(entry.id.toLowerCase()) : true, + ); + + maybeLoadShellEnvForImageProviders(availableProviders); + + const attempted: string[] = []; + const skipped: string[] = []; + const failures: string[] = []; + + for (const testCase of selectedCases) { + if (!testCase.modelRef) { + skipped.push(`${testCase.id}: no model configured`); + continue; + } + const resolvedAuth = await resolveLiveAuthForProvider(testCase.providerId, cfg, agentDir); + if (!resolvedAuth) { + skipped.push(`${testCase.id}: no auth`); + continue; + } + + try { + const result = await generateImage({ + cfg, + agentDir, + authStore: resolvedAuth.authStore, + modelOverride: testCase.modelRef, + prompt: testCase.prompt, + size: testCase.size, + resolution: testCase.resolution, + inputImages: testCase.inputImages, + }); + + attempted.push( + `${testCase.id}:${result.model} (${resolvedAuth.auth.source} ${redactLiveApiKey(resolvedAuth.auth.apiKey)})`, + ); + expect(result.provider).toBe(testCase.providerId); + expect(result.images.length).toBeGreaterThan(0); + expect(result.images[0]?.mimeType.startsWith("image/")).toBe(true); + expect(result.images[0]?.buffer.byteLength).toBeGreaterThan(512); + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + failures.push( + `${testCase.id} (${resolvedAuth.auth.source} ${redactLiveApiKey(resolvedAuth.auth.apiKey)}): ${message}`, + ); + } + } + + console.log( + `[live:image-generation] attempted=${attempted.join(", ") || "none"} skipped=${skipped.join(", ") || "none"} failures=${failures.join(" | ") || "none"} shellEnv=${getShellEnvAppliedKeys().join(", ") || "none"}`, + ); + + if (attempted.length === 0) { + console.warn("[live:image-generation] no provider had usable auth; skipping assertions"); + return; + } + expect(failures).toEqual([]); + expect(attempted.length).toBeGreaterThan(0); + }, 180_000); +}); From 990d0d7261c962fc28d94a63e6639b891b2c85ac Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 01:09:42 -0700 Subject: [PATCH 181/187] docs(image-generation): remove nano banana stock docs --- CHANGELOG.md | 1 + docs/gateway/configuration-examples.md | 2 +- docs/gateway/configuration-reference.md | 2 +- docs/gateway/configuration.md | 4 +-- docs/help/testing.md | 29 ++++++++++++++----- docs/tools/index.md | 24 +++++++++++++++ docs/tools/skills-config.md | 6 +++- docs/tools/skills.md | 14 +++++---- ...erged-skills-into-target-workspace.test.ts | 14 ++++----- 9 files changed, 72 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9343a5d34a4..2b33d3f4947 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,6 +40,7 @@ Docs: https://docs.openclaw.ai - Browser/Chrome MCP: remove the legacy Chrome extension relay path, bundled extension assets, `driver: "extension"`, and `browser.relayBindHost`. Run `openclaw doctor --fix` to migrate host-local browser config to `existing-session` / `user`; Docker, headless, sandbox, and remote browser flows still use raw CDP. (#47893) Thanks @vincentkoc. - Plugins/runtime: remove the public `openclaw/extension-api` surface with no compatibility shim. Bundled plugins must use injected runtime for host-side operations (for example `api.runtime.agent.runEmbeddedPiAgent`) and any remaining direct imports must come from narrow `openclaw/plugin-sdk/*` subpaths instead of the monolithic SDK root. +- Tools/image generation: standardize the stock image create/edit path on the core `image_generate` tool. The old `nano-banana-pro` docs/examples are gone; if you previously copied that sample-skill config, switch to `agents.defaults.imageGenerationModel` for built-in image generation or install a separate third-party skill explicitly. ### Fixes diff --git a/docs/gateway/configuration-examples.md b/docs/gateway/configuration-examples.md index 9767f2db674..5627f93395d 100644 --- a/docs/gateway/configuration-examples.md +++ b/docs/gateway/configuration-examples.md @@ -434,7 +434,7 @@ Save to `~/.openclaw/openclaw.json` and you can DM the bot from that number. nodeManager: "npm", }, entries: { - "nano-banana-pro": { + "image-lab": { enabled: true, apiKey: "GEMINI_KEY_HERE", env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" }, diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index 9085c9c35f5..0913040949b 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -2371,7 +2371,7 @@ See [Local Models](/gateway/local-models). TL;DR: run MiniMax M2.5 via LM Studio nodeManager: "npm", // npm | pnpm | yarn }, entries: { - "nano-banana-pro": { + "image-lab": { apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" }, }, diff --git a/docs/gateway/configuration.md b/docs/gateway/configuration.md index 3ead49f6817..d15efb3384b 100644 --- a/docs/gateway/configuration.md +++ b/docs/gateway/configuration.md @@ -597,11 +597,11 @@ Rules: }, skills: { entries: { - "nano-banana-pro": { + "image-lab": { apiKey: { source: "file", provider: "filemain", - id: "/skills/entries/nano-banana-pro/apiKey", + id: "/skills/entries/image-lab/apiKey", }, }, }, diff --git a/docs/help/testing.md b/docs/help/testing.md index f3315fa6faa..2055db4373f 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -360,14 +360,29 @@ If you want to rely on env keys (e.g. exported in your `~/.profile`), run local - Enable: `BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - Optional model override: `BYTEPLUS_CODING_MODEL=ark-code-latest` -## Google image generation live +## Image generation live -- Test: `src/image-generation/providers/google.live.test.ts` -- Enable: `GOOGLE_LIVE_TEST=1 pnpm test:live src/image-generation/providers/google.live.test.ts` -- Key source: `GEMINI_API_KEY` or `GOOGLE_API_KEY` -- Optional overrides: - - `GOOGLE_IMAGE_GENERATION_MODEL=gemini-3.1-flash-image-preview` - - `GOOGLE_IMAGE_BASE_URL=https://generativelanguage.googleapis.com/v1beta` +- Test: `src/image-generation/runtime.live.test.ts` +- Command: `pnpm test:live src/image-generation/runtime.live.test.ts` +- Scope: + - Enumerates every registered image-generation provider plugin + - Loads missing provider env vars from your login shell (`~/.profile`) before probing + - Uses live/env API keys ahead of stored auth profiles by default, so stale test keys in `auth-profiles.json` do not mask real shell credentials + - Skips providers with no usable auth/profile/model + - Runs the stock image-generation variants through the shared runtime capability: + - `google:flash-generate` + - `google:pro-generate` + - `google:pro-edit` + - `openai:default-generate` +- Current bundled providers covered: + - `openai` + - `google` +- Optional narrowing: + - `OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS="openai,google"` + - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-1,google/gemini-3.1-flash-image-preview"` + - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit"` +- Optional auth behavior: + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` to force profile-store auth and ignore env-only overrides ## Docker runners (optional “works in Linux” checks) diff --git a/docs/tools/index.md b/docs/tools/index.md index deb42b0d76a..1dfe2b87703 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -400,6 +400,30 @@ Notes: - Only available when `agents.defaults.imageModel` is configured (primary or fallbacks), or when an implicit image model can be inferred from your default model + configured auth (best-effort pairing). - Uses the image model directly (independent of the main chat model). +### `image_generate` + +Generate one or more images with the configured image-generation model. + +Core parameters: + +- `action` (optional: `generate` or `list`; default `generate`) +- `prompt` (required) +- `image` or `images` (optional reference image path/URL for edit mode) +- `model` (optional provider/model override) +- `size` (optional size hint) +- `resolution` (optional `1K|2K|4K` hint) +- `count` (optional, `1-4`, default `1`) + +Notes: + +- Only available when `agents.defaults.imageGenerationModel` is configured. +- Use `action: "list"` to inspect registered providers, default models, supported model ids, sizes, resolutions, and edit support. +- Returns local `MEDIA:` lines so channels can deliver the generated files directly. +- Uses the image-generation model directly (independent of the main chat model). +- Google-backed flows support reference-image edits plus explicit `1K|2K|4K` resolution hints. +- When editing and `resolution` is omitted, OpenClaw infers a draft/final resolution from the input image size. +- This is the built-in replacement for the old sample `nano-banana-pro` skill workflow. Use `agents.defaults.imageGenerationModel`, not `skills.entries`, for stock image generation. + ### `pdf` Analyze one or more PDF documents. diff --git a/docs/tools/skills-config.md b/docs/tools/skills-config.md index 589d464bb13..697cb46dad6 100644 --- a/docs/tools/skills-config.md +++ b/docs/tools/skills-config.md @@ -24,7 +24,7 @@ All skills-related configuration lives under `skills` in `~/.openclaw/openclaw.j nodeManager: "npm", // npm | pnpm | yarn | bun (Gateway runtime still Node; bun not recommended) }, entries: { - "nano-banana-pro": { + "image-lab": { enabled: true, apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string env: { @@ -38,6 +38,10 @@ All skills-related configuration lives under `skills` in `~/.openclaw/openclaw.j } ``` +For built-in image generation/editing, prefer `agents.defaults.imageGenerationModel` +plus the core `image_generate` tool. `skills.entries.*` is only for custom or +third-party skill workflows. + ## Fields - `allowBundled`: optional allowlist for **bundled** skills only. When set, only diff --git a/docs/tools/skills.md b/docs/tools/skills.md index 05369677b89..5b91d79af59 100644 --- a/docs/tools/skills.md +++ b/docs/tools/skills.md @@ -81,8 +81,8 @@ that up as `/skills` on the next session. ```markdown --- -name: nano-banana-pro -description: Generate or edit images via Gemini 3 Pro Image +name: image-lab +description: Generate or edit images via a provider-backed image workflow --- ``` @@ -109,8 +109,8 @@ OpenClaw **filters skills at load time** using `metadata` (single-line JSON): ```markdown --- -name: nano-banana-pro -description: Generate or edit images via Gemini 3 Pro Image +name: image-lab +description: Generate or edit images via a provider-backed image workflow metadata: { "openclaw": @@ -194,7 +194,7 @@ Bundled/managed skills can be toggled and supplied with env values: { skills: { entries: { - "nano-banana-pro": { + "image-lab": { enabled: true, apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string env: { @@ -214,6 +214,10 @@ Bundled/managed skills can be toggled and supplied with env values: Note: if the skill name contains hyphens, quote the key (JSON5 allows quoted keys). +If you want stock image generation/editing inside OpenClaw itself, use the core +`image_generate` tool with `agents.defaults.imageGenerationModel` instead of a +bundled skill. Skill examples here are for custom or third-party workflows. + Config keys match the **skill name** by default. If a skill defines `metadata.openclaw.skillKey`, use that key under `skills.entries`. diff --git a/src/agents/skills.build-workspace-skills-prompt.syncs-merged-skills-into-target-workspace.test.ts b/src/agents/skills.build-workspace-skills-prompt.syncs-merged-skills-into-target-workspace.test.ts index 1f4da5163e1..b09571f540f 100644 --- a/src/agents/skills.build-workspace-skills-prompt.syncs-merged-skills-into-target-workspace.test.ts +++ b/src/agents/skills.build-workspace-skills-prompt.syncs-merged-skills-into-target-workspace.test.ts @@ -200,30 +200,30 @@ describe("buildWorkspaceSkillsPrompt", () => { }); it("filters skills based on env/config gates", async () => { const workspaceDir = await createCaseDir("workspace"); - const skillDir = path.join(workspaceDir, "skills", "nano-banana-pro"); + const skillDir = path.join(workspaceDir, "skills", "image-lab"); await writeSkill({ dir: skillDir, - name: "nano-banana-pro", + name: "image-lab", description: "Generates images", metadata: '{"openclaw":{"requires":{"env":["GEMINI_API_KEY"]},"primaryEnv":"GEMINI_API_KEY"}}', - body: "# Nano Banana\n", + body: "# Image Lab\n", }); withEnv({ GEMINI_API_KEY: undefined }, () => { const missingPrompt = buildPrompt(workspaceDir, { managedSkillsDir: path.join(workspaceDir, ".managed"), - config: { skills: { entries: { "nano-banana-pro": { apiKey: "" } } } }, + config: { skills: { entries: { "image-lab": { apiKey: "" } } } }, }); - expect(missingPrompt).not.toContain("nano-banana-pro"); + expect(missingPrompt).not.toContain("image-lab"); const enabledPrompt = buildPrompt(workspaceDir, { managedSkillsDir: path.join(workspaceDir, ".managed"), config: { - skills: { entries: { "nano-banana-pro": { apiKey: "test-key" } } }, // pragma: allowlist secret + skills: { entries: { "image-lab": { apiKey: "test-key" } } }, // pragma: allowlist secret }, }); - expect(enabledPrompt).toContain("nano-banana-pro"); + expect(enabledPrompt).toContain("image-lab"); }); }); it("applies skill filters, including empty lists", async () => { From 6bf07b5075f2565d670f437617c2a7a71058530e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 17 Mar 2026 08:13:53 +0000 Subject: [PATCH 182/187] fix(ci): restore local check suite --- extensions/discord/src/subagent-hooks.test.ts | 2 +- extensions/feishu/src/subagent-hooks.test.ts | 2 +- .../googlechat/src/setup-surface.test.ts | 5 ++- extensions/irc/src/setup-surface.test.ts | 5 ++- extensions/line/src/setup-surface.test.ts | 5 ++- extensions/nostr/src/setup-surface.test.ts | 5 ++- .../synology-chat/src/setup-surface.test.ts | 5 ++- extensions/tlon/src/setup-surface.test.ts | 5 ++- extensions/zalo/src/setup-surface.test.ts | 5 ++- ...compaction-retry-aggregate-timeout.test.ts | 39 +++++++++++-------- .../run/history-image-prune.test.ts | 2 +- src/agents/pi-embedded-runner/runs.test.ts | 9 +++-- .../pi-embedded-runner/system-prompt.test.ts | 4 +- 13 files changed, 61 insertions(+), 32 deletions(-) diff --git a/extensions/discord/src/subagent-hooks.test.ts b/extensions/discord/src/subagent-hooks.test.ts index 6d22ea1ff54..a05db63043a 100644 --- a/extensions/discord/src/subagent-hooks.test.ts +++ b/extensions/discord/src/subagent-hooks.test.ts @@ -3,7 +3,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { getRequiredHookHandler, registerHookHandlersForTest, -} from "../../test-utils/subagent-hooks.js"; +} from "../../../test/helpers/extensions/subagent-hooks.js"; import { registerDiscordSubagentHooks } from "./subagent-hooks.js"; type ThreadBindingRecord = { diff --git a/extensions/feishu/src/subagent-hooks.test.ts b/extensions/feishu/src/subagent-hooks.test.ts index df2c276ad95..87450b10265 100644 --- a/extensions/feishu/src/subagent-hooks.test.ts +++ b/extensions/feishu/src/subagent-hooks.test.ts @@ -3,7 +3,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { getRequiredHookHandler, registerHookHandlersForTest, -} from "../../test-utils/subagent-hooks.js"; +} from "../../../test/helpers/extensions/subagent-hooks.js"; import { registerFeishuSubagentHooks } from "./subagent-hooks.js"; import { __testing as threadBindingTesting, diff --git a/extensions/googlechat/src/setup-surface.test.ts b/extensions/googlechat/src/setup-surface.test.ts index 65c124c8180..15d77a46605 100644 --- a/extensions/googlechat/src/setup-surface.test.ts +++ b/extensions/googlechat/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/googlechat"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { googlechatPlugin } from "./channel.js"; const googlechatConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/irc/src/setup-surface.test.ts b/extensions/irc/src/setup-surface.test.ts index d87ba916622..5741a90ad96 100644 --- a/extensions/irc/src/setup-surface.test.ts +++ b/extensions/irc/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import type { RuntimeEnv } from "openclaw/plugin-sdk/irc"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { ircPlugin } from "./channel.js"; import type { CoreConfig } from "./types.js"; diff --git a/extensions/line/src/setup-surface.test.ts b/extensions/line/src/setup-surface.test.ts index 1606cb3ff22..3c2e6bc05e4 100644 --- a/extensions/line/src/setup-surface.test.ts +++ b/extensions/line/src/setup-surface.test.ts @@ -7,7 +7,10 @@ import { resolveLineAccount, } from "../../../src/line/accounts.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { lineSetupAdapter, lineSetupWizard } from "./setup-surface.js"; const lineConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/nostr/src/setup-surface.test.ts b/extensions/nostr/src/setup-surface.test.ts index a883fda1234..98e479842c5 100644 --- a/extensions/nostr/src/setup-surface.test.ts +++ b/extensions/nostr/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import type { OpenClawConfig } from "openclaw/plugin-sdk/nostr"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { nostrPlugin } from "./channel.js"; const nostrConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/synology-chat/src/setup-surface.test.ts b/extensions/synology-chat/src/setup-surface.test.ts index f6fbf48606f..5b30c747813 100644 --- a/extensions/synology-chat/src/setup-surface.test.ts +++ b/extensions/synology-chat/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import type { OpenClawConfig } from "../../../src/config/config.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { synologyChatPlugin } from "./channel.js"; import { synologyChatSetupWizard } from "./setup-surface.js"; diff --git a/extensions/tlon/src/setup-surface.test.ts b/extensions/tlon/src/setup-surface.test.ts index d10e35785db..e88fd15a89e 100644 --- a/extensions/tlon/src/setup-surface.test.ts +++ b/extensions/tlon/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/tlon"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { tlonPlugin } from "./channel.js"; const tlonConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/extensions/zalo/src/setup-surface.test.ts b/extensions/zalo/src/setup-surface.test.ts index 858720c74a8..8470a3bce66 100644 --- a/extensions/zalo/src/setup-surface.test.ts +++ b/extensions/zalo/src/setup-surface.test.ts @@ -2,7 +2,10 @@ import type { OpenClawConfig, RuntimeEnv } from "openclaw/plugin-sdk/zalo"; import { describe, expect, it, vi } from "vitest"; import { buildChannelSetupWizardAdapterFromSetupWizard } from "../../../src/channels/plugins/setup-wizard.js"; import { createRuntimeEnv } from "../../../test/helpers/extensions/runtime-env.js"; -import { createTestWizardPrompter, type WizardPrompter } from "../../../test/helpers/extensions/setup-wizard.js"; +import { + createTestWizardPrompter, + type WizardPrompter, +} from "../../../test/helpers/extensions/setup-wizard.js"; import { zaloPlugin } from "./channel.js"; const zaloConfigureAdapter = buildChannelSetupWizardAdapterFromSetupWizard({ diff --git a/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts b/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts index 2f2d7d0260c..7b7ce460826 100644 --- a/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts +++ b/src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts @@ -25,14 +25,18 @@ function expectClearedTimeoutState(onTimeout: ReturnType, timedOut function buildAggregateTimeoutParams( overrides: Partial & Pick, -): AggregateTimeoutParams & { onTimeout: ReturnType } { - const onTimeout = overrides.onTimeout ?? vi.fn(); +): { params: AggregateTimeoutParams; onTimeoutSpy: ReturnType } { + const onTimeoutSpy = vi.fn(); + const onTimeout = overrides.onTimeout ?? (() => onTimeoutSpy()); return { - waitForCompactionRetry: overrides.waitForCompactionRetry, - abortable: overrides.abortable ?? (async (promise) => await promise), - aggregateTimeoutMs: overrides.aggregateTimeoutMs ?? 60_000, - isCompactionStillInFlight: overrides.isCompactionStillInFlight, - onTimeout, + params: { + waitForCompactionRetry: overrides.waitForCompactionRetry, + abortable: overrides.abortable ?? (async (promise) => await promise), + aggregateTimeoutMs: overrides.aggregateTimeoutMs ?? 60_000, + isCompactionStillInFlight: overrides.isCompactionStillInFlight, + onTimeout, + }, + onTimeoutSpy, }; } @@ -40,7 +44,7 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { it("times out and fires callback when compaction retry never resolves", async () => { await withFakeTimers(async () => { const waitForCompactionRetry = vi.fn(async () => await new Promise(() => {})); - const params = buildAggregateTimeoutParams({ waitForCompactionRetry }); + const { params, onTimeoutSpy } = buildAggregateTimeoutParams({ waitForCompactionRetry }); const resultPromise = waitForCompactionRetryWithAggregateTimeout(params); @@ -48,7 +52,7 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { const result = await resultPromise; expect(result.timedOut).toBe(true); - expectClearedTimeoutState(params.onTimeout, true); + expectClearedTimeoutState(onTimeoutSpy, true); }); }); @@ -68,14 +72,15 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { waitForCompactionRetry, isCompactionStillInFlight: () => compactionInFlight, }); + const { params: aggregateTimeoutParams, onTimeoutSpy } = params; - const resultPromise = waitForCompactionRetryWithAggregateTimeout(params); + const resultPromise = waitForCompactionRetryWithAggregateTimeout(aggregateTimeoutParams); await vi.advanceTimersByTimeAsync(170_000); const result = await resultPromise; expect(result.timedOut).toBe(false); - expectClearedTimeoutState(params.onTimeout, false); + expectClearedTimeoutState(onTimeoutSpy, false); }); }); @@ -86,7 +91,7 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { setTimeout(() => { compactionInFlight = false; }, 90_000); - const params = buildAggregateTimeoutParams({ + const { params, onTimeoutSpy } = buildAggregateTimeoutParams({ waitForCompactionRetry, isCompactionStillInFlight: () => compactionInFlight, }); @@ -97,19 +102,19 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { const result = await resultPromise; expect(result.timedOut).toBe(true); - expectClearedTimeoutState(params.onTimeout, true); + expectClearedTimeoutState(onTimeoutSpy, true); }); }); it("does not time out when compaction retry resolves", async () => { await withFakeTimers(async () => { const waitForCompactionRetry = vi.fn(async () => {}); - const params = buildAggregateTimeoutParams({ waitForCompactionRetry }); + const { params, onTimeoutSpy } = buildAggregateTimeoutParams({ waitForCompactionRetry }); const result = await waitForCompactionRetryWithAggregateTimeout(params); expect(result.timedOut).toBe(false); - expectClearedTimeoutState(params.onTimeout, false); + expectClearedTimeoutState(onTimeoutSpy, false); }); }); @@ -118,7 +123,7 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { const abortError = new Error("aborted"); abortError.name = "AbortError"; const waitForCompactionRetry = vi.fn(async () => await new Promise(() => {})); - const params = buildAggregateTimeoutParams({ + const { params, onTimeoutSpy } = buildAggregateTimeoutParams({ waitForCompactionRetry, abortable: async () => { throw abortError; @@ -127,7 +132,7 @@ describe("waitForCompactionRetryWithAggregateTimeout", () => { await expect(waitForCompactionRetryWithAggregateTimeout(params)).rejects.toThrow("aborted"); - expectClearedTimeoutState(params.onTimeout, false); + expectClearedTimeoutState(onTimeoutSpy, false); }); }); }); diff --git a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts index c9a76ea9acf..03e532eda2e 100644 --- a/src/agents/pi-embedded-runner/run/history-image-prune.test.ts +++ b/src/agents/pi-embedded-runner/run/history-image-prune.test.ts @@ -8,7 +8,7 @@ function expectArrayMessageContent( message: AgentMessage | undefined, errorMessage: string, ): Array<{ type: string; text?: string; data?: string }> { - if (!message || !Array.isArray(message.content)) { + if (!message || !("content" in message) || !Array.isArray(message.content)) { throw new Error(errorMessage); } return message.content as Array<{ type: string; text?: string; data?: string }>; diff --git a/src/agents/pi-embedded-runner/runs.test.ts b/src/agents/pi-embedded-runner/runs.test.ts index f4a154d0141..82baac1ca1e 100644 --- a/src/agents/pi-embedded-runner/runs.test.ts +++ b/src/agents/pi-embedded-runner/runs.test.ts @@ -10,14 +10,17 @@ import { waitForActiveEmbeddedRuns, } from "./runs.js"; +type RunHandle = Parameters[1]; + function createRunHandle( - overrides: { isCompacting?: boolean; abort?: ReturnType } = {}, -) { + overrides: { isCompacting?: boolean; abort?: () => void } = {}, +): RunHandle { + const abort = overrides.abort ?? (() => {}); return { queueMessage: async () => {}, isStreaming: () => true, isCompacting: () => overrides.isCompacting ?? false, - abort: overrides.abort ?? vi.fn(), + abort, }; } diff --git a/src/agents/pi-embedded-runner/system-prompt.test.ts b/src/agents/pi-embedded-runner/system-prompt.test.ts index 8e20a95bda7..0ba4ee66d0f 100644 --- a/src/agents/pi-embedded-runner/system-prompt.test.ts +++ b/src/agents/pi-embedded-runner/system-prompt.test.ts @@ -2,7 +2,7 @@ import type { AgentSession } from "@mariozechner/pi-coding-agent"; import { describe, expect, it, vi } from "vitest"; import { applySystemPromptOverrideToSession, createSystemPromptOverride } from "./system-prompt.js"; -type MutableSession = AgentSession & { +type MutableSystemPromptFields = { _baseSystemPrompt?: string; _rebuildSystemPrompt?: (toolNames: string[]) => string; }; @@ -21,7 +21,7 @@ function applyAndGetMutableSession( const { session, setSystemPrompt } = createMockSession(); applySystemPromptOverrideToSession(session, prompt); return { - mutable: session as MutableSession, + mutable: session as unknown as MutableSystemPromptFields, setSystemPrompt, }; } From 6bec21bf006db84b6f676902d62f10d575b41485 Mon Sep 17 00:00:00 2001 From: Frank Yang Date: Tue, 17 Mar 2026 16:48:46 +0800 Subject: [PATCH 183/187] chore: sync pnpm lockfile importers --- pnpm-lock.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e05340832b6..bde6311c766 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -342,6 +342,8 @@ importers: extensions/discord: {} + extensions/elevenlabs: {} + extensions/feishu: dependencies: '@larksuiteoapi/node-sdk': @@ -451,6 +453,8 @@ importers: specifier: ^6.29.0 version: 6.29.0(ws@8.19.0)(zod@4.3.6) + extensions/microsoft: {} + extensions/minimax: {} extensions/mistral: {} From 6101c023bbe8efcbe5ced7da48d7cb1a09637aca Mon Sep 17 00:00:00 2001 From: stim64045-spec Date: Tue, 17 Mar 2026 17:03:35 +0800 Subject: [PATCH 184/187] fix(ui): restore control-ui query token compatibility (#43979) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(ui): restore control-ui query token imports * chore(changelog): add entry for openclaw#43979 thanks @stim64045-spec --------- Co-authored-by: 大禹 Co-authored-by: Val Alexander Co-authored-by: Val Alexander <68980965+BunsDev@users.noreply.github.com> --- CHANGELOG.md | 2 + docs/web/control-ui.md | 2 +- ui/src/ui/app-settings.test.ts | 90 ++++++++++++++++++++++++---- ui/src/ui/app-settings.ts | 2 +- ui/src/ui/navigation.browser.test.ts | 26 +++++++- 5 files changed, 107 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b33d3f4947..61272b7a77a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -296,6 +296,8 @@ Docs: https://docs.openclaw.ai - Discord/gateway startup: treat plain-text and transient `/gateway/bot` metadata fetch failures as transient startup errors so Discord gateway boot no longer crashes on unhandled rejections. (#44397) Thanks @jalehman. - Agents/Ollama overflow: rewrite Ollama `prompt too long` API payloads through the normal context-overflow sanitizer so embedded sessions keep the friendly overflow copy and auto-compaction trigger. (#34019) thanks @lishuaigit. +- Control UI/auth: restore one-time legacy `?token=` imports for shared Control UI links while keeping `#token=` preferred, and carry pending query tokens through gateway URL confirmation so compatibility links still authenticate after confirmation. (#43979) Thanks @stim64045-spec. + ## 2026.3.11 ### Security diff --git a/docs/web/control-ui.md b/docs/web/control-ui.md index d35b245d814..3ad5feb80b4 100644 --- a/docs/web/control-ui.md +++ b/docs/web/control-ui.md @@ -242,7 +242,7 @@ http://localhost:5173/?gatewayUrl=wss://:18789#token= { + const next = new URL(String(nextUrl), current.toString()); + current.href = next.toString(); + current.protocol = next.protocol; + current.host = next.host; + current.pathname = next.pathname; + current.search = next.search; + current.hash = next.hash; + }), + }; + const locationLike = { + get href() { + return current.toString(); + }, + get protocol() { + return current.protocol; + }, + get host() { + return current.host; + }, + get pathname() { + return current.pathname; + }, + get search() { + return current.search; + }, + get hash() { + return current.hash; + }, + }; + vi.stubGlobal("window", { + location: locationLike, + history, + setInterval, + clearInterval, + } as unknown as Window & typeof globalThis); + vi.stubGlobal("location", locationLike as Location); + return { history, location: locationLike }; +} + const createHost = (tab: Tab): SettingsHost => ({ settings: { gatewayUrl: "", @@ -233,15 +276,44 @@ describe("setTabFromRoute", () => { describe("applySettingsFromUrl", () => { beforeEach(() => { vi.stubGlobal("localStorage", createStorageMock()); + vi.stubGlobal("sessionStorage", createStorageMock()); vi.stubGlobal("navigator", { language: "en-US" } as Navigator); + setTestWindowUrl("https://control.example/ui/overview"); }); afterEach(() => { + vi.restoreAllMocks(); vi.unstubAllGlobals(); - window.history.replaceState({}, "", "/chat"); + }); + + it("hydrates query token params and strips them from the URL", () => { + setTestWindowUrl("https://control.example/ui/overview?token=abc123"); + const host = createHost("overview"); + host.settings.gatewayUrl = "wss://control.example/openclaw"; + + applySettingsFromUrl(host); + + expect(host.settings.token).toBe("abc123"); + expect(window.location.search).toBe(""); + }); + + it("keeps query token params pending when a gatewayUrl confirmation is required", () => { + setTestWindowUrl( + "https://control.example/ui/overview?gatewayUrl=wss://other-gateway.example/openclaw&token=abc123", + ); + const host = createHost("overview"); + host.settings.gatewayUrl = "wss://control.example/openclaw"; + + applySettingsFromUrl(host); + + expect(host.settings.token).toBe(""); + expect(host.pendingGatewayUrl).toBe("wss://other-gateway.example/openclaw"); + expect(host.pendingGatewayToken).toBe("abc123"); + expect(window.location.search).toBe(""); }); it("resets stale persisted session selection to main when a token is supplied without a session", () => { + setTestWindowUrl("https://control.example/chat#token=test-token"); const host = createHost("chat"); host.settings = { ...host.settings, @@ -252,8 +324,6 @@ describe("applySettingsFromUrl", () => { }; host.sessionKey = "agent:test_old:main"; - window.history.replaceState({}, "", "/chat#token=test-token"); - applySettingsFromUrl(host); expect(host.sessionKey).toBe("main"); @@ -262,6 +332,9 @@ describe("applySettingsFromUrl", () => { }); it("preserves an explicit session from the URL when token and session are both supplied", () => { + setTestWindowUrl( + "https://control.example/chat?session=agent%3Atest_new%3Amain#token=test-token", + ); const host = createHost("chat"); host.settings = { ...host.settings, @@ -272,8 +345,6 @@ describe("applySettingsFromUrl", () => { }; host.sessionKey = "agent:test_old:main"; - window.history.replaceState({}, "", "/chat?session=agent%3Atest_new%3Amain#token=test-token"); - applySettingsFromUrl(host); expect(host.sessionKey).toBe("agent:test_new:main"); @@ -282,6 +353,9 @@ describe("applySettingsFromUrl", () => { }); it("does not reset the current gateway session when a different gateway is pending confirmation", () => { + setTestWindowUrl( + "https://control.example/chat?gatewayUrl=ws%3A%2F%2Fgateway-b.example%3A18789#token=test-token", + ); const host = createHost("chat"); host.settings = { ...host.settings, @@ -292,12 +366,6 @@ describe("applySettingsFromUrl", () => { }; host.sessionKey = "agent:test_old:main"; - window.history.replaceState( - {}, - "", - "/chat?gatewayUrl=ws%3A%2F%2Fgateway-b.example%3A18789#token=test-token", - ); - applySettingsFromUrl(host); expect(host.sessionKey).toBe("agent:test_old:main"); diff --git a/ui/src/ui/app-settings.ts b/ui/src/ui/app-settings.ts index 2a9c2685589..bd924915b76 100644 --- a/ui/src/ui/app-settings.ts +++ b/ui/src/ui/app-settings.ts @@ -97,7 +97,7 @@ export function applySettingsFromUrl(host: SettingsHost) { const gatewayUrlRaw = params.get("gatewayUrl") ?? hashParams.get("gatewayUrl"); const nextGatewayUrl = gatewayUrlRaw?.trim() ?? ""; const gatewayUrlChanged = Boolean(nextGatewayUrl && nextGatewayUrl !== host.settings.gatewayUrl); - const tokenRaw = hashParams.get("token"); + const tokenRaw = hashParams.get("token") ?? params.get("token"); const passwordRaw = params.get("password") ?? hashParams.get("password"); const sessionRaw = params.get("session") ?? hashParams.get("session"); const shouldResetSessionForToken = Boolean( diff --git a/ui/src/ui/navigation.browser.test.ts b/ui/src/ui/navigation.browser.test.ts index 5251eda790c..3407288c03d 100644 --- a/ui/src/ui/navigation.browser.test.ts +++ b/ui/src/ui/navigation.browser.test.ts @@ -315,11 +315,11 @@ describe("control UI routing", () => { expect(container.scrollTop).toBe(maxScroll); }); - it("strips query token params without importing them", async () => { + it("hydrates token from query params and strips them", async () => { const app = mountApp("/ui/overview?token=abc123"); await app.updateComplete; - expect(app.settings.token).toBe(""); + expect(app.settings.token).toBe("abc123"); expect(JSON.parse(localStorage.getItem("openclaw.control.settings.v1") ?? "{}").token).toBe( undefined, ); @@ -405,6 +405,28 @@ describe("control UI routing", () => { expect(window.location.hash).toBe(""); }); + it("keeps a query token pending until the gateway URL change is confirmed", async () => { + const app = mountApp( + "/ui/overview?gatewayUrl=wss://other-gateway.example/openclaw&token=abc123", + ); + await app.updateComplete; + + expect(app.settings.gatewayUrl).not.toBe("wss://other-gateway.example/openclaw"); + expect(app.settings.token).toBe(""); + + const confirmButton = Array.from(app.querySelectorAll("button")).find( + (button) => button.textContent?.trim() === "Confirm", + ); + expect(confirmButton).not.toBeUndefined(); + confirmButton?.dispatchEvent(new MouseEvent("click", { bubbles: true, cancelable: true })); + await app.updateComplete; + + expect(app.settings.gatewayUrl).toBe("wss://other-gateway.example/openclaw"); + expect(app.settings.token).toBe("abc123"); + expect(window.location.search).toBe(""); + expect(window.location.hash).toBe(""); + }); + it("restores the token after a same-tab refresh", async () => { const first = mountApp("/ui/overview#token=abc123"); await first.updateComplete; From 73032534276d1dedf645e785f02ec2a3c0a2cf89 Mon Sep 17 00:00:00 2001 From: Br1an <932039080@qq.com> Date: Tue, 17 Mar 2026 17:46:54 +0800 Subject: [PATCH 185/187] fix: update macOS node service to use current CLI command shape (closes #43171) (#46843) Merged via squash. Prepared head SHA: dbf2edd6f4fdc89aea865bec631f7a289a4dcbd1 Co-authored-by: Br1an67 <29810238+Br1an67@users.noreply.github.com> Co-authored-by: ImLukeF <92253590+ImLukeF@users.noreply.github.com> Reviewed-by: @ImLukeF --- CHANGELOG.md | 1 + .../Sources/OpenClaw/NodeServiceManager.swift | 26 ++++++++++++++----- .../NodeServiceManagerTests.swift | 19 ++++++++++++++ 3 files changed, 39 insertions(+), 7 deletions(-) create mode 100644 apps/macos/Tests/OpenClawIPCTests/NodeServiceManagerTests.swift diff --git a/CHANGELOG.md b/CHANGELOG.md index 61272b7a77a..11ed3943f5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -122,6 +122,7 @@ Docs: https://docs.openclaw.ai - Agents/bootstrap warnings: move bootstrap truncation warnings out of the system prompt and into the per-turn prompt body so prompt-cache reuse stays stable when truncation warnings appear or disappear. (#48753) Thanks @scoootscooob and @obviyus. - Telegram/DM topic session keys: route named-account DM topics through the same per-account base session key across inbound messages, native commands, and session-state lookups so `/status` and thread recovery stop creating phantom `agent:main:main:thread:...` sessions. (#48204) Thanks @vincentkoc. +- macOS/node service startup: use `openclaw node start/stop --json` from the Mac app instead of the removed `openclaw service node ...` command shape, so current CLI installs expose the full node exec surface again. (#46843) Fixes #43171. Thanks @Br1an67. ## 2026.3.13 diff --git a/apps/macos/Sources/OpenClaw/NodeServiceManager.swift b/apps/macos/Sources/OpenClaw/NodeServiceManager.swift index 7a9da5925f8..18f500bd359 100644 --- a/apps/macos/Sources/OpenClaw/NodeServiceManager.swift +++ b/apps/macos/Sources/OpenClaw/NodeServiceManager.swift @@ -6,7 +6,7 @@ enum NodeServiceManager { static func start() async -> String? { let result = await self.runServiceCommandResult( - ["node", "start"], + ["start"], timeout: 20, quiet: false) if let error = self.errorMessage(from: result, treatNotLoadedAsError: true) { @@ -18,7 +18,7 @@ enum NodeServiceManager { static func stop() async -> String? { let result = await self.runServiceCommandResult( - ["node", "stop"], + ["stop"], timeout: 15, quiet: false) if let error = self.errorMessage(from: result, treatNotLoadedAsError: false) { @@ -30,6 +30,14 @@ enum NodeServiceManager { } extension NodeServiceManager { + private static func serviceCommand(_ args: [String]) -> [String] { + CommandResolver.openclawCommand( + subcommand: "node", + extraArgs: self.withJsonFlag(args), + // Service management must always run locally, even if remote mode is configured. + configRoot: ["gateway": ["mode": "local"]]) + } + private struct CommandResult { let success: Bool let payload: Data? @@ -52,11 +60,7 @@ extension NodeServiceManager { timeout: Double, quiet: Bool) async -> CommandResult { - let command = CommandResolver.openclawCommand( - subcommand: "service", - extraArgs: self.withJsonFlag(args), - // Service management must always run locally, even if remote mode is configured. - configRoot: ["gateway": ["mode": "local"]]) + let command = self.serviceCommand(args) var env = ProcessInfo.processInfo.environment env["PATH"] = CommandResolver.preferredPaths().joined(separator: ":") let response = await ShellExecutor.runDetailed(command: command, cwd: nil, env: env, timeout: timeout) @@ -136,3 +140,11 @@ extension NodeServiceManager { TextSummarySupport.summarizeLastLine(text) } } + +#if DEBUG +extension NodeServiceManager { + static func _testServiceCommand(_ args: [String]) -> [String] { + self.serviceCommand(args) + } +} +#endif diff --git a/apps/macos/Tests/OpenClawIPCTests/NodeServiceManagerTests.swift b/apps/macos/Tests/OpenClawIPCTests/NodeServiceManagerTests.swift new file mode 100644 index 00000000000..df49a82e223 --- /dev/null +++ b/apps/macos/Tests/OpenClawIPCTests/NodeServiceManagerTests.swift @@ -0,0 +1,19 @@ +import Foundation +import Testing +@testable import OpenClaw + +@Suite(.serialized) struct NodeServiceManagerTests { + @Test func `builds node service commands with current CLI shape`() throws { + let tmp = try makeTempDirForTests() + CommandResolver.setProjectRoot(tmp.path) + + let openclawPath = tmp.appendingPathComponent("node_modules/.bin/openclaw") + try makeExecutableForTests(at: openclawPath) + + let start = NodeServiceManager._testServiceCommand(["start"]) + #expect(start == [openclawPath.path, "node", "start", "--json"]) + + let stop = NodeServiceManager._testServiceCommand(["stop"]) + #expect(stop == [openclawPath.path, "node", "stop", "--json"]) + } +} From 6b6942552d847a047d70f3c4947b796e3e00047c Mon Sep 17 00:00:00 2001 From: Stable Genius Date: Tue, 17 Mar 2026 02:59:56 -0700 Subject: [PATCH 186/187] fix(macos): stop relaunching the app after quit when launch-at-login is enabled (#40213) Merged via squash. Prepared head SHA: c702d98bd63f4de4059df54f8aaea1ff56c01a34 Co-authored-by: stablegenius49 <259448942+stablegenius49@users.noreply.github.com> Co-authored-by: ImLukeF <92253590+ImLukeF@users.noreply.github.com> Reviewed-by: @ImLukeF --- CHANGELOG.md | 1 + .../Sources/OpenClaw/LaunchAgentManager.swift | 10 ++++++---- .../LaunchAgentManagerTests.swift | 19 +++++++++++++++++++ 3 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 apps/macos/Tests/OpenClawIPCTests/LaunchAgentManagerTests.swift diff --git a/CHANGELOG.md b/CHANGELOG.md index 11ed3943f5e..7c090e31784 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -123,6 +123,7 @@ Docs: https://docs.openclaw.ai - Agents/bootstrap warnings: move bootstrap truncation warnings out of the system prompt and into the per-turn prompt body so prompt-cache reuse stays stable when truncation warnings appear or disappear. (#48753) Thanks @scoootscooob and @obviyus. - Telegram/DM topic session keys: route named-account DM topics through the same per-account base session key across inbound messages, native commands, and session-state lookups so `/status` and thread recovery stop creating phantom `agent:main:main:thread:...` sessions. (#48204) Thanks @vincentkoc. - macOS/node service startup: use `openclaw node start/stop --json` from the Mac app instead of the removed `openclaw service node ...` command shape, so current CLI installs expose the full node exec surface again. (#46843) Fixes #43171. Thanks @Br1an67. +- macOS/launch at login: stop emitting `KeepAlive` for the desktop app launch agent so OpenClaw no longer relaunches immediately after a manual quit while launch at login remains enabled. (#40213) Thanks @stablegenius49. ## 2026.3.13 diff --git a/apps/macos/Sources/OpenClaw/LaunchAgentManager.swift b/apps/macos/Sources/OpenClaw/LaunchAgentManager.swift index af318b330d4..004d575d5d5 100644 --- a/apps/macos/Sources/OpenClaw/LaunchAgentManager.swift +++ b/apps/macos/Sources/OpenClaw/LaunchAgentManager.swift @@ -26,7 +26,12 @@ enum LaunchAgentManager { } private static func writePlist(bundlePath: String) { - let plist = """ + let plist = self.plistContents(bundlePath: bundlePath) + try? plist.write(to: self.plistURL, atomically: true, encoding: .utf8) + } + + static func plistContents(bundlePath: String) -> String { + """ @@ -41,8 +46,6 @@ enum LaunchAgentManager { \(FileManager().homeDirectoryForCurrentUser.path) RunAtLoad - KeepAlive - EnvironmentVariables PATH @@ -55,7 +58,6 @@ enum LaunchAgentManager { """ - try? plist.write(to: self.plistURL, atomically: true, encoding: .utf8) } @discardableResult diff --git a/apps/macos/Tests/OpenClawIPCTests/LaunchAgentManagerTests.swift b/apps/macos/Tests/OpenClawIPCTests/LaunchAgentManagerTests.swift new file mode 100644 index 00000000000..c9a17d57577 --- /dev/null +++ b/apps/macos/Tests/OpenClawIPCTests/LaunchAgentManagerTests.swift @@ -0,0 +1,19 @@ +import Foundation +import Testing +@testable import OpenClaw + +struct LaunchAgentManagerTests { + @Test func `launch at login plist does not keep app alive after manual quit`() throws { + let plist = LaunchAgentManager.plistContents(bundlePath: "/Applications/OpenClaw.app") + let data = try #require(plist.data(using: .utf8)) + let object = try #require( + PropertyListSerialization.propertyList(from: data, format: nil) as? [String: Any] + ) + + #expect(object["RunAtLoad"] as? Bool == true) + #expect(object["KeepAlive"] == nil) + + let args = try #require(object["ProgramArguments"] as? [String]) + #expect(args == ["/Applications/OpenClaw.app/Contents/MacOS/OpenClaw"]) + } +} From f404ff32d527d2cbcccd7dc1beb30a0d024d6c0d Mon Sep 17 00:00:00 2001 From: Chris Kimpton Date: Tue, 17 Mar 2026 09:08:08 +0000 Subject: [PATCH 187/187] tests: add missing useNoBundledPlugins() to bundle MCP loader test The "treats bundle MCP as a supported bundle surface" test was missing the useNoBundledPlugins() call present in all surrounding bundle plugin tests. Without it, loadOpenClawPlugins() scanned and loaded the full real bundled plugins directory on every call (with cache:false), causing excessive memory pressure and an OOM crash on Linux CI, which manifested as the test timing out at 120s. Co-Authored-By: Claude Sonnet 4.6 --- src/plugins/loader.test.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/plugins/loader.test.ts b/src/plugins/loader.test.ts index a1e25c0ea3e..151a1ddaf59 100644 --- a/src/plugins/loader.test.ts +++ b/src/plugins/loader.test.ts @@ -421,6 +421,7 @@ describe("bundle plugins", () => { }); it("treats bundle MCP as a supported bundle surface", () => { + useNoBundledPlugins(); const workspaceDir = makeTempDir(); const bundleRoot = path.join(workspaceDir, ".openclaw", "extensions", "claude-mcp"); mkdirSafe(path.join(bundleRoot, ".claude-plugin"));