baileys-joss 1.0.2 → 2.0.0

package/README.md

@@ -1,2853 +1,1312 @@
-<p align="center">
-  <img src="https://raw.githubusercontent.com/firdausmntp/Baileys-Joss/main/Media/logo.png" alt="Baileys-Joss" width="200"/>
-</p>
-
-<h1 align="center">🚀 Baileys-Joss</h1>
-
-<p align="center">
-  <b>WhatsApp Web API Library dengan Fitur Ekstra Premium</b><br>
-  Fork dari <a href="https://github.com/WhiskeySockets/Baileys">Baileys</a> dengan penambahan fitur Interactive Button, Albums, AI Message, LID Plotting, dan lainnya.
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/baileys-joss"><img src="https://img.shields.io/npm/v/baileys-joss?color=brightgreen&label=npm&style=for-the-badge&logo=npm" alt="npm version"/></a>
-  <a href="https://www.npmjs.com/package/baileys-joss"><img src="https://img.shields.io/npm/dm/baileys-joss?color=blue&style=for-the-badge&logo=npm" alt="npm downloads"/></a>
-  <a href="https://www.npmjs.com/package/baileys-joss"><img src="https://img.shields.io/npm/dt/baileys-joss?color=blue&style=for-the-badge" alt="npm total downloads"/></a>
-</p>
-
-<p align="center">
-  <a href="https://github.com/firdausmntp/Baileys-Joss/blob/main/LICENSE"><img src="https://img.shields.io/github/license/firdausmntp/Baileys-Joss?style=for-the-badge&logo=opensourceinitiative&logoColor=white" alt="license"/></a>
-  <a href="https://github.com/firdausmntp/Baileys-Joss/stargazers"><img src="https://img.shields.io/github/stars/firdausmntp/Baileys-Joss?style=for-the-badge&logo=github&color=gold" alt="stars"/></a>
-  <a href="https://github.com/firdausmntp/Baileys-Joss/network/members"><img src="https://img.shields.io/github/forks/firdausmntp/Baileys-Joss?style=for-the-badge&logo=github&color=purple" alt="forks"/></a>
-  <a href="https://github.com/firdausmntp/Baileys-Joss/issues"><img src="https://img.shields.io/github/issues/firdausmntp/Baileys-Joss?style=for-the-badge&logo=github&color=red" alt="issues"/></a>
-</p>
-
-<p align="center">
-  <a href="#-installation">📦 Installation</a> •
-  <a href="#-features">✨ Features</a> •
-  <a href="#-quick-start">🚀 Quick Start</a> •
-  <a href="#-use-case-examples">💡 Examples</a> •
-  <a href="#-api-reference">📋 API</a> •
-  <a href="#-contributing">🤝 Contributing</a>
-</p>
-
-<p align="center">
-  <b>📖 Documentation:</b>
-  <a href="./README.md">🇮🇩 Indonesia</a> |
-  <a href="./docs/README.en.md">🇺🇸 English</a>
-</p>
-
-<p align="center">
-  <b>🎮 Full Demo:</b>
-  <a href="https://gist.github.com/firdausmntp/07f4698578a38b63d2ff0f8990fdb2ee">📝 Complete Example Code (Gist)</a> |
-  <a href="./Example/wa-baileys-joss-complete.js">📁 Local Example File</a>
-</p>
-
----
-
-## ✨ Kenapa Baileys-Joss?
-
-<table>
-<tr>
-<th align="center">🎯 Feature</th>
-<th align="center">Baileys Original</th>
-<th align="center">Baileys-Joss</th>
-</tr>
-<tr>
-<td>🖱️ Interactive Buttons</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📋 List Messages</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📋 Copy Code Button</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🔗 URL Buttons</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🔄 Combined Button Types</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🎨 Native Flow Messages</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>👤 LID/SenderPn Plotting</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🖼️ Album Messages</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🤖 AI Message Style</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📊 Poll Creation</td>
-<td align="center">✅</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>📢 Newsletter/Channel Control</td>
-<td align="center">✅</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>🔐 Custom Pairing Code</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📷 HD Profile Pictures</td>
-<td align="center">✅</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🔧 Fixed Button Delivery</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📸 HD Images (Uncompressed)</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🎬 HD Videos (Uncompressed)</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🌄 Panorama Profile Picture</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📅 Message Scheduling</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📨 Bulk Messaging</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🔄 Auto Reply System</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📇 Contact Card (vCard)</td>
-<td align="center">⚠️ Basic</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>📺 Status/Story Posting</td>
-<td align="center">⚠️ Basic</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>🎤 Voice Note Helper</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📋 Message Templates</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📡 Broadcast Manager</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>⌨️ Typing Indicator</td>
-<td align="center">⚠️ Basic</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>✅ Read Receipt Control</td>
-<td align="center">⚠️ Basic</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>🔍 Message Search</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>📊 Chat Analytics</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>💾 Chat Export</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🔗 QR Code Generator</td>
-<td align="center">⚠️ Basic</td>
-<td align="center">✅ Enhanced</td>
-</tr>
-<tr>
-<td>📁 Media Downloader</td>
-<td align="center">❌</td>
-<td align="center">✅</td>
-</tr>
-<tr>
-<td>🎮 Mini Games</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🔍 Content Detector</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🛡️ Anti-Spam System</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🔗 Link Scanner</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>📝 Activity Logger</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🎭 Meme Generator</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🍅 Pomodoro Timer</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>💬 Quote Generator</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-<tr>
-<td>🌤️ Weather Bot</td>
-<td align="center">❌</td>
-<td align="center">⚠️ Untested</td>
-</tr>
-</table>
-
----
-
-## 📦 Installation
-
-```bash
-# Menggunakan npm
-npm install baileys-joss
-
-# Menggunakan yarn
-yarn add baileys-joss
-
-# Menggunakan pnpm
-pnpm add baileys-joss
-```
-
-<details>
-<summary><b>📦 Via package.json (Fork Override)</b></summary>
-
-```json
-// Untuk mengganti @whiskeysockets/baileys
-{
-  "dependencies": {
-    "@whiskeysockets/baileys": "npm:baileys-joss"
-  }
-}
-
-// Untuk mengganti @adiwajshing/baileys
-{
-  "dependencies": {
-    "@adiwajshing/baileys": "npm:baileys-joss"
-  }
-}
-```
+<h1 align='center'><img alt="Baileys logo" src="https://raw.githubusercontent.com/WhiskeySockets/Baileys/refs/heads/master/Media/logo.png" height="75"/></h1>
 
-</details>
+<div align='center'>Baileys is a WebSockets-based TypeScript library for interacting with the WhatsApp Web API.</div>
 
----
 
-## 🎯 Features
+> [!CAUTION]
+> NOTICE OF BREAKING CHANGE.
+>
+> As of 7.0.0, multiple breaking changes were introduced into the library.
+>
+> Please check out https://whiskey.so/migrate-latest for more information.
 
-<details open>
-<summary><h3>🖱️ Interactive Messages & Buttons</h3></summary>
+# Important Note
+This is a temporary README.md, the new guide is in development and will this file will be replaced with .github/README.md (already a default on GitHub).
 
-Fitur button interactive yang lebih lengkap dan mudah digunakan:
+New guide link: https://baileys.wiki
 
