zaileys 1.1.33 → 1.1.34

package/README.md

@@ -1,52 +1,100 @@
-<h1 align="center">Zaileys - Simplified WhatsApp Node.js API</h1>
-
 <div align="center">
   <img alt="Zaileys - Simplified WhatsApp Node.js API" src="https://socialify.git.ci/zeative/zaileys/image?description=1&descriptionEditable=Zaileys%20is%20a%20simplified%20version%20of%20the%20Baileys%20package%20%0Awhich%20is%20easier%20and%20faster.&font=KoHo&forks=1&issues=1&language=1&name=1&owner=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Auto">
-  <br>
-  <a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/v/zaileys.svg" alt="NPM Version"></a>
-  <a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/dw/zaileys?label=npm&color=%23CB3837" alt="NPM Downloads"></a>
-  <a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/languages/code-size/zeative/zaileys" alt="GitHub Code Size"></a>
-  <a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/license/zeative/zaileys" alt="GitHub License"></a>
-  <a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/stars/zeative/zaileys" alt="GitHub Stars"></a>
-  <a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/forks/zeative/zaileys" alt="GitHub Forks"></a>
-</div>
-
-#
-**Zaileys** is a lightweight, user-friendly wrapper around the [Baileys](https://github.com/WhiskeySockets/Baileys) library, designed to simplify building WhatsApp bots and integrations with TypeScript or ESM JavaScript. It offers a streamlined API, robust multi-device support, and seamless database integration for session management.
-
-> **Note**: Stay updated and get support by joining our [WhatsApp Channel](https://whatsapp.com/channel/0029VazENbmInlqHIWzgn33h).
 
-> **Warning**: Pairing code authentication is currently not supported due to issues. Use QR code authentication instead.
+  <h1 align="center">Zaileys - Simplified WhatsApp Node.js API</h1>
 
-## 📋 Table of Contents
+<a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/v/zaileys.svg" alt="NPM Version"></a>
+<a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/dw/zaileys?label=npm&color=%23CB3837" alt="NPM Downloads"></a>
+<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/languages/code-size/zeative/zaileys" alt="GitHub Code Size"></a>
+<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/license/zeative/zaileys" alt="GitHub License"></a>
+<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/stars/zeative/zaileys" alt="GitHub Stars"></a>
+<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/forks/zeative/zaileys" alt="GitHub Forks"></a>
 
-1. [✨ Features](#features)
-2. [📦 Installation](#installation)
-3. [🚀 Quick Start](#quick-start)
-4. [🛠 Core Concepts](#core-concepts)
-5. [📡 Event Handling](#event-handling)
-6. [📩 Sending Messages](#sending-messages)
-7. [🖼 Sending Media](#sending-media)
-8. [🔧 Advanced Actions](#advanced-actions)
-9. [🐛 Issues & Feedback](#issues--feedback)
-10. [❤️ Support](#support)
-11. [📜 License](#license)
-12. [🙌 Acknowledgements](#acknowledgements)
-
-## ✨ Features
-
-- **Simplified API**: Minimal setup for rapid bot development.
-- **Multi-Device Support**: Full compatibility with WhatsApp’s multi-device feature via Baileys.
-- **Modular & Extensible**: Easily integrate middleware and custom storage solutions.
-- **QR Code Authentication**: Hassle-free login with terminal-based QR codes.
-- **TypeScript & ESM**: Full type safety and modern JavaScript support.
-- **Database Integration**: Supports SQLite, PostgreSQL, or MySQL for session persistence.
-- **Rate Limiting**: Built-in spam detection to prevent abuse.
-- **Webhooks Support**: Handle external events with a dynamically provided URL during runtime.
+</div>
 
-## 📦 Installation
+**Zaileys** is a lightweight, user-friendly wrapper around the [Baileys](https://github.com/WhiskeySockets/Baileys) library, designed to simplify building WhatsApp bots and integrations with TypeScript or ESM JavaScript. It offers a streamlined API, robust multi-device support, and seamless database integration for session management.
 
-Install Zaileys using your preferred package manager:
+> [!TIP]
+> Stay updated and get support by joining our [WhatsApp Channel](https://whatsapp.com/channel/0029VazENbmInlqHIWzgn33h).
+
+> [!IMPORTANT]
+> There is no assurance that you won’t get blocked when using this approach. WhatsApp does not permit bots or unofficial clients, so use it at your own risk.
+
+### 💠 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Example Projects](#-example-projects)
+- [Connecting Methods](#-connecting-methods)
+  - [QR Code](#qr-code)
+  - [Pairing Code](#pairing-code)
+- [Quick Start](#-quick-start)
+- [Core Concepts](#-core-concepts)
+  - [Citation](#citation)
+  - [Limiter](#limiter)
+  - [Fake Reply](#fake-reply)
+- [Event Handling](#-event-handling)
+- [Relay Handling](#-relay-handling)
+  - [General](#general)
+    - [Text Message](#text-message)
+    - [Reply Message](#reply-message)
+    - [Forward Message](#forward-message)
+    - [Edit Message](#edit-message)
+    - [Delete Message](#delete-message)
+    - [Reaction Message](#reaction-message)
+    - [Presence](#presence)
+    - [Reject Call](#reject-call)
+  - [Media](#media)
+    - [Document Message](#document-message)
+    - [Image Message](#image-message)
+    - [Sticker Message](#sticker-message)
+    - [Video Message](#video-message)
+    - [Audio Message](#audio-message)
+    - [Voice Message](#voice-message)
+    - [View Once Message](#view-once-message)
+    - [Note Message](#note-message)
+    - [Gif Message](#gif-message)
+    - [Location Message](#location-message)
+    - [Contacts Message](#contacts-message)
+    - [Polling Message](#polling-message)
+    - [Button Message](#button-message)
+  - [Group Control](#group-control)
+    - [Group Create](#group-create)
+    - [Group Action](#group-action)
+    - [Group Invite](#group-invite)
+    - [Group Update](#group-update)
+    - [Group Settings](#group-settings)
+    - [Group Leave](#group-leave)
+    - [Group Links](#group-links)
+    - [Group Invite](#group-invite)
+    - [Group Metadata](#group-metadata)
+    - [Group Requests](#group-requests)
+  - [Privacy Control](#privacy-control)
+    - [Privacy Update](#privacy-update)
+    - [Privacy Fetch](#privacy-fetch)
+  - [Profile Control](#profile-control)
+    - [Profile Bio](#profile-bio)
+    - [Profile Avatar](#profile-avatar)
+    - [Profile Business](#profile-business)
+    - [Profile Update](#profile-update)
+    - [Profile Check](#profile-check)
+- [Issues & Feedback](#-issues---feedback)
+
+### 💠 Features
+
+- 🎯 **Simplified API**: Minimal boilerplate get up and running in minutes.
+- 🔒 **Secure Multi-Device**: Full multi-device support via Baileys.
+- ⚙️ **Modular & Extensible**: Plug-and-play middleware, transports, and storage layers.
+- 📟 **Multi Auth (QR and Pairing Code)**: Connect to whatsapp with QR code or Pairing Code.
+- 🛠️ **TypeScript First**: Full type definitions and zero-config TS support.
+- ~~📈 **Built-in Logging**: Integrated with Pino for structured logs.~~
+
+### 💠 Installation
+
+> [!WARNING]
+> Ensure you are running [Node.js](https://nodejs.org/) **>= 20** as specified in `package.json`.
+
+Install with your preferred package manager:
 
 ```bash
 npm install zaileys
@@ -54,394 +102,617 @@ npm install zaileys
 yarn add zaileys
 # or
 pnpm add zaileys
+# or
+bun add zaileys
+deno add npm:zaileys
 ```
 
-**Requirements**:
+Then import your code using:
 
-- **Node.js**: Version 18 or higher.
-- **Module System**: ESM or TypeScript only (no CommonJS).
-- **Authentication**: QR code only (pairing code not supported).
-- **Unsupported Runtimes**: Deno and Bun (due to `better-sqlite3` incompatibility).
+```js
+import { Client } from "zaileys";
+// or
+const { Client } = require("zaileys");
+```
 
-## 🚀 Quick Start
+### 💠 Example Projects
 
-Explore the `/examples` folder for practical use cases:
+Explore the `examples` for practical use cases:
 
 - [Simple Setup](https://github.com/zeative/zaileys/blob/main/examples/simple.ts): A minimal setup for quick prototyping.
 - [Citation Example](https://github.com/zeative/zaileys/blob/main/examples/citation.ts): Demonstrates custom metadata with the citation mechanism.
 - [Rate Limiting Example](https://github.com/zeative/zaileys/blob/main/examples/limiter.ts): Shows how to implement spam detection.
 - [AI Integration with Groq](https://github.com/zeative/zaileys/blob/main/examples/llms.ts): Integrates AI capabilities using Groq.
-- [Webhooks Integration](https://github.com/zeative/zaileys/blob/main/examples/webhooks.ts): Handles webhook-based interactions.
 - [Voice Note with AI](https://github.com/zeative/zaileys/blob/main/examples/speech.ts): Interacts with AI using voice notes.
 
-### Basic Example
+### 💠 Connecting Methods
 
-```ts
-import { Client } from "zaileys";
+> [!TIP]
+> You can connect to WhatsApp using either a QR code or a pairing code.
 
-// default configuration
+### `QR Code`
+
+```js
 const wa = new Client({
-  prefix: "/",
-  ignoreMe: true,
-  showLogs: true,
-  autoRead: true,
-  autoOnline: true,
-  autoPresence: true,
-  autoRejectCall: true,
-  loadLLMSchemas: false,
-  database: {
-    type: "sqlite",
-    connection: { url: "./session/zaileys.db" },
-  },
+  authType: "qr",
 });
+```
 
-wa.on("messages", async (ctx) => {
-  if (ctx.text === "test") {
-    await wa.text("Hello!", { roomId: ctx.roomId });
-  }
+### `Pairing Code`
+
+```js
+const wa = new Client({
+  authType: "pairing",
+  phoneNumber: 628123456789,
 });
 ```
 
-### Minimal Example
+### 💠 Quick Start
 
-```ts
-import { Client } from "zaileys";
+here is minimal example of how to run:
 
+```js
 const wa = new Client({ authType: "qr" });
 
 wa.on("messages", (ctx) => {
-  wa.text("Hello", { roomId: ctx.roomId });
+  if (ctx.text == "ping") {
+    wa.text("pong");
+  }
 });
 ```
 
-## 🛠 Core Concepts
-
-### Sessions & Authentication
-
-Zaileys uses QR code authentication and stores sessions in a database to avoid repeated QR scans.
-
-```ts
-import { Client } from "zaileys";
-
-const wa = new Client({
-  database: {
-    type: "sqlite",
-    connection: { url: "./session/zaileys.db" },
-  },
-});
-```
+### 💠 Core Concepts
 
-### Citation Mechanism
+### `Citation`
 
-Define custom metadata providers for dynamic boolean flags in `ctx.citation`. See [citation.ts](https://github.com/zeative/zaileys/blob/main/examples/citation.ts).
+Define custom metadata providers for dynamic boolean flags in `ctx.citation`. See `citation.ts`.
 
-```ts
+```js
 const wa = new Client({
+  ...,
   citation: {
-    admins: async () => [628123456789],
-    vips: () => [628123456789],
-  },
-});
+    admins: [628123456789]
+  }
+})
 
 wa.on("messages", (ctx) => {
+  // from 'admins' to 'isAdmins'
+  // from 'test' to 'isTest'
   if (ctx.citation?.isAdmins) {
-    wa.text("Admin access granted", { roomId: ctx.roomId });
+    wa.text("Admin access granted")
   }
-});
+})
 ```
 
-### Rate Limiting
+### `Limiter`
 
-Detect and prevent spam with the built-in limiter. See [limiter.ts](https://github.com/zeative/zaileys/blob/main/examples/limiter.ts).
+Detect and prevent spam with the built-in limiter. See limiter.ts.
 
-```ts
+```js
 const wa = new Client({
-  authType: "qr",
-
-  // max 10 messages on 10 seconds
+  ...,
+  // max 5 messages on 10 seconds
   limiter: {
     durationMs: 10000,
-    maxMessages: 5,
-  },
-});
+    maxMessages: 5
+  }
+})
 
 wa.on("messages", (ctx) => {
   if (ctx.isSpam) {
-    wa.text("You're spamming!!", { roomId: ctx.roomId });
-    return;
+    wa.text("You're spamming!!");
   }
-
-  wa.text("Hello!", { roomId: ctx.roomId });
-});
+})
 ```
 
-### Webhooks
+### `Fake Reply`
 
-Configure webhooks to handle external events. The URL is dynamically provided in the CLI upon running the app. See [webhooks.ts](https://github.com/zeative/zaileys/blob/main/examples/webhooks.ts).
+Make it look like the number verified by manipulation.
 
-```ts
+```js
 const wa = new Client({
-  authType: "qr",
-  webhooks: {
-    url: "https://your-webhook-url.com",
-  },
-});
+  ...,
+  fakeReply: {
+    provider: "whatsapp", // meta | chatgpt | copilot | instagram | tiktok
+  }
+})
 
-wa.on("webhooks", (ctx) => {
-  console.log(ctx.data.query); // Query params
-  console.log(ctx.data.json); // JSON body
-  console.log(ctx.data.form); // Form data
-  console.log(ctx.data.raw); // Raw body
-});
+wa.on("messages", (ctx) => {
+  if (ctx.text == "test") {
+    wa.reply("Test reply...");
+  }
+})
 ```
 
-**Webhook Access**: Displayed in CLI on startup (e.g., `http://xxx.xxx.x.xxx:4135/webhooks`, Port: 4135, Methods: GET, POST).
+### 💠 Event Handling
 
-## 📡 Event Handling
+Types of events handled.
 
-### Connection Events
+```js
+/* Monitor connection status */
+wa.on("connection", (ctx) => {});
 
-Monitor connection status changes.
+/* Handle incoming messages */
+wa.on("messages", (ctx) => {});
 
-```ts
-wa.on("connection", (ctx) => {
-  console.log(`Connection: ${ctx.status}`);
-});
+/* Handle incoming calls */
+wa.on("calls", (ctx) => {});
 ```
 
-### Message Events
+### 💠 Relay Handling
 
-```ts
-wa.on("messages", (ctx) => {
-  console.log(ctx);
-});
+### `General`
+
+#### *Text Message*
+
+```js
+wa.text("Hello World!")
+// or
+wa.text({ text: "Hello World!" })
+
+/* custom roomId */
+wa.text({ text: "Hello World!", roomId: "12345@xxx" })
+```
+
+auto mentions user/group (works for both):
+
+```js
+wa.text("Hello @628123456789 @0")
+```
+
+external ads preview (works for both):
+
+```js
+wa.text({
+  text: "Test ads text",
+  externalAdReply: {
+    title: "Test ads title",
+    body: "Test ads body",
+    thumbnailUrl: "https://github.com/zeative.png",
+    mediaUrl: "https://zpi.my.id",
+  }
+})
+```
+
+#### *Reply Message*
+
+```js
+wa.reply("Test reply message...")
+```
+
+#### *Forward Message*
+
+```js
+wa.forward("Test forward message...")
+```
+
+#### *Edit Message*
+
+```js
+const msg = await wa.text("Test edit message...")
+await wa.edit({ text: "Edit success!", message: msg.message })
 ```
 
-Schemas output of `ctx` type:
-
-```json
-{
-  "chatId": "string",
-  "channelId": "string",
-  "uniqueId": "string",
-  "receiverId": "string",
-  "receiverName": "string",
-  "roomId": "string",
-  "roomName": "string",
-  "senderId": "string",
-  "senderName": "string",
-  "senderDevice": "string",
-  "chatType": "string",
-  "timestamp": "number",
-  "mentions": "array",
-  "text": "string",
-  "links": "array",
-  "isPrefix": "boolean",
-  "isSpam": "boolean",
-  "isFromMe": "boolean",
-  "isTagMe": "boolean",
-  "isGroup": "boolean",
-  "isStory": "boolean",
-  "isViewOnce": "boolean",
-  "isEdited": "boolean",
-  "isDeleted": "boolean",
-  "isPinned": "boolean",
-  "isUnPinned": "boolean",
-  "isChannel": "boolean",
-  "isBroadcast": "boolean",
-  "isEphemeral": "boolean",
-  "isForwarded": "boolean",
-  "citation": "object",
-  "media": {
-    ...
-    "buffer": "function",
-    "stream": "function"
-  },
-  "replied": "object (same schema as ctx)",
-  "message": "function"
-}
-```
-
-### Call Events
-
-Handle incoming calls.
-
-```ts
+#### *Delete Message*
+
+```js
+const msg = await wa.text("Test delete message...")
+await wa.delete({ message: msg.message })
+```
+
+#### *Reaction Message*
+
+```js
+wa.reaction("🎯")
+// or
+wa.reaction({ emoticon: "🎯" });
+```
+
+#### *Presence*
+
+```js
+wa.presence("typing") // online | offline | recording | paused
+```
+
+#### *Reject Call*
+
+```js
 wa.on("calls", (ctx) => {
-  console.log(ctx);
-});
+  wa.reject(ctx);
+  // or
+  wa.reject({ callId: ctx.callId, callerId: ctx.callerId });
+})
 ```
 
-### Webhook Events
+### `Media`
 
-Handle external webhook requests.
+#### *Document Message*
 
-```ts
-wa.on("webhooks", (ctx) => {
-  console.log(ctx.data.query); // Query params
-  console.log(ctx.data.json); // JSON body
-  console.log(ctx.data.form); // Form data
-  console.log(ctx.data.raw); // Raw body
-});
+```js
+wa.document("text", {
+  document: "https://github.com/zeative.png",
+  mimetype: "image/png",
+  fileName: "zaadevofc logo.png",
+  text: "Here your logo",
+})
+
+// others method: text | reply | forward
+// example as reply
+wa.document("reply" { ... })
 ```
 
-**Webhook Access**: Displayed in CLI on startup (e.g., `http://xxx.xxx.x.xxx:4135/webhooks`, Port: 4135, Methods: GET, POST).
+#### *Image Message*
 
-## 📩 Sending Messages
+```js
+wa.image("text", {
+  image: "https://github.com/zeative.png",
+  text: "Here your logo",
+})
+```
 
-### Basic Text Messages
+#### *Sticker Message*
 
-Send simple or advanced text messages with options like replies or forwarding.
+```js
+wa.sticker("text", {
+  sticker: "https://example.com/file.webp"
+})
+```
 
-```ts
-const roomId = ctx.roomId;
-const message = ctx.message;
+#### *Video Message*
 
-/* sending text  */
-wa.text("Hello", { roomId });
+```js
+wa.video("text", {
+  video: "https://example.com/file.mp4",
+  text: "Here your logo",
+})
+```
 
-/* sending reply  */
-wa.text("Reply", { roomId, quoted: message });
+#### *Audio Message*
 
-/* sending forwarded  */
-wa.text("Forwarded", { roomId, asForwarded: true });
+```js
+wa.audio("text", {
+  audio: "https://example.com/file.mp3",
+  text: "Here your logo",
+})
+```
+
+#### *Voice Message*
+
+```js
+wa.voice("text", {
+  audio: "https://example.com/file.ogg"
+})
+```
 
-/* fake verified (just work on reply message only!)  */
-wa.text("Verified reply", { roomId, quoted: message, verifiedReply: "whatsapp" });
+#### *View Once Message*
+
+```js
+wa.image("text", {
+  image: "https://github.com/zeative.png",
+  text: "Here your logo",
+  viewOnce: true
+})
+
+wa.video("text", {
+  ...,
+  viewOnce: true
+})
+
+wa.voice("text", {
+  ...,
+  viewOnce: true
+})
+```
 
-/* mark as ai (just work on private message only!)  */
-wa.text("Mark AI Message!", { roomId, asAI: true });
+#### *Note Message*
 
-/* sending view once */
-wa.text({ image: "https://example.com/image.png", text: "View once" }, { roomId, asViewOnce: true });
+```js
+wa.note("text", {
+  video: "https://example.com/file.mp4"
+})
 ```
 
-### Message Reactions, Edits, and Deletion
+#### *Gif Message*
 
-Add reactions, edit, or delete messages.
+```js
+wa.gif("text", {
+  video: "https://example.com/file.gif"
+})
+```
 
-```ts
-/* sending reaction */
-wa.reaction("👍", { message });
+#### *Location Message*
 
-/* sending edit */
-const original = await wa.text("Will edit", { roomId });
-wa.edit("Edited", { message: original?.message });
+```js
+wa.location('text', {
+  latitude: 1115,
+  longitude: -2225,
+  title: "Test location title",
+  footer: "Test location footer",
+})
+```
 
-/* sending delete */
-const original = await wa.text("Will delete", { roomId });
-wa.delete("Deleted", { message: original?.message });
+#### *Contacts Message*
+
+```js
+wa.contacts('text', {
+  title: "Test contacts title",
+  contacts: [
+    {
+      fullname: "zaadevofc",
+      nickname: "kejaa",
+      phoneNumber: 628123456789,
+      website: "https://github.com/zaadevofc",
+    },
+  ],
+})
 ```
 
-### Polls
+#### *Polling Message*
+
+```js
+wa.poll('text', {
+  action: "create",
+  name: "Test poll",
+  answers: [
+    "Option 1",
+    "Option 2",
+  ],
+})
+```
 
-Create interactive polls.
+#### *Button Message*
+
+simple button schema:
+
+```js
+wa.button("text", {
+  type: "simple",
+  text: "Test button",
+  footer: "Test button footer",
+  buttons: [
+    {
+      id: "1",
+      text: "Test button 1",
+    },
+    {
+      id: "2",
+      text: "Test button 2",
+    }
+  ]D
+})
+```
 
-```ts
-/* sending polling */
-wa.poll({ name: "Do you love me?", answers: ["Yes", "Maybe", "No"] }, { roomId });
+interactive button schema:
+
+```js
+wa.button("text", {
+  type: "interactive",
+  text: "Test button",
+  footer: "Test button footer",
+  buttons: [
+    {
+      id: "1",
+      type: "quick_reply",
+      text: "Reply button",
+    },
+    {
+      id: "2",
+      type: "cta_copy",
+      text: "Copy button",
+      copy: "this is form copy",
+    },
+    {
+      id: "3",
+      type: "cta_call",
+      text: "Test Call",
+      phoneNumber: "628123456789",
+    },
+    {
+      id: "4",
+      type: "cta_url",
+      text: "Visit Url",
+      url: "https://github.com/zeative",
+    }
+  ]
+})
 ```
 
-### Contacts
+### `Group Control`
 
-Share contact information.
+#### *Group Create*
 
-```ts
-/* sending contact */
-wa.contact({ fullname: "Kejaa", whatsAppNumber: 628123456789 }, { roomId });
+```js
+wa.group().create({
+  title: "Test New Group",
+  members: ["628123456789@s.whatsapp.net"],
+})
 ```
 
-### Location
+#### *Group Action*
 
-Share geographic coordinates.
+add new member to group:
 
-```ts
-/* sending location */
-wa.location({ latitude: 24.121231, longitude: 55.1121221 }, { roomId });
+```js
+wa.group().action({
+  action: "add",
+  roomId: "123456789@g.us",
+  members: ["628123456789@s.whatsapp.net"],
+})
 ```
 
-## 🖼 Sending Media
+checkout others action: `add` | `kick` | `promote` | `demote`
 
-### Images and Stickers
+#### *Group Update*
 
-Send images or stickers from URLs or local files.
+update group subject:
 
-```ts
-import fs from "fs";
+```js
+wa.group().update({
+  action: "subject",
+  roomId: "123456789@g.us",
+  text: "Test New Group Title",
+})
+```
+
+checkout others action: `subject` | `description`
 
-/* sending by url */
-wa.text({ image: "https://github.com/zeative.png", text: "Image" }, { roomId });
+#### *Group Settings*
 
-/* sending by file */
-wa.text({ image: fs.readFileSync("example/image.png"), text: "Image" }, { roomId });
+setting group only admin can send message:
 
-/* sending sticker */
-wa.text({ sticker: "https://github.com/zeative.png" }, { roomId });
+```js
+wa.group().settings({
+  action: "close",
+  roomId: "123456789@g.us"
+})
 ```
 
-### Videos and GIFs
+checkout others action: `open` | `close` | `lock` | `unlock`
 
-Send videos or GIFs with optional captions.
+#### *Group Leave*
 
-```ts
-/* sending video */
-wa.text({ video: "https://example.com/video.mp4", text: "Video" }, { roomId });
+leave group:
+
+```js
+wa.group().leave({
+  roomId: "123456789@g.us"
+})
+```
 
-/* sending video as circle */
-wa.text({ note: "https://example.com/video.mp4", text: "Video" }, { roomId });
+#### *Group Invite*
 
-/* sending gif */
-wa.text({ gif: "https://example.com/video.mp4" }, { roomId });
+join group chat by url:
+
+```js
+wa.group().invite({
+  url: "https://chat.whatsapp.com/xxxxxx",
+  action: "join",
+})
+```
+
+checkout others action: `join` | `info`
+
+#### *Group Metadata*
+
+get group metadata:
+
+```js
+wa.group().metadata({
+  roomId: "123456789@g.us",
+})
+```
+
+#### *Group Requests*
+
+get request join list:
+
+```js
+wa.group().requests.list({
+  roomId: "123456789@g.us",
+})
 ```
 
-### Audio and Voice Notes
+approve request join:
 
-Send audio files or voice notes (use `.ogg` for compatibility).
+```js
+wa.group().requests.approve({
+  roomId: "123456789@g.us",
+  members: ["628123456789@s.whatsapp.net"],
+})
+```
 
-```ts
-/* sending audio (recommended use .ogg format) */
-wa.text({ audio: "https://example.com/audio.ogg" }, { roomId });
+reject request join:
 
-/* sending voice note (recommended use .ogg format) */
-wa.text({ voice: "https://example.com/audio.ogg" }, { roomId });
+```js
+wa.group().requests.reject({
+  roomId: "123456789@g.us",
+  members: ["628123456789@s.whatsapp.net"],
+})
 ```
 
-## 🔧 Advanced Actions
+### `Privacy Control`
 
-### Presence Updates
+#### *Privacy Update*
 
-Update the bot’s presence status in a chat.
+update profile picture privacy:
 
-```ts
-wa.presence("typing", { roomId }); // Options: typing, recording, online, offline, paused
+```js
+wa.privacy().update({
+  action: "avatar",
+  type: "all"
+})
 ```
 
-### Profile Retrieval
+checkout others type: `avatar` | `groupsAdd` | `lastSeen` | `online` | `read` | `story`
+
+#### *Privacy Fetch*
 
-Fetch user or group profiles.
+get blocklists user:
 
-```ts
-wa.profile("628123456789@s.whatsapp.net"); // User profile
-wa.profile("1209999@g.us"); // Group profile
+```js
+wa.privacy().fetch.blocklists()
 ```
 
-## 🐛 Issues & Feedback
+get my settings:
 
-Encounter a bug or have a feature request? Submit it on our [GitHub Issues](https://github.com/zeative/zaileys/issues) page.
+```js
+wa.privacy().fetch.settings()
+```
 
-## ❤️ Support
+### `Profile Control`
 
-Show your support for Zaileys:
+#### *Profile Bio*
 
-- [Buy me a coffee ☕](https://saweria.co/zaadevofc)
-- ⭐ Star the repository on [GitHub](https://github.com/zeative/zaileys)
+get user bio:
+
+```js
+wa.profile().bio({ senderId: ctx.senderId })
+```
 
-## 📜 License
+#### *Profile Avatar*
 
-Zaileys is licensed under the [MIT License](https://github.com/zeative/zaileys/blob/main/LICENSE).
+get user/group avatar:
 
-## 🙌 Acknowledgements
+```js
+wa.profile().avatar({ senderId: ctx.senderId })
+// or group
+wa.profile().avatar({ senderId: ctx.roomId })
+```
+
+#### *Profile Business*
+
+get user business:
+
+```js
+wa.profile().business({ senderId: ctx.senderId })
+```
+
+#### *Profile Update*
+
+```js
+wa.profile().update({
+  type: 'avatar',
+  avatar: 'https://github.com/zeative.png',
+})
+```
+
+checkout others type: `avatar` | `bio` | `name`
+
+#### *Profile Check*
+
+```js
+wa.profile().check({ senderId: ctx.senderId })
+```
+
+### 💠 Issues & Feedback
+
+**If you encounter any problems or have feature requests, please open an [issue](https://github.com/zeative/zaileys/issues)**
+
+- [Buy me a coffee ☕](https://saweria.co/zaadevofc)
+- [Ko-Fi](https://ko-fi.com/zaadevofc)
+- [Trakteer](https://trakteer.id/zaadevofc)
+- ⭐ Star the repo on GitHub
 
-Powered by [Baileys](https://github.com/WhiskeySockets/Baileys) from Whiskey Sockets.
+### 💠 License
 
-Happy coding! 🚀
+Distributed under the **MIT License**. See [`LICENSE`](https://github.com/zeative/zaileys/blob/main/LICENSE) for details.