@spatulox/simplediscordbot 2.1.0 → 2.1.1

package/dist/index.d.mts

@@ -208,6 +208,71 @@ declare class FileManager {
     static deleteFile(filePath: string): Promise<boolean>;
 }
 
+declare class CacheManager {
+    private static get cacheDir();
+    private static cleanCacheId;
+    private static createFilePath;
+    /**
+     * New file with cache_id as name
+     * @param cache_id - id which become the cache file name
+     * @param initialData - optional initial data
+     * @returns true if success, false otherwise
+     */
+    static createCache(cache_id: string, initialData?: any): Promise<boolean>;
+    /**
+     * Read cache data or create empty one
+     * @param cache_id
+     * @param default_data default data with default key/value This will be send back if the cache doesn't exist and need to be created
+     * @returns true if success, false otherwise
+     */
+    static getOrCreateCache<T = any>(cache_id: string, default_data: T): Promise<T | false>;
+    /**
+     * Read cache data
+     * @param cache_id - cache_id to read
+     * @returns Json data, false otherwise
+     */
+    static readCache<T = any>(cache_id: string): Promise<T | false>;
+    /**
+     * Overwrite cache data with the new data
+     * @param cache_id - ID of the cache
+     * @param data - new data
+     * @returns true if success, false otherwise
+     */
+    static writeCache(cache_id: string, data: any): Promise<boolean>;
+    /**
+     * Update specific property of the cache
+     * @param cache_id - ID of the cache
+     * @param property - property to update, with key and value
+     * @returns true if success, false otherwise
+     */
+    static updateCacheProperty(cache_id: string, property: {
+        key: string;
+        value: any;
+    }): Promise<boolean>;
+    /**
+     * Reset an entire cache
+     * @param cache_id - cache ID to reset
+     * @returns true if success, false otherwise
+     */
+    static resetCache(cache_id: string): Promise<boolean>;
+    /**
+     * Delete an entire cache
+     * @param cache_id - cache ID to delete
+     * @returns true if success, false otherwise
+     */
+    static deleteCache(cache_id: string): Promise<boolean>;
+    /**
+     * List every existing cache
+     * @returns Array of cache_id, false otherwise
+     */
+    static listCaches(): Promise<string[] | false>;
+    /**
+     * Clean cache data
+     * @returns true if success, false otherwise
+     */
+    static clearAllCaches(): Promise<boolean>;
+}
+
 declare class EmbedManager {
     private static get BOT_ICON();
     private static get DEFAULT_COLOR();
@@ -1095,4 +1160,4 @@ declare const SimpleDiscordBotInfo: {
     license: string;
 };
 
-export { Bot, type BotConfig, BotEnv, ButtonManager, type ButtonOptions, ComponentManager, type ComponentManagerCreate, type ComponentManagerField, type ComponentManagerFileInput, DiscordRegex, EmbedManager, FileManager, GuildManager, Log, type ModalField, ModalFieldType, ModalManager, type RandomBotActivity, ReactionManager, type SelectMenuCreateOption, type SelectMenuList, SelectMenuManager, SimpleColor, SimpleDiscordBotInfo, SimpleMutex, Time, UserManager, WebhookManager };
+export { Bot, type BotConfig, BotEnv, ButtonManager, type ButtonOptions, CacheManager, ComponentManager, type ComponentManagerCreate, type ComponentManagerField, type ComponentManagerFileInput, DiscordRegex, EmbedManager, FileManager, GuildManager, Log, type ModalField, ModalFieldType, ModalManager, type RandomBotActivity, ReactionManager, type SelectMenuCreateOption, type SelectMenuList, SelectMenuManager, SimpleColor, SimpleDiscordBotInfo, SimpleMutex, Time, UserManager, WebhookManager };

package/dist/index.d.ts

@@ -208,6 +208,71 @@ declare class FileManager {
     static deleteFile(filePath: string): Promise<boolean>;
 }
 
+declare class CacheManager {
+    private static get cacheDir();
+    private static cleanCacheId;
+    private static createFilePath;
+    /**
+     * New file with cache_id as name
+     * @param cache_id - id which become the cache file name
+     * @param initialData - optional initial data
+     * @returns true if success, false otherwise
+     */
+    static createCache(cache_id: string, initialData?: any): Promise<boolean>;
+    /**
+     * Read cache data or create empty one
+     * @param cache_id
+     * @param default_data default data with default key/value This will be send back if the cache doesn't exist and need to be created
+     * @returns true if success, false otherwise
+     */
+    static getOrCreateCache<T = any>(cache_id: string, default_data: T): Promise<T | false>;
+    /**
+     * Read cache data
+     * @param cache_id - cache_id to read
+     * @returns Json data, false otherwise
+     */
+    static readCache<T = any>(cache_id: string): Promise<T | false>;
+    /**
+     * Overwrite cache data with the new data
+     * @param cache_id - ID of the cache
+     * @param data - new data
+     * @returns true if success, false otherwise
+     */
+    static writeCache(cache_id: string, data: any): Promise<boolean>;
+    /**
+     * Update specific property of the cache
+     * @param cache_id - ID of the cache
+     * @param property - property to update, with key and value
+     * @returns true if success, false otherwise
+     */
+    static updateCacheProperty(cache_id: string, property: {
+        key: string;
+        value: any;
+    }): Promise<boolean>;
+    /**
+     * Reset an entire cache
+     * @param cache_id - cache ID to reset
+     * @returns true if success, false otherwise
+     */
+    static resetCache(cache_id: string): Promise<boolean>;
+    /**
+     * Delete an entire cache
+     * @param cache_id - cache ID to delete
+     * @returns true if success, false otherwise
+     */
+    static deleteCache(cache_id: string): Promise<boolean>;
+    /**
+     * List every existing cache
+     * @returns Array of cache_id, false otherwise
+     */
+    static listCaches(): Promise<string[] | false>;
+    /**
+     * Clean cache data
+     * @returns true if success, false otherwise
+     */
+    static clearAllCaches(): Promise<boolean>;
+}
+
 declare class EmbedManager {
     private static get BOT_ICON();
     private static get DEFAULT_COLOR();
@@ -1095,4 +1160,4 @@ declare const SimpleDiscordBotInfo: {
     license: string;
 };
 
-export { Bot, type BotConfig, BotEnv, ButtonManager, type ButtonOptions, ComponentManager, type ComponentManagerCreate, type ComponentManagerField, type ComponentManagerFileInput, DiscordRegex, EmbedManager, FileManager, GuildManager, Log, type ModalField, ModalFieldType, ModalManager, type RandomBotActivity, ReactionManager, type SelectMenuCreateOption, type SelectMenuList, SelectMenuManager, SimpleColor, SimpleDiscordBotInfo, SimpleMutex, Time, UserManager, WebhookManager };
+export { Bot, type BotConfig, BotEnv, ButtonManager, type ButtonOptions, CacheManager, ComponentManager, type ComponentManagerCreate, type ComponentManagerField, type ComponentManagerFileInput, DiscordRegex, EmbedManager, FileManager, GuildManager, Log, type ModalField, ModalFieldType, ModalManager, type RandomBotActivity, ReactionManager, type SelectMenuCreateOption, type SelectMenuList, SelectMenuManager, SimpleColor, SimpleDiscordBotInfo, SimpleMutex, Time, UserManager, WebhookManager };

package/dist/index.js

@@ -863,11 +863,11 @@ var require_baseGet = __commonJS({
     "use strict";
     var castPath = require_castPath();
     var toKey = require_toKey();
-    function baseGet(object, path2) {
-      path2 = castPath(path2, object);
-      var index = 0, length = path2.length;
+    function baseGet(object, path3) {
+      path3 = castPath(path3, object);
+      var index = 0, length = path3.length;
       while (object != null && index < length) {
-        object = object[toKey(path2[index++])];
+        object = object[toKey(path3[index++])];
       }
       return index && index == length ? object : void 0;
     }
@@ -880,8 +880,8 @@ var require_get = __commonJS({
   "node_modules/lodash/get.js"(exports2, module2) {
     "use strict";
     var baseGet = require_baseGet();
-    function get2(object, path2, defaultValue) {
-      var result = object == null ? void 0 : baseGet(object, path2);
+    function get2(object, path3, defaultValue) {
+      var result = object == null ? void 0 : baseGet(object, path3);
       return result === void 0 ? defaultValue : result;
     }
     module2.exports = get2;
@@ -4984,6 +4984,7 @@ __export(index_exports, {
   Bot: () => Bot,
   BotEnv: () => BotEnv,
   ButtonManager: () => ButtonManager,
+  CacheManager: () => CacheManager,
   ComponentManager: () => ComponentManager,
   DiscordRegex: () => DiscordRegex,
   EmbedManager: () => EmbedManager,
@@ -14329,7 +14330,7 @@ var BotInteraction = class {
 // package.json
 var package_default = {
   name: "@spatulox/simplediscordbot",
-  version: "2.0.3",
+  version: "2.1.0",
   author: "Spatulox",
   description: "Simple discord bot framework to set up a bot under 30 secondes",
   exports: {
@@ -14617,10 +14618,186 @@ var FileManager = class {
   }
 };
 
+// src/manager/CacheManager.ts
+var import_path2 = __toESM(require("path"));
+var CacheManager = class {
+  static get cacheDir() {
+    return import_path2.default.join(process.cwd(), `.${Bot.config?.botName ?? "simplediscordbot"}cache`);
+  }
+  static cleanCacheId(key) {
+    return key.replace(/[^a-zA-Z0-9_-]/g, "_");
+  }
+  static createFilePath(filename) {
+    return import_path2.default.join(this.cacheDir, `${filename}.json`);
+  }
+  /**
+   * New file with cache_id as name
+   * @param cache_id - id which become the cache file name
+   * @param initialData - optional initial data
+   * @returns true if success, false otherwise
+   */
+  static async createCache(cache_id, initialData = {}) {
+    if (!cache_id || typeof cache_id !== "string" || cache_id.trim() === "") {
+      Bot.log.error('"Key" to create a cache must be a non-empty string');
+      return false;
+    }
+    const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+    Bot.log.info(`Creating cache file: ${cleanCacheId}.json`);
+    return await FileManager.writeJsonFile(
+      this.cacheDir,
+      this.cleanCacheId(cache_id),
+      initialData,
+      true
+    );
+  }
+  /**
+   * Read cache data or create empty one
+   * @param cache_id
+   * @param default_data default data with default key/value This will be send back if the cache doesn't exist and need to be created
+   * @returns true if success, false otherwise
+   */
+  static async getOrCreateCache(cache_id, default_data) {
+    if (!cache_id || typeof cache_id !== "string" || cache_id.trim() === "") {
+      Log.error('"cache_id" to get or create a cache must be a non-empty string');
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    const filePath = this.createFilePath(cleanCacheId);
+    if (await FileManager.fileExists(filePath)) {
+      Log.info(`Cache already exists: ${cleanCacheId}.json`);
+      return FileManager.readJsonFile(filePath);
+    }
+    Log.info(`Creating new cache file: ${this.cacheDir}/${cleanCacheId}.json`);
+    const res = await FileManager.writeJsonFile(
+      this.cacheDir,
+      cleanCacheId,
+      default_data,
+      false
+    );
+    return res ? default_data : false;
+  }
+  /**
+   * Read cache data
+   * @param cache_id - cache_id to read
+   * @returns Json data, false otherwise
+   */
+  static async readCache(cache_id) {
+    if (!cache_id || typeof cache_id !== "string") {
+      Bot.log.error('"Key" must be a string');
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    const filePath = this.createFilePath(cleanCacheId);
+    if (!await FileManager.fileExists(filePath)) {
+      Log.debug(`Cache not found: ${cleanCacheId}.json`);
+      return false;
+    }
+    return await FileManager.readJsonFile(filePath);
+  }
+  /**
+   * Overwrite cache data with the new data
+   * @param cache_id - ID of the cache
+   * @param data - new data
+   * @returns true if success, false otherwise
+   */
+  static async writeCache(cache_id, data) {
+    if (!cache_id || typeof cache_id !== "string") {
+      Log.error("Cache ID must be a string");
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    Bot.log.info(`Writing to cache: ${cleanCacheId}.json`);
+    return await FileManager.writeJsonFile(
+      this.cacheDir,
+      cleanCacheId,
+      data,
+      true
+    );
+  }
+  /**
+   * Update specific property of the cache
+   * @param cache_id - ID of the cache
+   * @param property - property to update, with key and value
+   * @returns true if success, false otherwise
+   */
+  static async updateCacheProperty(cache_id, property) {
+    const cacheData = await this.readCache(cache_id);
+    if (cacheData === false) {
+      Log.error(`Cache ${cache_id} not found`);
+      return false;
+    }
+    cacheData[property.key] = property.value;
+    return await this.writeCache(cache_id, cacheData);
+  }
+  /**
+   * Reset an entire cache
+   * @param cache_id - cache ID to reset
+   * @returns true if success, false otherwise
+   */
+  static async resetCache(cache_id) {
+    try {
+      const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+      await this.writeCache(cache_id, {});
+      Log.info(`Reset cache: ${cleanCacheId}.json`);
+      return true;
+    } catch (error) {
+      Log.error(`Failed to reset cache ${cache_id}: ${error}`);
+      return false;
+    }
+  }
+  /**
+   * Delete an entire cache
+   * @param cache_id - cache ID to delete
+   * @returns true if success, false otherwise
+   */
+  static async deleteCache(cache_id) {
+    try {
+      const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+      const filePath = this.createFilePath(cleanCacheId);
+      if (await FileManager.deleteFile(filePath)) {
+        Log.info(`Deleted cache: ${cleanCacheId}.json`);
+        return true;
+      }
+      return false;
+    } catch (error) {
+      Log.error(`Failed to delete cache ${cache_id}: ${error}`);
+      return false;
+    }
+  }
+  /**
+   * List every existing cache
+   * @returns Array of cache_id, false otherwise
+   */
+  static async listCaches() {
+    return await FileManager.listJsonFiles(this.cacheDir);
+  }
+  /**
+   * Clean cache data
+   * @returns true if success, false otherwise
+   */
+  static async clearAllCaches() {
+    try {
+      const caches = await this.listCaches();
+      if (caches === false || caches.length === 0) {
+        return true;
+      }
+      let success = true;
+      for (const cache of caches) {
+        const result = await this.deleteCache(cache.replace(".json", ""));
+        if (!result) success = false;
+      }
+      return success;
+    } catch (error) {
+      Log.error(`Failed to clear caches: ${error}`);
+      return false;
+    }
+  }
+};
+
 // src/manager/messages/WebhookManager.ts
 var import_discord7 = require("discord.js");
 var import_promises2 = require("fs/promises");
-var import_path2 = require("path");
+var import_path3 = require("path");
 var WebhookManager = class {
   constructor(client, name, avatarPathOrUrl) {
     this.client = client;
@@ -14634,7 +14811,7 @@ var WebhookManager = class {
       return this.avatarPathOrUrl;
     }
     try {
-      const resolvedPath = (0, import_path2.resolve)(process.cwd(), this.avatarPathOrUrl);
+      const resolvedPath = (0, import_path3.resolve)(process.cwd(), this.avatarPathOrUrl);
       return await (0, import_promises2.readFile)(resolvedPath);
     } catch (error) {
       Bot.log.warn(`Failed to load avatar from ${this.avatarPathOrUrl}: ${error}`);
@@ -16238,6 +16415,7 @@ var SimpleMutex = class {
   Bot,
   BotEnv,
   ButtonManager,
+  CacheManager,
   ComponentManager,
   DiscordRegex,
   EmbedManager,

package/dist/index.mjs

@@ -857,11 +857,11 @@ var require_baseGet = __commonJS({
     "use strict";
     var castPath = require_castPath();
     var toKey = require_toKey();
-    function baseGet(object, path2) {
-      path2 = castPath(path2, object);
-      var index = 0, length = path2.length;
+    function baseGet(object, path3) {
+      path3 = castPath(path3, object);
+      var index = 0, length = path3.length;
       while (object != null && index < length) {
-        object = object[toKey(path2[index++])];
+        object = object[toKey(path3[index++])];
       }
       return index && index == length ? object : void 0;
     }
@@ -874,8 +874,8 @@ var require_get = __commonJS({
   "node_modules/lodash/get.js"(exports, module) {
     "use strict";
     var baseGet = require_baseGet();
-    function get2(object, path2, defaultValue) {
-      var result = object == null ? void 0 : baseGet(object, path2);
+    function get2(object, path3, defaultValue) {
+      var result = object == null ? void 0 : baseGet(object, path3);
       return result === void 0 ? defaultValue : result;
     }
     module.exports = get2;
@@ -14323,7 +14323,7 @@ var BotInteraction = class {
 // package.json
 var package_default = {
   name: "@spatulox/simplediscordbot",
-  version: "2.0.3",
+  version: "2.1.0",
   author: "Spatulox",
   description: "Simple discord bot framework to set up a bot under 30 secondes",
   exports: {
@@ -14611,6 +14611,182 @@ var FileManager = class {
   }
 };
 
+// src/manager/CacheManager.ts
+import path2 from "path";
+var CacheManager = class {
+  static get cacheDir() {
+    return path2.join(process.cwd(), `.${Bot.config?.botName ?? "simplediscordbot"}cache`);
+  }
+  static cleanCacheId(key) {
+    return key.replace(/[^a-zA-Z0-9_-]/g, "_");
+  }
+  static createFilePath(filename) {
+    return path2.join(this.cacheDir, `${filename}.json`);
+  }
+  /**
+   * New file with cache_id as name
+   * @param cache_id - id which become the cache file name
+   * @param initialData - optional initial data
+   * @returns true if success, false otherwise
+   */
+  static async createCache(cache_id, initialData = {}) {
+    if (!cache_id || typeof cache_id !== "string" || cache_id.trim() === "") {
+      Bot.log.error('"Key" to create a cache must be a non-empty string');
+      return false;
+    }
+    const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+    Bot.log.info(`Creating cache file: ${cleanCacheId}.json`);
+    return await FileManager.writeJsonFile(
+      this.cacheDir,
+      this.cleanCacheId(cache_id),
+      initialData,
+      true
+    );
+  }
+  /**
+   * Read cache data or create empty one
+   * @param cache_id
+   * @param default_data default data with default key/value This will be send back if the cache doesn't exist and need to be created
+   * @returns true if success, false otherwise
+   */
+  static async getOrCreateCache(cache_id, default_data) {
+    if (!cache_id || typeof cache_id !== "string" || cache_id.trim() === "") {
+      Log.error('"cache_id" to get or create a cache must be a non-empty string');
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    const filePath = this.createFilePath(cleanCacheId);
+    if (await FileManager.fileExists(filePath)) {
+      Log.info(`Cache already exists: ${cleanCacheId}.json`);
+      return FileManager.readJsonFile(filePath);
+    }
+    Log.info(`Creating new cache file: ${this.cacheDir}/${cleanCacheId}.json`);
+    const res = await FileManager.writeJsonFile(
+      this.cacheDir,
+      cleanCacheId,
+      default_data,
+      false
+    );
+    return res ? default_data : false;
+  }
+  /**
+   * Read cache data
+   * @param cache_id - cache_id to read
+   * @returns Json data, false otherwise
+   */
+  static async readCache(cache_id) {
+    if (!cache_id || typeof cache_id !== "string") {
+      Bot.log.error('"Key" must be a string');
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    const filePath = this.createFilePath(cleanCacheId);
+    if (!await FileManager.fileExists(filePath)) {
+      Log.debug(`Cache not found: ${cleanCacheId}.json`);
+      return false;
+    }
+    return await FileManager.readJsonFile(filePath);
+  }
+  /**
+   * Overwrite cache data with the new data
+   * @param cache_id - ID of the cache
+   * @param data - new data
+   * @returns true if success, false otherwise
+   */
+  static async writeCache(cache_id, data) {
+    if (!cache_id || typeof cache_id !== "string") {
+      Log.error("Cache ID must be a string");
+      return false;
+    }
+    const cleanCacheId = this.cleanCacheId(cache_id);
+    Bot.log.info(`Writing to cache: ${cleanCacheId}.json`);
+    return await FileManager.writeJsonFile(
+      this.cacheDir,
+      cleanCacheId,
+      data,
+      true
+    );
+  }
+  /**
+   * Update specific property of the cache
+   * @param cache_id - ID of the cache
+   * @param property - property to update, with key and value
+   * @returns true if success, false otherwise
+   */
+  static async updateCacheProperty(cache_id, property) {
+    const cacheData = await this.readCache(cache_id);
+    if (cacheData === false) {
+      Log.error(`Cache ${cache_id} not found`);
+      return false;
+    }
+    cacheData[property.key] = property.value;
+    return await this.writeCache(cache_id, cacheData);
+  }
+  /**
+   * Reset an entire cache
+   * @param cache_id - cache ID to reset
+   * @returns true if success, false otherwise
+   */
+  static async resetCache(cache_id) {
+    try {
+      const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+      await this.writeCache(cache_id, {});
+      Log.info(`Reset cache: ${cleanCacheId}.json`);
+      return true;
+    } catch (error) {
+      Log.error(`Failed to reset cache ${cache_id}: ${error}`);
+      return false;
+    }
+  }
+  /**
+   * Delete an entire cache
+   * @param cache_id - cache ID to delete
+   * @returns true if success, false otherwise
+   */
+  static async deleteCache(cache_id) {
+    try {
+      const cleanCacheId = cache_id.replace(/[^a-zA-Z0-9_-]/g, "_");
+      const filePath = this.createFilePath(cleanCacheId);
+      if (await FileManager.deleteFile(filePath)) {
+        Log.info(`Deleted cache: ${cleanCacheId}.json`);
+        return true;
+      }
+      return false;
+    } catch (error) {
+      Log.error(`Failed to delete cache ${cache_id}: ${error}`);
+      return false;
+    }
+  }
+  /**
+   * List every existing cache
+   * @returns Array of cache_id, false otherwise
+   */
+  static async listCaches() {
+    return await FileManager.listJsonFiles(this.cacheDir);
+  }
+  /**
+   * Clean cache data
+   * @returns true if success, false otherwise
+   */
+  static async clearAllCaches() {
+    try {
+      const caches = await this.listCaches();
+      if (caches === false || caches.length === 0) {
+        return true;
+      }
+      let success = true;
+      for (const cache of caches) {
+        const result = await this.deleteCache(cache.replace(".json", ""));
+        if (!result) success = false;
+      }
+      return success;
+    } catch (error) {
+      Log.error(`Failed to clear caches: ${error}`);
+      return false;
+    }
+  }
+};
+
 // src/manager/messages/WebhookManager.ts
 import {
   BaseGuildTextChannel,
@@ -16259,6 +16435,7 @@ export {
   Bot,
   BotEnv,
   ButtonManager,
+  CacheManager,
   ComponentManager,
   DiscordRegex,
   EmbedManager,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spatulox/simplediscordbot",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "author": "Spatulox",
   "description": "Simple discord bot framework to set up a bot under 30 secondes",
   "exports": {