@alannxd/baileys 6.0.6 → 6.0.9

package/README.md

@@ -45,364 +45,419 @@ Begin by installing the library via your preferred package manager, then follow
 
 ## Add Function ( Simple code )
 
-### Label Group
-Tag/Label Member Grop
+# AlannXD Baileys
+
+Simple WhatsApp Web API Library Based On Baileys.
+
+---
+
+# Installation
+
+### Install Package
+
+Install package using npm.
+
+```bash
+npm install @alannxd/baileys
+```
+
+---
+
+# Import
+
+### CommonJS
+
+Import package using require.
+
+```javascript
+const {
+    default: makeWASocket
+} = require("@alannxd/baileys");
+```
+
+---
+
+### ES Module
+
+Import package using ES Module.
+
+```javascript
+import makeWASocket from "@alannxd/baileys";
+```
+
+---
+
+# Connection Documentation
+
+### Connect With QR Code
+
+Connect WhatsApp using QR authentication.
+
+```javascript
+const {
+    default: makeWASocket,
+    Browsers
+} = require("@alannxd/baileys");
+
+const client = makeWASocket({
+    browser: Browsers.ubuntu("Chrome"),
+    printQRInTerminal: true
+});
+```
+
+---
+
+### Connect With Pairing Code
+
+Connect WhatsApp using phone number.
+
+```javascript
+const {
+    default: makeWASocket,
+    Browsers,
+    fetchLatestWAWebVersion
+} = require("@alannxd/baileys");
+
+const client = makeWASocket({
+    browser: Browsers.ubuntu("Chrome"),
+    printQRInTerminal: false,
+    version: fetchLatestWAWebVersion(),
+    aiLabel: false
+});
+
+const code = await client.requestPairingCode("628xxxxxxxxxx");
+
+console.log(code);
+```
+
+---
+
+# Store Documentation
+
+### In Memory Store
+
+Store contacts, chats and messages in memory.
+
+```javascript
+const {
+    default: makeWASocket,
+    makeInMemoryStore
+} = require("@alannxd/baileys");
+
+const pino = require("pino");
+
+const store = makeInMemoryStore({
+    logger: pino().child({
+        level: "silent",
+        stream: "store"
+    })
+});
+
+store.bind(client.ev);
+```
+
+---
+
+# Group Documentation
+
+### Member Label
+
+Send member label inside group.
 
 ```javascript
-sock.setLabelGroup(jid, string)
+await client.sendMessage(jid, {
+    groupLabel: {
+        labelText: "Premium Member"
+    }
+});
 ```
+
 ---
-### Check ID Channel 
-Get ID Channel From Url
+
+### Message Members
+
+Send message to all group members.
 
 ```javascript
-sock.newsletterFromUrl(url)
+await client.sendMessageMembers(
+    jid,
+    {
+        extendedTextMessage: {
+            text: "Hello Members"
+        }
+    },
+    {}
+);
 ```
-Result JSON
+
+---
+
+# Utility Documentation
+
+### Check Channel Information
+
+Get newsletter information from URL.
+
+```javascript
+client.newsletterFromUrl(url);
+```
+
+Result:
+
 ```json
 {
-  "name": "Name Channel",
-  "id": "Channel ID",
-  "state": "Status Channel",
-  "subscribers": "Followers",
-  "verification": "UNVERIFIED",
-  "creation_time": 1728547155,
-  "description": "Description Channel"
+    "name": "Channel Name",
+    "id": "123456789",
+    "state": "ACTIVE",
+    "subscribers": "1000",
+    "verification": "UNVERIFIED",
+    "creation_time": 1728547155,
+    "description": "Channel Description"
 }
 ```
+
 ---
-### Check banned number
-You can see the status of blocked numbers here 
+
+### Check WhatsApp Number
+
+Check whether number exists on WhatsApp.
 
 ```javascript
-sock.checkWhatsApp(jid)
+client.checkWhatsApp(jid);
 ```
+
 ---
 
-## SendMessage Documentation
+# SendMessage Documentation
+
+### Send Text
 
-### Status Mention Group & Private Message
-Send Status Mention Group/Private Chat
+Send text message.
 
 ```javascript
-await sock.sendStatusMention(content, jid);
+await client.sendText(
+    jid,
+    "Hello World"
+);
 ```
 
