let5see/clawdbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move provider to a plugin-architecture (#661)

Browse Source 
* refactor: introduce provider plugin registry

* refactor: move provider CLI to plugins

* docs: add provider plugin implementation notes

* refactor: shift provider runtime logic into plugins

* refactor: add plugin defaults and summaries

* docs: update provider plugin notes

* feat(commands): add /commands slash list

* Auto-reply: tidy help message

* Auto-reply: fix status command lint

* Tests: align google shared expectations

* Auto-reply: tidy help message

* Auto-reply: fix status command lint

* refactor: move provider routing into plugins

* test: align agent routing expectations

* docs: update provider plugin notes

* refactor: route replies via provider plugins

* docs: note route-reply plugin hooks

* refactor: extend provider plugin contract

* refactor: derive provider status from plugins

* refactor: unify gateway provider control

* refactor: use plugin metadata in auto-reply

* fix: parenthesize cron target selection

* refactor: derive gateway methods from plugins

* refactor: generalize provider logout

* refactor: route provider logout through plugins

* refactor: move WhatsApp web login methods into plugin

* refactor: generalize provider log prefixes

* refactor: centralize default chat provider

* refactor: derive provider lists from registry

* refactor: move provider reload noops into plugins

* refactor: resolve web login provider via alias

* refactor: derive CLI provider options from plugins

* refactor: derive prompt provider list from plugins

* style: apply biome lint fixes

* fix: resolve provider routing edge cases

* docs: update provider plugin refactor notes

* fix(gateway): harden agent provider routing

* refactor: move provider routing into plugins

* refactor: move provider CLI to plugins

* refactor: derive provider lists from registry

* fix: restore slash command parsing

* refactor: align provider ids for schema

* refactor: unify outbound target resolution

* fix: keep outbound labels stable

* feat: add msteams to cron surfaces

* fix: clean up lint build issues

* refactor: localize chat provider alias normalization

* refactor: drive gateway provider lists from plugins

* docs: update provider plugin notes

* style: format message-provider

* fix: avoid provider registry init cycles

* style: sort message-provider imports

* fix: relax provider alias map typing

* refactor: move provider routing into plugins

* refactor: add plugin pairing/config adapters

* refactor: route pairing and provider removal via plugins

* refactor: align auto-reply provider typing

* test: stabilize telegram media mocks

* docs: update provider plugin refactor notes

* refactor: pluginize outbound targets

* refactor: pluginize provider selection

* refactor: generalize text chunk limits

* docs: update provider plugin notes

* refactor: generalize group session/config

* fix: normalize provider id for room detection

* fix: avoid provider init in system prompt

* style: formatting cleanup

* refactor: normalize agent delivery targets

* test: update outbound delivery labels

* chore: fix lint regressions

* refactor: extend provider plugin adapters

* refactor: move elevated/block streaming defaults to plugins

* refactor: defer outbound send deps to plugins

* docs: note plugin-driven streaming/elevated defaults

* refactor: centralize webchat provider constant

* refactor: add provider setup adapters

* refactor: delegate provider add config to plugins

* docs: document plugin-driven provider add

* refactor: add plugin state/binding metadata

* refactor: build agent provider status from plugins

* docs: note plugin-driven agent bindings

* refactor: centralize internal provider constant usage

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* refactor: centralize default chat provider

* refactor: centralize WhatsApp target normalization

* refactor: move provider routing into plugins

* refactor: normalize agent delivery targets

* chore: fix lint regressions

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* feat: expand provider plugin adapters

* refactor: route auto-reply via provider plugins

* fix: align WhatsApp target normalization

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* refactor: centralize WhatsApp target normalization

* feat: add /config chat config updates

* docs: add /config get alias

* feat(commands): add /commands slash list

* refactor: centralize default chat provider

* style: apply biome lint fixes

* chore: fix lint regressions

* fix: clean up whatsapp allowlist typing

* style: format config command helpers

* refactor: pluginize tool threading context

* refactor: normalize session announce targets

* docs: note new plugin threading and announce hooks

* refactor: pluginize message actions

* docs: update provider plugin actions notes

* fix: align provider action adapters

* refactor: centralize webchat checks

* style: format message provider helpers

* refactor: move provider onboarding into adapters

* docs: note onboarding provider adapters

* feat: add msteams onboarding adapter

* style: organize onboarding imports

* fix: normalize msteams allowFrom types

* feat: add plugin text chunk limits

* refactor: use plugin chunk limit fallbacks

* feat: add provider mention stripping hooks

* style: organize provider plugin type imports

* refactor: generalize health snapshots

* refactor: update macOS health snapshot handling

* docs: refresh health snapshot notes

* style: format health snapshot updates

* refactor: drive security warnings via plugins

* docs: note provider security adapter

* style: format provider security adapters

* refactor: centralize provider account defaults

* refactor: type gateway client identity constants

* chore: regen gateway protocol swift

* fix: degrade health on failed provider probe

* refactor: centralize pairing approve hint

* docs: add plugin CLI command references

* refactor: route auth and tool sends through plugins

* docs: expand provider plugin hooks

* refactor: document provider docking touchpoints

* refactor: normalize internal provider defaults

* refactor: streamline outbound delivery wiring

* refactor: make provider onboarding plugin-owned

* refactor: support provider-owned agent tools

* refactor: move telegram draft chunking into telegram module

* refactor: infer provider tool sends via extractToolSend

* fix: repair plugin onboarding imports

* refactor: de-dup outbound target normalization

* style: tidy plugin and agent imports

* refactor: data-drive provider selection line

* fix: satisfy lint after provider plugin rebase

* test: deflake gateway-cli coverage

* style: format gateway-cli coverage test

* refactor(provider-plugins): simplify provider ids

* test(pairing-cli): avoid provider-specific ternary

* style(macos): swiftformat HealthStore

* refactor(sandbox): derive provider tool denylist

* fix(sandbox): avoid plugin init in defaults

* refactor(provider-plugins): centralize provider aliases

* style(test): satisfy biome

* refactor(protocol): v3 providers.status maps

* refactor(ui): adapt to protocol v3

* refactor(macos): adapt to protocol v3

* test: update providers.status v3 fixtures

* refactor(gateway): map provider runtime snapshot

* test(gateway): update reload runtime snapshot

* refactor(whatsapp): normalize heartbeat provider id

* docs(refactor): update provider plugin notes

* style: satisfy biome after rebase

* fix: describe sandboxed elevated in prompt

* feat(gateway): add agent image attachments + live probe

* refactor: derive CLI provider options from plugins

* fix(gateway): harden agent provider routing

* fix(gateway): harden agent provider routing

* refactor: align provider ids for schema

* fix(protocol): keep agent provider string

* fix(gateway): harden agent provider routing

* fix(protocol): keep agent provider string

* refactor: normalize agent delivery targets

* refactor: support provider-owned agent tools

* refactor(config): provider-keyed elevated allowFrom

* style: satisfy biome

* fix(gateway): appease provider narrowing

* style: satisfy biome

* refactor(reply): move group intro hints into plugin

* fix(reply): avoid plugin registry init cycle

* refactor(providers): add lightweight provider dock

* refactor(gateway): use typed client id in connect

* refactor(providers): document docks and avoid init cycles

* refactor(providers): make media limit helper generic

* fix(providers): break plugin registry import cycles

* style: satisfy biome

* refactor(status-all): build providers table from plugins

* refactor(gateway): delegate web login to provider plugin

* refactor(provider): drop web alias

* refactor(provider): lazy-load monitors

* style: satisfy lint/format

* style: format status-all providers table

* style: swiftformat gateway discovery model

* test: make reload plan plugin-driven

* fix: avoid token stringification in status-all

* refactor: make provider IDs explicit in status

* feat: warn on signal/imessage provider runtime errors

* test: cover gateway provider runtime warnings in status

* fix: add runtime kind to provider status issues

* test: cover health degradation on probe failure

* fix: keep routeReply lightweight

* style: organize routeReply imports

* refactor(web): extract auth-store helpers

* refactor(whatsapp): lazy login imports

* refactor(outbound): route replies via plugin outbound

* docs: update provider plugin notes

* style: format provider status issues

* fix: make sandbox scope warning wrap-safe

* refactor: load outbound adapters from provider plugins

* docs: update provider plugin outbound notes

* style(macos): fix swiftformat lint

* docs: changelog for provider plugins

* fix(macos): satisfy swiftformat

* fix(macos): open settings via menu action

* style: format after rebase

* fix(macos): open Settings via menu action

---------

Co-authored-by: LK <luke@kyohere.com>
Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Xin <xin@imfing.com>
This commit is contained in:
Peter Steinberger
2026-01-11 11:45:25 +00:00
committed by GitHub
parent 23eec7d841
commit 7acd26a2fc
232 changed files with 13642 additions and 10809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

309
src/infra/outbound/deliver.ts
View File

@@ -1,24 +1,18 @@
import {
chunkMarkdownText,
chunkText,
resolveTextChunkLimit,
} from "../../auto-reply/chunk.js";
import { resolveTextChunkLimit } from "../../auto-reply/chunk.js";
import type { ReplyPayload } from "../../auto-reply/types.js";
import type { ClawdbotConfig } from "../../config/config.js";
import { sendMessageDiscord } from "../../discord/send.js";
import { sendMessageIMessage } from "../../imessage/send.js";
import { sendMessageMSTeams } from "../../msteams/send.js";
import { normalizeAccountId } from "../../routing/session-key.js";
import { sendMessageSignal } from "../../signal/send.js";
import { sendMessageSlack } from "../../slack/send.js";
import { sendMessageTelegram } from "../../telegram/send.js";
import { sendMessageWhatsApp } from "../../web/outbound.js";
import type { sendMessageDiscord } from "../../discord/send.js";
import type { sendMessageIMessage } from "../../imessage/send.js";
import { loadProviderOutboundAdapter } from "../../providers/plugins/outbound/load.js";
import type { ProviderOutboundAdapter } from "../../providers/plugins/types.js";
import type { sendMessageSignal } from "../../signal/send.js";
import type { sendMessageSlack } from "../../slack/send.js";
import type { sendMessageTelegram } from "../../telegram/send.js";
import type { sendMessageWhatsApp } from "../../web/outbound.js";
import type { NormalizedOutboundPayload } from "./payloads.js";
import { normalizeOutboundPayloads } from "./payloads.js";
import type { OutboundProvider } from "./targets.js";
const MB = 1024 * 1024;
export type { NormalizedOutboundPayload } from "./payloads.js";
export { normalizeOutboundPayloads } from "./payloads.js";
@@ -36,32 +30,24 @@ export type OutboundSendDeps = {
) => Promise<{ messageId: string; conversationId: string }>;
};
export type OutboundDeliveryResult =
| { provider: "whatsapp"; messageId: string; toJid: string }
| { provider: "telegram"; messageId: string; chatId: string }
| { provider: "discord"; messageId: string; channelId: string }
| { provider: "slack"; messageId: string; channelId: string }
| { provider: "signal"; messageId: string; timestamp?: number }
| { provider: "imessage"; messageId: string }
| { provider: "msteams"; messageId: string; conversationId: string };
export type OutboundDeliveryResult = {
provider: Exclude<OutboundProvider, "none">;
messageId: string;
chatId?: string;
channelId?: string;
conversationId?: string;
timestamp?: number;
toJid?: string;
pollId?: string;
// Provider docking: stash provider-specific fields here to avoid core type churn.
meta?: Record<string, unknown>;
};
type Chunker = (text: string, limit: number) => string[];
const providerCaps: Record<
Exclude<OutboundProvider, "none">,
{ chunker: Chunker | null }
> = {
whatsapp: { chunker: chunkText },
telegram: { chunker: chunkMarkdownText },
discord: { chunker: null },
slack: { chunker: null },
signal: { chunker: chunkText },
imessage: { chunker: chunkText },
msteams: { chunker: chunkMarkdownText },
};
type ProviderHandler = {
chunker: Chunker | null;
textChunkLimit?: number;
sendText: (text: string) => Promise<OutboundDeliveryResult>;
sendMedia: (
caption: string,
@@ -69,165 +55,87 @@ type ProviderHandler = {
) => Promise<OutboundDeliveryResult>;
};
function resolveMediaMaxBytes(
cfg: ClawdbotConfig,
provider: "signal" | "imessage",
accountId?: string | null,
): number | undefined {
const normalizedAccountId = normalizeAccountId(accountId);
const providerLimit =
provider === "signal"
? (cfg.signal?.accounts?.[normalizedAccountId]?.mediaMaxMb ??
cfg.signal?.mediaMaxMb)
: (cfg.imessage?.accounts?.[normalizedAccountId]?.mediaMaxMb ??
cfg.imessage?.mediaMaxMb);
if (providerLimit) return providerLimit * MB;
if (cfg.agents?.defaults?.mediaMaxMb) {
return cfg.agents.defaults.mediaMaxMb * MB;
function throwIfAborted(abortSignal?: AbortSignal): void {
if (abortSignal?.aborted) {
throw new Error("Outbound delivery aborted");
}
return undefined;
}
function createProviderHandler(params: {
// Provider docking: outbound delivery delegates to plugin.outbound adapters.
async function createProviderHandler(params: {
cfg: ClawdbotConfig;
provider: Exclude<OutboundProvider, "none">;
to: string;
accountId?: string;
deps: Required<OutboundSendDeps>;
}): ProviderHandler {
const { cfg, to, deps } = params;
const rawAccountId = params.accountId;
const accountId = normalizeAccountId(rawAccountId);
const signalMaxBytes =
params.provider === "signal"
? resolveMediaMaxBytes(cfg, "signal", accountId)
: undefined;
const imessageMaxBytes =
params.provider === "imessage"
? resolveMediaMaxBytes(cfg, "imessage", accountId)
: undefined;
replyToId?: string | null;
threadId?: number | null;
deps?: OutboundSendDeps;
gifPlayback?: boolean;
}): Promise<ProviderHandler> {
const outbound = await loadProviderOutboundAdapter(params.provider);
if (!outbound?.sendText || !outbound?.sendMedia) {
throw new Error(`Outbound not configured for provider: ${params.provider}`);
}
const handler = createPluginHandler({
outbound,
cfg: params.cfg,
provider: params.provider,
to: params.to,
accountId: params.accountId,
replyToId: params.replyToId,
threadId: params.threadId,
deps: params.deps,
gifPlayback: params.gifPlayback,
});
if (!handler) {
throw new Error(`Outbound not configured for provider: ${params.provider}`);
}
return handler;
}
const handlers: Record<Exclude<OutboundProvider, "none">, ProviderHandler> = {
whatsapp: {
chunker: providerCaps.whatsapp.chunker,
sendText: async (text) => ({
provider: "whatsapp",
...(await deps.sendWhatsApp(to, text, {
verbose: false,
accountId: rawAccountId,
})),
function createPluginHandler(params: {
outbound?: ProviderOutboundAdapter;
cfg: ClawdbotConfig;
provider: Exclude<OutboundProvider, "none">;
to: string;
accountId?: string;
replyToId?: string | null;
threadId?: number | null;
deps?: OutboundSendDeps;
gifPlayback?: boolean;
}): ProviderHandler | null {
const outbound = params.outbound;
if (!outbound?.sendText || !outbound?.sendMedia) return null;
const sendText = outbound.sendText;
const sendMedia = outbound.sendMedia;
const chunker = outbound.chunker ?? null;
return {
chunker,
textChunkLimit: outbound.textChunkLimit,
sendText: async (text) =>
sendText({
cfg: params.cfg,
to: params.to,
text,
accountId: params.accountId,
replyToId: params.replyToId,
threadId: params.threadId,
gifPlayback: params.gifPlayback,
deps: params.deps,
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "whatsapp",
...(await deps.sendWhatsApp(to, caption, {
verbose: false,
mediaUrl,
accountId: rawAccountId,
})),
sendMedia: async (caption, mediaUrl) =>
sendMedia({
cfg: params.cfg,
to: params.to,
text: caption,
mediaUrl,
accountId: params.accountId,
replyToId: params.replyToId,
threadId: params.threadId,
gifPlayback: params.gifPlayback,
deps: params.deps,
}),
},
telegram: {
chunker: providerCaps.telegram.chunker,
sendText: async (text) => ({
provider: "telegram",
...(await deps.sendTelegram(to, text, {
verbose: false,
accountId: rawAccountId,
})),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "telegram",
...(await deps.sendTelegram(to, caption, {
verbose: false,
mediaUrl,
accountId: rawAccountId,
})),
}),
},
discord: {
chunker: providerCaps.discord.chunker,
sendText: async (text) => ({
provider: "discord",
...(await deps.sendDiscord(to, text, {
verbose: false,
accountId: rawAccountId,
})),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "discord",
...(await deps.sendDiscord(to, caption, {
verbose: false,
mediaUrl,
accountId: rawAccountId,
})),
}),
},
slack: {
chunker: providerCaps.slack.chunker,
sendText: async (text) => ({
provider: "slack",
...(await deps.sendSlack(to, text, {
accountId: rawAccountId,
})),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "slack",
...(await deps.sendSlack(to, caption, {
mediaUrl,
accountId: rawAccountId,
})),
}),
},
signal: {
chunker: providerCaps.signal.chunker,
sendText: async (text) => ({
provider: "signal",
...(await deps.sendSignal(to, text, {
maxBytes: signalMaxBytes,
accountId: rawAccountId,
})),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "signal",
...(await deps.sendSignal(to, caption, {
mediaUrl,
maxBytes: signalMaxBytes,
accountId: rawAccountId,
})),
}),
},
imessage: {
chunker: providerCaps.imessage.chunker,
sendText: async (text) => ({
provider: "imessage",
...(await deps.sendIMessage(to, text, {
maxBytes: imessageMaxBytes,
accountId: rawAccountId,
})),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "imessage",
...(await deps.sendIMessage(to, caption, {
mediaUrl,
maxBytes: imessageMaxBytes,
accountId: rawAccountId,
})),
}),
},
msteams: {
chunker: providerCaps.msteams.chunker,
sendText: async (text) => ({
provider: "msteams",
...(await deps.sendMSTeams(to, text)),
}),
sendMedia: async (caption, mediaUrl) => ({
provider: "msteams",
...(await deps.sendMSTeams(to, caption, { mediaUrl })),
}),
},
};
return handlers[params.provider];
}
export async function deliverOutboundPayloads(params: {
@@ -236,45 +144,44 @@ export async function deliverOutboundPayloads(params: {
to: string;
accountId?: string;
payloads: ReplyPayload[];
replyToId?: string | null;
threadId?: number | null;
deps?: OutboundSendDeps;
gifPlayback?: boolean;
abortSignal?: AbortSignal;
bestEffort?: boolean;
onError?: (err: unknown, payload: NormalizedOutboundPayload) => void;
onPayload?: (payload: NormalizedOutboundPayload) => void;
}): Promise<OutboundDeliveryResult[]> {
const { cfg, provider, to, payloads } = params;
const accountId = params.accountId;
const defaultSendMSTeams = async (
to: string,
text: string,
opts?: { mediaUrl?: string },
) => sendMessageMSTeams({ cfg, to, text, mediaUrl: opts?.mediaUrl });
const deps = {
sendWhatsApp: params.deps?.sendWhatsApp ?? sendMessageWhatsApp,
sendTelegram: params.deps?.sendTelegram ?? sendMessageTelegram,
sendDiscord: params.deps?.sendDiscord ?? sendMessageDiscord,
sendSlack: params.deps?.sendSlack ?? sendMessageSlack,
sendSignal: params.deps?.sendSignal ?? sendMessageSignal,
sendIMessage: params.deps?.sendIMessage ?? sendMessageIMessage,
sendMSTeams: params.deps?.sendMSTeams ?? defaultSendMSTeams,
};
const deps = params.deps;
const abortSignal = params.abortSignal;
const results: OutboundDeliveryResult[] = [];
const handler = createProviderHandler({
const handler = await createProviderHandler({
cfg,
provider,
to,
deps,
accountId,
replyToId: params.replyToId,
threadId: params.threadId,
gifPlayback: params.gifPlayback,
});
const textLimit = handler.chunker
? resolveTextChunkLimit(cfg, provider, accountId)
? resolveTextChunkLimit(cfg, provider, accountId, {
fallbackLimit: handler.textChunkLimit,
})
: undefined;
const sendTextChunks = async (text: string) => {
throwIfAborted(abortSignal);
if (!handler.chunker || textLimit === undefined) {
results.push(await handler.sendText(text));
return;
}
for (const chunk of handler.chunker(text, textLimit)) {
throwIfAborted(abortSignal);
results.push(await handler.sendText(chunk));
}
};
@@ -282,6 +189,7 @@ export async function deliverOutboundPayloads(params: {
const normalizedPayloads = normalizeOutboundPayloads(payloads);
for (const payload of normalizedPayloads) {
try {
throwIfAborted(abortSignal);
params.onPayload?.(payload);
if (payload.mediaUrls.length === 0) {
await sendTextChunks(payload.text);
@@ -290,6 +198,7 @@ export async function deliverOutboundPayloads(params: {
let first = true;
for (const url of payload.mediaUrls) {
throwIfAborted(abortSignal);
const caption = first ? payload.text : "";
first = false;
results.push(await handler.sendMedia(caption, url));

6
src/infra/outbound/format.test.ts
View File

@@ -9,7 +9,7 @@ import {
describe("formatOutboundDeliverySummary", () => {
it("falls back when result is missing", () => {
expect(formatOutboundDeliverySummary("telegram")).toBe(
"✅ Sent via telegram. Message ID: unknown",
"✅ Sent via Telegram. Message ID: unknown",
);
expect(formatOutboundDeliverySummary("imessage")).toBe(
"✅ Sent via iMessage. Message ID: unknown",
@@ -23,7 +23,7 @@ describe("formatOutboundDeliverySummary", () => {
messageId: "m1",
chatId: "c1",
}),
).toBe("✅ Sent via telegram. Message ID: m1 (chat c1)");
).toBe("✅ Sent via Telegram. Message ID: m1 (chat c1)");
expect(
formatOutboundDeliverySummary("discord", {
@@ -31,7 +31,7 @@ describe("formatOutboundDeliverySummary", () => {
messageId: "d1",
channelId: "chan",
}),
).toBe("✅ Sent via discord. Message ID: d1 (channel chan)");
).toBe("✅ Sent via Discord. Message ID: d1 (channel chan)");
});
});

9
src/infra/outbound/format.ts
View File

@@ -1,3 +1,5 @@
import { getProviderPlugin } from "../../providers/plugins/index.js";
import type { ProviderId } from "../../providers/plugins/types.js";
import type { OutboundDeliveryResult } from "./deliver.js";
export type OutboundDeliveryJson = {
@@ -11,6 +13,7 @@ export type OutboundDeliveryJson = {
conversationId?: string;
timestamp?: number;
toJid?: string;
meta?: Record<string, unknown>;
};
type OutboundDeliveryMeta = {
@@ -20,10 +23,11 @@ type OutboundDeliveryMeta = {
conversationId?: string;
timestamp?: number;
toJid?: string;
meta?: Record<string, unknown>;
};
const resolveProviderLabel = (provider: string) =>
provider === "imessage" ? "iMessage" : provider;
getProviderPlugin(provider as ProviderId)?.meta.label ?? provider;
export function formatOutboundDeliverySummary(
provider: string,
@@ -79,6 +83,9 @@ export function buildOutboundDeliveryJson(params: {
if (result && "toJid" in result && result.toJid !== undefined) {
payload.toJid = result.toJid;
}
if (result && "meta" in result && result.meta !== undefined) {
payload.meta = result.meta;
}
return payload;
}

83
src/infra/outbound/message.ts
View File

@@ -3,22 +3,33 @@ import { loadConfig } from "../../config/config.js";
import { callGateway, randomIdempotencyKey } from "../../gateway/call.js";
import type { PollInput } from "../../polls.js";
import { normalizePollInput } from "../../polls.js";
import { normalizeMessageProvider } from "../../utils/message-provider.js";
import {
getProviderPlugin,
normalizeProviderId,
} from "../../providers/plugins/index.js";
import type { ProviderId } from "../../providers/plugins/types.js";
import {
GATEWAY_CLIENT_MODES,
GATEWAY_CLIENT_NAMES,
type GatewayClientMode,
type GatewayClientName,
} from "../../utils/message-provider.js";
import {
deliverOutboundPayloads,
type OutboundDeliveryResult,
type OutboundSendDeps,
} from "./deliver.js";
import { resolveMessageProviderSelection } from "./provider-selection.js";
import type { OutboundProvider } from "./targets.js";
import { resolveOutboundTarget } from "./targets.js";
type GatewayCallMode = "cli" | "agent";
export type MessageGatewayOptions = {
url?: string;
token?: string;
timeoutMs?: number;
clientName?: GatewayCallMode;
mode?: GatewayCallMode;
clientName?: GatewayClientName;
clientDisplayName?: string;
mode?: GatewayClientMode;
};
type MessageSendParams = {
@@ -84,47 +95,56 @@ function resolveGatewayOptions(opts?: MessageGatewayOptions) {
typeof opts?.timeoutMs === "number" && Number.isFinite(opts.timeoutMs)
? Math.max(1, Math.floor(opts.timeoutMs))
: 10_000,
clientName: opts?.clientName ?? "cli",
mode: opts?.mode ?? "cli",
clientName: opts?.clientName ?? GATEWAY_CLIENT_NAMES.CLI,
clientDisplayName: opts?.clientDisplayName,
mode: opts?.mode ?? GATEWAY_CLIENT_MODES.CLI,
};
}
export async function sendMessage(
params: MessageSendParams,
): Promise<MessageSendResult> {
const provider = normalizeMessageProvider(params.provider) ?? "whatsapp";
const cfg = params.cfg ?? loadConfig();
const provider = params.provider?.trim()
? normalizeProviderId(params.provider)
: (await resolveMessageProviderSelection({ cfg })).provider;
if (!provider) {
throw new Error(`Unknown provider: ${params.provider}`);
}
const plugin = getProviderPlugin(provider as ProviderId);
if (!plugin) {
throw new Error(`Unknown provider: ${provider}`);
}
const deliveryMode = plugin.outbound?.deliveryMode ?? "direct";
if (params.dryRun) {
return {
provider,
to: params.to,
via: provider === "whatsapp" ? "gateway" : "direct",
via: deliveryMode === "gateway" ? "gateway" : "direct",
mediaUrl: params.mediaUrl ?? null,
dryRun: true,
};
}
if (
provider === "telegram" ||
provider === "discord" ||
provider === "slack" ||
provider === "signal" ||
provider === "imessage" ||
provider === "msteams"
) {
if (deliveryMode !== "gateway") {
const outboundProvider = provider as Exclude<OutboundProvider, "none">;
const resolvedTarget = resolveOutboundTarget({
provider,
provider: outboundProvider,
to: params.to,
cfg,
accountId: params.accountId,
mode: "explicit",
});
if (!resolvedTarget.ok) throw resolvedTarget.error;
const results = await deliverOutboundPayloads({
cfg,
provider,
provider: outboundProvider,
to: resolvedTarget.to,
accountId: params.accountId,
payloads: [{ text: params.content, mediaUrl: params.mediaUrl }],
gifPlayback: params.gifPlayback,
deps: params.deps,
bestEffort: params.bestEffort,
});
@@ -154,6 +174,7 @@ export async function sendMessage(
},
timeoutMs: gateway.timeoutMs,
clientName: gateway.clientName,
clientDisplayName: gateway.clientDisplayName,
mode: gateway.mode,
});
@@ -169,13 +190,12 @@ export async function sendMessage(
export async function sendPoll(
params: MessagePollParams,
): Promise<MessagePollResult> {
const provider = normalizeMessageProvider(params.provider) ?? "whatsapp";
if (
provider !== "whatsapp" &&
provider !== "discord" &&
provider !== "msteams"
) {
throw new Error(`Unsupported poll provider: ${provider}`);
const cfg = params.cfg ?? loadConfig();
const provider = params.provider?.trim()
? normalizeProviderId(params.provider)
: (await resolveMessageProviderSelection({ cfg })).provider;
if (!provider) {
throw new Error(`Unknown provider: ${params.provider}`);
}
const pollInput: PollInput = {
@@ -184,8 +204,14 @@ export async function sendPoll(
maxSelections: params.maxSelections,
durationHours: params.durationHours,
};
const maxOptions = provider === "discord" ? 10 : 12;
const normalized = normalizePollInput(pollInput, { maxOptions });
const plugin = getProviderPlugin(provider as ProviderId);
const outbound = plugin?.outbound;
if (!outbound?.sendPoll) {
throw new Error(`Unsupported poll provider: ${provider}`);
}
const normalized = outbound.pollMaxOptions
? normalizePollInput(pollInput, { maxOptions: outbound.pollMaxOptions })
: normalizePollInput(pollInput);
if (params.dryRun) {
return {
@@ -222,6 +248,7 @@ export async function sendPoll(
},
timeoutMs: gateway.timeoutMs,
clientName: gateway.clientName,
clientDisplayName: gateway.clientDisplayName,
mode: gateway.mode,
});

88
src/infra/outbound/provider-selection.ts
View File

@@ -1,20 +1,11 @@
import type { ClawdbotConfig } from "../../config/config.js";
import { listEnabledDiscordAccounts } from "../../discord/accounts.js";
import { listEnabledIMessageAccounts } from "../../imessage/accounts.js";
import { resolveMSTeamsCredentials } from "../../msteams/token.js";
import { listEnabledSignalAccounts } from "../../signal/accounts.js";
import { listEnabledSlackAccounts } from "../../slack/accounts.js";
import { listEnabledTelegramAccounts } from "../../telegram/accounts.js";
import { listProviderPlugins } from "../../providers/plugins/index.js";
import type { ProviderPlugin } from "../../providers/plugins/types.js";
import {
DELIVERABLE_MESSAGE_PROVIDERS,
type DeliverableMessageProvider,
normalizeMessageProvider,
} from "../../utils/message-provider.js";
import {
listEnabledWhatsAppAccounts,
resolveWhatsAppAccount,
} from "../../web/accounts.js";
import { webAuthExists } from "../../web/session.js";
export type MessageProviderId = DeliverableMessageProvider;
@@ -24,60 +15,43 @@ function isKnownProvider(value: string): value is MessageProviderId {
return (MESSAGE_PROVIDERS as readonly string[]).includes(value);
}
async function isWhatsAppConfigured(cfg: ClawdbotConfig): Promise<boolean> {
const accounts = listEnabledWhatsAppAccounts(cfg);
if (accounts.length === 0) {
const fallback = resolveWhatsAppAccount({ cfg });
return await webAuthExists(fallback.authDir);
}
for (const account of accounts) {
if (await webAuthExists(account.authDir)) return true;
function isAccountEnabled(account: unknown): boolean {
if (!account || typeof account !== "object") return true;
const enabled = (account as { enabled?: boolean }).enabled;
return enabled !== false;
}
async function isPluginConfigured(
plugin: ProviderPlugin,
cfg: ClawdbotConfig,
): Promise<boolean> {
const accountIds = plugin.config.listAccountIds(cfg);
if (accountIds.length === 0) return false;
for (const accountId of accountIds) {
const account = plugin.config.resolveAccount(cfg, accountId);
const enabled = plugin.config.isEnabled
? plugin.config.isEnabled(account, cfg)
: isAccountEnabled(account);
if (!enabled) continue;
if (!plugin.config.isConfigured) return true;
const configured = await plugin.config.isConfigured(account, cfg);
if (configured) return true;
}
return false;
}
function isTelegramConfigured(cfg: ClawdbotConfig): boolean {
return listEnabledTelegramAccounts(cfg).some(
(account) => account.token.trim().length > 0,
);
}
function isDiscordConfigured(cfg: ClawdbotConfig): boolean {
return listEnabledDiscordAccounts(cfg).some(
(account) => account.token.trim().length > 0,
);
}
function isSlackConfigured(cfg: ClawdbotConfig): boolean {
return listEnabledSlackAccounts(cfg).some(
(account) => (account.botToken ?? "").trim().length > 0,
);
}
function isSignalConfigured(cfg: ClawdbotConfig): boolean {
return listEnabledSignalAccounts(cfg).some((account) => account.configured);
}
function isIMessageConfigured(cfg: ClawdbotConfig): boolean {
return listEnabledIMessageAccounts(cfg).some((account) => account.configured);
}
function isMSTeamsConfigured(cfg: ClawdbotConfig): boolean {
if (!cfg.msteams || cfg.msteams.enabled === false) return false;
return Boolean(resolveMSTeamsCredentials(cfg.msteams));
}
export async function listConfiguredMessageProviders(
cfg: ClawdbotConfig,
): Promise<MessageProviderId[]> {
const providers: MessageProviderId[] = [];
if (await isWhatsAppConfigured(cfg)) providers.push("whatsapp");
if (isTelegramConfigured(cfg)) providers.push("telegram");
if (isDiscordConfigured(cfg)) providers.push("discord");
if (isSlackConfigured(cfg)) providers.push("slack");
if (isSignalConfigured(cfg)) providers.push("signal");
if (isIMessageConfigured(cfg)) providers.push("imessage");
if (isMSTeamsConfigured(cfg)) providers.push("msteams");
for (const plugin of listProviderPlugins()) {
if (!isKnownProvider(plugin.id)) continue;
if (await isPluginConfigured(plugin, cfg)) {
providers.push(plugin.id);
}
}
return providers;
}

12
src/infra/outbound/targets.test.ts
View File

@@ -1,8 +1,20 @@
import { describe, expect, it } from "vitest";
import type { ClawdbotConfig } from "../../config/config.js";
import { resolveOutboundTarget } from "./targets.js";
describe("resolveOutboundTarget", () => {
it("falls back to whatsapp allowFrom via config", () => {
const cfg: ClawdbotConfig = { whatsapp: { allowFrom: ["+1555"] } };
const res = resolveOutboundTarget({
provider: "whatsapp",
to: "",
cfg,
mode: "explicit",
});
expect(res).toEqual({ ok: true, to: "+1555" });
});
it.each([
{
name: "normalizes whatsapp target when provided",

260
src/infra/outbound/targets.ts
View File

@@ -1,14 +1,18 @@
import type { ClawdbotConfig } from "../../config/config.js";
import type { SessionEntry } from "../../config/sessions.js";
import {
getProviderPlugin,
normalizeProviderId,
} from "../../providers/plugins/index.js";
import type {
ProviderId,
ProviderOutboundTargetMode,
} from "../../providers/plugins/types.js";
import type {
DeliverableMessageProvider,
GatewayMessageProvider,
} from "../../utils/message-provider.js";
import { normalizeE164 } from "../../utils.js";
import {
isWhatsAppGroupJid,
normalizeWhatsAppTarget,
} from "../../whatsapp/normalize.js";
import { INTERNAL_MESSAGE_PROVIDER } from "../../utils/message-provider.js";
export type OutboundProvider = DeliverableMessageProvider | "none";
@@ -24,117 +28,60 @@ export type OutboundTargetResolution =
| { ok: true; to: string }
| { ok: false; error: Error };
export function normalizeOutboundTarget(params: {
provider: GatewayMessageProvider;
to?: string;
allowFrom?: string[];
}): OutboundTargetResolution {
const trimmed = params.to?.trim() || "";
if (params.provider === "whatsapp") {
if (trimmed) {
const normalized = normalizeWhatsAppTarget(trimmed);
if (!normalized) {
return {
ok: false,
error: new Error(
"Delivering to WhatsApp requires --to <E.164|group JID> or whatsapp.allowFrom[0]",
),
};
}
return { ok: true, to: normalized };
}
const fallback = params.allowFrom?.[0]?.trim();
if (fallback) {
const normalized = normalizeWhatsAppTarget(fallback);
if (normalized) {
return { ok: true, to: normalized };
}
}
return {
ok: false,
error: new Error(
"Delivering to WhatsApp requires --to <E.164|group JID> or whatsapp.allowFrom[0]",
),
};
}
if (params.provider === "telegram") {
if (!trimmed) {
return {
ok: false,
error: new Error("Delivering to Telegram requires --to <chatId>"),
};
}
return { ok: true, to: trimmed };
}
if (params.provider === "discord") {
if (!trimmed) {
return {
ok: false,
error: new Error(
"Delivering to Discord requires --to <channelId|user:ID|channel:ID>",
),
};
}
return { ok: true, to: trimmed };
}
if (params.provider === "slack") {
if (!trimmed) {
return {
ok: false,
error: new Error(
"Delivering to Slack requires --to <channelId|user:ID|channel:ID>",
),
};
}
return { ok: true, to: trimmed };
}
if (params.provider === "signal") {
if (!trimmed) {
return {
ok: false,
error: new Error(
"Delivering to Signal requires --to <E.164|group:ID|signal:group:ID|signal:+E.164>",
),
};
}
return { ok: true, to: trimmed };
}
if (params.provider === "imessage") {
if (!trimmed) {
return {
ok: false,
error: new Error(
"Delivering to iMessage requires --to <handle|chat_id:ID>",
),
};
}
return { ok: true, to: trimmed };
}
if (params.provider === "msteams") {
if (!trimmed) {
return {
ok: false,
error: new Error(
"Delivering to MS Teams requires --to <conversationId|user:ID|conversation:ID>",
),
};
}
return { ok: true, to: trimmed };
}
return {
ok: false,
error: new Error(
"Delivering to WebChat is not supported via `clawdbot agent`; use WhatsApp/Telegram or run with --deliver=false.",
),
};
}
// Provider docking: prefer plugin.outbound.resolveTarget + allowFrom to normalize destinations.
export function resolveOutboundTarget(params: {
provider: GatewayMessageProvider;
to?: string;
allowFrom?: string[];
cfg?: ClawdbotConfig;
accountId?: string | null;
mode?: ProviderOutboundTargetMode;
}): OutboundTargetResolution {
return normalizeOutboundTarget(params);
if (params.provider === INTERNAL_MESSAGE_PROVIDER) {
return {
ok: false,
error: new Error(
"Delivering to WebChat is not supported via `clawdbot agent`; use WhatsApp/Telegram or run with --deliver=false.",
),
};
}
const plugin = getProviderPlugin(params.provider as ProviderId);
if (!plugin) {
return {
ok: false,
error: new Error(`Unsupported provider: ${params.provider}`),
};
}
const allowFrom =
params.allowFrom ??
(params.cfg && plugin.config.resolveAllowFrom
? plugin.config.resolveAllowFrom({
cfg: params.cfg,
accountId: params.accountId ?? undefined,
})
: undefined);
const resolveTarget = plugin.outbound?.resolveTarget;
if (resolveTarget) {
return resolveTarget({
cfg: params.cfg,
to: params.to,
allowFrom,
accountId: params.accountId ?? undefined,
mode: params.mode ?? "explicit",
});
}
const trimmed = params.to?.trim();
if (trimmed) {
return { ok: true, to: trimmed };
}
return {
ok: false,
error: new Error(`Delivering to ${plugin.meta.label} requires --to`),
};
}
export function resolveHeartbeatDeliveryTarget(params: {
@@ -143,18 +90,14 @@ export function resolveHeartbeatDeliveryTarget(params: {
}): OutboundTarget {
const { cfg, entry } = params;
const rawTarget = cfg.agents?.defaults?.heartbeat?.target;
const target: HeartbeatTarget =
rawTarget === "whatsapp" ||
rawTarget === "telegram" ||
rawTarget === "discord" ||
rawTarget === "slack" ||
rawTarget === "signal" ||
rawTarget === "imessage" ||
rawTarget === "msteams" ||
rawTarget === "none" ||
rawTarget === "last"
? rawTarget
: "last";
let target: HeartbeatTarget = "last";
if (rawTarget === "none" || rawTarget === "last") {
target = rawTarget;
} else if (typeof rawTarget === "string") {
const normalized = normalizeProviderId(rawTarget);
if (normalized) target = normalized;
}
if (target === "none") {
return { provider: "none", reason: "target-none" };
}
@@ -166,31 +109,11 @@ export function resolveHeartbeatDeliveryTarget(params: {
: undefined;
const lastProvider =
entry?.lastProvider && entry.lastProvider !== "webchat"
? entry.lastProvider
entry?.lastProvider && entry.lastProvider !== INTERNAL_MESSAGE_PROVIDER
? normalizeProviderId(entry.lastProvider)
: undefined;
const lastTo = typeof entry?.lastTo === "string" ? entry.lastTo.trim() : "";
const provider:
| "whatsapp"
| "telegram"
| "discord"
| "slack"
| "signal"
| "imessage"
| "msteams"
| undefined =
target === "last"
? lastProvider
: target === "whatsapp" ||
target === "telegram" ||
target === "discord" ||
target === "slack" ||
target === "signal" ||
target === "imessage" ||
target === "msteams"
? target
: undefined;
const provider = target === "last" ? lastProvider : target;
const to =
explicitTo ||
@@ -201,28 +124,35 @@ export function resolveHeartbeatDeliveryTarget(params: {
return { provider: "none", reason: "no-target" };
}
if (provider !== "whatsapp") {
const resolved = normalizeOutboundTarget({ provider, to });
return resolved.ok
? { provider, to: resolved.to }
: { provider: "none", reason: "no-target" };
}
const rawAllow = cfg.whatsapp?.allowFrom ?? [];
const resolved = normalizeOutboundTarget({
provider: "whatsapp",
const accountId =
provider === lastProvider ? entry?.lastAccountId : undefined;
const resolved = resolveOutboundTarget({
provider,
to,
allowFrom: rawAllow,
cfg,
accountId,
mode: "heartbeat",
});
if (!resolved.ok) {
return { provider: "none", reason: "no-target" };
}
if (rawAllow.includes("*")) return { provider, to: resolved.to };
if (isWhatsAppGroupJid(resolved.to)) return { provider, to: resolved.to };
const allowFrom = rawAllow
.map((val) => normalizeE164(val))
.filter((val) => val.length > 1);
if (allowFrom.length === 0) return { provider, to: resolved.to };
if (allowFrom.includes(resolved.to)) return { provider, to: resolved.to };
return { provider, to: allowFrom[0], reason: "allowFrom-fallback" };
let reason: string | undefined;
const plugin = getProviderPlugin(provider as ProviderId);
if (plugin?.config.resolveAllowFrom) {
const explicit = resolveOutboundTarget({
provider,
to,
cfg,
accountId,
mode: "explicit",
});
if (explicit.ok && explicit.to !== resolved.to) {
reason = "allowFrom-fallback";
}
}
return reason
? { provider, to: resolved.to, reason }
: { provider, to: resolved.to };
}