* refactor: implement channel architecture and dynamic setup - Introduced ChannelRegistry for dynamic channel loading - Decoupled WhatsApp from core index.ts and config.ts - Updated setup wizard to support ENABLED_CHANNELS selection - Refactored IPC and group registration to be channel-aware - Verified with 359 passing tests and clean typecheck * style: fix formatting in config.ts to pass CI * refactor(setup): full platform-agnostic transformation - Harmonized all instructional text and help prompts - Implemented conditional guards for WhatsApp-specific steps - Normalized CLI terminology across all 4 initial channels - Unified troubleshooting and verification logic - Verified 369 tests pass with clean typecheck * feat(skills): transform WhatsApp into a pluggable skill - Created .claude/skills/add-whatsapp with full 5-phase interactive setup - Fixed TS7006 'implicit any' error in IpcDeps - Added auto-creation of STORE_DIR to prevent crashes on fresh installs - Verified with 369 passing tests and clean typecheck * refactor(skills): move WhatsApp from core to pluggable skill - Move src/channels/whatsapp.ts to add-whatsapp skill add/ folder - Move src/channels/whatsapp.test.ts to skill add/ folder - Move src/whatsapp-auth.ts to skill add/ folder - Create modify/ for barrel file (src/channels/index.ts) - Create tests/ with skill package validation test - Update manifest with adds/modifies lists - Remove WhatsApp deps from core package.json (now skill-managed) - Remove WhatsApp-specific ghost language from types.ts - Update SKILL.md to reflect skill-apply workflow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): move setup/whatsapp-auth.ts into WhatsApp skill The WhatsApp auth setup step is channel-specific — move it from core to the add-whatsapp skill so core stays minimal. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): convert Telegram skill to pluggable channel pattern Replace the old direct-integration approach (modifying src/index.ts, src/config.ts, src/routing.test.ts) with self-registration via the channel registry, matching the WhatsApp skill pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(skills): fix add-whatsapp build failure and improve auth flow - Add missing @types/qrcode-terminal to manifest npm_dependencies (build failed after skill apply without it) - Make QR-browser the recommended auth method (terminal QR too small, pairing codes expire too fast) - Remove "replace vs alongside" question — channels are additive - Add pairing code retry guidance and QR-browser fallback Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: remove hardcoded WhatsApp default and stale Baileys comment - ENABLED_CHANNELS now defaults to empty (fresh installs must configure channels explicitly via /setup; existing installs already have .env) - Remove Baileys-specific comment from storeMessageDirect() in db.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): convert Discord, Slack, Gmail skills to pluggable channel pattern All channel skills now use the same self-registration pattern: - registerChannel() factory at module load time - Barrel file append (src/channels/index.ts) instead of orchestrator modifications - No more *_ONLY flags (DISCORD_ONLY, SLACK_ONLY) — use ENABLED_CHANNELS instead - Removed ~2500 lines of old modify/ files (src/index.ts, src/config.ts, src/routing.test.ts) Gmail retains its container-runner.ts and agent-runner modifications (MCP mount + server config) since those are independent of channel wiring. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor: use getRegisteredChannels instead of ENABLED_CHANNELS Remove the ENABLED_CHANNELS env var entirely. The orchestrator now iterates getRegisteredChannelNames() from the channel registry — channels self-register via barrel imports and their factories return null when credentials are missing, so unconfigured channels are skipped automatically. Deleted setup/channels.ts (and its tests) since its sole purpose was writing ENABLED_CHANNELS to .env. Refactored verify, groups, and environment setup steps to detect channels by credential presence instead of reading ENABLED_CHANNELS. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add breaking change notice and whatsapp migration instructions CHANGELOG.md documents the pluggable channel architecture shift and provides migration steps for existing WhatsApp users. CLAUDE.md updated: Quick Context reflects multi-channel architecture, Key Files lists registry.ts instead of whatsapp.ts, and a new Troubleshooting section directs users to /add-whatsapp if WhatsApp stops connecting after upgrade. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: rewrite READMEs for pluggable multi-channel architecture Reflects the architectural shift from a hardcoded WhatsApp bot to a pluggable channel platform. Adds upgrading notice, Mermaid architecture diagram, CI/License/TypeScript/PRs badges, and clarifies that slash commands run inside the Claude Code CLI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: move pluggable channel architecture details to SPEC.md Revert READMEs to original tone with only two targeted changes: - Add upgrading notice for WhatsApp breaking change - Mention pluggable channels in "What It Supports" Move Mermaid diagram, channel registry internals, factory pattern explanation, and self-registration walkthrough into docs/SPEC.md. Update stale WhatsApp-specific references in SPEC.md to be channel-agnostic. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: move upgrading notice to CHANGELOG, add changelog link Remove the "Upgrading from Pre-Pluggable Versions" section from README.md — breaking change details belong in the CHANGELOG. Add a Changelog section linking to CHANGELOG.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: expand CHANGELOG with full PR #500 changes Cover all changes: channel registry, WhatsApp moved to skill, removed core dependencies, all 5 skills simplified, orchestrator refactored, setup decoupled. Use Claude Code CLI instructions for migration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: bump version to 1.2.0 for pluggable channel architecture Minor version bump — new functionality (pluggable channels) with a managed migration path for existing WhatsApp users. Update version references in CHANGELOG and update skill. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix skill application * fix: use slotted barrel file to prevent channel merge conflicts Pre-allocate a named comment slot for each channel in src/channels/index.ts, separated by blank lines. Each skill's modify file only touches its own slot, so three-way merges never conflict when applying multiple channels. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: resolve real chat ID during setup for token-based channels Instead of registering with `pending@telegram` (which never matches incoming messages), the setup skill now runs an inline bot that waits for the user to send /chatid, capturing the real chat ID before registration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: setup delegates to channel skills, fix group sync and Discord metadata - Restructure setup SKILL.md to delegate channel setup to individual channel skills (/add-whatsapp, /add-telegram, etc.) instead of reimplementing auth/registration inline with broken placeholder JIDs - Move channel selection to step 5 where it's immediately acted on - Fix setup/groups.ts: write sync script to temp file instead of passing via node -e which broke on shell escaping of newlines - Fix Discord onChatMetadata missing channel and isGroup parameters - Add .tmp-* to .gitignore for temp sync script cleanup Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: align add-whatsapp skill with main setup patterns Add headless detection for auth method selection, structured inline error handling, dedicated number DM flow, and reorder questions to match main's trigger-first flow. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: add missing auth script to package.json The add-whatsapp skill adds src/whatsapp-auth.ts but doesn't add the corresponding npm script. Setup and SKILL.md reference `npm run auth` for WhatsApp QR terminal authentication. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: update Discord skill tests to match onChatMetadata signature The onChatMetadata callback now takes 5 arguments (jid, timestamp, name, channel, isGroup) but the Discord skill tests only expected 3. This caused skill application to roll back on test failure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: replace 'pluggable' jargon with clearer language User-facing text now says "multi-channel" or describes what it does. Developer-facing text uses "self-registering" or "channel registry". Also removes extra badge row from README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: align Chinese README with English version Remove extra badges, replace pluggable jargon, remove upgrade section (now in CHANGELOG), add missing intro line and changelog section, fix setup FAQ answer. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: warn on installed-but-unconfigured channels instead of silent skip Channels with missing credentials now emit WARN logs naming the exact missing variable, so misconfigurations surface instead of being hidden. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: simplify changelog to one-liner with compare link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: add isMain flag and channel-prefixed group folders Replace MAIN_GROUP_FOLDER constant with explicit isMain boolean on RegisteredGroup. Group folders now use channel prefix convention (e.g., whatsapp_main, telegram_family-chat) to prevent cross-channel collisions. - Add isMain to RegisteredGroup type and SQLite schema (with migration) - Replace all folder-based main group checks with group.isMain - Add --is-main flag to setup/register.ts - Strip isMain from IPC payload (defense in depth) - Update MCP tool description for channel-prefixed naming - Update all channel SKILL.md files and documentation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: gavrielc <gabicohen22@yahoo.com> Co-authored-by: Koshkoshinski <daniel.milliner@gmail.com>
301 lines
9.4 KiB
TypeScript
301 lines
9.4 KiB
TypeScript
import { App, LogLevel } from '@slack/bolt';
|
|
import type { GenericMessageEvent, BotMessageEvent } from '@slack/types';
|
|
|
|
import { ASSISTANT_NAME, TRIGGER_PATTERN } from '../config.js';
|
|
import { updateChatName } from '../db.js';
|
|
import { readEnvFile } from '../env.js';
|
|
import { logger } from '../logger.js';
|
|
import { registerChannel, ChannelOpts } from './registry.js';
|
|
import {
|
|
Channel,
|
|
OnInboundMessage,
|
|
OnChatMetadata,
|
|
RegisteredGroup,
|
|
} from '../types.js';
|
|
|
|
// Slack's chat.postMessage API limits text to ~4000 characters per call.
|
|
// Messages exceeding this are split into sequential chunks.
|
|
const MAX_MESSAGE_LENGTH = 4000;
|
|
|
|
// The message subtypes we process. Bolt delivers all subtypes via app.event('message');
|
|
// we filter to regular messages (GenericMessageEvent, subtype undefined) and bot messages
|
|
// (BotMessageEvent, subtype 'bot_message') so we can track our own output.
|
|
type HandledMessageEvent = GenericMessageEvent | BotMessageEvent;
|
|
|
|
export interface SlackChannelOpts {
|
|
onMessage: OnInboundMessage;
|
|
onChatMetadata: OnChatMetadata;
|
|
registeredGroups: () => Record<string, RegisteredGroup>;
|
|
}
|
|
|
|
export class SlackChannel implements Channel {
|
|
name = 'slack';
|
|
|
|
private app: App;
|
|
private botUserId: string | undefined;
|
|
private connected = false;
|
|
private outgoingQueue: Array<{ jid: string; text: string }> = [];
|
|
private flushing = false;
|
|
private userNameCache = new Map<string, string>();
|
|
|
|
private opts: SlackChannelOpts;
|
|
|
|
constructor(opts: SlackChannelOpts) {
|
|
this.opts = opts;
|
|
|
|
// Read tokens from .env (not process.env — keeps secrets off the environment
|
|
// so they don't leak to child processes, matching NanoClaw's security pattern)
|
|
const env = readEnvFile(['SLACK_BOT_TOKEN', 'SLACK_APP_TOKEN']);
|
|
const botToken = env.SLACK_BOT_TOKEN;
|
|
const appToken = env.SLACK_APP_TOKEN;
|
|
|
|
if (!botToken || !appToken) {
|
|
throw new Error(
|
|
'SLACK_BOT_TOKEN and SLACK_APP_TOKEN must be set in .env',
|
|
);
|
|
}
|
|
|
|
this.app = new App({
|
|
token: botToken,
|
|
appToken,
|
|
socketMode: true,
|
|
logLevel: LogLevel.ERROR,
|
|
});
|
|
|
|
this.setupEventHandlers();
|
|
}
|
|
|
|
private setupEventHandlers(): void {
|
|
// Use app.event('message') instead of app.message() to capture all
|
|
// message subtypes including bot_message (needed to track our own output)
|
|
this.app.event('message', async ({ event }) => {
|
|
// Bolt's event type is the full MessageEvent union (17+ subtypes).
|
|
// We filter on subtype first, then narrow to the two types we handle.
|
|
const subtype = (event as { subtype?: string }).subtype;
|
|
if (subtype && subtype !== 'bot_message') return;
|
|
|
|
// After filtering, event is either GenericMessageEvent or BotMessageEvent
|
|
const msg = event as HandledMessageEvent;
|
|
|
|
if (!msg.text) return;
|
|
|
|
// Threaded replies are flattened into the channel conversation.
|
|
// The agent sees them alongside channel-level messages; responses
|
|
// always go to the channel, not back into the thread.
|
|
|
|
const jid = `slack:${msg.channel}`;
|
|
const timestamp = new Date(parseFloat(msg.ts) * 1000).toISOString();
|
|
const isGroup = msg.channel_type !== 'im';
|
|
|
|
// Always report metadata for group discovery
|
|
this.opts.onChatMetadata(jid, timestamp, undefined, 'slack', isGroup);
|
|
|
|
// Only deliver full messages for registered groups
|
|
const groups = this.opts.registeredGroups();
|
|
if (!groups[jid]) return;
|
|
|
|
const isBotMessage =
|
|
!!msg.bot_id || msg.user === this.botUserId;
|
|
|
|
let senderName: string;
|
|
if (isBotMessage) {
|
|
senderName = ASSISTANT_NAME;
|
|
} else {
|
|
senderName =
|
|
(await this.resolveUserName(msg.user)) ||
|
|
msg.user ||
|
|
'unknown';
|
|
}
|
|
|
|
// Translate Slack <@UBOTID> mentions into TRIGGER_PATTERN format.
|
|
// Slack encodes @mentions as <@U12345>, which won't match TRIGGER_PATTERN
|
|
// (e.g., ^@<ASSISTANT_NAME>\b), so we prepend the trigger when the bot is @mentioned.
|
|
let content = msg.text;
|
|
if (this.botUserId && !isBotMessage) {
|
|
const mentionPattern = `<@${this.botUserId}>`;
|
|
if (content.includes(mentionPattern) && !TRIGGER_PATTERN.test(content)) {
|
|
content = `@${ASSISTANT_NAME} ${content}`;
|
|
}
|
|
}
|
|
|
|
this.opts.onMessage(jid, {
|
|
id: msg.ts,
|
|
chat_jid: jid,
|
|
sender: msg.user || msg.bot_id || '',
|
|
sender_name: senderName,
|
|
content,
|
|
timestamp,
|
|
is_from_me: isBotMessage,
|
|
is_bot_message: isBotMessage,
|
|
});
|
|
});
|
|
}
|
|
|
|
async connect(): Promise<void> {
|
|
await this.app.start();
|
|
|
|
// Get bot's own user ID for self-message detection.
|
|
// Resolve this BEFORE setting connected=true so that messages arriving
|
|
// during startup can correctly detect bot-sent messages.
|
|
try {
|
|
const auth = await this.app.client.auth.test();
|
|
this.botUserId = auth.user_id as string;
|
|
logger.info({ botUserId: this.botUserId }, 'Connected to Slack');
|
|
} catch (err) {
|
|
logger.warn(
|
|
{ err },
|
|
'Connected to Slack but failed to get bot user ID',
|
|
);
|
|
}
|
|
|
|
this.connected = true;
|
|
|
|
// Flush any messages queued before connection
|
|
await this.flushOutgoingQueue();
|
|
|
|
// Sync channel names on startup
|
|
await this.syncChannelMetadata();
|
|
}
|
|
|
|
async sendMessage(jid: string, text: string): Promise<void> {
|
|
const channelId = jid.replace(/^slack:/, '');
|
|
|
|
if (!this.connected) {
|
|
this.outgoingQueue.push({ jid, text });
|
|
logger.info(
|
|
{ jid, queueSize: this.outgoingQueue.length },
|
|
'Slack disconnected, message queued',
|
|
);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
// Slack limits messages to ~4000 characters; split if needed
|
|
if (text.length <= MAX_MESSAGE_LENGTH) {
|
|
await this.app.client.chat.postMessage({ channel: channelId, text });
|
|
} else {
|
|
for (let i = 0; i < text.length; i += MAX_MESSAGE_LENGTH) {
|
|
await this.app.client.chat.postMessage({
|
|
channel: channelId,
|
|
text: text.slice(i, i + MAX_MESSAGE_LENGTH),
|
|
});
|
|
}
|
|
}
|
|
logger.info({ jid, length: text.length }, 'Slack message sent');
|
|
} catch (err) {
|
|
this.outgoingQueue.push({ jid, text });
|
|
logger.warn(
|
|
{ jid, err, queueSize: this.outgoingQueue.length },
|
|
'Failed to send Slack message, queued',
|
|
);
|
|
}
|
|
}
|
|
|
|
isConnected(): boolean {
|
|
return this.connected;
|
|
}
|
|
|
|
ownsJid(jid: string): boolean {
|
|
return jid.startsWith('slack:');
|
|
}
|
|
|
|
async disconnect(): Promise<void> {
|
|
this.connected = false;
|
|
await this.app.stop();
|
|
}
|
|
|
|
// Slack does not expose a typing indicator API for bots.
|
|
// This no-op satisfies the Channel interface so the orchestrator
|
|
// doesn't need channel-specific branching.
|
|
async setTyping(_jid: string, _isTyping: boolean): Promise<void> {
|
|
// no-op: Slack Bot API has no typing indicator endpoint
|
|
}
|
|
|
|
/**
|
|
* Sync channel metadata from Slack.
|
|
* Fetches channels the bot is a member of and stores their names in the DB.
|
|
*/
|
|
async syncChannelMetadata(): Promise<void> {
|
|
try {
|
|
logger.info('Syncing channel metadata from Slack...');
|
|
let cursor: string | undefined;
|
|
let count = 0;
|
|
|
|
do {
|
|
const result = await this.app.client.conversations.list({
|
|
types: 'public_channel,private_channel',
|
|
exclude_archived: true,
|
|
limit: 200,
|
|
cursor,
|
|
});
|
|
|
|
for (const ch of result.channels || []) {
|
|
if (ch.id && ch.name && ch.is_member) {
|
|
updateChatName(`slack:${ch.id}`, ch.name);
|
|
count++;
|
|
}
|
|
}
|
|
|
|
cursor = result.response_metadata?.next_cursor || undefined;
|
|
} while (cursor);
|
|
|
|
logger.info({ count }, 'Slack channel metadata synced');
|
|
} catch (err) {
|
|
logger.error({ err }, 'Failed to sync Slack channel metadata');
|
|
}
|
|
}
|
|
|
|
private async resolveUserName(
|
|
userId: string,
|
|
): Promise<string | undefined> {
|
|
if (!userId) return undefined;
|
|
|
|
const cached = this.userNameCache.get(userId);
|
|
if (cached) return cached;
|
|
|
|
try {
|
|
const result = await this.app.client.users.info({ user: userId });
|
|
const name = result.user?.real_name || result.user?.name;
|
|
if (name) this.userNameCache.set(userId, name);
|
|
return name;
|
|
} catch (err) {
|
|
logger.debug({ userId, err }, 'Failed to resolve Slack user name');
|
|
return undefined;
|
|
}
|
|
}
|
|
|
|
private async flushOutgoingQueue(): Promise<void> {
|
|
if (this.flushing || this.outgoingQueue.length === 0) return;
|
|
this.flushing = true;
|
|
try {
|
|
logger.info(
|
|
{ count: this.outgoingQueue.length },
|
|
'Flushing Slack outgoing queue',
|
|
);
|
|
while (this.outgoingQueue.length > 0) {
|
|
const item = this.outgoingQueue.shift()!;
|
|
const channelId = item.jid.replace(/^slack:/, '');
|
|
await this.app.client.chat.postMessage({
|
|
channel: channelId,
|
|
text: item.text,
|
|
});
|
|
logger.info(
|
|
{ jid: item.jid, length: item.text.length },
|
|
'Queued Slack message sent',
|
|
);
|
|
}
|
|
} finally {
|
|
this.flushing = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
registerChannel('slack', (opts: ChannelOpts) => {
|
|
const envVars = readEnvFile(['SLACK_BOT_TOKEN', 'SLACK_APP_TOKEN']);
|
|
if (!envVars.SLACK_BOT_TOKEN || !envVars.SLACK_APP_TOKEN) {
|
|
logger.warn('Slack: SLACK_BOT_TOKEN or SLACK_APP_TOKEN not set');
|
|
return null;
|
|
}
|
|
return new SlackChannel(opts);
|
|
});
|