310 lines
11 KiB
TypeScript
310 lines
11 KiB
TypeScript
import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../../routing/session-key.js";
|
|
import {
|
|
listSlackAccountIds,
|
|
type ResolvedSlackAccount,
|
|
resolveDefaultSlackAccountId,
|
|
resolveSlackAccount,
|
|
} from "../../slack/accounts.js";
|
|
import { probeSlack } from "../../slack/probe.js";
|
|
import { sendMessageSlack } from "../../slack/send.js";
|
|
import { getChatChannelMeta } from "../registry.js";
|
|
import {
|
|
deleteAccountFromConfigSection,
|
|
setAccountEnabledInConfigSection,
|
|
} from "./config-helpers.js";
|
|
import { resolveSlackGroupRequireMention } from "./group-mentions.js";
|
|
import { formatPairingApproveHint } from "./helpers.js";
|
|
import { normalizeSlackMessagingTarget } from "./normalize-target.js";
|
|
import { slackOnboardingAdapter } from "./onboarding/slack.js";
|
|
import { PAIRING_APPROVED_MESSAGE } from "./pairing-message.js";
|
|
import {
|
|
applyAccountNameToChannelSection,
|
|
migrateBaseNameToDefaultAccount,
|
|
} from "./setup-helpers.js";
|
|
import { createSlackActions } from "./slack.actions.js";
|
|
import type { ChannelPlugin } from "./types.js";
|
|
|
|
const meta = getChatChannelMeta("slack");
|
|
|
|
export const slackPlugin: ChannelPlugin<ResolvedSlackAccount> = {
|
|
id: "slack",
|
|
meta: {
|
|
...meta,
|
|
},
|
|
onboarding: slackOnboardingAdapter,
|
|
pairing: {
|
|
idLabel: "slackUserId",
|
|
normalizeAllowEntry: (entry) => entry.replace(/^(slack|user):/i, ""),
|
|
notifyApproval: async ({ id }) => {
|
|
await sendMessageSlack(`user:${id}`, PAIRING_APPROVED_MESSAGE);
|
|
},
|
|
},
|
|
capabilities: {
|
|
chatTypes: ["direct", "channel", "thread"],
|
|
reactions: true,
|
|
threads: true,
|
|
media: true,
|
|
nativeCommands: true,
|
|
},
|
|
streaming: {
|
|
blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 },
|
|
},
|
|
reload: { configPrefixes: ["channels.slack"] },
|
|
config: {
|
|
listAccountIds: (cfg) => listSlackAccountIds(cfg),
|
|
resolveAccount: (cfg, accountId) => resolveSlackAccount({ cfg, accountId }),
|
|
defaultAccountId: (cfg) => resolveDefaultSlackAccountId(cfg),
|
|
setAccountEnabled: ({ cfg, accountId, enabled }) =>
|
|
setAccountEnabledInConfigSection({
|
|
cfg,
|
|
sectionKey: "slack",
|
|
accountId,
|
|
enabled,
|
|
allowTopLevel: true,
|
|
}),
|
|
deleteAccount: ({ cfg, accountId }) =>
|
|
deleteAccountFromConfigSection({
|
|
cfg,
|
|
sectionKey: "slack",
|
|
accountId,
|
|
clearBaseFields: ["botToken", "appToken", "name"],
|
|
}),
|
|
isConfigured: (account) => Boolean(account.botToken && account.appToken),
|
|
describeAccount: (account) => ({
|
|
accountId: account.accountId,
|
|
name: account.name,
|
|
enabled: account.enabled,
|
|
configured: Boolean(account.botToken && account.appToken),
|
|
botTokenSource: account.botTokenSource,
|
|
appTokenSource: account.appTokenSource,
|
|
}),
|
|
resolveAllowFrom: ({ cfg, accountId }) =>
|
|
(resolveSlackAccount({ cfg, accountId }).dm?.allowFrom ?? []).map((entry) => String(entry)),
|
|
formatAllowFrom: ({ allowFrom }) =>
|
|
allowFrom
|
|
.map((entry) => String(entry).trim())
|
|
.filter(Boolean)
|
|
.map((entry) => entry.toLowerCase()),
|
|
},
|
|
security: {
|
|
resolveDmPolicy: ({ cfg, accountId, account }) => {
|
|
const resolvedAccountId = accountId ?? account.accountId ?? DEFAULT_ACCOUNT_ID;
|
|
const useAccountPath = Boolean(cfg.channels?.slack?.accounts?.[resolvedAccountId]);
|
|
const allowFromPath = useAccountPath
|
|
? `channels.slack.accounts.${resolvedAccountId}.dm.`
|
|
: "channels.slack.dm.";
|
|
return {
|
|
policy: account.dm?.policy ?? "pairing",
|
|
allowFrom: account.dm?.allowFrom ?? [],
|
|
allowFromPath,
|
|
approveHint: formatPairingApproveHint("slack"),
|
|
normalizeEntry: (raw) => raw.replace(/^(slack|user):/i, ""),
|
|
};
|
|
},
|
|
collectWarnings: ({ account }) => {
|
|
const groupPolicy = account.config.groupPolicy ?? "allowlist";
|
|
if (groupPolicy !== "open") return [];
|
|
const channelAllowlistConfigured =
|
|
Boolean(account.config.channels) && Object.keys(account.config.channels ?? {}).length > 0;
|
|
if (channelAllowlistConfigured) {
|
|
return [
|
|
`- Slack channels: groupPolicy="open" allows any channel not explicitly denied to trigger (mention-gated). Set channels.slack.groupPolicy="allowlist" and configure channels.slack.channels.`,
|
|
];
|
|
}
|
|
return [
|
|
`- Slack channels: groupPolicy="open" with no channel allowlist; any channel can trigger (mention-gated). Set channels.slack.groupPolicy="allowlist" and configure channels.slack.channels.`,
|
|
];
|
|
},
|
|
},
|
|
groups: {
|
|
resolveRequireMention: resolveSlackGroupRequireMention,
|
|
},
|
|
threading: {
|
|
resolveReplyToMode: ({ cfg, accountId }) =>
|
|
resolveSlackAccount({ cfg, accountId }).replyToMode ?? "off",
|
|
allowTagsWhenOff: true,
|
|
buildToolContext: ({ cfg, accountId, context, hasRepliedRef }) => {
|
|
const configuredReplyToMode = resolveSlackAccount({ cfg, accountId }).replyToMode ?? "off";
|
|
const effectiveReplyToMode = context.ThreadLabel ? "all" : configuredReplyToMode;
|
|
return {
|
|
currentChannelId: context.To?.startsWith("channel:")
|
|
? context.To.slice("channel:".length)
|
|
: undefined,
|
|
currentThreadTs: context.ReplyToId,
|
|
replyToMode: effectiveReplyToMode,
|
|
hasRepliedRef,
|
|
};
|
|
},
|
|
},
|
|
messaging: {
|
|
normalizeTarget: normalizeSlackMessagingTarget,
|
|
},
|
|
actions: createSlackActions(meta.id),
|
|
setup: {
|
|
resolveAccountId: ({ accountId }) => normalizeAccountId(accountId),
|
|
applyAccountName: ({ cfg, accountId, name }) =>
|
|
applyAccountNameToChannelSection({
|
|
cfg,
|
|
channelKey: "slack",
|
|
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: "slack",
|
|
accountId,
|
|
name: input.name,
|
|
});
|
|
const next =
|
|
accountId !== DEFAULT_ACCOUNT_ID
|
|
? migrateBaseNameToDefaultAccount({
|
|
cfg: namedConfig,
|
|
channelKey: "slack",
|
|
})
|
|
: 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 } : {}),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
},
|
|
},
|
|
outbound: {
|
|
deliveryMode: "direct",
|
|
chunker: null,
|
|
textChunkLimit: 4000,
|
|
resolveTarget: ({ to }) => {
|
|
const trimmed = to?.trim();
|
|
if (!trimmed) {
|
|
return {
|
|
ok: false,
|
|
error: new Error("Delivering to Slack requires --to <channelId|user:ID|channel:ID>"),
|
|
};
|
|
}
|
|
return { ok: true, to: trimmed };
|
|
},
|
|
sendText: async ({ to, text, accountId, deps, replyToId }) => {
|
|
const send = deps?.sendSlack ?? sendMessageSlack;
|
|
const result = await send(to, text, {
|
|
threadTs: replyToId ?? undefined,
|
|
accountId: accountId ?? undefined,
|
|
});
|
|
return { channel: "slack", ...result };
|
|
},
|
|
sendMedia: async ({ to, text, mediaUrl, accountId, deps, replyToId }) => {
|
|
const send = deps?.sendSlack ?? sendMessageSlack;
|
|
const result = await send(to, text, {
|
|
mediaUrl,
|
|
threadTs: replyToId ?? undefined,
|
|
accountId: accountId ?? undefined,
|
|
});
|
|
return { channel: "slack", ...result };
|
|
},
|
|
},
|
|
status: {
|
|
defaultRuntime: {
|
|
accountId: DEFAULT_ACCOUNT_ID,
|
|
running: false,
|
|
lastStartAt: null,
|
|
lastStopAt: null,
|
|
lastError: null,
|
|
},
|
|
buildChannelSummary: ({ snapshot }) => ({
|
|
configured: snapshot.configured ?? false,
|
|
botTokenSource: snapshot.botTokenSource ?? "none",
|
|
appTokenSource: snapshot.appTokenSource ?? "none",
|
|
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 token = account.botToken?.trim();
|
|
if (!token) return { ok: false, error: "missing token" };
|
|
return await probeSlack(token, timeoutMs);
|
|
},
|
|
buildAccountSnapshot: ({ account, runtime, probe }) => {
|
|
const configured = Boolean(account.botToken && account.appToken);
|
|
return {
|
|
accountId: account.accountId,
|
|
name: account.name,
|
|
enabled: account.enabled,
|
|
configured,
|
|
botTokenSource: account.botTokenSource,
|
|
appTokenSource: account.appTokenSource,
|
|
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;
|
|
const botToken = account.botToken?.trim();
|
|
const appToken = account.appToken?.trim();
|
|
ctx.log?.info(`[${account.accountId}] starting provider`);
|
|
// Lazy import: the monitor pulls the reply pipeline; avoid ESM init cycles.
|
|
const { monitorSlackProvider } = await import("../../slack/index.js");
|
|
return monitorSlackProvider({
|
|
botToken: botToken ?? "",
|
|
appToken: appToken ?? "",
|
|
accountId: account.accountId,
|
|
config: ctx.cfg,
|
|
runtime: ctx.runtime,
|
|
abortSignal: ctx.abortSignal,
|
|
mediaMaxMb: account.config.mediaMaxMb,
|
|
slashCommand: account.config.slashCommand,
|
|
});
|
|
},
|
|
},
|
|
};
|