@spatulox/simplediscordbot 2.2.1 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
-Date format : dd/mm/yyy
-
+Date format : dd/mm/yyyy
+
+### 28/04/2026 - 2.2.1
+- Changes :
+  - Add dependency to @spatulox/utils
+    - `Time/Log/SimpleMutex` are now part of the `@spatulox/utils` package but are still reexported from this package
+    - `FileManager/CacheManager` are now part of the `@spatulox/utils` package but are still reexported from this package
+  - CacheManager now have a fixed cache folder `.utilscache`
+  - The `sendErrorToChannel` param of FileManager.writeJsonFile() have been removed
 
 ### 27/04/2026 - 2.2.1
 - Add :

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { EmbedBuilder, ContainerBuilder, ActionRowBuilder, MessageActionRowComponentBuilder, Message, TextChannel, DMChannel, ThreadChannel, MessageCreateOptions, User, GuildMember, BaseInteraction, InteractionResponse, Client, ActivityType, InteractionDeferReplyOptions, InteractionReplyOptions, InteractionEditReplyOptions, Snowflake, WebhookMessageCreateOptions, EmojiResolvable, Guild, BanOptions, GuildBasedChannel, GuildChannelCreateOptions, ForumChannel, NewsChannel, StageChannel, StartThreadOptions, VoiceChannel, Invite, Channel, Collection, GuildBan, ModalBuilder, StringSelectMenuBuilder, UserSelectMenuBuilder, RoleSelectMenuBuilder, MentionableSelectMenuBuilder, ChannelSelectMenuBuilder, ChannelType, SeparatorSpacingSize, ButtonBuilder, AttachmentBuilder, ButtonStyle } from 'discord.js';
 import { BaseSelectMenuBuilder } from '@discordjs/builders';
+export { CacheManager, FileManager, Log, SimpleMutex, Time } from '@spatulox/utils';
 
 type SendableComponent = EmbedBuilder | ContainerBuilder | BaseSelectMenuBuilder<any> | ActionRowBuilder<MessageActionRowComponentBuilder>;
 
@@ -157,120 +158,6 @@ declare const BotEnv: {
     readonly dev: boolean;
 };
 
