* 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>
181 lines
5.6 KiB
TypeScript
181 lines
5.6 KiB
TypeScript
/**
|
|
* WhatsApp Authentication Script
|
|
*
|
|
* Run this during setup to authenticate with WhatsApp.
|
|
* Displays QR code, waits for scan, saves credentials, then exits.
|
|
*
|
|
* Usage: npx tsx src/whatsapp-auth.ts
|
|
*/
|
|
import fs from 'fs';
|
|
import path from 'path';
|
|
import pino from 'pino';
|
|
import qrcode from 'qrcode-terminal';
|
|
import readline from 'readline';
|
|
|
|
import makeWASocket, {
|
|
Browsers,
|
|
DisconnectReason,
|
|
fetchLatestWaWebVersion,
|
|
makeCacheableSignalKeyStore,
|
|
useMultiFileAuthState,
|
|
} from '@whiskeysockets/baileys';
|
|
|
|
const AUTH_DIR = './store/auth';
|
|
const QR_FILE = './store/qr-data.txt';
|
|
const STATUS_FILE = './store/auth-status.txt';
|
|
|
|
const logger = pino({
|
|
level: 'warn', // Quiet logging - only show errors
|
|
});
|
|
|
|
// Check for --pairing-code flag and phone number
|
|
const usePairingCode = process.argv.includes('--pairing-code');
|
|
const phoneArg = process.argv.find((_, i, arr) => arr[i - 1] === '--phone');
|
|
|
|
function askQuestion(prompt: string): Promise<string> {
|
|
const rl = readline.createInterface({
|
|
input: process.stdin,
|
|
output: process.stdout,
|
|
});
|
|
return new Promise((resolve) => {
|
|
rl.question(prompt, (answer) => {
|
|
rl.close();
|
|
resolve(answer.trim());
|
|
});
|
|
});
|
|
}
|
|
|
|
async function connectSocket(
|
|
phoneNumber?: string,
|
|
isReconnect = false,
|
|
): Promise<void> {
|
|
const { state, saveCreds } = await useMultiFileAuthState(AUTH_DIR);
|
|
|
|
if (state.creds.registered && !isReconnect) {
|
|
fs.writeFileSync(STATUS_FILE, 'already_authenticated');
|
|
console.log('✓ Already authenticated with WhatsApp');
|
|
console.log(
|
|
' To re-authenticate, delete the store/auth folder and run again.',
|
|
);
|
|
process.exit(0);
|
|
}
|
|
|
|
const { version } = await fetchLatestWaWebVersion({}).catch((err) => {
|
|
logger.warn(
|
|
{ err },
|
|
'Failed to fetch latest WA Web version, using default',
|
|
);
|
|
return { version: undefined };
|
|
});
|
|
const sock = makeWASocket({
|
|
version,
|
|
auth: {
|
|
creds: state.creds,
|
|
keys: makeCacheableSignalKeyStore(state.keys, logger),
|
|
},
|
|
printQRInTerminal: false,
|
|
logger,
|
|
browser: Browsers.macOS('Chrome'),
|
|
});
|
|
|
|
if (usePairingCode && phoneNumber && !state.creds.me) {
|
|
// Request pairing code after a short delay for connection to initialize
|
|
// Only on first connect (not reconnect after 515)
|
|
setTimeout(async () => {
|
|
try {
|
|
const code = await sock.requestPairingCode(phoneNumber!);
|
|
console.log(`\n🔗 Your pairing code: ${code}\n`);
|
|
console.log(' 1. Open WhatsApp on your phone');
|
|
console.log(' 2. Tap Settings → Linked Devices → Link a Device');
|
|
console.log(' 3. Tap "Link with phone number instead"');
|
|
console.log(` 4. Enter this code: ${code}\n`);
|
|
fs.writeFileSync(STATUS_FILE, `pairing_code:${code}`);
|
|
} catch (err: any) {
|
|
console.error('Failed to request pairing code:', err.message);
|
|
process.exit(1);
|
|
}
|
|
}, 3000);
|
|
}
|
|
|
|
sock.ev.on('connection.update', (update) => {
|
|
const { connection, lastDisconnect, qr } = update;
|
|
|
|
if (qr) {
|
|
// Write raw QR data to file so the setup skill can render it
|
|
fs.writeFileSync(QR_FILE, qr);
|
|
console.log('Scan this QR code with WhatsApp:\n');
|
|
console.log(' 1. Open WhatsApp on your phone');
|
|
console.log(' 2. Tap Settings → Linked Devices → Link a Device');
|
|
console.log(' 3. Point your camera at the QR code below\n');
|
|
qrcode.generate(qr, { small: true });
|
|
}
|
|
|
|
if (connection === 'close') {
|
|
const reason = (lastDisconnect?.error as any)?.output?.statusCode;
|
|
|
|
if (reason === DisconnectReason.loggedOut) {
|
|
fs.writeFileSync(STATUS_FILE, 'failed:logged_out');
|
|
console.log('\n✗ Logged out. Delete store/auth and try again.');
|
|
process.exit(1);
|
|
} else if (reason === DisconnectReason.timedOut) {
|
|
fs.writeFileSync(STATUS_FILE, 'failed:qr_timeout');
|
|
console.log('\n✗ QR code timed out. Please try again.');
|
|
process.exit(1);
|
|
} else if (reason === 515) {
|
|
// 515 = stream error, often happens after pairing succeeds but before
|
|
// registration completes. Reconnect to finish the handshake.
|
|
console.log('\n⟳ Stream error (515) after pairing — reconnecting...');
|
|
connectSocket(phoneNumber, true);
|
|
} else {
|
|
fs.writeFileSync(STATUS_FILE, `failed:${reason || 'unknown'}`);
|
|
console.log('\n✗ Connection failed. Please try again.');
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
if (connection === 'open') {
|
|
fs.writeFileSync(STATUS_FILE, 'authenticated');
|
|
// Clean up QR file now that we're connected
|
|
try {
|
|
fs.unlinkSync(QR_FILE);
|
|
} catch {}
|
|
console.log('\n✓ Successfully authenticated with WhatsApp!');
|
|
console.log(' Credentials saved to store/auth/');
|
|
console.log(' You can now start the NanoClaw service.\n');
|
|
|
|
// Give it a moment to save credentials, then exit
|
|
setTimeout(() => process.exit(0), 1000);
|
|
}
|
|
});
|
|
|
|
sock.ev.on('creds.update', saveCreds);
|
|
}
|
|
|
|
async function authenticate(): Promise<void> {
|
|
fs.mkdirSync(AUTH_DIR, { recursive: true });
|
|
|
|
// Clean up any stale QR/status files from previous runs
|
|
try {
|
|
fs.unlinkSync(QR_FILE);
|
|
} catch {}
|
|
try {
|
|
fs.unlinkSync(STATUS_FILE);
|
|
} catch {}
|
|
|
|
let phoneNumber = phoneArg;
|
|
if (usePairingCode && !phoneNumber) {
|
|
phoneNumber = await askQuestion(
|
|
'Enter your phone number (with country code, no + or spaces, e.g. 14155551234): ',
|
|
);
|
|
}
|
|
|
|
console.log('Starting WhatsApp authentication...\n');
|
|
|
|
await connectSocket(phoneNumber);
|
|
}
|
|
|
|
authenticate().catch((err) => {
|
|
console.error('Authentication failed:', err.message);
|
|
process.exit(1);
|
|
});
|