-```typescript
-import { 
-    generateInteractiveButtonMessage,
-    generateInteractiveListMessage,
-    generateTemplateMessage,
-    generateCombinedButtons,
-    generateCopyCodeButton,
-    generateUrlButtonMessage,
-    generateQuickReplyButtons
-} from 'baileys-joss'
+# Get Support
 
-// Quick Reply Buttons
-const quickButtons = generateQuickReplyButtons(
-    'Pilih opsi di bawah ini:',
-    [
-        { id: 'btn-1', displayText: '✅ Setuju' },
-        { id: 'btn-2', displayText: '❌ Tolak' },
-        { id: 'btn-3', displayText: '📞 Hubungi CS' }
-    ],
-    { footer: 'Powered by Baileys-Joss' }
-)
+If you'd like business to enterprise-level support from Rajeh, the current maintainer of Baileys, you can book a video chat. Book a 1 hour time slot by contacting him on Discord or pre-ordering [here](https://purpshell.dev/book). The earlier you pre-order the better, as his time slots usually fill up very quickly. He offers immense value per hour and will answer all your questions before the time runs out.
 
-await sock.sendMessage(jid, quickButtons)
+If you are a business, we encourage you to contribute back to the high development costs of the project and to feed the maintainers who dump tens of hours a week on this. You can do so by booking meetings or sponsoring below. All support, even in bona fide / contribution hours, is welcome by businesses of all sizes. This is not condoning or endorsing businesses to use the library. See the Disclaimer below.
 
-// URL Button
-const urlButton = generateUrlButtonMessage(
-    'Kunjungi website kami untuk info lebih lanjut',
-    [{ displayText: '🌐 Buka Website', url: 'https://example.com' }],
-    { title: 'Info Produk', footer: 'Click untuk membuka' }
-)
+# Sponsor
+If you'd like to financially support this project, you can do so by supporting the current maintainer [here](https://purpshell.dev/sponsor).
 
-await sock.sendMessage(jid, urlButton)
+# Disclaimer
+This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
+The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
 
-// Copy Code Button (untuk OTP, kode promo, dll)
-const copyButton = generateCopyCodeButton(
-    'Kode OTP Anda adalah:',
-    '123456',
-    '📋 Copy Kode'
-)
+The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used.
+Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.
 
-await sock.sendMessage(jid, copyButton)
-
-// Combined Buttons (mix URL, Reply, Copy, Call)
-const combinedButtons = generateCombinedButtons(
-    'Pilih aksi:',
-    [
-        { type: 'reply', displayText: '🛒 Pesan Sekarang', id: 'order' },
-        { type: 'url', displayText: '🌐 Website', url: 'https://example.com' },
-        { type: 'call', displayText: '📞 Telepon', phoneNumber: '+6281234567890' },
-        { type: 'copy', displayText: '📋 Copy Promo', copyCode: 'PROMO2024' }
-    ],
-    { title: 'Menu Utama', footer: 'Baileys-Joss' }
-)
+##
 
-await sock.sendMessage(jid, combinedButtons)
-
-// List Message
-const listMessage = generateInteractiveListMessage({
-    title: '📋 Menu Produk',
-    buttonText: 'Lihat Menu',
-    description: 'Silahkan pilih produk yang diinginkan',
-    footer: 'Ketik nomor untuk memesan',
-    sections: [
-        {
-            title: 'Makanan',
-            rows: [
-                { rowId: 'nasi-goreng', title: 'Nasi Goreng', description: 'Rp 25.000' },
-                { rowId: 'mie-goreng', title: 'Mie Goreng', description: 'Rp 22.000' }
-            ]
-        },
-        {
-            title: 'Minuman',
-            rows: [
-                { rowId: 'es-teh', title: 'Es Teh', description: 'Rp 5.000' },
-                { rowId: 'kopi', title: 'Kopi', description: 'Rp 10.000' }
-            ]
-        }
-    ]
-})
-
-await sock.sendMessage(jid, listMessage)
-```
+- Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**.
+- Not running Selenium or Chromium saves you like **half a gig** of ram :/
+- Baileys supports interacting with the multi-device & web versions of WhatsApp.
+- Thank you to [@pokearaujo](https://github.com/pokearaujo/multidevice) for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to [@Sigalor](https://github.com/sigalor/whatsapp-web-reveng) for writing his observations on the workings of WhatsApp Web and thanks to [@Rhymen](https://github.com/Rhymen/go-whatsapp/) for the __go__ implementation.
 
-</details>
+> [!IMPORTANT]
+> The original repository had to be removed by the original author - we now continue development in this repository here.
+This is the only official repository and is maintained by the community.
+> **Join the Discord [here](https://discord.gg/WeJM5FP9GG)**
 
-<details>
-<summary><h3>🖼️ Album Messages (Carousel)</h3></summary>
+## Example
 
-Kirim beberapa gambar/video sekaligus dalam format album:
+Do check out & run [example.ts](Example/example.ts) to see an example usage of the library.
+The script covers most common use cases.
+To run the example script, download or clone the repo and then type the following in a terminal:
+1. ``` cd path/to/Baileys ```
+2. ``` yarn ```
+3. ``` yarn example ```
 
-```typescript
-// Send Album (grouped images/videos)
-const albumMedia = [
-    { image: { url: 'https://example.com/pic1.jpg' }, caption: 'Photo 1' },
-    { image: { url: 'https://example.com/pic2.jpg' }, caption: 'Photo 2' },
-    { video: { url: 'https://example.com/video.mp4' }, caption: 'Video' }
-]
+## Install
 
-await sock.sendMessage(jid, { 
-    album: albumMedia, 
-    caption: 'My Album 📸' 
-})
-
-// Album dari file lokal
-const localAlbum = [
-    { image: fs.readFileSync('./image1.jpg') },
-    { image: fs.readFileSync('./image2.jpg') },
-    { video: fs.readFileSync('./video.mp4'), gifPlayback: true }
-]
-
-await sock.sendMessage(jid, { album: localAlbum })
+Use the stable version:
 ```
-
-</details>
-
-<details>
-<summary><h3>🤖 AI Message Style</h3></summary>
-
-Tambahkan ikon AI stylish pada pesan:
-
-```typescript
-// Kirim pesan dengan AI icon
-await sock.sendMessage(jid, { 
-    text: 'Halo! Saya adalah asisten AI Anda 🤖',
-    ai: true  // Menampilkan ikon AI pada pesan
-})
-
-// AI dengan media
-await sock.sendMessage(jid, {
-    image: { url: 'https://example.com/ai-generated.jpg' },
-    caption: 'Generated by AI',
-    ai: true
-})
+yarn add @whiskeysockets/baileys
 ```
 
-</details>
-
-<details>
-<summary><h3>📸 HD Images & Videos (Uncompressed)</h3></summary>
-
-Kirim gambar dan video tanpa kompresi dalam kualitas HD:
-
-```typescript
-// Kirim gambar HD (kualitas tinggi, tidak dikompres)
-await sock.sendMessage(jid, {
-    image: { url: './photo-hd.jpg' },
-    caption: 'Foto HD 📸',
-    hd: true  // Kirim tanpa kompresi
-})
-
-// Kirim video HD
-await sock.sendMessage(jid, {
-    video: { url: './video-4k.mp4' },
-    caption: 'Video 4K 🎬',
-    hd: true  // Kualitas asli
-})
-
-// HD dengan media dari URL
-await sock.sendMessage(jid, {
-    image: { url: 'https://example.com/high-res-photo.jpg' },
-    hd: true,
-    caption: 'High Resolution Photo'
-})
+Use the edge version (no guarantee of stability, but latest fixes + features)
 ```
-
-</details>
-
-<details>
-<summary><h3>🌄 Panorama Profile Picture</h3></summary>
-
-Set foto profil panorama (wide) tanpa cropping:
-
-```typescript
-// Set panorama profile picture (tidak di-crop square)
-await sock.updatePanoramaProfilePicture(myJid, { url: './panorama.jpg' })
-
-// Dengan opsi kustom
-await sock.updatePanoramaProfilePicture(myJid, { url: './wide-photo.jpg' }, {
-    maxWidth: 1080,  // Maximum width
-    quality: 90      // JPEG quality (1-100)
-})
-
-// Set panorama untuk grup
-await sock.updatePanoramaProfilePicture(groupJid, { url: './group-banner.jpg' })
-
-// Atau gunakan profile picture biasa (square crop)
-await sock.updateProfilePicture(myJid, { url: './square-photo.jpg' })
+yarn add github:WhiskeySockets/Baileys
 ```
 
-</details>
-
-<details>
-<summary><h3>📊 Poll Creation</h3></summary>
-
-Buat polling dengan mudah:
-
-```typescript
-// Create a Poll
-const pollMessage = {
-    name: '🎨 Warna Favorit?',
-    values: ['🔴 Merah', '🔵 Biru', '🟢 Hijau', '🟡 Kuning'],
-    selectableCount: 1  // Jumlah pilihan yang bisa dipilih
-}
-
-await sock.sendMessage(jid, { poll: pollMessage })
-
-// Multi-select Poll
-const multiPoll = {
-    name: '🍕 Topping Pizza Favorit?',
-    values: ['Pepperoni', 'Mushroom', 'Cheese', 'Olive', 'Bacon'],
-    selectableCount: 3  // Bisa pilih hingga 3 opsi
-}
-
-await sock.sendMessage(jid, { poll: multiPoll })
+Then import your code using:
+```ts
+import makeWASocket from '@whiskeysockets/baileys'
 ```
 
-</details>
+# Links
+
+- [Discord](https://discord.gg/WeJM5FP9GG)
+- [Docs](https://baileys.wiki/docs/intro/)
+
+# Index
+
+- [Connecting Account](#connecting-account)
+    - [Connect with QR-CODE](#starting-socket-with-qr-code)
+    - [Connect with Pairing Code](#starting-socket-with-pairing-code)
+    - [Receive Full History](#receive-full-history)
+- [Important Notes About Socket Config](#important-notes-about-socket-config)
+    - [Caching Group Metadata (Recommended)](#caching-group-metadata-recommended)
+    - [Improve Retry System & Decrypt Poll Votes](#improve-retry-system--decrypt-poll-votes)
+    - [Receive Notifications in Whatsapp App](#receive-notifications-in-whatsapp-app)
+
+- [Save Auth Info](#saving--restoring-sessions)
+- [Handling Events](#handling-events)
+    - [Example to Start](#example-to-start)
+    - [Decrypt Poll Votes](#decrypt-poll-votes)
+    - [Summary of Events on First Connection](#summary-of-events-on-first-connection)
+- [Implementing a Data Store](#implementing-a-data-store)
+- [Whatsapp IDs Explain](#whatsapp-ids-explain)
+- [Utility Functions](#utility-functions)
+- [Sending Messages](#sending-messages)
+    - [Non-Media Messages](#non-media-messages)
+        - [Text Message](#text-message)
+        - [Quote Message](#quote-message-works-with-all-types)
+        - [Mention User](#mention-user-works-with-most-types)
+        - [Forward Messages](#forward-messages)
+        - [Location Message](#location-message)
+        - [Contact Message](#contact-message)
+        - [Reaction Message](#reaction-message)
+        - [Pin Message](#pin-message)
+        - [Poll Message](#poll-message)
+    - [Sending with Link Preview](#sending-messages-with-link-previews)
+    - [Media Messages](#media-messages)
+        - [Gif Message](#gif-message)
+        - [Video Message](#video-message)
+        - [Audio Message](#audio-message)
+        - [Image Message](#image-message)
+        - [ViewOnce Message](#view-once-message)
+- [Modify Messages](#modify-messages)
+    - [Delete Messages (for everyone)](#deleting-messages-for-everyone)
+    - [Edit Messages](#editing-messages)
+- [Manipulating Media Messages](#manipulating-media-messages)
+    - [Thumbnail in Media Messages](#thumbnail-in-media-messages)
+    - [Downloading Media Messages](#downloading-media-messages)
+    - [Re-upload Media Message to Whatsapp](#re-upload-media-message-to-whatsapp)
+- [Reject Call](#reject-call)
+- [Send States in Chat](#send-states-in-chat)
+    - [Reading Messages](#reading-messages)
+    - [Update Presence](#update-presence)
+- [Modifying Chats](#modifying-chats)
+    - [Archive a Chat](#archive-a-chat)
+    - [Mute/Unmute a Chat](#muteunmute-a-chat)
+    - [Mark a Chat Read/Unread](#mark-a-chat-readunread)
+    - [Delete a Message for Me](#delete-a-message-for-me)
+    - [Delete a Chat](#delete-a-chat)
+    - [Star/Unstar a Message](#starunstar-a-message)
+    - [Disappearing Messages](#disappearing-messages)
+- [User Querys](#user-querys)
+    - [Check If ID Exists in Whatsapp](#check-if-id-exists-in-whatsapp)
+    - [Query Chat History (groups too)](#query-chat-history-groups-too)
+    - [Fetch Status](#fetch-status)
+    - [Fetch Profile Picture (groups too)](#fetch-profile-picture-groups-too)
+    - [Fetch Bussines Profile (such as description or category)](#fetch-bussines-profile-such-as-description-or-category)
+    - [Fetch Someone's Presence (if they're typing or online)](#fetch-someones-presence-if-theyre-typing-or-online)
+- [Change Profile](#change-profile)
+    - [Change Profile Status](#change-profile-status)
+    - [Change Profile Name](#change-profile-name)
+    - [Change Display Picture (groups too)](#change-display-picture-groups-too)
+    - [Remove display picture (groups too)](#remove-display-picture-groups-too)
+- [Groups](#groups)
+    - [Create a Group](#create-a-group)
+    - [Add/Remove or Demote/Promote](#addremove-or-demotepromote)
+    - [Change Subject (name)](#change-subject-name)
+    - [Change Description](#change-description)
+    - [Change Settings](#change-settings)
+    - [Leave a Group](#leave-a-group)
+    - [Get Invite Code](#get-invite-code)
+    - [Revoke Invite Code](#revoke-invite-code)
+    - [Join Using Invitation Code](#join-using-invitation-code)
+    - [Get Group Info by Invite Code](#get-group-info-by-invite-code)
+    - [Query Metadata (participants, name, description...)](#query-metadata-participants-name-description)
+    - [Join using groupInviteMessage](#join-using-groupinvitemessage)
+    - [Get Request Join List](#get-request-join-list)
+    - [Approve/Reject Request Join](#approvereject-request-join)
+    - [Get All Participating Groups Metadata](#get-all-participating-groups-metadata)
+    - [Toggle Ephemeral](#toggle-ephemeral)
+    - [Change Add Mode](#change-add-mode)
+- [Privacy](#privacy)
+    - [Block/Unblock User](#blockunblock-user)
+    - [Get Privacy Settings](#get-privacy-settings)
+    - [Get BlockList](#get-blocklist)
+    - [Update LastSeen Privacy](#update-lastseen-privacy)
+    - [Update Online Privacy](#update-online-privacy)
+    - [Update Profile Picture Privacy](#update-profile-picture-privacy)
+    - [Update Status Privacy](#update-status-privacy)
+    - [Update Read Receipts Privacy](#update-read-receipts-privacy)
+    - [Update Groups Add Privacy](#update-groups-add-privacy)
+    - [Update Default Disappearing Mode](#update-default-disappearing-mode)
+- [Broadcast Lists & Stories](#broadcast-lists--stories)
+    - [Send Broadcast & Stories](#send-broadcast--stories)
+    - [Query a Broadcast List's Recipients & Name](#query-a-broadcast-lists-recipients--name)
+- [Writing Custom Functionality](#writing-custom-functionality)
+    - [Enabling Debug Level in Baileys Logs](#enabling-debug-level-in-baileys-logs)
+    - [How Whatsapp Communicate With Us](#how-whatsapp-communicate-with-us)
+    - [Register a Callback for Websocket Events](#register-a-callback-for-websocket-events)
+
+## Connecting Account
+
+WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a **QR code** or **Pairing Code** with WhatsApp on your phone.
+
+> [!NOTE]
+> **[Here](#example-to-start) is a simple example of event handling**
+
+> [!TIP]
+> **You can see all supported socket configs in the [SocketConfig type alias](https://baileys.wiki/docs/api/type-aliases/SocketConfig/) (Recommended)**
+
+### Starting socket with **QR-CODE**
+
+> [!TIP]
+> You can customize browser name if you connect with **QR-CODE**, with `Browser` constant, we have some browsers config, **see the [BrowsersMap type alias](https://baileys.wiki/docs/api/type-aliases/BrowsersMap/)**
+
+```ts
+import makeWASocket from '@whiskeysockets/baileys'
 
-<details>
-<summary><h3>📢 Newsletter/Channel Control</h3></summary>
+const sock = makeWASocket({
+    // can provide additional config here
+    browser: Browsers.ubuntu('My App'),
+    printQRInTerminal: true
+})
+```
 
-Kelola WhatsApp Channel dengan lengkap:
+If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!
 
-```typescript
-// Create Newsletter/Channel
-await sock.newsletterCreate('My Channel', 'Channel description')
+### Starting socket with **Pairing Code**
 
-// Update channel info
-await sock.newsletterUpdateName(channelJid, 'New Channel Name')
-await sock.newsletterUpdateDescription(channelJid, 'Updated description')
-await sock.newsletterUpdatePicture(channelJid, { url: 'https://example.com/pic.jpg' })
 
-// Follow/Unfollow
-await sock.newsletterFollow(channelJid)
-await sock.newsletterUnfollow(channelJid)
+> [!IMPORTANT]
+> Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see [here](https://faq.whatsapp.com/1324084875126592/?cms_platform=web)
 
-// Mute/Unmute
-await sock.newsletterMute(channelJid)
-await sock.newsletterUnmute(channelJid)
+The phone number can't have `+` or `()` or `-`, only numbers, you must provide country code
 
-// Send reaction to channel message
-await sock.newsletterReactMessage(channelJid, 'server_id', '🔥')
+```ts
+import makeWASocket from '@whiskeysockets/baileys'
 
-// Get channel metadata
-const metadata = await sock.newsletterMetadata('jid', channelJid)
-console.log('Subscribers:', metadata.subscribers)
+const sock = makeWASocket({
+    // can provide additional config here
+    printQRInTerminal: false //need to be false
+})
 
-// Admin operations
-await sock.newsletterChangeOwner(channelJid, newOwnerLid)
-await sock.newsletterDemote(channelJid, adminLid)
-const adminCount = await sock.newsletterAdminCount(channelJid)
+if (!sock.authState.creds.registered) {
+    const number = 'XXXXXXXXXXX'
+    const code = await sock.requestPairingCode(number)
+    console.log(code)
+}
 ```
 
-</details>
-
-<details>
-<summary><h3>🔐 Custom Pairing Code</h3></summary>
-
-Generate custom alphanumeric pairing code:
+### Receive Full History
 
-```typescript
-// Standard pairing code
-const code = await sock.requestPairingCode('6281234567890')
-console.log('Your Pairing Code:', code)
+1. Set `syncFullHistory` as `true`
+2. Baileys, by default, use chrome browser config
+    - If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
 
-// Custom alphanumeric pairing code
-const customCode = await sock.requestPairingCode('6281234567890', 'MYCODE12')
-console.log('Your Custom Code:', customCode)
+```ts
+const sock = makeWASocket({
+    ...otherOpts,
+    // can use Windows, Ubuntu here too
+    browser: Browsers.macOS('Desktop'),
+    syncFullHistory: true
+})
 ```
 
-</details>
-
-<details>
-<summary><h3>📍 LID & SenderPn Plotting</h3></summary>
-
-Utilities untuk mengelola JID, LID (Linked ID), dan senderPn:
+## Important Notes About Socket Config
 
-```typescript
-import { 
-    parseJid,
-    getSenderPn,
-    getCurrentSenderInfo,
-    isSelf,
-    plotJid,
-    normalizePhoneToJid,
-    extractPhoneNumber,
-    formatJidDisplay,
-    isSameUser,
-    getJidVariants,
-    getRemoteJidFromMessage,
-    createJidPlotter
-} from 'baileys-joss'
+### Caching Group Metadata (Recommended)
+- If you use baileys for groups, we recommend you to set `cachedGroupMetadata` in socket config, you need to implement a cache like this:
 
-// Get info tentang current session (senderPn)
-const senderInfo = getCurrentSenderInfo(sock.authState)
-console.log('Phone:', senderInfo.phoneNumber)
-console.log('Phone JID:', senderInfo.phoneJid)
-console.log('LID:', senderInfo.lid)
-console.log('Device ID:', senderInfo.deviceId)
-console.log('Name:', senderInfo.pushName)
+    ```ts
+    const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})
 
-// Parse JID untuk info lengkap
-const jidInfo = parseJid('6281234567890@s.whatsapp.net')
-console.log('User:', jidInfo.user)
-console.log('Is LID:', jidInfo.isLid)
-console.log('Is PN:', jidInfo.isPn)
-console.log('Device:', jidInfo.device)
+    const sock = makeWASocket({
+        cachedGroupMetadata: async (jid) => groupCache.get(jid)
+    })
 
-// Check apakah JID adalah diri sendiri
-const isMe = isSelf(someJid, senderInfo)
+    sock.ev.on('groups.update', async ([event]) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
 
-// Normalize berbagai format nomor
-const jid = normalizePhoneToJid('+62 812-3456-7890') // -> 6281234567890@s.whatsapp.net
+    sock.ev.on('group-participants.update', async (event) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
+    ```
 
-// Extract phone number dari JID
-const phone = extractPhoneNumber('6281234567890@s.whatsapp.net') // -> 6281234567890
-
-// Format untuk display
-const display = formatJidDisplay('6281234567890:1@s.whatsapp.net', {
-    showDevice: true,
-    showType: true
-}) // -> 6281234567890:1 (PN)
-
-// Compare dua JID
-const same = isSameUser('6281234567890@s.whatsapp.net', '6281234567890:1@s.whatsapp.net') // true
-
-// Get sender dari message
-sock.ev.on('messages.upsert', async ({ messages }) => {
-    for (const msg of messages) {
-        const { chatJid, senderJid } = getRemoteJidFromMessage(msg)
-        console.log('Chat:', chatJid)
-        console.log('Sender:', senderJid)
-    }
-})
+### Improve Retry System & Decrypt Poll Votes
+- If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set `getMessage` config in socket like this:
+    ```ts
+    const sock = makeWASocket({
+        getMessage: async (key) => await getMessageFromStore(key)
+    })
+    ```
 
-// Advanced: Create plotter dengan LID mapping support
-const plotter = createJidPlotter(
-    sock.lidMapping.getLIDForPN.bind(sock.lidMapping),
-    sock.lidMapping.getPNForLID.bind(sock.lidMapping)
-)
+### Receive Notifications in Whatsapp App
+- If you want to receive notifications in whatsapp app, set `markOnlineOnConnect` to `false`
+    ```ts
+    const sock = makeWASocket({
+        markOnlineOnConnect: false
+    })
+    ```
+## Saving & Restoring Sessions
 
-const plotted = await plotter.plotBidirectional('6281234567890@s.whatsapp.net')
-console.log('Phone:', plotted.pn)
-console.log('LID:', plotted.lid)
-```
+You obviously don't want to keep scanning the QR code every time you want to connect.
 
-</details>
+So, you can load the credentials to log back in:
+```ts
+import makeWASocket, { useMultiFileAuthState } from '@whiskeysockets/baileys'
 
-<details>
-<summary><h3>📍 Location Sharing</h3></summary>
+const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
 
-Kirim lokasi dengan mudah:
+// will use the given state to connect
+// so if valid credentials are available -- it'll connect without QR
+const sock = makeWASocket({ auth: state })
 
-```typescript
-// Send location
-await sock.sendMessage(jid, {
-    location: {
-        degreesLatitude: -6.2088,
-        degreesLongitude: 106.8456,
-        name: 'Jakarta, Indonesia',
-        address: 'Jl. Sudirman, Jakarta Pusat'
-    }
-})
+// this will be called as soon as the credentials are updated
+sock.ev.on('creds.update', saveCreds)
 ```
 
-</details>
-
-<details>
-<summary><h3>👥 Group Management</h3></summary>
-
-Kelola grup dengan lengkap:
-
-```typescript
-// Create group
-const group = await sock.groupCreate('My Group', ['6281234567890@s.whatsapp.net'])
+> [!IMPORTANT]
+> `useMultiFileAuthState` is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.
 
-// Update group info
-await sock.groupUpdateSubject(groupJid, 'New Group Name')
-await sock.groupUpdateDescription(groupJid, 'New description')
+> [!NOTE]
+> When a message is received/sent, due to signal sessions needing updating, the auth keys (`authState.keys`) will update. Whenever that happens, you must save the updated keys (`authState.keys.set()` is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The `useMultiFileAuthState` function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.
 
-// Manage participants
-await sock.groupParticipantsUpdate(groupJid, ['6281234567890@s.whatsapp.net'], 'add')
-await sock.groupParticipantsUpdate(groupJid, ['6281234567890@s.whatsapp.net'], 'remove')
-await sock.groupParticipantsUpdate(groupJid, ['6281234567890@s.whatsapp.net'], 'promote')
-await sock.groupParticipantsUpdate(groupJid, ['6281234567890@s.whatsapp.net'], 'demote')
+## Handling Events
 
-// Get group metadata
-const metadata = await sock.groupMetadata(groupJid)
-console.log('Group Name:', metadata.subject)
-console.log('Members:', metadata.participants.length)
+- Baileys uses the EventEmitter syntax for events.
+They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.
 
-// Group settings
-await sock.groupSettingUpdate(groupJid, 'announcement') // Only admins can send
-await sock.groupSettingUpdate(groupJid, 'not_announcement') // Everyone can send
-await sock.groupSettingUpdate(groupJid, 'locked') // Only admins can edit info
-await sock.groupSettingUpdate(groupJid, 'unlocked') // Everyone can edit info
+> [!IMPORTANT]
+> **The events are in the [BaileysEventMap type alias](https://baileys.wiki/docs/api/type-aliases/BaileysEventMap/)**, it's important you see all events
 
-// Leave group
-await sock.groupLeave(groupJid)
+You can listen to these events like this:
+```ts
+const sock = makeWASocket()
+sock.ev.on('messages.upsert', ({ messages }) => {
+    console.log('got messages', messages)
+})
 ```
 
-</details>
+### Example to Start
 
----
+> [!NOTE]
+> This example includes basic auth storage too
 
-## 🚀 Quick Start
+> [!NOTE]
+> For reliable serialization of the authentication state, especially when storing as JSON, always use the BufferJSON utility.
 
-```typescript
-import makeWASocket, { 
-    useMultiFileAuthState,
-    DisconnectReason,
-    // Interactive Message features
-    generateQuickReplyButtons,
-    generateInteractiveListMessage,
-    generateCombinedButtons,
-    // JID Plotting features
-    getCurrentSenderInfo,
-    parseJid,
-    isSelf
-} from 'baileys-joss'
+```ts
+import makeWASocket, { DisconnectReason, useMultiFileAuthState } from '@whiskeysockets/baileys'
+import { Boom } from '@hapi/boom'
 
-async function startBot() {
-    const { state, saveCreds } = await useMultiFileAuthState('auth_session')
-    
+async function connectToWhatsApp () {
+    const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
     const sock = makeWASocket({
+        // can provide additional config here
         auth: state,
         printQRInTerminal: true
     })
-    
-    sock.ev.on('creds.update', saveCreds)
-    
     sock.ev.on('connection.update', (update) => {
         const { connection, lastDisconnect } = update
-        
-        if (connection === 'close') {
-            const shouldReconnect = lastDisconnect?.error?.output?.statusCode !== DisconnectReason.loggedOut
-            if (shouldReconnect) {
-                startBot()
+        if(connection === 'close') {
+            const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
+            console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
+            // reconnect if not logged out
+            if(shouldReconnect) {
+                connectToWhatsApp()
             }
-        } else if (connection === 'open') {
-            console.log('✅ Connected!')
-            
-            // Get sender info
-            const sender = getCurrentSenderInfo(sock.authState)
-            console.log('📱 Logged in as:', sender?.phoneNumber)
+        } else if(connection === 'open') {
+            console.log('opened connection')
         }
     })
-    
-    sock.ev.on('messages.upsert', async ({ messages }) => {
-        const msg = messages[0]
-        if (!msg.message || msg.key.fromMe) return
-        
-        const text = msg.message.conversation || 
-                     msg.message.extendedTextMessage?.text || ''
-        
-        if (text === '/menu') {
-            // Kirim interactive buttons
-            const buttons = generateQuickReplyButtons(
-                '🤖 Bot Menu\n\nPilih opsi:',
-                [
-                    { id: 'help', displayText: '❓ Bantuan' },
-                    { id: 'info', displayText: 'ℹ️ Info' },
-                    { id: 'order', displayText: '🛒 Order' }
-                ],
-                { footer: 'Baileys-Joss Bot' }
-            )
-            
-            await sock.sendMessage(msg.key.remoteJid!, buttons)
-        }
-        
-        if (text === '/poll') {
-            // Kirim poll
-            await sock.sendMessage(msg.key.remoteJid!, {
-                poll: {
-                    name: '🗳️ Vote sekarang!',
-                    values: ['Option A', 'Option B', 'Option C'],
-                    selectableCount: 1
-                }
-            })
-        }
-        
-        if (text === '/ai') {
-            // Kirim pesan dengan AI style
-            await sock.sendMessage(msg.key.remoteJid!, {
-                text: 'Halo! Saya asisten AI Anda 🤖',
-                ai: true
-            })
+    sock.ev.on('messages.upsert', event => {
+        for (const m of event.messages) {
+            console.log(JSON.stringify(m, undefined, 2))
+
+            console.log('replying to', m.key.remoteJid)
+            await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
         }
     })
+
+    // to storage creds (session info) when it updates
+    sock.ev.on('creds.update', saveCreds)
 }
+// run in main file
+connectToWhatsApp()
+```
 
-startBot()
+> [!IMPORTANT]
+> In `messages.upsert` it's recommended to use a loop like `for (const message of event.messages)` to handle all messages in array
+
+### Decrypt Poll Votes
+
+- By default poll votes are encrypted and handled in `messages.update`
+- That's a simple example
+```ts
+sock.ev.on('messages.update', event => {
+    for(const { key, update } of event) {
+        if(update.pollUpdates) {
+            const pollCreation = await getMessage(key)
+            if(pollCreation) {
+                console.log(
+                    'got poll update, aggregation: ',
+                    getAggregateVotesInPollMessage({
+                        message: pollCreation,
+                        pollUpdates: update.pollUpdates,
+                    })
+                )
+            }
+        }
+    }
+})
 ```
 
----
+- `getMessage` is a [store](#implementing-a-data-store) implementation (in your end)
 
-## 💡 Use Case Examples
+### Summary of Events on First Connection
 
-<details>
-<summary><b>📬 Newsletter Control</b></summary>
+1. When you connect first time, `connection.update` will be fired requesting you to restart sock
+2. Then, history messages will be received in `messaging.history-set`
 
-```typescript
-// Create a newsletter  
-await sock.newsletterCreate('My Updates Channel', 'Stay updated!')
+## Implementing a Data Store
 
-// Update description  
-await sock.newsletterUpdateDescription(channelJid, 'Fresh updates weekly 🔥')
+- Baileys does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.
 
-// Send reaction to channel message  
-await sock.newsletterReactMessage(channelJid, 'server_id', '❤️')
+> [!IMPORTANT]
+> I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
 
-// Fetch channel messages
-const messages = await sock.newsletterFetchMessages('jid', channelJid, 10)
-```
+It can be used as follows:
 
-</details>
+```ts
+import makeWASocket, { makeInMemoryStore } from '@whiskeysockets/baileys'
+// the store maintains the data of the WA connection in memory
+// can be written out to a file & read from it
+const store = makeInMemoryStore({ })
+// can be read from a file
+store.readFromFile('./baileys_store.json')
+// saves the state to a file every 10s
+setInterval(() => {
+    store.writeToFile('./baileys_store.json')
+}, 10_000)
 
-<details>
-<summary><b>📌 Interactive Messaging</b></summary>
+const sock = makeWASocket({ })
+// will listen from this socket
+// the store can listen from a new socket once the current socket outlives its lifetime
+store.bind(sock.ev)
 
-```typescript
-// Native Flow Buttons
-const buttons = generateCombinedButtons(
-    'Welcome to our service! 🎉',
-    [
-        { type: 'reply', displayText: '📋 View Menu', id: 'menu' },
-        { type: 'url', displayText: '🌐 Visit Website', url: 'https://example.com' },
-        { type: 'call', displayText: '📞 Call Us', phoneNumber: '+1234567890' },
-        { type: 'copy', displayText: '📋 Copy Promo', copyCode: 'SAVE20' }
-    ],
-    { title: 'Welcome!', footer: 'Powered by Baileys-Joss' }
-)
+sock.ev.on('chats.upsert', () => {
+    // can use 'store.chats' however you want, even after the socket dies out
+    // 'chats' => a KeyedDB instance
+    console.log('got chats', store.chats.all())
+})
 
-await sock.sendMessage(jid, buttons)
-```
+sock.ev.on('contacts.upsert', () => {
+    console.log('got contacts', Object.values(store.contacts))
+})
 
-</details>
+```
 
-<details>
-<summary><b>🖼️ Send Album</b></summary>
+The store also provides some simple functions such as `loadMessages` that utilize the store to speed up data retrieval.
 
-```typescript
-const media = [
-    { image: { url: 'https://example.com/pic1.jpg' }, caption: 'Photo 1 📸' },
-    { image: { url: 'https://example.com/pic2.jpg' }, caption: 'Photo 2 📸' },
-    { video: { url: 'https://example.com/clip.mp4' }, caption: 'Video 🎬' }
-]
+## Whatsapp IDs Explain
 
-await sock.sendMessage(jid, { 
-    album: media, 
-    caption: 'My Vacation Memories 🌴' 
-})
-```
+- `id` is the WhatsApp ID, called `jid` 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```.
+	    - For groups, it must be in the format ``` 123456789-123345@g.us ```.
+    - For broadcast lists, it's `[timestamp of creation]@broadcast`.
+    - For stories, the ID is `status@broadcast`.
 
-</details>
+## Utility Functions
 
-<details>
-<summary><b>🔐 Pairing with Custom Code</b></summary>
+- `getContentType`, returns the content type for any message
+- `getDevice`, returns the device from message
+- `makeCacheableSignalKeyStore`, make auth store more fast
+- `downloadContentFromMessage`, download content from any message
 
-```typescript
-// Request standard pairing code
-const code = await sock.requestPairingCode('6281234567890')
-console.log('Your Pairing Code:', code)
+## Sending Messages
 
-// Request custom pairing code
-const customCode = await sock.requestPairingCode('6281234567890', 'BAILEYS1')
-console.log('Your Custom Code:', customCode)
-```
+- Send all types of messages with a single function
+    - **In the [AnyMessageContent type alias](https://baileys.wiki/docs/api/type-aliases/AnyMessageContent/) you can see all message contents supported, like text message**
+    - **In the [MiscMessageGenerationOptions type alias](https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions/) you can see all options supported, like quote message**
 
-</details>
+    ```ts
+    const jid: string
+    const content: AnyMessageContent
+    const options: MiscMessageGenerationOptions
 
-<details>
-<summary><b>📊 Poll Creation</b></summary>
+    sock.sendMessage(jid, content, options)
+    ```
 
-```typescript
-const pollMessage = {
-    name: '🎬 Film Favorit Weekend Ini?',
-    values: [
-        '🦸 Superhero Movie',
-        '😂 Comedy',
-        '😱 Horror',
-        '💑 Romance'
-    ],
-    selectableCount: 1
-}
+### Non-Media Messages
 
-await sock.sendMessage(jid, { poll: pollMessage })
+#### Text Message
+```ts
+await sock.sendMessage(jid, { text: 'hello word' })
 ```
 
-</details>
-
-<details>
-<summary><b>📍 Location Sharing</b></summary>
+#### Quote Message (works with all types)
+```ts
+await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })
+```
 
-```typescript
-await sock.sendMessage(jid, {
-    location: {
-        degreesLatitude: -6.2088,
-        degreesLongitude: 106.8456,
-        name: 'Monas Jakarta',
-        address: 'Jalan Medan Merdeka, Jakarta Pusat'
+#### Mention User (works with most types)
+- @number is to mention in text, it's optional
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        text: '@12345678901',
+        mentions: ['12345678901@s.whatsapp.net']
     }
-})
+)
 ```
 
-</details>
-
-<details>
-<summary><b>👥 Group Management</b></summary>
-
-```typescript
-// Create group
-const group = await sock.groupCreate('My Awesome Group', [
-    '6281234567890@s.whatsapp.net',
-    '6281234567891@s.whatsapp.net'
-])
-
-console.log('Group created:', group.id)
-
-// Update group settings
-await sock.groupUpdateSubject(group.id, 'Updated Group Name')
-await sock.groupSettingUpdate(group.id, 'announcement')
-
-// Add members
-await sock.groupParticipantsUpdate(group.id, [
-    '6281234567892@s.whatsapp.net'
-], 'add')
+#### Forward Messages
+- You need to have message object, can be retrieved from [store](#implementing-a-data-store) or use a [message](https://baileys.wiki/docs/api/type-aliases/WAMessage/) object
+```ts
+const msg = getMessageFromStore() // implement this on your end
+await sock.sendMessage(jid, { forward: msg }) // WA forward the message!
 ```
 
-</details>
-
----
-
-## 🆕 Baileys-Joss v1.0.2 New Features
-
-<details>
-<summary><h3>📅 Message Scheduling</h3></summary>
-
-Jadwalkan pesan untuk dikirim otomatis di waktu tertentu:
-
-```typescript
-import { createMessageScheduler } from 'baileys-joss'
-
-// Buat scheduler
-const scheduler = createMessageScheduler(
-    (jid, content) => sock.sendMessage(jid, content),
+#### Location Message
+```ts
+await sock.sendMessage(
+    jid,
     {
-        onSent: (scheduled, message) => {
-            console.log(`Pesan terkirim ke ${scheduled.jid}`)
-        },
-        onFailed: (scheduled, error) => {
-            console.log(`Gagal kirim: ${error.message}`)
+        location: {
+            degreesLatitude: 24.121231,
+            degreesLongitude: 55.1121221
         }
     }
 )
-
-// Jadwalkan pesan untuk waktu tertentu
-const scheduled = scheduler.schedule(
-    '6281234567890@s.whatsapp.net',
-    { text: 'Selamat Ulang Tahun! 🎂' },
-    new Date('2024-12-25 09:00:00')
-)
-
-// Jadwalkan dengan delay (30 menit dari sekarang)
-scheduler.scheduleDelay(jid, { text: 'Reminder!' }, 30 * 60 * 1000)
-
-// Cancel scheduled message
-scheduler.cancel(scheduled.id)
-
-// Get all pending messages
-const pending = scheduler.getPending()
-
-// Stop scheduler
-scheduler.stop()
 ```
-
-</details>
-
-<details>
-<summary><h3>📨 Bulk Messaging</h3></summary>
-
-Kirim pesan massal ke banyak kontak dengan rate limiting:
-
-```typescript
-import { createBulkSender, sendBulkMessages } from 'baileys-joss'
-
-// Method 1: Create bulk sender instance
-const bulkSender = createBulkSender(
-    (jid, content) => sock.sendMessage(jid, content),
+#### Contact Message
+```ts
+const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
+            + 'VERSION:3.0\n'
+            + 'FN:Jeff Singh\n' // full name
+            + 'ORG:Ashoka Uni;\n' // the organization of the contact
+            + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
+            + 'END:VCARD'
+
+await sock.sendMessage(
+    id,
     {
-        delayBetweenMessages: 2000, // 2 detik delay
-        randomDelay: 1000, // Random 0-1 detik tambahan
-        maxRetries: 2,
-        onProgress: (progress) => {
-            console.log(`Progress: ${progress.sent}/${progress.total} (${progress.percentage}%)`)
-        },
-        onComplete: (results) => {
-            const success = results.filter(r => r.success).length
-            console.log(`Selesai: ${success}/${results.length} berhasil`)
+        contacts: {
+            displayName: 'Jeff',
+            contacts: [{ vcard }]
         }
     }
 )
-
-// Kirim pesan yang sama ke banyak JID
-const jids = [
-    '6281234567890@s.whatsapp.net',
-    '6281234567891@s.whatsapp.net',
-    '6281234567892@s.whatsapp.net'
-]
-
-const results = await bulkSender.sendToMany(jids, { text: 'Hello everyone!' })
-
-// Kirim pesan berbeda ke JID berbeda
-const messages = [
-    { jid: '6281...@s.whatsapp.net', content: { text: 'Hi John!' } },
-    { jid: '6282...@s.whatsapp.net', content: { text: 'Hi Jane!' } }
-]
-await bulkSender.send(messages)
-
-// Method 2: Quick helper
-await sendBulkMessages(
-    (jid, content) => sock.sendMessage(jid, content),
-    jids,
-    { text: 'Broadcast message' }
-)
 ```
 
-</details>
-
-<details>
-<summary><h3>🔄 Auto Reply System</h3></summary>
-
-Sistem balasan otomatis berdasarkan keyword/pattern:
-
-```typescript
-import { createAutoReply } from 'baileys-joss'
-
-// Buat auto-reply handler
-const autoReply = createAutoReply(
-    (jid, content, options) => sock.sendMessage(jid, content, options),
-    (jid, presence) => sock.sendPresenceUpdate(presence, jid),
+#### Reaction Message
+- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) object
+```ts
+await sock.sendMessage(
+    jid,
     {
-        simulateTyping: true,
-        typingDuration: 1500,
-        globalCooldown: 1000
+        react: {
+            text: '💖', // use an empty string to remove the reaction
+            key: message.key
+        }
     }
 )
+```
 
-// Tambah rule berdasarkan keywords
-autoReply.addRule({
-    keywords: ['harga', 'price', 'biaya'],
-    response: { text: 'Silakan cek katalog kami di example.com' },
-    cooldown: 60000, // 1 menit cooldown per user
-    quoted: true // Reply dengan quote
-})
+#### Pin Message
+- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) object
 
-// Rule dengan regex pattern
-autoReply.addRule({
-    pattern: /^(hi|hello|halo|hay)/i,
-    response: { text: 'Hai! Ada yang bisa dibantu? 😊' },
-    privateOnly: true // Hanya di private chat
-})
+- Time can be:
 
-// Rule dengan dynamic response
-autoReply.addRule({
-    keywords: ['order'],
-    response: async (message, match) => {
-        const sender = message.key.remoteJid
-        return { text: `Terima kasih sudah order! ID: ${Date.now()}` }
-    }
-})
-
-// Rule untuk grup saja
-autoReply.addRule({
-    exactMatch: '/menu',
-    response: { text: 'Menu:\n1. Help\n2. Info\n3. Contact' },
-    groupsOnly: true
-})
+| Time  | Seconds        |
+|-------|----------------|
+| 24h    | 86.400        |
+| 7d     | 604.800       |
+| 30d    | 2.592.000     |
 
-// Proses pesan masuk
-sock.ev.on('messages.upsert', async ({ messages }) => {
-    for (const msg of messages) {
-        if (!msg.key.fromMe) {
-            await autoReply.processMessage(msg)
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        pin: {
+            type: 1, // 0 to remove
+            time: 86400
+            key: message.key
         }
     }
-})
-```
-
-</details>
-
-<details>
-<summary><h3>📇 Contact Card (vCard)</h3></summary>
-
-Kirim kartu kontak lengkap dengan detail:
-
-```typescript
-import { 
-    createContactCard, 
-    createContactCards, 
-    quickContact,
-    generateVCard 
-} from 'baileys-joss'
-
-// Quick contact (simple)
-const simple = quickContact('John Doe', '+628123456789', {
-    organization: 'PT Example',
-    email: 'john@example.com'
-})
-await sock.sendMessage(jid, createContactCard(simple))
-
-// Full vCard with all details
-const fullContact = {
-    fullName: 'Dr. John Doe',
-    displayName: 'John D.',
-    organization: 'Hospital ABC',
-    title: 'Senior Doctor',
-    phones: [
-        { number: '+628123456789', type: 'CELL' },
-        { number: '+622112345678', type: 'WORK' }
-    ],
-    emails: [
-        { email: 'john@hospital.com', type: 'WORK' },
-        { email: 'john.personal@gmail.com', type: 'HOME' }
-    ],
-    urls: [
-        { url: 'https://linkedin.com/in/johndoe', type: 'WORK' }
-    ],
-    addresses: [{
-        street: 'Jl. Sudirman No. 123',
-        city: 'Jakarta',
-        state: 'DKI Jakarta',
-        postalCode: '12345',
-        country: 'Indonesia',
-        type: 'WORK'
-    }],
-    birthday: '1990-05-15',
-    note: 'Met at conference 2024'
-}
-
-await sock.sendMessage(jid, createContactCard(fullContact))
-
-// Send multiple contacts
-const contacts = [
-    quickContact('Alice', '+628111111111'),
-    quickContact('Bob', '+628222222222'),
-    quickContact('Charlie', '+628333333333')
-]
-await sock.sendMessage(jid, createContactCards(contacts))
-
-// Generate raw vCard string
-const vcardString = generateVCard(fullContact)
-console.log(vcardString)
+)
 ```
 
-</details>
-
-<details>
-<summary><h3>📺 Status/Story Posting</h3></summary>
-
-Posting status WhatsApp (foto, video, text):
-
-```typescript
-import { 
-    StatusHelper, 
-    STATUS_BROADCAST_JID,
-    STATUS_BACKGROUNDS,
-    STATUS_FONTS
-} from 'baileys-joss'
-
-const statusJid = STATUS_BROADCAST_JID // 'status@broadcast'
-
-// Post text status
-await sock.sendMessage(statusJid, StatusHelper.text(
-    'Hello World! 🌍',
-    STATUS_BACKGROUNDS.solid.green
-))
-
-// Post image status
-const imageBuffer = fs.readFileSync('./my-photo.jpg')
-await sock.sendMessage(statusJid, StatusHelper.image(
-    imageBuffer,
-    'Beautiful day! ☀️'
-))
-
-// Post video status
-const videoBuffer = fs.readFileSync('./my-video.mp4')
-await sock.sendMessage(statusJid, StatusHelper.video(
-    videoBuffer,
-    'Check this out! 🎬'
-))
-
-// Post GIF status
-await sock.sendMessage(statusJid, StatusHelper.gif(
-    gifBuffer,
-    'Animated! 🎭'
-))
-
-// Post voice note status
-await sock.sendMessage(statusJid, StatusHelper.voiceNote(audioBuffer))
-
-// Custom text status with font
-import { createTextStatus } from 'baileys-joss'
-
-await sock.sendMessage(statusJid, createTextStatus({
-    text: 'Custom styled status!',
-    backgroundColor: STATUS_BACKGROUNDS.solid.purple,
-    font: STATUS_FONTS.DANCING,
-    textColor: '#FFFFFF'
-}))
+#### Poll Message
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        poll: {
+            name: 'My Poll',
+            values: ['Option 1', 'Option 2', ...],
+            selectableCount: 1,
+            toAnnouncementGroup: false // or true
+        }
+    }
+)
 ```
 
-</details>
-
-<details>
-<summary><h3>🎤 Voice Note Helper</h3></summary>
-
-Rekam dan kirim voice note dengan PTT mode:
-
-```typescript
-import { 
-    createVoiceNote, 
-    createAudioMessage,
-    VoiceNoteHelper 
-} from 'baileys-joss'
-
-// Simple voice note from buffer
-const voiceNote = await VoiceNoteHelper.fromBuffer(audioBuffer, 15) // 15 seconds
-await sock.sendMessage(jid, voiceNote)
-
-// Voice note from file
-const vnFromFile = await VoiceNoteHelper.fromFile('./recording.mp3')
-await sock.sendMessage(jid, vnFromFile)
-
-// Regular audio (not PTT)
-const audio = await VoiceNoteHelper.audioFromBuffer(audioBuffer)
-await sock.sendMessage(jid, audio)
+### Sending Messages with Link Previews
 
-// Check if FFmpeg is available (for conversions)
-const hasFFmpeg = await VoiceNoteHelper.checkFFmpeg()
-
-// Convert audio to Opus (WhatsApp format)
-const opusBuffer = await VoiceNoteHelper.toOpus(mp3Buffer)
-
-// Get audio duration
-const duration = await VoiceNoteHelper.getDuration(audioBuffer)
-console.log(`Audio duration: ${duration} seconds`)
-
-// Full control with createVoiceNote
-const customVN = await createVoiceNote(audioBuffer, {
-    seconds: 30,
-    sampleRate: 48000,
-    channels: 1
-})
-await sock.sendMessage(jid, customVN)
+1. By default, wa does not have link generation when sent from the web
+2. Baileys has a function to generate the content for these link previews
+3. To enable this function's usage, add `link-preview-js` as a dependency to your project with `yarn add link-preview-js`
+4. Send a link:
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
+    }
+)
 ```
 
-</details>
-
-<details>
-<summary><h3>📋 Message Templates</h3></summary>
-
-Template pesan siap pakai untuk berbagai keperluan:
+### Media Messages
 
-```typescript
-import { createTemplateManager, renderTemplate, PRESET_TEMPLATES } from 'baileys-joss'
+Sending media (video, stickers, images) is easier & more efficient than ever.
 
-// Create manager with preset templates
-const templates = createTemplateManager(true)
+> [!NOTE]
+> In media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](https://baileys.wiki/docs/api/type-aliases/WAMediaUpload/)
 
-// Render preset template
-const orderConfirmation = templates.render('order_confirmation', {
-    orderId: 'ORD-12345',
-    customerName: 'John Doe',
-    orderDate: '2024-01-15',
-    items: '1x Product A\n2x Product B',
-    total: '150,000'
-})
-
-await sock.sendMessage(jid, { text: orderConfirmation })
-
-// Create custom template
-templates.create({
-    name: 'Welcome Message',
-    content: `Halo {{name}}! 👋
-
-Selamat datang di {{company}}!
-
-Berikut layanan kami:
-{{services}}
-
-Contact: {{phone:021-12345678}}`,
-    category: 'greeting'
-})
+- When specifying a media url, Baileys never loads the entire buffer into memory; it even encrypts the media as a readable stream.
 
-// Render custom template
-const welcome = templates.render('welcome_message', {
-    name: 'Budi',
-    company: 'PT Example',
-    services: '- Layanan A\n- Layanan B\n- Layanan C'
-})
+> [!TIP]
+> It's recommended to use Stream or Url to save memory
 
-// Quick template rendering (tanpa manager)
-const quick = renderTemplate(
-    'Hi {{name}}, your order #{{orderId}} is {{status:processing}}',
-    { name: 'Alice', orderId: '123' }
+#### Gif Message
+- Whatsapp doesn't support `.gif` files, that's why we send gifs as common `.mp4` video with `gifPlayback` flag
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        video: fs.readFileSync('Media/ma_gif.mp4'),
+        caption: 'hello word',
+        gifPlayback: true
+    }
 )
