@innovatorssoft/innovators-bot2 2.0.0 → 2.0.2

package/README.md

@@ -9,12 +9,14 @@ A powerful WhatsApp client library that provides seamless integration between Ba
 - 💬 Send and receive messages
 - � Message reactions (add/remove emoji reactions)
 - �📸 Media handling (images, videos, documents)
-- 👥 Group management
+- � Mentions support in text and media messages
+- �👥 Group management
 - 💾 Message history and chat management
 - 🔄 Auto-reconnect functionality
 - 📝 Read receipts
 - 🔐 LID (Local Identifier) support for enhanced privacy
 - 🗂️ Signal repository store for LID/PN mapping
+- 🧩 Interactive buttons support for both text and media (URL or local file)
 
 ## Installation
 
@@ -97,10 +99,22 @@ await client.sendMedia('1234567890@s.whatsapp.net', './image.jpg', {
     caption: 'Check out this image!'
 })
 
+// Send an image with mentions
+await client.sendMedia('1234567890@s.whatsapp.net', './image.jpg', {
+    caption: 'Hey @user, check this out!',
+    mentions: ['user@s.whatsapp.net']
+})
+
 // Send a document
 await client.sendDocument('1234567890@s.whatsapp.net', './document.pdf', 
     'Check out this document!'
 )
+
+// Send a document with mentions (caption object is supported)
+await client.sendDocument('1234567890@s.whatsapp.net', './document.pdf', {
+    caption: 'Hey @user, please read this',
+    mentions: ['user@s.whatsapp.net']
+})
 ```
 
 ### 3. Sticker Management
@@ -145,6 +159,45 @@ client.on('message-deleted', async (data) => {
 // Get all groups
 const groups = await client.getAllGroups()
 
+// Get group metadata (participants, name, description...)
+const metadata = await client.getGroupMetadata(groupId)
+console.log(metadata.id, metadata.subject, metadata.desc)
+
+// Create a new group
+const newGroup = await client.createGroup('Group Name', ['1234567890@s.whatsapp.net'])
+console.log('Created group:', newGroup.id)
+
+// Change group subject (name)
+await client.changeGroupSubject(groupId, 'New Group Name')
+
+// Change group description
+await client.changeGroupDescription(groupId, 'New description for the group')
+
+// Change group settings
+// Options: 'announcement' (only admins send), 'not_announcement' (everyone sends),
+//          'locked' (only admins edit info), 'unlocked' (everyone edits info)
+await client.changeGroupSettings(groupId, 'announcement')
+
+// Get group invite code
+const code = await client.getGroupInviteCode(groupId)
+console.log('Invite link: https://chat.whatsapp.com/' + code)
+
+// Revoke invite code (generates a new one)
+const newCode = await client.revokeGroupInviteCode(groupId)
+console.log('New invite link: https://chat.whatsapp.com/' + newCode)
+
+// Join group by invite code
+const joinedGroupId = await client.joinGroupByInviteCode('AbCdEfGhIjK')
+// Also accepts full URL - it strips the prefix automatically
+await client.joinGroupByInviteCode('https://chat.whatsapp.com/AbCdEfGhIjK')
+
+// Get group info by invite code (without joining)
+const groupInfo = await client.getGroupInfoByInviteCode('AbCdEfGhIjK')
+console.log('Group name:', groupInfo.subject)
+
+// Leave a group
+await client.leaveGroup(groupId)
+
 // Add participant to group
 // Note: If adding fails due to user's privacy settings (403), 
 // an invitation link is automatically sent to the user instead.
@@ -165,9 +218,71 @@ await client.changeGroupParticipants(groupId, ['1234567890@s.whatsapp.net'], 'pr
 
 // Demote admin
 await client.changeGroupParticipants(groupId, ['1234567890@s.whatsapp.net'], 'demote')
+
+// Get pending join requests
+const requests = await client.getGroupJoinRequests(groupId)
+console.log('Pending requests:', requests)
+
+// Approve/Reject join requests
+await client.handleGroupJoinRequest(groupId, ['1234567890@s.whatsapp.net'], 'approve')
+await client.handleGroupJoinRequest(groupId, ['1234567890@s.whatsapp.net'], 'reject')
+
+// Toggle ephemeral (disappearing) messages
+// Options: 0 (off), 86400 (24h), 604800 (7d), 7776000 (90d)
+await client.toggleGroupEphemeral(groupId, 86400)
+
+// Change who can add members
+// Options: 'all_member_add' or 'admin_add'
+await client.changeGroupAddMode(groupId, 'admin_add')
 ```
 
