@vanzxy/baileys 1.6.4 → 1.6.6

package/README.md

@@ -1,43 +1,95 @@
-# 🍃 @vanzxy/baileys
+<div align="center" id="top">
 
-> Next-generation Baileys fork by **Vanzxy**.
-> Built for modern WhatsApp bot development with extended interactive messages, native flow enhancements, status tools, and quality-of-life improvements.
+# 🍃 @vanzxy/baileys
 
-![Version](https://img.shields.io/npm/v/@vanzxy/baileys)
-![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen)
-![ESM](https://img.shields.io/badge/module-ESM-blue)
+### *"Next-generation Baileys fork — built different, built by Vanzxy."*
+
+Extended interactive messages • native flow enhancements • status tools • quality-of-life fixes — built on top of WhiskeySockets/Baileys.
+
+<p>
+<a href="https://www.npmjs.com/package/@vanzxy/baileys" target="_blank"><img src="https://img.shields.io/npm/v/@vanzxy/baileys?color=2ecc71&label=npm&style=for-the-badge" alt="npm version"/></a>
+<a href="https://www.npmjs.com/package/@vanzxy/baileys" target="_blank"><img src="https://img.shields.io/npm/dt/@vanzxy/baileys?color=3498db&style=for-the-badge" alt="npm downloads"/></a>
+<a href="https://github.com/vanzxysenpai/vanzxybaileys/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/vanzxysenpai/vanzxybaileys?color=f1c40f&style=for-the-badge" alt="GitHub stars"/></a>
+<a href="https://github.com/vanzxysenpai/vanzxybaileys/issues" target="_blank"><img src="https://img.shields.io/github/issues/vanzxysenpai/vanzxybaileys?color=e74c3c&style=for-the-badge" alt="GitHub issues"/></a>
+</p>
+<p>
+<img src="https://img.shields.io/github/last-commit/vanzxysenpai/vanzxybaileys?color=9b59b6&style=flat-square" alt="Last commit"/>
+<img src="https://img.shields.io/github/commit-activity/m/vanzxysenpai/vanzxybaileys?color=1abc9c&style=flat-square" alt="Commit activity"/>
+<img src="https://img.shields.io/github/languages/code-size/vanzxysenpai/vanzxybaileys?color=e67e22&style=flat-square" alt="Code size"/>
+<img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen?style=flat-square" alt="Node >=20"/>
+<img src="https://img.shields.io/badge/module-ESM-blue?style=flat-square" alt="ESM"/>
+<img src="https://img.shields.io/badge/license-see%20NOTICE-lightgrey?style=flat-square" alt="License"/>
+</p>
+
+<p>
+<a href="#-why-vanzxybaileys">About</a> &#xa0;|&#xa0;
+<a href="#-built-with">Tech Stack</a> &#xa0;|&#xa0;
+<a href="#-features">Features</a> &#xa0;|&#xa0;
+<a href="#-exclusive-vanzxy-enhancements">Enhancements</a> &#xa0;|&#xa0;
+<a href="#-installation">Installation</a> &#xa0;|&#xa0;
+<a href="#-usage-examples">Examples</a> &#xa0;|&#xa0;
+<a href="#-fork-lineage">Fork Lineage</a> &#xa0;|&#xa0;
+<a href="#-credits">Credits</a> &#xa0;|&#xa0;
+<a href="#-maintainer">Maintainer</a>
+</p>
+
+</div>
 
 ---
 
-# ✨ Why @vanzxy/baileys?
+## ✨ Why @vanzxy/baileys?
 
 This fork focuses on:
 
-- 🚀 Better developer experience
-- 🎯 Extended native flow support
-- 📢 Advanced status & broadcast features
-- 🧩 More interactive message types
-- ⚡ Cleaner implementation for bot developers
-- 🔧 Extra utilities not available in standard Baileys forks
+| | |
+|---|---|
+| 🚀 | Better developer experience |
+| 🎯 | Extended native flow support |
+| 📢 | Advanced status & broadcast features |
+| 🧩 | More interactive message types |
+| ⚡ | Cleaner implementation for bot developers |
+| 🔧 | Extra utilities not available in standard Baileys forks |
+
+---
+
+## 🧰 Built With
+
+<p>
+<img src="https://img.shields.io/badge/node.js-%2343853D.svg?style=for-the-badge&logo=node.js&logoColor=white" alt="Node.js"/>
+<img src="https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E" alt="JavaScript"/>
+<img src="https://img.shields.io/badge/esm-%23F7DF1E.svg?style=for-the-badge&logo=javascript&logoColor=black" alt="ESM"/>
+<img src="https://img.shields.io/badge/websocket-%23000000.svg?style=for-the-badge&logo=socket.io&logoColor=white" alt="WebSocket"/>
+<img src="https://img.shields.io/badge/signal%20protocol-%233A76F0.svg?style=for-the-badge&logo=signal&logoColor=white" alt="Signal Protocol"/>
+<img src="https://img.shields.io/badge/protobuf-%23345?style=for-the-badge&logo=google&logoColor=white" alt="Protobuf"/>
+<img src="https://img.shields.io/badge/npm-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white" alt="npm"/>
+</p>
 
 ---
 
-# 🔥 Features
+## 🔥 Features
+
+<table>
+<tr>
+<th align="center">💬 Interactive Messages</th>
+<th align="center">🛒 Commerce & Business</th>
+<th align="center">🧩 Utility Features</th>
+</tr>
+<tr>
+<td valign="top">
 
-## Interactive Messages
 - Native Flow
 - Buttons
 - Lists
 - Carousel Messages
 - Rich Response Messages
-- CTA Buttons
-- Reply Buttons
-- URL Buttons
+- CTA / Reply / URL Buttons
 - Call Buttons
 - OTP Buttons
 - Authentication Buttons
 
-## Commerce & Business
+</td>
+<td valign="top">
+
 - Catalog Message
 - Order Details
 - Order Status
@@ -48,7 +100,9 @@ This fork focuses on:
 - Reorder
 - Cancel Order
 
-## Utility Features
+</td>
+<td valign="top">
+
 - Group Status Support
 - Mention All
 - Lottie Sticker Support
@@ -58,43 +112,66 @@ This fork focuses on:
 - Rich Formatting
 - Code Highlighting
 
+</td>
+</tr>
+</table>
+
 ---
 
-# 🌟 Exclusive Vanzxy Enhancements
+## 🌟 Exclusive Vanzxy Enhancements
 
 ### Audio Group Status Fix
 Audio status uses a more compatible implementation to avoid unsupported-version errors on older WhatsApp clients.
 
 ### Native Flow Expansion
-Additional supported button types:
 
+<table>
+<tr>
+<td valign="top" width="33%">
+
+**Buttons & Actions**
 - cta_reminder
 - cta_cancel_reminder
-- address_message
-- send_location
-- catalog_message
-- mpm
 - otp_button
 - authentication_button
 - call_button
 - url_button
 - reply_button
+- voice_call
+- video_call_button
+
+</td>
+<td valign="top" width="33%">
+
+**Commerce Flow**
+- catalog_message
+- mpm
 - card_message
 - order_details
 - order_status
 - review_and_pay
 - payment_status
 - payment_method
+
+</td>
+<td valign="top" width="33%">
+
+**Navigation & Misc**
+- address_message
+- send_location
 - track_order
 - reorder
 - cancel_order
 - clear_chat
 - navigateToScreen
 - flow_action
-- voice_call
-- video_call_button
+
+</td>
+</tr>
+</table>
 
 ### System Notification Filter
+
 Messages include:
 
 ```js
@@ -109,21 +186,21 @@ Useful for filtering:
 
 ---
 
-# 📦 Installation
+## 📦 Installation
 
 ```bash
 npm install @vanzxy/baileys
 ```
 
-GitHub:
+Directly from GitHub:
 
 ```bash
-npm install github:vanzxy/baileys
+npm install github:vanzxysenpai/vanzxybaileys
 ```
 
 ---
 
-# 🚀 Quick Start
+## 🚀 Quick Start
 
 ```js
 import { makeWASocket } from '@vanzxy/baileys'
@@ -131,51 +208,126 @@ import { makeWASocket } from '@vanzxy/baileys'
 const sock = makeWASocket({
     printQRInTerminal: true
 })
+
+sock.ev.on('connection.update', (update) => {
+    const { connection } = update
+    if (connection === 'open') console.log('🍃 Connected!')
+})
+```
+
+---
+
+## 💡 Usage Examples
+
+### Buttons
+```js
+import { Button } from '@vanzxy/baileys'
+
+await new Button(sock)
+    .setTitle('Promo Spesial')
+    .setBody('Diskon 20% cuma hari ini')
+    .setFooter('@vanzxy/baileys')
+    .addReply('Klaim Sekarang', 'claim_promo')
+    .addUrl('Lihat Katalog', 'https://example.com/catalog')
+    .send(jid)
+```
+
+### AIRich (rich response cards)
+```js
+import { AIRich } from '@vanzxy/baileys'
+
+await new AIRich(sock)
+    .addHeading('Ringkasan Order')
+    .addText('Pesananmu sedang diproses.')
+    .addTable(['Item', 'Qty'], [['Kopi Susu', '2']])
+    .addSuggest('Lacak Order')
+    .send(jid)
+```
+
+### Carousel
+```js
+import { Carousel } from '@vanzxy/baileys'
+
+const carousel = new Carousel()
+    .addCard({ title: 'Produk A', image: 'https://example.com/a.jpg' })
+    .addCard({ title: 'Produk B', image: 'https://example.com/b.jpg' })
+
+await sock.relayMessage(jid, carousel.build(), {})
 ```
 
 ---
 
-# 🛠 Recommended Environment
+## 🛠 Recommended Environment
 
-- Node.js 18+
-- ESM Project
-- Latest WhatsApp Multi Device
+| Requirement | Version |
+|---|---|
+| Node.js | 18+ |
+| Module system | ESM |
+| WhatsApp | Latest Multi Device |
 
 ---
 
-# 📚 Fork Lineage
+## 📚 Fork Lineage
 
+```
 @vanzxy/baileys
 └── @itsliaaa/baileys
     └── WhiskeySockets/Baileys
+```
 
 Respect to all original maintainers and contributors.
 
 ---
 
-# 👑 Maintainer
+## 🙏 Credits
 
-**Vanzxy**
+- **Nixel** (with contributions from **Ahmad tumbuh kembang**) — base implementation of the `MessageBuilder` (AIRich / Button / Carousel / Toolkit), originally "NIXCODE — Advanced WhatsApp Interactive Message Builder"
+- **vinikjkkj** ([zapo](https://github.com/vinikjkkj/zapo)) — button/list addon-kind resolution logic
+- **QueenAnya** (`@queenanya/baileys`) — interactive/native-flow button send layer
+- **WhiskeySockets/Baileys** & **@itsliaaa/baileys** — upstream base
 
-GitHub:
-https://github.com/vanzxy
+Full details and license terms per component: see [`NOTICE.md`](./NOTICE.md).
 
-Package:
-@vanzxy/baileys
+---
+
+## 📈 Repo Activity
+
+<div align="center">
+
+![Vanzxy's GitHub stats](https://github-readme-stats.vercel.app/api?username=vanzxysenpai&show_icons=true&theme=radical&hide_border=true)
+
+</div>
+
+> Powered by [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) — updates automatically, no setup needed on this repo.
+
+<details>
+<summary>🎮 Want a 3D contribution graph on your own profile?</summary>
+
+<br/>
+
+That's a separate, opt-in GitHub Action for your **profile** repo (`username/username`), not something this package ships — see [github-profile-3d-contrib](https://github.com/yoshi389111/github-profile-3d-contrib) if you want to set it up for yourself.
+
+</details>
 
 ---
 
-# ⚠️ Disclaimer
+## 👑 Maintainer
 
-This project is an independent fork.
-Use responsibly and follow WhatsApp Terms of Service.
+**Vanzxy**
+
+- GitHub: [github.com/vanzxysenpai](https://github.com/vanzxysenpai)
+- Package: [`@vanzxy/baileys`](https://www.npmjs.com/package/@vanzxy/baileys)
 
 ---
 
-Made with 🍃 by Vanzxy
+## ⚠️ Disclaimer
+
+This project is an independent fork.
+Use responsibly and follow WhatsApp Terms of Service.
 
+---
 
-## V4 Patch Notes
+## 📝 V4 Patch Notes
 
 - Kept the existing Vanzxy custom MessageBuilder classes and AIRich implementation intact.
 - Added `whatsapp-rust-bridge@0.5.5` as a runtime dependency. The library already dynamically imports this module for LT Hash/app-state and crypto helpers; declaring it prevents accidental missing-module fallbacks in normal installations.
@@ -183,3 +335,15 @@ Made with 🍃 by Vanzxy
 - ESM-only package metadata is preserved; no CommonJS build is included.
 
 Reference audit: the supplied Ourin, Elaina, ItsLiaaa, and Noxleyss packages were compared before this patch. Their broader core changes were not copied wholesale because the current Vanzxy tree already contains additional LID, retry, media, interactive, and AIRich fixes that would risk regressions if replaced.
+
+---
+
+<div align="center">
+
+Made with 🍃 by **Vanzxy**
+
+Thanks for stopping by! ✌️
+
+<a href="#top">⬆️ Back to top</a>
+
+</div>

package/WAProto/CHANGELOG-proto-upgrade.md

@@ -0,0 +1,111 @@
+# WAProto upgrade — progress checkpoint
+
+Base: @vanzxy/baileys 1.6.6 WAProto (already the most complete of the 4 sources compared:
+716 types vs wa-proto-main 603 / Baileys-5 570 / raphaelvserafim 569).
+Diffed field-by-field against wa-proto-main (WA 2.3000.1046350168, newest available) to find real gaps.
+
+## ✅ Applied in this checkpoint (session 1)
+- `AIRichResponseMessage.originalRecipientMetadata` (field 5, type `AIRichResponseUnifiedResponse`)
+  — direct "airich" gap, full encode/decode/verify/fromObject/toObject wired.
+- `BotMetadata.responseStoppedByUser` (field 44, bool) — full round-trip wired.
+
+## ✅ Applied in this checkpoint (session 2 — pending queue cleared)
+- `Message.VideoMessage.dashManifestUrl` (field 33, string) — full encode/decode/fromObject/toObject
+  wired alongside the existing `videoSourceType` enum field (30/31).
+- `ContextInfo.experienceIds` (field 82, repeated packed uint32) — wired using the same packed-varint
+  pattern as `ADVKeyIndexList.validIndexes` (fork/ldelim on encode, packed-or-single fallback on decode).
+- `DeviceCapabilities.BusinessBroadcast.proCompanionSupportEnabled` (field 6, bool) — full round-trip
+  wired next to the existing `recipientLimit` field.
+- `Message.newsletterScheduledMessage` (field 132, reuses existing `FutureProofMessage` type) — wired
+  next to `botPlatformRegistrationSuccessMessage` (field 131).
+- 3 new nested types under `SyncActionValue`, each a single-bool message built from scratch off the
+  `StarAction`/`CtwaMessageReceivedAction` template, then wired into the parent message at fields 94–96:
+  - `SharedDeviceAllowlistAction` (bool `allowed`) — field 94
+  - `ContactManagerMetadataAction` (bool `isHidden`) — field 95
+  - `BusinessFolderActivationAction` (bool `activated`) — field 96
+
+**Pending queue is now empty** — every gap identified in the wa-proto-main diff has been applied.
+
+## Already confirmed complete, no changes needed
+Buttons (ButtonsMessage, TemplateButton, HydratedTemplateButton, ButtonsResponseMessage),
+InteractiveMessage + NativeFlowMessage (incl. bloksWidget/A2UI), TemplateMessage,
+ExtendedContentMessage (CTA buttons, XMA), ListMessage, all AIRichResponse* submessage types,
+MessageContextInfo — all field-complete vs every reference source checked.
+
+## Validation
+- `node --check WAProto/index.js` — syntax clean after all edits.
+- Functional round-trip (encode → decode → toObject) verified for all 5 session-2 fields, plus
+  regression checks confirming neighboring pre-existing fields (`videoSourceType`, `aiProvenance`,
+  `posterStatusId`, `botPlatformRegistrationSuccessMessage`, `ctwaMessageReceivedAction`, and
+  `BusinessBroadcast`'s other bool fields) still encode/decode correctly after the inserts.
+  Run against a hand-written wire-format shim (varint/string/bool/length-delimited), not the real
+  `protobufjs` package, since this sandbox has no network/registry access to install it — the shim
+  implements the exact subset of the protobufjs runtime API (`Writer`/`Reader`/`util`) that the
+  generated code calls, so it validates wire-format correctness but not protobufjs's own internals.
+  **Recommend re-running a quick smoke test against the real `protobufjs` package once installed in
+  your environment before shipping to production**, though the generated code path itself is
+  mechanically identical to every other field in this file.
+
+index.js syntax-validated with `node --check` after this checkpoint's edits.
+
+## Session 3 — full Button/AIRich/A2UI field audit (no gaps found)
+Ran an exhaustive field-by-field diff of every Button-, AIRich-, and Interactive/NativeFlow (A2UI)
+-related message against `wa-proto-main` (the newest reference in this bundle) and cross-checked
+against `Baileys-5`:
+
+- **Buttons**: `ButtonsMessage` (+ nested `Button`/`ButtonText`/`NativeFlowInfo`), `ButtonsResponseMessage`,
+  `TemplateButton`/`HydratedTemplateButton` (+ `QuickReplyButton`/`URLButton`/`CallButton` variants) —
+  field-complete, 1:1 match.
+- **AIRich**: all 12 top-level `AIRichResponse*` messages (`Message`, `SubMessage`, `CodeMetadata`,
+  `ContentItemsMetadata`, `DynamicMetadata`, `GridImageMetadata`, `ImageURL`, `InlineImageMetadata`,
+  `LatexMetadata`, `MapMetadata`, `TableMetadata`, `UnifiedResponse`) — field-complete, including the
+  `originalRecipientMetadata` field added in session 1.
+- **A2UI / Interactive**: `InteractiveMessage` (+ `BloksWidget`, `Header` incl. its own nested
+  `bloksWidget` field 10, `Footer`, `Body`, `CarouselMessage`, `CollectionMessage`, `NativeFlowMessage`
+  + `NativeFlowButton`, `ShopMessage`), `InteractiveResponseMessage` (+ `Body`, `NativeFlowResponseMessage`),
+  `InteractiveAnnotation` — field-complete.
+- `Baileys-5` (older/less complete source per this file's header) contributes nothing extra relevant —
+  its only two extra top-level messages (`LIDMigrationMapping`/`LIDMigrationMappingSyncPayload`) are the
+  deprecated pre-migration types already superseded and handled in session 26-08-26.
+
+**Conclusion: the WAProto layer for Button/AIRich/A2UI is fully caught up — no further proto-level
+patches identified.** Next stage for these features is JS-level (`lib/Utils/MessageBuilder.js`,
+`lib/Utils/A2UI.js`) — wiring the newly-added fields (`dashManifestUrl`, `experienceIds`,
+`newsletterScheduledMessage`, etc.) into builder APIs where relevant, not further WAProto edits.
+
+## Session 4 — JS-level integration check
+Checked whether `MessageBuilder.js`/`A2UI.js` need whitelist updates to expose the new proto fields:
+
+- `dashManifestUrl` (VideoMessage) and `experienceIds` (ContextInfo): no gap. `setContextInfo(obj)`
+  merges the object verbatim (no field whitelist), and video-message construction elsewhere
+  (`sendPairedMedia`) spreads a plain object straight into `relayMessage` — any proto-valid field,
+  including these two, is already usable with zero code changes.
+- `DeviceCapabilities.proCompanionSupportEnabled`: no gap, but not because it's already wired —
+  `DeviceCapabilities` isn't referenced anywhere in `lib/` (not part of this fork's companion
+  registration flow), so there's nothing to update.
+- **Real gap found**: `lib/Utils/messages.js`'s `getFutureProofMessage()` — the whitelist function
+  `normalizeMessageContent()` uses to unwrap `FutureProofMessage`-typed fields — was missing
+  `botPlatformRegistrationSuccessMessage` (field 131, pre-existing) and `newsletterScheduledMessage`
+  (field 132, added this session). Both would have silently failed to unwrap: a message using either
+  wrapper would pass through `normalizeMessageContent()` unchanged instead of resolving to its inner
+  `message`. **Fixed** — both added to the whitelist. Syntax-checked (`node --check`) and functionally
+  verified both fields now correctly unwrap.
+
+Bumped package version 1.6.6 → 1.6.7.
+
+## Session 5 — resolved the standing "verify against live traffic" TODO
+`lib/Utils/process-message.js`'s `decodeLidMigrationMappingSyncPayload()` (the hand-written decoder
+from session 26-08-26, flagged since then as needing live-traffic verification) has now been
+cross-checked against an independent source: `Baileys-5`'s bundled `WAProto.proto`, an older compiled
+schema dump from before Meta stopped publishing this type's inner structure. It's an exact
+field-for-field match:
+- `LIDMigrationMappingSyncPayload { repeated pnToLidMappings = 1; optional chatDbMigrationTimestamp = 2 (uint64); }`
+- `LIDMigrationMapping { pn = 1; assignedLid = 2; latestLid = 3; all uint64 }`
+
+This isn't literal live WhatsApp traffic, but it is a real independent extraction agreeing byte-for-byte
+with the from-scratch guess — meaningfully stronger evidence than "seems plausible," since an
+independent tool derived the same field layout separately. Also ran a functional round-trip test
+(hand-encoded a payload matching this exact structure, fed it through the actual decoder function) —
+PASS. Updated the code comment to reflect this and removed the "TODO: verify" marker; the residual risk
+(Meta silently changing the inner layout with zero signal) is unchanged and can only be closed by
+actual live traffic, but the decoder is no longer running on-guess. Bumped package version 1.6.7 → 1.6.8.