@alannxd/baileys 6.1.2 → 6.1.4

package/README.md

@@ -1,7 +1,7 @@
 # <div align='center'>Baileys - Typescript/Javascript WhatsApp Web API</div>
 
 <p align="center">
-  <img src="https://i.top4top.io/p_3463no0l00.jpg" alt="Thumbnail" />
+  <img src="https://img2.pixhost.to/images/9521/751472173_alan.jpg" alt="Thumbnail" />
 </p>
 
 <div align='center'>
@@ -51,413 +51,327 @@ Simple WhatsApp Web API Library Based On Baileys.
 
 ---
 
-# Installation
-
-### Install Package
-
-Install package using npm.
-
-```bash
-npm install @alannxd/baileys
+## Usage
+```json
+"depencies": {
+  "@alannxd/baileys": "latest"
+  // or "@whiskeysocket/baileys": "npm:@alannxd/baileys"
+}
 ```
-
----
-
-# Import
-
-### CommonJS
-
-Import package using require.
-
+## Import
 ```javascript
 const {
-    default: makeWASocket
-} = require("@alannxd/baileys");
-```
-
----
-
-### ES Module
-
-Import package using ES Module.
-
-```javascript
-import makeWASocket from "@alannxd/baileys";
+  default: makeWASocket,
+  // Other function
+} = require('@alannxd/baileys');
 ```
 
 ---
-
-# Connection Documentation
-
-### Connect With QR Code
-
-Connect WhatsApp using QR authentication.
-
+# How To Connect To Whatsapp
+## With QR Code
 ```javascript
 const {
-    default: makeWASocket,
-    Browsers
-} = require("@alannxd/baileys");
+  default: makeWASocket,
+  Browsers
+} = require('@alannxd/baileys');
 
 const client = makeWASocket({
-    browser: Browsers.ubuntu("Chrome"),
-    printQRInTerminal: true
-});
+  browser: Browsers.ubuntu('Chrome'),
+  printQRInTerminal: true
+})
 ```
 
----
-
-### Connect With Pairing Code
-
-Connect WhatsApp using phone number.
-
+## Connect With Number
 ```javascript
 const {
-    default: makeWASocket,
-    Browsers,
-    fetchLatestWAWebVersion
-} = require("@alannxd/baileys");
+  default: makeWASocket,
+  fetchLatestWAWebVersion,
+  Browsers
+} = require('@alannxd/baileys');
 
 const client = makeWASocket({
-    browser: Browsers.ubuntu("Chrome"),
-    printQRInTerminal: false,
-    version: fetchLatestWAWebVersion(),
-    aiLabel: false
+  browser: Browsers.ubuntu('Chrome'),
+  printQRInTerminal: false,
+  version: fetchLatestWAWebVersion()
+  aiLabel: false // enable for ai label in every message are bot send
+  // Other options
 });
 
-const code = await client.requestPairingCode("628xxxxxxxxxx");
+const number = "628XXXXX";
+const code = await client.requestPairingCode(number.trim) //Use : (number, "YYYYYYYY") for custom-pairing
 
-console.log(code);
+console.log("Ur pairing code : " + code)
 ```
 
----
-
-# Store Documentation
-
-### In Memory Store
-
-Store contacts, chats and messages in memory.
-
+# Store Data
 ```javascript
 const {
-    default: makeWASocket,
-    makeInMemoryStore
-} = require("@alannxd/baileys");
-
-const pino = require("pino");
+  default: makeWASocket,
+  makeInMemoryStore
+} = require('@alannxd/baileys');
+const pino = require('pino');
 
 const store = makeInMemoryStore({
-    logger: pino().child({
-        level: "silent",
-        stream: "store"
-    })
+  logger: pino().child({ level: 'silent', stream: 'store' })
 });
