@open-discord-bots/framework 0.3.3 → 0.3.4

package/src/api/modules/client.ts

@@ -123,7 +123,7 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
     }
     /**Get all servers the bot is part of. */
     async getGuilds(): Promise<discord.Guild[]> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager() => Unable to use this method. Client isn't initiated yet.")
         if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
         
         return this.client.guilds.cache.map((guild) => guild)
@@ -146,15 +146,15 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
     /**Log-in with a discord auth token. Rejects returns `false` using 'softErrors' on failure. */
     login(softErrors?:boolean): Promise<boolean> {
         return new Promise(async (resolve,reject) => {
-            if (!this.initiated) reject("Client isn't initiated yet!")
-            if (!this.token) reject("Client doesn't have a token!")
+            if (!this.initiated) reject("ODClientManager.login() => Unable to use this method. Client isn't initiated yet.")
+            if (!this.token) reject("ODClientManager.login() => Unable to login, client does not have a token.")
             
             try {
                 this.client.once("clientReady",async () => {
                     this.ready = true
 
                     //set slashCommandManager & contextMenuManager to client applicationCommandManager
-                    if (!this.client.application) throw new ODSystemError("Couldn't get client application for slashCommand & contextMenu managers!")
+                    if (!this.client.application) throw new ODSystemError("ODClientManager.login() => Unable to fetch client application for slashCommand & contextMenu managers.")
                     this.slashCommands.commandManager = this.client.application.commands
                     this.contextMenus.commandManager = this.client.application.commands
                     this.autocompletes.commandManager = this.client.application.commands
@@ -177,10 +177,10 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             }
         })
     }
-    /**A simplified shortcut to get a `discord.User` :) */
+    /**A simplified shortcut to get a `discord.User`. */
     async fetchUser(id:string): Promise<discord.User|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchUser() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchUser() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             return await this.client.users.fetch(id)
@@ -188,10 +188,10 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.Guild` :) */
+    /**A simplified shortcut to get a `discord.Guild`. */
     async fetchGuild(id:string): Promise<discord.Guild|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuild() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuild() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             return await this.client.guilds.fetch(id)
@@ -199,10 +199,10 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.Channel` :) */
+    /**A simplified shortcut to get a `discord.Channel`. */
     async fetchChannel(id:string): Promise<discord.Channel|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchChannel() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchChannel() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             return await this.client.channels.fetch(id)
@@ -210,10 +210,23 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.GuildBasedChannel` :) */
+    /**A simplified shortcut to get a `discord.TextChannel` (guild or DM). */
+    async fetchTextChannel(id:string): Promise<discord.TextChannel|discord.DMChannel|discord.PartialDMChannel|null> {
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchTextChannel() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchTextChannel() => Unable to use this method. Client isn't ready and logged in yet.")
+
+        try{
+            const channel = await this.client.channels.fetch(id)
+            if (!channel || (channel.type != discord.ChannelType.GuildText && channel.type != discord.ChannelType.DM)) return null
+            return channel
+        }catch{
+            return null
+        }
+    }
+    /**A simplified shortcut to get a `discord.GuildBasedChannel`. */
     async fetchGuildChannel(guildId:string|discord.Guild, id:string): Promise<discord.GuildBasedChannel|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuildChannel() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuildChannel() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             const guild = (guildId instanceof discord.Guild) ? guildId : await this.fetchGuild(guildId)
@@ -224,10 +237,10 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.TextChannel` :) */
+    /**A simplified shortcut to get a `discord.TextChannel`. */
     async fetchGuildTextChannel(guildId:string|discord.Guild, id:string): Promise<discord.TextChannel|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuildTextChannel() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuildTextChannel() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             const guild = (guildId instanceof discord.Guild) ? guildId : await this.fetchGuild(guildId)
@@ -239,10 +252,10 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.CategoryChannel` :) */
+    /**A simplified shortcut to get a `discord.CategoryChannel`. */
     async fetchGuildCategoryChannel(guildId:string|discord.Guild, id:string): Promise<discord.CategoryChannel|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuildCategoryChannel() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuildCategoryChannel() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             const guild = (guildId instanceof discord.Guild) ? guildId : await this.fetchGuild(guildId)
@@ -254,12 +267,11 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.GuildMember` :) */
+    /**A simplified shortcut to get a `discord.GuildMember`. */
     async fetchGuildMember(guildId:string|discord.Guild, id:string): Promise<discord.GuildMember|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
