@open-discord-bots/framework 0.3.0 → 0.3.1

package/dist/api/modules/checker.js

@@ -221,17 +221,17 @@ export class ODDefaultCheckerRenderer extends ODCheckerRenderer {
         const finalFooter = [footerErrorText, footerWarningText, footerSupportText, ...this.extraFooterText];
         const finalTop = [...this.extraTopText];
         const finalBottom = [bottomCompactInfo, ...this.extraBottomText];
-        const borderLength = this.#getLongestLength([...finalHeader, ...finalFooter]);
+        const borderLength = this.getLongestLength([...finalHeader, ...finalFooter]);
         const finalComponents = [];
         //header
         if (!this.disableHeader) {
             finalHeader.forEach((text) => {
                 if (text.length < 1)
                     return;
-                finalComponents.push(this.#createBlockFromText(text, borderLength));
+                finalComponents.push(this.createBlockFromText(text, borderLength));
             });
         }
-        finalComponents.push(this.#getHorizontalDivider(borderLength + 4));
+        finalComponents.push(this.getHorizontalDivider(borderLength + 4));
         //top
         finalTop.forEach((text) => {
             if (text.length < 1)
@@ -289,24 +289,24 @@ export class ODDefaultCheckerRenderer extends ODCheckerRenderer {
             finalComponents.push(this.verticalFiller + " " + text);
         });
         //footer
-        finalComponents.push(this.#getHorizontalDivider(borderLength + 4));
+        finalComponents.push(this.getHorizontalDivider(borderLength + 4));
         if (!this.disableFooter) {
             finalFooter.forEach((text) => {
                 if (text.length < 1)
                     return;
-                finalComponents.push(this.#createBlockFromText(text, borderLength));
+                finalComponents.push(this.createBlockFromText(text, borderLength));
             });
-            finalComponents.push(this.#getHorizontalDivider(borderLength + 4));
+            finalComponents.push(this.getHorizontalDivider(borderLength + 4));
         }
         //return all components
         return finalComponents;
     }
     /**Get the length of the longest string in the array. */
-    #getLongestLength(texts) {
+    getLongestLength(texts) {
         return Math.max(...texts.map((t) => ansis.strip(t).length));
     }
     /**Get a horizontal divider used between different parts of the config checker result. */
-    #getHorizontalDivider(width) {
+    getHorizontalDivider(width) {
         if (width > 2)
             width = width - 2;
         else
@@ -315,7 +315,7 @@ export class ODDefaultCheckerRenderer extends ODCheckerRenderer {
         return divider;
     }
     /**Create a block of text with a vertical divider on the left & right side. */
-    #createBlockFromText(text, width) {
+    createBlockFromText(text, width) {
         if (width < 3)
             return this.verticalFiller + this.verticalFiller;
         let newWidth = width - ansis.strip(text).length + 1;
@@ -333,28 +333,28 @@ export class ODDefaultCheckerRenderer extends ODCheckerRenderer {
  */
 export class ODCheckerTranslationRegister {
     /**This is the array that stores all the data. ❌ **(don't edit unless really needed!)***/
-    #translations = [];
+    translations = [];
     get(type, id) {
-        const result = this.#translations.find(d => (d.id == id) && (d.type == type));
+        const result = this.translations.find(d => (d.id == id) && (d.type == type));
         return (result) ? result.translation : null;
     }
     set(type, id, translation) {
-        const index = this.#translations.findIndex(d => (d.id == id) && (d.type == type));
+        const index = this.translations.findIndex(d => (d.id == id) && (d.type == type));
         if (index > -1) {
             //overwrite
-            this.#translations[index] = { type, id, translation };
+            this.translations[index] = { type, id, translation };
             return true;
         }
         else {
-            this.#translations.push({ type, id, translation });
+            this.translations.push({ type, id, translation });
             return false;
         }
     }
     delete(type, id) {
-        const index = this.#translations.findIndex(d => (d.id == id) && (d.type == type));
+        const index = this.translations.findIndex(d => (d.id == id) && (d.type == type));
         if (index > -1) {
             //delete
-            this.#translations.splice(index, 1);
+            this.translations.splice(index, 1);
             return true;
         }
         else
@@ -362,7 +362,7 @@ export class ODCheckerTranslationRegister {
     }
     /**Get all translations */
     getAll() {
-        return this.#translations;
+        return this.translations;
     }
     /**Insert the translation params into the text. */
     insertTranslationParams(text, translationParams) {
@@ -473,7 +473,7 @@ export class ODChecker extends ODManagerData {
         this.options = options ?? {};
     }
     /**Get a human-readable number string. */
-    #ordinalNumber(num) {
+    ordinalNumber(num) {
         const i = Math.abs(Math.round(num));
         const cent = i % 100;
         if (cent >= 10 && cent <= 20)
@@ -502,7 +502,7 @@ export class ODChecker extends ODManagerData {
         const final = [];
         trace.forEach((t) => {
             if (typeof t == "number") {
-                final.push(`:(${this.#ordinalNumber(t + 1)})`);
+                final.push(`:(${this.ordinalNumber(t + 1)})`);
             }
             else {
                 final.push(`."${t}"`);
@@ -845,11 +845,11 @@ export class ODCheckerArrayStructure extends ODCheckerStructure {
             checker.createMessage("opendiscord:array-length-invalid", "error", `This array needs to have a length of ${this.options.length}!`, lt, null, [this.options.length.toString()], this.id, (this.options.docs ?? null));
             return false;
         }
-        else if (typeof this.options.allowedTypes != "undefined" && !this.#arrayAllowedTypesCheck(value, this.options.allowedTypes)) {
+        else if (typeof this.options.allowedTypes != "undefined" && !this.arrayAllowedTypesCheck(value, this.options.allowedTypes)) {
             checker.createMessage("opendiscord:array-invalid-types", "error", `This array can only contain the following types: ${this.options.allowedTypes.join(", ")}!`, lt, null, [this.options.allowedTypes.join(", ").toString()], this.id, (this.options.docs ?? null));
             return false;
         }
-        else if (typeof this.options.allowDoubles != "undefined" && !this.options.allowDoubles && this.#arrayHasDoubles(value)) {
+        else if (typeof this.options.allowDoubles != "undefined" && !this.options.allowDoubles && this.arrayHasDoubles(value)) {
             checker.createMessage("opendiscord:array-double", "error", "This array doesn't allow the same value twice!", lt, null, [], this.id, (this.options.docs ?? null));
             return false;
         }
@@ -875,7 +875,7 @@ export class ODCheckerArrayStructure extends ODCheckerStructure {
         }
     }
     /**Check this array for the allowed types */
-    #arrayAllowedTypesCheck(array, allowedTypes) {
+    arrayAllowedTypesCheck(array, allowedTypes) {
         //return TRUE if ALL values are valid
         return !array.some((value) => {
             if (allowedTypes.includes("string") && typeof value == "string") {
@@ -905,7 +905,7 @@ export class ODCheckerArrayStructure extends ODCheckerStructure {
         });
     }
     /**Check this array for doubles */
-    #arrayHasDoubles(array) {
+    arrayHasDoubles(array) {
         const alreadyFound = [];
         let hasDoubles = false;
         array.forEach((value) => {
@@ -1270,7 +1270,7 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
             else if (emptyAllowed && value.length == 0) {
                 return true;
             }
-            else if (!this.#urlIsValid(value)) {
+            else if (!this.urlIsValid(value)) {
                 checker.createMessage("opendiscord:url-invalid", "error", "This url is invalid!", lt, null, [], this.id, (this.options.docs ?? null));
                 return false;
             }
@@ -1282,15 +1282,15 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
                 checker.createMessage("opendiscord:url-invalid-protocol", "error", "This url can only use the http:// & https:// protocols!", lt, null, [], this.id, (this.options.docs ?? null));
                 return false;
             }
-            else if (typeof this.urlSettings.allowedHostnames != "undefined" && !this.#urlHasValidHostname(value, this.urlSettings.allowedHostnames)) {
+            else if (typeof this.urlSettings.allowedHostnames != "undefined" && !this.urlHasValidHostname(value, this.urlSettings.allowedHostnames)) {
                 checker.createMessage("opendiscord:url-invalid-hostname", "error", "This url has a disallowed hostname!", lt, null, [], this.id, (this.options.docs ?? null));
                 return false;
             }
-            else if (typeof this.urlSettings.allowedExtensions != "undefined" && !this.#urlHasValidExtension(value, this.urlSettings.allowedExtensions)) {
+            else if (typeof this.urlSettings.allowedExtensions != "undefined" && !this.urlHasValidExtension(value, this.urlSettings.allowedExtensions)) {
                 checker.createMessage("opendiscord:url-invalid-extension", "error", `This url has an invalid extension! Choose between: ${this.urlSettings.allowedExtensions.join(", ")}!"`, lt, null, [this.urlSettings.allowedExtensions.join(", ")], this.id, (this.options.docs ?? null));
                 return false;
             }
-            else if (typeof this.urlSettings.allowedPaths != "undefined" && !this.#urlHasValidPath(value, this.urlSettings.allowedPaths)) {
+            else if (typeof this.urlSettings.allowedPaths != "undefined" && !this.urlHasValidPath(value, this.urlSettings.allowedPaths)) {
                 checker.createMessage("opendiscord:url-invalid-path", "error", "This url has an invalid path!", lt, null, [], this.id, (this.options.docs ?? null));
                 return false;
             }
@@ -1306,7 +1306,7 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
         this.emptyAllowed = emptyAllowed;
     }
     /**Check for the hostname */
-    #urlHasValidHostname(url, hostnames) {
+    urlHasValidHostname(url, hostnames) {
         try {
             const hostname = new URL(url).hostname;
             return hostnames.some((rule) => {
@@ -1323,7 +1323,7 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
         }
     }
     /**Check for the extension */
-    #urlHasValidExtension(url, extensions) {
+    urlHasValidExtension(url, extensions) {
         try {
             const path = new URL(url).pathname;
             return extensions.some((rule) => {
@@ -1335,7 +1335,7 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
         }
     }
     /**Check for the path */
-    #urlHasValidPath(url, paths) {
+    urlHasValidPath(url, paths) {
         try {
             const path = new URL(url).pathname;
             return paths.some((rule) => {
@@ -1352,7 +1352,7 @@ export class ODCheckerCustomStructure_UrlString extends ODCheckerStringStructure
         }
     }
     /**Do general syntax check on url */
-    #urlIsValid(url) {
+    urlIsValid(url) {
         try {
             new URL(url);
             return true;

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

@@ -1,8 +1,10 @@
 import { ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js";
 import * as discord from "discord.js";
 import { ODDebugger } from "./console.js";
-import { ODMessageBuildResult, ODMessageBuildSentResult } from "./builder.js";
+import { ODMessageBuildResult } from "./builder.js";
 import { ODManualProgressBar } from "./progressbar.js";
+import { ODResponderSendResult } from "./responder.js";
+import { ODMessageComponentBuildResult } from "./component.js";
 /**## ODClientIntents `type`
  * A list of intents required when inviting the bot.
  */
@@ -27,7 +29,8 @@ export type ODClientPermissions = ("CreateInstantInvite" | "KickMembers" | "BanM
  * If you want, you can also listen for custom events on the `ODClientManager.client` variable (`discord.Client`)
  */
 export declare class ODClientManager<SlashIdList extends ODSlashCommandManagerIdConstraint = ODSlashCommandManagerIdConstraint, TextIdList extends ODTextCommandManagerIdConstraint = ODTextCommandManagerIdConstraint, ContextMenuIdList extends ODContextMenuManagerIdConstraint = ODContextMenuManagerIdConstraint> {
-    #private;
+    /**Alias to Open Discord debugger. */
+    protected debug: ODDebugger;
     /**List of required bot intents. Add intents to this list using the `onClientLoad` event. */
     intents: ODClientIntents[];
     /**List of required bot privileged intents. Add intents to this list using the `onClientLoad` event. */
@@ -39,6 +42,8 @@ export declare class ODClientManager<SlashIdList extends ODSlashCommandManagerId
     /**The discord bot token, empty by default. */
     set token(value: string);
     get token(): string;
+    /**The discord  bot token. **DON'T USE THIS!!!** (use `ODClientManager.token` instead) */
+    private rawBotToken;
     /**The discord.js `discord.Client`. Only use it when initiated! */
     client: discord.Client<true>;
     /**The discord.js REST client. Used for stuff that discord.js can't handle :) */
@@ -94,7 +99,7 @@ export declare class ODClientManager<SlashIdList extends ODSlashCommandManagerId
     fetchGuildChannelMessage(guildId: string | discord.Guild, channelId: string | discord.TextChannel, id: string): Promise<discord.Message<true> | null>;
     fetchGuildChannelMessage(channelId: discord.TextChannel, id: string): Promise<discord.Message<true> | null>;
     /**A simplified shortcut to send a DM to a user :) */
-    sendUserDm(user: string | discord.User, message: ODMessageBuildResult): Promise<ODMessageBuildSentResult<false>>;
+    sendUserDm(user: string | discord.User, build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<false>>;
 }
 /**## ODClientActivityType `type`
  * Possible activity types for the bot.
@@ -112,7 +117,10 @@ export type ODClientActivityMode = ("online" | "invisible" | "idle" | "dnd");
  * It also has a built-in refresh function, so the status will refresh every 10 minutes to keep it visible.
  */
 export declare class ODClientActivityManager {
-    #private;
+    /**Alias to Open Discord debugger. */
+    protected debug: ODDebugger;
+    /**Copy of discord.js client */
+    protected client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>;
     /**The current status type */
     type: ODClientActivityType;
     /**The current status text */
@@ -127,11 +135,15 @@ export declare class ODClientActivityManager {
     refreshInterval: number;
     /**Is the status already initiated? */
     initiated: boolean;
-    constructor(debug: ODDebugger, manager: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    constructor(debug: ODDebugger, client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
     /**Update the status. When already initiated, it can take up to 10min to see the updated status in discord. */
     setStatus(type: ODClientActivityType, text: string, mode: ODClientActivityMode, state: string, forceUpdate?: boolean): void;
     /**When initiating the status, the bot starts updating the status using `discord.js`. Returns `true` when successfull. */
     initStatus(): boolean;
+    /**Update the client status */
+    private updateClientActivity;
+    /**Get the enum that links to the correct type */
+    private getStatusTypeEnum;
     /**Get the status type (for displaying the status) */
     getStatusType(): "listening " | "playing " | "watching " | "";
 }
@@ -238,7 +250,12 @@ export interface ODSlashCommandBuilder extends discord.ChatInputApplicationComma
  * A utility class to compare existing slash commands with newly registered ones.
  */
 export declare class ODSlashCommandComparator {
-    #private;
+    /**Convert a `discord.ApplicationCommandOptionChoiceData<string>` to a universal Open Discord slash command option choice object for comparison. */
+    protected convertOptionChoice(choice: discord.ApplicationCommandOptionChoiceData<string>): ODSlashCommandUniversalOptionChoice;
+    /**Convert a `discord.ApplicationCommandOptionData` to a universal Open Discord slash command option object for comparison. */
+    protected convertBuilderOption(option: discord.ApplicationCommandOptionData): ODSlashCommandUniversalOption;
+    /**Convert a `discord.ApplicationCommandOption` to a universal Open Discord slash command option object for comparison. */
+    protected convertCommandOption(option: discord.ApplicationCommandOption): ODSlashCommandUniversalOption;
     /**Convert a `ODSlashCommandBuilder` to a universal Open Discord slash command object for comparison. */
     convertBuilder(builder: ODSlashCommandBuilder, guildId: string | null): ODSlashCommandUniversalCommand | null;
     /**Convert a `discord.ApplicationCommand` to a universal Open Discord slash command object for comparison. */
@@ -296,14 +313,20 @@ export type ODSlashCommandManagerIdConstraint = Record<string, ODSlashCommand>;
  * Here, you can add & remove slash commands & the bot will do the (de)registering.
  */
 export declare class ODSlashCommandManager<IdList extends ODSlashCommandManagerIdConstraint = ODSlashCommandManagerIdConstraint> extends ODManager<ODSlashCommand> {
-    #private;
+    /**Refrerence to discord.js client. */
+    protected client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>;
     /**Discord.js application commands manager. */
     commandManager: discord.ApplicationCommandManager | null;
+    /**Collection of all interaction listeners. */
+    protected interactionListeners: {
+        name: string | RegExp;
+        callback: ODSlashCommandInteractionCallback;
+    }[];
     /**Set the soft limit for maximum amount of listeners. A warning will be shown when there are more listeners than this limit. */
     listenerLimit: number;
     /**A utility class used to compare 2 slash commands with each other. */
     comparator: ODSlashCommandComparator;
-    constructor(debug: ODDebugger, manager: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    constructor(debug: ODDebugger, client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
     /**Get all registered & unregistered slash commands. */
     getAllRegisteredCommands(guildId?: string): Promise<ODSlashCommandRegisteredResult>;
     /**Create all commands that are not registered yet.*/
@@ -586,12 +609,26 @@ export type ODTextCommandManagerIdConstraint = Record<string, ODTextCommand>;
  * Here, you can add & remove text commands & the bot will do the (de)registering.
  */
 export declare class ODTextCommandManager<IdList extends ODTextCommandManagerIdConstraint = ODTextCommandManagerIdConstraint> extends ODManager<ODTextCommand> {
-    #private;
+    /**Copy of discord.js client. */
+    protected client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>;
+    /**Collection of all interaction listeners. */
+    protected interactionListeners: {
+        prefix: string;
+        name: string | RegExp;
+        callback: ODTextCommandInteractionCallback;
+    }[];
+    /**Collection of all error listeners. */
+    protected errorListeners: ODTextCommandErrorCallback[];
     /**Set the soft limit for maximum amount of listeners. A warning will be shown when there are more listeners than this limit. */
     listenerLimit: number;
-    constructor(debug: ODDebugger, manager: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    constructor(debug: ODDebugger, client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    private checkMessage;
+    /**Check if all options of a command are correct. */
+    private checkOptions;
     /**Start listening to the discord.js client `messageCreate` event. */
     startListeningToInteractions(): void;
+    /**Check if optional values are only present at the end of the command. */
+    private checkBuilderOptions;
     /**Callback on interaction from one of the registered text commands */
     onInteraction(commandPrefix: string, commandName: keyof ODNoGeneric<IdList>, callback: ODTextCommandInteractionCallback): void;
     onInteraction(commandPrefix: string, commandName: string | RegExp, callback: ODTextCommandInteractionCallback): void;
@@ -711,14 +748,20 @@ export type ODContextMenuManagerIdConstraint = Record<string, ODContextMenu>;
  * Here, you can add & remove context interactions & the bot will do the (de)registering.
  */
 export declare class ODContextMenuManager<IdList extends ODContextMenuManagerIdConstraint = ODContextMenuManagerIdConstraint> extends ODManager<ODContextMenu> {
-    #private;
+    /**Refrerence to discord.js client. */
+    protected client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>;
     /**Discord.js application commands manager. */
     commandManager: discord.ApplicationCommandManager | null;
+    /**Collection of all interaction listeners. */
+    protected interactionListeners: {
+        name: string | RegExp;
+        callback: ODContextMenuInteractionCallback;
+    }[];
     /**Set the soft limit for maximum amount of listeners. A warning will be shown when there are more listeners than this limit. */
     listenerLimit: number;
     /**A utility class used to compare 2 context menus with each other. */
     comparator: ODContextMenuComparator;
-    constructor(debug: ODDebugger, manager: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    constructor(debug: ODDebugger, client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
     /**Get all registered & unregistered message context menu commands. */
     getAllRegisteredMenus(guildId?: string): Promise<ODContextMenuRegisteredResult>;
     /**Create all context menus that are not registered yet.*/
@@ -778,12 +821,21 @@ export type ODAutocompleteInteractionCallback = (interaction: discord.Autocomple
  * It's responsible for managing all the autocomplete interactions from the client.
  */
 export declare class ODAutocompleteManager {
-    #private;
+    /**Alias to Open Discord debugger. */
+    protected debug: ODDebugger;
+    /**Refrerence to discord.js client. */
+    protected client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>;
     /**Discord.js application commands manager. */
     commandManager: discord.ApplicationCommandManager | null;
+    /**Collection of all interaction listeners. */
+    protected interactionListeners: {
+        cmdName: string | RegExp;
+        optName: string | RegExp;
+        callback: ODAutocompleteInteractionCallback;
+    }[];
     /**Set the soft limit for maximum amount of listeners. A warning will be shown when there are more listeners than this limit. */
     listenerLimit: number;
-    constructor(debug: ODDebugger, manager: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
+    constructor(debug: ODDebugger, client: ODClientManager<ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint, ODContextMenuManagerIdConstraint>);
     /**Start listening to the discord.js client `interactionCreate` event. */
     startListeningToInteractions(): void;
     /**Callback on interaction from one or multiple autocompletes. */