-
-store.bind(client.ev);
-```
-
----
-
-# Group Documentation
-
-### Member Label
-
-Send member label inside group.
-
-```javascript
-await client.sendMessage(jid, {
-    groupLabel: {
-        labelText: "Premium Member"
-    }
+const client = makeWASocket({
+  // option
 });
-```
-
----
+store.bind(client.ev)
 
-### Message Members
-
-Send message to all group members.
-
-```javascript
-await client.sendMessageMembers(
-    jid,
-    {
-        extendedTextMessage: {
-            text: "Hello Members"
-        }
-    },
-    {}
-);
+client.ev.on('contacts.upsert', () => {
+  console.log('Get new contact: ' + Object.values(store.contacts()));
+})
 ```
+# Sending messages
 
----
-
-# Utility Documentation
-
-### Check Channel Information
-
-Get newsletter information from URL.
-
+## send/relay message with participant
 ```javascript
-client.newsletterFromUrl(url);
+await client.relayMessage(m.chat, {
+  conversation: "Alann Winter's"
+}, {
+  participant: true
+})
+// or
+await client.sendMessage(m.chat, {
+  text: "Alann Winter's"
+}, {
+  participant: true
+})
 ```
-
-Result:
-
-```json
-{
-    "name": "Channel Name",
-    "id": "123456789",
-    "state": "ACTIVE",
-    "subscribers": "1000",
-    "verification": "UNVERIFIED",
-    "creation_time": 1728547155,
-    "description": "Channel Description"
-}
+## send orderMessage
+```javascript
+const fs = require('fs');
+const AlannXd = fs.readFileSync('./AlannXd');
+
+await client.sendMessage(m.chat, {
+  thumbnail: AlannXd,
+  message: "Gotta get a grip",
+  orderTitle: "Alann-Winters",
+  totalAmount1000: 72502,
+  totalCurrencyCode: "IDR"
+}, { quoted:m })
 ```
 
----
-
-### Check WhatsApp Number
-
-Check whether number exists on WhatsApp.
-
+## send pollResultSnapshotMessage
 ```javascript
-client.checkWhatsApp(jid);
+await client.sendMessage(m.chat, {
+  pollResultMessage: {
+    name: "Alann-Winters",
+    options: [
+      {
+        optionName: "poll 1"
+      },
+      {
+        optionName: "poll 2"
+      }
+    ],
+    newsletter: {
+      newsletterName: "ALANNXD | HOLOW",
+      newsletterJid: "1@newsletter"
+    }
+  }
+})
 ```
 
----
-
-# SendMessage Documentation
-
-### Send Text
-
-Send text message.
-
+## send productMessage
 ```javascript
-await client.sendText(
-    jid,
-    "Hello World"
-);
+await client.relayMessage(m.chat, {
+  productMessage {
+    title: "AlannWinter's",
+    description: "zazaza...",
+    thumbnail: { url: "./AlannXd" },
+    productId: "EXAMPLE_TOKEN",
+    retailerId: "EXAMPLE_RETAILER_ID",
+    url: "https://t.me/alannxd",
+    body: "Apalah ya",
+    footer: "Footer",
+    buttons: [
+      {
+        name: "cta_url",
+        buttonParamsJson: "{\"display_text\":\"AlannWinters\",\"url\":\"https://t.me/alannxd\"}"
+      }
+    ],
+    priceAmount1000: 72502,
+    currencyCode: "IDR"
+  }
+})
 ```
 
----
-
-### Send Image
-
-Send image message.
-
+## send interactiveMessage
 ```javascript
-await client.sendImage(
-    jid,
+await client.sendMessage(m.chat, {
+  image: { url: "./alxd.jpg" },
+  text: "body",
+  title: "title", // if media, should put title in
+  footer: "footer",
+  interactiveButtons: [
     {
-        url: "./image.jpg"
-    },
-    "Caption Here"
-);
+      name: "single_select",
+      buttonParamsJson: JSON.stringify({
+        title: "\0"
+      })
+    }
+  ],
+  messageParams: JSON.stringify({
+    bottom_sheet: {
+      /** ot params **/
+    }
+  })
+})
 ```
 
----
-
-### Send Video
-
-Send video message.
-
+## send member label
 ```javascript
-await client.sendVideo(
-    jid,
-    {
-        url: "./video.mp4"
-    },
-    "Caption Here"
-);
+await client.sendMessage(m.chat, {
+  groupLabel: {
+    labelText: "Tag anggota tercantum di sini"
+  }
+})
 ```
 
----
-
-### Send Audio
-
-Send audio message.
-
+## send message to members in group
 ```javascript
-await client.sendAudio(
-    jid,
-    {
-        url: "./audio.mp3"
-    }
-);
+await client.sendMessageMembers(m.chat, {
+  extendedTextMessage: {
+    text: "woik sialan"
+  }
+}, {})
 ```
+# Simple sendMessage
 
----
-
-### Send Location
-
-Send location message.
-
+## send text
 ```javascript
-await client.sendLocation(
-    jid,
-    "AlannXD",
-    -6.2,
-    106.8,
-    "https://example.com",
-    "123456789"
-);
+await client.sendText(m.chat, "AlannWinters", {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
-
----
-
-### Send Poll
-
-Create poll message.
-
+## send image
 ```javascript
-await client.sendPoll(
-    jid,
-    "Choose One",
-    [
-        "Option 1",
-        "Option 2",
-        "Option 3"
-    ],
-    true
-);
+await client.sendImage(m.chat, { url: "./alxd.jpg" }, "AlannWinters", {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Send Quiz
-
-Create quiz poll message.
-
+## send video
 ```javascript
-await client.sendQuiz(
-    jid,
-    "Question Here",
-    [
-        "A",
-        "B",
-        "C"
-    ],
-    "B"
-);
+await client.sendVideo(m.chat, { url: "./alanxd.mp4" }, "AlannWinters", {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Status Mention
-
-Mention users through status.
-
+## send audio
 ```javascript
-await client.statusMention(
-    jid,
-    {
-        extendedTextMessage: {
-            text: "Hello World"
-        }
-    }
-);
+await client.sendAudio(m.chat, { url: "./alanxd.mp3" }, {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Interactive Message
-
-Send interactive message.
-
+## send location
 ```javascript
-await client.sendMessage(
-    jid,
-    {
-        image: {
-            url: "./image.jpg"
-        },
-        text: "Body Message",
-        title: "Hello World",
-        footer: "AlannXD",
-        interactiveButtons: [
-            {
-                name: "single_select",
-                buttonParamsJson: JSON.stringify({
-                    title: "Menu"
-                })
-            }
-        ]
-    }
-);
+await client.sendLocation(m.chat, "AlannWinters", 90.0, 90.0, "https://t.me/alannxd", "1234567890", {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Product Message
-
-Send product catalog message.
-
+## send polling
 ```javascript
-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"
-        }
-    }
-);
+await client.sendPoll(m.chat, "AlannWinters", ["1", "2", "3"], true, {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Order Message
-
-Send order message.
-
+## send quiz
 ```javascript
-await client.sendMessage(
-    jid,
-    {
-        thumbnail: thumbnailBuffer,
-        message: "Order Example",
-        orderTitle: "AlannXD Store",
-        totalAmount1000: 50000,
-        totalCurrencyCode: "IDR"
-    }
-);
+await client.sendQuiz(m.chat, "AlannWinters", ["1", "2", "3"], "2", {
+  contextInfo: {
+    mentionedJid: [m.chat]
+  }
+}, {
+  key: {
+    remoteJid: "status@broadcast",
+    participant: m.sender,
+    fromMe: true
+  },
+  message: {
+    conversation: "\0"
+  }
+})
 ```
 
----
-
-### Poll Result Snapshot
-
-Display poll result snapshot.
-
+## send status mention
 ```javascript
-await client.sendMessage(
-    jid,
-    {
-        pollResultMessage: {
-            name: "Example Poll",
-            options: [
-                {
-                    optionName: "Option 1"
-                },
-                {
-                    optionName: "Option 2"
-                }
-            ]
-        }
-    }
-);
+await client.statusMention(m.chat, {
+  extendedTextMessage: {
+    text: "AlannWinters"
+  }
+})
 ```
 
 ---
@@ -496,9 +410,9 @@ For questions, support, or collaboration, feel free to contact the developer:
 - **Telegram**: [Telegram Contact](https://t.me/alannxd)
 - **Channel WhatsApp**: [Channel WhatsApp](https://whatsapp.com/channel/0029Vb3IiqTL7UVP9A9n0w1x) 
 
-### 🙌 Contributors outside the Baileys code
+### Contributors outside the Baileys code
 
-Thanks to the following awesome contributors who help improve this project 💖
+Thanks to the following awesome contributors who help improve this project
 
 <table>
   <tr>
@@ -524,11 +438,12 @@ Thanks to the following awesome contributors who help improve this project 💖
       </a>
     </td>
     <td align="center">
-      <a href="https://github.com/RexxHayanasi">
-        <img src="https://github.com/RexxHayanasi.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
+      <a href="https://github.com/Xcoursed">
+        <img src="https://github.com/Xcoursed.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
         <br />
-        <sub><b>RexxHayanasi</b></sub>
+        <sub><b>Xcoursed</b></sub>
       </a>
     </td>
   </tr>
 </table>
+