How guiireal/takeshi-bot works
Project Type and Purpose
• This is a Node.js–based, event-driven WhatsApp chatbot (“Takeshi Bot”) that runs as a single process.
• It uses the Baileys library to connect to WhatsApp, loads commands dynamically, applies middleware, calls external services (Spider X API, Catbox, FFMPEG, etc.), and stores simple data in JSON.
High-Level File‐Structure Analysis
• Top-level:
• index.js (entry point for hosting), index.js under src (runtime entry)
• assets/ (media files + Baileys auth state)
• database/ (auto-responder JSON)
• src/ (core code):
– config.js, connection.js, loader.js, index.js, test.js
– folders: commands (admin/member/owner), middlewares, services, utils, errors, @types
• Patterns:
• Event‐driven flow (Baileys emits messages → loader & middlewares → command handlers)
• Plugin-style commands folder, each command modularized
• Layered organization: Connection → Loader → Middlewares → Commands → Services/Utils
Key Components
A. WhatsApp Connection Layer
• Baileys client (in src/connection.js)
• Entry point (src/index.js)
B. Loader & Dispatcher
• loader.js (scans commands, loads help metadata)
• Dynamic command resolver (utils/dynamicCommand.js)
C. Middleware Layer
• src/middlewares/*.js (check permissions, onGroupParticipantsUpdate, onMessagesUpsert)
D. Command Handlers
• src/commands/* (admin, member, owner)
• Each command: receives context, interacts with services/utils, returns responses
E. Services & External Integrations
• src/services/baileys.js (wrapper around Baileys send/receive)
• src/services/spider-x-api.js, src/services/catbox.js
• Axios HTTP calls
• FFmpeg (spawned via child_process for media)
F. Utilities & Data Stores
• src/utils/*.js (logger, database wrapper, message templates, common functions)
• database/auto-responder.json (persistent data)
• assets/auth/baileys/ (session files)
• assets/temp/ (transient files)
G. External Systems
• WhatsApp servers (via Baileys)
• Spider X API
• Catbox API
• YouTube/TikTok for downloads (through third-party endpoints)
Relationships and Data Flow
1. Start: Node.js (index.js) initializes config → connection → loader
2. Connection: Baileys connects to WhatsApp, emits “message upsert” events
3. Loader: Receives event, applies global interceptors, loads appropriate command module
4. Middleware: Each incoming message passes through checkPermission, onGroupParticipantsUpdate, etc.
5. Command Execution:
• Command handler logic in src/commands/*
• May call services (e.g., Spider X for AI generation, Catbox for file hosting)
• May invoke utilities (e.g., utils/database.js, logger.js)
• For media, spawns FFMPEG or downloads via Axios
6. Response: Service writes reply via Baileys wrapper → WhatsApp
Architectural Patterns & Principles
• Event‐Driven Architecture (EDA)
• Layered structure (Connection → Loader → Middleware → Commands → Services → Utils)
• Plugin/Modular Commands (dynamic discovery of handlers)
• Single Responsibility (each module has a clear domain)