@spatulox/simplediscordbot 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Changelog
 Date format : dd/mm/yyy
 
-### 15/04/2026 - 2.1.0
+
+### 27/04/2026 - 2.2.0
+- Add :
+  - Add a full wiki matching this version
+- Changes:
+  - `DISCORD_BOT_DEV` now enable/disable the Bot.log.debug() / Log.debug()
+  - Removed `DISCORD_BOT_CLIENTID`
+  - Add overloading for `BotMessage.sendDM()` : Should now match all other `send()` from the framework for consistency
+  - Rework the type of `ComponentManagerField` to mandatory/optionally allow the 'name' & 'value' fields (both need to be present (or not) at the same time)
+- Fix :
+  - `Bot.interaction.xxx()` logic : some interaction were enable to pass some requirement because of a wrong check logic
+  - RoleManager : take the member.guild.role instead of member.role to assign an exsiting role to a GuildMember
+
+### 15/04/2026 - 2.1.2
+- CacheManager should now take the botname in lowercase and escape weird char from it
+
+### 15/04/2026 - 2.1.0 & 2.1.1
 - Add a CacheManager for simple persisting data
 - Add QoL method to FileManager (fileExist(), deleteFile())
 - Fix :

package/README.md

@@ -14,19 +14,28 @@
 > - Provides easy Managers to avoid repetitive code everywhere
 > - Simple yet powerful builders (Embeds, Modals, SelectMenus, Components, Buttons) that rely on discord.js for full compatibility
 
+# Don't forget to check the [wiki](https://github.com/spatulox-discord/SimpleDiscordBot/wiki)
 
 ## Installation
 ```bash
-npm i @spatulox/simplediscordbot
+  npm i @spatulox/simplediscordbot
 ```
 
 ## Quick Start
 
 Env Variables:
-```bash
+```
 DISCORD_BOT_TOKEN="" // Your bot Token
-DISCORD_BOT_CLIENTID="" // Yout bot client id
 ```
+<details>
+    <summary>Note for v2.1.2 and older</summary>
+
+> You also need to set up this env var :
+> ```
+> DISCORD_BOT_CLIENTID="" // You bot ClientID
+> ```
+
+</details>
 
 ```typescript
 import {Bot, BotConfig, SimpleColor, Time} from "@spatulox/simplediscordbot";

package/dist/index.d.mts

@@ -54,7 +54,8 @@ declare class BotMessage {
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content?: string | null, component?: SendableComponent): Promise<Message | null>;
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content: SendableComponent): Promise<Message | null>;
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content: MessageCreateOptions): Promise<Message | null>;
-    static sendDM(user: User | GuildMember | string, content?: string, component?: SendableComponent): Promise<Message | null>;
+    static sendDM(userOrId: User | GuildMember | string, content: string, component: SendableComponent): Promise<Message | null>;
+    static sendDM(userOrId: User | GuildMember | string, content: string | SendableComponent | MessageCreateOptions): Promise<Message | null>;
     /**
      * Quick success message
      */
