zaileys 0.28.94-beta → 0.28.95-beta

package/README.md

@@ -1,6 +1,8 @@
-<p align="center"><img src="https://socialify.git.ci/zeative/zaileys/image?description=1&amp;descriptionEditable=Zaileys%20is%20a%20simplified%20version%20of%20the%20Baileys%20package%20%0Awhich%20is%20easier%20and%20faster.&amp;font=KoHo&amp;forks=1&amp;issues=1&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Circuit%20Board&amp;pulls=1&amp;stargazers=1&amp;theme=Auto" alt="project-image"></p>
+<div align='center'>
+  <img alt="Zaileys - Simplify Typescript/Javascript WhatsApp NodeJS API" border='4' src="https://socialify.git.ci/zeative/zaileys/image?description=1&amp;descriptionEditable=Zaileys%20is%20a%20simplified%20version%20of%20the%20Baileys%20package%20%0Awhich%20is%20easier%20and%20faster.&amp;font=KoHo&amp;forks=1&amp;issues=1&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Circuit%20Board&amp;pulls=1&amp;stargazers=1&amp;theme=Auto">
+</div>
 
-<h1 align="center" id="title">Zaileys - Simplify Typescript/Javascript WhatsApp NodeJS API</h1>
+<h1 align="center">Zaileys - Simplify Typescript/Javascript WhatsApp NodeJS API</h1>
 
 <div align='center'>
 
@@ -15,51 +17,323 @@
 
 </div>
 