-### Status Group Message V2
-Send Group Status With Version 2 
+---
+
+### Send Image
+
+Send image message.
 
 ```javascript
-await sock.sendMessage(jid, {
-     groupStatusMessage: {
-          text: "Hello World"
-     }
-});
+await client.sendImage(
+    jid,
+    {
+        url: "./image.jpg"
+    },
+    "Caption Here"
+);
 ```
 
-### Album Message (Multiple Images)
-Send multiple images in a single album message:
+---
+
+### Send Video
+
+Send video message.
 
 ```javascript
-await sock.sendMessage(jid, { 
-    albumMessage: [
-        { image: haii, caption: "Foto pertama" },
-        { image: { url: "URL IMAGE" }, caption: "Foto kedua" }
-    ] 
-}, { quoted: m });
+await client.sendVideo(
+    jid,
+    {
+        url: "./video.mp4"
+    },
+    "Caption Here"
+);
 ```
 
-### Event Message
-Create and send WhatsApp event invitations:
+---
+
+### Send Audio
+
+Send audio message.
 
 ```javascript
-await sock.sendMessage(jid, { 
-    eventMessage: { 
-        isCanceled: false, 
-        name: "Hello World", 
-        description: "alannxd", 
-        location: { 
-            degreesLatitude: 0, 
-            degreesLongitude: 0, 
-            name: "rowrrrr" 
-        }, 
-        joinLink: "https://call.whatsapp.com/video/alannxd", 
-        startTime: "1763019000", 
-        endTime: "1763026200", 
-        extraGuestsAllowed: false 
-    } 
-}, { quoted: m });
+await client.sendAudio(
+    jid,
+    {
+        url: "./audio.mp3"
+    }
+);
 ```
 
-### Poll Result Message
-Display poll results with vote counts:
+---
+
+### Send Location
+
+Send location message.
 
 ```javascript
-await sock.sendMessage(jid, { 
-    pollResultMessage: { 
-        name: "Hello World", 
-        pollVotes: [
-            {
-                optionName: "TEST 1",
-                optionVoteCount: "112233"
-            },
-            {
-                optionName: "TEST 2",
-                optionVoteCount: "1"
-            }
-        ] 
-    } 
-}, { quoted: m });
+await client.sendLocation(
+    jid,
+    "AlannXD",
+    -6.2,
+    106.8,
+    "https://example.com",
+    "123456789"
+);
 ```
 
-### Simple Interactive Message
-Send basic interactive messages with copy button functionality:
+---
+
+### Send Poll
+
+Create poll message.
 
 ```javascript
-await sock.sendMessage(jid, {
-    interactiveMessage: {
-        header: "Hello World",
-        title: "Hello World",
-        footer: "telegram: @alannxd ",
-        buttons: [
-            {
-                name: "cta_copy",
-                buttonParamsJson: JSON.stringify({
-                    display_text: "copy code",
-                    id: "123456789",              
-                    copy_code: "ABC123XYZ"
-                })
-            }
-        ]
-    }
-}, { quoted: m });
+await client.sendPoll(
+    jid,
+    "Choose One",
+    [
+        "Option 1",
+        "Option 2",
+        "Option 3"
+    ],
+    true
+);
 ```
 
