@itsliaaa/baileys 0.1.33 → 0.2.0

package/README.md

@@ -34,30 +34,8 @@ This fork designed for production use with a focus on clarity and safety:
 - 🚫 No obfuscation. Easy to read and audit.
 - 🚫 No auto-follow channel (newsletter) behavior.
 
-> [!IMPORTANT]
-Hi everyone,
->
-> I want to share something that’s been weighing on me a bit.
->
-> Recently, I found a few packages published on npm that are essentially just **renamed** versions of a fork I personally worked on:
->
-> - ~[RESOLVED]~
-> - ~[RESOLVED]~
-> - ~[RESOLVED]~
-> - [@zackmans](https://www.npmjs.com/package/@zackmans/baileys) **[STEALER]**
-> - [@dnuzi](https://www.npmjs.com/package/@dnuzi/baileys) **[STEALER]**
-> - ["Update rich.js"](https://github.com/gcamerator/mbaileys/commits/main/) **[STEALER]**
->
-> To be clear, I’m **not** the original maintainer of Baileys all respect goes to the amazing work behind [@whiskeysockets/baileys](https://github.com/WhiskeySockets/Baileys). I only created and maintained my own fork ([@itsliaaa/baileys](https://www.npmjs.com/package/@itsliaaa/baileys)) where I spent a **lot** of time improving and adapting things on my own.
->
-> **It’s honestly a bit disheartening to see my fork being republished under different names without any acknowledgment or credit.** I put a lot of late nights and personal effort into it, so seeing it circulate like this feels… quietly painful.
->
-> If you come across these packages, I’d really appreciate it if you could take a closer look and, if appropriate, **help report them to npm.** More than anything, I just hope for a bit of fairness and proper recognition for the work that people put in.
->
-> Thank you for taking the time to read this 🤍
-
 > [!NOTE]
-📄 This project is maintained with limited scope and is not intended to replace upstream Baileys.
+> 📄 This project is maintained with limited scope and is not intended to replace upstream Baileys.
 >
 > 😞 And, really sorry for my bad english.
 
@@ -90,10 +68,15 @@ Hi everyone,
    - 🔒 [`secureMetaServiceLabel`](#6%EF%B8%8F⃣-secure-meta-service-label) - Secure meta service label on message **[NEW]**
    - 📄 [`raw`](#5%EF%B8%8F⃣-raw) - Build your message manually **(DO NOT USE FOR EXPLOITATION)**
 
-### 📋 Index
+### 📋 Table of Contents
+- [✨ Highlights](#-highlights)
+- [🛠️ Internal Adjustments](#%EF%B8%8F-internal-adjustments)
+- [📨 Messages Handling & Compatibility](#-highlights)
+- [🧩 Additional Message Options](#-additional-message-options)
 - [📥 Installation](#-installation)
    - [🧩 Import (ESM & CJS)](#-import-esm--cjs)
 - [🌐 Connect to WhatsApp (Quick Step)](#-connect-to-whatsapp-quick-step)
+   - [🔐 Auth State](#-auth-state)
 - [🗄️ Implementing Data Store](#%EF%B8%8F-implementing-data-store)
 - [🪪 WhatsApp IDs Explain](#-whatsapp-ids-explain)
 - [✉️ Sending Messages](#%EF%B8%8F-sending-messages)
@@ -154,6 +137,7 @@ Hi everyone,
    - [👤 Profile Management](#-profile-management)
    - [🔐 Privacy Management](#-privacy-management)
    - [📡 Events](#-events)
+- [🚀 Try the Bot](#-try-the-bot)
 - [📦 Fork Base](#-fork-base)
 - [📣 Credits](#-credits)
 
@@ -249,10 +233,15 @@ const connectToWhatsApp = async () => {
 connectToWhatsApp()
 ```
 
+#### 🔐 Auth State
+
+> [!NOTE]
+> You can use the experimental `useSingleFileAuthState` as an alternative to `useMultiFileAuthState`. However, `useSingleFileAuthState` already includes an internal caching mechanism, so there is no need to wrap `state.keys` with `makeCacheableSignalKeyStore`.
+
 ### 🗄️ Implementing 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.
+> 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 '@itsliaaa/baileys'
@@ -335,16 +324,68 @@ connectToWhatsApp()
 ### ✉️ Sending Messages
 
 > [!NOTE]
-You can get the `jid` from `message.key.remoteJid` in the first example.
+> You can get the `jid` from `message.key.remoteJid` in the first example.
 
 #### 🔠 Text
 
 ```javascript
+// --- Send a regular text message
 sock.sendMessage(jid, {
    text: '👋🏻 Hello'
 }, {
    quoted: message
 })
+
+// --- Send a text message with a link preview
+const urlA = 'https://www.npmjs.com/package/@itsliaaa/baileys'
+
+sock.sendMessage(jid, {
+   text: urlA + ' 👆🏻 Check it out!',
+   linkPreview: {
+      'matched-text': urlA,
+      title: '🌱 @itsliaaa/baileys',
+      description: 'Underrated Baileys Fork',
+      previewType: 0, // --- Use 1 for video playback in the link preview
+      jpegThumbnail: fs.readFileSync('./path/to/image.jpg')
+   }
+})
+
+// --- Send a text message with a large link preview and favicon
+import { prepareWAMessageMedia } from '@itsliaaa/baileys'
+
+const urlB = 'https://www.npmjs.com/package/@itsliaaa/baileys#readme'
+
+const { imageMessage: image } = await prepareWAMessageMedia({
+   image: {
+      url: './path/to/image.jpg'
+   }
+}, {
+   upload: sock.waUploadToServer,
+   mediaTypeOverride: 'thumbnail-link'
+})
+
+// --- Set the thumbnail display size
+image.height = 720
+image.width = 480
+
+sock.sendMessage(jid, {
+   text: urlB + ' 👆🏻 Check it out!',
+   linkPreview: {
+      'matched-text': urlB,
+      title: '🌱 @itsliaaa/baileys',
+      description: 'Underrated Baileys Fork',
+      previewType: 0,
+      jpegThumbnail: fs.readFileSync('./path/to/image.jpg'),
+      highQualityThumbnail: image,
+      linkPreviewMetadata: {
+         linkMediaDuration: 0, // --- Duration in seconds (for video/audio content)
+         socialMediaPostType: 1, // --- Enum: 0 = NONE, 1 = REEL, 2 = LIVE_VIDEO, 3 = LONG_VIDEO, 4 = SINGLE_IMAGE, 5 = CAROUSEL
+      } // --- Additional metadata for large link preview
+   },
+   favicon: {
+      url: './path/to/tiny-image.jpg'
+   }
+})
 ```
 
 #### 🔔 Mention
@@ -625,10 +666,10 @@ sock.sendMessage(jid, {
 #### ✨ Rich Response
 
 > [!NOTE]
-`richResponse[]` is a representation of [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) inside `richResponseMessage`.
+> `richResponse[]` is a representation of [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) inside `richResponseMessage`.
 
 > [!TIP]
-You can still use the original [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) field directly.
+> You can still use the original [`submessages[]`](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage) field directly.
 > The code example below is just an implementation using a helper, not a required structure.
 
 ```javascript
@@ -664,7 +705,7 @@ sock.sendMessage(jid, {
 ```
 
 > [!TIP]
-You can easily add syntax highlighting by importing `tokenizeCode` directly from Baileys.
+> You can easily add syntax highlighting by importing `tokenizeCode` directly from Baileys.
 
 ```javascript
 import { tokenizeCode } from '@itsliaaa/baileys'
@@ -687,7 +728,7 @@ sock.sendMessage(jid, {
 #### 🧾 Message with Code Block
 
 > [!NOTE]
-This feature already includes a built-in tokenizer.
+> This feature already includes a built-in tokenizer.
 
 ```javascript
 sock.sendMessage(jid, {
@@ -750,7 +791,7 @@ sock.sendMessage([jidA, jidB, jidC], {
 ### 📁 Sending Media Messages
 
 > [!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).
+> 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
 
@@ -852,7 +893,7 @@ sock.sendMessage(jid, {
 #### 📦 Sticker Pack
 
 > [!IMPORTANT]
-If `sharp` or `@napi-rs/image` is not installed, the `cover` and `stickers` must already be in WebP format.
+> If `sharp` or `@napi-rs/image` is not installed, the `cover` and `stickers` must already be in WebP format.
 
 ```javascript
 sock.sendMessage(jid, {
@@ -936,7 +977,7 @@ sock.sendMessage(jid, {
 #### 2️⃣ List
 
 > [!NOTE]
-It only works in private chat (`@s.whatsapp.net`).
+> It only works in private chat (`@s.whatsapp.net`).
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1114,7 +1155,7 @@ sock.sendMessage(jid, {
 #### 2️⃣ Invoice
 
 > [!NOTE]
-Invoice message are not supported yet.
+> Invoice message are not supported yet.
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1150,7 +1191,7 @@ sock.sendMessage(jid, {
 #### 1️⃣ AI Icon
 
 > [!NOTE]
-It only works in private chat (`@s.whatsapp.net`).
+> It only works in private chat (`@s.whatsapp.net`).
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1167,7 +1208,7 @@ sock.sendMessage(jid, {
 #### 2️⃣ Ephemeral
 
 > [!NOTE]
-Wrap message into `ephemeralMessage`
+> Wrap message into `ephemeralMessage`
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1182,7 +1223,7 @@ sock.sendMessage(jid, {
 #### 3️⃣ External Ad Reply
 
 > [!NOTE]
-Add an ad thumbnail to messages (may not be displayed on some WhatsApp versions).
+> Add an ad thumbnail to messages (may not be displayed on some WhatsApp versions).
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1202,7 +1243,7 @@ sock.sendMessage(jid, {
 #### 4️⃣ Group Status
 
 > [!NOTE]
-It only works in group chat (`@g.us`)
+> It only works in group chat (`@g.us`)
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1248,7 +1289,7 @@ sock.sendMessage(jid, {
 #### 7️⃣ View Once
 
 > [!NOTE]
-Wrap message into `viewOnceMessage`
+> Wrap message into `viewOnceMessage`
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1263,7 +1304,7 @@ sock.sendMessage(jid, {
 #### 8️⃣ View Once V2
 
 > [!NOTE]
-Wrap message into `viewOnceMessageV2`
+> Wrap message into `viewOnceMessageV2`
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1278,7 +1319,7 @@ sock.sendMessage(jid, {
 #### 9️⃣ View Once V2 Extension
 
 > [!NOTE]
-Wrap message into `viewOnceMessageV2Extension`
+> Wrap message into `viewOnceMessageV2Extension`
 
 ```javascript
 sock.sendMessage(jid, {
@@ -1321,7 +1362,7 @@ sock.sendMessage(jid, {
 #### 🏷️ Find User ID (JID|PN/LID)
 
 > [!NOTE]
-The ID must contain numbers only (no +, (), or -) and must include the country code with WhatsApp ID format.
+> The ID must contain numbers only (no +, (), or -) and must include the country code with WhatsApp ID format.
 
 ```javascript
 // --- PN (Phone Number)
@@ -1354,7 +1395,7 @@ console.log('🏷️ Got user ID', ':', ids)
 #### 🔑 Request Custom Pairing Code
 
 > [!NOTE]
-The phone number must contain numbers only (no +, (), or -) and must include the country code.
+> The phone number must contain numbers only (no +, (), or -) and must include the country code.
 
 ```javascript
 const phoneNumber = '6281111111111'
@@ -1368,7 +1409,7 @@ console.log('🔗 Pairing code', ':', customPairingCode)
 #### 🖼️ Image Processing
 
 > [!NOTE]
-Automatically use available image processing library: `sharp`, `@napi-rs/image`, or `jimp`
+> Automatically use available image processing library: `sharp`, `@napi-rs/image`, or `jimp`
 
 ```javascript
 import { getImageProcessingLibrary } from '@itsliaaa/baileys'
@@ -1725,19 +1766,29 @@ sock.ev.on('newsletter-settings.update', (update) => {})
 sock.ev.on('settings.update', (update) => {})
 ```
 
-## 📦 Fork Base
-> [!NOTE]
+### 🚀 Try the Bot
+
+A fast, lightweight, and modular WhatsApp bot built with [@itsliaaa/baileys](https://www.npmjs.com/package/@itsliaaa/baileys).
+Perfect for managing groups, moderating chats, and adding fun with quiz games and handy tools.
+
+👉🏻 [@itsliaaa/starseed](https://github.com/itsliaaa/starseed#readme)
+
+### 📦 Fork Base
+
 This fork is based on [Baileys (GitHub)](https://github.com/WhiskeySockets/Baileys)
 
-## 📣 Credits
-> [!IMPORTANT]
-This fork uses Protocol Buffer definitions maintained by [WPP Connect](https://github.com/wppconnect-team) via [`wa-proto`](https://github.com/wppconnect-team/wa-proto)
-> 
-> Full credit goes to the original Baileys maintainers and contributors:
-> - [purpshell](https://github.com/purpshell)
-> - [jlucaso1](https://github.com/jlucaso1)
-> - [adiwajshing](https://github.com/adiwajshing)
->
-> This fork includes additional enhancements and modifications by [Lia Wynn](https://github.com/itsliaaa)
->
-> **Credits are mandatory and must remain unchanged in any form of redistribution or fork.**
+### 📣 Credits
+
+This project utilizes Protocol Buffer definitions maintained by [WPPConnect](https://github.com/wppconnect-team) through the [`wa-proto`](https://github.com/wppconnect-team/wa-proto) repository.
+
+Full credit is attributed to the original maintainers and contributors of Baileys:
+- [purpshell](https://github.com/purpshell)
+- [jlucaso1](https://github.com/jlucaso1)
+- [adiwajshing](https://github.com/adiwajshing)
+
+This fork includes additional enhancements and modifications by [Lia Wynn](https://github.com/itsliaaa)
+
+Special thanks to [itsreimau](https://github.com/itsreimau) for the fix to the `updateBlockStatus` implementation.
+
+> [!CAUTION]
+> ⚠️ **Modification, removal, or misrepresentation of these credits is strictly prohibited. Any redistribution or fork must preserve this section in its original form without exception.**

package/lib/Defaults/index.js

@@ -126,6 +126,8 @@ export const MEDIA_HKDF_KEY_MAPPING = {
     'biz-cover-photo': 'Image'
 };
 export const MEDIA_KEYS = Object.keys(MEDIA_PATH_MAP);
+/** 120s timeout for history sync stall detection, same as WA Web's handleChunkProgress / restartPausedTimer (g = 120) */
+export const HISTORY_SYNC_PAUSED_TIMEOUT_MS = 120_000;
 export const MIN_PREKEY_COUNT = 5;
 export const INITIAL_PREKEY_COUNT = 812;
 export const UPLOAD_TIMEOUT = 30000; // 30 seconds