-
-// List available templates
-const allTemplates = templates.getAll()
-const invoiceTemplates = templates.getByCategory('invoice')
-
-// Export/Import templates
-const exportJson = templates.export()
-templates.import(exportJson, true) // true = overwrite existing
 ```
 
-</details>
-
-<details>
-<summary><h3>📡 Broadcast Manager</h3></summary>
-
-Kelola dan kirim ke broadcast list:
-
-```typescript
-import { createBroadcastManager } from 'baileys-joss'
-
-const broadcast = createBroadcastManager(
-    (jid, content) => sock.sendMessage(jid, content)
+#### Video Message
+```ts
+await sock.sendMessage(
+    id,
+    {
+        video: {
+            url: './Media/ma_gif.mp4'
+        },
+        caption: 'hello word',
+	    ptv: false // if set to true, will send as a `video note`
+    }
 )
+```
 
-// Create broadcast list
-const customerList = broadcast.create({
-    name: 'VIP Customers',
-    description: 'Premium customers for promo',
-    recipients: [
-        '6281234567890@s.whatsapp.net',
-        '6281234567891@s.whatsapp.net'
-    ]
-})
-
-// Add more recipients
-broadcast.addRecipients(customerList.id, [
-    '6281234567892@s.whatsapp.net'
-])
-
-// Send to broadcast list
-const result = await broadcast.broadcast(
-    customerList.id,
-    { text: '🎉 Special promo for VIP customers!' },
+#### Audio Message
+- To audio message work in all devices you need to convert with some tool like `ffmpeg` with this flags:
+    ```bash
+        codec: libopus //ogg file
+        ac: 1 //one channel
+        avoid_negative_ts
+        make_zero
+    ```
+    - Example:
+    ```bash
+    ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
+    ```
+```ts
+await sock.sendMessage(
+    jid,
     {
-        delay: 2000,
-        onProgress: (sent, total, jid) => {
-            console.log(`Sending ${sent}/${total}: ${jid}`)
-        }
+        audio: {
+            url: './Media/audio.mp3'
+        },
+        mimetype: 'audio/mp4'
     }
 )
-
-console.log(`Sent: ${result.sent}, Failed: ${result.failed}`)
-
-// Get statistics
-const stats = broadcast.getStats()
-console.log(`Total lists: ${stats.totalLists}, Recipients: ${stats.totalRecipients}`)
-
-// Export/Import lists
-const json = broadcast.export()
-broadcast.import(json)
 ```
 
-</details>
-
-<details>
-<summary><h3>⌨️ Typing Indicator</h3></summary>
-
-Simulasi sedang mengetik:
-
-```typescript
-import { createTypingIndicator } from 'baileys-joss'
-
-const typing = createTypingIndicator(
-    (jid, presence) => sock.sendPresenceUpdate(presence, jid)
+#### Image Message
+```ts
+await sock.sendMessage(
+    id,
+    {
+        image: {
+            url: './Media/ma_img.png'
+        },
+        caption: 'hello word'
+    }
 )
-
-// Start typing
-await typing.startTyping(jid, { 
-    duration: 5000,  // Auto pause after 5 seconds
-    autoPause: true 
-})
-
-// Start recording (for voice notes)
-await typing.startRecording(jid, { duration: 3000 })
-
-// Stop typing
-await typing.stopTyping(jid)
-
-// Simulate typing then send
-await typing.simulateTyping(jid, 2000, async () => {
-    return sock.sendMessage(jid, { text: 'Hello!' })
-})
-
-// Stop all typing indicators
-await typing.stopAll()
 ```
 
-</details>
-
-<details>
-<summary><h3>✅ Read Receipt Control</h3></summary>
+#### View Once Message
 
-Kontrol centang biru:
+- You can send all messages above as `viewOnce`, you only need to pass `viewOnce: true` in content object
 
-```typescript
-import { createReadReceiptController } from 'baileys-joss'
-
-const readReceipts = createReadReceiptController(
-    (jid, participant, messageIds) => sock.readMessages([{ remoteJid: jid, id: messageIds[0] }]),
+```ts
+await sock.sendMessage(
+    id,
     {
-        enabled: true,
-        readDelay: 1000, // 1 second delay
-        excludeJids: ['blocked@s.whatsapp.net']
+        image: {
+            url: './Media/ma_img.png'
+        },
+        viewOnce: true, //works with video, audio too
+        caption: 'hello word'
     }
 )
-
-// Toggle read receipts
-readReceipts.disable() // Stop sending read receipts
-readReceipts.enable()  // Resume
-
-// Check status
-console.log(readReceipts.isEnabled())
-
-// Manual read (respects config)
-await readReceipts.markRead(jid, participant, ['messageId123'])
-
-// Force read (ignores config)
-await readReceipts.forceMarkRead(jid, participant, ['messageId123'])
-
-// Update config
-readReceipts.setConfig({
-    enabled: true,
-    readDelay: 2000
-})
 ```
 
-</details>
-
-<details>
-<summary><h3>🔍 Message Search</h3></summary>
-
-Cari pesan dalam chat:
-
-```typescript
-import { createMessageSearch, searchMessages } from 'baileys-joss'
-
-// Create search manager
-const search = createMessageSearch()
-
-// Add messages to index
-search.addMessages(chatMessages)
-
-// Search by text
-const results = search.search('harga produk', {
-    caseSensitive: false,
-    limit: 20,
-    messageTypes: ['text', 'image'], // Include captions
-    fromDate: new Date('2024-01-01')
-})
-
-for (const result of results) {
-    console.log(`Found: "${result.matchedText}"`)
-    console.log(`Score: ${result.relevanceScore}`)
-    console.log(`Message ID: ${result.message.key.id}`)
-}
-
-// Search with regex
-const regexResults = search.searchRegex(/order\s*#?\d+/i)
+## Modify Messages
 
-// Get messages by type
-const images = search.getByType('image')
-const videos = search.getByType('video')
+### Deleting Messages (for everyone)
 
-// Get messages by sender
-const fromSender = search.getBySender('6281234567890@s.whatsapp.net')
-
-// Quick search (without manager)
-const quickResults = searchMessages(messages, 'keyword', {
-    jid: specificChatJid,
-    fromMe: false
-})
+```ts
+const msg = await sock.sendMessage(jid, { text: 'hello word' })
+await sock.sendMessage(jid, { delete: msg.key })
 ```
 
-</details>
-
-<details>
-<summary><h3>📊 Chat Analytics</h3></summary>
+**Note:** deleting for oneself is supported via `chatModify`, see in [this section](#modifying-chats)
 
-Statistik dan analitik chat:
+### Editing Messages
 
-```typescript
-import { createChatAnalytics } from 'baileys-joss'
-
-const analytics = createChatAnalytics()
-
-// Add messages for analysis
-analytics.addMessages(allMessages)
-
-// Get stats for specific chat
-const chatStats = analytics.getChatStats('6281234567890@s.whatsapp.net')
-
-console.log(`Total messages: ${chatStats.totalMessages}`)
-console.log(`From me: ${chatStats.messagesFromMe}`)
-console.log(`Media count: ${chatStats.mediaCount}`)
-console.log(`Links shared: ${chatStats.linkCount}`)
-console.log(`Emojis used: ${chatStats.emojiCount}`)
-console.log(`Most active hour: ${chatStats.mostActiveHour}:00`)
-console.log(`Most active day: ${chatStats.mostActiveDay}`)
-console.log(`Avg messages/day: ${chatStats.averageMessagesPerDay}`)
-
-// Message breakdown by type
-console.log('Messages by type:', chatStats.messagesByType)
-// { text: 150, image: 45, video: 12, audio: 8, ... }
-
-// Global stats across all chats
-const globalStats = analytics.getGlobalStats()
-console.log(`Total chats: ${globalStats.totalChats}`)
-console.log(`Total messages: ${globalStats.totalMessages}`)
-console.log(`Most active chat: ${globalStats.mostActiveChat?.jid}`)
-
-// Activity analysis
-const hourlyActivity = analytics.getActivityByHour(jid) // Array[24]
-const dailyActivity = analytics.getActivityByDay(jid) // { Sunday: 10, Monday: 25, ... }
+- You can pass all editable contents here
+```ts
+await sock.sendMessage(jid, {
+      text: 'updated text goes here',
+      edit: response.key,
+    });
+```
 
-// Top participants in group
-const topParticipants = analytics.getTopParticipants(groupJid, 5)
-for (const p of topParticipants) {
-    console.log(`${p.participant}: ${p.count} messages`)
+## Manipulating Media Messages
+
+### Thumbnail in Media Messages
+- For media messages, the thumbnail can be generated automatically for images & stickers provided you add `jimp` or `sharp` as a dependency in your project using `yarn add jimp` or `yarn add sharp`.
+- Thumbnails for videos can also be generated automatically, though, you need to have `ffmpeg` installed on your system.
+
+### Downloading Media Messages
+
+If you want to save the media you received
+```ts
+import { createWriteStream } from 'fs'
+import { downloadMediaMessage, getContentType } from '@whiskeysockets/baileys'
+
+sock.ev.on('messages.upsert', async ({ [m] }) => {
+    if (!m.message) return // if there is no text or media message
+    const messageType = getContentType(m) // get what type of message it is (text, image, video...)
+
+    // if the message is an image
+    if (messageType === 'imageMessage') {
+        // download the message
+        const stream = await downloadMediaMessage(
+            m,
+            'stream', // can be 'buffer' too
+            { },
+            {
+                logger,
+                // pass this so that baileys can request a reupload of media
+                // that has been deleted
+                reuploadRequest: sock.updateMediaMessage
+            }
+        )
+        // save to file
+        const writeStream = createWriteStream('./my-download.jpeg')
+        stream.pipe(writeStream)
+    }
 }
 ```
 
-</details>
-
-<details>
-<summary><h3>💾 Chat Export</h3></summary>
-
-Export chat ke JSON, HTML, TXT, atau CSV:
-
-```typescript
-import { createChatExporter, exportChat } from 'baileys-joss'
+### Re-upload Media Message to Whatsapp
 
-const exporter = createChatExporter()
-
-// Add messages
-exporter.addMessages(jid, chatMessages)
-
-// Export to JSON
-const jsonExport = exporter.export(jid, {
-    format: 'json',
-    includeMediaInfo: true,
-    includeMetadata: true
-})
-
-fs.writeFileSync(jsonExport.filename, jsonExport.content)
-
-// Export to HTML (readable format)
-const htmlExport = exporter.export(jid, {
-    format: 'html',
-    title: 'Chat dengan John',
-    dateFormat: 'YYYY-MM-DD HH:mm'
-})
-
-fs.writeFileSync(htmlExport.filename, htmlExport.content)
+- WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
+```ts
+await sock.updateMediaMessage(msg)
+```
 
-// Export to TXT (simple text)
-const txtExport = exporter.export(jid, {
-    format: 'txt',
-    dateRange: {
-        start: new Date('2024-01-01'),
-        end: new Date('2024-12-31')
-    }
-})
+## Reject Call
 
-// Export to CSV (for spreadsheet)
-const csvExport = exporter.export(jid, {
-    format: 'csv',
-    includeMetadata: true
-})
+- You can obtain `callId` and `callFrom` from `call` event
 
-// Quick export (without manager)
-const result = exportChat(messages, jid, { format: 'json' })
-console.log(`Exported ${result.messageCount} messages`)
-
-// Export all chats
-const allExports = exporter.exportAll({ format: 'json' })
+```ts
+await sock.rejectCall(callId, callFrom)
 ```
 
-</details>
+## Send States in Chat
 
-<details>
-<summary><h3>🎮 Mini Games (UNTESTED ⚠️)</h3></summary>
+### Reading Messages
+- A set of message [keys](https://baileys.wiki/docs/api/type-aliases/WAMessageKey/) must be explicitly marked read now.
+- You cannot mark an entire 'chat' read as it were with Baileys Web.
+This means you have to keep track of unread messages.
 
-Game sederhana untuk chat interaktif:
+```ts
+const key: WAMessageKey
+// can pass multiple keys to read multiple messages as well
+await sock.readMessages([key])
+```
 
-```typescript
-import { 
-    MiniGamesManager,
-    createTicTacToeGame,
-    createQuiz 
-} from 'baileys-joss'
+The message ID is the unique identifier of the message that you are marking as read.
+On a `WAMessage`, the `messageID` can be accessed using ```messageID = message.key.id```.
 
-// Create games manager
-const games = new MiniGamesManager()
+### Update Presence
 
-// 🎯 Guess Number Game
-const guessSession = games.startGuessNumber('6281234567890@s.whatsapp.net', {
-    minNumber: 1,
-    maxNumber: 100,
-    maxAttempts: 7
-})
+- ``` presence ``` can be one of the values in the [WAPresence type alias](https://baileys.wiki/docs/api/type-aliases/WAPresence/)
+- The presence expires after about 10 seconds.
+- This lets the person/group with `jid` know whether you're online, offline, typing etc.
 
-// Handle guess
-const result = games.handleGuess(guessSession.id, 50)
-if (result.correct) {
-    await sock.sendMessage(jid, { text: `🎉 Correct! The number was ${result.answer}` })
-} else {
-    await sock.sendMessage(jid, { text: `${result.hint} (${result.remaining} attempts left)` })
-}
-
-// 🧠 Quiz Game
-const quizSession = games.startQuiz(jid, {
-    questions: [
-        {
-            question: 'Apa ibukota Indonesia?',
-            options: ['Jakarta', 'Bandung', 'Surabaya', 'Medan'],
-            correctIndex: 0,
-            explanation: 'Jakarta adalah ibukota Indonesia sejak 1945'
-        }
-    ],
-    category: 'geography'
-})
-await sock.sendMessage(jid, { 
-    text: `📝 Quiz:\n${quizSession.data.currentQuestion}\n\n${quizSession.data.options.map((o, i) => `${i+1}. ${o}`).join('\n')}` 
-})
+```ts
+await sock.sendPresenceUpdate('available', jid)
+```
 
-// ❌⭕ TicTacToe Game  
-const tttSession = games.startTicTacToe(jid, player1Jid, player2Jid)
-const moveResult = games.handleMove(tttSession.id, player1Jid, 4) // Center position
+> [!NOTE]
+> If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Baileys client offline using `sock.sendPresenceUpdate('unavailable')`
 
-await sock.sendMessage(jid, { 
-    text: `${games.renderBoard(tttSession)}\n\n${moveResult.message}` 
-})
+## Modifying Chats
 
-// 🎲 Quick Games
-const dice = games.rollDice() // { value: 1-6, emoji: '🎲' }
-const coin = games.flipCoin() // { result: 'heads'|'tails', emoji: '🪙' }
-const rps = games.playRockPaperScissors('rock', 'scissors') // { winner: 'player1', ... }
-
-// 🏆 Leaderboard
-const leaderboard = games.getLeaderboard(10)
-```
-
-</details>
-
-<details>
-<summary><h3>🔍 Content Detector (UNTESTED ⚠️)</h3></summary>
-
-Deteksi otomatis berbagai jenis konten dalam pesan:
-
-```typescript
-import { 
-    ContentDetector, 
-    ContentFilter,
-    hasLinks,
-    hasPhoneNumbers,
-    hasEmails,
-    hasMediaContent 
-} from 'baileys-joss'
-
-// Create detector
-const detector = new ContentDetector()
-
-// Full analysis
-const result = detector.analyze(message)
-console.log('Has media:', result.hasMedia)
-console.log('Media type:', result.mediaType)
-console.log('Links found:', result.links)
-console.log('Phone numbers:', result.phoneNumbers)
-console.log('Emails:', result.emails)
-console.log('Mentions:', result.mentions)
-console.log('Hashtags:', result.hashtags)
-console.log('Word count:', result.wordCount)
-
-// Quick checks
-if (hasLinks(message)) {
-    console.log('Message contains links!')
-}
-if (hasPhoneNumbers(message)) {
-    console.log('Message contains phone numbers!')
-}
-if (hasMediaContent(message)) {
-    console.log('Message has media attachment!')
-}
+WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:
 
-// Content filtering
-const filter = new ContentFilter({
-    blockLinks: true,
-    blockedDomains: ['spam.com', 'malware.xyz'],
-    blockPhoneNumbers: false,
-    sensitiveKeywords: ['spam', 'promo', 'click here'],
-    maxMessageLength: 1000
-})
+> [!IMPORTANT]
+> If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.
 
-const filterResult = filter.check(message)
-if (!filterResult.allowed) {
-    await sock.sendMessage(jid, { 
-        text: `⚠️ Message blocked: ${filterResult.blockedReason}` 
-    })
-}
+### Archive a Chat
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)
 ```
+### Mute/Unmute a Chat
 
-</details>
-
-<details>
-<summary><h3>🛡️ Anti-Spam System (UNTESTED ⚠️)</h3></summary>
+- Supported times:
 
-Sistem untuk mendeteksi dan mencegah spam:
+| Time  | Miliseconds     |
+|-------|-----------------|
+| Remove | null           |
+| 8h     | 86.400.000     |
+| 7d     | 604.800.000    |
 
-```typescript
-import { AntiSpamManager } from 'baileys-joss'
+```ts
+// mute for 8 hours
+await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
+// unmute
+await sock.chatModify({ mute: null }, jid)
+```
+### Mark a Chat Read/Unread
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+// mark it unread
+await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)
+```
 
-// Create anti-spam manager
-const antispam = new AntiSpamManager({
-    maxMessagesPerMinute: 15,
-    maxDuplicates: 3,
-    duplicateWindow: 60000, // 1 minute
-    minMessageDelay: 500,
-    whitelist: ['admin@s.whatsapp.net'],
-    onSpamDetected: async (jid, message, result) => {
-        console.log(`Spam detected from ${jid}: ${result.reason}`)
-        if (result.action === 'mute') {
-            await sock.sendMessage(jid, { text: '⚠️ You are muted for spamming!' })
+### Delete a Message for Me
+```ts
+await sock.chatModify(
+    {
+        clear: {
+            messages: [
+                {
+                    id: 'ATWYHDNNWU81732J',
+                    fromMe: true,
+                    timestamp: '1654823909'
+                }
+            ]
         }
-    }
-})
-
-// Add custom spam pattern
-antispam.addRule({
-    id: 'promo_spam',
-    name: 'Promotional Spam',
-    type: 'pattern',
-    enabled: true,
-    config: { patterns: [/FREE\s+\d+\s+TOKEN/i, /CLICK\s+HERE.*WIN/i] },
-    action: 'delete'
-})
+    },
+    jid
+)
 
