wa-multi-mongodb 3.10.2 → 3.10.4

package/readme.md

@@ -19,6 +19,8 @@ Built on [Baileys](https://github.com/WhiskeySockets/Baileys) Library.
 - Automatic group chat detection (v3.9.0+)
 - Hybrid caching system for group metadata (v3.9.4+)
 - Message deletion for self and others (v3.9.5+)
+- Custom browser configuration (v3.10.4+)
+- LID ↔ PN conversion utilities (v3.10.4+)
 
 ## Installation
 
@@ -113,9 +115,16 @@ await whatsapp.startSession("mysession2", {
   }
 });
 
+// Start with custom browser configuration (v3.10.4+)
+await whatsapp.startSession("mysession3", {
+  printQR: true,
+  browserType: "windows",  // Options: "ubuntu" (default), "macOS", "windows", "appropriate"
+  browserName: "My Bot App", // Custom name shown in WhatsApp Linked Devices
+  onConnected: () => console.log("Connected with custom browser!"),
+});
+
 // Start session with Pairing Code (v3.9.6+)
-await whatsapp.startSessionWithPairingCode("mysession3", {
-  mobile: "6281234567890", // your phone number with country code
+await whatsapp.startSessionWithPairingCode("mysession4", "6281234567890", {
   onConnected: () => console.log("Pairing session connected!"),
   onDisconnected: () => console.log("Pairing session disconnected!"),
   onPairingCode: (code) => {
@@ -124,6 +133,13 @@ await whatsapp.startSessionWithPairingCode("mysession3", {
   }
 });
 
+// Pairing code with custom browser
+await whatsapp.startSessionWithPairingCode("mysession5", "6281234567890", {
+  browserType: "macOS",
+  browserName: "My Custom Bot",
+  onPairingCode: (code) => console.log("Code:", code),
+});
+
 // Get all active sessions
 const sessions = await whatsapp.getAllSession();
 
@@ -155,6 +171,44 @@ console.log("Pairing code sessions:", pairingSessions);
 await whatsapp.reconnectAllPairingCodeSessions();
 ```
 
+### Custom Browser Configuration (v3.10.4+)
+
+You can customize the browser type and name that appears in WhatsApp's "Linked Devices" list:
+
+```javascript
+// Available browser types
+type BrowserType = "ubuntu" | "macOS" | "windows" | "appropriate";
+
+// Usage examples
+await whatsapp.startSession("session1", {
+  browserType: "ubuntu",      // Default - Ubuntu browser agent
+  browserName: "Chrome",      // Default - App name shown in Linked Devices
+});
+
+await whatsapp.startSession("session2", {
+  browserType: "windows",     // Windows browser agent
+  browserName: "My Bot App",  // Custom app name
+});
+
+await whatsapp.startSession("session3", {
+  browserType: "macOS",       // macOS browser agent
+  browserName: "Desktop App",
+});
+
+await whatsapp.startSession("session4", {
+  browserType: "appropriate", // Auto-detect based on platform
+  browserName: "Auto Bot",
+});
+```
+
+| Browser Type | Description |
+|--------------|-------------|
+| `ubuntu` | Ubuntu browser agent (default) |
+| `macOS` | macOS browser agent |
+| `windows` | Windows browser agent |
+| `appropriate` | Auto-detect based on current platform |
+
+
 ### Sending Messages
 
 ```javascript
@@ -424,8 +478,105 @@ try {
 }
 ```
 
+## LID ↔ PN Conversion Utilities (v3.10.4+)
+
+WhatsApp has introduced LID (Linked ID) as a new anonymous identifier format to enhance user privacy. These utility functions help you convert between LID and Phone Number (PN) formats.
+
+### Understanding LID and PN
+
+| Format | Description | Example |
+|--------|-------------|---------|
+| **LID** | Anonymous identifier (new format) | `1524746986546@lid` |
+| **PN/JID** | Phone number based identifier (traditional) | `6281234567890@s.whatsapp.net` |
+
+### Converting LID to Phone Number
+
+```javascript
+// Get phone number from LID
+const result = await whatsapp.getPNForLID("mysession", "1524746986546@lid");
+if (result.success && result.pn) {
+  console.log(`Phone number: ${result.pn}`);
+} else {
+  console.log("Phone number not found:", result.error);
+}
+
+// Returns: { success: boolean, lid: string, pn: string | null, error?: string }
+```
+
+### Converting Phone Number to LID
+
+```javascript
+// Get LID from phone number
+const result = await whatsapp.getLIDForPN("mysession", "6281234567890");
+if (result.success && result.lid) {
+  console.log(`LID: ${result.lid}`);
+} else {
+  console.log("LID not found:", result.error);
+}
+
+// Returns: { success: boolean, pn: string, lid: string | null, error?: string }
+```
+
+### Smart Conversion (Auto-detect Format)
+
+```javascript
+// Automatically convert any JID to phone number
+const phoneNumber = await whatsapp.toPhoneNumber("mysession", anyJid);
+if (phoneNumber) {
+  console.log(`Phone: ${phoneNumber}`);
+}
+
+// Automatically convert any JID to LID
+const lid = await whatsapp.toLID("mysession", "6281234567890@s.whatsapp.net");
+if (lid) {
+  console.log(`LID: ${lid}`);
+}
+```
+
+### Get All Known LID Mappings
+
+```javascript
+// Get all LID-PN mappings for a session
+const mappings = await whatsapp.getAllLIDMappings("mysession");
+for (const { lid, pn } of mappings) {
+  console.log(`${lid} => ${pn}`);
+}
+```
+
+### Format Detection Helpers
+
+```javascript
+// Check if JID is in LID format
+if (whatsapp.isLIDFormat("1524746986546@lid")) {
+  console.log("This is an LID");
+}
+
+// Check if JID is in PN format
+if (whatsapp.isPNFormat("6281234567890@s.whatsapp.net")) {
+  console.log("This is a phone number JID");
+}
+```
+
+### Important Notes on LID Conversion
+
+> ⚠️ **Limitations**:
+> - `getPNForLID` may return `null` for new contacts or when WhatsApp hasn't provided the LID-PN mapping
+> - LID mappings are only available for contacts that have already interacted with your session
+> - WhatsApp is increasingly focusing on privacy, so not all LIDs have known phone numbers
+
+| Function | Description |
+|----------|-------------|
+| `getPNForLID(sessionId, lid)` | Convert LID to phone number |
+| `getLIDForPN(sessionId, pn)` | Convert phone number to LID |
+| `toPhoneNumber(sessionId, jid)` | Smart convert any JID to PN |
+| `toLID(sessionId, jid)` | Smart convert any JID to LID |
+| `getAllLIDMappings(sessionId)` | Get all known LID-PN mappings |
+| `isLIDFormat(jid)` | Check if JID is in LID format |
+| `isPNFormat(jid)` | Check if JID is in PN format |
+
 ## Complete Example: Auto-Reconnect Application
 
+
 ```javascript
 import * as whatsapp from "wa-multi-mongodb";
 import { withTimeout } from "wa-multi-mongodb";
@@ -816,7 +967,23 @@ export default WhatsAppQRComponent;
 
 ## Changelog
 
-### v3.10.2 (latest)
+### v3.10.4 (latest)
+- **Custom Browser Configuration**: Added ability to customize browser type and name for WhatsApp connection
+  - New `browserType` option: Choose from "ubuntu" (default), "macOS", "windows", or "appropriate"
+  - New `browserName` option: Customize the app name displayed in WhatsApp's "Linked Devices" list
+  - Works with both `startSession()` and `startSessionWithPairingCode()` methods
+  - Default behavior unchanged (Ubuntu browser with "Chrome" name)
+- **LID ↔ PN Conversion Utilities**: Added comprehensive utilities for converting between LID (Linked ID) and Phone Number formats
+  - New `getPNForLID(sessionId, lid)` function to convert LID to phone number
+  - New `getLIDForPN(sessionId, pn)` function to convert phone number to LID
+  - New `toPhoneNumber(sessionId, jid)` smart conversion function (auto-detects format)
+  - New `toLID(sessionId, jid)` smart conversion function (auto-detects format)
+  - New `getAllLIDMappings(sessionId)` function to get all known LID-PN mappings
+  - New `isLIDFormat(jid)` and `isPNFormat(jid)` helper functions
+  - Uses Baileys' internal `signalRepository.lidMapping` for conversions
+
+
+### v3.10.2
 - **Fixed Group JID Validation**: Resolved issue with group chat validation
   - Fixed `isValidJid()` function to properly validate group JIDs without requiring dash (-) character
   - Some WhatsApp group IDs don't use dash format, validation now accepts all valid group formats