@zaiinlin/bails 0.0.0-stage → 1.0.2

package/readme.md

@@ -0,0 +1,456 @@
+<p align="center">
+  <img src="https://e.top4top.io/p_38721hu6c1.jpg" width="250"/>
+</p>
+
+<h1 align="center">WhatsApp Baileys</h1>
+
+<p align="center">
+  Open-source library for building fast, stable WhatsApp automation and integrations over WebSocket — no browser required.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/Node.js-%3E%3D20-339933?logo=node.js&logoColor=white" alt="Node.js" />
+  <img src="https://img.shields.io/badge/license-MIT-blue" />
+  <img src="https://img.shields.io/badge/multi--device-supported-success" />
+</p>
+
+> [!NOTE]
+> `"@zaiinlin/bails": "^1.0.2"` is an unofficial WhatsApp Web API library. Not affiliated, not authorized, not maintained, not sponsored, and not endorsed by WhatsApp or Meta.
+>
+> Use Baileys responsibly, and comply with the WhatsApp Terms of Service and applicable laws.
+
+---
+
+# Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Import](#import)
+- [Quick Start](#quick-start)
+  - [With QR Code](#with-qr-code)
+  - [With Pairing Code](#with-pairing-code)
+- [Sending Message](#sending-message)
+  - [Generic Send / Relay](#generic-send--relay)
+  - [Simple Senders](#simple-senders)
+  - [Ban Checker](#ban-checker)
+  - [Send Message with Participant](#sending-message-with-participant)
+  - [Rich Menu](#rich-menu)
+- [Message Builder](#message-builder)
+  - [Import](#import-1)
+  - [Example](#example)
+- [Button](#button)
+  - [Quick Reply + URL + Copy](#quick-reply--url--copy)
+- [ButtonV2](#buttonv2)
+- [Carousel](#carousel)
+- [Why Choose WhatsApp Baileys?](#why-choose-whatsapp-baileys)
+- [Contributors](#contributors)
+- [Contact & Support](#contact--support)
+
+---
+
+# Requirements
+
+- Node.js **>= 20**
+- Optional peer dependencies depending on the features you use:
+  - `sharp` or `jimp` for image processing
+  - `link-preview-js` for link previews
+  - `audio-decode` for audio waveform handling
+  - `fluent-ffmpeg` for frame preview video, MessageBuilder Toolkit.getMp4Preview
+
+---
+
+# Installation
+
+```bash
+npm install @zaiinlin/bails
+```
+
+Add it to your `package.json`:
+
+```json
+{
+  "dependencies": {
+    "@zaiinlin/bails": "^1.0.2"
+  }
+}
+```
+
+---
+
+# Import
+
+```javascript
+const {
+  default: makeWASocket,
+  // Other Options
+} = require('@zaiinlin/bails');
+```
+
+---
+
+# Quick Start
+
+## With QR Code
+
+```javascript
+const {
+  default: makeWASocket,
+  Browsers
+  // Other Options
+} = require('@zaiinlin/bails');
+
+const client = makeWASocket({
+  browser: Browsers.ubuntu('Chrome'),
+  printQRInTerminal: true
+});
+```
+
+## With Pairing Code
+
+```javascript
+const {
+  default: makeWASocket,
+  fetchLatestWAWebVersion,
+  Browsers
+} = require('@zaiinlin/bails');
+
+const client = makeWASocket({
+  browser: Browsers.ubuntu('Chrome'),
+  printQRInTerminal: false,
+  version: fetchLatestWAWebVersion(),
+  auth: state
+});
+
+const number = "628XXXXX";
+const code = await client.requestPairingCode(number.trim()); // Use (number, "XXXXXXXX") for custom pairing
+
+console.log("Ur pairing code : " + code);
+```
+
+---
+
+# Sending Message
+
+## Generic Send / Relay
+
+```javascript
+// relayMessage — sends a raw message object
+(async () => {
+	await client.relayMessage(m.chat, {
+		conversation: 'zaienv'
+	});
+})();
+
+// sendMessage — the standard way to send a message
+(async () => {
+	await client.sendMessage(m.chat, {
+		text: 'zaienv'
+	});
+})();
+```
+
+## Simple Senders
+
+### Send Text
+
+```javascript
+(async () => {
+	await client.sendText(m.chat, 'Hi!', {
+		contextInfo: {
+			mentionedJid: [jid]
+		}
+	});
+})();
+```
+
+### Send Image
+
+```javascript
+(async () => {
+	await client.sendImage(m.chat, { url: './photo.jpg' }, 'image caption');
+})();
+```
+
+### Send Video
+
+```javascript
+(async () => {
+	await client.sendVideo(m.chat, { url: './clip.mp4' }, 'video caption');
+})();
+```
+
+### Send Audio
+
+```javascript
+(async () => {
+	await client.sendAudio(m.chat, { url: './clip.mp3' });
+})();
+```
+
+### Send Location
+
+```javascript
+(async () => {
+	await client.sendLocation(m.chat, 'Location name', -6.2, 106.8, 'https://maps.example', '1234567890');
+})();
+```
+
+### Send Poll
+
+```javascript
+(async () => {
+	await client.sendPoll(m.chat, 'Pick one', ['Option 1', 'Option 2', 'Option 3'], true);
+})();
+```
+
+### Send Quiz
+
+```javascript
+(async () => {
+	await client.sendQuiz(m.chat, 'Correct answer?', ['1', '2', '3'], '2');
+})();
+```
+
+## Ban Checker
+
+`checkBan` allows you to check the WhatsApp ban status of a phone number using an external API.
+
+### Example
+
+```javascript
+(async () => {
+	try {
+		const number = '6281234567890';
+		const result = await checkBan(number);
+
+		await client.sendMessage(m.chat, {
+			text: JSON.stringify(result, null, 2)
+		});
+	} catch (error) {
+		console.error('Ban Checker Error:', error.message);
+	}
+})();
+```
+
+### Usage
+
+- Replace `6281234567890` with the phone number you want to check.
+- `checkBan` must already be defined in your bot's environment.
+
+> [!NOTE]
+> Ban Checker relies on an external API. Its availability and accuracy depend on the API provider. Results are not an official confirmation of a WhatsApp account's ban status.
+
+# Send Message with Participant
+
+`relayMessage`:
+
+```javascript
+(async () => {
+	await client.relayMessage(m.chat, {
+		extendedTextMessage: {
+			text: 'zaienv'
+		}
+	}, {
+		ptcp: true
+	});
+})();
+```
+
+`sendMessage`:
+
+```javascript
+(async () => {
+	await client.sendMessage(m.chat, {
+		text: 'zaienv'
+	}, {
+		ptcp: true
+	});
+})();
+```
+
+## Rich Menu
+
+`sendRich` sends a rich response with an optional header image, action buttons, carousel cards, and an open-URL footer:
+
+```javascript
+await client.sendRich(m.chat, {
+  header: {
+    disclaimer: true,
+    disclaimerText: "t.me/zdven",
+    title: "zaienv"
+  },
+  body: {
+    title: "Select Option",
+    buttons: ["Menu 1", "Menu 2"]
+  },
+  footer: {
+    text: "Telegram Channel",
+    url: "https://t.me/zdxnv"
+  }
+});
+```
+
+---
+
+# Message Builder
+
+MessageBuilder v4.7 is included directly in `"github:zaiinlin/baileys"`.
+
+## Import
+
+```javascript
+const {
+  VERSION,
+  Button,
+  ButtonV2,
+  Carousel,
+  AIRich,
+  Toolkit,
+  bind,
+  MB
+} = require('@zaiinlin/bails');
+```
+
+> [!NOTE]
+> MessageBuilder is integrated. You don't need to install `baileys-mbuilder` separately.
+
+---
+
+## Example
+
+```javascript
+const { MB } = require('@zaiinlin/bails')
+
+const rich = new MB.AIRich(sock)
+  .setTitle('zaienv')
+  .setFooter('Dibuat dengan AIRich')
+  .addText('Halo! Ini respons rich.')
+  .addCode('javascript', `console.log('Halo zai')`)
+  .addTable([
+    ['Fitur', 'Status'],
+    ['Button', 'Tersedia'],
+    ['Carousel', 'Tersedia'],
+    ['AIRich', 'Eksperimental']
+  ])
+  .addSuggest(['List Menu', 'Help', 'About zai'])
+
+await rich.send(jid)
+```
+
+---
+
+## Button
+
+Builder `Button` is used for native-flow interactive messages.
+
+### Quick Reply + URL + Copy
+
+```js
+const { MB } = require('@zaiinlin/bails')
+
+const msg = new MB.Button(client)
+  .setTitle('Select Menu')
+  .setBody('Pilih salah satu di bawah.')
+  .setFooter('t.me/zdven')
+  .addReply('Ping', 'ping')
+  .addUrl('Buka Website', 'https://example.com')
+  .addCopy('Salin Kode', 'zaienv')
+
+await msg.send(m.chat)
+```
+
+---
+
+## ButtonV2
+
+`ButtonV2` provides a simpler classic button builder.
+
+```javascript
+const { MB } = require('@zaiinlin/bails')
+
+const message = new MB.ButtonV2(client)
+  .setTitle('zaienv')
+  .setSubtitle('WhatsApp Bot')
+  .setBody('Pilih satu tindakan.')
+  .setFooter('zaiBaileys')
+  .setThumbnail('https://example.com/xxx.jpg')
+  .addButton('Menu', 'menu')
+  .addButton('Ping', 'ping')
+
+await message.send(m.chat)
+```
+
+---
+
+## Carousel
+
+Carousel cards can be created from `Button.toCard()` and then submitted to `Carousel`.
+
+```javascript
+const { MB } = require('@zaiinlin/bails')
+
+const card1 = await new MB.Button(client)
+  .setImage('https://example.com/card1.jpg')
+  .setBody('Kartu pertama')
+  .addReply('Pilih', 'card_1')
+  .toCard()
+
+const card2 = await new MB.Button(client)
+  .setImage('https://example.com/card2.jpg')
+  .setBody('Kartu kedua')
+  .addUrl('Buka', 'https://example.com')
+  .toCard()
+
+const carousel = new MB.Carousel(client)
+  .setBody('Pilih salah satu kartu di bawah.')
+  .setFooter('zaiCarousel')
+  .addCard([card1, card2])
+
+await carousel.send(jid)
+```
+
+> [!IMPORTANT]
+> Each carousel card must have an image or video media attachment in its header.
+
+---
+
+# Why Choose WhatsApp Baileys?
+
+Because this library offers high stability, full features, and an actively improved pairing process. It is ideal for developers aiming to create professional and secure WhatsApp automation solutions. Support for the latest WhatsApp features ensures compatibility with platform updates.
+
+---
+
+# Contributors
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/zaienv">
+        <img src="https://cdn.takahasii.my.id/file/414f32e8-80ca-4711-beb7-4d1f68b0e5e3?mode=attachment&exp=0&sig=ae07c53dec74437ac82708f1b88245e1a38aa02891bc4abd5ce58217248b025e" width="80px;" style="border-radius:50%;" alt="Main contributor"/>
+        <br /><sub><b>Z A I D E V</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
+---
+
+## Contact & Support
+
+Have questions, suggestions, or need help with this project? Feel free to reach out through the channels below.
+
+<p align="center">
+  <a href="https://t.me/zdven">
+    <img src="https://img.shields.io/badge/Telegram-Contact%20Developer-26A5E4?style=flat-square&logo=telegram&logoColor=white" alt="Telegram"/>
+  </a>
+  <a href="https://whatsapp.com/channel/0029VbDXMbwElagkugFqkU3U">
+    <img src="https://img.shields.io/badge/WhatsApp-Official%20Channel-25D366?style=flat-square&logo=whatsapp&logoColor=white" alt="WhatsApp Channel"/>
+  </a>
+  <a href="https://t.me/zdxnv">
+    <img src="https://img.shields.io/badge/Telegram-Updates-2CA5E0?style=flat-square&logo=telegram&logoColor=white" alt="Telegram Channel"/>
+  </a>
+</p>
+
+<p align="center">
+  <sub>Developed and maintained by <a href="https://github.com/zaienv">zai</a>.</sub>
+</p>