-### 4. Interactive Messages
+### 6. Privacy Management
+
+```javascript
+// Block a user
+await client.blockUser('1234567890@s.whatsapp.net')
+
+// Unblock a user
+await client.unblockUser('1234567890@s.whatsapp.net')
+
+// Get all privacy settings
+const settings = await client.getPrivacySettings()
+console.log('Privacy settings:', settings)
+
+// Get blocked contacts list
+const blocklist = await client.getBlockList()
+console.log('Blocked users:', blocklist)
+
+// Update last seen privacy
+// Options: 'all' | 'contacts' | 'contact_blacklist' | 'none'
+await client.updateLastSeenPrivacy('contacts')
+
+// Update online status privacy
+// Options: 'all' | 'match_last_seen'
+await client.updateOnlinePrivacy('match_last_seen')
+
+// Update profile picture privacy
+// Options: 'all' | 'contacts' | 'contact_blacklist' | 'none'
+await client.updateProfilePicturePrivacy('contacts')
+
+// Update status privacy
+// Options: 'all' | 'contacts' | 'contact_blacklist' | 'none'
+await client.updateStatusPrivacy('contacts')
+
+// Update read receipts privacy
+// Options: 'all' | 'none'
+await client.updateReadReceiptsPrivacy('all')
+
+// Update who can add you to groups
+// Options: 'all' | 'contacts' | 'contact_blacklist'
+await client.updateGroupsAddPrivacy('contacts')
+
+// Update default disappearing mode for new chats
+// Options: 0 (off), 86400 (24h), 604800 (7d), 7776000 (90d)
+await client.updateDefaultDisappearingMode(604800)
+```
+
+### 7. Interactive Messages
 
 #### Buttons
 ```javascript
@@ -176,7 +291,7 @@ await client.sendButtons('1234567890@s.whatsapp.net', {
     text: 'Do you like this bot?',
     title: 'Feedback',
     subtitle: 'Let us know!',
-    footer: 'Powered by Baileys',
+    footer: 'Powered by Innovators Soft',
     interactiveButtons: [
         {
             name: 'quick_reply',
@@ -194,6 +309,43 @@ await client.sendButtons('1234567890@s.whatsapp.net', {
         }
     ]
 });
+
+// Send interactive buttons with an image from URL + caption
+await client.sendButtons('1234567890@s.whatsapp.net', {
+    image: { url: 'https://example.com/image.jpg' },
+    caption: 'Body',
+    title: 'Title',
+    subtitle: 'Subtitle',
+    footer: 'Footer',
+    interactiveButtons: [
+        {
+            name: 'quick_reply',
+            buttonParamsJson: JSON.stringify({
+                display_text: 'DisplayText',
+                id: 'ID1'
+            })
+        }
+    ],
+    hasMediaAttachment: false
+});
+
+// Send interactive buttons with a local image file + caption
+await client.sendButtons('1234567890@s.whatsapp.net', {
+    imagePath: './image.jpg',
+    caption: 'Body',
+    title: 'Title',
+    subtitle: 'Subtitle',
+    footer: 'Footer',
+    interactiveButtons: [
+        {
+            name: 'quick_reply',
+            buttonParamsJson: JSON.stringify({
+                display_text: 'DisplayText',
+                id: 'ID1'
+            })
+        }
+    ]
+});
 ```
 
 #### List Messages
@@ -223,7 +375,7 @@ await client.SendList('1234567890@s.whatsapp.net', {
 });
 ```
 
-### 4. Message History
+### 8. Message History
 
 ```javascript
 // Get chat history
@@ -260,13 +412,16 @@ The library includes example bot commands that you can use:
 - `!react` - React to your message with ❤️
 - `!read` - Mark messages as read
 - `!typing` - Show typing indicator
-- `!presence` - Set online presence
+- `!recording` - Show recording indicator
+- `!paused` - Clear typing or recording indicator
 
 ### Media & Content
 - `!media` - Send an example image
 - `!doc` - Send an example document
 - `!location` - Send a location
 - `!contact` - Send a contact card
+- `!sticker` - Create a sticker from an image
+- `!ad` - Send an ad reply message
 
 ### Group Management
 - `!groups` - List all your groups