-declare class FileManager {
-    /**
-     * Check if a file exist
-     * @param filePath File path with file name
-     * @returns true si le fichier existe, false sinon
-     */
-    static fileExists(filePath: string): Promise<boolean>;
-    /**
-     * Reads a JSON file synchronously.
-     * @param filePath Full path to the JSON file
-     * @returns Parsed JSON object or 'Error' string on failure
-     */
-    static readJsonFile<T = any>(filePath: string): Promise<T | false>;
-    /**
-     * Lists all directories in a given path.
-     * @param directoryPath Path to scan for directories
-     * @returns Array of directory names or false on error
-     */
-    static listDirectories(directoryPath: string): Promise<string[] | false>;
-    /**
-     * Lists all JSON files in a directory.
-     * @param directoryPath Path to scan for JSON files
-     * @returns Array of JSON filenames or false on error
-     */
-    static listJsonFiles(directoryPath: string): Promise<string[] | false>;
-    /**
-     * Lists files with specific extension in a directory.
-     * @param directoryPath Path to scan
-     * @param extension File extension (with or without dot)
-     * @returns Array of matching filenames or 'Error' string on failure
-     */
-    static listFiles(directoryPath: string, extension: string): Promise<string[] | false>;
-    /**
-     * Creates directory structure and writes JSON data to file.
-     * @param directoryPath Full directory path (creates if missing)
-     * @param filename Filename without extension
-     * @param data Data to write (JSON serializable)
-     * @param sendErrorToErrorChannel Send error to the error channel
-     * @returns true on success, false on failure
-     */
-    static writeJsonFile(directoryPath: string, filename: string, data: any, sendErrorToErrorChannel?: boolean): Promise<boolean>;
-    /**
-     * Delete a file
-     * @param filePath Full file path
-     * @returns true si supprimé avec succès, false sinon
-     */
-    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();
@@ -878,217 +765,6 @@ declare class ButtonManager {
     private static createRowsToReturn;
 }
 
-declare class UnitTime {
-    private readonly val;
-    constructor(val: number);
-    toMilliseconds(): number;
-    toSeconds(): number;
-    toMinutes(): number;
-    toHours(): number;
-    toDays(): number;
-    toString(): string;
-    valueOf(): number;
-    value(): number;
-}
-declare const Time: {
-    milisecond: {
-        MS_100: UnitTime;
-        MS_200: UnitTime;
-        MS_500: UnitTime;
-        MS_800: UnitTime;
-        MS_1000: UnitTime;
-    };
-    second: {
-        SEC_01: UnitTime;
-        SEC_02: UnitTime;
-        SEC_03: UnitTime;
-        SEC_04: UnitTime;
-        SEC_05: UnitTime;
-        SEC_06: UnitTime;
-        SEC_07: UnitTime;
-        SEC_08: UnitTime;
-        SEC_09: UnitTime;
-        SEC_10: UnitTime;
-        SEC_11: UnitTime;
-        SEC_12: UnitTime;
-        SEC_13: UnitTime;
-        SEC_14: UnitTime;
-        SEC_15: UnitTime;
-        SEC_16: UnitTime;
-        SEC_17: UnitTime;
-        SEC_18: UnitTime;
-        SEC_19: UnitTime;
-        SEC_20: UnitTime;
-        SEC_21: UnitTime;
-        SEC_22: UnitTime;
-        SEC_23: UnitTime;
-        SEC_24: UnitTime;
-        SEC_25: UnitTime;
-        SEC_26: UnitTime;
-        SEC_27: UnitTime;
-        SEC_28: UnitTime;
-        SEC_29: UnitTime;
-        SEC_30: UnitTime;
-        SEC_31: UnitTime;
-        SEC_32: UnitTime;
-        SEC_33: UnitTime;
-        SEC_34: UnitTime;
-        SEC_35: UnitTime;
-        SEC_36: UnitTime;
-        SEC_37: UnitTime;
-        SEC_38: UnitTime;
-        SEC_39: UnitTime;
-        SEC_40: UnitTime;
-        SEC_41: UnitTime;
-        SEC_42: UnitTime;
-        SEC_43: UnitTime;
-        SEC_44: UnitTime;
-        SEC_45: UnitTime;
-        SEC_46: UnitTime;
-        SEC_47: UnitTime;
-        SEC_48: UnitTime;
-        SEC_49: UnitTime;
-        SEC_50: UnitTime;
-        SEC_51: UnitTime;
-        SEC_52: UnitTime;
-        SEC_53: UnitTime;
-        SEC_54: UnitTime;
-        SEC_55: UnitTime;
-        SEC_56: UnitTime;
-        SEC_57: UnitTime;
-        SEC_58: UnitTime;
-        SEC_59: UnitTime;
-        SEC_60: UnitTime;
-    };
-    minute: {
-        MIN_01: UnitTime;
-        MIN_02: UnitTime;
-        MIN_03: UnitTime;
-        MIN_04: UnitTime;
-        MIN_05: UnitTime;
-        MIN_06: UnitTime;
-        MIN_07: UnitTime;
-        MIN_08: UnitTime;
-        MIN_09: UnitTime;
-        MIN_10: UnitTime;
-        MIN_11: UnitTime;
-        MIN_12: UnitTime;
-        MIN_13: UnitTime;
-        MIN_14: UnitTime;
-        MIN_15: UnitTime;
-        MIN_16: UnitTime;
-        MIN_17: UnitTime;
-        MIN_18: UnitTime;
-        MIN_19: UnitTime;
-        MIN_20: UnitTime;
-        MIN_21: UnitTime;
-        MIN_22: UnitTime;
-        MIN_23: UnitTime;
-        MIN_24: UnitTime;
-        MIN_25: UnitTime;
-        MIN_26: UnitTime;
-        MIN_27: UnitTime;
-        MIN_28: UnitTime;
-        MIN_29: UnitTime;
-        MIN_30: UnitTime;
-        MIN_31: UnitTime;
-        MIN_32: UnitTime;
-        MIN_33: UnitTime;
-        MIN_34: UnitTime;
-        MIN_35: UnitTime;
-        MIN_36: UnitTime;
-        MIN_37: UnitTime;
-        MIN_38: UnitTime;
-        MIN_39: UnitTime;
-        MIN_40: UnitTime;
-        MIN_41: UnitTime;
-        MIN_42: UnitTime;
-        MIN_43: UnitTime;
-        MIN_44: UnitTime;
-        MIN_45: UnitTime;
-        MIN_46: UnitTime;
-        MIN_47: UnitTime;
-        MIN_48: UnitTime;
-        MIN_49: UnitTime;
-        MIN_50: UnitTime;
-        MIN_51: UnitTime;
-        MIN_52: UnitTime;
-        MIN_53: UnitTime;
-        MIN_54: UnitTime;
-        MIN_55: UnitTime;
-        MIN_56: UnitTime;
-        MIN_57: UnitTime;
-        MIN_58: UnitTime;
-        MIN_59: UnitTime;
-        MIN_60: UnitTime;
-    };
-    hour: {
-        HOUR_01: UnitTime;
-        HOUR_02: UnitTime;
-        HOUR_03: UnitTime;
-        HOUR_04: UnitTime;
-        HOUR_05: UnitTime;
-        HOUR_06: UnitTime;
-        HOUR_07: UnitTime;
-        HOUR_08: UnitTime;
-        HOUR_09: UnitTime;
-        HOUR_10: UnitTime;
-        HOUR_11: UnitTime;
-        HOUR_12: UnitTime;
-        HOUR_13: UnitTime;
-        HOUR_14: UnitTime;
-        HOUR_15: UnitTime;
-        HOUR_16: UnitTime;
-        HOUR_17: UnitTime;
-        HOUR_18: UnitTime;
-        HOUR_19: UnitTime;
-        HOUR_20: UnitTime;
-        HOUR_21: UnitTime;
-        HOUR_22: UnitTime;
-        HOUR_23: UnitTime;
-        HOUR_24: UnitTime;
-    };
-    day: {
-        DAY_01: UnitTime;
-        DAY_02: UnitTime;
-        DAY_03: UnitTime;
-        DAY_04: UnitTime;
-        DAY_05: UnitTime;
-        DAY_06: UnitTime;
-        DAY_07: UnitTime;
-        DAY_08: UnitTime;
-        DAY_09: UnitTime;
-        DAY_10: UnitTime;
-    };
-    readonly DAY: boolean;
-    readonly NIGHT: boolean;
-};
-
-declare class Log {
-    private static getPrefix;
-    static info(message: string): void;
-    static warn(message: string): void;
-    static error(message: string): void;
-    static debug(message: string): void;
-    static table(data: Record<string, any>[]): void;
-}
-
-declare class SimpleMutex {
-    private _locked;
-    private queue;
-    constructor();
-    /**
-     * Verrouille le mutex. Si le mutex est déjà verrouillé, la méthode retourne une promesse qui sera résolue une fois que le mutex sera disponible.
-     * @returns Une promesse résolue lorsque le mutex est verrouillé.
-     */
-    lock(): Promise<void>;
-    /**
-     * Déverrouille le mutex. Si une file d'attente existe, débloque le prochain élément dans la file.
-     */
-    unlock(): void;
-    get locked(): boolean;
-}
-
 /**
  * Classe utilitaire pour valider tous les formats Discord avec regex
  */
@@ -1163,4 +839,4 @@ declare const SimpleDiscordBotInfo: {
     license: string;
 };
 
-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 };
+export { Bot, type BotConfig, BotEnv, ButtonManager, type ButtonOptions, ComponentManager, type ComponentManagerCreate, type ComponentManagerField, type ComponentManagerFileInput, DiscordRegex, EmbedManager, GuildManager, type ModalField, ModalFieldType, ModalManager, type RandomBotActivity, ReactionManager, type SelectMenuCreateOption, type SelectMenuList, SelectMenuManager, SimpleColor, SimpleDiscordBotInfo, UserManager, WebhookManager };