wp-heart

WhatsApp Bot Core Engine

A lightweight, modular WhatsApp bot framework built on Baileys.
Clean client class · Command routing · Session management · Built-in database layer.

Install

npm install wp-heart

Quick Start

const { Client, CommandHandler, Events } = require("wp-heart");

const bot = new Client({
    auth: {
        phoneNumber: "8801XXXXXXXXX",
        usePairingCode: true,
    },
    owner: ["8801XXXXXXXXX"],
});

bot.ev.on(Events.ClientReady, () => console.log("Bot connected!"));

const handler = new CommandHandler(bot, "./commands");
handler.load();

bot.launch();

Example command file:

module.exports = {
    name: "ping",
    category: "info",
    code: async (ctx) => {
        await ctx.reply("pong 🏓");
    }
};

Client Options

new Client({
    auth: {
        dir:              "./auth",       // session folder
        phoneNumber:      "880XXXXXXXXXX", // with country code, no +
        usePairingCode:   true,
        customPairingCode: "ABCD1234",    // optional 8-char code
        useStore:         false,          // persist message store
    },
    connection: {
        browser:      ["MyBot", "Safari", "1.0"],
        version:      null,               // WA version override
        alwaysOnline: false,
        selfReply:    false,
        loggerLevel:  "silent",
    },
    messaging: {
        prefix:   "!",                   // string, string[], or regex
        autoRead: false,
    },
    database: {
        dir: "./database",
    },
    owner: ["880XXXXXXXXXX"],
});

Events

const { Events } = require("wp-heart");

bot.ev.on(Events.ClientReady,    (core)  => { /* connected   */ });
bot.ev.on(Events.MessagesUpsert, (ctx)   => { /* new message */ });
bot.ev.on(Events.GroupJoin,      (event) => { /* joined group */ });
bot.ev.on(Events.UserJoin,       (event) => { /* user joined */ });
bot.ev.on(Events.UserLeave,      (event) => { /* user left   */ });
bot.ev.on(Events.Call,           (call)  => { /* incoming call */ });

Exports

const {
    Client,         // WhatsApp client
    CommandHandler, // Command loader & router
    Config,         // JSON settings reader
    Cooldown,       // Per-user cooldown manager
    Events,         // Event name constants
    Formatter,      // Bold, italic, mono helpers
    MessageType,    // Message type constants
    VCardBuilder,   // Build vCard contacts
    Baileys,        // Raw Baileys exports
    Gktw,           // Utility helpers
} = require("wp-heart");

Requirements

• Node.js v20+
• A real WhatsApp number

License

MIT © SIFAT