@manybot/manybot 4.0.3 → 4.1.1

package/README.md

@@ -4,15 +4,56 @@
 
 **Just a cool open source WhatsApp bot**
 
-[🇧🇷 Português](README.md) · [🇺🇸 English](README_EN.md)
-
 ![Node.js 18+](https://img.shields.io/badge/Node.js-18+-339933?logo=node.js&logoColor=white)
 ![npm 9+](https://img.shields.io/badge/npm-9+-CB3837?logo=npm&logoColor=white)
 ![GPL v3](https://img.shields.io/badge/License-GPL--v3-blue.svg)
 ![Linux](https://img.shields.io/badge/Linux%20%7C%20Windows-lightgrey)
+![whatsapp-web.js](https://img.shields.io/badge/WhatsApp-25D366?logo=whatsapp&logoColor=white)
+
+</div>
 
 ---
 
-This repository is dedicated to contributions related to the project.
+ManyBot is a free, open source WhatsApp bot built around a modular plugin system. Instead of a monolithic bot with features baked in, ManyBot gives you a lightweight core and lets you pick exactly what you want through plugins - no cloud dependency, no subscription, no black box.
+
+## Requirements
+
+- Node.js >= 18
+- npm
+
+## Getting started
+
+```bash
+npm install -g @manybot/manybot
+npm install -g @manybot/manyplug
+manybot
+```
+
+On first run, a configuration file is created at `~/.manybot/manybot.conf`. Edit it to set up your preferences and list the plugins you want to load.
+
+For detailed setup instructions, see the **[documentation](https://manybot.stxerr.dev/docs/)**.
+
+## Plugins
+
+ManyBot's functionality comes from plugins. Install them with ManyPlug:
+
+```bash
+manyplug install <plugin-name>
+```
+
+Browse available plugins at **[manybot.stxerr.dev/plugins](https://manybot.stxerr.dev/plugins/)**.
+
+Want to build your own? The plugin API lets you add commands and features without touching the bot's core - *documentation coming soon*.
+
+## Contributing
+
+All kinds of contributions are welcome:
+
+- **Bug reports and feature requests**: open an issue on GitHub or Codeberg
+- **Code**: pull requests are welcome on [GitHub](https://github.com/many-bot/manybot) or [Codeberg](https://codeberg.org/many-bot/manybot); patches by email (`devel+manybot@stxerr.dev`) are also accepted - subscribe to the mailing list [here](https://list.stxerr.dev).
+- **Plugins**: submit your plugin to [manyplug-repo](https://github.com/many-bot/manyplug-repo), which has instructions on how to do it
+- **Anything else**: suggestions, translations, documentation fixes - reach out by email or open an issue
+
+## License
 
-website: https://manybot.stxerr.dev
+ManyBot is distributed under the [GNU General Public License v3.0](LICENSE).

package/package.json

@@ -5,7 +5,7 @@
     "name": "SyntaxError!",
     "email": "me@stxerr.dev"
   },
-  "version": "4.0.3",
+  "version": "4.1.1",
   "license": "GPL-3.0-only",
   "private": false,
   "engines": {

package/src/kernel/pluginApi.js

@@ -16,7 +16,6 @@ import { enqueue }                             from "#download";
 import { emptyFolder }                         from "#utils/file";
 import { getChatId }                           from "#utils/getChatId";
 import pkg                                     from "whatsapp-web.js";
-import { client }                              from "#client/whatsappClient";
 
 const { MessageMedia } = pkg;
 
@@ -112,7 +111,7 @@ function buildPluginsApi(pluginRegistry) {
     require(name) {
       const plugin = pluginRegistry.get(name);
       if (!plugin || plugin.status !== "active") {
-        throw new Error(`Plugin dependency "${name}" is not active.`);
+        throw new Error(`Plugin dependency "${name}" does not exist or is not active.`);
       }
       return plugin.exports;
     },
@@ -181,24 +180,35 @@ function chatIdTarget(client, chatId) {
   };
 }
 
-// ── Setup API ────────────────────────────────────────────────────────────────
+// ── Send APIs ────────────────────────────────────────────────────────────────
 
-/**
- * Setup API — without message context.
- * Passed to plugin.setup(ctx) during initialization.
- *
- * @param {import("whatsapp-web.js").Client} client
- * @param {Map<string, any>} pluginRegistry
- * @returns {object}
- */
-export function buildSetupApi(client, pluginRegistry) {
+/** Send to a specific chat by ID. Available in both setup and runtime. */
+function buildSendToApi(client) {
   return {
     sendTo:        (chatId, text)              => client.sendMessage(chatId, text),
     sendImageTo:   (chatId, filePath, caption) => makeSender(chatIdTarget(client, chatId)).image(filePath, caption),
     sendVideoTo:   (chatId, filePath, caption) => makeSender(chatIdTarget(client, chatId)).video(filePath, caption),
     sendAudioTo:   (chatId, filePath)          => makeSender(chatIdTarget(client, chatId)).audio(filePath),
     sendStickerTo: (chatId, source)            => makeSender(chatIdTarget(client, chatId)).sticker(source),
+  };
+}
+
+/** Send to the current chat. Only available in runtime. */
+function buildSendApi(chat) {
+  const sender = makeSender(chat);
+  return {
+    send:        (text)              => sender.text(text),
+    sendImage:   (filePath, caption) => sender.image(filePath, caption),
+    sendVideo:   (filePath, caption) => sender.video(filePath, caption),
+    sendAudio:   (filePath)          => sender.audio(filePath),
+    sendSticker: (source)            => sender.sticker(source),
+  };
+}
 
+// ── Base API (shared between setup and runtime) ───────────────────────────────
+
+function buildBaseApi(client, pluginRegistry) {
+  return {
     log,
     t,
     config:   buildConfigApi(),
@@ -207,6 +217,23 @@ export function buildSetupApi(client, pluginRegistry) {
     download: buildDownloadApi(),
     plugins:  buildPluginsApi(pluginRegistry),
     botId:    client.info?.wid?._serialized ?? null,
+    ...buildSendToApi(client),
+  };
+}
+
+// ── Setup API ────────────────────────────────────────────────────────────────
+
+/**
+ * Setup API — without message context.
+ * Passed to plugin.setup(ctx) during initialization.
+ *
+ * @param {import("whatsapp-web.js").Client} client
+ * @param {Map<string, any>} pluginRegistry
+ * @returns {object}
+ */
+export function buildSetupApi(client, pluginRegistry) {
+  return {
+    ...buildBaseApi(client, pluginRegistry),
   };
 }
 
@@ -224,10 +251,9 @@ export function buildSetupApi(client, pluginRegistry) {
  * @returns {object} ctx
  */
 export function buildApi({ msg, chat, client, pluginRegistry }) {
-
-  const currentSender = makeSender(chat);
-
   return {
+    ...buildBaseApi(client, pluginRegistry),
+    ...buildSendApi(chat),
 
     // ── msg ──────────────────────────────────────────────────
 
@@ -263,6 +289,10 @@ export function buildApi({ msg, chat, client, pluginRegistry }) {
       async reply(text) {
         return msg.reply(text);
       },
+
+      async react(emoji) {
+        return msg.react(emoji);
+      },
     },
 
     // ── chat ─────────────────────────────────────────────────
@@ -272,32 +302,5 @@ export function buildApi({ msg, chat, client, pluginRegistry }) {
       name:    chat.name || chat.id.user,
       isGroup: /@g\.us$/.test(chat.id._serialized),
     },
-
-    // ── send (current chat) ──────────────────────────────────
-
-    send:        (text)              => currentSender.text(text),
-    sendImage:   (filePath, caption) => currentSender.image(filePath, caption),
-    sendVideo:   (filePath, caption) => currentSender.video(filePath, caption),
-    sendAudio:   (filePath)          => currentSender.audio(filePath),
-    sendSticker: (source)            => currentSender.sticker(source),
-
-    // ── sendTo (specific chat) ───────────────────────────────
-
-    sendTo:        (chatId, text)              => client.sendMessage(chatId, text),
-    sendImageTo:   (chatId, filePath, caption) => makeSender(chatIdTarget(client, chatId)).image(filePath, caption),
-    sendVideoTo:   (chatId, filePath, caption) => makeSender(chatIdTarget(client, chatId)).video(filePath, caption),
-    sendAudioTo:   (chatId, filePath)          => makeSender(chatIdTarget(client, chatId)).audio(filePath),
-    sendStickerTo: (chatId, source)            => makeSender(chatIdTarget(client, chatId)).sticker(source),
-
-    // ── system ───────────────────────────────────────────────
-
-    log,
-    t,
-    config:   buildConfigApi(),
-    i18n:     buildI18nApi(),
-    utils:    buildUtilsApi(),
-    download: buildDownloadApi(),
-    plugins:  buildPluginsApi(pluginRegistry),
-    botId: client.info?.wid?._serialized ?? null,
   };
 }