-### Interactive Message with Native Flow
-Send interactive messages with buttons, copy actions, and native flow features:
+---
+
+### Send Quiz
+
+Create quiz poll message.
 
 ```javascript
-await sock.sendMessage(jid, {    
-    interactiveMessage: {      
-        header: "Hello World",
-        title: "Hello World",      
-        footer: "telegram: @alannxd",      
-        image: { url: "https://example.com/image.jpg" },      
-        nativeFlowMessage: {        
-            messageParamsJson: JSON.stringify({          
-                limited_time_offer: {            
-                    text: "idk hummmm?",            
-                    url: "https://t.me/alannxd",            
-                    copy_code: "alannxd",            
-                    expiration_time: Date.now() * 999          
-                },          
-                bottom_sheet: {            
-                    in_thread_buttons_limit: 2,            
-                    divider_indices: [1, 2, 3, 4, 5, 999],            
-                    list_title: "alannxd",            
-                    button_title: "alannxd"          
-                },          
-                tap_target_configuration: {            
-                    title: " X ",            
-                    description: "bomboclard",            
-                    canonical_url: "https://t.me/alannxd",            
-                    domain: "shop.example.com",            
-                    button_index: 0          
-                }        
-            }),        
-            buttons: [          
-                {            
-                    name: "single_select",            
-                    buttonParamsJson: JSON.stringify({              
-                        has_multiple_buttons: true            
-                    })          
-                },          
-                {            
-                    name: "call_permission_request",            
-                    buttonParamsJson: JSON.stringify({              
-                        has_multiple_buttons: true            
-                    })          
-                },          
-                {            
-                    name: "single_select",            
-                    buttonParamsJson: JSON.stringify({              
-                        title: "Hello World",              
-                        sections: [                
-                            {                  
-                                title: "title",                  
-                                highlight_label: "label",                  
-                                rows: [                    
-                                    {                      
-                                        title: "@alannxd",                      
-                                        description: "love you",                      
-                                        id: "row_2"                    
-                                    }                  
-                                ]                
-                            }              
-                        ],              
-                        has_multiple_buttons: true            
-                    })          
-                },          
-                {            
-                    name: "cta_copy",            
-                    buttonParamsJson: JSON.stringify({              
-                        display_text: "copy code",              
-                        id: "123456789",              
-                        copy_code: "ABC123XYZ"            
-                    })          
-                }        
-            ]      
-        }    
-    }  
-}, { quoted: m });
+await client.sendQuiz(
+    jid,
+    "Question Here",
+    [
+        "A",
+        "B",
+        "C"
+    ],
+    "B"
+);
 ```
 
-### Interactive Message with Thumbnail
-Send interactive messages with thumbnail image and copy button:
+---
+
+### Status Mention
+
+Mention users through status.
 
 ```javascript
-await sock.sendMessage(jid, {
-    interactiveMessage: {
-        header: "Hello World",
-        title: "Hello World",
-        footer: "telegram: @alannxd",
-        image: { url: "https://example.com/image.jpg" },
-        buttons: [
-            {
-                name: "cta_copy",
-                buttonParamsJson: JSON.stringify({
-                    display_text: "copy code",
-                    id: "123456789",
-                    copy_code: "ABC123XYZ"
-                })
-            }
-        ]
+await client.statusMention(
+    jid,
+    {
+        extendedTextMessage: {
+            text: "Hello World"
+        }
     }
-}, { quoted: m });
+);
 ```
 
-### Product Message
-Send product catalog messages with buttons and merchant information:
+---
+
+### Interactive Message
+
+Send interactive message.
 
 ```javascript
-await sock.sendMessage(jid, {
-    productMessage: {
-        title: "Produk Contoh",
-        description: "Ini adalah deskripsi produk",
-        thumbnail: { url: "https://example.com/image.jpg" },
-        productId: "PROD001",
-        retailerId: "RETAIL001",
-        url: "https://example.com/product",
-        body: "Detail produk",
-        footer: "Harga spesial",
-        priceAmount1000: 50000,
-        currencyCode: "USD",
-        buttons: [
+await client.sendMessage(
+    jid,
+    {
+        image: {
+            url: "./image.jpg"
+        },
+        text: "Body Message",
+        title: "Hello World",
+        footer: "AlannXD",
+        interactiveButtons: [
             {
-                name: "cta_url",
+                name: "single_select",
                 buttonParamsJson: JSON.stringify({
-                    display_text: "Beli Sekarang",
-                    url: "https://example.com/buy"
+                    title: "Menu"
                 })
             }
         ]
     }
-}, { quoted: m });
+);
 ```
 
