@hbmodsofc/baileys 1.0.6

package/README.MD

@@ -0,0 +1,1276 @@
+# <div align='center'>@hbmodsofc/baileys</div>
+
+<div align='center'>
+
+[![npm version](https://img.shields.io/npm/v/@hbmodsofc/baileys.svg)](https://www.npmjs.com/package/@hbmodsofc/baileys)
+[![License](https://img.shields.io/badge/license-GPL%203-blue.svg)](LICENSE)
+[![Downloads](https://img.shields.io/npm/dm/@hbmodsofc/baileys.svg)](https://www.npmjs.com/package/@hbmodsofc/baileys)
+
+</div>
+
+## ⚠️ Warning
+
+This project is not affiliated, associated, authorized, endorsed, or officially connected with WhatsApp or its subsidiaries. WhatsApp's official website is at whatsapp.com.
+
+@hbmodsofc/baileys administrators do not support the use of this application to violate WhatsApp's Terms of Service. We emphasize the user's personal responsibility to use it fairly and responsibly.
+
+Use it wisely. Avoid spam. Don't overuse automation.
+
+## 📦 Installation
+
+### Stable Version (Recommended)
+
+```bash
+npm i @hbmodsofc/baileys
+```
+
+### Edge Version (Latest Features)
+
+```bash
+npm i @hbmodsofc/baileys@latest
+# or
+yarn add @hbmodsofc/baileys@latest
+```
+
+### Import in Code
+
+```javascript
+const { default: makeWASocket } = require("@hbmodsofc/baileys")
+// or ES6
+import makeWASocket from "@hbmodsofc/baileys"
+```
+
+## 🚀 Quick Start
+
+### Basic Example
+
+```javascript
+const { default: makeWASocket, DisconnectReason, useMultiFileAuthState } = require('@hbmodsofc/baileys')
+const { Boom } = require('@hapi/boom')
+
+async function connectToWhatsApp() {
+    const { state, saveCreds } = await useMultiFileAuthState('auth_info_hbwabot')
+    
+    const sock = makeWASocket({
+        auth: state,
+        printQRInTerminal: true,
+        browser: ['HBWABot', 'Desktop', '3.0']
+    })
+
+    sock.ev.on('connection.update', (update) => {
+        const { connection, lastDisconnect } = update
+        if(connection === 'close') {
+            const shouldReconnect = (lastDisconnect?.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
+            console.log('Connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
+            if(shouldReconnect) {
+                connectToWhatsApp()
+            }
+        } else if(connection === 'open') {
+            console.log('✅ Successfully connected to WhatsApp!')
+        }
+    })
+
+    sock.ev.on('messages.upsert', async ({ messages }) => {
+        for (const m of messages) {
+            if (!m.message) continue
+            
+            console.log('📱 New message:', JSON.stringify(m, undefined, 2))
+            
+            // Balas otomatis
+            await sock.sendMessage(m.key.remoteJid!, { 
+                text: 'Hi! I'm a WhatsApp bot using @hbmodsofc/baileys 🤖' 
+            })
+        }
+    })
+
+    sock.ev.on('creds.update', saveCreds)
+}
+
+connectToWhatsApp()
+```
+
+## 📋 Table of Contents
+
+Disclaimer: This document is still in beta, so there may be errors or inconsistencies. 
+
+## 🔌 Account Connection
+
+WhatsApp provides a multi-device API that allows HBMods-OFC Library to authenticate as a secondary WhatsApp client via a QR code or pairing code.
+
+### Connect with QR Code
+
+> [!TIP]
+> Customize the browser name using the `Browsers` constant. See the available configurations below.
+
+```javascript
+const { default: makeWASocket, Browsers } = require("@hbmodsofc/baileys")
+
+const sock = makeWASocket({
+    browser: Browsers.ubuntu('My App'),
+    printQRInTerminal: true
+})
+```
+
+Once the connection is successful, a QR code will appear on the terminal. Scan it with WhatsApp on your phone to log in.
+
+### Connect with Pairing Code
+
+> [!IMPORTANT]
+> Pairing code is not part of the Mobile API. It allows WhatsApp Web connection without a QR code, but only between one device. See [FAQ WhatsApp](https://faq.whatsapp.com/).
+
+Phone numbers must be without `+`, `()`, or `-`, and include the country code.
+
+```javascript
+const { default: makeWASocket } = require("@hbmodsofc/baileys")
+
+const sock = makeWASocket({
+    printQRInTerminal: false
+})
+
+// Pairing Normal
+if (!sock.authState.creds.registered) {
+    const number = '918416093656'
+    const code = await sock.requestPairingCode(number)
+    console.log('🔑 Code Pairing:', code)
+}
+
+// Pairing Kustom
+if (!sock.authState.creds.registered) {
+    const pair = "HBWABOTZ" // 8 character
+    const number = '918416093656'
+    const code = await sock.requestPairingCode(number, pair)
+    console.log('🔑 Code Pairing custom:', code)
+}
+```
+
+### Receive Full History
+
+1. Set `syncFullHistory` to `true`.
+2. By default, the HBMods-OFC Library uses the Chrome configuration. For desktop-like connections (for more message history)
+
+```javascript
+const { default: makeWASocket, Browsers } = require("@hbmodsofc/baileys")
+
+const sock = makeWASocket({
+    browser: Browsers.macOS('Desktop'),
+    syncFullHistory: true
+})
+```
+
+## ⚙️ Important Socket Configuration Notes
+
+### Group Metadata Caching (Recommended)
+
+For group usage, implement group metadata caching:
+
+```javascript
+const { default: makeWASocket } = require("@hbmodsofc/baileys")
+const NodeCache = require('node-cache')
+
+const groupCache = new NodeCache({ stdTTL: 5 * 60, useClones: false })
+
+const sock = makeWASocket({
+    cachedGroupMetadata: async (jid) => groupCache.get(jid)
+})
+
+sock.ev.on('groups.update', async ([event]) => {
+    const metadata = await sock.groupMetadata(event.id)
+    groupCache.set(event.id, metadata)
+})
+
+sock.ev.on('group-participants.update', async (event) => {
+    const metadata = await sock.groupMetadata(event.id)
+    groupCache.set(event.id, metadata)
+})
+```
+
+### Improve the Vote Poll Retry & Decryption System
+
+Improve message delivery and vote poll decryption with the store:
+
+```javascript
+const sock = makeWASocket({
+    getMessage: async (key) => await getMessageFromStore(key)
+})
+```
+
+### Receive Notifications in the WhatsApp App
+
+Turn off your online status to receive notifications:
+
+```javascript
+const sock = makeWASocket({
+    markOnlineOnConnect: false
+})
+```
+
+## 💾 Save Auth Info
+
+Avoid repeated QR code scanning by saving credentials:
+
+```javascript
+const makeWASocket = require("@hbmodsofc/baileys").default
+const { useMultiFileAuthState } = require("@hbmodsofc/baileys")
+
+async function connect() {
+    const { state, saveCreds } = await useMultiFileAuthState('auth_info_hbwabot')
+    const sock = makeWASocket({ auth: state })
+    sock.ev.on('creds.update', saveCreds)
+}
+
+connect()
+```
+
+> [!IMPORTANT] 
+> `useMultiFileAuthState` stores the auth state in a folder. For production, use a SQL/No-SQL database and manage key updates carefully.
+
+```javascript
+const sock = makeWASocket()
+sock.ev.on('messages.upsert', ({ messages }) => {
+    console.log('Dapat pesan:', messages)
+})
+```
+
+### Starting Example
+
+```javascript
+const makeWASocket = require("@hbmodsofc/baileys").default
+const { DisconnectReason, useMultiFileAuthState } = require("@hbmodsofc/baileys")
+const { Boom } = require('@hapi/boom')
+
+async function connectToWhatsApp() {
+    const { state, saveCreds } = await useMultiFileAuthState('auth_info_hbwabot')
+    const sock = makeWASocket({
+        auth: state,
+        printQRInTerminal: true
+    })
+
+    sock.ev.on('connection.update', (update) => {
+        const { connection, lastDisconnect } = update
+        if(connection === 'close') {
+            const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
+            console.log('Connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
+            if(shouldReconnect) {
+                connectToWhatsApp()
+            }
+        } else if(connection === 'open') {
+            console.log('Open connection')
+        }
+    })
+
+    sock.ev.on('messages.upsert', async ({ messages }) => {
+        for (const m of messages) {
+            console.log(JSON.stringify(m, undefined, 2))
+            console.log('Balas ke', m.key.remoteJid)
+            await sock.sendMessage(m.key.remoteJid!, { text: 'Hello World' })
+        }
+    })
+
+    sock.ev.on('creds.update', saveCreds)
+}
+
+connectToWhatsApp()
+```
+
+### Vote Poll Decryption
+
+By default, vote polls are encrypted and handled in `messages.update`:
+
+```javascript
+sock.ev.on('messages.update', event => {
+    for(const { key, update } of event) {
+        if(update.pollUpdates) {
+            const pollCreation = await getMessage(key)
+            if(pollCreation) {
+                console.log(
+                    'update poll diterima, agregasi: ',
+                    getAggregateVotesInPollMessage({
+                        message: pollCreation,
+                        pollUpdates: update.pollUpdates,
+                    })
+                )
+            }
+        }
+    }
+})
+```
+
+`getMessage` is the store implementation (on your end).
+
+### First Connection Event Summary
+
+1. On the first connection, `connection.update` will be triggered, requesting a restart of the socket.
+2. Then, history messages are received in `messaging.history-set`.
+
+## 🗄️ Data Store Implementation
+
+The HBMods-OFC Library does not include default storage for chats, contacts, or messages. However, a simple in-memory implementation is provided. The store listens for chat updates, new messages, etc., to keep the data up to date.
+
+> [!IMPORTANT] 
+> I highly recommend building your own data store, as storing your entire chat history in memory is very RAM intensive.
+
+```javascript
+const makeWASocket = require("@hbmodsofc/baileys").default
+const { makeInMemoryStore } = require("@hbmodsofc/baileys")
+
+const store = makeInMemoryStore({ })
+
+store.readFromFile('./hbwabot_store.json')
+
+setInterval(() => {
+    store.writeToFile('./hbwabot_store.json')
+}, 10_000)
+
+const sock = makeWASocket({ })
+store.bind(sock.ev)
+
+sock.ev.on('chats.upsert', () => {
+    console.log('can chat', store.chats.all())
+})
+
+sock.ev.on('contacts.upsert', () => {
+    console.log('can contact', Object.values(store.contacts))
+})
+```
+
+The store also provides simple functions like `loadMessages` to speed up data retrieval.
+
+## 🆔 WhatsApp ID explanation
+
+`ID` is the WhatsApp ID, also called `jid`, for the person or group to whom the message is sent.
+
+Format: `[country code][phone number]@s.whatsapp.net`  
+Example: `+19999999999@s.whatsapp.net`.  
+
+For groups: `123456789-123345@g.us`.  
+
+For broadcast lists: `[creation timestamp]@broadcast`.  
+
+For story: `status@broadcast`.
+
+## 🔧 Utility Functions
+
+- `getContentType` - Returns the message content type
+- `getDevice` - Returns the device from the message
+- `makeCacheableSignalKeyStore` - Speeds up store auth
+- `downloadContentFromMessage` - Downloads content from a message
+
+## 📤 Send Message
+
+Send all types of messages with one function.
+
+See supported message content in the section below.
+See options like quotes in the example below.
+
+```javascript
+const jid: string
+const content: AnyMessageContent
+const options: MiscMessageGenerationOptions
+
+sock.sendMessage(jid, content, options)
+```
+
+### Non-Media Messages
+
+#### Text Message
+
+```javascript
+await sock.sendMessage(jid, { text: 'hello world' })
+```
+
+#### Quote Message (works with all types)
+
+```javascript
+await sock.sendMessage(jid, { text: 'hello world' }, { quoted: message })
+```
+
+#### Name User (works with most types)
+
+`@number` for mention in text, optional..
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        text: '@12345678901',
+        mentions: ['12345678901@s.whatsapp.net']
+    }
+)
+```
+
+#### Forward Message
+
+Requires a message object, retrieve it from the store or use a message object.
+
+```javascript
+const msg = getMessageFromStore() // implementasikan sendiri
+await sock.sendMessage(jid, { forward: msg })
+```
+
+#### Message Location
+
+```javascript
+await sock.sendMessage(
+    jid, 
+    {
+        location: {
+            degreesLatitude: 24.121231,
+            degreesLongitude: 55.1121221
+        }
+    }
+)
+```
+
+#### Contact Message
+
+```javascript
+const vcard = 'BEGIN:VCARD\n' 
+            + 'VERSION:3.0\n' 
+            + 'FN:Jeff Singh\n' 
+            + 'ORG:Ashoka Uni;\n' 
+            + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' 
+            + 'END:VCARD'
+
+await sock.sendMessage(
+    id,
+    { 
+        contacts: { 
+            displayName: 'Jeff', 
+            contacts: [{ vcard }] 
+        }
+    }
+)
+```
+
+#### Reaction Message
+
+Requires a message key, retrieve it from the store or use a key object.
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        react: {
+            text: '💖', // clear to delete reaction
+            key: message.key
+        }
+    }
+)
+```
+
+#### Message PIN
+
+Message key needed.
+
+Time:
+
+| Time | Seconds |
+|-------|------------|
+| 24h   | 86.400     |
+| 7h    | 604.800    |
+| 30h   | 2.592.000  |
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        pin: {
+            type: 1, // 0 to delete
+            time: 86400,
+            key: message.key
+        }
+    }
+)
+```
+
+#### Poll Message
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        poll: {
+            name: 'My Poll',
+            values: ['Option 1', 'Option 2', ...],
+            selectableCount: 1,
+            toAnnouncementGroup: false // or true
+        }
+    }
+)
+```
+
+### Send with Link Preview
+
+1. By default, WhatsApp doesn't generate links from the web.
+2. The HBMods-OFC Library has a link preview function.
+3. Add `link-preview-js` with `npm i link-preview-js`.
+4. Submit the link:
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        text: 'Hello, this was sent using https://npmjs.com/@hbmodsofc/baileys'
+    }
+)
+```
+
+### Media Messages
+
+Sending media (videos, stickers, images) is easier and more efficient.
+
+> [!NOTE] In media messages, you can use `{ stream: Stream }` or `{ url: Url }` or Buffer directly, see example below.
+
+HBMods-OFC Library does not fit the entire buffer into memory; encrypts as a stream.
+
+> [!TIP] Use Stream or URL to save memory.
+
+#### GIF Message
+
+WA does not support .gif, send as .mp4 with the `gifPlayback` flag.
+
+```javascript
+await sock.sendMessage(
+    jid, 
+    { 
+        video: fs.readFileSync('Media/ma_gif.mp4'),
+        caption: 'hello world',
+        gifPlayback: true
+    }
+)
+```
+
+#### Video Message
+
+```javascript
+await sock.sendMessage(
+    id, 
+    { 
+        video: {
+            url: './Media/ma_gif.mp4'
+        },
+        caption: 'Hello World',
+        ptv: false // true for video notes
+    }
+)
+```
+
+#### Audio Message
+
+Conversion with ffmpeg: `codec: libopus`, `ac: 1`, `avoid_negative_ts`, `make_zero`.
+
+Example: `ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg`
+
+```javascript
+await sock.sendMessage(
+    jid, 
+    {
+        audio: {
+            url: './Media/audio.mp3'
+        },
+        mimetype: 'audio/mp4'
+    }
+)
+```
+
+#### Image Message
+
+```javascript
+await sock.sendMessage(
+    id, 
+    { 
+        image: {
+            url: './Media/ma_img.png'
+        },
+        caption: 'hello world'
+    }
+)
+```
+
+#### View Once Messages
+
+Add `viewOnce: true` to all the above messages.
+
+```javascript
+await sock.sendMessage(
+    id, 
+    { 
+        image: {
+            url: './Media/ma_img.png'
+        },
+        viewOnce: true, // work with video, audio too
+        caption: 'Hello World'
+    }
+)
+```
+
+## ✏️ Edit Message
+
+### Delete Message (for all)
+
+```javascript
+const msg = await sock.sendMessage(jid, { text: 'Hello World' })
+await sock.sendMessage(jid, { delete: msg.key })
+```
+
+Note: Delete for self support via `chatModify`, see [Modify Chat](#modify-chat).
+
+### Edit Message
+
+Use editable content.
+
+```javascript
+await sock.sendMessage(jid, {
+      text: 'updated text here',
+      edit: response.key,
+    });
+```
+
+## 🖼️ Media Message Manipulation
+
+### Thumbnails in Media Messages
+
+Automatic thumbnails for images & stickers if you add `jimp` or `sharp` (`npm i jimp` or `npm i sharp`). 
+
+For video, ffmpeg is required.
+
+### Download Media Message
+
+To save received media:
+
+```javascript
+import { createWriteStream } from 'fs'
+import { downloadMediaMessage, getContentType } from '@hbmodsofc/baileys'
+
+sock.ev.on('messages.upsert', async ({ messages: [m] }) => {
+    if (!m.message) return
+    const messageType = getContentType(m)
+
+    if (messageType === 'imageMessage') {
+        const stream = await downloadMediaMessage(
+            m,
+            'stream', // atau 'buffer'
+            { },
+            { 
+                logger,
+                reuploadRequest: sock.updateMediaMessage
+            }
+        )
+        const writeStream = createWriteStream('./my-download.jpeg')
+        stream.pipe(writeStream)
+    }
+})
+```
+
+### Re-upload Media Messages to WhatsApp
+
+WA deletes old media from the server. Re-upload using:
+
+```javascript
+await sock.updateMediaMessage(msg)
+```
+
+## 📞 Reject Call
+
+Retrieve `callId` and `callFrom` from the `call` event.
+
+```javascript
+await sock.rejectCall(callId, callFrom)
+```
+
+## 💬 Send Status in Chat
+
+### Read Message
+
+The message key set must be explicitly marked read.
+
+```javascript
+const key: WAMessageKey
+await sock.readMessages([key]) // can be multiple keys
+```
+
+The message ID is a unique identifier. Access it with `message.key.id`.
+
+### Attendance Update
+
+`presence` bisa: available, composing, recording, paused, unavailable.
+
+Valid for 10 seconds. Tell jid whether you are online, offline, typing, etc.
+
+```javascript
+await sock.sendPresenceUpdate('available', jid) 
+```
+
+> [!NOTE] If the desktop client is active, WA does not send push notifications. To receive notifications, set it offline with `sock.sendPresenceUpdate('unavailable')`.
+
+## 📁 Change Chat
+
+WA uses encrypted communication for chat/app updates.
+
+> [!IMPORTANT] If the update is incorrect, WhatsApp may log you out of all devices.
+
+### Archive Chats
+
+```javascript
+const lastMsgInChat = await getLastMessageInChat(jid) // implement it yourself
+await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)
+```
+
+### Mute/Unmute Chat
+
+Supported time:
+
+| Time | Milliseconds |
+|-------|-------------|
+| Delete | null |
+| 8j    | 86.400.000  |
+| 7h    | 604.800.000 |
+
+```javascript
+// Mute 8 hours
+await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
+// Unmute
+await sock.chatModify({ mute: null }, jid)
+```
+
+### Mark Chats Read/Unread
+
+```javascript
+const lastMsgInChat = await getLastMessageInChat(jid)
+// mark as unread
+await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)
+```
+
+### Delete Message for Me
+
+```javascript
+await sock.chatModify(
+    {
+        clear: {
+            messages: [
+                {
+                    id: 'ATWYHDNNWU81732J',
+                    fromMe: true, 
+                    timestamp: '1654823909'
+                }
+            ]
+        }
+    }, 
+    jid
+)
+```
+
+### Delete Chat
+
+```javascript
+const lastMsgInChat = await getLastMessageInChat(jid)
+await sock.chatModify({
+        delete: true,
+        lastMessages: [
+            {
+                key: lastMsgInChat.key,
+                messageTimestamp: lastMsgInChat.messageTimestamp
+            }
+        ]
+    },
+    jid
+)
+```
+
+### Pin/Unpin Chat
+
+```javascript
+await sock.chatModify({
+        pin: true // or false to delete pin
+    },
+    jid
+)
+```
+
+### Star/Unstar Messages
+
+```javascript
+await sock.chatModify({
+        star: {
+            messages: [
+                {
+                    id: 'messageID',
+                    fromMe: true // or false
+                }
+            ],
+            star: true // true: Star; false: Unstar
+        }
+    },
+    jid
+)
+```
+
+### Disappearing Messages
+
+Ephemeral:
+
+| Time | Seconds |
+|-------|-------------|
+| Delete | 0           |
+| 24h   | 86.400      |
+| 7h    | 604.800     |
+| 90h   | 7.776.000   |
+
+Use seconds, default 7 days.
+
+```javascript
+// Enable disappearing messages
+await sock.sendMessage(
+    jid, 
+    { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
+)
+
+// Send as disappearing message
+await sock.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })
+
+// Turn off
+await sock.sendMessage(
+    jid, 
+    { disappearingMessagesInChat: false }
+)
+```
+
+## 👤 User Query
+
+### Check ID Exists on WhatsApp
+
+```javascript
+const [result] = await sock.onWhatsApp(jid)
+if (result.exists) console.log(`${jid} is on WhatsApp, as jid: ${result.jid}`)
+```
+
+### Query Chat History (groups too)
+
+Need the oldest message in a chat.
+
+```javascript
+const msg = await getOldestMessageInChat(jid) // implement it yourself
+await sock.fetchMessageHistory(
+    50, // jumlah (max: 50 per query)
+    msg.key,
+    msg.messageTimestamp
+)
+```
+
+Message received in `messaging.history-set` event.
+
+### Get Status
+
+```javascript
+const status = await sock.fetchStatus(jid)
+console.log('status: ' + status)
+```
+
+### Take Profile Photo (groups too)
+
+```javascript
+// low resolution
+const ppUrl = await sock.profilePictureUrl(jid)
+console.log(ppUrl)
+
+// high resolution
+const ppUrl = await sock.profilePictureUrl(jid, 'image')
+```
+
+### Get Business Profile (description or category)
+
+```javascript
+const profile = await sock.getBusinessProfile(jid)
+console.log('business description: ' + profile.description + ', category: ' + profile.category)
+```
+
+### Take Someone's Attendance (typing or online)
+
+```javascript
+sock.ev.on('presence.update', console.log)
+
+await sock.presenceSubscribe(jid) 
+```
+
+## 🔄 Change Profile
+
+### Change Profile Status
+
+```javascript
+await sock.updateProfileStatus('Hello World!')
+```
+
+### Change Profile Name
+
+```javascript
+await sock.updateProfileName('Your Name')
+```
+
+### Change Display Photo (groups too)
+
+> [!NOTE] Like media messages, use `{ stream: Stream }` or `{ url: Url }` or Buffer, see [Media Message](#media-message).
+
+```javascript
+await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })
+```
+
+### Delete Display Photo (groups too)
+
+```javascript
+await sock.removeProfilePicture(jid)
+```
+
+## 👥 Groups
+
+To change group properties, you must be an admin.
+
+### Create a Group
+
+```javascript
+const group = await sock.groupCreate('Your Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
+console.log('groups are created with id: ' + group.gid)
+await sock.sendMessage(group.id, { text: 'hi everybody' })
+```
+
+### Add/Delete or Lower/Increase
+
+```javascript
+await sock.groupParticipantsUpdate(
+    jid, 
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'add' // replace with 'remove', 'demote', or 'promote'
+)
+```
+
+### Change Subject (name)
+
+```javascript
+await sock.groupUpdateSubject(jid, 'New Subject!')
+```
+
+### Change Description
+
+```javascript
+await sock.groupUpdateDescription(jid, 'New Description!')
+```
+
+### Change Settings
+
+```javascript
+// Only admin send messages
+await sock.groupSettingUpdate(jid, 'announcement')
+// Everyone can send
+await sock.groupSettingUpdate(jid, 'not_announcement')
+// Everyone can change group settings
+await sock.groupSettingUpdate(jid, 'unlocked')
+// Only admin change settings
+await sock.groupSettingUpdate(jid, 'locked')
+```
+
+### Exit Group
+
+```javascript
+await sock.groupLeave(jid)
+```
+
+### Get Invitation Code
+
+Create link: `'https://chat.whatsapp.com/' + code`.
+
+```javascript
+const code = await sock.groupInviteCode(jid)
+console.log('kode grup: ' + code)
+```
+
+### Revoke Invitation Code
+
+```javascript
+const code = await sock.groupRevokeInvite(jid)
+console.log('New group code: ' + code)
+```
+
+### Join Using Invitation Code
+
+Code without `https://chat.whatsapp.com/`.
+
+```javascript
+const response = await sock.groupAcceptInvite(code)
+console.log('join in: ' + response)
+```
+
+### Get Group Info from Invitation Code
+
+```javascript
+const response = await sock.groupGetInviteInfo(code)
+console.log('group info: ' + response)
+```
+
+### Query Metadata (participant, name, description...)
+
+```javascript
+const metadata = await sock.groupMetadata(jid) 
+console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)
+```
+
+### Join Using groupInviteMessage
+
+```javascript
+const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
+console.log('join in: ' + response)
+```
+
+### Get Join Request List
+
+```javascript
+const response = await sock.groupRequestParticipantsList(jid)
+console.log(response)
+```
+
+### Approve/Decline Join Request
+
+```javascript
+const response = await sock.groupRequestParticipantsUpdate(
+    jid,
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'approve' // or 'reject'
+)
+console.log(response)
+```
+
+### Fetch All Followed Groups Metadata
+
+```javascript
+const response = await sock.groupFetchAllParticipating()
+console.log(response)
+```
+
+### Toggle Ephemeral
+
+Ephemeral:
+
+| Time | Seconds |
+|-------|-------------|
+| Delete | 0           |
+| 24h   | 86.400      |
+| 7h    | 604.800     |
+| 90h   | 7.776.000   |
+
+```javascript
+await sock.groupToggleEphemeral(jid, 86400)
+```
+
+### Ubah Mode Tambah
+
+```javascript
+await sock.groupMemberAddMode(
+    jid,
+    'all_member_add' // or 'admin_add'
+)
+```
+
+## 🔒 Privacy
+
+### Block/Unblock Users.
+
+```javascript
+await sock.updateBlockStatus(jid, 'block') // Block
+await sock.updateBlockStatus(jid, 'unblock') // Unblock.
+```
+
+### Take Privacy Settings
+
+```javascript
+const privacySettings = await sock.fetchPrivacySettings(true)
+console.log('privacy settings: ' + privacySettings)
+```
+
+### Get Block List
+
+```javascript
+const response = await sock.fetchBlocklist()
+console.log(response)
+```
+
+### Last Seen Privacy Update
+
+```javascript
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateLastSeenPrivacy(value)
+```
+
+### Online Privacy Update
+
+```javascript
+const value = 'all' // 'match_last_seen'
+await sock.updateOnlinePrivacy(value)
+```
+
+### Profile Photo Privacy Update
+
+```javascript
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateProfilePicturePrivacy(value)
+```
+
+### Update Privacy Status
+
+```javascript
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateStatusPrivacy(value)
+```
+
+### Read Receipt Privacy Update
+
+```javascript
+const value = 'all' // 'none'
+await sock.updateReadReceiptsPrivacy(value)
+```
+
+### Update Privacy Add Group
+
+```javascript
+const value = 'all' // 'contacts' | 'contact_blacklist'
+await sock.updateGroupsAddPrivacy(value)
+```
+
+### Update Default Disappearance Mode
+
+Ephemeral:
+
+| Time | Seconds |
+|-------|-------------|
+| Delete | 0           |
+| 24h   | 86.400      |
+| 7h    | 604.800     |
+| 90h   | 7.776.000   |
+
+```javascript
+const ephemeral = 86400 
+await sock.updateDefaultDisappearingMode(ephemeral)
+```
+
+## 📢 Broadcast & Story List
+
+### Send Broadcast & Story
+
+Messages can be sent to broadcasts and stories. Add a message option:
+
+```javascript
+await sock.sendMessage(
+    jid,
+    {
+        image: {
+            url: url
+        },
+        caption: caption
+    },
+    {
+        backgroundColor: backgroundColor,
+        font: font,
+        statusJidList: statusJidList,
+        broadcast: true
+    }
+)
+```
+
+The message body can be `extendedTextMessage`, `imageMessage`, etc., see [Media Message](#media-message).  
+
+`broadcast: true` enables broadcast mode.
+
+`statusJidList`: list of recipients.
+
+Broadcast ID: `12345678@broadcast`.
+
+### Query Receiver & Broadcast List Name
+
+```javascript
+const bList = await sock.getBroadcastListInfo('1234@broadcast')
+console.log(`list name: ${bList.name}, recipient: ${bList.recipients}`)
+```
+
+## 🛠️ Custom Functions
+
+The HBMods-OFC Library is designed for custom functions. Add your own extensions without forking.
+
+### Enable Debug Level in HBWABot Logs
+
+```javascript
+const sock = makeWASocket({
+    logger: P({ level: 'debug' }),
+})
+```
+
+It displays WhatsApp messages in the console.
+
+### How WhatsApp Communicates
+
+> [!TIP] Learn WhatsApp protocols with Libsignal Protocol and Noise Protocol.
+
+Example: Track phone battery percentage. Enable log, battery message appears:
+
+```json
+{
+    "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]
+                        }
+                    }
+                ]
+            }
+        ]
+    },
+    "msg":"communication"
+}
+```
+
+`'frame'` has: `tag` (frame type), `attrs` (metadata), `content` (data).  
+
+### Register Callbacks for Websocket Events
+
+> [!TIP] See the `onMessageReceived` function in `socket.ts`.
+
+```javascript
+// For tags 'edge_routing'
+sock.ws.on('CB:edge_routing', (node: BinaryNode) => { })
+
+// With id 'abcd'
+sock.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })
+
+// With node routing_info
+sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })
+```
+
+## 💡 Tips & Best Practices
+
+- **Use Caching**: Cache group metadata for better performance.
+- **Handle Reconnection**: Implement auto-reconnect for stability.
+- **Manage Store**: Use a database (MongoDB, PostgreSQL) for production.
+- **Error Handling**: Wrap socket calls with try-catch.
+- **Rate Limits**: Respect WhatsApp's limits to avoid bans—don't spam.
+- **Security**: Don't share auth credentials; use environment variables.
+
+## 📄 License
+
+Distributed under the GPL-3.0 License. See [LICENSE](LICENSE) for more information.
+
+---
+
+<div align="center">
+  Forked and modified by the HBMods-OFC.
+  Baileys - Modern WhatsApp Web API with @lid to @pn Improvements
+</div>