@alannxds/baileys 0.0.0-stage → 6.2.11

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2026 alannxd (AlannXD) and contributors
+
+Based on Baileys (https://github.com/WhiskeySockets/Baileys), originally
+created by Adhiraj Singh and the WhiskeySockets community, also MIT licensed.
+
+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

@@ -1,3 +1,610 @@
-# Temporary Holding Version
+# <div align='center'>Baileys - Typescript/Javascript WhatsApp Web API</div>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  <img src="https://img3.pixhost.to/images/6661/791050008_alanwinter.jpg" alt="Thumbnail" />
+</p>
+
+<div align='center'>
+
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/whiskeysockets/baileys/total)
+![NPM Downloads](https://img.shields.io/npm/dw/%40whiskeysockets%2Fbaileys?label=npm&color=%23CB3837)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/whiskeysockets/baileys)
+![GitHub License](https://img.shields.io/github/license/whiskeysockets/baileys)
+![Discord](https://img.shields.io/discord/725839806084546610?label=discord&color=%235865F2)
+![GitHub Repo stars](https://img.shields.io/github/stars/whiskeysockets/baileys)
+![GitHub forks](https://img.shields.io/github/forks/whiskeysockets/baileys)
+
+</div>
+
+WhatsApp Baileys is an open-source TypeScript/JavaScript library designed for developers who need direct and flexible integration with WhatsApp Web. It allows applications to establish WhatsApp connections through WebSocket communication without requiring a browser such as Chrome or Chromium.
+
+This library provides a modular interface for authentication, session management, message processing, event handling, and raw message relay. It can be integrated into various Node.js applications, including automation systems, business bots, customer service platforms, notification services, and other communication-related projects.
+
+The project also focuses on making the authentication and pairing workflow easier to integrate into custom applications. QR authentication and pairing code authentication can be combined with persistent session storage, allowing applications to reconnect without requiring users to authenticate every time the process restarts.
+
+Baileys is designed to provide developers with direct access to WhatsApp Web functionality while keeping the implementation relatively lightweight. Because the library operates through a WebSocket connection rather than browser automation, it can be deployed on environments such as Linux servers, VPS instances, Docker containers, and development environments such as Termux.
+
+This project is developed and maintained independently and is not affiliated with WhatsApp or Meta.
+
+---
+
+### Main Features and Advantages
+
+- WhatsApp Web connection through WebSocket
+- QR Code authentication
+- Pairing Code authentication
+- Multi-device authentication
+- Persistent local session management
+- Automatic credential updates
+- `sendMessage` support
+- `relayMessage` support
+- Raw message object support
+- Custom message structures
+- Interactive messages and action buttons
+- Poll and quiz message support
+- Product and order message support
+- Group-related message functionality
+- Event-based message and connection handling
+- Lightweight Node.js integration
+- Suitable for VPS, Linux, Docker, and Termux environments
+- Ready-to-use examples for common use cases
+
+---
+
+## Getting Started
+
+Before starting development, make sure Node.js 20 or newer is installed on your environment.
+
+Install the package using npm, configure the authentication state, then create a WhatsApp socket using `makeWASocket()`.
+
+The simplest setup uses `useMultiFileAuthState()` to store authentication data locally. Once the credentials have been saved, the same session can be reused when the application is restarted.
+
+The examples below use CommonJS syntax so they can be integrated directly into most existing Node.js projects.
+
+---
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Install](#install)
+- [Quick Start](#quick-start)
+- [Sending Messages](#sending-messages)
+- [Raw Message Relay](#raw-message-relay)
+- [Relay Examples](#relay-examples)
+- [Events](#events)
+- [Authentication](#authentication)
+- [Complete Example](#complete-example)
+- [Why Choose WhatsApp Baileys?](#why-choose-whatsapp-baileys)
+- [Technical Notes](#technical-notes)
+- [Contact Developer](#contact-developer)
+- [Contributors outside the Baileys code](#contributors-outside-the-baileys-code)
+- [Credits](#credits)
+- [Disclaimer](#disclaimer)
+
+---
+
+## Requirements
+
+- Node.js **>= 20**
+- npm
+- Internet connection
+- A WhatsApp account for authentication
+
+Depending on the features being used, additional dependencies may be required by the project.
+
+---
+
+## Install
+
+Install the package using npm:
+
+```bash
+npm install @alannxd/baileys
+```
+
+Or use it as an alias while keeping the standard Baileys package name in your source code:
+
+```json
+{
+  "dependencies": {
+    "@whiskeysockets/baileys": "npm:@alannxd/baileys@latest"
+  }
+}
+```
+
+Then import it using:
+
+```js
+const makeWASocket =
+  require('@whiskeysockets/baileys').default
+
+const {
+  useMultiFileAuthState
+} = require('@whiskeysockets/baileys')
+```
+
+---
+
+## Quick Start
+
+The following example creates a basic WhatsApp connection, stores authentication credentials locally, and listens for connection updates.
+
+```js
+const makeWASocket =
+  require('@whiskeysockets/baileys').default
+
+const {
+  useMultiFileAuthState
+} = require('@whiskeysockets/baileys')
+
+async function start() {
+  const { state, saveCreds } =
+    await useMultiFileAuthState('./session')
+
+  const sock = makeWASocket({
+    auth: state
+  })
+
+  sock.ev.on(
+    'creds.update',
+    saveCreds
+  )
+
+  sock.ev.on(
+    'connection.update',
+    ({ connection }) => {
+      console.log(
+        'Connection:',
+        connection
+      )
+    }
+  )
+}
+
+start()
+```
+
+The authentication state is stored inside the `session/` directory. Once authenticated, the same session can be reused when the application starts again.
+
+---
+
+## Sending Messages
+
+### Text Message
+
+```js
+await sock.sendMessage(
+  '628xxxxxxxxxx@s.whatsapp.net',
+  {
+    text: 'Hello'
+  }
+)
+```
+
+### Image Message
+
+```js
+await sock.sendMessage(
+  '628xxxxxxxxxx@s.whatsapp.net',
+  {
+    image: {
+      url: './image.jpg'
+    },
+    caption: 'Hello'
+  }
+)
+```
+
+### Video Message
+
+```js
+await sock.sendMessage(
+  '628xxxxxxxxxx@s.whatsapp.net',
+  {
+    video: {
+      url: './video.mp4'
+    },
+    caption: 'Hello'
+  }
+)
+```
+
+---
+
+## Raw Message Relay
+
+`relayMessage()` digunakan untuk mengirim raw message object secara langsung.
+
+Metode ini berguna ketika aplikasi membutuhkan kontrol yang lebih langsung terhadap struktur message dibandingkan penggunaan helper `sendMessage()` biasa.
+
+```js
+await sock.relayMessage(
+  target,
+  message,
+  {
+    messageId: message.key.id
+  }
+)
+```
+
+### `Alanself`
+
+Library ini menyediakan opsi tambahan `Alanself` pada relay message:
+
+```js
+await sock.relayMessage(
+  target,
+  message,
+  {
+    messageId: message.key.id,
+    Alanself: true
+  }
+)
+```
+
+`Alanself: true` digunakan pada implementasi tertentu untuk mengatur bagaimana pesan hasil relay diperlakukan terhadap sinkronisasi pesan milik perangkat pengirim.
+
+Karena opsi ini merupakan bagian dari modifikasi/penyesuaian project, perilakunya dapat bergantung pada implementasi socket yang digunakan.
+
+---
+
+## Relay Examples
+
+### Conversation
+
+```js
+await sock.relayMessage(
+  jid,
+  {
+    conversation: 'Hello'
+  },
+  {
+    Alanself: true
+  }
+)
+```
+
+### Extended Text
+
+```js
+await sock.relayMessage(
+  jid,
+  {
+    extendedTextMessage: {
+      text: 'Hello'
+    }
+  },
+  {
+    Alanself: true
+  }
+)
+```
+
+Raw message relay memungkinkan developer menggunakan struktur message yang lebih spesifik sesuai kebutuhan aplikasinya.
+
+---
+
+## Events
+
+Semua event tersedia melalui `sock.ev`.
+
+### Connection
+
+```js
+sock.ev.on(
+  'connection.update',
+  ({ connection }) => {
+    console.log(
+      'Connection:',
+      connection
+    )
+  }
+)
+```
+
+### Incoming Message
+
+```js
+sock.ev.on(
+  'messages.upsert',
+  ({ messages }) => {
+    for (const message of messages) {
+      console.log(
+        'Incoming:',
+        message.message
+      )
+    }
+  }
+)
+```
+
+### Credentials
+
+```js
+sock.ev.on(
+  'creds.update',
+  saveCreds
+)
+```
+
+Event system memungkinkan aplikasi menangani berbagai perubahan secara asynchronous, termasuk status koneksi, pesan masuk, pembaruan credential, dan event lain yang tersedia pada socket.
+
+---
+
+## Authentication
+
+Session disimpan secara lokal menggunakan:
+
+```js
+useMultiFileAuthState()
+```
+
+Contoh struktur session:
+
+```text
+session/
+├── creds.json
+├── app-state-sync-key-*.json
+└── ...
+```
+
+Folder tersebut berisi informasi authentication yang memungkinkan aplikasi mempertahankan session WhatsApp.
+
+Jangan upload folder `session` ke repository publik.
+
+Tambahkan ke `.gitignore`:
+
+```gitignore
+session/
+node_modules/
+.env
+```
+
+Credential session sebaiknya diperlakukan sebagai data sensitif karena dapat digunakan untuk mempertahankan authentication pada perangkat yang menjalankan aplikasi.
+
+---
+
+## Complete Example
+
+```js
+const makeWASocket =
+  require('@whiskeysockets/baileys').default
+
+const {
+  useMultiFileAuthState
+} = require('@whiskeysockets/baileys')
+
+async function start() {
+  const { state, saveCreds } =
+    await useMultiFileAuthState('./session')
+
+  const sock = makeWASocket({
+    auth: state
+  })
+
+  sock.ev.on(
+    'creds.update',
+    saveCreds
+  )
+
+  sock.ev.on(
+    'connection.update',
+    ({ connection }) => {
+      console.log(
+        '[ CONNECTION ]',
+        connection
+      )
+    }
+  )
+
+  async function sendText(jid, text) {
+    return sock.sendMessage(
+      jid,
+      { text }
+    )
+  }
+
+  async function relay(jid, message) {
+    return sock.relayMessage(
+      jid,
+      message,
+      {
+        messageId: message.key.id,
+        Alanself: true
+      }
+    )
+  }
+}
+
+start()
+```
+
+---
+
+## Why Choose WhatsApp Baileys?
+
+Baileys memberikan pendekatan yang relatif ringan untuk membuat aplikasi yang terhubung dengan WhatsApp Web tanpa harus menjalankan browser automation.
+
+Beberapa karakteristik utama yang membuat library ini cocok untuk berbagai kebutuhan development:
+
+- **Direct WebSocket Connection**
+  Aplikasi dapat berkomunikasi dengan WhatsApp Web melalui koneksi WebSocket tanpa membutuhkan browser sebagai perantara.
+
+- **Flexible Authentication**
+  Mendukung authentication berbasis QR Code maupun Pairing Code serta penyimpanan session secara lokal.
+
+- **Multi-Device Support**
+  Mendukung sistem multi-device WhatsApp sehingga aplikasi dapat digunakan dengan mekanisme authentication modern.
+
+- **Raw Message Access**
+  `relayMessage()` memungkinkan developer bekerja dengan message object secara lebih langsung ketika `sendMessage()` standar tidak cukup untuk kebutuhan tertentu.
+
+- **Event-Based Architecture**
+  Berbagai aktivitas dapat dipantau menggunakan event seperti `connection.update`, `messages.upsert`, dan `creds.update`.
+
+- **Lightweight Deployment**
+  Dapat digunakan pada VPS, Linux server, Docker, maupun Termux tanpa memerlukan browser automation.
+
+- **Flexible Integration**
+  API dapat digunakan sebagai bagian dari bot, automation system, notification service, customer service application, maupun project Node.js lainnya.
+
+- **Customizable**
+  Karena source dan struktur library dapat dikembangkan lebih lanjut, developer dapat menyesuaikannya dengan kebutuhan aplikasi masing-masing.
+
+---
+
+## Technical Notes
+
+### Node.js Version
+
+Library ditujukan untuk environment Node.js versi:
+
+```text
+Node.js >= 20
+```
+
+Menggunakan versi Node.js yang sesuai membantu memastikan fitur JavaScript modern dan dependency dapat berjalan sebagaimana mestinya.
+
+### Authentication State
+
+Authentication state menggunakan:
+
+```js
+useMultiFileAuthState()
+```
+
+Credential harus tetap disimpan melalui:
+
+```js
+sock.ev.on(
+  'creds.update',
+  saveCreds
+)
+```
+
+Hal tersebut memungkinkan perubahan credential ditulis ke session secara otomatis.
+
+### Raw Relay
+
+`relayMessage()` bekerja menggunakan raw message object.
+
+Contoh:
+
+```js
+await sock.relayMessage(
+  jid,
+  message,
+  {
+    messageId: message.key.id,
+    Alanself: true
+  }
+)
+```
+
+Struktur message yang dikirim harus sesuai dengan format message yang dapat diproses oleh socket.
+
+### Environment
+
+Library dapat digunakan pada berbagai environment Node.js, termasuk:
+
+```text
+Linux
+VPS
+Docker
+Termux
+Local Development
+```
+
+### Session Security
+
+Folder session sebaiknya tidak dibagikan, dikirim ke orang lain, atau diupload ke repository publik.
+
+Jika session tidak sengaja terekspos, authentication dapat berisiko disalahgunakan.
+
+### WhatsApp Web Compatibility
+
+WhatsApp dapat melakukan perubahan pada sisi Web maupun protocol. Karena itu, perubahan pada WhatsApp dapat menyebabkan bagian tertentu dari library membutuhkan update atau penyesuaian.
+
+Developer yang menggunakan library ini sebaiknya memperhatikan update dependency dan perubahan compatibility secara berkala.
+
+### Additional Features
+
+Project ini juga menyediakan berbagai kemampuan message seperti interactive message, action button, poll, quiz, product message, order message, group-related message, dan beberapa struktur message lainnya tergantung versi library yang digunakan.
+
+---
+
+## Contact Developer
+
+Untuk pertanyaan, support, laporan bug, collaboration, atau informasi mengenai project:
+
+- **Telegram:** [Telegram Contact](https://t.me/alannxd)
+- **WhatsApp Channel:** [Channel WhatsApp](https://whatsapp.com/channel/0029Vb3IiqTL7UVP9A9n0w1x)
+
+Untuk informasi terbaru mengenai project dan update library, silakan mengikuti channel yang tersedia.
+
+---
+
+## Contributors outside the Baileys code
+
+Thanks to the following awesome contributors who help improve this project.
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/alannzxd">
+        <img src="https://github.com/alannzxd.png" width="80px;" style="border-radius:50%;" alt="Developer"/>
+        <br />
+        <sub><b>AlannXD</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Xazepysk">
+        <img src="https://github.com/XazepysK.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
+        <br />
+        <sub><b>Xaz zepysK</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/kiuur">
+        <img src="https://github.com/kiuur.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
+        <br />
+        <sub><b>KyuuRzy</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/Xcoursed">
+        <img src="https://github.com/Xcoursed.png" width="80px;" style="border-radius:50%;" alt="Contributor"/>
+        <br />
+        <sub><b>Xcoursed</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
+---
+
+## Credits
+
+<div align="center">
+
+**AlannXD**
+
+Developer & Maintainer
+
+<br>
+
+Based on:
+
+**Baileys**
+
+</div>
+
+---
+
+## Disclaimer
+
+Project ini dibuat untuk keperluan **development dan educational**.
+
+Developer tidak bertanggung jawab atas penyalahgunaan library, pembatasan akun, kehilangan session, atau pelanggaran Terms of Service WhatsApp.
+
+Gunakan library secara bertanggung jawab dan ikuti ketentuan layanan WhatsApp yang berlaku.

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