302 lines
10 KiB
TypeScript
302 lines
10 KiB
TypeScript
import {
|
|
applyAccountNameToChannelSection,
|
|
buildChannelConfigSchema,
|
|
DEFAULT_ACCOUNT_ID,
|
|
deleteAccountFromConfigSection,
|
|
formatPairingApproveHint,
|
|
getChatChannelMeta,
|
|
listSignalAccountIds,
|
|
looksLikeSignalTargetId,
|
|
migrateBaseNameToDefaultAccount,
|
|
normalizeAccountId,
|
|
normalizeE164,
|
|
normalizeSignalMessagingTarget,
|
|
PAIRING_APPROVED_MESSAGE,
|
|
resolveChannelMediaMaxBytes,
|
|
resolveDefaultSignalAccountId,
|
|
resolveSignalAccount,
|
|
setAccountEnabledInConfigSection,
|
|
signalOnboardingAdapter,
|
|
SignalConfigSchema,
|
|
type ChannelPlugin,
|
|
type ResolvedSignalAccount,
|
|
} from "clawdbot/plugin-sdk";
|
|
|
|
import { getSignalRuntime } from "./runtime.js";
|
|
|
|
const meta = getChatChannelMeta("signal");
|
|
|
|
export const signalPlugin: ChannelPlugin<ResolvedSignalAccount> = {
|
|
id: "signal",
|
|
meta: {
|
|
...meta,
|
|
},
|
|
onboarding: signalOnboardingAdapter,
|
|
pairing: {
|
|
idLabel: "signalNumber",
|
|
normalizeAllowEntry: (entry) => entry.replace(/^signal:/i, ""),
|
|
notifyApproval: async ({ id }) => {
|
|
await getSignalRuntime().channel.signal.sendMessageSignal(id, PAIRING_APPROVED_MESSAGE);
|
|
},
|
|
},
|
|
capabilities: {
|
|
chatTypes: ["direct", "group"],
|
|
media: 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,
|
|
}),
|
|
resolveAllowFrom: ({ cfg, accountId }) =>
|
|
(resolveSignalAccount({ cfg, accountId }).config.allowFrom ?? []).map((entry) =>
|
|
String(entry),
|
|
),
|
|
formatAllowFrom: ({ allowFrom }) =>
|
|
allowFrom
|
|
.map((entry) => String(entry).trim())
|
|
.filter(Boolean)
|
|
.map((entry) => (entry === "*" ? "*" : normalizeE164(entry.replace(/^signal:/i, ""))))
|
|
.filter(Boolean),
|
|
},
|
|
security: {
|
|
resolveDmPolicy: ({ cfg, accountId, account }) => {
|
|
const resolvedAccountId = accountId ?? account.accountId ?? DEFAULT_ACCOUNT_ID;
|
|
const useAccountPath = Boolean(cfg.channels?.signal?.accounts?.[resolvedAccountId]);
|
|
const basePath = useAccountPath
|
|
? `channels.signal.accounts.${resolvedAccountId}.`
|
|
: "channels.signal.";
|
|
return {
|
|
policy: account.config.dmPolicy ?? "pairing",
|
|
allowFrom: account.config.allowFrom ?? [],
|
|
policyPath: `${basePath}dmPolicy`,
|
|
allowFromPath: basePath,
|
|
approveHint: formatPairingApproveHint("signal"),
|
|
normalizeEntry: (raw) => normalizeE164(raw.replace(/^signal:/i, "").trim()),
|
|
};
|
|
},
|
|
collectWarnings: ({ account, cfg }) => {
|
|
const defaultGroupPolicy = cfg.channels?.defaults?.groupPolicy;
|
|
const groupPolicy = account.config.groupPolicy ?? defaultGroupPolicy ?? "allowlist";
|
|
if (groupPolicy !== "open") return [];
|
|
return [
|
|
`- Signal groups: groupPolicy="open" allows any member to trigger the bot. Set channels.signal.groupPolicy="allowlist" + channels.signal.groupAllowFrom to restrict senders.`,
|
|
];
|
|
},
|
|
},
|
|
messaging: {
|
|
normalizeTarget: normalizeSignalMessagingTarget,
|
|
targetResolver: {
|
|
looksLikeId: looksLikeSignalTargetId,
|
|
hint: "<E.164|group:ID|signal:group:ID|signal:+E.164>",
|
|
},
|
|
},
|
|
setup: {
|
|
resolveAccountId: ({ accountId }) => normalizeAccountId(accountId),
|
|
applyAccountName: ({ cfg, accountId, name }) =>
|
|
applyAccountNameToChannelSection({
|
|
cfg,
|
|
channelKey: "signal",
|
|
accountId,
|
|
name,
|
|
}),
|
|
validateInput: ({ input }) => {
|
|
if (
|
|
!input.signalNumber &&
|
|
!input.httpUrl &&
|
|
!input.httpHost &&
|
|
!input.httpPort &&
|
|
!input.cliPath
|
|
) {
|
|
return "Signal requires --signal-number or --http-url/--http-host/--http-port/--cli-path.";
|
|
}
|
|
return null;
|
|
},
|
|
applyAccountConfig: ({ cfg, accountId, input }) => {
|
|
const namedConfig = applyAccountNameToChannelSection({
|
|
cfg,
|
|
channelKey: "signal",
|
|
accountId,
|
|
name: input.name,
|
|
});
|
|
const next =
|
|
accountId !== DEFAULT_ACCOUNT_ID
|
|
? migrateBaseNameToDefaultAccount({
|
|
cfg: namedConfig,
|
|
channelKey: "signal",
|
|
})
|
|
: namedConfig;
|
|
if (accountId === DEFAULT_ACCOUNT_ID) {
|
|
return {
|
|
...next,
|
|
channels: {
|
|
...next.channels,
|
|
signal: {
|
|
...next.channels?.signal,
|
|
enabled: true,
|
|
...(input.signalNumber ? { account: input.signalNumber } : {}),
|
|
...(input.cliPath ? { cliPath: input.cliPath } : {}),
|
|
...(input.httpUrl ? { httpUrl: input.httpUrl } : {}),
|
|
...(input.httpHost ? { httpHost: input.httpHost } : {}),
|
|
...(input.httpPort ? { httpPort: Number(input.httpPort) } : {}),
|
|
},
|
|
},
|
|
};
|
|
}
|
|
return {
|
|
...next,
|
|
channels: {
|
|
...next.channels,
|
|
signal: {
|
|
...next.channels?.signal,
|
|
enabled: true,
|
|
accounts: {
|
|
...next.channels?.signal?.accounts,
|
|
[accountId]: {
|
|
...next.channels?.signal?.accounts?.[accountId],
|
|
enabled: true,
|
|
...(input.signalNumber ? { account: input.signalNumber } : {}),
|
|
...(input.cliPath ? { cliPath: input.cliPath } : {}),
|
|
...(input.httpUrl ? { httpUrl: input.httpUrl } : {}),
|
|
...(input.httpHost ? { httpHost: input.httpHost } : {}),
|
|
...(input.httpPort ? { httpPort: Number(input.httpPort) } : {}),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
},
|
|
},
|
|
outbound: {
|
|
deliveryMode: "direct",
|
|
chunker: (text, limit) => getSignalRuntime().channel.text.chunkText(text, limit),
|
|
textChunkLimit: 4000,
|
|
sendText: async ({ cfg, to, text, accountId, deps }) => {
|
|
const send = deps?.sendSignal ?? getSignalRuntime().channel.signal.sendMessageSignal;
|
|
const maxBytes = resolveChannelMediaMaxBytes({
|
|
cfg,
|
|
resolveChannelLimitMb: ({ cfg, accountId }) =>
|
|
cfg.channels?.signal?.accounts?.[accountId]?.mediaMaxMb ??
|
|
cfg.channels?.signal?.mediaMaxMb,
|
|
accountId,
|
|
});
|
|
const result = await send(to, text, {
|
|
maxBytes,
|
|
accountId: accountId ?? undefined,
|
|
});
|
|
return { channel: "signal", ...result };
|
|
},
|
|
sendMedia: async ({ cfg, to, text, mediaUrl, accountId, deps }) => {
|
|
const send = deps?.sendSignal ?? getSignalRuntime().channel.signal.sendMessageSignal;
|
|
const maxBytes = resolveChannelMediaMaxBytes({
|
|
cfg,
|
|
resolveChannelLimitMb: ({ cfg, accountId }) =>
|
|
cfg.channels?.signal?.accounts?.[accountId]?.mediaMaxMb ??
|
|
cfg.channels?.signal?.mediaMaxMb,
|
|
accountId,
|
|
});
|
|
const result = await send(to, text, {
|
|
mediaUrl,
|
|
maxBytes,
|
|
accountId: accountId ?? undefined,
|
|
});
|
|
return { channel: "signal", ...result };
|
|
},
|
|
},
|
|
status: {
|
|
defaultRuntime: {
|
|
accountId: DEFAULT_ACCOUNT_ID,
|
|
running: false,
|
|
lastStartAt: null,
|
|
lastStopAt: null,
|
|
lastError: null,
|
|
},
|
|
collectStatusIssues: (accounts) =>
|
|
accounts.flatMap((account) => {
|
|
const lastError = typeof account.lastError === "string" ? account.lastError.trim() : "";
|
|
if (!lastError) return [];
|
|
return [
|
|
{
|
|
channel: "signal",
|
|
accountId: account.accountId,
|
|
kind: "runtime",
|
|
message: `Channel error: ${lastError}`,
|
|
},
|
|
];
|
|
}),
|
|
buildChannelSummary: ({ snapshot }) => ({
|
|
configured: snapshot.configured ?? false,
|
|
baseUrl: snapshot.baseUrl ?? null,
|
|
running: snapshot.running ?? false,
|
|
lastStartAt: snapshot.lastStartAt ?? null,
|
|
lastStopAt: snapshot.lastStopAt ?? null,
|
|
lastError: snapshot.lastError ?? null,
|
|
probe: snapshot.probe,
|
|
lastProbeAt: snapshot.lastProbeAt ?? null,
|
|
}),
|
|
probeAccount: async ({ account, timeoutMs }) => {
|
|
const baseUrl = account.baseUrl;
|
|
return await getSignalRuntime().channel.signal.probeSignal(baseUrl, timeoutMs);
|
|
},
|
|
buildAccountSnapshot: ({ account, runtime, probe }) => ({
|
|
accountId: account.accountId,
|
|
name: account.name,
|
|
enabled: account.enabled,
|
|
configured: account.configured,
|
|
baseUrl: account.baseUrl,
|
|
running: runtime?.running ?? false,
|
|
lastStartAt: runtime?.lastStartAt ?? null,
|
|
lastStopAt: runtime?.lastStopAt ?? null,
|
|
lastError: runtime?.lastError ?? null,
|
|
probe,
|
|
lastInboundAt: runtime?.lastInboundAt ?? null,
|
|
lastOutboundAt: runtime?.lastOutboundAt ?? null,
|
|
}),
|
|
},
|
|
gateway: {
|
|
startAccount: async (ctx) => {
|
|
const account = ctx.account;
|
|
ctx.setStatus({
|
|
accountId: account.accountId,
|
|
baseUrl: account.baseUrl,
|
|
});
|
|
ctx.log?.info(`[${account.accountId}] starting provider (${account.baseUrl})`);
|
|
// Lazy import: the monitor pulls the reply pipeline; avoid ESM init cycles.
|
|
return getSignalRuntime().channel.signal.monitorSignalProvider({
|
|
accountId: account.accountId,
|
|
config: ctx.cfg,
|
|
runtime: ctx.runtime,
|
|
abortSignal: ctx.abortSignal,
|
|
mediaMaxMb: account.config.mediaMaxMb,
|
|
});
|
|
},
|
|
},
|
|
};
|