@@ -79,7 +80,7 @@ declare class BotInteraction {
     static reply(interaction: BaseInteraction, content: string, component: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static followUp(interaction: BaseInteraction, content: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static followUp(interaction: BaseInteraction, content: string, component: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
-    static defer(interaction: BaseInteraction): Promise<void>;
+    static defer(interaction: BaseInteraction): Promise<InteractionResponse<boolean> | void>;
     static update(interaction: BaseInteraction, content: SendableComponent): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static update(interaction: BaseInteraction, content: string, component: SendableComponent): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
 }
@@ -129,9 +130,7 @@ type BotConfig = {
     botName?: string;
     log?: ConfigLog;
 };
-type InternalBotConfig = {
-    clientId: string;
-} & BotConfig;
+type InternalBotConfig = {} & BotConfig;
 type RandomBotActivity = {
     type: ActivityType;
     message: string;
@@ -147,7 +146,7 @@ declare class Bot {
     get client(): Client;
     static get client(): Client;
     static get config(): InternalBotConfig;
-    constructor(client: Client, config: BotConfig);
+    constructor(client: Client, config?: BotConfig);
     login(maxTries?: number): Promise<boolean>;
     static setActivity(message: string, type: ActivityType): void;
     static setRandomActivity(randomActivity: RandomBotActivity, intervalMs?: number | null): void;
@@ -156,7 +155,6 @@ declare class Bot {
 declare const BotEnv: {
     readonly token: string;
     readonly dev: boolean;
-    readonly clientId: string;
 };
 
 declare class FileManager {
@@ -755,18 +753,24 @@ declare class SelectMenuManager {
     private static _createRowsToReturn;
 }
 
-interface BasicComponentManagerField {
-    name?: string;
-    value: string;
+type OptionalText = {
     separator?: SeparatorSpacingSize | false;
-}
-interface ComponentManagerFieldThumbnail extends BasicComponentManagerField {
+    name?: never;
+    value?: never;
+};
+type RequiredText = {
+    separator?: SeparatorSpacingSize | false;
+    name: string;
+    value: string;
+};
+type BasicComponentManagerField = OptionalText | RequiredText;
+type ComponentManagerFieldThumbnail = RequiredText & {
     thumbnailUrl: string;
-}
-interface ComponentManagerFieldAccessory extends BasicComponentManagerField {
+};
+type ComponentManagerFieldAccessory = BasicComponentManagerField & {
     button: ButtonBuilder | ButtonBuilder[];
-}
-type ComponentManagerField = ComponentManagerFieldAccessory | ComponentManagerFieldThumbnail | BasicComponentManagerField;
+};
+type ComponentManagerField = (ComponentManagerFieldAccessory | ComponentManagerFieldThumbnail | BasicComponentManagerField);
 interface ComponentManagerCreate {
     title?: string | null;
     description?: string | null;

package/dist/index.d.ts

@@ -54,7 +54,8 @@ declare class BotMessage {
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content?: string | null, component?: SendableComponent): Promise<Message | null>;
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content: SendableComponent): Promise<Message | null>;
     static send(channel: TextChannel | DMChannel | ThreadChannel | string, content: MessageCreateOptions): Promise<Message | null>;
-    static sendDM(user: User | GuildMember | string, content?: string, component?: SendableComponent): Promise<Message | null>;
+    static sendDM(userOrId: User | GuildMember | string, content: string, component: SendableComponent): Promise<Message | null>;
+    static sendDM(userOrId: User | GuildMember | string, content: string | SendableComponent | MessageCreateOptions): Promise<Message | null>;
     /**
      * Quick success message
      */
@@ -79,7 +80,7 @@ declare class BotInteraction {
     static reply(interaction: BaseInteraction, content: string, component: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static followUp(interaction: BaseInteraction, content: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static followUp(interaction: BaseInteraction, content: string, component: SendableComponent, ephemeral?: boolean): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
-    static defer(interaction: BaseInteraction): Promise<void>;
+    static defer(interaction: BaseInteraction): Promise<InteractionResponse<boolean> | void>;
     static update(interaction: BaseInteraction, content: SendableComponent): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
     static update(interaction: BaseInteraction, content: string, component: SendableComponent): Promise<InteractionResponse<boolean> | Message<boolean> | boolean>;
 }
@@ -129,9 +130,7 @@ type BotConfig = {
     botName?: string;
     log?: ConfigLog;
 };
-type InternalBotConfig = {
-    clientId: string;
-} & BotConfig;
+type InternalBotConfig = {} & BotConfig;
 type RandomBotActivity = {
     type: ActivityType;
     message: string;
@@ -147,7 +146,7 @@ declare class Bot {
     get client(): Client;
     static get client(): Client;
     static get config(): InternalBotConfig;
-    constructor(client: Client, config: BotConfig);
+    constructor(client: Client, config?: BotConfig);
     login(maxTries?: number): Promise<boolean>;
     static setActivity(message: string, type: ActivityType): void;
     static setRandomActivity(randomActivity: RandomBotActivity, intervalMs?: number | null): void;
@@ -156,7 +155,6 @@ declare class Bot {
 declare const BotEnv: {
     readonly token: string;
     readonly dev: boolean;
-    readonly clientId: string;
 };
 
 declare class FileManager {
@@ -755,18 +753,24 @@ declare class SelectMenuManager {
     private static _createRowsToReturn;
 }
 
-interface BasicComponentManagerField {
-    name?: string;
-    value: string;
+type OptionalText = {
     separator?: SeparatorSpacingSize | false;
-}
-interface ComponentManagerFieldThumbnail extends BasicComponentManagerField {
+    name?: never;
+    value?: never;
+};
+type RequiredText = {
+    separator?: SeparatorSpacingSize | false;
+    name: string;
+    value: string;
+};
+type BasicComponentManagerField = OptionalText | RequiredText;
+type ComponentManagerFieldThumbnail = RequiredText & {
     thumbnailUrl: string;
-}
-interface ComponentManagerFieldAccessory extends BasicComponentManagerField {
+};
+type ComponentManagerFieldAccessory = BasicComponentManagerField & {
     button: ButtonBuilder | ButtonBuilder[];
-}
-type ComponentManagerField = ComponentManagerFieldAccessory | ComponentManagerFieldThumbnail | BasicComponentManagerField;
+};
+type ComponentManagerField = (ComponentManagerFieldAccessory | ComponentManagerFieldThumbnail | BasicComponentManagerField);
 interface ComponentManagerCreate {
     title?: string | null;
     description?: string | null;