@open-discord-bots/framework 0.3.0 → 0.3.1

package/dist/api/modules/permission.js

@@ -56,12 +56,10 @@ export class ODPermission extends ODManagerData {
  * Add new permissions using the `ODPermission` class in your plugin!
  */
 export class ODPermissionManager extends ODManager {
-    /**Alias for Open Discord debugger. */
-    #debug;
     /**The function for calculating permissions in this manager. */
-    #calculation;
+    calculation;
     /**An alias to the Open Discord client manager. */
-    #client;
+    client;
     /**The result which is returned when no other permissions match. (`member` by default) */
     defaultResult = {
         level: ODPermissionLevel["member"],
@@ -71,13 +69,12 @@ export class ODPermissionManager extends ODManager {
     };
     constructor(debug, client, useDefaultCalculation) {
         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) {
-        this.#calculation = calculation;
+        this.calculation = calculation;
     }
     /**Edit the result which is returned when no other permissions match. (`member` by default) */
     setDefaultResult(result) {
@@ -86,9 +83,9 @@ export class ODPermissionManager extends ODManager {
     /**Get an `ODPermissionResult` based on a few context factors. Use `hasPermissions()` to simplify the result. */
     getPermissions(user, channel, guild, settings) {
         try {
-            if (!this.#calculation)
+            if (!this.calculation)
                 throw new ODSystemError("ODPermissionManager:getPermissions() => missing perms calculation");
-            return this.#calculation(user, channel, guild, settings);
+            return this.calculation(user, channel, guild, settings);
         }
         catch (err) {
             process.emit("uncaughtException", err);
@@ -113,16 +110,16 @@ export class ODPermissionManager extends ODManager {
             throw new ODSystemError("Invalid minimum permission type at ODPermissionManager.hasPermissions()");
     }
     /**Check for permissions. (default calculation) */
-    async #defaultCalculation(user, channel, guild, settings) {
-        const globalCalc = await this.#defaultGlobalCalculation(user, channel, guild, settings);
-        const channelCalc = await this.#defaultChannelCalculation(user, channel, guild, settings);
+    async defaultCalculation(user, channel, guild, settings) {
+        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, channel, guild, settings) {
+    async defaultGlobalCalculation(user, channel, guild, settings) {
         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;
@@ -152,7 +149,7 @@ export class ODPermissionManager extends ODManager {
         //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);
@@ -182,7 +179,7 @@ export class ODPermissionManager extends ODManager {
         return { ...this.defaultResult };
     }
     /**Check for channel permissions. Result will be compared with the global perms in `#defaultCalculation()`. */
-    async #defaultChannelCalculation(user, channel, guild, settings) {
+    async defaultChannelCalculation(user, channel, guild, settings) {
         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;
@@ -212,7 +209,7 @@ export class ODPermissionManager extends ODManager {
             }
             //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);
@@ -259,12 +256,12 @@ export class ODPermissionManager extends ODManager {
         }
         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))

package/dist/api/modules/plugin.d.ts

@@ -97,7 +97,6 @@ export interface ODPluginDetails {
  * Don't re-execute plugins which are already enabled! It might break the bot or plugin.
  */
 export declare class ODPlugin extends ODManagerData {
-    #private;
     /**The name of the directory of this plugin. (same as id) */
     dir: string;
     /**All plugin data found in the `plugin.json` file. */
@@ -123,6 +122,8 @@ export declare class ODPlugin extends ODManagerData {
     getStartFile(): string;
     /**Execute this plugin. Returns `false` on crash. */
     execute(debug: ODDebugger, force?: boolean): Promise<boolean>;
+    /**Check if a npm dependency exists. */
+    checkDependency(id: string): boolean;
     /**Get a list of all missing npm dependencies that are required for this plugin. */
     dependenciesInstalled(): string[];
     /**Get a list of all missing plugins that are required for this plugin. */

package/dist/api/modules/plugin.js

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

package/dist/api/modules/post.d.ts

@@ -1,7 +1,9 @@
 import { 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.
  */
@@ -14,7 +16,8 @@ export type ODPostManagerIdConstraint = Record<string, ODPost<discord.GuildBased
  * You can use this to get the logs channel of the bot (or some other static channel/category).
  */
 export declare class ODPostManager<IdList extends ODPostManagerIdConstraint = ODPostManagerIdConstraint> extends ODManager<ODPost<discord.GuildBasedChannel>> {
-    #private;
+    /**A reference to the main server of the bot */
+    protected guild: discord.Guild | null;
     constructor(debug: ODDebugger);
     add(data: ODPost<discord.GuildBasedChannel>, overwrite?: boolean): boolean;
     /**Initialize the post manager & all posts. */
@@ -35,7 +38,8 @@ export declare class ODPostManager<IdList extends ODPostManagerIdConstraint = OD
  * This class also contains utilities for sending messages via the Open Discord builders.
  */
 export declare class ODPost<ChannelType extends discord.GuildBasedChannel> extends ODManagerData {
-    #private;
+    /**A reference to the main server of the bot */
+    protected guild: discord.Guild | null;
     /**Is this post already initialized? */
     ready: boolean;
     /**The discord.js channel */
@@ -50,5 +54,9 @@ export declare class ODPost<ChannelType extends discord.GuildBasedChannel> exten
     /**Initialize the discord.js channel of this post. */
     init(): Promise<null | undefined>;
     /**Send a message to this channel using the Open Discord builder system */
-    send(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<true>>;
+    send(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<true>>;
+    /**Get the final `messageCreateOptions` from a returned build result from builders/components. */
+    protected getMessageFromBuildResult(build: ODMessageBuildResult | ODMessageComponentBuildResult, type: "interaction" | "message"): discord.MessageCreateOptions & {
+        flags: number[];
+    };
 }

package/dist/api/modules/post.js

@@ -2,6 +2,7 @@
 //POST MODULE
 ///////////////////////////////////////
 import { ODManager, ODManagerData } from "./base.js";
+import * as discord from "discord.js";
 /**## ODPostManager `class`
  * This is an Open Discord post manager.
  *
@@ -11,18 +12,18 @@ import { ODManager, ODManagerData } from "./base.js";
  */
 export class ODPostManager extends ODManager {
     /**A reference to the main server of the bot */
-    #guild = null;
+    guild = null;
     constructor(debug) {
         super(debug, "post");
     }
     add(data, overwrite) {
-        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) {
-        this.#guild = guild;
+        this.guild = guild;
         for (const post of this.getAll()) {
             post.useGuild(guild);
             await post.init();
@@ -48,7 +49,7 @@ export class ODPostManager extends ODManager {
  */
 export class ODPost extends ODManagerData {
     /**A reference to the main server of the bot */
-    #guild = null;
+    guild = null;
     /**Is this post already initialized? */
     ready = false;
     /**The discord.js channel */
@@ -61,7 +62,7 @@ export class ODPost extends ODManagerData {
     }
     /**Use a specific guild in this class for fetching the channel*/
     useGuild(guild) {
-        this.#guild = guild;
+        this.guild = guild;
     }
     /**Change the channel id to another channel! */
     setChannelId(id) {
@@ -71,10 +72,10 @@ export class ODPost extends ODManagerData {
     async init() {
         if (this.ready)
             return;
-        if (!this.#guild)
+        if (!this.guild)
             return this.channel = null;
         try {
-            this.channel = await this.#guild.channels.fetch(this.channelId);
+            this.channel = await this.guild.channels.fetch(this.channelId);
         }
         catch {
             this.channel = null;
@@ -82,15 +83,40 @@ export class ODPost extends ODManagerData {
         this.ready = true;
     }
     /**Send a message to this channel using the Open Discord builder system */
-    async send(msg) {
+    async send(build) {
         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. */
+    getMessageFromBuildResult(build, type) {
+        const msgFlags = [];
+        let msgData;
+        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/dist/api/modules/progressbar.d.ts

@@ -54,9 +54,9 @@ export type ODProgressBarRenderFunc<Settings extends {}> = (settings: Settings,
  * There are already a lot of default options available if you just want an easy progress bar!
  */
 export declare class ODProgressBarRenderer<Settings extends {}> extends ODManagerData {
-    #private;
     settings: Settings;
-    constructor(id: ODValidId, render: ODProgressBarRenderFunc<Settings>, settings: Settings);
+    private renderFunction;
+    constructor(id: ODValidId, renderFunction: ODProgressBarRenderFunc<Settings>, settings: Settings);
     /**Render a progress bar using this renderer. */
     render(min: number, max: number, value: number, prefix: string | null, suffix: string | null): string;
     /**Create a clone of this progress bar renderer, but with additional settings. */
@@ -71,9 +71,12 @@ export declare class ODProgressBarRenderer<Settings extends {}> extends ODManage
  * Use other classes as existing templates or create your own progress bar from scratch using this class.
  */
 export declare abstract class ODProgressBar extends ODManagerData {
-    #private;
     /**The renderer of this progress bar. */
     renderer: ODProgressBarRenderer<{}>;
+    /**Is this progress bar currently active? */
+    protected active: boolean;
+    /**A list of listeners when the progress bar stops. */
+    protected stopListeners: Function[];
     /**The current value of the progress bar. */
     protected value: number;
     /**The minimum value of the progress bar. */
@@ -89,6 +92,10 @@ export declare abstract class ODProgressBar extends ODManagerData {
     /**Enable automatic stopping when reaching `min` or `max`. */
     autoStop: null | "min" | "max";
     constructor(id: ODValidId, renderer: ODProgressBarRenderer<{}>, min: number, max: number, value: number, autoStop: null | "min" | "max", prefix: string | null, suffix: string | null);
+    /**Parse a value in such a way that it doesn't go below/above the min/max limits. */
+    private parseValue;
+    /**Render progress bar to the console. */
+    private renderStdout;
     /**Start showing this progress bar in the console. */
     start(): boolean;
     /**Update this progress bar while active. (will automatically update the progress bar in the console) */
@@ -103,12 +110,15 @@ export declare abstract class ODProgressBar extends ODManagerData {
  * You can set a fixed duration (milliseconds) in the constructor.
  */
 export declare class ODTimedProgressBar extends ODProgressBar {
-    #private;
     /**The time in milliseconds. */
     time: number;
     /**The mode of the timer. */
     mode: "increasing" | "decreasing";
     constructor(id: ODValidId, renderer: ODProgressBarRenderer<{}>, time: number, mode: "increasing" | "decreasing", prefix: string | null, suffix: string | null);
+    /**The timer which is used. */
+    private timer;
+    /**Run the timed progress bar. */
+    private execute;
     start(): boolean;
 }
 /**## ODManualProgressBar `class`
@@ -170,6 +180,7 @@ export interface ODDefaultProgressBarRendererSettings {
     showBorder: boolean;
 }
 export declare class ODDefaultProgressBarRenderer extends ODProgressBarRenderer<ODDefaultProgressBarRendererSettings> {
-    #private;
     constructor(id: ODValidId, settings: ODDefaultProgressBarRendererSettings);
+    /**Switch between Ansis functions based on the specified color. */
+    private switchColorAnsis;
 }

package/dist/api/modules/progressbar.js

@@ -58,16 +58,16 @@ export class ODProgressBarManager extends ODManager {
  */
 export class ODProgressBarRenderer extends ODManagerData {
     settings;
-    #render;
-    constructor(id, render, settings) {
+    renderFunction;
+    constructor(id, renderFunction, settings) {
         super(id);
-        this.#render = render;
+        this.renderFunction = renderFunction;
         this.settings = settings;
     }
     /**Render a progress bar using this renderer. */
     render(min, max, value, prefix, suffix) {
         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);
@@ -81,7 +81,7 @@ export class ODProgressBarRenderer extends ODManagerData {
             if (typeof settings[key] != "undefined")
                 newSettings[key] = settings[key];
         }
-        return new ODProgressBarRenderer(this.id, this.#render, newSettings);
+        return new ODProgressBarRenderer(this.id, this.renderFunction, newSettings);
     }
 }
 /**## ODProgressBar `class`
@@ -96,9 +96,9 @@ export class ODProgressBar extends ODManagerData {
     /**The renderer of this progress bar. */
     renderer;
     /**Is this progress bar currently active? */
-    #active = false;
+    active = false;
     /**A list of listeners when the progress bar stops. */
-    #stopListeners = [];
+    stopListeners = [];
     /**The current value of the progress bar. */
     value;
     /**The minimum value of the progress bar. */
@@ -118,14 +118,14 @@ 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) {
+    parseValue(value) {
         if (value > this.max)
             return this.max;
         else if (value < this.min)
@@ -134,8 +134,8 @@ export class ODProgressBar extends ODManagerData {
             return value;
     }
     /**Render progress bar to the console. */
-    #renderStdout() {
-        if (!this.#active)
+    renderStdout() {
+        if (!this.active)
             return;
         readline.clearLine(process.stdout, 0);
         readline.cursorTo(process.stdout, 0);
@@ -143,31 +143,31 @@ export class ODProgressBar extends ODManagerData {
     }
     /**Start showing this progress bar in the console. */
     start() {
-        if (this.#active)
+        if (this.active)
             return false;
-        this.value = this.#parseValue(this.initialValue);
-        this.#active = true;
-        this.#renderStdout();
+        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) */
     update(value, stop) {
-        if (!this.#active)
+        if (!this.active)
             return false;
-        this.value = this.#parseValue(value);
-        this.#renderStdout();
+        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() {
         return new Promise((resolve) => {
-            this.#stopListeners.push(resolve);
+            this.stopListeners.push(resolve);
         });
     }
 }
@@ -188,7 +188,7 @@ export class ODTimedProgressBar extends ODProgressBar {
         this.mode = mode;
     }
     /**The timer which is used. */
-    async #timer(ms) {
+    async timer(ms) {
         return new Promise((resolve) => {
             setTimeout(() => {
                 resolve();
@@ -196,11 +196,11 @@ export class ODTimedProgressBar extends ODProgressBar {
         });
     }
     /**Run the timed progress bar. */
-    async #execute() {
+    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));
         }
@@ -209,7 +209,7 @@ export class ODTimedProgressBar extends ODProgressBar {
         const res = super.start();
         if (!res)
             return false;
-        this.#execute();
+        this.execute();
         return true;
     }
 }
@@ -245,12 +245,12 @@ export class ODDefaultProgressBarRenderer extends ODProgressBarRenderer {
         super(id, (settings, min, max, value, rawPrefix, rawSuffix) => {
             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) : "";
             const bar = (settings.showBar) ? filledBarAnsis(settings.filledBarChar.repeat(barLevel)) + emptyBarAnsis(settings.emptyBarChar.repeat(settings.barWidth - barLevel)) : "";
@@ -276,7 +276,7 @@ export class ODDefaultProgressBarRenderer extends ODProgressBarRenderer {
         }, settings);
     }
     /**Switch between Ansis functions based on the specified color. */
-    #switchColorAnsis(c) {
+    switchColorAnsis(c) {
         return (c === "openticket") ? ansis.hex("#f8ba00") : (c === "openmoderation") ? ansis.hex("#1690ff") : ansis[c];
     }
 }