@botgate/sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BotGate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+# @botgate/sdk
+
+SDK oficial do BotGate para integrar as configurações do Dashboard diretamente no seu bot.
+
+## Instalação
+
+```bash
+npm install @botgate/sdk
+```
+
+---
+
+## Como funciona
+
+Quando um dono de servidor configura seu bot pelo **BotGate Dashboard**, as preferências dele (prefixo, canal de boas-vindas, etc.) ficam salvas no banco de dados do BotGate.
+
+Esta lib permite que **o seu bot leia essas configs em tempo real**, com cache local automático para não sobrecarregar a API.
+
+---
+
+## Uso rápido
+
+```ts
+import { BotGateSDK } from "@botgate/sdk";
+
+// 1. Inicializar uma vez (no arquivo principal do bot)
+const botgate = new BotGateSDK({
+  apiKey: "sua-api-key-do-botgate",
+  debug: true, // opcional: mostra logs no console
+});
+
+// 2. Usar em qualquer evento
+client.on("messageCreate", async (message) => {
+  if (!message.guild) return;
+
+  // Busca configs do servidor (com cache de 5 minutos automático)
+  const settings = await botgate.getGuildSettings(message.guild.id);
+
+  const prefix = settings.prefix ?? "!";
+  if (!message.content.startsWith(prefix)) return;
+
+  // ... lógica do seu bot
+  console.log(`Prefixo usado: ${prefix}`);
+});
+
+// 3. Módulo de boas-vindas
+client.on("guildMemberAdd", async (member) => {
+  const settings = await botgate.getGuildSettings(member.guild.id);
+
+  if (!settings.welcome_enabled) return;
+
+  const channel = member.guild.channels.cache.get(
+    settings.welcome_channel_id ?? "",
+  );
+  if (!channel?.isTextBased()) return;
+
+  const msg = (settings.welcome_message ?? "Bem-vindo, {user}!").replace(
+    "{user}",
+    member.toString(),
+  );
+
+  channel.send(msg);
+});
+
+// 4. Módulo de logs de auditoria
+client.on("messageDelete", async (message) => {
+  if (!message.guild) return;
+  const settings = await botgate.getGuildSettings(message.guild.id);
+
+  if (!settings.logs_enabled) return;
+
+  const logChannel = message.guild.channels.cache.get(
+    settings.logs_channel_id ?? "",
+  );
+  if (!logChannel?.isTextBased()) return;
+
+  logChannel.send(
+    `🗑️ Mensagem deletada em ${message.channel}: ${message.content}`,
+  );
+});
+```
+
+---
+
+## Configurações disponíveis
+
+| Campo                | Tipo      | Descrição                                            |
+| -------------------- | --------- | ---------------------------------------------------- |
+| `prefix`             | `string`  | Prefixo dos comandos do bot                          |
+| `welcome_enabled`    | `boolean` | Liga/desliga o módulo de boas-vindas                 |
+| `welcome_channel_id` | `string`  | ID do canal de boas-vindas                           |
+| `welcome_message`    | `string`  | Mensagem personalizada. Use `{user}` para mencionar. |
+| `logs_enabled`       | `boolean` | Liga/desliga o módulo de auditoria                   |
+| `logs_channel_id`    | `string`  | ID do canal de logs                                  |
+
+---
+
+## API
+
+### `new BotGateSDK(config)`
+
+| Opção      | Tipo      | Padrão  | Descrição                                    |
+| ---------- | --------- | ------- | -------------------------------------------- |
+| `apiKey`   | `string`  | —       | API Key do bot no BotGate (**obrigatório**)  |
+| `cacheTtl` | `number`  | `300`   | Segundos que as configs ficam em cache local |
+| `debug`    | `boolean` | `false` | Ativa logs detalhados no console             |
+
+### `getGuildSettings(guildId, forceRefresh?)`
+
+Busca as configs de um servidor. Retorna `{}` vazio se o servidor ainda não foi configurado (nunca vai quebrar o bot).
+
+```ts
+const settings = await botgate.getGuildSettings("123456789");
+```
+
+### `clearCache(guildId?)`
+
+Limpa o cache de um servidor específico ou de todos.
+
+```ts
+botgate.clearCache("123456789"); // limpa um servidor
+botgate.clearCache(); // limpa tudo
+```
+
+---
+
+## Licença
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Configurações de inicialização do SDK
+ */
+export interface BotGateSdkConfig {
+    /** API Key do bot no BotGate (obrigatório) */
+    apiKey: string;
+    /** URL base da API do BotGate (opcional, padrão: produção) */
+    apiUrl?: string;
+    /**
+     * Tempo em segundos que as configs de um servidor ficam em cache local.
+     * Evita requisições repetidas. (padrão: 300 = 5 minutos)
+     */
+    cacheTtl?: number;
+    /** Ativar logs de debug no console (padrão: false) */
+    debug?: boolean;
+}
+/**
+ * Configurações de um servidor salvas pelo usuário no BotGate Dashboard
+ */
+export interface GuildSettings {
+    /** Prefixo do bot para esse servidor */
+    prefix?: string;
+    /** Módulo de boas-vindas ativo? */
+    welcome_enabled?: boolean;
+    /** ID do canal de boas-vindas */
+    welcome_channel_id?: string;
+    /** Mensagem personalizada de boas-vindas. Use {user} para mencionar. */
+    welcome_message?: string;
+    /** Módulo de logs de auditoria ativo? */
+    logs_enabled?: boolean;
+    /** ID do canal de logs */
+    logs_channel_id?: string;
+    /** Qualquer outra config futura (extensível) */
+    [key: string]: unknown;
+}
+/**
+ * Cliente do BotGate SDK para leitura de configurações de servidores.
+ *
+ * @example
+ * ```ts
+ * import { BotGateSDK } from '@botgate/sdk';
+ *
+ * const botgate = new BotGateSDK({ apiKey: 'sua-api-key' });
+ *
+ * client.on('messageCreate', async (message) => {
+ *   const settings = await botgate.getGuildSettings(message.guild.id);
+ *   const prefix = settings.prefix ?? '!';
+ *
+ *   if (!message.content.startsWith(prefix)) return;
+ *   // ... lógica do bot
+ * });
+ * ```
+ */
+export declare class BotGateSDK {
+    private http;
+    private cache;
+    private defaultTtl;
+    private debug;
+    constructor(config: BotGateSdkConfig);
+    /**
+     * Busca as configurações de um servidor específico.
+     *
+     * As configs são cacheadas localmente por `cacheTtl` segundos
+     * para evitar sobrecarga da API em servidores movimentados.
+     *
+     * @param guildId - ID do servidor Discord
+     * @param forceRefresh - Ignorar cache e buscar da API agora (padrão: false)
+     */
+    getGuildSettings(guildId: string, forceRefresh?: boolean): Promise<GuildSettings>;
+    /**
+     * Limpa o cache de um servidor específico.
+     * Útil para forçar a releitura após mudanças manuais.
+     *
+     * @param guildId - ID do servidor. Se omitido, limpa todo o cache.
+     */
+    clearCache(guildId?: string): void;
+    /**
+     * Retorna quantos servidores estão com cache ativo no momento.
+     */
+    getCacheSize(): number;
+    private getCached;
+    private setCache;
+    private log;
+}
+export default BotGateSDK;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC;IAEf,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,sDAAsD;IACtD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,mCAAmC;IACnC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iCAAiC;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wEAAwE;IACxE,eAAe,CAAC,EAAE,MAAM,CAAC;IAGzB,yCAAyC;IACzC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,gDAAgD;IAChD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AA+BD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAU;gBAEX,MAAM,EAAE,gBAAgB;IAqBpC;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,OAAO,EAAE,MAAM,EACf,YAAY,UAAQ,GACnB,OAAO,CAAC,aAAa,CAAC;IAuCzB;;;;;OAKG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAUzC;;OAEG;IACI,YAAY,IAAI,MAAM;IAM7B,OAAO,CAAC,SAAS;IAajB,OAAO,CAAC,QAAQ;IAYhB,OAAO,CAAC,GAAG;CAKZ;AAED,eAAe,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotGateSDK = void 0;
+const axios_1 = __importDefault(require("axios"));
+// ─────────────────────────────────────────────────────────
+// Classe principal
+// ─────────────────────────────────────────────────────────
+/**
+ * Cliente do BotGate SDK para leitura de configurações de servidores.
+ *
+ * @example
+ * ```ts
+ * import { BotGateSDK } from '@botgate/sdk';
+ *
+ * const botgate = new BotGateSDK({ apiKey: 'sua-api-key' });
+ *
+ * client.on('messageCreate', async (message) => {
+ *   const settings = await botgate.getGuildSettings(message.guild.id);
+ *   const prefix = settings.prefix ?? '!';
+ *
+ *   if (!message.content.startsWith(prefix)) return;
+ *   // ... lógica do bot
+ * });
+ * ```
+ */
+class BotGateSDK {
+    constructor(config) {
+        var _a, _b, _c;
+        this.cache = new Map();
+        if (!config.apiKey) {
+            throw new Error("[BotGate SDK] apiKey é obrigatório.");
+        }
+        this.defaultTtl = ((_a = config.cacheTtl) !== null && _a !== void 0 ? _a : 300) * 1000; // converte para ms
+        this.debug = (_b = config.debug) !== null && _b !== void 0 ? _b : false;
+        this.http = axios_1.default.create({
+            baseURL: (_c = config.apiUrl) !== null && _c !== void 0 ? _c : "https://api.botgate.coden8n.shop",
+            timeout: 8000,
+            headers: {
+                Authorization: `Bearer ${config.apiKey}`,
+                "Content-Type": "application/json",
+                "User-Agent": "BotGate-SDK/1.0.0",
+            },
+        });
+        this.log("✅ BotGate SDK inicializado.");
+    }
+    /**
+     * Busca as configurações de um servidor específico.
+     *
+     * As configs são cacheadas localmente por `cacheTtl` segundos
+     * para evitar sobrecarga da API em servidores movimentados.
+     *
+     * @param guildId - ID do servidor Discord
+     * @param forceRefresh - Ignorar cache e buscar da API agora (padrão: false)
+     */
+    async getGuildSettings(guildId, forceRefresh = false) {
+        // 1. Verificar cache
+        if (!forceRefresh) {
+            const cached = this.getCached(guildId);
+            if (cached) {
+                this.log(`📦 Cache hit para guild ${guildId}`);
+                return cached;
+            }
+        }
+        // 2. Buscar na API
+        this.log(`🌐 Buscando settings para guild ${guildId} na API...`);
+        try {
+            const response = await this.http.get(`/api/dashboard/sdk/guilds/${guildId}/settings`);
+            if (!response.data.success || !response.data.data) {
+                this.log(`⚠️ API retornou falha para guild ${guildId}.`);
+                return {};
+            }
+            const { settings, cacheTtl } = response.data.data;
+            // 3. Salvar no cache
+            this.setCache(guildId, settings, cacheTtl * 1000);
+            this.log(`✅ Settings carregados para guild ${guildId}.`);
+            return settings;
+        }
+        catch (error) {
+            this.log(`❌ Erro ao buscar settings para guild ${guildId}: ${error.message}`);
+            // Retorna objeto vazio para não quebrar o bot por uma falha de rede
+            return {};
+        }
+    }
+    /**
+     * Limpa o cache de um servidor específico.
+     * Útil para forçar a releitura após mudanças manuais.
+     *
+     * @param guildId - ID do servidor. Se omitido, limpa todo o cache.
+     */
+    clearCache(guildId) {
+        if (guildId) {
+            this.cache.delete(guildId);
+            this.log(`🗑️ Cache limpo para guild ${guildId}`);
+        }
+        else {
+            this.cache.clear();
+            this.log("🗑️ Cache global limpo.");
+        }
+    }
+    /**
+     * Retorna quantos servidores estão com cache ativo no momento.
+     */
+    getCacheSize() {
+        return this.cache.size;
+    }
+    // ─── Privados ───────────────────────────────────────────
+    getCached(guildId) {
+        const entry = this.cache.get(guildId);
+        if (!entry)
+            return null;
+        const expired = Date.now() - entry.fetchedAt > entry.ttl;
+        if (expired) {
+            this.cache.delete(guildId);
+            return null;
+        }
+        return entry.settings;
+    }
+    setCache(guildId, settings, ttlMs) {
+        this.cache.set(guildId, {
+            settings,
+            fetchedAt: Date.now(),
+            ttl: ttlMs || this.defaultTtl,
+        });
+    }
+    log(message) {
+        if (this.debug) {
+            console.log(`[BotGate SDK] [${new Date().toISOString()}] ${message}`);
+        }
+    }
+}
+exports.BotGateSDK = BotGateSDK;
+exports.default = BotGateSDK;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AA4E7C,4DAA4D;AAC5D,mBAAmB;AACnB,4DAA4D;AAE5D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,UAAU;IAMrB,YAAY,MAAwB;;QAJ5B,UAAK,GAA4B,IAAI,GAAG,EAAE,CAAC;QAKjD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,CAAC,MAAA,MAAM,CAAC,QAAQ,mCAAI,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,mBAAmB;QACtE,IAAI,CAAC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAC;QAEnC,IAAI,CAAC,IAAI,GAAG,eAAK,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,kCAAkC;YAC5D,OAAO,EAAE,IAAI;YACb,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,MAAM,CAAC,MAAM,EAAE;gBACxC,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,mBAAmB;aAClC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,gBAAgB,CAC3B,OAAe,EACf,YAAY,GAAG,KAAK;QAEpB,qBAAqB;QACrB,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,GAAG,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAC;gBAC/C,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QAED,mBAAmB;QACnB,IAAI,CAAC,GAAG,CAAC,mCAAmC,OAAO,YAAY,CAAC,CAAC;QAEjE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,6BAA6B,OAAO,WAAW,CAChD,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClD,IAAI,CAAC,GAAG,CAAC,oCAAoC,OAAO,GAAG,CAAC,CAAC;gBACzD,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAElD,qBAAqB;YACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,oCAAoC,OAAO,GAAG,CAAC,CAAC;YAEzD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,CAAC,GAAG,CACN,wCAAwC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;YACF,oEAAoE;YACpE,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAgB;QAChC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,2DAA2D;IAEnD,SAAS,CAAC,OAAe;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC;QACzD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAEO,QAAQ,CACd,OAAe,EACf,QAAuB,EACvB,KAAa;QAEb,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE;YACtB,QAAQ;YACR,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,GAAG,EAAE,KAAK,IAAI,IAAI,CAAC,UAAU;SAC9B,CAAC,CAAC;IACL,CAAC;IAEO,GAAG,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;CACF;AArID,gCAqIC;AAED,kBAAe,UAAU,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@botgate/sdk",
+  "version": "1.0.0",
+  "description": "SDK oficial do BotGate para integrar configurações de servidor no seu bot.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "discord",
+    "bot",
+    "botgate",
+    "sdk",
+    "config",
+    "dashboard"
+  ],
+  "author": "BotGate",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  }
+}