@@ -274,7 +429,34 @@ The library includes example bot commands that you can use:
 - `!remove <number>` - Remove participant from group
 - `!promote <number>` - Promote participant to admin
 - `!demote <number>` - Demote admin to participant
-- `!list` - Show interactive list message
+- `!invite <number>` - Send group invite link to user
+- `!creategroup <name>` - Create a new group
+- `!groupsubject <name>` - Change group name
+- `!groupdesc <text>` - Change group description
+- `!groupsetting <setting>` - Change group settings (announcement/not_announcement/locked/unlocked)
+- `!invitecode` - Get group invite code/link
+- `!revokeinvite` - Revoke current invite code and generate new one
+- `!leavegroup` - Leave the current group
+- `!joingroup <code>` - Join a group by invite code
+- `!groupinfo <code>` - Get group info by invite code without joining
+- `!joinrequests` - List pending join requests
+- `!approvejoin <number>` - Approve a join request
+- `!rejectjoin <number>` - Reject a join request
+- `!ephemeral <seconds>` - Toggle disappearing messages (0/86400/604800/7776000)
+- `!addmode <mode>` - Change who can add members (all_member_add/admin_add)
+
+### 🔒 Privacy
+- `!block <number>` - Block a user
+- `!unblock <number>` - Unblock a user
+- `!privacy` - View all privacy settings
+- `!blocklist` - List all blocked contacts
+- `!lastseenprivacy <value>` - Update last seen privacy (all/contacts/contact_blacklist/none)
+- `!onlineprivacy <value>` - Update online privacy (all/match_last_seen)
+- `!pfpprivacy <value>` - Update profile picture privacy (all/contacts/contact_blacklist/none)
+- `!statusprivacy <value>` - Update status privacy (all/contacts/contact_blacklist/none)
+- `!readreceiptprivacy <value>` - Update read receipts privacy (all/none)
+- `!groupaddprivacy <value>` - Update who can add you to groups (all/contacts/contact_blacklist)
+- `!disappearing <seconds>` - Update default disappearing mode (0/86400/604800/7776000)
 
 ### Interactive Messages
 - `!buttons` - Show interactive buttons
@@ -290,9 +472,6 @@ The library includes example bot commands that you can use:
 - `!parse <jid>` - Parse detailed JID information
 - `!normalize <number>` - Normalize a number to JID format
 
-### 🎨 Sticker Commands
-- `!sticker` - Create a sticker from an image
-
 ### Connection Events
 ```javascript
 // When QR code is generated
@@ -316,6 +495,24 @@ client.on('disconnected', (error) => {
 })
 ```
 
+### Contact Events
+```javascript
+// When contacts are received from history sync
+client.on('contacts-received', (contacts) => {
+    console.log(`Received ${contacts.length} contacts`);
+})
+
+// When new contacts are added/updated
+client.on('contacts-upsert', (contacts) => {
+    console.log(`New Contacts: ${contacts.length} contacts added/updated`);
+})
+
+// When existing contacts are updated (profile picture changes, etc.)
+client.on('contacts-update', (updates) => {
+    console.log(`Contact Updates: ${updates.length} contacts modified`);
+})
+```
+
 ### Message Events
 ```javascript
 // When a new message is received
@@ -329,7 +526,14 @@ client.on('message', async msg => {
     // Handle different message types
     if (msg.hasMedia) {
         console.log('Message contains media')
-        // Handle media message
+        // Download media (image/video/audio/document)
+        const media = await client.downloadMedia(msg)
+        if (media) {
+            const fs = require('fs')
+            const fileName = `./download-${Date.now()}.${media.extension}`
+            fs.writeFileSync(fileName, media.buffer)
+            console.log('Saved media to:', fileName)
+        }
     }
 })
 ```
@@ -716,3 +920,11 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 ## Credits
 
 Developed by [Innovators Soft](https://facebook.com/innovatorssoft). Based on the [@itsukichan/baileys](https://github.com/itsukichann/baileys) library.
+
+# Special Thanks
+- [@whiskeysockets/baileys](https://github.com/whiskeysockets/Baileys)
+- [@itsukichan](https://github.com/itsukichann)
+- [All Contributors](https://github.com/innovatorssoft/Baileys/)
+- [@ZenboBot](https://discordbot.innovatorssoftpk.com/) - AI Powered Baileys Bot
+# Sponsor Me
+Buy me a coffee - [Innovators Soft](https://facebook.com/innovatorssoft)