phantom-baileys 0.0.8 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rajeh Taher/WhiskeySockets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,592 @@
+# 🐳 phantom-baileys
+
+A Phantom-focused fork of [WhiskeySockets/Baileys](https://github.com/WhiskeySockets/Baileys) v7 with additional modifications from the [Ourin-Baileys](https://github.com/LuckyArch/ourin-baileys) lineage. This repo includes deliberate changes for Phantom bot use, such as safer newsletter action handling, removed hidden auto-follow behavior, and custom socket utilities.
+
+This package is published to npm for installation convenience and aliasing, but the source repository contains the active customization work.
+
+[![npm version](https://img.shields.io/npm/v/phantom-baileys?color=CB3837&logo=npm&logoColor=white&style=for-the-badge)](https://www.npmjs.com/package/phantom-baileys)
+[![npm downloads](https://img.shields.io/npm/dm/phantom-baileys?color=CB3837&logo=npm&logoColor=white&style=for-the-badge)](https://www.npmjs.com/package/phantom-baileys)
+[![GitHub](https://img.shields.io/github/stars/kyleee-max/phantom-baileys?color=181717&logo=github&logoColor=white&style=for-the-badge)](https://github.com/kyleee-max/phantom-baileys)
+[![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%3E%3D20.0.0-339933?logo=node.js&logoColor=white&style=for-the-badge)](https://nodejs.org)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8-3178C6?logo=typescript&logoColor=white&style=for-the-badge)](https://typescriptlang.org)
+[![ESM](https://img.shields.io/badge/ESM-only-F7DF1E?logo=javascript&logoColor=black&style=for-the-badge)](#)
+
+---
+
+## What is this fork?
+
+| Item | Description |
+| --- | --- |
+| `phantom-baileys` | Personal fork for Phantom bot features and newsletter utilities |
+| `phantom` | npm alias for easier import in bot projects |
+| `baileys` | Original WhatsApp multi-device library from WhiskeySockets |
+
+This repository is intended for private Phantom development. It is not a plain mirror or redistribution — the code includes custom changes for newsletter safety, socket behavior, and interactive message handling.
+
+**Copyright notice:** Baileys and its underlying protocol code remain the property of their original authors. This fork is licensed under MIT and includes modifications from the Ourin-Baileys lineage.
+
+---
+
+🌾 Deploy fork star /link: [github](https://github.com/what-sapp/Phantom)
+
+---
+
+## ✨ Features
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| 🎛️ **Interactive Messages** | Native flow buttons, lists, menus | ✅ |
+| 🖼️ **Album Messages** | Multi-image/video album support | ✅ |
+| 🤖 **AI Rich Response** | Table, code block, rich text (Meta AI style) [ **NEW** ] | ✅ |
+| 💻 **Code Block** | Syntax-highlighted code with tokenizer | ✅ |
+| 💳 **Payment Messages** | Request payment with sticker/note | ✅ |
+| 🛍️ **Product Messages** | Product catalog with buttons | ✅ |
+| 📅 **Event Messages** | Event creation with RSVP | ✅ |
+| 📊 **Poll Results** | Poll result snapshot messages | ✅ |
+| 📢 **Newsletter** | bulk follow, cekIDSaluran | ✅ |
+| 🔒 **Biz Node Injection** | Automatic business node for non-BA | ✅ |
+| ⚡ **ESM Native** | Pure ES Module output | ✅ |
+| 📖 **TypeScript** | Full type definitions included | ✅ |
+
+---
+
+## 📦 Installation
+
+This package is published to npm for convenience and easier installation, not as a vanilla copy. The source repo contains the actual forked development and unique Phantom bot adaptations.
+
+### Install from npm
+
+```bash
+npm install phantom-baileys
+```
+
+### Install with alias
+
+In `package.json`:
+
+```json
+{
+  "dependencies": {
+    "phantom": "npm:phantom-baileys@latest"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm install
+```
+
+> Tip: Use the alias `phantom` so you can import with `import phantom from 'phantom'` without changing existing bot code.
+
+---
+
+## 🛠️ Initial Setup (From Scratch)
+
+### 1️⃣ Project Preparation
+
+```bash
+mkdir my-bot
+cd my-bot
+npm init -y
+```
+
+Make sure `package.json` has `"type": "module"`:
+
+```json
+{
+  "name": "my-bot",
+  "type": "module",
+  "dependencies": {
+    "phantom": "npm:phantom-baileys@latest"
+  }
+}
+```
+
+> [!IMPORTANT]
+> **You must** use `"type": "module"` because phantom-baileys is an ESM-only package. Without this, imports will error.
+
+### 2️⃣ Install Dependencies
+
+```bash
+npm install phantom-baileys pino
+```
+
+### 3️⃣ Create File `index.js`
+
+```js
+import makeWASocket, {
+  useMultiFileAuthState,
+  DisconnectReason,
+  Browsers
+} from 'phantom-baileys'
+import pino from 'pino'
+
+const logger = pino({ level: 'silent' })
+
+async function startBot() {
+  const { state, saveCreds } = await useMultiFileAuthState('./session')
+
+  const sock = makeWASocket({
+    auth: state,
+    logger,
+    printQRInTerminal: true,
+    browser: Browsers.ubuntu('Chrome')
+  })
+
+  sock.ev.on('creds.update', saveCreds)
+
+  sock.ev.on('connection.update', ({ connection, lastDisconnect }) => {
+    if (connection === 'close') {
+      const shouldReconnect =
+        lastDisconnect?.error?.output?.statusCode !== DisconnectReason.loggedOut
+      if (shouldReconnect) startBot()
+    }
+
+    if (connection === 'open') {
+      console.log('✅ Bot connected!')
+    }
+  })
+
+  sock.ev.on('messages.upsert', async ({ messages }) => {
+    const msg = messages[0]
+    if (!msg?.message || msg.key.fromMe) return
+
+    const text =
+      msg.message.conversation ||
+      msg.message.extendedTextMessage?.text ||
+      ''
+
+    if (text === '.ping') {
+      await sock.sendMessage(msg.key.remoteJid, { text: '🏓 Pong!' })
+    }
+
+    if (text === '.menu') {
+      await sock.sendMessage(msg.key.remoteJid, {
+        interactiveMessage: {
+          title: '📋 Bot Menu',
+          footer: '⚡ Powered by phantom-baileys',
+          buttons: [
+            {
+              name: 'quick_reply',
+              buttonParamsJson: JSON.stringify({
+                display_text: '🏓 Ping',
+                id: '.ping'
+              })
+            },
+            {
+              name: 'quick_reply',
+              buttonParamsJson: JSON.stringify({
+                display_text: 'ℹ️ Info',
+                id: '.info'
+              })
+            }
+          ],
+          header: 'Main Menu'
+        }
+      })
+    }
+  })
+}
+
+startBot()
+```
+
+### 4️⃣ Run the Bot
+
+```bash
+node index.js
+```
+
+> Scan the QR code that appears in the terminal, then send `.ping` or `.menu` to test! 🎉
+
+---
+
+## 🎛️ Interactive Messages
+
+### Native Flow Buttons
+
+```js
+await sock.sendMessage(jid, {
+  interactiveMessage: {
+    title: '🎉 Welcome!',
+    footer: 'Powered by Terri',
+    buttons: [
+      {
+        name: 'quick_reply',
+        buttonParamsJson: JSON.stringify({
+          display_text: '📋 Menu',
+          id: 'menu'
+        })
+      },
+      {
+        name: 'cta_url',
+        buttonParamsJson: JSON.stringify({
+          display_text: '🌐 Website',
+          url: 'https://example.com'
+        })
+      },
+      {
+        name: 'cta_copy',
+        buttonParamsJson: JSON.stringify({
+          display_text: '📋 Copy Code',
+          copy_code: 'PHANTOM2026'
+        })
+      }
+    ],
+    header: 'Choose an option',
+    image: { url: 'https://example.com/banner.jpg' }
+  }
+})
+```
+
+### Interactive Buttons (viewOnce wrapper)
+
+```js
+await sock.sendMessage(jid, {
+  text: 'Hello World!',
+  title: 'Welcome',
+  footer: 'Choose below',
+  interactiveButtons: [
+    {
+      name: 'quick_reply',
+      buttonParamsJson: JSON.stringify({
+        display_text: '✅ Confirm',
+        id: 'confirm'
+      })
+    },
+    {
+      name: 'quick_reply',
+      buttonParamsJson: JSON.stringify({
+        display_text: '❌ Cancel',
+        id: 'cancel'
+      })
+    }
+  ]
+})
+```
+
+### List Menu
+
+```js
+await sock.sendMessage(jid, {
+  interactiveMessage: {
+    title: '📋 Choose Category',
+    footer: 'Powered by Terri',
+    buttons: [
+      {
+        name: 'single_select',
+        buttonParamsJson: JSON.stringify({
+          title: 'Menu List',
+          sections: [
+            {
+              title: '🎮 Games',
+              rows: [
+                { title: 'Guess the Picture', id: '.tebakgambar' },
+                { title: 'Quiz', id: '.quiz' }
+              ]
+            },
+            {
+              title: '🔧 Tools',
+              rows: [
+                { title: 'Sticker', id: '.sticker' },
+                { title: 'TTS', id: '.tts' }
+              ]
+            }
+          ]
+        })
+      }
+    ],
+    header: 'Bot Menu'
+  }
+})
+```
+
+---
+
+## 🖼️ Album Messages
+
+```js
+await sock.sendMessage(jid, {
+  albumMessage: [
+    { image: { url: './photo1.jpg' }, caption: 'First 📸' },
+    { image: { url: './photo2.jpg' }, caption: 'Second 📸' },
+    { video: { url: './clip.mp4' }, caption: 'Video 🎥' }
+  ]
+})
+```
+
+> [!NOTE]
+> Albums automatically set `expectedImageCount` and `expectedVideoCount` based on the array contents.
+
+---
+
+## 📢 Newsletter Methods
+
+```js
+// 🔍 Resolve a channel URL to metadata
+const info = await sock.cekIDSaluran('https://whatsapp.com/channel/xxxxx')
+console.log(info.name, info.subscribers)
+
+// 📥 Bulk follow multiple channels
+await sock.newsletterMultipleFollow('id1@newsletter id2@newsletter')
+
+// 📋 Fetch all subscribed channels
+const channels = await sock.newsletterFetchAllSubscribe()
+
+// ⚡ Generic action (follow/unfollow/mute)
+await sock.newsletterAction('id@newsletter', 'follow')
+```
+
+---
+
+## 📊 Other Message Types
+
+### 💳 Payment Request
+
+```js
+await sock.sendMessage(jid, {
+  requestPaymentMessage: {
+    amount: 50000,
+    currency: 'IDR',
+    note: 'Payment for order #123',
+    from: '628xxx@s.whatsapp.net'
+  }
+})
+```
+
+### 📅 Event
+
+```js
+await sock.sendMessage(jid, {
+  eventMessage: {
+    name: '🎉 Community Meetup',
+    description: 'Join us for the monthly meetup!',
+    startTime: Date.now() + 86400000,
+    endTime: Date.now() + 90000000,
+    location: {
+      name: 'Jakarta',
+      degreesLatitude: -6.2,
+      degreesLongitude: 106.8
+    }
+  }
+})
+```
+
+### 📊 Poll Result
+
+```js
+await sock.sendMessage(jid, {
+  pollResultMessage: {
+    name: 'Favorite Color?',
+    pollVotes: [
+      { optionName: '🔴 Red', optionVoteCount: 42 },
+      { optionName: '🔵 Blue', optionVoteCount: 38 },
+      { optionName: '🟢 Green', optionVoteCount: 25 }
+    ]
+  }
+})
+```
+
+### 📢 Status with Mentions
+
+```js
+await sock.sendStatusMention(
+  { text: '🔥 Big update coming!' },
+  ['628xxx@s.whatsapp.net', 'groupid@g.us']
+)
+```
+
+### 🛍️ Product Message
+
+```js
+await sock.sendMessage(jid, {
+  productMessage: {
+    title: '🎧 Wireless Headphones',
+    description: 'High quality bluetooth headphones',
+    productId: 'WH-001',
+    retailerId: 'Phantom-shop',
+    url: 'https://example.com/product',
+    priceAmount1000: 299000,
+    currencyCode: 'IDR',
+    thumbnail: { url: 'https://example.com/product.jpg' },
+    body: 'Check out this product!',
+    footer: 'Phantom Shop',
+    buttons: [
+      {
+        name: 'quick_reply',
+        buttonParamsJson: JSON.stringify({
+          display_text: '🛒 Buy Now',
+          id: 'buy_wh001'
+        })
+      }
+    ]
+  }
+})
+```
+
+---
+
+
+> [!IMPORTANT]
+> This package outputs **ESM only**. Your project must have `"type": "module"` in `package.json` or use a `.mjs` file.
+
+---
+
+## 🤖 AI Rich Response Messages
+
+Send messages in the Meta AI style — tables, code blocks with syntax highlighting, and rich text. All are rendered via `botForwardedMessage` > `richResponseMessage`.
+
+### 📊 Table (with heading)
+
+```js
+await sock.sendTable(jid, 'Java vs JavaScript',
+  ['Feature', 'Java', 'JavaScript'],
+  [
+    ['Type', 'Compiled', 'Interpreted'],
+    ['Typing', 'Static', 'Dynamic'],
+    ['Main Use', 'Enterprise, Android', 'Web, Full-stack']
+  ],
+  quoted, // optional, pass message object for quoting
+  {
+    headerText: 'Here is a comparison:',  // text before table
+    footer: 'Hope this helps!'            // text after table
+  }
+)
+```
+
+### 📋 List (without heading)
+
+```js
+await sock.sendList(jid, 'Bot Info',
+  [
+    ['Name', 'Phantom AI'],
+    ['Version', '2.4.0'],
+    ['Developer', 'Zann']
+  ],
+  quoted,
+  { footer: '© Phantom AI' }
+)
+```
+
+### 💻 Code Block (with syntax highlighting)
+
+```js
+await sock.sendCodeBlock(jid,
+  `const greeting = "Hello World"
+function sayHello(name) {
+    return greeting + " " + name
+}
+sayHello("Phantom") // output: Hello World Phantom`,
+  quoted,
+  {
+    language: 'javascript',  // default: 'javascript'
+    title: '📝 Example Code',
+    footer: 'Powered by Terri'
+  }
+)
+```
+
+**Supported languages:** `javascript`, `typescript`, `python` (auto keyword detection)
+
+### 🔀 Mixed Rich Message (custom submessages)
+
+```js
+await sock.sendRichMessage(jid, [
+  { messageType: 2, messageText: 'Here is some info:' },
+  {
+    messageType: 4,
+    tableMetadata: {
+      title: 'Stats',
+      rows: [
+        { items: ['Metric', 'Value'], isHeading: true },
+        { items: ['Users', '1000'] },
+        { items: ['Uptime', '99.9%'] }
+      ]
+    }
+  },
+  { messageType: 2, messageText: 'And some code:' },
+  {
+    messageType: 5,
+    codeMetadata: {
+      codeLanguage: 'javascript',
+      codeBlocks: [{ highlightType: 0, codeContent: 'console.log("OK")' }]
+    }
+  }
+], quoted)
+```
+
+### SubMessage Types
+
+| messageType | Name | Payload Field |
+|---|---|---|
+| 0 | UNKNOWN | — |
+| 1 | GRID_IMAGE | `gridImageMetadata` |
+| 2 | TEXT | `messageText` |
+| 3 | INLINE_IMAGE | `imageMetadata` |
+| 4 | TABLE | `tableMetadata` |
+| 5 | CODE | `codeMetadata` |
+| 6 | DYNAMIC | `dynamicMetadata` |
+| 7 | MAP | `mapMetadata` |
+| 8 | LATEX | `latexMetadata` |
+| 9 | CONTENT_ITEMS | `contentItemsMetadata` |
+
+### Code Highlight Types
+
+| highlightType | Name | Color |
+|---|---|---|
+| 0 | DEFAULT | Normal text |
+| 1 | KEYWORD | `import`, `const`, `function` |
+| 2 | METHOD | Function/method calls |
+| 3 | STRING | String literals |
+| 4 | NUMBER | Numeric values |
+| 5 | COMMENT | Comments (`//`, `#`) |
+
+### Utility Functions (Advanced)
+
+```js
+import {
+  tokenizeCode,
+  generateTableContent,
+  generateListContent,
+  generateCodeBlockContent,
+  generateRichMessageContent,
+  buildRichContextInfo,
+  buildBotForwardedMessage,
+  CodeHighlightType,
+  RichSubMessageType,
+} from 'phantom-baileys'
+```
+
+---
+
+## 🔀 Differences with Official Baileys
+
+| Area | Official Baileys v7 | phantom-baileys |
+|------|---------------------|---------------|
+| Interactive messages | ❌ Not available natively | ✅ Full support via Dugong |
+| Album messages | ❌ Not supported | ✅ Multi-media albums |
+| AI Rich Response | ❌ Not available | ✅ Table, code block, rich text |
+| Code Block | ❌ Not available | ✅ Syntax highlighting (JS/TS/Python) |
+| Business nodes | ❌ Inject manually | ✅ Auto-inject in relay |
+| Newsletter extras | ❌ Basic only | ✅ Auto-follow, bulk, resolve |
+| Button detection | ❌ Not available | ✅ `getButtonType()` auto-detect |
+| Payment messages | ❌ Not supported | ✅ Full support |
+| Event messages | ❌ Basic | ✅ Enhanced fields |
+| Status mentions | ❌ Not available | ✅ `sendStatusMention()` |
+| Product messages | ❌ Not supported | ✅ Catalog + buttons |
+
+---
+
+> [!WARNING]
+> Requires **Node.js ≥ 20.0.0** and **TypeScript ≥ 5.8** to build from source.
+
+## 📄 License
+
+MIT 
+
+> [!CAUTION]
+> This library is for **educational purposes**. Make sure you comply with WhatsApp's Terms of Service.
+```

package/WAProto/GenerateStatics.sh

@@ -0,0 +1,3 @@
+yarn pbjs -t static-module --no-beautify -w es6 --no-bundle --no-delimited --no-verify --no-comments -o ./index.js ./WAProto.proto;
+yarn pbjs -t static-module --no-beautify -w es6 --no-bundle --no-delimited --no-verify ./WAProto.proto | yarn pbts --no-comments -o ./index.d.ts -;
+node ./fix-imports.js