@manybot/manybot 5.0.0 → 5.2.0

package/src/kernel/pluginApi.js

@@ -1,524 +0,0 @@
-/**
- * pluginApi.js
- *
- * Builds the `ctx` object each plugin receives.
- * Plugins can only do what's here — never touch client directly.
- *
- * `chat` is already filtered by kernel (only allowed chats from .conf),
- * so plugins don't need and can't choose destination, unless they use sendTo.
- */
-
-import { logger }                              from "#logger";
-import { t, createPluginT, reloadTranslations,
-         getCurrentLang }                      from "#i18n";
-import { CONFIG, CONFIG_DIR }                  from "#config";
-import { enqueue }                             from "#download";
-import { emptyFolder }                         from "#utils/file";
-import { getChatId }                           from "#utils/getChatId";
-import pkg                                     from "whatsapp-web.js";
-import { mkdirSync }                           from "fs";
-
-const { MessageMedia } = pkg;
-
-// ── Storage API ──────────────────────────────────────────────────────────────
-
-export function buildStorageApi(pluginName) {
-  const dir = path.join(CONFIG_DIR, "data", pluginName);
-  mkdirSync(dir, { recursive: true });
-  
-  return {
-    dir,
-
-    /**
-     * Resolves a path inside data directory.
-     * Make subdirectories automatically.
-     * @param {string} relativePath
-     * @returns {string}
-     */
-    path(relativePath) {
-      const resolved = path.join(dir, relativePath);
-      mkdirSync(path.dirname(resolved), { recursive: true });
-      return resolved;
-    },
-  };
-}
-
-// ── Config API ───────────────────────────────────────────────────────────────
-
-function buildConfigApi() {
-  return {
-    /**
-     * Get a config value with optional default.
-     * @param {string} key
-     * @param {any} [defaultValue]
-     */
-    get(key, defaultValue = null) {
-      return CONFIG[key] ?? defaultValue;
-    },
-
-    /** Full config object — read only. */
-    all: CONFIG,
-  };
-}
-
-// ── i18n API ─────────────────────────────────────────────────────────────────
-
-function buildI18nApi() {
-  return {
-    /** Translate a core key. */
-    t,
-
-    /**
-     * Create a scoped t() for a plugin's own locale files.
-     * @param {string} pluginMetaUrl — pass import.meta.url from the plugin
-     */
-    createT: createPluginT,
-
-    /** Reload all translations (e.g. after language change). */
-    reload: reloadTranslations,
-
-    /** Returns current language code. */
-    getCurrentLang,
-  };
-}
-
-// ── Utils API ────────────────────────────────────────────────────────────────
-
-function buildUtilsApi() {
-  return {
-    /**
-     * Empty a folder's contents without removing the folder itself.
-     * @param {string} folder
-     */
-    emptyFolder,
-
-    /**
-     * Get the serialized chat ID from a chat object.
-     * @param {import("whatsapp-web.js").Chat} chat
-     */
-    getChatId,
-  };
-}
-
-// ── Download API ─────────────────────────────────────────────────────────────
-
-function buildDownloadApi() {
-  return {
-    /**
-     * Enqueue a download work function.
-     * @param {Function} workFn
-     * @param {Function} [errorFn]
-     */
-    enqueue,
-  };
-}
-
-// ── Plugin registry API ──────────────────────────────────────────────────────
-
-function buildPluginsApi(pluginRegistry) {
-  return {
-    /**
-     * Return public API of another plugin, or null if not active.
-     * @param {string} name
-     * @returns {any|null}
-     */
-    get(name) {
-      return pluginRegistry.get(name)?.exports ?? null;
-    },
-
-    /**
-     * Return public API of another plugin, or throw if not active.
-     * Analogous to require() — use when the dependency is mandatory.
-     * @param {string} name
-     * @returns {any}
-     */
-    require(name) {
-      const plugin = pluginRegistry.get(name);
-      if (!plugin || plugin.status !== "active") {
-        throw new Error(`Plugin dependency "${name}" does not exist or is not active.`);
-      }
-      return plugin.exports;
-    },
-
-    /**
-     * Check if a plugin is active.
-     * @param {string} name
-     * @returns {boolean}
-     */
-    exists(name) {
-      return pluginRegistry.get(name)?.status === "active";
-    },
-  };
-}
-
-// ── Log API ──────────────────────────────────────────────────────────────────
-
-const log = {
-  info:    (...a) => logger.info(...a),
-  warn:    (...a) => logger.warn(...a),
-  error:   (...a) => logger.error(...a),
-  success: (...a) => logger.success(...a),
-};
-
-// ── Contact API ──────────────────────────────────────────────────────────────
-
-/**
- * Normalizes a raw whatsapp-web.js Contact into a plain object.
- * Used internally so both ctx.contacts and ctx.msg.getContact()
- * always return the same shape.
- * @param {import("whatsapp-web.js").Contact} c
- * @returns {object}
- */
-function normalizeContact(c) {
-  return {
-    id:           c.id._serialized,
-    number:       c.number,
-    pushname:     c.pushname   ?? null,
-    name:         c.name       ?? null,
-    shortName:    c.shortName  ?? null,
-    isBusiness:   c.isBusiness,
-    isEnterprise: c.isEnterprise,
-    isBlocked:    c.isBlocked,
-    isMe:         c.isMe,
-    isMyContact:  c.isMyContact,
-    isWAContact:  c.isWAContact,
-    isUser:       c.isUser,
-    isGroup:      c.isGroup,
-  };
-}
-
-function buildContactsApi(client) {
-  return {
-    /**
-     * Get a normalized Contact object by ID.
-     * @param {string} contactId — serialized ID (e.g. "5511999999999@c.us")
-     * @returns {Promise<object|null>}
-     */
-    async get(contactId) {
-      try {
-        const c = await client.getContactById(contactId);
-        return normalizeContact(c);
-      } catch {
-        return null;
-      }
-    },
-
-    /**
-     * Get the profile picture URL of a contact.
-     * Respects privacy settings — may return null.
-     * @param {string} contactId
-     * @returns {Promise<string|null>}
-     */
-    async getProfilePicUrl(contactId) {
-      try {
-        const c = await client.getContactById(contactId);
-        return await c.getProfilePicUrl();
-      } catch {
-        return null;
-      }
-    },
-
-    /**
-     * Get the "about" text of a contact.
-     * Returns null if privacy settings block access.
-     * @param {string} contactId
-     * @returns {Promise<string|null>}
-     */
-    async getAbout(contactId) {
-      try {
-        const c = await client.getContactById(contactId);
-        return await c.getAbout();
-      } catch {
-        return null;
-      }
-    },
-  };
-}
-
-// ── Internal media helpers ───────────────────────────────────────────────────
-
-/**
- * @param {string|Buffer} source
- * @param {string} mimetype — required, no ambiguous default
- */
-function mediaFromSource(source, mimetype) {
-  return typeof source === "string"
-    ? MessageMedia.fromFilePath(source)
-    : new MessageMedia(mimetype, source.toString("base64"));
-}
-
-/**
- * Returns send methods bound to a target that exposes `.sendMessage()`.
- * @param {{ sendMessage: Function }} target
- */
-function makeSender(target) {
-  return {
-    async text(content, opts = {}) {
-      return target.sendMessage(content, opts);
-    },
-    async image(filePath, caption = "") {
-      const media = MessageMedia.fromFilePath(filePath);
-      return target.sendMessage(media, { caption });
-    },
-    async video(filePath, caption = "") {
-      const media = MessageMedia.fromFilePath(filePath);
-      return target.sendMessage(media, { caption });
-    },
-    async audio(filePath, { asVoice = true } = {}) {
-      const media = MessageMedia.fromFilePath(filePath);
-      return target.sendMessage(media, { sendAudioAsVoice: asVoice });
-    },
-    async sticker(source) {
-      const media = mediaFromSource(source, "image/webp");
-      return target.sendMessage(media, { sendMediaAsSticker: true });
-    },
-  };
-}
-
-/** Adapts client.sendMessage(chatId, ...) to the makeSender interface. */
-function chatIdTarget(client, chatId) {
-  return {
-    sendMessage: (content, opts) => client.sendMessage(chatId, content, opts),
-  };
-}
-
-// ── Send API ─────────────────────────────────────────────────────────────────
-
-/**
- * Runtime send API — current chat + .to() for other chats.
- *
- * ctx.send.text("oi")
- * ctx.send.image("./foto.jpg", "legenda")
- * ctx.send.to("5511@c.us").text("oi")
- */
-function buildSendApi(chat, client) {
-  const current = makeSender(chat);
-
-  return {
-    send: {
-      text:    (text, opts)        => current.text(text, opts),
-      image:   (filePath, caption) => current.image(filePath, caption),
-      video:   (filePath, caption) => current.video(filePath, caption),
-      audio:   (filePath, opts)    => current.audio(filePath, opts),
-      sticker: (source)            => current.sticker(source),
-
-      /**
-       * Returns a sender bound to another chat.
-       * @param {string} chatId
-       * @returns {{ text, image, video, audio, sticker }}
-       */
-      to: (chatId) => makeSender(chatIdTarget(client, chatId)),
-    },
-  };
-}
-
-/**
- * Setup send API — no current chat, only .to().
- *
- * ctx.send.to(adminChatId).text("bot iniciado")
- */
-function buildSetupSendApi(client) {
-  return {
-    send: {
-      to: (chatId) => makeSender(chatIdTarget(client, chatId)),
-    },
-  };
-}
-
-// ── Events API (setup only) ───────────────────────────────────────────────────
-
-function buildEventsApi(client) {
-  return {
-    /**
-     * Registers a persistent listener for a client event.
-     * Returns an 'off()' function to cancel the listener when the plugin wants.
-     *
-     * @param {string}   event
-     * @param {Function} handler
-     * @returns {Function} off
-     *
-     * @example
-     * const off = ctx.events.on("group_join", (notification) => { ... });
-     * // cancels when the plugin doesn't want anymore:
-     * off();
-     */
-    on(event, handler) {
-      client.on(event, handler);
-      return () => client.off(event, handler);
-    },
-
-    /**
-     * Returns a Promise that resolves on the next ocurrence of the event.
-     * Useful for waiting a specific event without having to manage listeners manually.
-     *
-     * @param {string} event
-     * @returns {Promise<any>}
-     *
-     * @example
-     * const notification = await ctx.events.once("group_join");
-     */
-    once(event) {
-      return new Promise((resolve) => client.once(event, resolve));
-    }
-  };
-}
-
-// ── Base API (shared between setup and runtime) ───────────────────────────────
-
-function buildBaseApi(client, pluginRegistry, pluginName) {
-  const botId = client.info?.wid?._serialized ?? null;
-  if (!botId) logger.warn("[pluginApi] botId is null - client may not be ready yet.");
-
-  return {
-    log,
-    t,
-    config:   buildConfigApi(),
-    i18n:     buildI18nApi(),
-    utils:    buildUtilsApi(),
-    download: buildDownloadApi(),
-    plugins:  buildPluginsApi(pluginRegistry),
-    contacts: buildContactsApi(client),
-    storage:  buildStorageApi(pluginName),
-    botId,
-  };
-}
-
-// ── 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, pluginName) {
-  return {
-    ...buildBaseApi(client, pluginRegistry, pluginName),
-    ...buildSetupSendApi(client),
-    events: buildEventsApi(client),
-  };
-}
-
-// ── Runtime API ──────────────────────────────────────────────────────────────
-
-/**
- * Runtime API — full context with message and chat.
- * Passed to plugin.default(ctx) on every message.
- *
- * @param {object}                            params
- * @param {import("whatsapp-web.js").Message} params.msg
- * @param {import("whatsapp-web.js").Chat}    params.chat
- * @param {import("whatsapp-web.js").Client}  params.client
- * @param {Map<string, any>}                  params.pluginRegistry
- * @returns {object} ctx
- */
-export function buildApi({ msg, chat, client, pluginRegistry }) {
-  const prefix  = CONFIG.CMD_PREFIX ?? "!";
-  const rawArgs = msg.body?.trim().split(/\s+/) ?? [];
-  const command = rawArgs[0]?.toLowerCase().startsWith(prefix)
-    ? rawArgs[0].slice(prefix.length).toLowerCase()
-    : rawArgs[0]?.toLowerCase() ?? "";
-
-  return {
-    ...buildBaseApi(client, pluginRegistry),
-    ...buildSendApi(chat, client),
-
-    // ── msg ──────────────────────────────────────────────────
-
-    msg: {
-      body:       msg.body ?? "",
-      type:       msg.type,
-      fromMe:     msg.fromMe,
-      sender:     msg.author || msg.from,
-      senderName: msg._data?.notifyName || String(msg.from).replace(/(:\d+)?@.*$/, ""),
-
-      /** Command token without prefix (e.g. "play" for "!play foo"). */
-      command,
-
-      /** Arguments after the command token. */
-      args: rawArgs.slice(1),
-
-      /**
-       * Check if message is a given command.
-       * @param {string} cmd — without prefix
-       */
-      is(cmd) {
-        return command === cmd.toLowerCase();
-      },
-
-      hasMedia:  msg.hasMedia,
-      isGif:     msg._data?.isGif ?? false,
-
-      async downloadMedia() {
-        const media = await msg.downloadMedia();
-        if (!media) return null;
-        return { mimetype: media.mimetype, data: media.data };
-      },
-
-      hasReply: msg.hasQuotedMsg,
-
-      async getReply() {
-        if (!msg.hasQuotedMsg) return null;
-        return msg.getQuotedMessage();
-      },
-
-      async reply(text) {
-        return msg.reply(text);
-      },
-
-      async react(emoji) {
-        return msg.react(emoji);
-      },
-
-      /**
-       * Get the sender as a normalized Contact object.
-       * Same shape as ctx.contacts.get().
-       * @returns {Promise<object|null>}
-       */
-      async getContact() {
-        try {
-          const c = await msg.getContact();
-          return normalizeContact(c);
-        } catch {
-          return null;
-        }
-      },
-    },
-
-    // ── chat ─────────────────────────────────────────────────
-
-    chat: {
-      id:      chat.id._serialized,
-      name:    chat.name || chat.id.user,
-      isGroup: /@g\.us$/.test(chat.id._serialized),
-
-      /**
-       * List of group participants.
-       * Returns [] for non-group chats.
-       * @returns {Promise<Array<{ id: string, isAdmin: boolean, isSuperAdmin: boolean }>>}
-       */
-      async getParticipants() {
-        if (!chat.participants) return [];
-        return chat.participants.map((p) => ({
-          id:           p.id._serialized,
-          isAdmin:      p.isAdmin,
-          isSuperAdmin: p.isSuperAdmin,
-        }));
-      },
-
-      /**
-       * Check if a contact is an admin of this group.
-       * Always returns false for non-group chats.
-       * @param {string} contactId
-       * @returns {Promise<boolean>}
-       */
-      async isAdmin(contactId) {
-        return chat.participants?.some(
-          (p) => p.id._serialized === contactId && (p.isAdmin || p.isSuperAdmin)
-        ) ?? false;
-      },
-    },
-  };
-}