-// Check incoming messages
-sock.ev.on('messages.upsert', async ({ messages }) => {
-    for (const msg of messages) {
-        const result = await antispam.checkMessage(msg)
-        
-        if (result.isSpam) {
-            console.log(`🛡️ Spam blocked! Score: ${result.score}, Reason: ${result.reason}`)
-            
-            // Handle based on action
-            if (result.action === 'delete') {
-                await sock.sendMessage(msg.key.remoteJid, { delete: msg.key })
-            } else if (result.action === 'warn') {
-                await sock.sendMessage(msg.key.remoteJid, { 
-                    text: `⚠️ Warning: ${result.reason}` 
-                })
+```
+### Delete a Chat
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+await sock.chatModify({
+        delete: true,
+        lastMessages: [
+            {
+                key: lastMsgInChat.key,
+                messageTimestamp: lastMsgInChat.messageTimestamp
             }
-            continue
-        }
-        
-        // Process non-spam message...
-    }
-})
-
-// Whitelist trusted users
-antispam.whitelist('trusteduser@s.whatsapp.net')
-
-// Mute spammer temporarily
-antispam.muteUser('spammer@s.whatsapp.net', 3600) // 1 hour
-
-// Ban repeat offender
-antispam.banUser('baduser@s.whatsapp.net')
-
-// Get spam statistics
-const stats = antispam.getStats()
-console.log('Total spam blocked:', stats.totalBlocked)
+        ]
+    },
+    jid
+)
 ```
-
-</details>
-
-<details>
-<summary><h3>🔗 Link Scanner (UNTESTED ⚠️)</h3></summary>
-
-Scan dan validasi URL untuk keamanan:
-
-```typescript
-import { LinkScanner, scanUrls, isUrlSafe } from 'baileys-joss'
-
-// Create scanner
-const scanner = new LinkScanner({
-    followRedirects: true,
-    maxRedirects: 5,
-    timeout: 5000,
-    enablePhishingDetection: true
-})
-
-// Scan single URL
-const result = await scanner.scanUrl('https://suspicious-link.xyz/login')
-console.log('Safe:', result.safe)
-console.log('Risk level:', result.riskLevel) // 'safe' | 'low' | 'medium' | 'high' | 'critical'
-console.log('Threats:', result.threats)
-console.log('Details:', result.details)
-
-// Scan all URLs in a message
-const messageResults = await scanner.scanMessage(message)
-for (const urlResult of messageResults) {
-    if (!urlResult.safe) {
-        await sock.sendMessage(jid, { 
-            text: `⚠️ Warning! Suspicious link detected:\n${urlResult.url}\n\nRisk: ${urlResult.riskLevel}\nThreats: ${urlResult.threats.join(', ')}` 
-        })
-    }
-}
-
-// Quick safety check
-const isSafe = await scanner.isUrlSafe('https://example.com')
-
-// Add custom patterns
-scanner.addPhishingPattern(/banking.*verify.*account/i)
-scanner.addTrustedDomain('mytrusted.com')
-scanner.addMaliciousDomain('known-scam.xyz')
-
-// Auto-scan in message handler
-sock.ev.on('messages.upsert', async ({ messages }) => {
-    for (const msg of messages) {
-        const scanResults = await scanner.scanMessage(msg)
-        const dangerous = scanResults.filter(r => r.riskLevel === 'high' || r.riskLevel === 'critical')
-        
-        if (dangerous.length > 0) {
-            await sock.sendMessage(msg.key.remoteJid, { 
-                text: `🚨 Dangerous link(s) detected! ${dangerous.length} threat(s) found.`
-            }, { quoted: msg })
-        }
-    }
-})
+### Pin/Unpin a Chat
+```ts
+await sock.chatModify({
+        pin: true // or `false` to unpin
+    },
+    jid
+)
 ```
-
-</details>
-
-<details>
-<summary><h3>📝 Activity Logger (UNTESTED ⚠️)</h3></summary>
-
-Logging aktivitas untuk audit trail:
-
-```typescript
-import { ActivityLogger } from 'baileys-joss'
-
-// Create logger
-const logger = new ActivityLogger({
-    fileLogging: true,
-    logFilePath: './logs/bot-activity.log',
-    maxMemoryEntries: 1000,
-    maxFileSize: 10 * 1024 * 1024, // 10MB
-    minLevel: 'info',
-    categories: ['message', 'user', 'group', 'bot'],
-    onLog: (entry) => {
-        if (entry.level === 'error') {
-            // Send alert to admin
-            console.error(`[ALERT] ${entry.action}: ${entry.details.message}`)
+### Star/Unstar a Message
+```ts
+await sock.chatModify({
+        star: {
+            messages: [
+                {
+                    id: 'messageID',
+                    fromMe: true // or `false`
+                }
+            ],
+            star: true // - true: Star Message; false: Unstar Message
         }
-    }
-})
-
-// Log message activity
-logger.logMessage(message, 'received', {
-    processed: true,
-    responseTime: 150
-})
-
-// Log user action
-logger.logUserAction('6281234567890@s.whatsapp.net', 'command_executed', {
-    command: '/help',
-    success: true
-})
-
-// Log group action
-logger.logGroupAction('groupjid@g.us', 'member_added', {
-    addedBy: 'admin@s.whatsapp.net',
-    newMember: 'newuser@s.whatsapp.net'
-})
-
-// Log custom activity
-logger.log({
-    level: 'info',
-    category: 'bot',
-    action: 'scheduled_task',
-    actor: 'system',
-    details: { task: 'daily_backup', status: 'completed' }
-})
-
-// Query logs
-const recentErrors = logger.query({
-    level: 'error',
-    fromDate: new Date(Date.now() - 24 * 60 * 60 * 1000), // Last 24 hours
-    limit: 50
-})
-
-// Get statistics
-const stats = logger.getStats()
-console.log('Total entries:', stats.totalEntries)
-console.log('By level:', stats.byLevel)
-console.log('Top actors:', stats.topActors)
-
-// Export logs
-const jsonLogs = logger.export('json')
-const csvLogs = logger.export('csv')
+    },
+    jid
+)
 ```
 
-</details>
-
-<details>
-<summary><h3>🎭 Meme Generator (UNTESTED ⚠️)</h3></summary>
+### Disappearing Messages
 
-Generate meme sederhana dengan text overlay:
+- Ephemeral can be:
 
-```typescript
-import { 
-    MemeGenerator, 
-    MEME_TEMPLATES,
-    drakeMeme,
-    expandingBrainMeme,
-    thisIsFineMeme 
-} from 'baileys-joss'
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
 
-// Create generator
-const meme = new MemeGenerator()
+- You need to pass in **Seconds**, default is 7 days
 
-// List available templates
-const templates = meme.getTemplates()
-console.log('Available templates:', templates.map(t => t.name))
-
-// Generate Drake meme (quick helper)
-const drake = drakeMeme(
-    'Debugging code manually',      // Rejected
-    'Using console.log everywhere'  // Approved
+```ts
+// turn on disappearing messages
+await sock.sendMessage(
+    jid,
+    // this is 1 week in seconds -- how long you want messages to appear for
+    { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
 )
-await sock.sendMessage(jid, { text: drake.htmlContent })
-
-// Generate Expanding Brain meme
-const brain = expandingBrainMeme([
-    'Using var',
-    'Using let',
-    'Using const',
-    'Using TypeScript'
-])
-await sock.sendMessage(jid, { text: brain.htmlContent })
-
-// Generate "This is Fine" meme
-const fine = thisIsFineMeme('Production is on fire but it\'s fine')
-await sock.sendMessage(jid, { text: fine.htmlContent })
-
-// Custom meme with template
-const custom = meme.generateTextMeme({
-    template: 'distracted',
-    texts: {
-        boyfriend: 'Me',
-        girlfriend: 'My deadlines',
-        other: 'New side project'
-    },
-    fontSize: 24,
-    fontColor: '#ffffff'
-})
 
-// Generate SVG meme (for advanced use)
-const svgMeme = meme.generateSvgMeme({
-    template: 'two_buttons',
-    texts: {
-        button1: 'Sleep early',
-        button2: 'One more episode'
-    }
-})
+// will send as a disappearing message
+await sock.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })
 
-// Send as formatted text meme
-await sock.sendMessage(jid, { 
-    text: `🎭 *MEME*\n\n${custom.htmlContent}` 
-})
+// turn off disappearing messages
+await sock.sendMessage(
+    jid,
+    { disappearingMessagesInChat: false }
+)
 ```
 
-</details>
-
-<details>
-<summary><h3>🍅 Pomodoro Timer (UNTESTED ⚠️)</h3></summary>
-
-Timer produktivitas dengan teknik Pomodoro:
-
-```typescript
-import { PomodoroManager, DEFAULT_POMODORO_CONFIG } from 'baileys-joss'
-
-// Create pomodoro manager
-const pomodoro = new PomodoroManager()
-
-// Register event handler
-pomodoro.onEvent(async (event) => {
-    const jid = event.session.jid
-    
-    switch (event.type) {
-        case 'work_start':
-            await sock.sendMessage(jid, { 
-                text: `🍅 *WORK SESSION STARTED*\n\n⏱️ Duration: 25 minutes\n🎯 Session: ${event.session.currentSession}/${event.session.totalSessions}\n\n💪 Stay focused!` 
-            })
-            break
-        case 'work_end':
-            await sock.sendMessage(jid, { 
-                text: `✅ *WORK SESSION COMPLETE!*\n\n🎉 Great job! Time for a break.\n\nType /break to start break timer.` 
-            })
-            break
-        case 'break_start':
-            await sock.sendMessage(jid, { 
-                text: `☕ *BREAK TIME*\n\n⏱️ Duration: 5 minutes\n\n🧘 Relax and recharge!` 
-            })
-            break
-        case 'break_end':
-            await sock.sendMessage(jid, { 
-                text: `⏰ *BREAK OVER!*\n\nReady for next session?\nType /work to continue.` 
-            })
-            break
-    }
-})
+## User Querys
 
-// Start work session
-const session = pomodoro.start('6281234567890@s.whatsapp.net', {
-    workDuration: 25,      // 25 minutes
-    shortBreakDuration: 5, // 5 minutes
-    longBreakDuration: 15, // 15 minutes
-    sessionsBeforeLongBreak: 4,
-    autoStartBreaks: true
-})
+### Check If ID Exists in Whatsapp
+```ts
+const [result] = await sock.onWhatsApp(jid)
+if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)
+```
 
-// Pause/Resume
-pomodoro.pause(jid)
-pomodoro.resume(jid)
+### Query Chat History (groups too)
 
-// Start break manually
-pomodoro.startBreak(jid)
+- You need to have oldest message in chat
+```ts
+const msg = await getOldestMessageInChat(jid) // implement this on your end
+await sock.fetchMessageHistory(
+    50, //quantity (max: 50 per query)
+    msg.key,
+    msg.messageTimestamp
+)
+```
+- Messages will be received in `messaging.history-set` event
 
-// Get current status
-const status = pomodoro.status(jid)
-console.log('Status:', status.status) // 'work' | 'short_break' | 'long_break' | 'paused'
-console.log('Time remaining:', status.remainingTime)
-console.log('Current session:', status.currentSession)
+### Fetch Status
+```ts
+const status = await sock.fetchStatus(jid)
+console.log('status: ' + status)
+```
 
-// Stop and reset
-pomodoro.stop(jid)
+### Fetch Profile Picture (groups too)
+- To get the display picture of some person/group
+```ts
+// for low res picture
+const ppUrl = await sock.profilePictureUrl(jid)
+console.log(ppUrl)
 
-// Get statistics
-const stats = pomodoro.stats(jid)
-console.log('Total work sessions:', stats.totalWorkSessions)
-console.log('Total work minutes:', stats.totalWorkMinutes)
-console.log('Current streak:', stats.currentStreak)
+// for high res picture
+const ppUrl = await sock.profilePictureUrl(jid, 'image')
 ```
 
-</details>
+### Fetch Bussines Profile (such as description or category)
+```ts
+const profile = await sock.getBusinessProfile(jid)
+console.log('business description: ' + profile.description + ', category: ' + profile.category)
+```
 
-<details>
-<summary><h3>💬 Quote Generator (UNTESTED ⚠️)</h3></summary>
+### Fetch Someone's Presence (if they're typing or online)
+```ts
+// the presence update is fetched and called here
+sock.ev.on('presence.update', console.log)
 
-Random quotes dan quotes harian:
+// request updates for a chat
+await sock.presenceSubscribe(jid)
+```
 
-```typescript
-import { 
-    QuoteManager,
-    getRandomQuote,
-    getQuoteOfTheDay,
-    getMotivationalQuote,
-    getIslamicQuote,
-    getFunnyQuote,
-    quoteCommand,
-    QUOTES 
-} from 'baileys-joss'
+## Change Profile
 
-// Quick helpers
-const random = getRandomQuote()
-await sock.sendMessage(jid, { 
-    text: `💬 *Quote*\n\n"${random.text}"\n\n— ${random.author}` 
-})
+### Change Profile Status
+```ts
+await sock.updateProfileStatus('Hello World!')
+```
+### Change Profile Name
+```ts
+await sock.updateProfileName('My name')
+```
+### Change Display Picture (groups too)
+- To change your display picture or a group's
 
-// Quote of the day (same quote all day)
-const qotd = getQuoteOfTheDay()
-await sock.sendMessage(jid, { 
-    text: `📅 *Quote of the Day*\n\n"${qotd.quote.text}"\n\n— ${qotd.quote.author}` 
-})
+> [!NOTE]
+> Like media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](https://baileys.wiki/docs/api/type-aliases/WAMediaUpload/)
 
-// Category-specific quotes
-const motivational = getMotivationalQuote()
-const islamic = getIslamicQuote()
-const funny = getFunnyQuote()
+```ts
+await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })
+```
+### Remove display picture (groups too)
+```ts
+await sock.removeProfilePicture(jid)
+```
 
-// Using QuoteManager for more control
-const quoteManager = new QuoteManager()
+## Groups
 
-// Get quote by category
-const loveQuote = quoteManager.getByCategory('love')
-const wisdomQuote = quoteManager.getByCategory('wisdom')
+- To change group properties you need to be admin
 
-// Get quote by language
-const indonesianQuote = quoteManager.getByLanguage('id')
-const englishQuote = quoteManager.getByLanguage('en')
+### Create a Group
+```ts
+// title & participants
+const group = await sock.groupCreate('My Fab Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
+console.log('created group with id: ' + group.gid)
+await sock.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the group
+```
+### Add/Remove or Demote/Promote
+```ts
+// id & people to add to the group (will throw error if it fails)
+await sock.groupParticipantsUpdate(
+    jid,
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'add' // replace this parameter with 'remove' or 'demote' or 'promote'
+)
+```
+### Change Subject (name)
+```ts
+await sock.groupUpdateSubject(jid, 'New Subject!')
+```
+### Change Description
+```ts
+await sock.groupUpdateDescription(jid, 'New Description!')
+```
+### Change Settings
+```ts
+// only allow admins to send messages
+await sock.groupSettingUpdate(jid, 'announcement')
+// allow everyone to send messages
+await sock.groupSettingUpdate(jid, 'not_announcement')
+// allow everyone to modify the group's settings -- like display picture etc.
+await sock.groupSettingUpdate(jid, 'unlocked')
+// only allow admins to modify the group's settings
+await sock.groupSettingUpdate(jid, 'locked')
+```
+### Leave a Group
+```ts
+// will throw error if it fails
+await sock.groupLeave(jid)
+```
+### Get Invite Code
+- To create link with code use `'https://chat.whatsapp.com/' + code`
+```ts
+const code = await sock.groupInviteCode(jid)
+console.log('group code: ' + code)
+```
+### Revoke Invite Code
+```ts
+const code = await sock.groupRevokeInvite(jid)
+console.log('New group code: ' + code)
+```
+### Join Using Invitation Code
+- Code can't have `https://chat.whatsapp.com/`, only code
+```ts
+const response = await sock.groupAcceptInvite(code)
+console.log('joined to: ' + response)
+```
+### Get Group Info by Invite Code
+```ts
+const response = await sock.groupGetInviteInfo(code)
+console.log('group information: ' + response)
+```
+### Query Metadata (participants, name, description...)
+```ts
+const metadata = await sock.groupMetadata(jid)
+console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)
+```
+### Join using `groupInviteMessage`
+```ts
+const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
+console.log('joined to: ' + response)
+```
+### Get Request Join List
+```ts
+const response = await sock.groupRequestParticipantsList(jid)
+console.log(response)
+```
+### Approve/Reject Request Join
+```ts
+const response = await sock.groupRequestParticipantsUpdate(
+    jid, // group id
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'approve' // or 'reject'
+)
+console.log(response)
+```
+### Get All Participating Groups Metadata
+```ts
+const response = await sock.groupFetchAllParticipating()
+console.log(response)
+```
+### Toggle Ephemeral
 
-// Search quotes
-const searchResults = quoteManager.search('success')
+- Ephemeral can be:
 
-// Add custom quote
-quoteManager.addQuote({
-    id: 'custom1',
-    text: 'My custom inspirational quote',
-    author: 'Me',
-    category: 'inspirational',
-    language: 'en'
-})
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
 
-// Parse command (for bot integration)
-// Supported: /quote, /quote motivational, /quote islamic, /quote funny
-const commandResult = quoteCommand('/quote motivational')
-await sock.sendMessage(jid, { text: commandResult })
-
-// Send random quote with formatting
-const formatted = quoteManager.format(getRandomQuote(), {
-    style: 'fancy', // 'simple' | 'fancy' | 'minimal'
-    includeCategory: true
-})
-await sock.sendMessage(jid, { text: formatted })
+```ts
+await sock.groupToggleEphemeral(jid, 86400)
 ```
 
-</details>
+### Change Add Mode
+```ts
+await sock.groupMemberAddMode(
+    jid,
+    'all_member_add' // or 'admin_add'
+)
+```
 
-<details>
-<summary><h3>🌤️ Weather Bot (UNTESTED ⚠️)</h3></summary>
+## Privacy
 
-Informasi cuaca dengan integrasi OpenWeatherMap:
+### Block/Unblock User
+```ts
+await sock.updateBlockStatus(jid, 'block') // Block user
+await sock.updateBlockStatus(jid, 'unblock') // Unblock user
+```
+### Get Privacy Settings
+```ts
+const privacySettings = await sock.fetchPrivacySettings(true)
+console.log('privacy settings: ' + privacySettings)
+```
+### Get BlockList
+```ts
+const response = await sock.fetchBlocklist()
+console.log(response)
+```
+### Update LastSeen Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateLastSeenPrivacy(value)
+```
+### Update Online Privacy
+```ts
+const value = 'all' // 'match_last_seen'
+await sock.updateOnlinePrivacy(value)
+```
+### Update Profile Picture Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateProfilePicturePrivacy(value)
+```
+### Update Status Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateStatusPrivacy(value)
+```
+### Update Read Receipts Privacy
+```ts
+const value = 'all' // 'none'
+await sock.updateReadReceiptsPrivacy(value)
+```
+### Update Groups Add Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist'
+await sock.updateGroupsAddPrivacy(value)
+```
+### Update Default Disappearing Mode
 
-```typescript
-import { 
-    WeatherBot, 
-    getWeather, 
-    getSimpleWeather,
-    weatherCommand 
-} from 'baileys-joss'
+- Like [this](#disappearing-messages), ephemeral can be:
 
-// Create weather bot (with API key for full features)
-const weather = new WeatherBot({
-    apiKey: 'YOUR_OPENWEATHERMAP_API_KEY', // Optional: enables API mode
-    units: 'metric', // 'metric' | 'imperial'
-    language: 'id',
-    defaultCity: 'Jakarta'
-})
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
 
-// Get weather for a city
-const data = await weather.getWeather('Jakarta')
-await sock.sendMessage(jid, { 
-    text: `🌤️ *Weather in ${data.city}, ${data.country}*\n\n🌡️ Temperature: ${data.temperature}°C\n🤒 Feels like: ${data.feelsLike}°C\n💧 Humidity: ${data.humidity}%\n💨 Wind: ${data.windSpeed} m/s\n☁️ Condition: ${data.description}\n\n🌅 Sunrise: ${new Date(data.sunrise * 1000).toLocaleTimeString()}\n🌇 Sunset: ${new Date(data.sunset * 1000).toLocaleTimeString()}` 
-})
+```ts
+const ephemeral = 86400
+await sock.updateDefaultDisappearingMode(ephemeral)
+```
 
-// Quick helper (uses sample data if no API key)
-const simpleWeather = await getSimpleWeather('Tokyo')
-await sock.sendMessage(jid, { text: simpleWeather })
+## Broadcast Lists & Stories
 
-// Get 5-day forecast
-const forecast = await weather.getForecast('Singapore')
-let forecastText = `📅 *5-Day Forecast for ${forecast.city}*\n\n`
-for (const day of forecast.forecasts.slice(0, 5)) {
-    forecastText += `${day.date}: ${day.temperature}°C, ${day.description}\n`
-}
-await sock.sendMessage(jid, { text: forecastText })
-
-// Weather alerts
-const alerts = await weather.getAlerts('Miami')
-if (alerts.length > 0) {
-    for (const alert of alerts) {
-        await sock.sendMessage(jid, { 
-            text: `⚠️ *Weather Alert*\n\n${alert.event}\n\nSeverity: ${alert.severity}\n${alert.description}` 
-        })
+### Send Broadcast & Stories
+- Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        image: {
+            url: url
+        },
+        caption: caption
+    },
+    {
+        backgroundColor: backgroundColor,
+        font: font,
+        statusJidList: statusJidList,
+        broadcast: true
     }
-}
-
-// Parse weather command (for bot integration)
-// Supported: /weather Jakarta, /cuaca Bandung
-const result = await weatherCommand('/weather Singapore', weather)
-await sock.sendMessage(jid, { text: result })
-
-// Format with emoji
-const formatted = weather.formatWeather(data, {
-    includeEmoji: true,
-    includeDetails: true,
-    language: 'id'
-})
-await sock.sendMessage(jid, { text: formatted })
+)
+```
+- Message body can be a `extendedTextMessage` or `imageMessage` or `videoMessage` or `voiceMessage`, see the [AnyRegularMessageContent type alias](https://baileys.wiki/docs/api/type-aliases/AnyRegularMessageContent/)
+- You can add `backgroundColor` and other options in the message options, see the [MiscMessageGenerationOptions type alias](https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions/)
+- `broadcast: true` enables broadcast mode
+- `statusJidList`: a list of people that you can get which you need to provide, which are the people who will get this status message.
+
+- You can send messages to broadcast lists the same way you send messages to groups & individual chats.
+- Right now, WA Web does not support creating broadcast lists, but you can still delete them.
+- Broadcast IDs are in the format `12345678@broadcast`
+### Query a Broadcast List's Recipients & Name
+```ts
+const bList = await sock.getBroadcastListInfo('1234@broadcast')
+console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)
 ```
 
-</details>
-
-<details>
-<summary><h3>🔗 QR Code Generator</h3></summary>
-
-Generate QR code custom untuk pairing:
-
-```typescript
-import { 
-    createQRGenerator, 
-    QRHelper,
-    createQRHandler,
-    createWhatsAppQR 
-} from 'baileys-joss'
-
-// Quick QR generation
-const terminalQR = await QRHelper.terminal(pairingCode)
-console.log(terminalQR)
-
-// Generate SVG QR
-const svgQR = await QRHelper.svg(pairingCode, {
-    size: 300,
-    foregroundColor: '#128C7E', // WhatsApp green
-    backgroundColor: '#FFFFFF'
-})
-
-// Generate base64 QR (for web)
-const base64QR = await QRHelper.base64(pairingCode)
-
-// Generate PNG buffer
-const pngBuffer = await QRHelper.buffer(pairingCode)
-fs.writeFileSync('qr.png', pngBuffer)
-
-// Custom generator
-const generator = createQRGenerator({
-    size: 256,
-    errorCorrectionLevel: 'H',
-    foregroundColor: '#000000',
-    margin: 4
-})
-
-const qr = await generator.generate(data)
-
-// WhatsApp-styled QR
-const waQR = await createWhatsAppQR(pairingCode)
+## Writing Custom Functionality
+Baileys is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.
 
-// Use as QR event handler
+### Enabling Debug Level in Baileys Logs
+First, enable the logging of unhandled messages from WhatsApp by setting:
+```ts
 const sock = makeWASocket({
-    // ...
-    printQRInTerminal: false
-})
-
-sock.ev.on('connection.update', async ({ qr }) => {
-    if (qr) {
-        const qrHandler = createQRHandler({
-            maxAttempts: 5,
-            onQR: (rendered, raw, attempt) => {
-                console.log(`\nScan QR (${attempt}/5):\n`)
-                console.log(rendered)
-            }
-        })
-        await qrHandler(qr)
-    }
+    logger: P({ level: 'debug' }),
 })
 ```
+This will enable you to see all sorts of messages WhatsApp sends in the console.
 
-</details>
-
-<details>
-<summary><h3>📁 Media Downloader</h3></summary>
+### How Whatsapp Communicate With Us
 
-Download semua media dari chat:
+> [!TIP]
+> If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol
 
-```typescript
-import { createMediaDownloader, downloadAllMedia } from 'baileys-joss'
-
-const downloader = createMediaDownloader(
-    async (key) => store.loadMessage(key.remoteJid, key.id)
-)
-
-// Download all media from chat
-const summary = await downloader.downloadFromChat(
-    '6281234567890@s.whatsapp.net',
-    chatMessages,
+- **Example:** Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console:
+    ```
     {
-        outputDir: './downloads/john-doe',
-        types: ['image', 'video', 'document'], // or ['all']
-        createSubfolders: true, // images/, videos/, etc.
-        skipExisting: true,
-        maxFileSize: 50 * 1024 * 1024, // 50MB limit
-        delay: 500, // Delay between downloads
-        onProgress: (current, total, filename) => {
-            console.log(`Downloading ${current}/${total}: ${filename}`)
+        "level": 10,
+        "fromMe": false,
+        "frame": {
+            "tag": "ib",
+            "attrs": {
+                "from": "@s.whatsapp.net"
+            },
+            "content": [
+                {
+                    "tag": "edge_routing",
+                    "attrs": {},
+                    "content": [
+                        {
+                            "tag": "routing_info",
+                            "attrs": {},
+                            "content": {
+                                "type": "Buffer",
+                                "data": [8,2,8,5]
+                            }
+                        }
+                    ]
+                }
+            ]
         },
-        onError: (msg, error) => {
-            console.log(`Failed: ${error.message}`)
-        }
+        "msg":"communication"
     }
-)
+    ```
 
-console.log(`Downloaded: ${summary.successful}/${summary.total}`)
-console.log(`Total size: ${(summary.totalSize / 1024 / 1024).toFixed(2)} MB`)
-console.log(`Failed: ${summary.failed}`)
+The `'frame'` is what the message received is, it has three components:
+- `tag` -- what this frame is about (eg. message will have 'message')
+- `attrs` -- a string key-value pair with some metadata (contains ID of the message usually)
+- `content` -- the actual data (eg. a message node will have the actual message content in it)
+- read more about this format [here](/src/WABinary/readme.md)
 
-// Download single media
-const singleResult = await downloader.downloadSingle(
-    mediaMessage,
-    './downloads',
-    { filenameTemplate: '{type}_{date}_{id}{ext}' }
-)
+### Register a Callback for Websocket Events
 
-// Quick download all (without manager)
-await downloadAllMedia(messages, './downloads/all-media', {
-    types: ['image'],
-    onProgress: (curr, total) => console.log(`${curr}/${total}`)
-})
-```
+> [!TIP]
+> Recommended to see `onMessageReceived` function in `socket.ts` file to understand how websockets events are fired
+
+```ts
+// for any message with tag 'edge_routing'
+sock.ws.on('CB:edge_routing', (node: BinaryNode) => { })
 
-</details>
-
----
-
-## 📋 API Reference
-
-<details>
-<summary><b>🖱️ Interactive Messages</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `generateInteractiveButtonMessage()` | Buat button message dengan media header |
-| `generateInteractiveListMessage()` | Buat list message dengan sections |
-| `generateTemplateMessage()` | Buat template message (Quick Reply, URL, Call) |
-| `generateNativeFlowMessage()` | Buat native flow message (format terbaru) |
-| `generateCopyCodeButton()` | Button untuk copy code |
-| `generateUrlButtonMessage()` | Button dengan URL |
-| `generateQuickReplyButtons()` | Quick reply buttons |
-| `generateCombinedButtons()` | Gabungan berbagai jenis button |
-
-</details>
-
-<details>
-<summary><b>📍 JID Plotting</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `parseJid()` | Parse JID dan extract info lengkap |
-| `getSenderPn()` | Get senderPn dari AuthenticationCreds |
-| `getCurrentSenderInfo()` | Get current sender info dari authState |
-| `isSelf()` | Check apakah JID adalah diri sendiri |
-| `plotJid()` | Plot JID (basic, tanpa LID mapping) |
-| `normalizePhoneToJid()` | Normalize nomor ke JID |
-| `extractPhoneNumber()` | Extract phone number dari JID |
-| `formatJidDisplay()` | Format JID untuk display |
-| `isSameUser()` | Compare dua JID |
-| `getJidVariants()` | Get semua variant JID dari nomor |
-| `constructJidWithDevice()` | Construct JID dengan device ID |
-| `getRemoteJidFromMessage()` | Get remoteJid dari message |
-| `createJidPlotter()` | Create plotter dengan LID mapping support |
-
-</details>
-
-<details>
-<summary><b>📢 Newsletter/Channel</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `newsletterCreate()` | Buat channel baru |
-| `newsletterUpdateName()` | Update nama channel |
-| `newsletterUpdateDescription()` | Update deskripsi channel |
-| `newsletterUpdatePicture()` | Update foto channel |
-| `newsletterFollow()` | Follow channel |
-| `newsletterUnfollow()` | Unfollow channel |
-| `newsletterMute()` | Mute notifikasi channel |
-| `newsletterUnmute()` | Unmute notifikasi channel |
-| `newsletterReactMessage()` | React ke pesan channel |
-| `newsletterMetadata()` | Get metadata channel |
-| `newsletterAdminCount()` | Get jumlah admin |
-| `newsletterChangeOwner()` | Ganti owner channel |
-| `newsletterDemote()` | Demote admin channel |
-| `newsletterDelete()` | Hapus channel |
-
-</details>
-
-<details>
-<summary><b>👥 Group Management</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `groupCreate()` | Buat grup baru |
-| `groupUpdateSubject()` | Update nama grup |
-| `groupUpdateDescription()` | Update deskripsi grup |
-| `groupParticipantsUpdate()` | Add/remove/promote/demote member |
-| `groupSettingUpdate()` | Update pengaturan grup |
-| `groupMetadata()` | Get metadata grup |
-| `groupLeave()` | Keluar dari grup |
-| `groupInviteCode()` | Get kode invite grup |
-| `groupAcceptInvite()` | Join grup via invite code |
-
-</details>
-
-<details>
-<summary><b>💬 Message Types</b></summary>
-
-| Type | Description |
-|------|-------------|
-| `text` | Pesan teks biasa |
-| `image` | Kirim gambar (dengan opsi `hd: true` untuk kualitas HD) |
-| `video` | Kirim video (dengan opsi `hd: true` untuk kualitas HD) |
-| `audio` | Kirim audio |
-| `document` | Kirim dokumen |
-| `sticker` | Kirim sticker |
-| `location` | Kirim lokasi |
-| `contacts` | Kirim kontak |
-| `poll` | Buat polling |
-| `album` | Kirim album (multiple media) |
-| `react` | React ke pesan |
-| `edit` | Edit pesan |
-| `delete` | Hapus pesan |
-
-</details>
-
-<details>
-<summary><b>📷 Profile Picture</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `updateProfilePicture()` | Update foto profil (square crop) |
-| `updatePanoramaProfilePicture()` | Update foto profil panorama (wide, tidak di-crop) |
-| `removeProfilePicture()` | Hapus foto profil |
-| `profilePictureUrl()` | Get URL foto profil |
-
-</details>
-
-<details>
-<summary><b>🎮 Mini Games (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `MiniGamesManager` | Main class untuk manage semua games |
-| `games.startGuessNumber()` | Start guess number game |
-| `games.startQuiz()` | Start quiz game |
-| `games.startTicTacToe()` | Start TicTacToe (vs bot/player) |
-| `games.playRockPaperScissors()` | Play RPS game |
-| `games.rollDice()` | Roll dice (1-6) |
-| `games.flipCoin()` | Flip a coin |
-| `games.handleGuess()` | Handle guess input |
-| `games.handleMove()` | Handle TicTacToe move |
-| `games.getLeaderboard()` | Get player leaderboard |
-
-</details>
-
-<details>
-<summary><b>🔍 Content Detector (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `ContentDetector` | Main class untuk detect content |
-| `detector.analyze()` | Full content analysis |
-| `hasLinks()` | Quick check for URLs |
-| `hasPhoneNumbers()` | Quick check for phone numbers |
-| `hasEmails()` | Quick check for emails |
-| `hasMediaContent()` | Check if message has media |
-| `isForwarded()` | Check if message is forwarded |
-| `ContentFilter` | Filter messages by criteria |
-
-</details>
-
-<details>
-<summary><b>🛡️ Anti-Spam (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `AntiSpamManager` | Main anti-spam class |
-| `antispam.checkMessage()` | Check if message is spam |
-| `antispam.addRule()` | Add custom spam rule |
-| `antispam.muteUser()` | Mute user temporarily |
-| `antispam.banUser()` | Ban user permanently |
-| `antispam.whitelist()` | Add user to whitelist |
-| `antispam.getStats()` | Get spam statistics |
-
-</details>
-
-<details>
-<summary><b>🔗 Link Scanner (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `LinkScanner` | Main URL security scanner |
-| `scanner.scanUrl()` | Scan single URL |
-| `scanner.scanMessage()` | Scan all URLs in message |
-| `scanner.isUrlSafe()` | Quick safety check |
-| `scanner.addPhishingPattern()` | Add custom phishing pattern |
-| `scanner.addTrustedDomain()` | Add trusted domain |
-
-</details>
-
-<details>
-<summary><b>📝 Activity Logger (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `ActivityLogger` | Main logging class |
-| `logger.log()` | Log custom activity |
-| `logger.logMessage()` | Log message activity |
-| `logger.logUserAction()` | Log user action |
-| `logger.logGroupAction()` | Log group action |
-| `logger.query()` | Query logs with filters |
-| `logger.getStats()` | Get activity statistics |
-
-</details>
-
-<details>
-<summary><b>🎭 Meme Generator (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `MemeGenerator` | Main meme class |
-| `meme.generateTextMeme()` | Generate ASCII text meme |
-| `meme.generateSvgMeme()` | Generate SVG meme |
-| `meme.getTemplates()` | List available templates |
-| `drakeMeme()` | Quick Drake meme |
-| `expandingBrainMeme()` | Quick Expanding Brain meme |
-| `thisIsFineMeme()` | Quick "This is Fine" meme |
-
-</details>
-
-<details>
-<summary><b>🍅 Pomodoro Timer (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `PomodoroManager` | Main timer class |
-| `pomodoro.start()` | Start work session |
-| `pomodoro.break()` | Start break |
-| `pomodoro.pause()` | Pause timer |
-| `pomodoro.resume()` | Resume timer |
-| `pomodoro.stop()` | Stop and reset |
-| `pomodoro.status()` | Get current status |
-| `pomodoro.stats()` | Get statistics |
-
-</details>
-
-<details>
-<summary><b>💬 Quote Generator (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `QuoteManager` | Main quote class |
-| `getRandomQuote()` | Get random quote |
-| `getQuoteOfTheDay()` | Get daily quote |
-| `getMotivationalQuote()` | Get motivational quote |
-| `getIslamicQuote()` | Get Islamic quote |
-| `getFunnyQuote()` | Get funny quote |
-| `quoteCommand()` | Parse quote command |
-
-</details>
-
-<details>
-<summary><b>🌤️ Weather Bot (UNTESTED ⚠️)</b></summary>
-
-| Function | Description |
-|----------|-------------|
-| `WeatherBot` | Main weather class |
-| `weather.getWeather()` | Get weather for city |
-| `weather.setApiKey()` | Set OpenWeatherMap API key |
-| `getWeather()` | Quick weather helper |
-| `getSimpleWeather()` | Get simplified weather |
-| `weatherCommand()` | Parse weather command |
-
-</details>
-
----
-
-## 🔄 Changelog
-
-<details open>
-<summary><b>v1.0.2</b> - Latest (BIG UPDATE! 🎉)</summary>
-
-### 🆕 New Features
-
-**🎮 Mini Games (UNTESTED ⚠️)**
-- Guess Number game with hints
-- Quiz with multiple categories
-- TicTacToe (vs Bot or 2 players)
-- Rock Paper Scissors
-- Dice Roll & Coin Flip
-- Score tracking and leaderboards
-
-**🔍 Content Detector (UNTESTED ⚠️)**
-- URL/Link detection with extraction
-- Phone number detection
-- Email detection
-- Media type detection (image, video, audio, document, sticker)
-- Mention and hashtag extraction
-- Emoji analysis
-- Sensitive content filtering
-- Forwarded message detection
-
-**🛡️ Anti-Spam System (UNTESTED ⚠️)**
-- Rate limiting per user
-- Duplicate message detection
-- Flood protection
-- Pattern-based spam detection
-- User mute/ban functionality
-- Whitelist support
-- Customizable rules and thresholds
-
-**🔗 Link Scanner (UNTESTED ⚠️)**
-- URL security analysis
-- Phishing detection with pattern matching
-- URL shortener expansion
-- Suspicious TLD detection
-- Domain reputation checking
-- Risk level scoring (safe/low/medium/high/critical)
-- Redirect following for shortened URLs
-
-**📝 Activity Logger (UNTESTED ⚠️)**
-- Audit trail logging
-- Multiple log levels (debug, info, warn, error, critical)
-- Category-based logging (message, user, group, bot, security)
-- File logging with rotation support
-- Query and search logs
-- Statistics and analytics
-- Memory and file output options
-
-**🎭 Meme Generator (UNTESTED ⚠️)**
-- Text-based meme templates
-- Popular meme formats (Drake, Expanding Brain, Two Buttons, etc.)
-- SVG/HTML output generation
-- Custom template support
-- Quick meme helpers
-
-**🍅 Pomodoro Timer (UNTESTED ⚠️)**
-- Productivity timer with Pomodoro technique
-- Configurable work/break durations
-- Session tracking and statistics
-- Pause/resume functionality
-- Auto-start options
-- Streak tracking
-
-**💬 Quote Generator (UNTESTED ⚠️)**
-- 40+ built-in quotes (English & Indonesian)
-- Multiple categories (motivational, inspirational, love, life, success, wisdom, funny, islamic, philosophy)
-- Quote of the day feature
-- Search quotes by text or author
-- Custom quote support
-- Formatted output styles
-
-**🌤️ Weather Bot (UNTESTED ⚠️)**
-- Real-time weather information
-- OpenWeatherMap API integration
-- Mock data for offline use
-- Detailed weather display (temp, humidity, wind, etc.)
-- Weather advice based on conditions
-- Multiple city support
-- Caching for performance
-
-**📅 Message Scheduling**
-- Schedule messages for future delivery
-- Delay-based scheduling
-- Cancel/manage scheduled messages
-
-**📨 Bulk Messaging**
-- Send to multiple recipients with rate limiting
-- Progress tracking and callbacks
-- Retry mechanism with error handling
-
-**🔄 Auto Reply System**
-- Keyword-based auto replies
-- Regex pattern matching
-- Cooldown per user/rule
-- Group/private chat filters
-
-**📇 Contact Card (vCard)**
-- Full vCard generation with all fields
-- Multi-contact support
-- Quick contact helper
-
-**📺 Status/Story Posting**
-- Text status with backgrounds & fonts
-- Image/video/voice note status
-- Pre-defined backgrounds & styles
-
-**🎤 Voice Note Helper**
-- Audio conversion to Opus format
-- PTT mode support
-- Duration detection
-
-**📋 Message Templates**
-- Pre-built templates (order, invoice, etc.)
-- Variable substitution
-- Export/import templates
-
-**📡 Broadcast Manager**
-- Create and manage broadcast lists
-- Send to multiple lists
-- Statistics and tracking
-
-**⌨️ Typing Indicator**
-- Start/stop typing simulation
-- Recording indicator for voice notes
-- Auto-pause functionality
-
-**✅ Read Receipt Control**
-- Enable/disable read receipts
-- Delay before marking read
-- Exclude specific JIDs
-
-**🔍 Message Search**
-- Full-text search in messages
-- Regex support
-- Filter by type, date, sender
-
-**📊 Chat Analytics**
-- Message statistics
-- Activity by hour/day
-- Top participants
-- Media/link/emoji counts
-
-**💾 Chat Export**
-- Export to JSON, HTML, TXT, CSV
-- Customizable templates
-- Date range filtering
-
-**🔗 QR Code Generator**
-- Multiple output formats (terminal, SVG, PNG, base64)
-- Customizable colors and styles
-- WhatsApp-styled QR
-
-**📁 Media Downloader**
-- Batch download media from chats
-- Progress tracking
-- Type filtering and size limits
-
-### ✨ Improvements
-- ✨ **HD Images & Videos** - Send uncompressed media with `hd: true`
-- ✨ **Panorama Profile Picture** - Set wide/panoramic profile pictures without cropping
-- ✨ Higher quality thumbnails for HD mode
-- 📸 Better image quality preservation
-- 🎬 Video quality improvements
-- 📝 Added complete demo code example
-- 🎨 Improved documentation structure
-- 🐛 Bug fixes and performance improvements
-
-</details>
-
-<details>
-<summary><b>v1.0.1</b></summary>
-
-- ✨ Added Album Messages support (carousel format)
-- ✨ Added AI Message Style (`ai: true`) - shows AI indicator on messages
-- ✨ Added Custom Pairing Code support
-- ✨ Enhanced Newsletter/Channel control
-- ✨ Enhanced Poll creation
-- 🔧 **Fixed Interactive Buttons** - Added `biz` node for proper button rendering
-- 🔧 Fixed List Messages delivery
-- 🎨 Improved documentation with collapsible sections
-- 🐛 Bug fixes and stability improvements
-
-</details>
-
-<details>
-<summary><b>v1.0.0</b></summary>
-
-- 🎉 Initial release
-- ✨ Interactive Buttons support
-- ✨ List Messages support
-- ✨ Copy Code Button
-- ✨ URL Buttons
-- ✨ Combined Button Types
-- ✨ Native Flow Messages
-- ✨ LID/SenderPn Plotting utilities
-
-</details>
-
----
-
-## 🤝 Contributing
-
-Kontribusi sangat diterima! Silahkan:
-
-1. 🍴 Fork repository ini
-2. 🌿 Buat branch fitur (`git checkout -b feature/AmazingFeature`)
-3. 💾 Commit changes (`git commit -m 'Add some AmazingFeature'`)
-4. 📤 Push ke branch (`git push origin feature/AmazingFeature`)
-5. 🔃 Buka Pull Request
-
----
-
-## 💖 Support
-
-Jika project ini membantu, berikan ⭐ di [GitHub](https://github.com/firdausmntp/Baileys-Joss)!
-
-<p align="center">
-  <a href="https://github.com/firdausmntp/Baileys-Joss/stargazers">
-    <img src="https://img.shields.io/github/stars/firdausmntp/Baileys-Joss?style=social" alt="GitHub Stars"/>
-  </a>
-</p>
-
----
-
-## ⚠️ Disclaimer
-
-> **Peringatan:** Proyek ini tidak berafiliasi dengan WhatsApp atau Meta. Gunakan dengan tanggung jawab dan sesuai dengan Terms of Service WhatsApp.
-> 
-> ❌ **Jangan spam!**  
-> ❌ **Jangan abuse API!**  
-> ✅ **Gunakan untuk keperluan yang baik!**
-
----
-
-## 📄 License
-
-MIT License - Lihat file [LICENSE](LICENSE) untuk detail.
-
----
-
-## 🙏 Credits
-
-<table>
-<tr>
-<td align="center">
-<a href="https://github.com/WhiskeySockets/Baileys">
-<b>Baileys Original</b>
-</a>
-<br>Base library
-</td>
-<td align="center">
-<a href="https://github.com/WhiskeySockets">
-<b>WhiskeySockets</b>
-</a>
-<br>Maintainer Baileys
-</td>
-</tr>
-</table>
-
----
+// for any message with tag 'edge_routing' and id attribute = abcd
+sock.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })
 
-<p align="center">
-  <b>Made with ❤️ by <a href="https://github.com/firdausmntp">firdausmntp</a></b>
-</p>
+// for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
+sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })
+```
 
-<p align="center">
-  <img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript"/>
-  <img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" alt="Node.js"/>
-  <img src="https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white" alt="WhatsApp"/>
-</p>
+# License
+Copyright (c) 2025 Rajeh Taher/WhiskeySockets
+
+Licensed under the MIT License:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Thus, the maintainers of the project can't be held liable for any potential misuse of this project.