@open-discord-bots/framework 0.2.17 → 0.3.1

package/src/api/modules/permission.ts

@@ -129,12 +129,10 @@ export type ODPermissionManagerIdConstraint = Record<string,ODPermission>
  * Add new permissions using the `ODPermission` class in your plugin!
  */
 export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint = ODPermissionManagerIdConstraint> extends ODManager<ODPermission> {
-    /**Alias for Open Discord debugger. */
-    #debug: ODDebugger
     /**The function for calculating permissions in this manager. */
-    #calculation: ODPermissionCalculationCallback|null
+    private calculation: ODPermissionCalculationCallback|null
     /**An alias to the Open Discord client manager. */
-    #client: ODClientManager
+    private client: ODClientManager
     /**The result which is returned when no other permissions match. (`member` by default) */
     defaultResult: ODPermissionResult = {
         level:ODPermissionLevel["member"],
@@ -145,14 +143,13 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
 
     constructor(debug:ODDebugger, client:ODClientManager, useDefaultCalculation?:boolean){
         super(debug,"permission")
-        this.#debug = debug
-        this.#calculation = useDefaultCalculation ? this.#defaultCalculation : null
-        this.#client = client
+        this.calculation = useDefaultCalculation ? this.defaultCalculation : null
+        this.client = client
     }
 
     /**Edit the permission calculation function in this manager. */
     setCalculation(calculation:ODPermissionCalculationCallback){
-        this.#calculation = calculation
+        this.calculation = calculation
     }
     /**Edit the result which is returned when no other permissions match. (`member` by default) */
     setDefaultResult(result:ODPermissionResult){
@@ -161,8 +158,8 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
     /**Get an `ODPermissionResult` based on a few context factors. Use `hasPermissions()` to simplify the result. */
     getPermissions(user:discord.User, channel?:discord.Channel|null, guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
         try{
-            if (!this.#calculation) throw new ODSystemError("ODPermissionManager:getPermissions() => missing perms calculation")
-            return this.#calculation(user,channel,guild,settings)
+            if (!this.calculation) throw new ODSystemError("ODPermissionManager:getPermissions() => missing perms calculation")
+            return this.calculation(user,channel,guild,settings)
         }catch(err){
             process.emit("uncaughtException",err)
             throw new ODSystemError("ODPermissionManager:getPermissions() => failed perms calculation")
@@ -179,15 +176,15 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
         else throw new ODSystemError("Invalid minimum permission type at ODPermissionManager.hasPermissions()")
     }
     /**Check for permissions. (default calculation) */
-    async #defaultCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
-        const globalCalc = await this.#defaultGlobalCalculation(user,channel,guild,settings)
-        const channelCalc = await this.#defaultChannelCalculation(user,channel,guild,settings)
+    private async defaultCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
+        const globalCalc = await this.defaultGlobalCalculation(user,channel,guild,settings)
+        const channelCalc = await this.defaultChannelCalculation(user,channel,guild,settings)
 
         if (globalCalc.level > channelCalc.level) return globalCalc
         else return channelCalc
     }
     /**Check for global permissions. Result will be compared with the channel perms in `#defaultCalculation()`. */
-    async #defaultGlobalCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
+    private async defaultGlobalCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
         const idRegex = (settings && typeof settings.idRegex != "undefined") ? settings.idRegex : null
         const allowGlobalUserScope = (settings && typeof settings.allowGlobalUserScope != "undefined") ? settings.allowGlobalUserScope : true
         const allowGlobalRoleScope = (settings && typeof settings.allowGlobalRoleScope != "undefined") ? settings.allowGlobalRoleScope : true
@@ -219,7 +216,7 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
         //check for global role permissions
         if (allowGlobalRoleScope){
             if (guild){
-                const member = await this.#client.fetchGuildMember(guild,user.id)
+                const member = await this.client.fetchGuildMember(guild,user.id)
                 if (member){
                     const memberRoles = member.roles.cache.map((role) => role.id)
                     const roles = this.getFiltered((permission) => (!idRegex || (idRegex && idRegex.test(permission.id.value))) && permission.scope == "global-role" && (permission.value instanceof discord.Role) && memberRoles.includes(permission.value.id) && permission.value.guild.id == guild.id)
@@ -250,7 +247,7 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
         return {...this.defaultResult}
     }
     /**Check for channel permissions. Result will be compared with the global perms in `#defaultCalculation()`. */
-    async #defaultChannelCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
+    private async defaultChannelCalculation(user:discord.User,channel?:discord.Channel|null,guild?:discord.Guild|null, settings?:ODPermissionSettings|null): Promise<ODPermissionResult> {
         const idRegex = (settings && typeof settings.idRegex != "undefined") ? settings.idRegex : null
         const allowChannelUserScope = (settings && typeof settings.allowChannelUserScope != "undefined") ? settings.allowChannelUserScope : true
         const allowChannelRoleScope = (settings && typeof settings.allowChannelRoleScope != "undefined") ? settings.allowChannelRoleScope : true
@@ -282,7 +279,7 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
             
             //check for channel role permissions
             if (allowChannelRoleScope){
-                const member = await this.#client.fetchGuildMember(guild,user.id)
+                const member = await this.client.fetchGuildMember(guild,user.id)
                 if (member){
                     const memberRoles = member.roles.cache.map((role) => role.id)
                     const roles = this.getFiltered((permission) => (!idRegex || (idRegex && idRegex.test(permission.id.value))) && permission.scope == "channel-role" && permission.channel && (permission.channel.id == channel.id) && (permission.value instanceof discord.Role) && memberRoles.includes(permission.value.id) && permission.value.guild.id == guild.id)
@@ -328,12 +325,12 @@ export class ODPermissionManager<IdList extends ODPermissionManagerIdConstraint
             else return {hasPerms:true,isAdmin}
         }else{
             if (!guild || !member){
-                this.#debug.debug("ODPermissionManager.checkCommandPerms(): Permission Error, Not in server! (#1)")
+                this.debug?.debug("ODPermissionManager.checkCommandPerms(): Permission Error, Not in server! (#1)")
                 return {hasPerms:false,reason:"not-in-server"}
             }
-            const role = await this.#client.fetchGuildRole(guild,permissionMode)
+            const role = await this.client.fetchGuildRole(guild,permissionMode)
             if (!role){
-                this.#debug.debug("ODPermissionManager.checkCommandPerms(): Permission Error, Not in server! (#2)")
+                this.debug?.debug("ODPermissionManager.checkCommandPerms(): Permission Error, Not in server! (#2)")
                 return {hasPerms:false,reason:"not-in-server"}
             }
             if (!role.members.has(member.id)) return {hasPerms:false,reason:"no-perms"}

package/src/api/modules/plugin.ts

@@ -201,7 +201,7 @@ export class ODPlugin extends ODManagerData {
     }
 
     /**Check if a npm dependency exists. */
-    #checkDependency(id:string){
+    checkDependency(id:string){
         try{
             import.meta.resolve(id)
             return true
@@ -214,7 +214,7 @@ export class ODPlugin extends ODManagerData {
     dependenciesInstalled(){
         const missing: string[] = []
         this.data.npmDependencies.forEach((d) => {
-            if (!this.#checkDependency(d)){
+            if (!this.checkDependency(d)){
                 missing.push(d)
             }
         })

package/src/api/modules/post.ts

@@ -2,9 +2,11 @@
 //POST MODULE
 ///////////////////////////////////////
 import { ODId, ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js"
-import { ODMessageBuildResult, ODMessageBuildSentResult } from "./builder.js"
+import { ODMessageBuildResult } from "./builder.js"
 import { ODDebugger } from "./console.js"
 import * as discord from "discord.js"
+import { ODResponderSendResult } from "./responder.js"
+import { ODMessageComponentBuildResult } from "./component.js"
 
 /**## ODPostManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODPostManager` class.
@@ -20,19 +22,19 @@ export type ODPostManagerIdConstraint = Record<string,ODPost<discord.GuildBasedC
  */
 export class ODPostManager<IdList extends ODPostManagerIdConstraint = ODPostManagerIdConstraint> extends ODManager<ODPost<discord.GuildBasedChannel>> {
     /**A reference to the main server of the bot */
-    #guild: discord.Guild|null = null
+    protected guild: discord.Guild|null = null
 
     constructor(debug:ODDebugger){
         super(debug,"post")
     }
 
     add(data:ODPost<discord.GuildBasedChannel>, overwrite?:boolean): boolean {
-        if (this.#guild) data.useGuild(this.#guild)
+        if (this.guild) data.useGuild(this.guild)
         return super.add(data,overwrite)
     }
     /**Initialize the post manager & all posts. */
     async init(guild:discord.Guild){
-        this.#guild = guild
+        this.guild = guild
         for (const post of this.getAll()){
             post.useGuild(guild)
             await post.init()
@@ -71,7 +73,7 @@ export class ODPostManager<IdList extends ODPostManagerIdConstraint = ODPostMana
  */
 export class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODManagerData {
     /**A reference to the main server of the bot */
-    #guild: discord.Guild|null = null
+    protected guild: discord.Guild|null = null
     /**Is this post already initialized? */
     ready: boolean = false
     /**The discord.js channel */
@@ -86,7 +88,7 @@ export class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODMan
 
     /**Use a specific guild in this class for fetching the channel*/
     useGuild(guild:discord.Guild|null){
-        this.#guild = guild
+        this.guild = guild
     }
     /**Change the channel id to another channel! */
     setChannelId(id:string){
@@ -95,22 +97,41 @@ export class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODMan
     /**Initialize the discord.js channel of this post. */
     async init(){
         if (this.ready) return
-        if (!this.#guild) return this.channel = null
+        if (!this.guild) return this.channel = null
         try{
-            this.channel = await this.#guild.channels.fetch(this.channelId) as ChannelType
+            this.channel = await this.guild.channels.fetch(this.channelId) as ChannelType
         }catch{
             this.channel = null
         }
         this.ready = true
     }
     /**Send a message to this channel using the Open Discord builder system */
-    async send(msg:ODMessageBuildResult): Promise<ODMessageBuildSentResult<true>> {
+    async send(build:ODMessageBuildResult|ODMessageComponentBuildResult): Promise<ODResponderSendResult<true>> {
         if (!this.channel || !this.channel.isTextBased()) return {success:false,message:null}
         try{
-            const sent = await this.channel.send(msg.message)
+            const finalMessage = this.getMessageFromBuildResult(build,"message")
+            const sent = await this.channel.send(finalMessage)
             return {success:true,message:sent}
         }catch{
             return {success:false,message:null}
         }
     }
+    /**Get the final `messageCreateOptions` from a returned build result from builders/components. */
+    protected getMessageFromBuildResult(build:ODMessageBuildResult|ODMessageComponentBuildResult,type:"interaction"|"message"){
+        const msgFlags: number[] = []
+        let msgData: discord.MessageCreateOptions
+        if ('message' in build){
+            //USING BUILDERS (deprecated)
+            msgData = build.message
+            if (build.ephemeral) msgFlags.push(discord.MessageFlags.Ephemeral)
+        }else{
+            //USING COMPONENTS
+            msgData = build.msg
+            if (type == "interaction" && build.ephemeral) msgFlags.push(discord.MessageFlags.Ephemeral) //disabled with regular messages
+            if (build.componentsV2) msgFlags.push(discord.MessageFlags.IsComponentsV2)
+            if (build.supressEmbeds) msgFlags.push(discord.MessageFlags.SuppressEmbeds)
+            if (build.supressNotifications) msgFlags.push(discord.MessageFlags.SuppressNotifications)
+        }
+        return Object.assign(msgData,{flags:msgFlags})
+    }
 }

package/src/api/modules/progressbar.ts

@@ -102,32 +102,31 @@ export type ODProgressBarRenderFunc<Settings extends {}> = (settings:Settings,mi
  */
 export class ODProgressBarRenderer<Settings extends {}> extends ODManagerData {
     settings: Settings
-    #render: ODProgressBarRenderFunc<Settings>
+    private renderFunction: ODProgressBarRenderFunc<Settings>
 
-    constructor(id:ODValidId,render:ODProgressBarRenderFunc<Settings>,settings:Settings){
+    constructor(id:ODValidId,renderFunction:ODProgressBarRenderFunc<Settings>,settings:Settings){
         super(id)
-        this.#render = render
+        this.renderFunction = renderFunction
         this.settings = settings
     }
 
     /**Render a progress bar using this renderer. */
     render(min:number,max:number,value:number,prefix:string|null,suffix:string|null){
         try {
-            return this.#render(this.settings,min,max,value,prefix,suffix)
+            return this.renderFunction(this.settings,min,max,value,prefix,suffix)
         }catch(err){
             process.emit("uncaughtException",err)
             return "<PROGRESS-BAR-ERROR>"
         }
     }
-
+    /**Create a clone of this progress bar renderer, but with additional settings. */
     withAdditionalSettings(settings:Partial<Settings>): ODProgressBarRenderer<Settings> {
         const newSettings: Settings = {...this.settings}
         for (const key of Object.keys(settings) as (keyof Partial<Settings>)[]){
             if (typeof settings[key] != "undefined") newSettings[key] = settings[key]
         }
 
-        const idk = Object.keys(settings)
-        return new ODProgressBarRenderer(this.id,this.#render,newSettings)
+        return new ODProgressBarRenderer(this.id,this.renderFunction,newSettings)
     }
 }
 
@@ -139,13 +138,13 @@ export class ODProgressBarRenderer<Settings extends {}> extends ODManagerData {
  * 
  * Use other classes as existing templates or create your own progress bar from scratch using this class.
  */
-export class ODProgressBar extends ODManagerData {
+export abstract class ODProgressBar extends ODManagerData {
     /**The renderer of this progress bar. */
     renderer: ODProgressBarRenderer<{}>
     /**Is this progress bar currently active? */
-    #active: boolean = false
+    protected active: boolean = false
     /**A list of listeners when the progress bar stops. */
-    #stopListeners: Function[] = []
+    protected stopListeners: Function[] = []
     /**The current value of the progress bar. */
     protected value: number
     /**The minimum value of the progress bar. */
@@ -167,50 +166,50 @@ export class ODProgressBar extends ODManagerData {
         this.renderer = renderer
         this.min = min
         this.max = max
-        this.initialValue = this.#parseValue(value)
-        this.value = this.#parseValue(value)
+        this.initialValue = this.parseValue(value)
+        this.value = this.parseValue(value)
         this.autoStop = autoStop
         this.prefix = prefix
         this.suffix = suffix
     }
     /**Parse a value in such a way that it doesn't go below/above the min/max limits. */
-    #parseValue(value:number){
+    private parseValue(value:number){
         if (value > this.max) return this.max
         else if (value < this.min) return this.min
         else return value
     }
     /**Render progress bar to the console. */
-    #renderStdout(){
-        if (!this.#active) return
+    private renderStdout(){
+        if (!this.active) return
         readline.clearLine(process.stdout,0)
         readline.cursorTo(process.stdout,0)
         process.stdout.write(this.renderer.render(this.min,this.max,this.value,this.prefix,this.suffix))
     }
     /**Start showing this progress bar in the console. */
     start(): boolean {
-        if (this.#active) return false
-        this.value = this.#parseValue(this.initialValue)
-        this.#active = true
-        this.#renderStdout() 
+        if (this.active) return false
+        this.value = this.parseValue(this.initialValue)
+        this.active = true
+        this.renderStdout() 
         return true
     }
     /**Update this progress bar while active. (will automatically update the progress bar in the console) */
     protected update(value:number,stop?:boolean): boolean {
-        if (!this.#active) return false
-        this.value = this.#parseValue(value)
-        this.#renderStdout()
+        if (!this.active) return false
+        this.value = this.parseValue(value)
+        this.renderStdout()
         if (stop || (this.autoStop == "max" && this.value  == this.max) || (this.autoStop == "min" && this.value  == this.min)){
             process.stdout.write("\n")
-            this.#active = false
-            this.#stopListeners.forEach((cb) => cb())
-            this.#stopListeners = []
+            this.active = false
+            this.stopListeners.forEach((cb) => cb())
+            this.stopListeners = []
         }
         return true
     }
     /**Wait for the progress bar to finish. */
     finished(): Promise<void> {
         return new Promise((resolve) => {
-            this.#stopListeners.push(resolve)
+            this.stopListeners.push(resolve)
         })
     }
 }
@@ -234,7 +233,7 @@ export class ODTimedProgressBar extends ODProgressBar {
     }
 
     /**The timer which is used. */
-    async #timer(ms:number): Promise<void> {
+    private async timer(ms:number): Promise<void> {
         return new Promise((resolve) => {
             setTimeout(() => {
                 resolve()
@@ -242,11 +241,11 @@ export class ODTimedProgressBar extends ODProgressBar {
         })
     }
     /**Run the timed progress bar. */
-    async #execute(){
+    private async execute(){
         let i = 0
         const fragment = this.time/100
         while (i < 100){
-            await this.#timer(fragment)
+            await this.timer(fragment)
             i++
             super.update((this.mode == "increasing") ? (i*fragment) : this.time-(i*fragment))
         }
@@ -254,7 +253,7 @@ export class ODTimedProgressBar extends ODProgressBar {
     start(){
         const res = super.start()
         if (!res) return false
-        this.#execute()
+        this.execute()
         return true
     }
 }
@@ -338,12 +337,12 @@ export class ODDefaultProgressBarRenderer extends ODProgressBarRenderer<ODDefaul
             const percentage = (value-min)/(max-min)
             const barLevel = Math.round(percentage*settings.barWidth)
 
-            const borderAnsis = this.#switchColorAnsis(settings.borderColor)
-            const filledBarAnsis = this.#switchColorAnsis(settings.filledBarColor)
-            const emptyBarAnsis = this.#switchColorAnsis(settings.emptyBarColor)
-            const labelAnsis = this.#switchColorAnsis(settings.labelColor)
-            const prefixAnsis = this.#switchColorAnsis(settings.prefixColor)
-            const suffixAnsis = this.#switchColorAnsis(settings.suffixColor)
+            const borderAnsis = this.switchColorAnsis(settings.borderColor)
+            const filledBarAnsis = this.switchColorAnsis(settings.filledBarColor)
+            const emptyBarAnsis = this.switchColorAnsis(settings.emptyBarColor)
+            const labelAnsis = this.switchColorAnsis(settings.labelColor)
+            const prefixAnsis = this.switchColorAnsis(settings.prefixColor)
+            const suffixAnsis = this.switchColorAnsis(settings.suffixColor)
 
             const leftBorder = (settings.showBorder) ? borderAnsis(settings.leftBorderChar) : ""
             const rightBorder = (settings.showBorder) ? borderAnsis(settings.rightBorderChar) : ""
@@ -365,7 +364,7 @@ export class ODDefaultProgressBarRenderer extends ODProgressBarRenderer<ODDefaul
     }
 
     /**Switch between Ansis functions based on the specified color. */
-    #switchColorAnsis(c:ODValidConsoleColor|"openticket"|"openmoderation"){
+    private switchColorAnsis(c:ODValidConsoleColor|"openticket"|"openmoderation"){
         return (c === "openticket") ? ansis.hex("#f8ba00") : (c === "openmoderation") ? ansis.hex("#1690ff") : ansis[c]
     }
 }