@aidulcandra/simple-wa-bot v21.3.7

simple-wa-bot

By aidulcandra

This module wraps baileys

What's New in 21.x

Bot

• bot.sendLocation()
• bot.addOwner() and bot.removeOwner()
• bot.addPrefix() and bot.removePrefix()
• bot.saveSettings()

Program

• sendMenu() modifier

Config

• displayName property

Message

• message.sender.getPPUrl()
• Saving media messages. Ex: message.image.saveTo(path)
• message.saveTextTo()

Other

• Fix bugs
• Code refactor

Installation

npm install @aidulcandra/simple-wa-bot

Config File

When first run, a config file bot-config.json will be created if not exists. Default config is as follows. You can save this as bot-config.json to configure things beforehand.

{
  // Array of owner/co-owners ids
  "ownerIds": [],

  // Bot's display name / pushname
  "displayName": "SimpleWABot",
  
  // Whether to parse mentions into their usernames
  "parseMentions": true,

  // Whether to keep track of user pushnames and the changes.
  // Will allow you to get a user's pushnames outside the event of receiving their message.
  "recordPushnames": true,

  // Auto read received messages (send double blue-tick mark)
  "autoRead": false,

  // List of prefixes that can be used to invoke commands
  "commandPrefixes": ["/"],

  // Command Menu Template
  "commandMenu": {

    // @categorylist will be replaced by category list
    "menuTemplate": "> COMMAND LIST\n\n@categorylist\n\n_Created by: @aidulcandra_",

    // @category will be replaced by category name, @commandlist will be replaced by the list of the commands
    "categoryTemplate": "[@category]----\n@commandlist\n------------",

    // Separator for each category list
    "categorySeparator": "\n\n",

    // @command will be replaced by command name, @description will be replaced by the description of the command
    "commandTemplate": "`/@command` - @description",

    // Separator for each command item
    "commandSeparator": "\n"
  }
}

Usage

const bot = require("@aidulcandra/simple-wa-bot");

// Receiving exact match of text and replying
bot.receive("Hello").reply("Hi there");

// Receiving text with similarity value (value is 0 thru 1)
bot.receive("Hello").similarity(0.6).reply("Hi there");

// Ignore case
bot.receive("Good morning").ignoreCase().reply("Good morning to you too!");

// Ignore case and check similarity
bot.receive("How are you?").ignoreCase().similarity(0.7).reply("I'm fine");

// Reply with image
bot
  .receive("send pic")
  .reply() // Insert string for caption
  .image("https://url.to/your/image");
// Or path to your local image

// Multi input (will respond to either one)
bot.receive(["text1", "text2", "text3"]).reply("Yes");

// Only respond in private chats
bot.receive("hello").privateOnly().reply("hi");

// Only respond in group chats
bot.receive("hello").groupOnly().reply("hi");

// Only respond in specific chat rooms
bot.receive("hello").in("ABCDE@g.us").reply("hi");

// Only respond to specific id(s)
bot.receive("hello").from("6282123456789@s.whatsapp.net").reply("hi");
bot.receive("hello").from("xxx@s.wa.net", "yyy@s.wa.net").reply("hi");
bot
  .receive("hello")
  .from(["6282123456789@s.whatsapp.net", "6282987654321@s.whatsapp.net"])
  .reply("hi");

// Respond to texts beginning with specific substring
bot.receiveBeginning("Do you").ignoreCase().reply("Maybe");

// Respond to texts containing specific substring
bot
  .receiveContaining("ice cream")
  .ignoreCase()
  .reply("Did you say ICE CREAM???");

// Respond to texts ending with specific substring
bot.receiveEnding("?").ignoreCase().reply("You were asking?");

// Testing incoming message on a regex pattern
bot.receive(/Do you know .+ \?/i).reply("No.");

// RegEx pattern matching, use <<number>> to insert captured match (in order starting from 1)
bot.receive(/My name is (\w+)/).reply("Nice to meet you, <<1>>!");

// Custom condition (must input a function)
let isActive = true;
function checkActive() {
  return isActive;
}
bot.receive("hey").if(checkActive).reply("heyo");
bot
  .receive("test")
  .if(function () {
    return true;
  })
  .reply("test back");