-### Interactive Message with Document Buffer
-Send interactive messages with document from buffer (file system) - **Note: Documents only support buffer**:
+---
+
+### Product Message
+
+Send product catalog message.
 
 ```javascript
-await sock.sendMessage(jid, {
-    interactiveMessage: {
-        header: "Hello World",
-        title: "Hello World",
-        footer: "telegram: @alannxd",
-        document: fs.readFileSync("./package.json"),
-        mimetype: "application/pdf",
-        fileName: "alannxd.pdf",
-        jpegThumbnail: fs.readFileSync("./document.jpeg"),
-        contextInfo: {
-            mentionedJid: [jid],
-            forwardingScore: 777,
-            isForwarded: false
-        },
-        externalAdReply: {
-            title: "shenń Bot",
-            body: "anu team",
-            mediaType: 3,
-            thumbnailUrl: "https://example.com/image.jpg",
-            mediaUrl: " X ",
-            sourceUrl: "https://t.me/alannxd",
-            showAdAttribution: true,
-            renderLargerThumbnail: false         
-        },
-        buttons: [
-            {
-                name: "cta_url",
-                buttonParamsJson: JSON.stringify({
-                    display_text: "Telegram",
-                    url: "https://t.me/alannxd",
-                    merchant_url: "https://t.me/alannxd"
-                })
-            }
-        ]
+await client.sendMessage(
+    jid,
+    {
+        productMessage: {
+            title: "AlannXD Product",
+            description: "Product Description",
+            thumbnail: {
+                url: "./thumbnail.jpg"
+            },
+            productId: "PRODUCT_ID",
+            retailerId: "RETAILER_ID",
+            url: "https://example.com",
+            body: "Product Body",
+            footer: "Footer Product",
+            priceAmount1000: 50000,
+            currencyCode: "IDR"
+        }
     }
-}, { quoted: m });
+);
 ```
 
-### Interactive Message with Document Buffer (Simple)
-Send interactive messages with document from buffer (file system) without contextInfo and externalAdReply - **Note: Documents only support buffer**:
+---
+
+### Order Message
+
+Send order message.
 
 ```javascript
-await sock.sendMessage(jid, {
-    interactiveMessage: {
-        header: "Hello World",
-        title: "Hello World",
-        footer: "telegram: @alannxd",
-        document: fs.readFileSync("./package.json"),
-        mimetype: "application/pdf",
-        fileName: "alannxd.pdf",
-        jpegThumbnail: fs.readFileSync("./document.jpeg"),
-        buttons: [
-            {
-                name: "cta_url",
-                buttonParamsJson: JSON.stringify({
-                    display_text: "Telegram",
-                    url: "https://t.me/alannxd",
-                    merchant_url: "https://t.me/alannxd"
-                })
-            }
-        ]
+await client.sendMessage(
+    jid,
+    {
+        thumbnail: thumbnailBuffer,
+        message: "Order Example",
+        orderTitle: "AlannXD Store",
+        totalAmount1000: 50000,
+        totalCurrencyCode: "IDR"
     }
-}, { quoted: m });
+);
 ```
 
-### Request Payment Message
-Send payment request messages with custom background and sticker:
+---
+
+### Poll Result Snapshot
+
+Display poll result snapshot.
 
 ```javascript
-let quotedType = m.quoted?.mtype || '';
-let quotedContent = JSON.stringify({ [quotedType]: m.quoted }, null, 2);
-
-await sock.sendMessage(jid, {
-    requestPaymentMessage: {
-        currency: "IDR",
-        amount: 10000000,
-        from: m.sender,
-        sticker: JSON.parse(quotedContent),
-        background: {
-            id: "100",
-            fileLength: "0",
-            width: 1000,
-            height: 1000,
-            mimetype: "image/webp",
-            placeholderArgb: 0xFF00FFFF,
-            textArgb: 0xFFFFFFFF,     
-            subtextArgb: 0xFFAA00FF   
+await client.sendMessage(
+    jid,
+    {
+        pollResultMessage: {
+            name: "Example Poll",
+            options: [
+                {
+                    optionName: "Option 1"
+                },
+                {
+                    optionName: "Option 2"
+                }
+            ]
         }
     }
-}, { quoted: m });
+);
 ```
 
 ---
@@ -455,10 +510,10 @@ Thanks to the following awesome contributors who help improve this project 💖
       </a>
     </td>
     <td align="center">
-      <a href="https://github.com/z4phdev">
-        <img src="https://github.com/z4phdev.png" width="80px;" style="border-radius:50%;" alt="Developer"/>
+      <a href="https://github.com/tenka-san">
+        <img src="https://github.com/tenka-san.png" width="80px;" style="border-radius:50%;" alt="Developer"/>
         <br />
-        <sub><b>z4phdev</b></sub>
+        <sub><b>D | Yuukey-7eppeli</b></sub>
       </a>
     </td>
 <td align="center">