violetics 7.0.1-alpha → 7.0.3-alpha

package/README.md

@@ -1,318 +1,1087 @@
-<div align="center">
-  <h1>🌟 Violetics Baileys</h1>
-  <p><i>A professionally enhanced, feature-rich version of the Baileys WhatsApp Web API</i></p>
+# 🌱 Violetics
 
-  [![npm version](https://img.shields.io/npm/v/violetics.svg?style=for-the-badge)](https://www.npmjs.com/package/violetics)
-  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE)
-</div>
+![Logo](https://files.catbox.moe/c5s9g0.jpg)
 
-<br/>
+A lightweight fork of Baileys with a few fixes and a small adjustment.
 
-Built for developers requiring robust WhatsApp automation with modern tooling, enhanced stability, and comprehensive documentation to handle **Hundreds of Sessions (Multi-Device)** concurrently using **SQLite**.
+### ⚙️ Changes
 
----
+#### 🛠️ Internal Adjustments
+- 🖼️ Fixed an issue where media could not be sent to newsletters due to an upstream issue.
+- 📁 Reintroduced [`makeInMemoryStore`](#%EF%B8%8F-implementing-a-data-store) with a minimal ESM adaptation and small adjustments for Baileys v7.
+- 📦 Switched FFmpeg execution from `exec` to `spawn` for safer process handling.
+- 🗃️ Added `@napi-rs/image` as a supported image processing backend in `getImageProcessingLibrary()`, offering a balance between performance and compatibility.
 
-## 📋 Table of Contents
+#### 📨 Message Handling & Compatibility
+- 👉🏻 Added support for sending [interactive message](#-sending-interactive-messages) types (button, list, interactive, template, carousel).
+- 📩 Added support for [album messages](#%EF%B8%8F-album-image--video), [group status messages](#4%EF%B8%8F⃣-group-status), [status mention messages](#%EF%B8%8F-status-mention), [sticker pack messages](#-sticker-pack), and several [payment-related messages](#-sending-payment-messages) (request payment, payment invite, order, invoice).
+- 📰 Simplified sending messages with ad thumbnails via [`externalAdReply`](#3%EF%B8%8F⃣-external-ad-reply) without requiring manual `contextInfo`.
 
-- [✨ Features](#-features)
-- [📦 Installation](#-installation)
-- [🚀 Quick Start](#-quick-start)
-- [🔌 Connection & Configuration](#-connection--configuration)
-- [💾 Handling Hundreds of Sessions (SQLite)](#-handling-hundreds-of-sessions-sqlite)
-- [📥 Core Features (Messages, Groups, Profile)](#-core-features)
-- [⚖️ Legal Notice](#️-legal-notice)
+#### 🧩 Additional Message Options
+- 👁️ Added optional boolean flags for message handling:  
+   - [`ai`](#1%EF%B8%8F⃣-ai-label) - AI label on message
+   - [`mentionAll`](#-mention) - Mentions all group participants without requiring their JIDs in `mentions` or `mentionedJid`
+   - [`ephemeral`](#2%EF%B8%8F⃣-ephemeral), [`groupStatus`](#4%EF%B8%8F⃣-group-status), [`viewOnceV2`](#7%EF%B8%8F⃣-view-once-v2), [`viewOnceV2Extension`](#8%EF%B8%8F⃣-view-once-v2-extension), [`interactiveAsTemplate`](#3%EF%B8%8F⃣-interactive) - Message wrappers
+   - [`raw`](#5%EF%B8%8F⃣-raw) - Build your message manually **(DO NOT USE FOR EXPLOITATION)**
 
----
+> [!NOTE]
+📄 This project is maintained with limited scope and is not intended to replace upstream Baileys.
+>
+> 😞 And, really sorry for my bad english.
 
-## ✨ Features
+### 📥 Installation
 
-- 🚀 **Modern & Fast** – Built with TypeScript and latest technologies.
-- 🔧 **Production Ready Stability** – Modified Web Socket client configurations, custom ping/pong keep-alives, and connection limits removed to prevent random logouts.
-- 📱 **Multi-Device Support** – Full support for WhatsApp's multi-device protocol.
-- 🔐 **End-to-End Encryption** – Secure communication using Signal Protocol.
-- 📨 **All Message Types** – Support for text, media, documents, contacts, locations, polls, reactions, and more.
-- 👥 **Advanced Group Management** – Comprehensive controls including unique group status support.
-- 🛠️ **Developer Friendly** – Clean API, extensive examples, and detailed documentation.
+- 📄 Via `package.json`
 
----
+```json
+# NPM
+"dependencies": {
+   "violetics": "latest"
+}
+
+# GitHub
+"dependencies": {
+   "violetics": "github:cv3inx/violetics"
+}
+```
 
-## 📦 Installation
+- ⌨️ Via terminal
 
-### Via NPM
 ```bash
-npm install violetics
+# NPM
+npm i violetics@latest
+
+# GitHub
+npm i github:cv3inx/violetics
 ```
 
-### Via GitHub
-```bash
-npm install github:cv3inx/violetics.git
+#### 🧩 Import (ESM & CJS)
+
+```javascript
+// --- ESM
+import { makeWASocket } from 'violetics'
+
+// --- CJS (tested and working on Node.js 24 ✅)
+const { makeWASocket } = require('violetics')
 ```
 
----
+### 🔧 Usage
+
+#### 🌐 Connect to WhatsApp (Quick Step)
+
+```javascript
+import { makeWASocket, delay, DisconnectReason, useMultiFileAuthState } from 'violetics'
+import { Boom } from '@hapi/boom'
+import pino from 'pino'
+
+// --- Connect with pairing code
+const myPhoneNumber = '6288888888888'
+
+const logger = pino({ level: 'silent' })
 
-## 🚀 Quick Start
+const connectToWhatsApp = async () => {
+   const { state, saveCreds } = await useMultiFileAuthState('session')
+    
+   const sock = makeWASocket({
+      logger,
+      auth: state
+   })
+
+   sock.ev.on('creds.update', saveCreds)
+
+   sock.ev.on('connection.update', (update) => {
+      const { connection, lastDisconnect } = update
+      if (connection === 'connecting' && !sock.authState.creds.registered) {
+         await delay(1500)
+         const code = await sock.requestPairingCode(myPhoneNumber)
+         console.log('🔗 Pairing code', ':', code)
+      }
+      else if (connection === 'close') {
+         const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
+         console.log('⚠️ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
+         if (shouldReconnect) {
+            connectToWhatsApp()
+         }
+      }
+      else if (connection === 'open') {
+         console.log('✅ Successfully connected to WhatsApp')
+      }
+   })
+
+   sock.ev.on('messages.upsert', async ({ messages }) => {
+      for (const message of messages) {
+         if (!message.message) continue
+
+         console.log('🔔 Got new message', ':', message)
+         await sock.sendMessage(message.key.remoteJid, {
+            text: '👋🏻 Hello world'
+         })
+      }
+   })
+}
 
-Here is a basic example to get you connected and listening to messages using standard File Authentication.
+connectToWhatsApp()
+```
+
+#### 🗄️ Implementing a Data Store
+
+> [!CAUTION]
+I highly recommend building your own data store, as keeping an entire chat history in memory can lead to excessive RAM usage.
 
 ```javascript
-const { makeWASocket, useMultiFileAuthState, DisconnectReason } = require('violetics');
-const { Boom } = require('@hapi/boom');
+import { makeWASocket, makeInMemoryStore, delay, DisconnectReason, useMultiFileAuthState } from 'violetics'
+import { Boom } from '@hapi/boom'
+import pino from 'pino'
+
+const myPhoneNumber = '6288888888888'
+
+// --- Create your store path
+const storePath = './store.json'
+
+const logger = pino({ level: 'silent' })
 
-async function connectToWhatsApp() {
-    const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys');
+const connectToWhatsApp = async () => {
+   const { state, saveCreds } = await useMultiFileAuthState('session')
     
-    const sock = makeWASocket({
-        auth: state,
-        printQRInTerminal: true,
-        browser: ["Ubuntu", "Chrome", "125"],
-    });
-
-    sock.ev.on('connection.update', (update) => {
-        const { connection, lastDisconnect } = update;
-        if (connection === 'close') {
-            const shouldReconnect = (lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut;
-            console.log('Connection closed. Reconnecting:', shouldReconnect);
-            if (shouldReconnect) connectToWhatsApp();
-        } else if (connection === 'open') {
-            console.log('✅ Successfully connected to WhatsApp!');
-        }
-    });
-
-    sock.ev.on('messages.upsert', async ({ messages }) => {
-        const m = messages[0];
-        if (!m.message || m.key.fromMe) return;
-        
-        // Auto-reply example
-        if (m.message.conversation === 'ping') {
-            await sock.sendMessage(m.key.remoteJid, { text: 'pong!' });
-        }
-    });
-
-    // Save credentials when updated (debounced by default in this library)
-    sock.ev.on('creds.update', saveCreds);
+   const sock = makeWASocket({
+      logger,
+      auth: state
+   })
+
+   const store = makeInMemoryStore({
+      logger,
+      socket: sock
+   })
+
+   store.bind(sock.ev)
+
+   sock.ev.on('creds.update', saveCreds)
+
+   sock.ev.on('connection.update', (update) => {
+      const { connection, lastDisconnect } = update
+      if (connection === 'connecting' && !sock.authState.creds.registered) {
+         await delay(1500)
+         const code = await sock.requestPairingCode(myPhoneNumber)
+         console.log('🔗 Pairing code', ':', code)
+      }
+      else if (connection === 'close') {
+         const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
+         console.log('⚠️ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
+         if (shouldReconnect) {
+            connectToWhatsApp()
+         }
+      }
+      else if (connection === 'open') {
+         console.log('✅ Successfully connected to WhatsApp')
+      }
+   })
+
+   sock.ev.on('chats.upsert', () => {
+      console.log('✉️ Got chats', store.chats.all())
+   })
+
+   sock.ev.on('contacts.upsert', () => {
+      console.log('👥 Got contacts', Object.values(store.contacts))
+   })
+
+   // --- Read store from file
+   store.readFromFile(storePath)
+
+   // --- Save store every 3 minutes
+   setInterval(() => {
+      store.writeToFile(storePath)
+   }, 180000)
 }
 
-connectToWhatsApp();
+connectToWhatsApp()
 ```
 
----
+#### 🪪 WhatsApp IDs Explain
 
-## 🔌 Connection & Configuration
+`id` is the WhatsApp ID, called `jid` and `lid` too, of the person or group you're sending the message to.
+- It must be in the format `[country code][phone number]@s.whatsapp.net`
+   - Example for people: `19999999999@s.whatsapp.net` and `12699999999@lid`.
+   - For groups, it must be in the format `123456789-123345@g.us`.
+- For Meta AI, it's `11111111111@bot`.
+- For broadcast lists, it's `[timestamp of creation]@broadcast`.
+- For stories, the ID is `status@broadcast`.
 
-### Connect via Pairing Code (No QR)
+#### ✉️ Sending Messages
 
-If you're running the bot on a remote server without a terminal, you can pair using an 8-digit code instead of scanning a QR code.
+> [!NOTE]
+You can get the `jid` from `message.key.remoteJid` in the first example.
+
+##### 🔠 Text
 
 ```javascript
-const sock = makeWASocket({ printQRInTerminal: false });
+sock.sendMessage(jid, {
+   text: '👋🏻 Hello'
+}, {
+   quoted: message
+})
+```
 
-if (!sock.authState.creds.registered) {
-    const phoneNumber = '1234567890'; // Include country code, no symbols
-    const pairingCode = await sock.requestPairingCode(phoneNumber);
-    console.log('🔑 Your Pairing Code:', pairingCode);
-}
+##### 🔔 Mention
+
+```javascript
+// --- Regular mention
+sock.sendMessage(jid, {
+   text: '👋🏻 Hello @628123456789',
+   mentions: ['628123456789@s.whatsapp.net']
+}, {
+   quoted: message
+})
+
+// --- Mention all
+sock.sendMessage(jid, {
+   text: '👋🏻 Hello @all',
+   mentionAll: true
+}, {
+   quoted: message
+})
 ```
 
----
+##### 😁 Reaction
+
+```javascript
+sock.sendMessage(jid, {
+   react: {
+      key: message.key,
+      text: '✨'
+   }
+}, {
+   quoted: message
+})
+```
+
+##### 📌 Pin Message
+
+```javascript
+sock.sendMessage(jid, {
+   pin: message.key,
+   time: 86400, // --- Set the value in seconds: 86400 (1d), 604800 (7d), or 2592000 (30d)
+   type: 1 // --- Or 0 to remove
+}, {
+   quoted: message
+})
+```
 
-## 💾 Handling Hundreds of Sessions (SQLite)
+##### 👤 Contact
 
-Jika target Anda adalah merender **Ratusan Bot secara bersamaan** dalam 1 Node.js Process, **file JSON biasa sangat tidak dianjurkan** karena rentan lock-file race condition dan limitasi sinkronisasi disk I/O, yang memicu masalah `Connection Closed` atau `DisconnectReason.loggedOut` tiba-tiba karena Socket API kehabisan waktu memanggil Event Emitter.
+```javascript
+const vcard = 'BEGIN:VCARD\n'
+            + 'VERSION:3.0\n'
+            + 'FN:Lia Wynn\n'
+            + 'ORG:Waiters;\n'
+            + 'TEL;type=CELL;type=VOICE;waid=628123456789:+62 8123 4567 89\n'
+            + 'END:VCARD'
+
+sock.sendMessage(jid, {
+   contacts: {
+      displayName: 'Lia',
+      contacts: [
+         { vcard }
+      ]
+   }
+}, {
+   quoted: message
+})
+```
 
-Gunakan **SQLite** untuk auth *Multi-Session* dengan tiga aturan vital:
+##### 📍 Location
 
-### 1. Gunakan Mode SQLite `WAL`
-SQLite biasanya mengunci database saat sedang diproses (*Database is locked*). Untuk mematikan lock tersebut, pastikan perintah ini selalu berjalan di koneksi pertama inisialisasi SQLite Anda:
-```sql
-PRAGMA journal_mode=WAL;
-PRAGMA synchronous=NORMAL;
-PRAGMA cache_size=-64000;
+```javascript
+sock.sendMessage(jid, {
+   location: {
+      degreesLatitude: 24.121231,
+      degreesLongitude: 55.1121221,
+      name: '👋🏻 I am here'
+   }
+}, {
+   quoted: message
+})
 ```
 
-### 2. Hindari `Sync` Database Queries
-Menggunakan fungsi bawaan `better-sqlite3` dengan eksekusi *sync* (seperti `db.prepare(query).run()`) dapat mem-blok *event loop* Node.js untuk mengeksekusi *callback* dari lib WhatsApp, menyebabkan ping-pong timeout.  
-Gunakan pendekatan koneksi SQLite *asynchronous* (`async/await`) atau *Worker Threads*.
+##### 📊 Poll
 
-### 3. Gunakan `addTransactionCapability`
-Ratusan WhatsApp session menghasilkan jutaan Signal Keys selama pertukaran PreKey login. Menyimpan data satu-per-satu ke SQLite secara harfiah akan merusak login sinkronisasi Anda! Anda diwajibkan menggunakan pembungkus Native `addTransactionCapability` yang terdapat dalam library ini.
+```javascript
+// --- Regular poll message
+sock.sendMessage(jid, {
+   poll: {
+      name: '🔥 Voting time',
+      values: ['Yes', 'No'],
+      selectableCount: 1,
+      toAnnouncementGroup: false
+   }
+}, {
+   quoted: message
+})
+
+// --- Quiz (only for newsletter)
+sock.sendMessage('1211111111111@newsletter', {
+   poll: {
+      name: '🔥 Quiz',
+      values: ['Yes', 'No'],
+      correctAnswer: 'Yes',
+      pollType: 1
+   }
+}, {
+   quoted: message
+})
+
+// --- Poll result
+sock.sendMessage(jid, {
+   pollResult: {
+      name: '📝 Poll Result',
+      votes: [{
+         name: 'Nice',
+         voteCount: 10
+      }, {
+         name: 'Nah',
+         voteCount: 2
+      }],
+      pollType: 0 // Or 1 for quiz
+   }
+}, {
+   quoted: message
+})
+
+// --- Poll update
+sock.sendMessage(jid, {
+   pollUpdate: {
+      metadata: {},
+      key: message.key,
+      vote: {
+         enclv: /* <Buffer> */,
+         encPayload: /* <Buffer> */
+      }
+   }
+}, {
+   quoted: message
+})
+```
+
+##### 🎞️ Status Mention
 
-**Contoh Template Asinkron Auth Bot SQLite:**
 ```javascript
-const { addTransactionCapability, initAuthCreds } = require('violetics');
+sock.sendMessage([jidA, jidB, jidC], {
+   text: 'Hello! 👋🏻'
+})
+```
 
-// Membungkus Database Custom Anda ke Session Bot
-function makeSqliteAuthState(dbConnection, sessionId) {
-    const state = {
-        get: async (type, ids) => {
-            // TODO: Ambil row dari tabel session secara `async`
-            // return dict { [id]: data }
-        },
-        set: async (data) => {
-            // TODO: Insert/Update row ke tabel SQLite secara `async`
-        }
-    };
+#### 📁 Sending Media Messages
 
-    // WAJIB: Membungkus transaksi Anda agar dieksekusi dalam bentuk 'Batch' 
-    // Setiap transaksi Signal WhatsApp akan disimpan 100 sekaligus tanpa spam query DB
-    const keys = addTransactionCapability(state, console, {
-        maxCommitRetries: 10,
-        delayBetweenTriesMs: 3000
-    });
+> [!NOTE]
+For media messages, you can pass a `Buffer` directly, or an object with either `{ stream: Readable }` or `{ url: string }` (local file path or HTTP/HTTPS URL).
 
-    return {
-        state: {
-            creds: /* creds dari database dbConnection */,
-            keys
-        },
-        saveCreds: () => {
-            // Simpan perubahan kredensial
-            // Sebaiknya Anda buat fungsi "Debounce" disini selama 2 detik
-            // agar tidak menyebabkan CPU Spike saat Login Pertama Kali
-        }
-    }
-}
+##### 🖼️ Image
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '🔥 Superb'
+}, {
+   quoted: message
+})
 ```
 
----
+##### 🎥 Video
 
-## 📥 Core Features
+```javascript
+sock.sendMessage(jid, {
+   video: {
+      url: './path/to/video.mp4'
+   },
+   gifPlayback: false, // --- Set true if you want to send video as GIF
+   ptv: false,  // --- Set true if you want to send video as PTV
+   caption: '🔥 Superb'
+}, {
+   quoted: message
+})
+```
 
-<details>
-<summary><b>📤 Sending Messages</b></summary>
-<br>
+##### 📃 Sticker
 
 ```javascript
-// 1. Text message
-await sock.sendMessage(jid, { text: 'Hello World!' });
+sock.sendMessage(jid, {
+   sticker: {
+      url: './path/to/sticker.webp'
+   }
+}, {
+   quoted: message
+})
+```
 
-// 2. Mention users
-await sock.sendMessage(jid, {
-    text: 'Hello @12345678901!',
-    mentions: ['12345678901@s.whatsapp.net']
-});
+##### 💽 Audio
+
+```javascript
+sock.sendMessage(jid, {
+   audio: {
+      url: './path/to/audio.mp3'
+   },
+   ptt: false, // --- Set true if you want to send audio as Voice Note
+}, {
+   quoted: message
+})
+```
 
-// 3. Send Media (Image)
-await sock.sendMessage(jid, {
-    image: { url: './path/to/image.jpg' },
-    caption: 'Check out this image!'
-});
+##### 🖼️ Album (Image & Video)
 
-// 4. Send Poll
-await sock.sendMessage(jid, {
-    poll: {
-        name: 'Favorite Language?',
-        values: ['TypeScript', 'Python', 'Go'],
-        selectableCount: 1
-    }
-});
+```javascript
+sock.sendMessage(jid, {
+   album: [{
+      image: {
+         url: './path/to/image.jpg'
+      },
+      caption: '1st image'
+   }, {
+      video: {
+         url: './path/to/video.mp4'
+      },
+      caption: '1st video'
+   }, {
+      image: {
+         url: './path/to/image.jpg'
+      },
+      caption: '2nd image'
+   }, {
+      video: {
+         url: './path/to/video.mp4'
+      },
+      caption: '2nd video'
+   }]
+}, {
+   quoted: message
+})
 ```
-</details>
 
-<details>
-<summary><b>👥 Group Management</b></summary>
-<br>
+##### 📦 Sticker Pack
+
+> [!IMPORTANT]
+If `sharp` or `@napi-rs/image` is not installed, the `cover` and `stickers` must already be in WebP format.
 
 ```javascript
-// 1. Create a group
-const group = await sock.groupCreate('My Developer Group', ['123...@s.whatsapp.net']);
+sock.sendMessage(jid, {
+   cover: {
+      url: './path/to/image.webp'
+   },
+   stickers: [{
+      data: {
+         url: './path/to/image.webp'
+      }
+   }, {
+      data: {
+         url: './path/to/image.webp'
+      }
+   }, {
+      data: {
+         url: './path/to/image.webp'
+      }
+   }],
+   name: '📦 My Sticker Pack',
+   publisher: '🌟 Lia Wynn',
+   description: 'violetics'
+}, {
+   quoted: message
+})
+```
 
-// 2. Modify participants (Add, Remove, Promote)
-await sock.groupParticipantsUpdate(groupJid, ['123...@s.whatsapp.net'], 'add');
+#### 👉🏻 Sending Interactive Messages
 
-// 3. Update Group Info
-await sock.groupUpdateSubject(groupJid, 'New Amazing Name');
-await sock.groupUpdateDescription(groupJid, 'New description for the group');
+##### 1️⃣ Buttons
+
+```javascript
+// --- Regular buttons message
+sock.sendMessage(jid, {
+   text: '👆🏻 Buttons!',
+   footer: 'violetics',
+   buttons: [{
+      text: '👋🏻 SignUp',
+      id: '#SignUp'
+   }]
+}, {
+   quoted: message
+})
+
+// --- Buttons with Media & Native Flow
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👆🏻 Buttons and Native Flow!',
+   footer: 'violetics',
+   buttons: [{
+      text: '👋🏻 Rating',
+      id: '#Rating'
+   }, {
+      text: '📋 Select',
+      sections: [{
+         title: '✨ Section 1',
+         rows: [{
+            header: '',
+            title: '💭 Secret Ingredient',
+            description: '',
+            id: '#SecretIngredient'
+         }]
+      }, {
+         title: '✨ Section 2',
+         highlight_label: '🔥 Popular',
+         rows: [{
+            header: '',
+            title: '🏷️ Coupon',
+            description: '',
+            id: '#CouponCode'
+         }]
+      }]
+   }]
+}, {
+   quoted: message
+})
 ```
-</details>
 
-<details>
-<summary><b>📢 Newsletter (Channels) API</b></summary>
-<br>
+##### 2️⃣ List
 
-Full support for WhatsApp Newsletters (Channels). Manage, fetch, and react to channel updates!
+> [!NOTE]
+It only works in private chat (`@s.whatsapp.net`).
 
 ```javascript
-// 1. Fetch Newsletter by Invitelink/URL
-const channelData = await sock.newsletterFromUrl('https://whatsapp.com/channel/0029...');
+sock.sendMessage(jid, {
+   text: '📋 List!',
+   footer: 'violetics',
+   buttonText: '📋 Select',
+   title: '👋🏻 Hello',
+   sections: [{
+      title: '🚀 Menu 1',
+      rows: [{
+         title: '✨ AI',
+         description: '',
+         rowId: '#AI'
+      }]
+   }, {
+      title: '🌱 Menu 2',
+      rows: [{
+         title: '🔍 Search',
+         description: '',
+         rowId: '#Search'
+      }]
+   }]
+}, {
+   quoted: message
+})
+```
+
+##### 3️⃣ Interactive
 
-// 2. Follow / Unfollow a Channel
-await sock.newsletterFollow(channelJid);
-await sock.newsletterUnfollow(channelJid);
+```javascript
+// --- Native Flow
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '🗄️ Interactive!',
+   footer: 'violetics',
+   optionText: '👉🏻 Select Options', // --- Optional, wrap all native flow into a single list
+   optionTitle: '📄 Select Options', // --- Optional
+   couponText: '🏷️ Newest Coupon!', // --- Optional, add coupon into message
+   couponCode: 'violetics', // --- Optional
+   nativeFlow: [{
+      text: '👋🏻 Greeting',
+      id: '#Greeting'
+   }, {
+      text: '📞 Call',
+      call: '628123456789'
+   }, {
+      text: '📋 Copy',
+      copy: 'violetics'
+   }, {
+      text: '🌐 Source',
+      url: 'https://www.npmjs.com/package/baileys'
+   }, {
+      text: '📋 Select',
+      sections: [{
+         title: '✨ Section 1',
+         rows: [{
+            header: '',
+            title: '🏷️ Coupon',
+            description: '',
+            id: '#CouponCode'
+         }]
+      }, {
+         title: '✨ Section 2',
+         highlight_label: '🔥 Popular',
+         rows: [{
+            header: '',
+            title: '💭 Secret Ingredient',
+            description: '',
+            id: '#SecretIngredient'
+         }]
+      }]
+   }],
+   interactiveAsTemplate: false, // --- Optional, wrap the interactive message into a template
+}, {
+   quoted: message
+})
+
+// --- Carousel & Native Flow
+sock.sendMessage(jid, {
+   text: '🗂️ Interactive with Carousel!',
+   footer: 'violetics',
+   cards: [{
+      image: {
+         url: './path/to/image.jpg'
+      },
+      caption: '🖼️ Image 1',
+      footer: '🏷️️ Pinterest',
+      nativeFlow: [{
+         text: '🌐 Source',
+         url: 'https://www.npmjs.com/package/baileys'
+      }]
+   }, {
+      image: {
+         url: './path/to/image.jpg'
+      },
+      caption: '🖼️ Image 2',
+      footer: '🏷️ Pinterest',
+      couponText: '🏷️ New Coupon!',
+      couponCode: 'violetics',
+      nativeFlow: [{
+         text: '🌐 Source',
+         url: 'https://www.npmjs.com/package/baileys'
+      }]
+   }, {
+      image: {
+         url: './path/to/image.jpg'
+      },
+      caption: '🖼️ Image 3',
+      footer: '🏷️ Pinterest',
+      optionText: '👉🏻 Select Options',
+      optionTitle: '📄 Select Options',
+      couponText: '🏷️ New Coupon!',
+      couponCode: 'violetics',
+      nativeFlow: [{
+         text: '🛒 Product',
+         id: '#Product'
+      }, {
+         text: '🌐 Source',
+         url: 'https://www.npmjs.com/package/baileys'
+      }]
+   }]
+}, {
+   quoted: message
+})
+```
 
-// 3. Mute / Unmute
-await sock.newsletterMute(channelJid);
-await sock.newsletterUnmute(channelJid);
+##### 4️⃣ Hydrated Template
 
-// 4. Create a new Channel
-const newChannel = await sock.newsletterCreate('My Channel', 'Description here', 'ALL');
+```javascript
+sock.sendMessage(jid, {
+   title: '👋🏻 Hello',
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '🫙 Template!',
+   footer: 'violetics',
+   templateButtons: [{
+      text: '👉🏻 Tap Here',
+      id: '#Order'
+   }, {
+      text: '🌐 Source',
+      url: 'https://www.npmjs.com/package/baileys'
+   }, {
+      text: '📞 Call',
+      call: '628123456789'
+   }]
+}, {
+   quoted: message
+})
+```
 
-// 5. Fetch Subscribed Channels & Messages
-const mySubscriptions = await sock.newsletterFetchAllSubscribe();
-console.log(mySubscriptions); // List of your followed newsletters
+#### 💳 Sending Payment Messages
 
-const messages = await sock.newsletterFetchMessages('get', channelJid, 50);
+##### 1️⃣ Invite Payment
 
-// 6. Update Channel Info
-await sock.newsletterUpdateName(channelJid, 'New Name');
-await sock.newsletterUpdateDescription(channelJid, 'New Description');
-await sock.newsletterUpdatePicture(channelJid, buffer);
+```javascript
+sock.sendMessage(jid, {
+   paymentInviteServiceType: 3 // 1, 2, or 3
+})
 ```
-</details>
 
-<details>
-<summary><b>✨ Advanced Messages (Violetics)</b></summary>
-<br>
+##### 2️⃣ Invoice
 
-Violetics implements advanced parsing and sending for native flow menus, albums, events, and unique status interactions directly through the `sock` instance!
+> [!NOTE]
+Invoice message are not supported yet.
 
 ```javascript
-// 1. Send Interactive Message (Buttons & Media)
-const interactive = await sock.handleInteractive(jid, {
-    interactiveMessage: {
-        title: "Main Menu",
-        footer: "Powered by Violetics",
-        header: "Select an option",
-        buttons: [
-            { name: 'quick_reply', buttonParamsJson: '{"display_text":"Option 1","id":"opt1"}' },
-            { name: 'cta_url', buttonParamsJson: '{"display_text":"Visit Site","url":"https://example.com"}' }
-        ]
-    }
-}, { quoted: messageObject }); // Pass quoting using the `options` object
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   invoiceNote: '🏷️ Invoice'
+})
+```
 
-await sock.relayMessage(jid, interactive.interactiveMessage, {});
+##### 3️⃣ Order
 
-// 2. Send Album (Multiple Media)
-await sock.handleAlbum(jid, [
-    { image: { url: './image1.jpg' } },
-    { video: { url: './video1.mp4' } }
-]);
+```javascript
+sock.sendMessage(chat, {
+   orderText: '🛍️ Order',
+   thumbnail: fs.readFileSync('./path/to/image.jpg') // --- Must in buffer format
+}, {
+   quoted: message
+})
+```
 
-// 3. Send Group / Private WhatsApp Status with Mentions
-await sock.sendStatusWhatsApp(['12345678901@s.whatsapp.net', '12345678902-1234@g.us'], {
-    text: "Check out this status!",
-    backgroundColor: "#ff0000",
-    font: 1
-});
+##### 4️⃣ Product
 
-// 4. Handle External Ad Replies, Payments, and Events natively!
-await sock.handleEvent(jid, {
-    eventMessage: {
-        name: "Developer Meetup",
-        description: "Join us for coding!",
-        joinLink: "https://zoom.us/...",
-        startTime: Date.now(),
-        endTime: Date.now() + 3600000
-    }
-});
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   product: {
+      title: '🛒 My Product'
+   },
+   businessOwnerJid: '0@s.whatsapp.net' // --- Must included
+}, {
+   quoted: message
+})
 ```
-</details>
 
----
+##### 5️⃣ Request Payment
+
+```javascript
+sock.sendMessage(jid, {
+   text: '💳 Request Payment',
+   requestPaymentFrom: '0@s.whatsapp.net'
+})
+```
+
+#### 👁️ Other Message Options
+
+##### 1️⃣ AI Label
+
+> [!NOTE]
+It only works in private chat (`@s.whatsapp.net`).
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '🤖 AI Labeled!',
+   ai: true
+}, {
+   quoted: message
+})
+```
+
+##### 2️⃣ Ephemeral
+
+> [!NOTE]
+Wrap message into `ephemeralMessage`
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👁️ Ephemeral',
+   ephemeral: true
+})
+```
+
+##### 3️⃣ External Ad Reply
+
+> [!NOTE]
+Add an ad thumbnail to messages (may not be displayed on some WhatsApp versions).
+
+```javascript
+sock.sendMessage(jid, {
+   text: '📰 External Ad Reply',
+   externalAdReply: {
+      title: '📝 Did you know?',
+      body: '❓ I dont know',
+      thumbnail: fs.readFileSync('./path/to/image.jpg'), // --- Must in buffer format
+      largeThumbnail: false, // --- Or true for bigger thumbnail
+      url: 'https://www.npmjs.com/package/baileys' // --- Optional, used for WhatsApp internal thumbnail caching and direct URL
+   }
+}, {
+   quoted: message
+})
+```
+
+##### 4️⃣ Group Status
+
+> [!NOTE]
+It only works in group chat (`@g.us`)
 
-## ⚖️ Legal Notice
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👥 Group Status!',
+   groupStatus: true
+})
+```
+
+##### 5️⃣ Raw
+
+```javascript
+sock.sendMessage(jid, {
+   extendedTextMessage: {
+      text: '📃 Built manually from scratch using the raw WhatsApp proto structure',
+      contextInfo: {
+         externalAdReply: {
+            title: 'violetics',
+            thumbnail: fs.readFileSync('./path/to/image.jpg'),
+            sourceApp: 'whatsapp',
+            showAdAttribution: true,
+            mediaType: 1
+         }
+      }
+   },
+   raw: true
+}, {
+   quoted: message
+})
+```
+
+##### 6️⃣ View Once
+
+> [!NOTE]
+Wrap message into `viewOnceMessage`
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👁️ View Once',
+   viewOnce: true
+})
+```
+
+##### 7️⃣ View Once V2
+
+> [!NOTE]
+Wrap message into `viewOnceMessageV2`
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👁️ View Once V2',
+   viewOnceV2: true
+})
+```
+
+##### 8️⃣ View Once V2 Extension
+
+> [!NOTE]
+Wrap message into `viewOnceMessageV2Extension`
+
+```javascript
+sock.sendMessage(jid, {
+   image: {
+      url: './path/to/image.jpg'
+   },
+   caption: '👁️ View Once V2 Extension',
+   viewOnceV2Extension: true
+})
+```
+
+#### 🧰 Additional Contents
+
+##### 🏷️ Find User ID (JID|PN/LID)
+
+> [!NOTE]
+The ID must contain numbers only (no +, (), or -) and must include the country code with WhatsApp ID format.
+
+```javascript
+// --- PN (Phone Number)
+const phoneNumber = '6281111111111@s.whatsapp.net'
+
+const ids = await sock.findUserId(phoneNumber)
+
+console.log('🏷️ Got user ID', ':', ids)
+
+// --- LID (Local Identifier)
+const lid = '43411111111111@lid'
+
+const ids = await sock.findUserId(lid)
+
+console.log('🏷️ Got user ID', ':', ids)
+
+// --- Output
+// {
+//    phoneNumber: '6281111111111@s.whatsapp.net',
+//    lid: '43411111111111@lid'
+// }
+// --- Output when failed
+// {
+//    phoneNumber: '6281111111111@s.whatsapp.net',
+//    lid: 'id-not-found'
+// }
+// --- Same output shape regardless of input type
+```
+
+##### 🔑 Request Custom Pairing Code
+
+> [!NOTE]
+The phone number must contain numbers only (no +, (), or -) and must include the country code.
+
+```javascript
+const phoneNumber = '6281111111111'
+const customPairingCode = 'STARFALL'
+
+await sock.requestPairingCode(phoneNumber, customPairingCode)
+
+console.log('🔗 Pairing code', ':', customPairingCode)
+```
+
+##### 📣 Newsletter Management
+
+```javascript
+// --- Create a new one
+sock.newsletterCreate('violetics')
+
+// --- Get info
+sock.newsletterMetadata('1231111111111@newsletter')
+
+// --- Demote admin
+sock.newsletterDemote('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
+
+// --- Change owner
+sock.newsletterChangeOwner('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
+
+// --- Change name
+sock.newsletterUpdateName('1231111111111@newsletter', '📦 violetics')
+
+// --- Change description
+sock.newsletterUpdateDescription('1231111111111@newsletter', '📣 Fresh updates weekly')
+
+// --- Change photo
+sock.newsletterUpdatePicture('1231111111111@newsletter', {
+   url: 'path/to/image.jpg'
+})
+
+// --- Remove photo
+sock.newsletterRemovePicture('1231111111111@newsletter')
+
+// --- React to a message
+sock.newsletterReactMessage('1231111111111@newsletter', '100', '💛')
+
+// --- Get all subscribed newsletters
+const newsletters = await sock.newsletterSubscribed()
+
+console.dir(newsletters, { depth: null })
+```
+
+##### 👥 Group Management
+
+```javascript
+// --- Create a new one and add participants using their JIDs
+sock.groupCreate('violetics', ['628123456789@s.whatsapp.net'])
+
+// --- Get info
+sock.groupMetadata(jid)
+
+// --- Get invite code
+sock.groupInviteCode(jid)
+
+// --- Revoke invite link
+sock.groupRevokeInvite(jid)
+
+// --- Leave group
+sock.groupLeave(jid)
+
+// --- Add participants
+sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'add')
+
+// --- Remove participants
+sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'remove')
+
+// --- Promote to admin
+sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'promote')
+
+// --- Demote from admin
+sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'demote')
+
+// --- Change name
+sock.groupUpdateSubject(jid, '📦 violetics')
+
+// --- Change description
+sock.groupUpdateDescription(jid, 'Updated description')
+
+// --- Change photo
+sock.updateProfilePicture(jid, {
+   url: 'path/to/image.jpg'
+})
+
+// --- Remove photo
+sock.removeProfilePicture(jid)
+
+// --- Set group as admin only for chatting
+sock.groupSettingUpdate(jid, 'announcement')
+
+// --- Set group as open to all for chatting
+sock.groupSettingUpdate(jid, 'not_announcement')
+
+// --- Set admin only can edit group info
+sock.groupSettingUpdate(jid, 'locked')
+
+// --- Set all participants can edit group info
+sock.groupSettingUpdate(jid, 'unlocked')
+
+// --- Set admin only can add participants
+sock.groupMemberAddMode(jid, 'admin_add')
+
+// --- Set all participants can add participants
+sock.groupMemberAddMode(jid, 'all_member_add')
+
+// --- Enable or disable temporary messages with seconds format
+sock.groupToggleEphemeral(jid, 86400)
+
+// --- Disable temporary messages
+sock.groupToggleEphemeral(jid, 0)
+
+// --- Enable or disable membership approval mode
+sock.groupJoinApprovalMode(jid, 'on')
+sock.groupJoinApprovalMode(jid, 'off')
+
+// --- Get all groups metadata
+const groups = await sock.groupFetchAllParticipating()
+
+console.dir(groups, { depth: null })
+
+// --- Get pending invites
+const invites = await sock.groupGetInviteInfo(code)
+
+console.dir(invites, { depth: null })
+
+// --- Accept group invite
+sock.groupAcceptInvite(code)
+
+// --- Get group info from link
+const group = await sock.groupGetInviteInfo('https://chat.whatsapp.com/ABC123')
+
+console.log('👥 Got group info from link', ':', group)
+```
 
-**Disclaimer**: This project is **NOT** affiliated with, authorized, maintained, sponsored, or endorsed by WhatsApp LLC or any of its affiliates. 
-- This library is intended for strictly legitimate automation purposes.
-- Do **NOT** use it for spamming, bulk reporting, or harassment.
-- Users are solely responsible for compliance with WhatsApp's Terms of Service. 
-- The maintainers assume **NO** liability for any damages, legal actions, or account bans caused by the use of this software.
+## 📦 Fork Base
+> [!NOTE]
+This fork is based on [Baileys (GitHub)](https://github.com/WhiskeySockets/Baileys)
+
+## 📣 Credits
+> [!IMPORTANT]
+This fork uses Protocol Buffer definitions maintained by [WPP Connect](https://github.com/wppconnect-team) via [`wa-proto`](https://github.com/wppconnect-team/wa-proto)
+> 
+> All rights belong to the original Baileys maintainers and contributors:
+> - [WhiskeySockets/Baileys](https://github.com/WhiskeySockets/Baileys)
+> - [purpshell](https://github.com/purpshell)
+> - [jlucaso1](https://github.com/jlucaso1)
+> - [adiwajshing](https://github.com/adiwajshing)