violetics 7.0.6-alpha → 7.0.8-alpha

package/README.md

@@ -1,1087 +1,565 @@
-# 🌱 Violetics
+<h1 align='center'><img alt="Baileys logo" src="https://raw.githubusercontent.com/WhiskeySockets/Baileys/refs/heads/master/Media/logo.png" height="75"/></h1>
 
-![Logo](https://files.catbox.moe/c5s9g0.jpg)
+<div align='center'>Baileys is a WebSockets-based TypeScript library for interacting with WhatsApp Web.</div>
 
-A lightweight fork of Baileys with a few fixes and a small adjustment.
-
-### ⚙️ Changes
-
-#### 🛠️ Internal Adjustments
-- 🖼️ Fixed an issue where media could not be sent to newsletters due to an upstream issue.
-- 📁 Reintroduced [`makeInMemoryStore`](#%EF%B8%8F-implementing-a-data-store) with a minimal ESM adaptation and small adjustments for Baileys v7.
-- 📦 Switched FFmpeg execution from `exec` to `spawn` for safer process handling.
-- 🗃️ Added `@napi-rs/image` as a supported image processing backend in `getImageProcessingLibrary()`, offering a balance between performance and compatibility.
-
-#### 📨 Message Handling & Compatibility
-- 👉🏻 Added support for sending [interactive message](#-sending-interactive-messages) types (button, list, interactive, template, carousel).
-- 📩 Added support for [album messages](#%EF%B8%8F-album-image--video), [group status messages](#4%EF%B8%8F⃣-group-status), [status mention messages](#%EF%B8%8F-status-mention), [sticker pack messages](#-sticker-pack), and several [payment-related messages](#-sending-payment-messages) (request payment, payment invite, order, invoice).
-- 📰 Simplified sending messages with ad thumbnails via [`externalAdReply`](#3%EF%B8%8F⃣-external-ad-reply) without requiring manual `contextInfo`.
-
-#### 🧩 Additional Message Options
-- 👁️ Added optional boolean flags for message handling:  
-   - [`ai`](#1%EF%B8%8F⃣-ai-label) - AI label on message
-   - [`mentionAll`](#-mention) - Mentions all group participants without requiring their JIDs in `mentions` or `mentionedJid`
-   - [`ephemeral`](#2%EF%B8%8F⃣-ephemeral), [`groupStatus`](#4%EF%B8%8F⃣-group-status), [`viewOnceV2`](#7%EF%B8%8F⃣-view-once-v2), [`viewOnceV2Extension`](#8%EF%B8%8F⃣-view-once-v2-extension), [`interactiveAsTemplate`](#3%EF%B8%8F⃣-interactive) - Message wrappers
-   - [`raw`](#5%EF%B8%8F⃣-raw) - Build your message manually **(DO NOT USE FOR EXPLOITATION)**
-
-> [!NOTE]
-📄 This project is maintained with limited scope and is not intended to replace upstream Baileys.
->
-> 😞 And, really sorry for my bad english.
-
-### 📥 Installation
-
-- 📄 Via `package.json`
-
-```json
-# NPM
-"dependencies": {
-   "violetics": "latest"
-}
-
-# GitHub
-"dependencies": {
-   "violetics": "github:cv3inx/violetics"
-}
-```
-
-- ⌨️ Via terminal
-
-```bash
-# NPM
-npm i violetics@latest
-
-# GitHub
-npm i github:cv3inx/violetics
-```
-
-#### 🧩 Import (ESM & CJS)
-
-```javascript
-// --- ESM
-import { makeWASocket } from 'violetics'
-
-// --- CJS (tested and working on Node.js 24 ✅)
-const { makeWASocket } = require('violetics')
-```
-
-### 🔧 Usage
-
-#### 🌐 Connect to WhatsApp (Quick Step)
-
-```javascript
-import { makeWASocket, delay, DisconnectReason, useMultiFileAuthState } from 'violetics'
-import { Boom } from '@hapi/boom'
-import pino from 'pino'
-
-// --- Connect with pairing code
-const myPhoneNumber = '6288888888888'
-
-const logger = pino({ level: 'silent' })
-
-const connectToWhatsApp = async () => {
-   const { state, saveCreds } = await useMultiFileAuthState('session')
-    
-   const sock = makeWASocket({
-      logger,
-      auth: state
-   })
-
-   sock.ev.on('creds.update', saveCreds)
-
-   sock.ev.on('connection.update', (update) => {
-      const { connection, lastDisconnect } = update
-      if (connection === 'connecting' && !sock.authState.creds.registered) {
-         await delay(1500)
-         const code = await sock.requestPairingCode(myPhoneNumber)
-         console.log('🔗 Pairing code', ':', code)
-      }
-      else if (connection === 'close') {
-         const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
-         console.log('⚠️ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
-         if (shouldReconnect) {
-            connectToWhatsApp()
-         }
-      }
-      else if (connection === 'open') {
-         console.log('✅ Successfully connected to WhatsApp')
-      }
-   })
-
-   sock.ev.on('messages.upsert', async ({ messages }) => {
-      for (const message of messages) {
-         if (!message.message) continue
-
-         console.log('🔔 Got new message', ':', message)
-         await sock.sendMessage(message.key.remoteJid, {
-            text: '👋🏻 Hello world'
-         })
-      }
-   })
-}
-
-connectToWhatsApp()
-```
-
-#### 🗄️ Implementing a Data Store
 
 > [!CAUTION]
-I highly recommend building your own data store, as keeping an entire chat history in memory can lead to excessive RAM usage.
-
-```javascript
-import { makeWASocket, makeInMemoryStore, delay, DisconnectReason, useMultiFileAuthState } from 'violetics'
-import { Boom } from '@hapi/boom'
-import pino from 'pino'
-
-const myPhoneNumber = '6288888888888'
-
-// --- Create your store path
-const storePath = './store.json'
-
-const logger = pino({ level: 'silent' })
-
-const connectToWhatsApp = async () => {
-   const { state, saveCreds } = await useMultiFileAuthState('session')
-    
-   const sock = makeWASocket({
-      logger,
-      auth: state
-   })
-
-   const store = makeInMemoryStore({
-      logger,
-      socket: sock
-   })
-
-   store.bind(sock.ev)
-
-   sock.ev.on('creds.update', saveCreds)
-
-   sock.ev.on('connection.update', (update) => {
-      const { connection, lastDisconnect } = update
-      if (connection === 'connecting' && !sock.authState.creds.registered) {
-         await delay(1500)
-         const code = await sock.requestPairingCode(myPhoneNumber)
-         console.log('🔗 Pairing code', ':', code)
-      }
-      else if (connection === 'close') {
-         const shouldReconnect = new Boom(connection?.lastDisconnect?.error)?.output?.statusCode !== DisconnectReason.loggedOut
-         console.log('⚠️ Connection closed because', lastDisconnect.error, ', reconnecting ', shouldReconnect)
-         if (shouldReconnect) {
-            connectToWhatsApp()
-         }
-      }
-      else if (connection === 'open') {
-         console.log('✅ Successfully connected to WhatsApp')
-      }
-   })
-
-   sock.ev.on('chats.upsert', () => {
-      console.log('✉️ Got chats', store.chats.all())
-   })
-
-   sock.ev.on('contacts.upsert', () => {
-      console.log('👥 Got contacts', Object.values(store.contacts))
-   })
-
-   // --- Read store from file
-   store.readFromFile(storePath)
-
-   // --- Save store every 3 minutes
-   setInterval(() => {
-      store.writeToFile(storePath)
-   }, 180000)
-}
-
-connectToWhatsApp()
-```
+> NOTICE OF BREAKING CHANGE.
+>
+> As of 1.0.0, multiple breaking changes were introduced into the library.
+>
+> Please check out https://whiskey.so/migrate-latest for more information.
 
-#### 🪪 WhatsApp IDs Explain
+# 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).
 
-`id` is the WhatsApp ID, called `jid` and `lid` too, of the person or group you're sending the message to.
-- It must be in the format `[country code][phone number]@s.whatsapp.net`
-   - Example for people: `19999999999@s.whatsapp.net` and `12699999999@lid`.
-   - For groups, it must be in the format `123456789-123345@g.us`.
-- For Meta AI, it's `11111111111@bot`.
-- For broadcast lists, it's `[timestamp of creation]@broadcast`.
-- For stories, the ID is `status@broadcast`.
+New guide link: https://baileys.wiki
 
-#### ✉️ Sending Messages
+# Get Support
 
-> [!NOTE]
-You can get the `jid` from `message.key.remoteJid` in the first example.
+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.
 
-##### 🔠 Text
+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.
 
-```javascript
-sock.sendMessage(jid, {
-   text: '👋🏻 Hello'
-}, {
-   quoted: message
-})
-```
+# Sponsor
+If you'd like to financially support this project, you can do so by supporting the current maintainer [here](https://purpshell.dev/sponsor).
 
-##### 🔔 Mention
+# 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.
 
-```javascript
-// --- Regular mention
-sock.sendMessage(jid, {
-   text: '👋🏻 Hello @628123456789',
-   mentions: ['628123456789@s.whatsapp.net']
-}, {
-   quoted: message
-})
+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.
 
-// --- Mention all
-sock.sendMessage(jid, {
-   text: '👋🏻 Hello @all',
-   mentionAll: true
-}, {
-   quoted: message
-})
-```
+##
 
-##### 😁 Reaction
+- 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.
 
-```javascript
-sock.sendMessage(jid, {
-   react: {
-      key: message.key,
-      text: '✨'
-   }
-}, {
-   quoted: message
-})
-```
+> [!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)**
 
-##### 📌 Pin Message
+## Example
 
-```javascript
-sock.sendMessage(jid, {
-   pin: message.key,
-   time: 86400, // --- Set the value in seconds: 86400 (1d), 604800 (7d), or 2592000 (30d)
-   type: 1 // --- Or 0 to remove
-}, {
-   quoted: message
-})
-```
+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 ```
 
-##### 👤 Contact
-
-```javascript
-const vcard = 'BEGIN:VCARD\n'
-            + 'VERSION:3.0\n'
-            + 'FN:Lia Wynn\n'
-            + 'ORG:Waiters;\n'
-            + 'TEL;type=CELL;type=VOICE;waid=628123456789:+62 8123 4567 89\n'
-            + 'END:VCARD'
-
-sock.sendMessage(jid, {
-   contacts: {
-      displayName: 'Lia',
-      contacts: [
-         { vcard }
-      ]
-   }
-}, {
-   quoted: message
-})
-```
+## Install
 
-##### 📍 Location
-
-```javascript
-sock.sendMessage(jid, {
-   location: {
-      degreesLatitude: 24.121231,
-      degreesLongitude: 55.1121221,
-      name: '👋🏻 I am here'
-   }
-}, {
-   quoted: message
-})
+Install dari file `.tgz` lokal (versi modified blckrose):
 ```
-
-##### 📊 Poll
-
-```javascript
-// --- Regular poll message
-sock.sendMessage(jid, {
-   poll: {
-      name: '🔥 Voting time',
-      values: ['Yes', 'No'],
-      selectableCount: 1,
-      toAnnouncementGroup: false
-   }
-}, {
-   quoted: message
-})
-
-// --- Quiz (only for newsletter)
-sock.sendMessage('1211111111111@newsletter', {
-   poll: {
-      name: '🔥 Quiz',
-      values: ['Yes', 'No'],
-      correctAnswer: 'Yes',
-      pollType: 1
-   }
-}, {
-   quoted: message
-})
-
-// --- Poll result
-sock.sendMessage(jid, {
-   pollResult: {
-      name: '📝 Poll Result',
-      votes: [{
-         name: 'Nice',
-         voteCount: 10
-      }, {
-         name: 'Nah',
-         voteCount: 2
-      }],
-      pollType: 0 // Or 1 for quiz
-   }
-}, {
-   quoted: message
-})
-
-// --- Poll update
-sock.sendMessage(jid, {
-   pollUpdate: {
-      metadata: {},
-      key: message.key,
-      vote: {
-         enclv: /* <Buffer> */,
-         encPayload: /* <Buffer> */
-      }
-   }
-}, {
-   quoted: message
-})
+npm install ./blckrose-baileys-1.2.9.tgz
 ```
 
-##### 🎞️ Status Mention
-
-```javascript
-sock.sendMessage([jidA, jidB, jidC], {
-   text: 'Hello! 👋🏻'
-})
+Atau tambahkan ke `package.json`:
+```json
+{
+  "dependencies": {
+    "@blckrose/baileys": "file:./blckrose-baileys-1.2.9.tgz"
+  }
+}
 ```
 
-#### 📁 Sending Media Messages
+Kemudian jalankan:
+```
+npm install
+```
+
+**ESM:**
+```ts
+import makeWASocket from '@blckrose/baileys'
+```
+
+**CJS (destructure langsung, tanpa top-level await):**
+```js
+const { makeWASocket, useMultiFileAuthState, Browsers, DisconnectReason } = require('@blckrose/baileys')
+// global apocalypse otomatis tersedia setelah baris di atas
+```
+
+# Links
+
+- [Discord](https://discord.gg/WeJM5FP9GG)
+- [Docs](https://guide.whiskeysockets.io/)
+
+# 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)
+- [Newsletter / Channel](#newsletter--channel)
+    - [Kirim Media ke Channel](#kirim-media-ke-channel)
+    - [Button di Channel](#button-di-channel)
+    - [Edit & Hapus Pesan Channel](#edit--hapus-pesan-channel)
+- [Resolve JID (LID → Phone)](#resolve-jid)
+- [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)
+        - [Live Location Message](#live-location-message)
+        - [Contact Message](#contact-message)
+        - [Reaction Message](#reaction-message)
+        - [Pin Message](#pin-message)
+        - [Keep Message](#keep-message)
+        - [Poll Message](#poll-message)
+        - [Poll Result Message](#poll-result-message)
+        - [Call Message](#call-message)
+        - [Event Message](#event-message)
+        - [Order Message](#order-message)
+        - [Product Message](#product-message)
+        - [Payment Message](#payment-message)
+        - [Payment Invite Message](#payment-invite-message)
+        - [Admin Invite Message](#admin-invite-message)
+        - [Group Invite Message](#group-invite-message)
+        - [Sticker Pack Message](#sticker-pack-message)
+        - [Share Phone Number Message](#share-phone-number-message)
+        - [Request Phone Number Message](#request-phone-number-message)
+        - [Buttons Reply Message](#buttons-reply-message)
+        - [Buttons Message](#buttons-message)
+        - [Buttons List Message](#buttons-list-message)
+        - [Buttons Product List Message](#buttons-product-list-message)
+        - [Buttons Cards Message](#buttons-cards-message)
+        - [Buttons Template Message](#buttons-template-message)
+        - [Buttons Interactive Message](#buttons-interactive-message)
+        - [Buttons Interactive Message PIX](#buttons-interactive-message-pix)
+        - [Buttons Interactive Message PAY](#buttons-interactive-message-pay)
+        - [Status Mentions Message](#status-mentions-message)
+        - [Shop Message](#shop-message)
+        - [Collection Message](#collection-message)
+    - [AI Icon Feature](#ai-icon-feature)
+    - [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)
+        - [Album Message](#album-message)
+        - [Ptv Video Message](#ptv-video-message)
+        - [View Once 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)
+    - [Clear Messages](#clear-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]
-For media messages, you can pass a `Buffer` directly, or an object with either `{ stream: Readable }` or `{ url: string }` (local file path or HTTP/HTTPS URL).
-
-##### 🖼️ Image
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '🔥 Superb'
-}, {
-   quoted: message
-})
-```
+> **[Here](#example-to-start) is a simple example of event handling**
 
-##### 🎥 Video
-
-```javascript
-sock.sendMessage(jid, {
-   video: {
-      url: './path/to/video.mp4'
-   },
-   gifPlayback: false, // --- Set true if you want to send video as GIF
-   ptv: false,  // --- Set true if you want to send video as PTV
-   caption: '🔥 Superb'
-}, {
-   quoted: message
-})
-```
+> [!TIP]
+> **You can see all supported socket configs [here](https://baileys.whiskeysockets.io/types/SocketConfig.html) (Recommended)**
 
-##### 📃 Sticker
-
-```javascript
-sock.sendMessage(jid, {
-   sticker: {
-      url: './path/to/sticker.webp'
-   }
-}, {
-   quoted: message
-})
-```
+### Starting socket with **QR-CODE**
 
-##### 💽 Audio
+> [!TIP]
+> You can customize browser name if you connect with **QR-CODE**, with `Browser` constant, we have some browsers config, **see [here](https://baileys.whiskeysockets.io/types/BrowsersMap.html)**
 
-```javascript
-sock.sendMessage(jid, {
-   audio: {
-      url: './path/to/audio.mp3'
-   },
-   ptt: false, // --- Set true if you want to send audio as Voice Note
-}, {
-   quoted: message
-})
-```
+```ts
+import makeWASocket from '@blckrose/baileys'
 
-##### 🖼️ Album (Image & Video)
-
-```javascript
-sock.sendMessage(jid, {
-   album: [{
-      image: {
-         url: './path/to/image.jpg'
-      },
-      caption: '1st image'
-   }, {
-      video: {
-         url: './path/to/video.mp4'
-      },
-      caption: '1st video'
-   }, {
-      image: {
-         url: './path/to/image.jpg'
-      },
-      caption: '2nd image'
-   }, {
-      video: {
-         url: './path/to/video.mp4'
-      },
-      caption: '2nd video'
-   }]
-}, {
-   quoted: message
+const sock = makeWASocket({
+    // can provide additional config here
+    browser: Browsers.ubuntu('My App'),
+    printQRInTerminal: true
 })
 ```
 
-##### 📦 Sticker Pack
-
-> [!IMPORTANT]
-If `sharp` or `@napi-rs/image` is not installed, the `cover` and `stickers` must already be in WebP format.
-
-```javascript
-sock.sendMessage(jid, {
-   cover: {
-      url: './path/to/image.webp'
-   },
-   stickers: [{
-      data: {
-         url: './path/to/image.webp'
-      }
-   }, {
-      data: {
-         url: './path/to/image.webp'
-      }
-   }, {
-      data: {
-         url: './path/to/image.webp'
-      }
-   }],
-   name: '📦 My Sticker Pack',
-   publisher: '🌟 Lia Wynn',
-   description: 'violetics'
-}, {
-   quoted: message
-})
-```
+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!
 
-#### 👉🏻 Sending Interactive Messages
-
-##### 1️⃣ Buttons
-
-```javascript
-// --- Regular buttons message
-sock.sendMessage(jid, {
-   text: '👆🏻 Buttons!',
-   footer: 'violetics',
-   buttons: [{
-      text: '👋🏻 SignUp',
-      id: '#SignUp'
-   }]
-}, {
-   quoted: message
-})
+### Starting socket with **Pairing Code**
 
-// --- Buttons with Media & Native Flow
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👆🏻 Buttons and Native Flow!',
-   footer: 'violetics',
-   buttons: [{
-      text: '👋🏻 Rating',
-      id: '#Rating'
-   }, {
-      text: '📋 Select',
-      sections: [{
-         title: '✨ Section 1',
-         rows: [{
-            header: '',
-            title: '💭 Secret Ingredient',
-            description: '',
-            id: '#SecretIngredient'
-         }]
-      }, {
-         title: '✨ Section 2',
-         highlight_label: '🔥 Popular',
-         rows: [{
-            header: '',
-            title: '🏷️ Coupon',
-            description: '',
-            id: '#CouponCode'
-         }]
-      }]
-   }]
-}, {
-   quoted: message
-})
-```
 
-##### 2️⃣ List
+> [!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)
 
-> [!NOTE]
-It only works in private chat (`@s.whatsapp.net`).
-
-```javascript
-sock.sendMessage(jid, {
-   text: '📋 List!',
-   footer: 'violetics',
-   buttonText: '📋 Select',
-   title: '👋🏻 Hello',
-   sections: [{
-      title: '🚀 Menu 1',
-      rows: [{
-         title: '✨ AI',
-         description: '',
-         rowId: '#AI'
-      }]
-   }, {
-      title: '🌱 Menu 2',
-      rows: [{
-         title: '🔍 Search',
-         description: '',
-         rowId: '#Search'
-      }]
-   }]
-}, {
-   quoted: message
-})
-```
+The phone number can't have `+` or `()` or `-`, only numbers, you must provide country code
 
-##### 3️⃣ Interactive
-
-```javascript
-// --- Native Flow
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '🗄️ Interactive!',
-   footer: 'violetics',
-   optionText: '👉🏻 Select Options', // --- Optional, wrap all native flow into a single list
-   optionTitle: '📄 Select Options', // --- Optional
-   couponText: '🏷️ Newest Coupon!', // --- Optional, add coupon into message
-   couponCode: 'violetics', // --- Optional
-   nativeFlow: [{
-      text: '👋🏻 Greeting',
-      id: '#Greeting'
-   }, {
-      text: '📞 Call',
-      call: '628123456789'
-   }, {
-      text: '📋 Copy',
-      copy: 'violetics'
-   }, {
-      text: '🌐 Source',
-      url: 'https://www.npmjs.com/package/baileys'
-   }, {
-      text: '📋 Select',
-      sections: [{
-         title: '✨ Section 1',
-         rows: [{
-            header: '',
-            title: '🏷️ Coupon',
-            description: '',
-            id: '#CouponCode'
-         }]
-      }, {
-         title: '✨ Section 2',
-         highlight_label: '🔥 Popular',
-         rows: [{
-            header: '',
-            title: '💭 Secret Ingredient',
-            description: '',
-            id: '#SecretIngredient'
-         }]
-      }]
-   }],
-   interactiveAsTemplate: false, // --- Optional, wrap the interactive message into a template
-}, {
-   quoted: message
-})
+```ts
+import makeWASocket from '@blckrose/baileys'
 
-// --- Carousel & Native Flow
-sock.sendMessage(jid, {
-   text: '🗂️ Interactive with Carousel!',
-   footer: 'violetics',
-   cards: [{
-      image: {
-         url: './path/to/image.jpg'
-      },
-      caption: '🖼️ Image 1',
-      footer: '🏷️️ Pinterest',
-      nativeFlow: [{
-         text: '🌐 Source',
-         url: 'https://www.npmjs.com/package/baileys'
-      }]
-   }, {
-      image: {
-         url: './path/to/image.jpg'
-      },
-      caption: '🖼️ Image 2',
-      footer: '🏷️ Pinterest',
-      couponText: '🏷️ New Coupon!',
-      couponCode: 'violetics',
-      nativeFlow: [{
-         text: '🌐 Source',
-         url: 'https://www.npmjs.com/package/baileys'
-      }]
-   }, {
-      image: {
-         url: './path/to/image.jpg'
-      },
-      caption: '🖼️ Image 3',
-      footer: '🏷️ Pinterest',
-      optionText: '👉🏻 Select Options',
-      optionTitle: '📄 Select Options',
-      couponText: '🏷️ New Coupon!',
-      couponCode: 'violetics',
-      nativeFlow: [{
-         text: '🛒 Product',
-         id: '#Product'
-      }, {
-         text: '🌐 Source',
-         url: 'https://www.npmjs.com/package/baileys'
-      }]
-   }]
-}, {
-   quoted: message
+const sock = makeWASocket({
+    // can provide additional config here
+    printQRInTerminal: false //need to be false
 })
-```
 
-##### 4️⃣ Hydrated Template
-
-```javascript
-sock.sendMessage(jid, {
-   title: '👋🏻 Hello',
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '🫙 Template!',
-   footer: 'violetics',
-   templateButtons: [{
-      text: '👉🏻 Tap Here',
-      id: '#Order'
-   }, {
-      text: '🌐 Source',
-      url: 'https://www.npmjs.com/package/baileys'
-   }, {
-      text: '📞 Call',
-      call: '628123456789'
-   }]
-}, {
-   quoted: message
-})
+if (!sock.authState.creds.registered) {
+    const number = 'XXXXXXXXXXX'
+    const code = await sock.requestPairingCode(number)
+    console.log(code)
+}
 ```
 
-#### 💳 Sending Payment Messages
+### Receive Full History
 
-##### 1️⃣ Invite Payment
+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:
 
-```javascript
-sock.sendMessage(jid, {
-   paymentInviteServiceType: 3 // 1, 2, or 3
+```ts
+const sock = makeWASocket({
+    ...otherOpts,
+    // can use Windows, Ubuntu here too
+    browser: Browsers.macOS('Desktop'),
+    syncFullHistory: true
 })
 ```
 
-##### 2️⃣ Invoice
+## Important Notes About Socket Config
 
-> [!NOTE]
-Invoice message are not supported yet.
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   invoiceNote: '🏷️ Invoice'
-})
-```
+### 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:
 
-##### 3️⃣ Order
+    ```ts
+    const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})
 
-```javascript
-sock.sendMessage(chat, {
-   orderText: '🛍️ Order',
-   thumbnail: fs.readFileSync('./path/to/image.jpg') // --- Must in buffer format
-}, {
-   quoted: message
-})
-```
+    const sock = makeWASocket({
+        cachedGroupMetadata: async (jid) => groupCache.get(jid)
+    })
 
-##### 4️⃣ Product
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   product: {
-      title: '🛒 My Product'
-   },
-   businessOwnerJid: '0@s.whatsapp.net' // --- Must included
-}, {
-   quoted: message
-})
-```
+    sock.ev.on('groups.update', async ([event]) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
 
-##### 5️⃣ Request Payment
+    sock.ev.on('group-participants.update', async (event) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
+    ```
 
-```javascript
-sock.sendMessage(jid, {
-   text: '💳 Request Payment',
-   requestPaymentFrom: '0@s.whatsapp.net'
-})
-```
+### 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)
+    })
+    ```
 
-#### 👁️ Other Message Options
+### 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
 
-##### 1️⃣ AI Label
+You obviously don't want to keep scanning the QR code every time you want to connect.
 
-> [!NOTE]
-It only works in private chat (`@s.whatsapp.net`).
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '🤖 AI Labeled!',
-   ai: true
-}, {
-   quoted: message
-})
-```
+So, you can load the credentials to log back in:
+```ts
+import makeWASocket, { useMultiFileAuthState } from '@blckrose/baileys'
 
-##### 2️⃣ Ephemeral
+const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
 
-> [!NOTE]
-Wrap message into `ephemeralMessage`
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👁️ Ephemeral',
-   ephemeral: true
-})
-```
-
-##### 3️⃣ External Ad Reply
+// will use the given state to connect
+// so if valid credentials are available -- it'll connect without QR
+const sock = makeWASocket({ auth: state })
 
-> [!NOTE]
-Add an ad thumbnail to messages (may not be displayed on some WhatsApp versions).
-
-```javascript
-sock.sendMessage(jid, {
-   text: '📰 External Ad Reply',
-   externalAdReply: {
-      title: '📝 Did you know?',
-      body: '❓ I dont know',
-      thumbnail: fs.readFileSync('./path/to/image.jpg'), // --- Must in buffer format
-      largeThumbnail: false, // --- Or true for bigger thumbnail
-      url: 'https://www.npmjs.com/package/baileys' // --- Optional, used for WhatsApp internal thumbnail caching and direct URL
-   }
-}, {
-   quoted: message
-})
+// this will be called as soon as the credentials are updated
+sock.ev.on('creds.update', saveCreds)
 ```
 
-##### 4️⃣ Group Status
+> [!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.
 
 > [!NOTE]
-It only works in group chat (`@g.us`)
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👥 Group Status!',
-   groupStatus: true
-})
-```
-
-##### 5️⃣ Raw
-
-```javascript
-sock.sendMessage(jid, {
-   extendedTextMessage: {
-      text: '📃 Built manually from scratch using the raw WhatsApp proto structure',
-      contextInfo: {
-         externalAdReply: {
-            title: 'violetics',
-            thumbnail: fs.readFileSync('./path/to/image.jpg'),
-            sourceApp: 'whatsapp',
-            showAdAttribution: true,
-            mediaType: 1
-         }
-      }
-   },
-   raw: true
-}, {
-   quoted: message
-})
-```
+> 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.
 
-##### 6️⃣ View Once
+## Handling Events
 
-> [!NOTE]
-Wrap message into `viewOnceMessage`
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👁️ View Once',
-   viewOnce: true
-})
-```
+- 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.
 
-##### 7️⃣ View Once V2
+> [!IMPORTANT]
+> **The events are [these](https://baileys.whiskeysockets.io/types/BaileysEventMap.html)**, it's important you see all events
 
-> [!NOTE]
-Wrap message into `viewOnceMessageV2`
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👁️ View Once V2',
-   viewOnceV2: true
+You can listen to these events like this:
+```ts
+const sock = makeWASocket()
+sock.ev.on('messages.upsert', ({ messages }) => {
+    console.log('got messages', messages)
 })
 ```
 
-##### 8️⃣ View Once V2 Extension
+### Example to Start
 
 > [!NOTE]
-Wrap message into `viewOnceMessageV2Extension`
-
-```javascript
-sock.sendMessage(jid, {
-   image: {
-      url: './path/to/image.jpg'
-   },
-   caption: '👁️ View Once V2 Extension',
-   viewOnceV2Extension: true
-})
-```
-
-#### 🧰 Additional Contents
-
-##### 🏷️ Find User ID (JID|PN/LID)
+> This example includes basic auth storage too
 
 > [!NOTE]
-The ID must contain numbers only (no +, (), or -) and must include the country code with WhatsApp ID format.
+> For reliable serialization of the authentication state, especially when storing as JSON, always use the BufferJSON utility.
 
-```javascript
-// --- PN (Phone Number)
-const phoneNumber = '6281111111111@s.whatsapp.net'
-
-const ids = await sock.findUserId(phoneNumber)
-
-console.log('🏷️ Got user ID', ':', ids)
-
-// --- LID (Local Identifier)
-const lid = '43411111111111@lid'
-
-const ids = await sock.findUserId(lid)
-
-console.log('🏷️ Got user ID', ':', ids)
+```ts
+import makeWASocket, { DisconnectReason, useMultiFileAuthState } from '@blckrose/baileys'
+import { Boom } from '@hapi/boom'
 
-// --- Output
-// {
-//    phoneNumber: '6281111111111@s.whatsapp.net',
-//    lid: '43411111111111@lid'
-// }
-// --- Output when failed
-// {
-//    phoneNumber: '6281111111111@s.whatsapp.net',
-//    lid: 'id-not-found'
-// }
-// --- Same output shape regardless of input type
+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('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)
+            // reconnect if not logged out
+            if(shouldReconnect) {
+                connectToWhatsApp()
+            }
+        } else if(connection === 'open') {
+            console.log('opened connection')
+        }
+    })
+    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()
 ```
 
-##### 🔑 Request Custom Pairing Code
-
-> [!NOTE]
-The phone number must contain numbers only (no +, (), or -) and must include the country code.
-
-```javascript
-const phoneNumber = '6281111111111'
-const customPairingCode = 'STARFALL'
+### For example if you use useSingleFileAuthState and useMongoFileAuthState
+```ts
+import makeWASocket, { useSingleFileAuthState, useMongoFileAuthState } from '@blckrose/baileys'
+
+// Single Auth
+const { state, saveState } = await useSingleFileAuthState('./auth_info_baileys.json')
+const sock = makeWASocket({
+        auth: state,
+        printQRInTerminal: true
+    })
+
+sock.ev.on('creds.update', saveState)
+
+// Mongo Auth
+import { MongoClient } from "mongodb"
+
+const connectAuth = async() => {
+    global.client = new MongoClient('mongoURL')
+    global.client.connect(err => {
+        if (err) {
+            console.warn("Warning: MongoDB link is invalid or cannot be connected.")
+        } else {
+            console.log('Successfully Connected To MongoDB Server')
+        }
+    })
+  await client.connect()
+  const collection = client.db("@blckrose").collection("sessions")
+  return collection
+}
 
-await sock.requestPairingCode(phoneNumber, customPairingCode)
+const Authentication = await connectAuth()
+const { state, saveCreds } = await useMongoFileAuthState(Authentication)
+const sock = makeWASocket({
+        auth: state,
+        printQRInTerminal: true
+    })
 
-console.log('🔗 Pairing code', ':', customPairingCode)
+sock.ev.on('creds.update', saveCreds)
 ```
 
-##### 📣 Newsletter Management
-
-```javascript
-// --- Create a new one
-sock.newsletterCreate('violetics')
-
-// --- Get info
-sock.newsletterMetadata('1231111111111@newsletter')
-
-// --- Demote admin
-sock.newsletterDemote('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
-
-// --- Change owner
-sock.newsletterChangeOwner('1231111111111@newsletter', '6281111111111@s.whatsapp.net')
-
-// --- Change name
-sock.newsletterUpdateName('1231111111111@newsletter', '📦 violetics')
+> [!IMPORTANT]
+> In `messages.upsert` it's recommended to use a loop like `for (const message of event.messages)` to handle all messages in array
 
-// --- Change description
-sock.newsletterUpdateDescription('1231111111111@newsletter', '📣 Fresh updates weekly')
+### Decrypt Poll Votes
 
-// --- Change photo
-sock.newsletterUpdatePicture('1231111111111@newsletter', {
-   url: 'path/to/image.jpg'
+- 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,
+                    })
+                )
+            }
+        }
+    }
 })
-
-// --- Remove photo
-sock.newsletterRemovePicture('1231111111111@newsletter')
-
-// --- React to a message
-sock.newsletterReactMessage('1231111111111@newsletter', '100', '💛')
-
-// --- Get all subscribed newsletters
-const newsletters = await sock.newsletterSubscribed()
-
-console.dir(newsletters, { depth: null })
 ```
 
-##### 👥 Group Management
-
-```javascript
-// --- Create a new one and add participants using their JIDs
-sock.groupCreate('violetics', ['628123456789@s.whatsapp.net'])
-
-// --- Get info
-sock.groupMetadata(jid)
+- `getMessage` is a [store](#implementing-a-data-store) implementation (in your end)
 
-// --- Get invite code
-sock.groupInviteCode(jid)
+### Summary of Events on First Connection
 
-// --- Revoke invite link
-sock.groupRevokeInvite(jid)
+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`
 
-// --- Leave group
-sock.groupLeave(jid)
+## Implementing a Data Store
 
-// --- Add participants
-sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'add')
+- 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.
 
-// --- Remove participants
-sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'remove')
-
-// --- Promote to admin
-sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'promote')
+> [!IMPORTANT]
+> I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
 
-// --- Demote from admin
-sock.groupParticipantsUpdate(jid, ['628123456789@s.whatsapp.net'], 'demote')
+It can be used as follows:
 
-// --- Change name
-sock.groupUpdateSubject(jid, '📦 violetics')
+```ts
+import makeWASocket, { makeInMemoryStore } from '@blckrose/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)
 
-// --- Change description
-sock.groupUpdateDescription(jid, 'Updated description')
+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)
 
-// --- Change photo
-sock.updateProfilePicture(jid, {
-   url: 'path/to/image.jpg'
+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())
 })
 
-// --- Remove photo
-sock.removeProfilePicture(jid)
-
-// --- Set group as admin only for chatting
-sock.groupSettingUpdate(jid, 'announcement')
-
-// --- Set group as open to all for chatting
-sock.groupSettingUpdate(jid, 'not_announcement')
-
-// --- Set admin only can edit group info
-sock.groupSettingUpdate(jid, 'locked')
-
-// --- Set all participants can edit group info
-sock.groupSettingUpdate(jid, 'unlocked')
-
-// --- Set admin only can add participants
-sock.groupMemberAddMode(jid, 'admin_add')
-
-// --- Set all participants can add participants
-sock.groupMemberAddMode(jid, 'all_member_add')
-
-// --- Enable or disable temporary messages with seconds format
-sock.groupToggleEphemeral(jid, 86400)
-
-// --- Disable temporary messages
-sock.groupToggleEphemeral(jid, 0)
-
-// --- Enable or disable membership approval mode
-sock.groupJoinApprovalMode(jid, 'on')
-sock.groupJoinApprovalMode(jid, 'off')
-
-// --- Get all groups metadata
-const groups = await sock.groupFetchAllParticipating()
+sock.ev.on('contacts.upsert', () => {
+    console.log('got contacts', Object.values(store.contacts))
+})
 
-console.dir(groups, { depth: null })
+```
 
-// --- Get pending invites
-const invites = await sock.groupGetInviteInfo(code)
+The store also provides some simple functions such as `loadMessages` that utilize the store to speed up data retrieval.
 
-console.dir(invites, { depth: null })
+## Whatsapp IDs Explain
 
-// --- Accept group invite
-sock.groupAcceptInvite(code)
+- `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`.
 
-// --- Get group info from link
-const group = await sock.groupGetInviteInfo('https://chat.whatsapp.com/ABC123')
+## Utility Functions
 
-console.log('👥 Got group info from link', ':', group)
+### Resize Image
+```ts
+// Resize an image (Buffer, URL, or stream) to given dimensions
+const resized = await sock.resize('https://example.com/image.jpg', 320, 320)
+// or
+const resized = await sock.resize(buffer, 320, 320)
 ```
 
-## 📦 Fork Base
-> [!NOTE]
-This fork is based on [Baileys (GitHub)](https://github.com/WhiskeySockets/Baileys)
+- `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
+- `makeNewsletterUtils`, helper lengkap untuk kirim ke newsletter/channel
+- `resolveJid`, resolve LID / participant ID ke JID @s.whatsapp.net
+- `resolveJids`, resolve banyak JID sekaligus
 
-## 📣 Credits
-> [!IMPORTANT]
-This fork uses Protocol Buffer definitions maintained by [WPP Connect](https://github.com/wppconnect-team) via [`wa-proto`](https://github.com/wppconnect-team/wa-proto)
-> 
-> All rights belong to the original Baileys maintainers and contributors:
-> - [WhiskeySockets/Baileys](https://github.com/WhiskeySockets/Baileys)
-> - [purpshell](https://github.com/purpshell)
-> - [jlucaso1](https://github.com/jlucaso1)
-> - [adiwajshing](https://github.com/adiwajshing)
+---
+
+<p align="center">Made with ⬡ by <a href="https://github.com/blckrose">@blckrose</a></p>