-Zaileys is a powerful and flexible WhatsApp API library for Node.js, built on top of Baileys. It simplifies the process of integrating WhatsApp functionalities into your applications, providing a comprehensive set of features for building robust and scalable WhatsApp-based solutions. 
+> [!WARNING]
+> This is beta version, not recomended to use in production. Join whatsapp community for latest info [WhatsApp Channel](https://whatsapp.com/channel/0029VazENbmInlqHIWzgn33h)
+
+Zaileys is a powerful and flexible WhatsApp API library for Node.js, built on top of [Baileys](https://github.com/WhiskeySockets/Baileys). It simplifies the process of integrating WhatsApp functionalities into your applications, providing a comprehensive set of features for building robust and scalable WhatsApp-based solutions.
 
-**Key Features:**
+## # Features
 
-*   **Multi-Device Support:** Leverage the latest WhatsApp multi-device features for enhanced reliability and performance.
-*   **Comprehensive API:** Access a wide range of WhatsApp functionalities, including sending and receiving messages, media handling, group management, and more.
-*   **Easy to Use:**  Designed with developer experience in mind, Zaileys offers a clean and intuitive API that is easy to learn and use.
-*   **Highly Customizable:** Adapt the library to your specific needs with flexible configuration options and modular design.
+- **Multi-Device Support:** Leverage the latest WhatsApp multi-device features for enhanced reliability and performance.
+- **Customizable:** Adapt the library to your specific needs with flexible configuration options and modular design.
 
-## Installation
+## # Installation
 
 ```bash
-npm install zaileys
+npm add zaileys
+
+pnpm add zaileys
+
+yarn add zaileys
+
+bun add zaileys
+
+deno add npm:zaileys
+```
+
+## # Example Code
+
+> [!TIP]
+> If you don't want to take time for setup and configuration, use the [example.ts](https://github.com/zeative/zaileys/blob/main/test/example.ts) file that I have provided.
+
+## # Usage & Configuration
+
+### 📦 Import Library
+
+```js
+// ESM
+import { Client } from "zaileys";
+
+// CJS
+const { Client } = require("zaileys");
 ```
 
-## Usage
+### ⚙️ Configuration
+
+> [!WARNING]
+> Warning! in beta version this library uses built-in Baileys [`makeInMemoryStore`](https://github.com/WhiskeySockets/Baileys?tab=readme-ov-file#implementing-a-data-store) function which will most likely use quite a lot of RAM.
+> If you experience this, you can delete the `.zaileys/memory.json` file then restart the server.
+
+```ts
+const wa = new Client({
+  prefix: "/", // for command message, example '/'
+  ignoreMe: true, // ignore messages from bot (bot phone number)
+  phoneNumber: 628xxx, // fill bot phone number if auth type is 'pairing'
+  authPath: ".zaileys", // auth directory path for session and chat store
+  authType: "pairing", // auth type 'pairing' or 'qr'
+  showLogs: true, // show logs of any chats
+  autoMentions: true, // bot will be auto mentioned if text contains sender number with '@' prefix
+  autoOnline: true, // bot status will be mark online
+  autoRead: true, // auto read message from any chats
+  autoRejectCall: true,  // auto reject call if someone call you
+  citation: {
+    // your citation will be boolean object based on validate with your value
+    // system will be validate your value with 'senderId' and 'roomId'
+    // if one is valid then the key will return 'boolean'
+    // sample output: { isAuthors: boolean }
+
+    // just sample, you can rename with any key
+    authors: () => ["628xxxx"], // key 'authors' will be 'isAuthors'
+    myGroups: () => ["1203633xxxxx"], // key 'myGroups' will be 'isMyGroups'
+    ...otherKey // key 'otherKey' will be 'isOtherKey'
+  },
+});
+```
+
+<hr>
+
+> [!NOTE]
+> The functions and parameters below may change at any time considering that this library is a beta version. So when you update a library to the latest version but an error occurs, there may be changes to certain functions and parameters.
+
+### 🛎️ Event Handler
+
+You can find out the output type of each object in the listener below:
 
-### Import Client
+- ctx for [`connection`]()
+- ctx for [`message`]()
+- ctx for [`command`]()
+- ctx for [`call`]()
 
-```typescript
-import { Client } from 'zaileys';
+```ts
+wa.on("connection", (ctx) => {}); // listener for current connection
+wa.on("message", (ctx) => {}); // listener for message from any chats
+wa.on("command", (ctx) => {}); // listener for message that starts with prefix at beginning of word
+wa.on("call", (ctx) => {}); // listener for someone call to bot
 ```
 
-### Basic Example
+<hr>
 
-```typescript
-import { Client } from 'zaileys';
+### 🔹 Connection Handler
 
+```ts
+wa.on("connection", (ctx) => {
+  if (ctx.status == "open") {
+    // do something
+  }
+});
 ```
 
-## Features
+<hr>
 
--   **Simple Client Initialization**: Easy setup with the `Client` class.
--   **Effortless Connection Management**: Connect and reconnect to WhatsApp with built-in functions.
--   **Versatile Message Handling**: Send and receive text, media, and interactive messages.
--   **Group Management**: Create, join, and manage WhatsApp groups.
--   **Contact Management**: Interact with contacts, block/unblock, and manage your contact list.
--   **Real-time Event Handling**: Get notified of events in real-time using a simple event listener system.
--   **Advanced Media Support**: Send and receive various types of media messages, including images, videos, audio, documents, and stickers.
--   **Location and Live Location Sharing**: Share and receive locations and live locations.
--   **Interactive Messages**: Send and receive interactive messages like buttons, lists, and quick reply buttons.
--   **Presence Management**: Manage your online presence with presence features.
--   **Device Synchronization**: Leverage multi-device features for seamless device synchronization.
+### 🔹 Send Text Message
+
+[Here](#) you can find out the complete parameters for the `.sendText()` function
+
+```ts
+wa.on("message", (ctx) => {
+  if (ctx.text == "ping") {
+    ctx.sendText("Hello! " + ctx.senderName);
+  }
+
+  // text from reply message
+  if (ctx.reply?.text == "ping") {
+    ctx.sendText("Pong from reply!");
+  }
+
+  // text from nested reply message
+  // you can retrieve reply messages of any depth
+  if (ctx.reply?.reply?.reply?.text == "ping") {
+    ctx.sendText("Pong from nested reply!");
+  }
+
+  // text with footer message (doesn't work on whatsapp desktop)
+  if (ctx.text == "pong") {
+    ctx.sendText("Ping!", { footer: "Footer message" });
+  }
+});
+```
+
+<hr>
+
+### 🔹 Send Reply Message
+
+[Here](#) you can find out the complete parameters for the `.sendReply()` function
+
+```ts
+wa.on("message", (ctx) => {
+  if (ctx.text == "ping") {
+    ctx.sendReply("Pong!");
+  }
+
+  // reply with footer message (doesn't work on whatsapp desktop)
+  if (ctx.text == "pong") {
+    ctx.sendReply("Ping!", { footer: "Footer message" });
+  }
+
+  // reply with fake verified badge
+  if (ctx.text == "fake") {
+    ctx.sendReply("Fake Verified!", { fakeVerified: "whatsapp" });
+  }
+});
+```
+
+[Here](#) you can find out all the **verified** platforms provided
+
+<hr>
+
+### 🔹 Send Sticker Message
+
+[Here](#) you can find out the complete parameters for the `.sendSticker()` function
+
+```ts
+wa.on("message", async (ctx) => {
+  if (ctx.chatType == "sticker") {
+    const sticker = await ctx.media?.buffer!();
+
+    ctx.sendSticker(sticker);
+  }
+
+  if (ctx.text == "sticker") {
+    ctx.sendSticker("https://gtihub.com/zeative.png");
+  }
+});
+```
+
+<hr>
+
+### 🔹 Send Image Message
+
+[Here](#) you can find out the complete parameters for the `.sendImage()` function
+
+```ts
+wa.on("message", async (ctx) => {
+  if (ctx.chatType == "image") {
+    const image = await ctx.media?.buffer!();
+
+    ctx.sendImage(image);
+  }
+
+  if (ctx.text == "image") {
+    ctx.sendImage("https://gtihub.com/zeative.png");
+  }
+
+  if (ctx.text == "mypp") {
+    const picture = await ctx.senderImage();
+
+    ctx.sendImage(picture);
+  }
+});
+```
+
+<hr>
+
+### 🔹 Send Video Message
+
+[Here](#) you can find out the complete parameters for the `.sendVideo()` function
+
+```ts
+wa.on("message", async (ctx) => {
+  if (ctx.chatType == "video") {
+    const video = await ctx.media?.buffer!();
+
+    ctx.sendVideo(video);
+  }
+
+  if (ctx.text == "video") {
+    ctx.sendVideo("https://gtihub.com/zeative.png");
+  }
+});
+```
+
+<hr>
+
+### 🔹 Send Audio Message
+
+[Here](#) you can find out the complete parameters for the `.sendAudio()` function
+
+```ts
+wa.on("message", async (ctx) => {
+  if (ctx.chatType == "audio") {
+    const audio = await ctx.media?.buffer!();
+
+    ctx.sendAudio(audio);
+  }
+
+  if (ctx.text == "audio") {
+    ctx.sendAudio("https://gtihub.com/zeative.png");
+  }
+});
+```
+
+<hr>
+
+### 🔹 With Prefix Message
+
+> [!NOTE]
+> You must set `prefix` option to anything character
+
+```ts
+wa.on("message", async (ctx) => {
+  // for example set prefix to "/"
+  // and user text "/test"
+  if (ctx.command == "test") {
+    ctx.sendText("From command message!");
+  }
+});
+```
+
+<hr>
+
+### 🔹 Mentioned User
+
+> [!NOTE]
+> You must set `autoMentions` option to `true` and bot will send text as mentions
+
+```ts
+wa.on("message", async (ctx) => {
+  if (ctx.text == "mentions") {
+    ctx.sendText("Here user mentioned: @0 @18002428478");
+    // example output: "Here user mentioned: @WhatsApp @ChatGPT"
+
+    // if `autoMentions` is inactive or `false`
+    // output can be plain text: "Here user mentioned: @0 @18002428478"
+  }
+});
+```
+
+<hr>
+
+### 🔹 Citation Handler
+
+> [!NOTE]
+> You must set `citation` like [example](https://github.com/zeative/zaileys?tab=readme-ov-file#%EF%B8%8F-configuration) above before
+
+```ts
+const wa = new Client({
+  ...,
+
+  // just example you can edit with your own
+  citation: {
+    authors: ["628xxxx"],
+    myPrivateGroups: ["1203633xxxxx"]
+  }
+})
+
+wa.on("message", async (ctx) => {
+  const isAuthors = ctx.citation?.isAuthors;
+  const isMyPrivateGroups = ctx.citation?.isMyPrivateGroups;
+  
+  if (isAuthors && ctx.text == "ping") {
+    ctx.sendText("Message for my author: kejaa");
+  }
+
+  if (isMyPrivateGroups && ctx.text == "pong") {
+    ctx.sendText("Message for my private group!");
+  }
+});
+```
 
-## Contributing
+## # Contributing
 
 Contributions are welcome! Please follow these steps to contribute:
 
@@ -71,10 +345,10 @@ Contributions are welcome! Please follow these steps to contribute:
 
 Please ensure your code follows the project's coding standards and includes appropriate tests.
 
-## License
+## # License
 
 This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.
 
-## Acknowledgements
+## # Acknowledgements
 
--   [Baileys](https://github.com/WhiskeySockets/Baileys) - The WhatsApp Web API library this project is based on.
+- [Baileys](https://github.com/WhiskeySockets/Baileys) - The WhatsApp Web API library this project is based on.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zaileys",
-  "version": "0.28.94-beta",
+  "version": "0.28.95-beta",
   "description": "Zaileys - Simplify Typescript/Javascript WhatsApp NodeJS API",
   "keywords": [
     "zaileys",