package/src/kernel/pluginGuard.js

@@ -1,37 +0,0 @@
-/**
- * pluginGuard.js
- *
- * Runs a plugin safely.
- * If plugin throws an error:
- *   - Logs error with context
- *   - Marks plugin as "error" in registry
- *   - Never crashes the bot
- *
- * Disabled or errored plugins are silently ignored.
- */
-
-import { logger }         from "#logger";
-import { t }              from "#i18n";
-import { pluginRegistry } from "#kernel/pluginLoader";
-
-/**
- * @param {object} plugin   — pluginRegistry entry
- * @param {object} context  — buildApi ctx
- */
-export async function runPlugin(plugin, context) {
-  if (plugin.status !== "active") return;
-
-  try {
-    await plugin.run(context);
-  } catch (err) {
-    // Disable plugin to prevent further breakage
-    plugin.status = "error";
-    plugin.error  = err;
-    pluginRegistry.set(plugin.name, plugin);
-
-    logger.error(
-      t("system.pluginDisabledAfterError", { name: plugin.name, message: err.message }),
-      `\n             ${t("errors.stack")}: ${err.stack?.split("\n")[1]?.trim() ?? ""}`
-    );
-  }
-}

package/src/kernel/pluginLoader.js

@@ -1,134 +0,0 @@
-/**
- * pluginLoader.js
- *
- * Responsible for:
- *   1. Reading active plugins (config.js imports this module and give the list)
- *   2. Loading each plugin from ~/.manybot/plugins folder
- *   3. Registering in pluginRegistry with status and public exports
- *   4. Exposing pluginRegistry to kernel and pluginApi
- *
- */
-
-import fs                from "fs";
-import path              from "path";
-import { logger }        from "#logger";
-import { t }             from "#i18n";
-import { pathToFileURL } from "url";
-import { PATHS }         from "#config";
-import { buildStorageApi } from "#manyapi";
-
-const PLUGINS_DIR = path.join(PATHS.HOME, "plugins");
-
-/**
- * Each entry in registry:
- * {
- *   name:    string,
- *   status:  "active" | "disabled" | "error",
- *   run:     async function({ msg, chat, api }) — plugin default function
- *   exports: any — what plugin exposed via `export const api = { ... }`
- *   error:   Error | null
- * }
- *
- * @type {Map<string, object>}
- */
-export const pluginRegistry = new Map();
-
-/**
- * Load all active plugins listed in `activePlugins`.
- * Called once during bot initialization.
- *
- * @param {string[]} activePlugins — active plugin names (from .conf)
- */
-export async function loadPlugins(activePlugins) {
-  if (!fs.existsSync(PLUGINS_DIR)) {
-    fs.mkdirSync(PLUGINS_DIR, { recursive: true });
-  }
-
-  for (const name of activePlugins) {
-    await loadPlugin(name);
-  }
-
-  const total   = pluginRegistry.size;
-  const ativos  = [...pluginRegistry.values()].filter(p => p.status === "active").length;
-  const erros   = total - ativos;
-
-  logger.success(t("system.pluginsLoaded", {
-    count: ativos,
-    errors: erros ? t("system.pluginsLoadedWithErrors", { count: erros }) : ""
-  }));
-}
-
-/**
- * Call setup(api) on all plugins that export it.
- * Executed once after bot connects to WhatsApp.
- *
- * @param {object} api — api without message context (only sendTo, log, schedule...)
- */
-export async function setupPlugins(baseApi) {
-  for (const plugin of pluginRegistry.values()) {
-    if (plugin.status !== "active" || !plugin.setup) continue;
-    try {
-      const api = { ...baseApi, storage: buildStorageApi(plugin.name) };
-      await plugin.setup(api);
-    } catch (err) {
-      logger.error(t("system.pluginSetupFailed", { name: plugin.name, message: err.message }));
-    }
-  }
-}
-
-async function findPluginPath(name) {
-  // key direto: synt-xerror/figurinha
-  const direct = path.join(PLUGINS_DIR, name, "index.js");
-  if (fs.existsSync(direct)) return direct;
-
-  // nome simples em subdir: plugins/synt-xerror/figurinha
-  if (!fs.existsSync(PLUGINS_DIR)) return null;
-  for (const entry of fs.readdirSync(PLUGINS_DIR, { withFileTypes: true })) {
-    if (!entry.isDirectory()) continue;
-    const nested = path.join(PLUGINS_DIR, entry.name, name, "index.js");
-    if (fs.existsSync(nested)) return nested;
-  }
-
-  return null;
-}
-/**
- * Carrega um único plugin pelo nome.
- * @param {string} name
- */
-async function loadPlugin(name) {
-  const pluginPath = await findPluginPath(name);
-  if (!pluginPath) {
-    logger.warn(t("system.pluginNotFound", { name, path: path.join(PLUGINS_DIR, name) }));
-    pluginRegistry.set(name, { name, status: "disabled", run: null, exports: null, error: null });
-    return;
-  }
-
-  if (!fs.existsSync(pluginPath)) {
-    logger.warn(t("system.pluginNotFound", { name, path: pluginPath }));
-    pluginRegistry.set(name, { name, status: "disabled", run: null, exports: null, error: null });
-    return;
-  }
-
-  try {
-    const mod = await import(pathToFileURL(pluginPath).href);
-
-    // Plugin must export a default function — this is called on every message
-    if (typeof mod.default !== "function") {
-      throw new Error(`Plugin "${name}" does not export a default function`);
-    }
-
-    pluginRegistry.set(name, {
-      name,
-      status:  "active",
-      run:     mod.default,
-      setup:   mod.setup ?? null,     // opcional — chamado uma vez na inicialização
-      exports: mod.api ?? null,
-      error:   null,
-    });
-
-    logger.info(t("system.pluginLoaded", { name }));
-  } catch (err) {
-    logger.error(t("system.pluginLoadFailed", { name, message: err.message }));
-    pluginRegistry.set(name, { name, status: "error", run: null, exports: null, error: err });
-  }
-}