// Random reply
bot.receive("Hi").ignoreCase().replyRandom("Hey", "Hello", "Sup?"); // Can input array

// Default response if no programs are executed
bot.defaultResponse("I don't understand.");

// Send

//Don't forget to start the bot after programming responses
bot.start();

// Instead of bot.start(), you can test your bot in the console using this
bot.test();

Custom Script

// Run script
bot.receive("date").run(function (message) {
    const name = message.sender.name
    const date = Date()
    message.reply(`Hello, ${name}! Today's date is ${date}`)
})
// 2nd argument of the run function is the array of captured matches when using regex as input
bot.receive(/my name is (\w+)/i).run(function (message, matches)) {
    message.reply(`Hello, ${matches[0]}!`)
}
// 3rd argument is the group if the message is received in a group
bot.receive("group name").run(function (msg, m, group) {
    msg.reply(`The group name is ${group.name}`)
})
// 4th argument is the bot object
function (msg, m, group, bot) {}

// Can also provide path to module that exports a function
bot.receive("import").run("commands/import.js")
// Inside commands/import.js:
module.exports = async function (msg, m, group) {
    msg.reply("I was called from outside")
}

The message Object's Properties and Methods

message.video? message.video?.getBuffer() message.video?.saveTo(path)|Save the video to path message.audio? message.audio?.getBuffer() message.audio?.saveTo(path)|Save the audio to path message.sticker? message.sticker?.getBuffer() message.sticker?.saveTo(path)|Save the sticker to path message.document? message.document?.getBuffer() message.document?.saveTo(path)|Save the document to path message.mentions | Array of mentioned ids | | message.groupMentions | Array of mentioned group ids | | message.getBaileysMessage() | Get the original baileys' MessageInfo object | | message.reply(text) | Reply to the message | message.reply("Of course") | message.replyImage(source, caption)|Reply with image. source can be a Buffer or a string of url/path message.replyVideo(source, caption)|Reply with video message.replyAudio(source, mimetype?)|Reply with audio. Default mimetype is audio/mp4 message.replySticker(source, options)|Reply with audio. Options: pack = string; author = string; type = 'default'/'crop'/'full'/'circle'/'rounded'; background=hex color string; quality = number message.replyDocument(source, mimetype, fileName, caption)|Reply with a document. message.replyContacts(contacts) | Reply with contact(s). contacts is an array of object {name, number} message.edit(text)|Edit this message (text only) message.forward(to)|Forward this message to target id message.react(emoji)|React to this message|message.react("😂") message.delete()|Delete this message. Remember to delete others' messages the bot needs to be an admin of the group| message.read()|"Read" the message. This will send the double blue-ticks mark to the sender's end. message.saveTextTo(path)|Save the text in the disk

The bot Object's Properties and Methods

Programs

In this module there are types of Programs that can be created using the bot's trigger definers:

• bot.receive(), bot.receiveBeginning(), bot.receiveContaining(), bot.receiveEnding(), bot.receiveAny(), bot.command() and bot.sent() creates an InputReaderProgram
• bot.started() creates a StartupProgram
• bot.schedule() creates a ScheduledProgram

Methods Of Program Object (Program Modifiers)

These modifiers works for all type of Programs

InputReaderProgram's modifiers

Created with bot.receive(), bot.receiveAny(), bot.receiveBeginning(), bot.receiveEnding(), bot.receiveContaining(), bot.sent(). This basically is responding to an incoming message.

ScheduledProgram's modifiers

Created with bot.schedule(). This will trigger the response based on provided interval.

No special modifiers (probably will be added later)

Templating Notation

Command Menu Template

You can use bot.createCommandMenu() to generate menu string for your command list. You can edit the template in the bot-config.json file. See the default template

You can pass in extraCommands as the argument. It is an array of commands ({name, description, category}) that you want to show in the result.

Mentioning

If the message text contains the pattern @phonenumber (ex:@62821234567) it will be automatically converted to a mention.

Baileys' Objects

In case you want to do your own functionality

1. bot.getSocket() : The sock/socket/client object that is typically used in baileys
2. message.getBaileysMessage() : See above in the section about message object