-        if (typeof id != "string") throw new ODSystemError("TEMP ERROR => ODClientManager.fetchGuildMember() => id param isn't string")
-
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuildMember() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuildMember() => Unable to use this method. Client isn't ready and logged in yet.")
+        
         try{
             const guild = (guildId instanceof discord.Guild) ? guildId : await this.fetchGuild(guildId)
             if (!guild) return null
@@ -268,12 +280,11 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.Role` :) */
+    /**A simplified shortcut to get a `discord.Role`. */
     async fetchGuildRole(guildId:string|discord.Guild, id:string): Promise<discord.Role|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
-        if (typeof id != "string") throw new ODSystemError("TEMP ERROR => ODClientManager.fetchGuildRole() => id param isn't string")
-
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchGuildRole() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchGuildRole() => Unable to use this method. Client isn't ready and logged in yet.")
+        
         try{
             const guild = (guildId instanceof discord.Guild) ? guildId : await this.fetchGuild(guildId)
             if (!guild) return null
@@ -282,30 +293,23 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             return null
         }
     }
-    /**A simplified shortcut to get a `discord.Message` :) */
-    async fetchGuildChannelMessage(guildId:string|discord.Guild, channelId:string|discord.TextChannel, id:string): Promise<discord.Message<true>|null>
-    async fetchGuildChannelMessage(channelId:discord.TextChannel, id:string): Promise<discord.Message<true>|null>
-    async fetchGuildChannelMessage(guildId:string|discord.Guild|discord.TextChannel, channelId:string|discord.TextChannel|string, id?:string): Promise<discord.Message<true>|null> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+    /**A simplified shortcut to get a `discord.Message`. */
+    async fetchChannelMessage(channelId:string|discord.TextChannel|discord.DMChannel, id:string): Promise<discord.Message<boolean>|null> {
+        if (!this.initiated) throw new ODSystemError("ODClientManager.fetchChannelMessage() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.fetchChannelMessage() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
-            if (guildId instanceof discord.TextChannel && typeof channelId == "string"){
-                const channel = guildId
-                return await channel.messages.fetch(channelId)
-            }else if (!(guildId instanceof discord.TextChannel) && id){
-                const channel = (channelId instanceof discord.TextChannel) ? channelId : await this.fetchGuildTextChannel(guildId,channelId)
-                if (!channel) return null
-                return await channel.messages.fetch(id)
-            }else return null
+            const channel = (channelId instanceof discord.TextChannel || channelId instanceof discord.DMChannel) ? channelId : await this.fetchTextChannel(channelId)
+            if (!channel) return null
+            return await channel.messages.fetch(id)
         }catch{
             return null
         }
     }
-    /**A simplified shortcut to send a DM to a user :) */
+    /**A simplified shortcut to send a DM to a user. */
     async sendUserDm(user:string|discord.User, build:ODMessageBuildResult|ODMessageComponentBuildResult): Promise<ODResponderSendResult<false>> {
-        if (!this.initiated) throw new ODSystemError("Client isn't initiated yet!")
-        if (!this.ready) throw new ODSystemError("Client isn't ready yet!")
+        if (!this.initiated) throw new ODSystemError("ODClientManager.sendUserDm() => Unable to use this method. Client isn't initiated yet.")
+        if (!this.ready) throw new ODSystemError("ODClientManager.sendUserDm() => Unable to use this method. Client isn't ready and logged in yet.")
 
         try{
             const msgFlags: number[] = []
@@ -325,26 +329,26 @@ export class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstrai
             const finalMessage = Object.assign(msgData,{flags:msgFlags})
 
             if (user instanceof discord.User){
-                if (user.bot) return {success:false,message:null}
+                if (user.bot) return {success:false}
                 const channel = await user.createDM()
                 const msg = await channel.send(finalMessage)
                 return {success:true,message:msg}
             }else{
                 const newUser = await this.fetchUser(user)
                 if (!newUser) throw new Error()
-                if (newUser.bot) return {success:false,message:null}
+                if (newUser.bot) return {success:false}
                 const channel = await newUser.createDM()
                 const msg = await channel.send(finalMessage)
                 return {success:true,message:msg}
             }
         }catch{
             try{
-                this.debug.console.log("Failed to send DM to user! ","warning",[
+                this.debug.console.log("ODClientManager.sendUserDm() => Failed to send DM. User may have DMs disabled for non-friends. ","warning",[
                     {key:"id",value:(user instanceof discord.User ? user.id : user)},
                     {key:"message-build",value:build.id.value}
                 ])
             }catch{}
-            return {success:false,message:null}
+            return {success:false}
         }
     }
 }
@@ -417,7 +421,7 @@ export class ODClientActivityManager {
 
     /**Update the client status */
     private updateClientActivity(type:ODClientActivityType,text:string){
-        if (!this.client.client.user) throw new ODSystemError("Couldn't set client status: client.user == undefined")
+        if (!this.client.client.user) throw new ODSystemError("ODClientActivityManager.updateClientActivity() => Couldn't set client status: client.user is 'undefined'.")
         if (type == false){
             this.client.client.user.setActivity()
             return

package/src/api/modules/console.ts

@@ -217,7 +217,9 @@ export class ODError {
     }
     /**Create a more-detailed, non-colored version of this error to store it in the `debug.txt` file! */
     toDebugString(){
-        return "[UNKNOWN OD ERROR]: "+this.error.message+" | origin: "+this.origin+"\n"+this.error.stack
+        const date = new Date()
+        const dstring = `${date.getDate()}/${date.getMonth()+1}/${date.getFullYear()} ${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`
+        return "["+dstring+" UNKNOWN OPENDISCORD ERROR]: "+this.error.message+" | Error Origin: "+this.origin+" | Stacktrace:\n"+this.error.stack
     }
 }
 

package/src/api/modules/database.ts

@@ -89,7 +89,7 @@ export abstract class ODDatabase<IdList extends ODDatabaseIdConstraint = ODDatab
     abstract get(category:string, key:string): ODOptionalPromise<ODValidJsonType|undefined>
     abstract get(category:string, key:string): ODOptionalPromise<ODValidJsonType|undefined>
     
-    /**Delete a specific category & key in the database */
+    /**Delete a specific category & key in the database. Returns `true` when deleted. */
     abstract delete<CategoryId extends keyof ODNoGeneric<IdList>>(category:CategoryId, key:string): ODOptionalPromise<boolean>
     abstract delete(category:string, key:string): ODOptionalPromise<boolean>
     abstract delete(category:string, key:string): ODOptionalPromise<boolean>

package/src/api/modules/fuse.ts

@@ -142,9 +142,6 @@ export interface ODSharedFuseList {
     /**Load the default Open Discord client activity initialization (& status refresh). */
     clientActivityInitiating:boolean,
 
-    /**Load the default Open Discord priority levels. */
-    priorityLoading:boolean,
-
     /**Load the default Open Discord slash commands. */
     slashCommandLoading:boolean,
     /**Load the default Open Discord slash command registerer (register slash cmds in discord). */
@@ -164,6 +161,11 @@ export interface ODSharedFuseList {
     /**Load the default Open Discord text commands. */
     textCommandLoading:boolean,
 
+    /**Load the default Open Discord message states. */
+    stateLoading:boolean,
+    /**Initiate the default Open Discord message states. */
+    stateInitiating:boolean,
+
     /**Load the default Open Discord button builders. */
     buttonBuildersLoading:boolean,
     /**Load the default Open Discord dropdown builders. */
@@ -298,8 +300,6 @@ export class ODSharedFuseManager extends ODFuseManager<ODSharedFuseList> {
             clientActivityLoading:true,
             clientActivityInitiating:true,
 
-            priorityLoading:true,
-            
             slashCommandLoading:true,
             slashCommandRegistering:true,
             forceSlashCommandRegistration:false,
@@ -310,6 +310,9 @@ export class ODSharedFuseManager extends ODFuseManager<ODSharedFuseList> {
             allowContextMenuRemoval:true,
             textCommandLoading:true,
 
+            stateLoading:true,
+            stateInitiating:true,
+
             buttonBuildersLoading:true,
             dropdownBuildersLoading:true,
             fileBuildersLoading:true,

package/src/api/modules/post.ts

@@ -107,13 +107,13 @@ export class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODMan
     }
     /**Send a message to this channel using the Open Discord builder system */
     async send(build:ODMessageBuildResult|ODMessageComponentBuildResult): Promise<ODResponderSendResult<true>> {
-        if (!this.channel || !this.channel.isTextBased()) return {success:false,message:null}
+        if (!this.channel || !this.channel.isTextBased()) return {success:false}
         try{
             const finalMessage = this.getMessageFromBuildResult(build,"message")
             const sent = await this.channel.send(finalMessage)
             return {success:true,message:sent}
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Get the final `messageCreateOptions` from a returned build result from builders/components. */

package/src/api/modules/responder.ts

@@ -47,9 +47,7 @@ export type ODResponderSendResult<InGuild extends boolean> = {
     message:discord.Message<InGuild>
 } | {
     /**Did the message get sent successfully? */
-    success:boolean,
-    /**The message that got sent. */
-    message:null
+    success:false
 }
 
 /**## ODResponderManager `class`
@@ -485,9 +483,9 @@ export class ODCommandResponderInstance extends ODBaseResponderInstance {
                 const sent = await this.interaction.channel.send(finalMessage)
                 this.ignoreResponderTimeout = true
                 return {success:true,message:sent}
-            }else return {success:false,message:null}
+            }else return {success:false}
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Defer this command. */
@@ -670,7 +668,7 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Update the message of this button. */
@@ -687,7 +685,7 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Defer this button. */
@@ -985,7 +983,7 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Update the message of this dropdown. */
@@ -1002,7 +1000,7 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Defer this dropdown. */
@@ -1229,7 +1227,7 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
             this.ignoreResponderTimeout = true
             return {success:true,message:sent}
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Update the message of this modal. */
@@ -1246,7 +1244,7 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Defer this modal. */
@@ -1414,7 +1412,7 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Update the message of this context menu. */
@@ -1427,7 +1425,7 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
                 return {success:true,message:await sent.fetch()}
             }else throw new ODSystemError("Unable to update context menu interaction!")
         }catch{
-            return {success:false,message:null}
+            return {success:false}
         }
     }
     /**Defer this context menu. */