* 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>
353 lines
9.9 KiB
TypeScript
353 lines
9.9 KiB
TypeScript
import fs from 'fs';
|
|
import os from 'os';
|
|
import path from 'path';
|
|
|
|
import { google, gmail_v1 } from 'googleapis';
|
|
import { OAuth2Client } from 'google-auth-library';
|
|
|
|
// isMain flag is used instead of MAIN_GROUP_FOLDER constant
|
|
import { logger } from '../logger.js';
|
|
import { registerChannel, ChannelOpts } from './registry.js';
|
|
import {
|
|
Channel,
|
|
OnChatMetadata,
|
|
OnInboundMessage,
|
|
RegisteredGroup,
|
|
} from '../types.js';
|
|
|
|
export interface GmailChannelOpts {
|
|
onMessage: OnInboundMessage;
|
|
onChatMetadata: OnChatMetadata;
|
|
registeredGroups: () => Record<string, RegisteredGroup>;
|
|
}
|
|
|
|
interface ThreadMeta {
|
|
sender: string;
|
|
senderName: string;
|
|
subject: string;
|
|
messageId: string; // RFC 2822 Message-ID for In-Reply-To
|
|
}
|
|
|
|
export class GmailChannel implements Channel {
|
|
name = 'gmail';
|
|
|
|
private oauth2Client: OAuth2Client | null = null;
|
|
private gmail: gmail_v1.Gmail | null = null;
|
|
private opts: GmailChannelOpts;
|
|
private pollIntervalMs: number;
|
|
private pollTimer: ReturnType<typeof setTimeout> | null = null;
|
|
private processedIds = new Set<string>();
|
|
private threadMeta = new Map<string, ThreadMeta>();
|
|
private consecutiveErrors = 0;
|
|
private userEmail = '';
|
|
|
|
constructor(opts: GmailChannelOpts, pollIntervalMs = 60000) {
|
|
this.opts = opts;
|
|
this.pollIntervalMs = pollIntervalMs;
|
|
}
|
|
|
|
async connect(): Promise<void> {
|
|
const credDir = path.join(os.homedir(), '.gmail-mcp');
|
|
const keysPath = path.join(credDir, 'gcp-oauth.keys.json');
|
|
const tokensPath = path.join(credDir, 'credentials.json');
|
|
|
|
if (!fs.existsSync(keysPath) || !fs.existsSync(tokensPath)) {
|
|
logger.warn(
|
|
'Gmail credentials not found in ~/.gmail-mcp/. Skipping Gmail channel. Run /add-gmail to set up.',
|
|
);
|
|
return;
|
|
}
|
|
|
|
const keys = JSON.parse(fs.readFileSync(keysPath, 'utf-8'));
|
|
const tokens = JSON.parse(fs.readFileSync(tokensPath, 'utf-8'));
|
|
|
|
const clientConfig = keys.installed || keys.web || keys;
|
|
const { client_id, client_secret, redirect_uris } = clientConfig;
|
|
this.oauth2Client = new google.auth.OAuth2(
|
|
client_id,
|
|
client_secret,
|
|
redirect_uris?.[0],
|
|
);
|
|
this.oauth2Client.setCredentials(tokens);
|
|
|
|
// Persist refreshed tokens
|
|
this.oauth2Client.on('tokens', (newTokens) => {
|
|
try {
|
|
const current = JSON.parse(fs.readFileSync(tokensPath, 'utf-8'));
|
|
Object.assign(current, newTokens);
|
|
fs.writeFileSync(tokensPath, JSON.stringify(current, null, 2));
|
|
logger.debug('Gmail OAuth tokens refreshed');
|
|
} catch (err) {
|
|
logger.warn({ err }, 'Failed to persist refreshed Gmail tokens');
|
|
}
|
|
});
|
|
|
|
this.gmail = google.gmail({ version: 'v1', auth: this.oauth2Client });
|
|
|
|
// Verify connection
|
|
const profile = await this.gmail.users.getProfile({ userId: 'me' });
|
|
this.userEmail = profile.data.emailAddress || '';
|
|
logger.info({ email: this.userEmail }, 'Gmail channel connected');
|
|
|
|
// Start polling with error backoff
|
|
const schedulePoll = () => {
|
|
const backoffMs = this.consecutiveErrors > 0
|
|
? Math.min(this.pollIntervalMs * Math.pow(2, this.consecutiveErrors), 30 * 60 * 1000)
|
|
: this.pollIntervalMs;
|
|
this.pollTimer = setTimeout(() => {
|
|
this.pollForMessages()
|
|
.catch((err) => logger.error({ err }, 'Gmail poll error'))
|
|
.finally(() => {
|
|
if (this.gmail) schedulePoll();
|
|
});
|
|
}, backoffMs);
|
|
};
|
|
|
|
// Initial poll
|
|
await this.pollForMessages();
|
|
schedulePoll();
|
|
}
|
|
|
|
async sendMessage(jid: string, text: string): Promise<void> {
|
|
if (!this.gmail) {
|
|
logger.warn('Gmail not initialized');
|
|
return;
|
|
}
|
|
|
|
const threadId = jid.replace(/^gmail:/, '');
|
|
const meta = this.threadMeta.get(threadId);
|
|
|
|
if (!meta) {
|
|
logger.warn({ jid }, 'No thread metadata for reply, cannot send');
|
|
return;
|
|
}
|
|
|
|
const subject = meta.subject.startsWith('Re:')
|
|
? meta.subject
|
|
: `Re: ${meta.subject}`;
|
|
|
|
const headers = [
|
|
`To: ${meta.sender}`,
|
|
`From: ${this.userEmail}`,
|
|
`Subject: ${subject}`,
|
|
`In-Reply-To: ${meta.messageId}`,
|
|
`References: ${meta.messageId}`,
|
|
'Content-Type: text/plain; charset=utf-8',
|
|
'',
|
|
text,
|
|
].join('\r\n');
|
|
|
|
const encodedMessage = Buffer.from(headers)
|
|
.toString('base64')
|
|
.replace(/\+/g, '-')
|
|
.replace(/\//g, '_')
|
|
.replace(/=+$/, '');
|
|
|
|
try {
|
|
await this.gmail.users.messages.send({
|
|
userId: 'me',
|
|
requestBody: {
|
|
raw: encodedMessage,
|
|
threadId,
|
|
},
|
|
});
|
|
logger.info({ to: meta.sender, threadId }, 'Gmail reply sent');
|
|
} catch (err) {
|
|
logger.error({ jid, err }, 'Failed to send Gmail reply');
|
|
}
|
|
}
|
|
|
|
isConnected(): boolean {
|
|
return this.gmail !== null;
|
|
}
|
|
|
|
ownsJid(jid: string): boolean {
|
|
return jid.startsWith('gmail:');
|
|
}
|
|
|
|
async disconnect(): Promise<void> {
|
|
if (this.pollTimer) {
|
|
clearTimeout(this.pollTimer);
|
|
this.pollTimer = null;
|
|
}
|
|
this.gmail = null;
|
|
this.oauth2Client = null;
|
|
logger.info('Gmail channel stopped');
|
|
}
|
|
|
|
// --- Private ---
|
|
|
|
private buildQuery(): string {
|
|
return 'is:unread category:primary';
|
|
}
|
|
|
|
private async pollForMessages(): Promise<void> {
|
|
if (!this.gmail) return;
|
|
|
|
try {
|
|
const query = this.buildQuery();
|
|
const res = await this.gmail.users.messages.list({
|
|
userId: 'me',
|
|
q: query,
|
|
maxResults: 10,
|
|
});
|
|
|
|
const messages = res.data.messages || [];
|
|
|
|
for (const stub of messages) {
|
|
if (!stub.id || this.processedIds.has(stub.id)) continue;
|
|
this.processedIds.add(stub.id);
|
|
|
|
await this.processMessage(stub.id);
|
|
}
|
|
|
|
// Cap processed ID set to prevent unbounded growth
|
|
if (this.processedIds.size > 5000) {
|
|
const ids = [...this.processedIds];
|
|
this.processedIds = new Set(ids.slice(ids.length - 2500));
|
|
}
|
|
|
|
this.consecutiveErrors = 0;
|
|
} catch (err) {
|
|
this.consecutiveErrors++;
|
|
const backoffMs = Math.min(this.pollIntervalMs * Math.pow(2, this.consecutiveErrors), 30 * 60 * 1000);
|
|
logger.error({ err, consecutiveErrors: this.consecutiveErrors, nextPollMs: backoffMs }, 'Gmail poll failed');
|
|
}
|
|
}
|
|
|
|
private async processMessage(messageId: string): Promise<void> {
|
|
if (!this.gmail) return;
|
|
|
|
const msg = await this.gmail.users.messages.get({
|
|
userId: 'me',
|
|
id: messageId,
|
|
format: 'full',
|
|
});
|
|
|
|
const headers = msg.data.payload?.headers || [];
|
|
const getHeader = (name: string) =>
|
|
headers.find((h) => h.name?.toLowerCase() === name.toLowerCase())
|
|
?.value || '';
|
|
|
|
const from = getHeader('From');
|
|
const subject = getHeader('Subject');
|
|
const rfc2822MessageId = getHeader('Message-ID');
|
|
const threadId = msg.data.threadId || messageId;
|
|
const timestamp = new Date(
|
|
parseInt(msg.data.internalDate || '0', 10),
|
|
).toISOString();
|
|
|
|
// Extract sender name and email
|
|
const senderMatch = from.match(/^(.+?)\s*<(.+?)>$/);
|
|
const senderName = senderMatch ? senderMatch[1].replace(/"/g, '') : from;
|
|
const senderEmail = senderMatch ? senderMatch[2] : from;
|
|
|
|
// Skip emails from self (our own replies)
|
|
if (senderEmail === this.userEmail) return;
|
|
|
|
// Extract body text
|
|
const body = this.extractTextBody(msg.data.payload);
|
|
|
|
if (!body) {
|
|
logger.debug({ messageId, subject }, 'Skipping email with no text body');
|
|
return;
|
|
}
|
|
|
|
const chatJid = `gmail:${threadId}`;
|
|
|
|
// Cache thread metadata for replies
|
|
this.threadMeta.set(threadId, {
|
|
sender: senderEmail,
|
|
senderName,
|
|
subject,
|
|
messageId: rfc2822MessageId,
|
|
});
|
|
|
|
// Store chat metadata for group discovery
|
|
this.opts.onChatMetadata(chatJid, timestamp, subject, 'gmail', false);
|
|
|
|
// Find the main group to deliver the email notification
|
|
const groups = this.opts.registeredGroups();
|
|
const mainEntry = Object.entries(groups).find(
|
|
([, g]) => g.isMain === true,
|
|
);
|
|
|
|
if (!mainEntry) {
|
|
logger.debug(
|
|
{ chatJid, subject },
|
|
'No main group registered, skipping email',
|
|
);
|
|
return;
|
|
}
|
|
|
|
const mainJid = mainEntry[0];
|
|
const content = `[Email from ${senderName} <${senderEmail}>]\nSubject: ${subject}\n\n${body}`;
|
|
|
|
this.opts.onMessage(mainJid, {
|
|
id: messageId,
|
|
chat_jid: mainJid,
|
|
sender: senderEmail,
|
|
sender_name: senderName,
|
|
content,
|
|
timestamp,
|
|
is_from_me: false,
|
|
});
|
|
|
|
// Mark as read
|
|
try {
|
|
await this.gmail.users.messages.modify({
|
|
userId: 'me',
|
|
id: messageId,
|
|
requestBody: { removeLabelIds: ['UNREAD'] },
|
|
});
|
|
} catch (err) {
|
|
logger.warn({ messageId, err }, 'Failed to mark email as read');
|
|
}
|
|
|
|
logger.info(
|
|
{ mainJid, from: senderName, subject },
|
|
'Gmail email delivered to main group',
|
|
);
|
|
}
|
|
|
|
private extractTextBody(
|
|
payload: gmail_v1.Schema$MessagePart | undefined,
|
|
): string {
|
|
if (!payload) return '';
|
|
|
|
// Direct text/plain body
|
|
if (payload.mimeType === 'text/plain' && payload.body?.data) {
|
|
return Buffer.from(payload.body.data, 'base64').toString('utf-8');
|
|
}
|
|
|
|
// Multipart: search parts recursively
|
|
if (payload.parts) {
|
|
// Prefer text/plain
|
|
for (const part of payload.parts) {
|
|
if (part.mimeType === 'text/plain' && part.body?.data) {
|
|
return Buffer.from(part.body.data, 'base64').toString('utf-8');
|
|
}
|
|
}
|
|
// Recurse into nested multipart
|
|
for (const part of payload.parts) {
|
|
const text = this.extractTextBody(part);
|
|
if (text) return text;
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
}
|
|
|
|
registerChannel('gmail', (opts: ChannelOpts) => {
|
|
const credDir = path.join(os.homedir(), '.gmail-mcp');
|
|
if (
|
|
!fs.existsSync(path.join(credDir, 'gcp-oauth.keys.json')) ||
|
|
!fs.existsSync(path.join(credDir, 'credentials.json'))
|
|
) {
|
|
logger.warn('Gmail: credentials not found in ~/.gmail-mcp/');
|
|
return null;
|
|
}
|
|
return new GmailChannel(opts);
|
|
});
|