wa-multi-mongodb 3.8.1

package/readme.md

@@ -0,0 +1,423 @@
+# WhatsApp Multi MongoDB - Multi Session WhatsApp with MongoDB
+
+## ⚠️ Important Note
+This repository is a modified version of [@mimamch/wa-multi-session](https://github.com/mimamch/wa-multi-session) with MongoDB session management integration. The original repository uses file-based session storage, while this version uses MongoDB for better scalability and session management.
+
+Lightweight library for WhatsApp with MongoDB integration. No Selenium or browser required.
+
+Built on [Baileys](https://github.com/WhiskeySockets/Baileys) Library.
+
+## Features
+- Multi-session WhatsApp (multiple numbers simultaneously)
+- State (auth) storage in MongoDB instead of files
+- Automatic loading of all sessions from the database at startup
+- No need to scan QR again as long as MongoDB data is preserved
+- Automatic timeout handling for long-running operations
+- Auto-reconnect when connection is lost
+- Better group chat support
+- Automatic retry for failed message deliveries
+
+## Installation
+
+Install package using npm:
+
+```bash
+npm install wa-multi-mongodb@latest
+```
+
+Then import into your code:
+
+```typescript
+// Using ES modules
+import * as whatsapp from "wa-multi-mongodb";
+
+// Or using CommonJS
+const whatsapp = require("wa-multi-mongodb");
+```
+
+## Environment Setup
+
+For secure MongoDB URI management, we recommend using environment variables:
+
+1. Create a `.env` file in your project root (copy from `.env.example`):
+   ```
+   # MongoDB Configuration
+   MONGODB_URI=mongodb://username:password@hostname:port/database
+
+   # Optional database settings
+   WA_DB_NAME=wa_session
+   WA_COLLECTION_NAME=auth
+   ```
+
+2. Install and use the dotenv package:
+   ```javascript
+   // Load environment variables
+   require('dotenv').config();
+
+   // Use in your code
+   const MONGODB_URI = process.env.MONGODB_URI;
+   if (!MONGODB_URI) {
+     console.error('Error: MONGODB_URI not found in environment variables');
+     process.exit(1);
+   }
+
+   // Initialize WhatsApp with MongoDB
+   await whatsapp.setMongoURI(MONGODB_URI);
+   ```
+
+3. Make sure to add `.env` to your `.gitignore` file to prevent exposing sensitive credentials
+
+## MongoDB Configuration
+
+### Setup MongoDB Connection
+1. Make sure MongoDB is running (local/cloud)
+2. Configure the connection using one of these methods:
+   
+   **Using environment variables (recommended):**
+   ```javascript
+   require('dotenv').config();
+   await whatsapp.setMongoURI(process.env.MONGODB_URI);
+   ```
+
+   **Directly in code (not recommended for production):**
+   ```javascript
+   await whatsapp.setMongoURI("mongodb+srv://username:password@host/db?options");
+   ```
+
+3. Optionally customize the database and collection names:
+   ```javascript
+   // Default values are "wa_session" and "auth"
+   whatsapp.setMongoDBNames("custom_database_name", "custom_collection_name");
+   ```
+
+## Basic Usage
+
+### Session Management
+
+```javascript
+// Start a new session
+const session = await whatsapp.startSession("mysession");
+
+// Start with options
+await whatsapp.startSession("mysession2", {
+  printQR: true,
+  onConnected: () => console.log("Connected!"),
+  onDisconnected: () => console.log("Disconnected!"),
+  onQRUpdated: (qr) => console.log("New QR:", qr)
+});
+
+// Get all active sessions
+const sessions = await whatsapp.getAllSession();
+
+// Get data for a specific session
+const sessionData = whatsapp.getSession("mysession");
+
+// Load all saved sessions from MongoDB
+await whatsapp.loadSessionsFromMongo();
+```
+
+### Sending Messages
+
+```javascript
+// Send text message
+await whatsapp.sendTextMessage({
+  sessionId: "mysession",
+  to: "6281234567890", // always include country code
+  text: "Hello from wa-multi-mongodb!",
+  isGroup: false, // set true if sending to a group
+});
+
+// Send media (unified function)
+await whatsapp.sendMedia({
+  sessionId: "mysession",
+  to: "6281234567890",
+  type: "image", // options: image, video, pdf, doc, docx, xls, xlsx, zip, mp3
+  media: fs.readFileSync("./image.jpg"), // or URL string
+  caption: "Image caption",
+  fileName: "image.jpg", // required for documents
+  isGroup: false,
+});
+
+// Send voice note
+await whatsapp.sendVoiceNote({
+  sessionId: "mysession",
+  to: "6281234567890",
+  media: fs.readFileSync("./audio.mp3"),
+});
+
+// Mark message as read
+await whatsapp.readMessage({
+  sessionId: "mysession",
+  key: msg.key,
+});
+
+// Send typing indicator (private chats only)
+await whatsapp.sendTyping({
+  sessionId: "mysession",
+  to: "6281234567890",
+  duration: 3000, // milliseconds
+});
+```
+
+> **⚠️ Important:** The "typing" indicator **only works in private chats**. Always check if you're messaging a group:
+>
+> ```js
+> const isGroup = remoteJid.endsWith('@g.us');
+> if (!isGroup) {
+>   await whatsapp.sendTyping({...});
+> }
+> ```
+
+### Event Listeners
+
+```javascript
+// Incoming messages
+whatsapp.onMessageReceived((msg) => {
+  console.log(`Message from ${msg.key.remoteJid}:`, msg);
+});
+
+// QR code updates
+whatsapp.onQRUpdated(({ sessionId, qr }) => {
+  console.log(`QR Code for ${sessionId}:`, qr);
+  // You can display this QR in a UI or save it to a file
+});
+
+// Connection events
+whatsapp.onConnected((sessionId) => {
+  console.log(`Session ${sessionId} connected`);
+});
+
+whatsapp.onDisconnected((sessionId) => {
+  console.log(`Session ${sessionId} disconnected`);
+});
+```
+
+### Handling Media in Incoming Messages
+
+```javascript
+whatsapp.onMessageReceived(async (msg) => {
+  if (msg.message?.imageMessage) {
+    await msg.saveImage("./saved-image.jpg");
+  }
+
+  if (msg.message?.videoMessage) {
+    await msg.saveVideo("./saved-video.mp4");
+  }
+
+  if (msg.message?.documentMessage) {
+    await msg.saveDocument("./saved-document"); // extension will be added automatically
+  }
+
+  if (msg.message?.audioMessage) {
+    await msg.saveAudio("./saved-audio.mp3");
+  }
+});
+```
+
+## Utility Functions
+
+```javascript
+// Create a delay
+import { createDelay } from "wa-multi-mongodb";
+await createDelay(2000); // wait 2 seconds
+
+// Execute with timeout
+import { withTimeout } from "wa-multi-mongodb";
+try {
+  const result = await withTimeout(
+    functionThatMightTakeTooLong(),
+    10000, // timeout in ms
+    "Operation timed out" // error message if timeout occurs
+  );
+} catch (error) {
+  console.error(error.message);
+}
+
+// Attempt to reconnect a session
+import { reconnect } from "wa-multi-mongodb";
+try {
+  const reconnected = await reconnect("mysession");
+  console.log("Reconnect successful:", reconnected);
+} catch (error) {
+  console.error("Reconnect failed:", error);
+}
+```
+
+## Complete Example: Auto-Reconnect Application
+
+```javascript
+import * as whatsapp from "wa-multi-mongodb";
+import { withTimeout } from "wa-multi-mongodb";
+require('dotenv').config();
+
+// Store connection status
+const sessionStatus = {};
+
+// Function to check and reconnect if disconnected
+async function checkAndReconnect(sessionId) {
+  if (sessionStatus[sessionId] === 'disconnected') {
+    try {
+      const reconnected = await whatsapp.reconnect(sessionId);
+      if (reconnected) {
+        sessionStatus[sessionId] = 'connected';
+        console.log(`Session ${sessionId} reconnected`);
+      }
+    } catch (error) {
+      console.error(`Error during reconnect: ${error.message}`);
+    }
+  }
+}
+
+async function startApp() {
+  // MongoDB Configuration
+  await whatsapp.setMongoURI(process.env.MONGODB_URI);
+  
+  // Event listeners
+  whatsapp.onQRUpdated(({ sessionId, qr }) => {
+    console.log(`QR Code for session ${sessionId}:`, qr);
+  });
+  
+  whatsapp.onConnected((sessionId) => {
+    console.log(`Session ${sessionId} connected!`);
+    sessionStatus[sessionId] = 'connected';
+  });
+  
+  whatsapp.onDisconnected((sessionId) => {
+    console.log(`Session ${sessionId} disconnected!`);
+    sessionStatus[sessionId] = 'disconnected';
+    
+    // Try to reconnect after a few seconds
+    setTimeout(() => checkAndReconnect(sessionId), 10000);
+  });
+  
+  // Message handler with error handling and group detection
+  whatsapp.onMessageReceived(async (msg) => {
+    try {
+      if (msg.key.fromMe || msg.key.remoteJid.includes("status")) return;
+      
+      const messageContent = msg.message?.conversation || 
+                            msg.message?.extendedTextMessage?.text || 
+                            "";
+      
+      // Detect if message is from a group
+      const isGroup = msg.key.remoteJid.endsWith('@g.us');
+      
+      // Mark message as read
+      try {
+        await whatsapp.readMessage({
+          sessionId: msg.sessionId,
+          key: msg.key,
+        });
+      } catch (error) {
+        if (error.message.includes('Connection Closed')) {
+          sessionStatus[msg.sessionId] = 'disconnected';
+          setTimeout(() => checkAndReconnect(msg.sessionId), 5000);
+        }
+      }
+      
+      // Reply to messages containing "hello"
+      if (messageContent.toLowerCase().includes("hello")) {
+        // Show typing indicator (only for private chats)
+        if (!isGroup) {
+          await whatsapp.sendTyping({
+            sessionId: msg.sessionId,
+            to: msg.key.remoteJid,
+            duration: 2000,
+          });
+        }
+        
+        // Use different timeouts for groups vs private chats
+        const timeoutMs = isGroup ? 60000 : 30000;
+        
+        try {
+          await withTimeout(
+            whatsapp.sendTextMessage({
+              sessionId: msg.sessionId,
+              to: msg.key.remoteJid,
+              text: "Hello! How can I help you?",
+              answering: msg,
+              isGroup: isGroup
+            }),
+            timeoutMs,
+            "Message sending timed out"
+          );
+        } catch (error) {
+          console.error("Error sending message:", error.message);
+        }
+      }
+    } catch (error) {
+      // Prevent application crash
+      console.error("Error processing message:", error.message);
+    }
+  });
+  
+  // Load all sessions from MongoDB
+  await whatsapp.loadSessionsFromMongo();
+  
+  // Create a main session if it doesn't exist
+  const mainSession = "main_session";
+  const existingSessions = await whatsapp.getAllSession();
+  if (!existingSessions.includes(mainSession)) {
+    await whatsapp.startSession(mainSession);
+  } else {
+    sessionStatus[mainSession] = 'connected';
+  }
+  
+  // Check connections periodically
+  setInterval(() => {
+    Object.keys(sessionStatus).forEach(sid => {
+      checkAndReconnect(sid);
+    });
+  }, 5 * 60 * 1000); // check every 5 minutes
+}
+
+startApp().catch(err => {
+  console.error("Failed to start application:", err);
+  process.exit(1);
+});
+```
+
+## Best Practices for Group Chats
+
+1. **Always Identify Groups**: Use `remoteJid.endsWith('@g.us')` before sending messages
+2. **No Typing Indicators**: WhatsApp doesn't support typing indicators in groups
+3. **Longer Timeouts**: Use longer timeouts when sending media to groups (60+ seconds)
+4. **Handle Errors**: Implement retry mechanisms for failed group messages
+
+## WhatsApp Limitations
+
+1. **Typing Indicators**: Only work in private chats, not in groups
+2. **Media Transfer**: Large media files to groups may take longer or timeout
+3. **Connection Stability**: Auto-reconnect may be needed in production apps
+
+## Changelog
+
+### v3.8.1 (Current)
+- Updated baileys to v6.7.16
+- Improved MongoDB integration
+- Enhanced error handling and connection stability
+
+### v3.8.0
+- Package renamed from wa-multi-session to wa-multi-mongodb
+- Added MongoDB session management
+- Fixed connection and authentication issues
+
+### v3.7.0
+- Upgraded to baileys v6.7.9
+- Fixed phone number validation
+- Removed registered phone number validation requirement
+
+## Links
+
+- [GitHub Repository](https://github.com/wahdalo/wa-multi-mongodb)
+- [Issue Tracker](https://github.com/wahdalo/wa-multi-mongodb/issues)
+- [Original wa-multi-session](https://github.com/mimamch/wa-multi-session)
+- [Baileys Library](https://github.com/WhiskeySockets/Baileys)
+
+## Author
+
+- [@wahdalo](https://github.com/wahdalo)
+
+## License
+
+ISC