zaileys 1.1.0 → 1.1.2

package/README.md

@@ -20,33 +20,27 @@
 
 > **Zaileys** is a simplified, high-performance wrapper around the Baileys library for building WhatsApp bots and integrations with TypeScript/JavaScript. Designed for simplicity, speed, and scalability—perfect for beginners and pros alike.
 
----
-
 ## 📋 Table of Contents
 
 1. [🚀 Features](#🚀-features)
 2. [💻 Installation](#💻-installation)
 3. [⚡ Quick Start](#⚡-quick-start)
+   - [Simplify Version](#simplify-version)
 4. [🔍 Core Concepts](#🔍-core-concepts)
-   - [Client](#client)
    - [Sessions & Authentication](#sessions--authentication)
-   - [Messages & Events](#messages--events)
    - [Citation Concept](#citation-concept)
-5. [⚙️ Configuration & Options](#⚙️-configuration--options)
-6. [📁 Examples](#📁-examples)
-7. [📢 Event Handling](#📢-event-handling)
-8. [👾 Worker Actions](#👾-worker-actions)
+5. [📁 Examples](#📁-examples)
+6. [📢 Event Handling](#📢-event-handling)
+7. [👾 Worker Actions](#👾-worker-actions)
    - [Sending Messages](#sending-messages)
    - [Sending Media](#sending-media)
    - [Presence Update](#presence-update)
    - [Get Profile](#get-profile)
    - [Reject Call](#reject-call)
-9. [🐞 Issues & Feedback](#🐞-issues--feedback)
-10. [❤️ Funding & Support](#❤️-funding--support)
-11. [📄 License](#📄-license)
-12. [🙏 Acknowledgements](#🙏-acknowledgements)
-
----
+8. [🐞 Issues & Feedback](#🐞-issues--feedback)
+9. [❤️ Funding & Support](#❤️-funding--support)
+10. [📄 License](#📄-license)
+11. [🙏 Acknowledgements](#🙏-acknowledgements)
 
 ## 🚀 Features
 
@@ -57,8 +51,6 @@
 - 📟 **Live QRs**: Automatically generate and display WhatsApp QR codes in terminal.
 - 🛠️ **TypeScript First**: Full type definitions (`.d.ts`) and zero-config TS support.
 
----
-
 ## 💻 Installation
 
 Install with your preferred package manager:
@@ -82,18 +74,16 @@ deno add npm:zaileys
 
 Ensure you are running Node.js **>= 18** as specified in `package.json`.
 
----
-
 ## ⚡ Quick Start
 
 Basic usage of Zaileys based on [`test/example.ts`](https://github.com/zeative/zaileys/blob/main/test/example.ts):
 
 ```ts
 // cjs
-// const Client = require("zaileys");
+// const { Client } = require("zaileys");
 
 // esm
-import Client from "zaileys";
+import { Client } from "zaileys";
 
 // the configuration below is the default
 const wa = new Client({
@@ -146,21 +136,48 @@ wa.on("calls", (ctx) => {
 });
 ```
 
----
+### Simplify Version
 
-## 🔍 Core Concepts
+```js
+// auth with pairing code
+const wa = new Client({
+  phoneNumber: 628123456789,
+  authType: "pairing",
+});
+
+// auth with qr
+const wa = new Client({
+  authType: "qr",
+});
 
-### Client
+wa.on("messages", (ctx) => {
+  wa.reply("hello");
+});
+```
 
-The heart of Zaileys. Use `new Client(options)` to instantiate. It emits events (`messages`, `calls`, `connection`, etc.) and exposes methods (`text`, `reply`, `location`, and more).
+## 📁 Examples
+
+Refer to [`test/example.ts`](https://github.com/zeative/zaileys/blob/main/test/example.ts) for complete example usage.
+
+## 🔍 Core Concepts
 
 ### Sessions & Authentication
 
-Zaileys persists authentication credentials in your specified `session`. Re-running your bot will reuse credentials—no QR scan or pairing code required each time.
+Zaileys persists authentication credentials and session data in a configurable database (`sqlite`, `postgresql`, or `mysql`), ensuring seamless reconnection without repeated QR scans or pairing codes. This database-driven approach enhances flexibility by:
+
+- **Unified Storage**: Store session data and authentication credentials in a single, structured database, enabling easy backup, migration, and scalability.
+- **Flexible Data Management**: Query and manage session data directly via SQL, allowing custom integrations and advanced use cases.
 
-### Messages & Events
+Configure the database in the `Client` options:
 
-All WhatsApp activity is exposed via events. Listen on `messages`, `calls`, `connection`, and more to build reactive bots.
+```js
+const wa = new Client({
+  database: {
+    type: "sqlite", // or 'postgresql' | 'mysql'
+    connection: { url: "./session/zaileys.db" }, // sqlite file path
+  },
+});
+```
 
 #### Citation Concept
 
@@ -193,20 +210,6 @@ wa.on("messages", (ctx) => {
 });
 ```
 
----
-
-## ⚙️ Configuration & Options
-
-Pass low-level Baileys options via `baileysConfig` in your client options for advanced scenarios.
-
----
-
-## 📁 Examples
-
-Refer to [`test/example.ts`](https://github.com/zeative/zaileys/blob/main/test/example.ts) for complete example usage.
-
----
-
 ## 📢 Event Handling
 
 ```js
@@ -220,8 +223,6 @@ wa.on("messages", (ctx) => {});
 wa.on("calls", (ctx) => {});
 ```
 
----
-
 ## 👾 Worker Actions
 
 ### Sending Messages
@@ -255,11 +256,11 @@ wa.reaction("🐞", { message });
 
 // editing message
 const msg1 = await wa.text("Test edit", { roomId });
-await wa.edit("Editing success", { message: msg1?.message });
+wa.edit("Editing success", { message: msg1?.message });
 
 // deleting message
 const msg2 = await wa.text("Test delete", { roomId });
-await wa.delete("Deleting success", { message: msg2?.message });
+wa.delete("Deleting success", { message: msg2?.message });
 
 // sending location message
 wa.location({ latitude: 24.121231, longitude: 55.1121221, ...other }, { roomId });
@@ -271,8 +272,6 @@ wa.contact({ fullname: "Kejaa", whatsAppNumber: 628123456789, ...other }, { room
 wa.poll({ name: "Are you love me?", answers: ["yes", "maybe", "no"] }, { roomId });
 ```
 
----
-
 ### Sending Media
 
 ```js
@@ -302,8 +301,6 @@ wa.text({ audio: "https://qu.ax/oeSCG.ogg" }, { roomId });
 wa.text({ audioNote: "https://qu.ax/oeSCG.ogg" }, { roomId });
 ```
 
----
-
 ### Presence Update
 
 ```js
@@ -312,8 +309,6 @@ wa.text({ audioNote: "https://qu.ax/oeSCG.ogg" }, { roomId });
 wa.presence("typing", { roomId });
 ```
 
----
-
 ### Get Profile
 
 ```js
@@ -324,8 +319,6 @@ wa.profile("6281223456789@s.whatsapp.net");
 wa.profile("1209999@g.us");
 ```
 
----
-
 ### Reject Call
 
 ```js
@@ -337,31 +330,22 @@ wa.on("calls", (ctx) => {
 });
 ```
 
----
-
 ## 🐞 Issues & Feedback
 
 If you encounter any problems or have feature requests, please open an issue:
 [https://github.com/zeative/zaileys/issues](https://github.com/zeative/zaileys/issues)
 
----
-
 ## ❤️ Funding & Support
 
 If you find Zaileys useful, consider supporting development:
 
-- [Buy me a coffee ☕](https://trakteer.id/zaadevofc)
+- [Buy me a coffee ☕](https://saweria.co/zaadevofc)
 - ⭐ Star the repo on GitHub
-- Spread the word
-
----
 
 ## 📄 License
 
 Distributed under the **MIT License**. See [`LICENSE`](https://github.com/zeative/zaileys/blob/main/LICENSE) for details.
 
----
-
 ## 🙏 Acknowledgements
 
 This project stands on the shoulders of the original [Baileys](https://github.com/WhiskeySockets/Baileys) library by Whiskey Sockets. Thank you for your incredible work and inspiration!"