@open-discord-bots/framework 0.3.14 → 0.3.15

package/dist/api/main.js

@@ -44,7 +44,7 @@ export class ODMain {
     constructor(managers, project) {
         this.project = project;
         this.versions = managers.versions;
-        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.3.14"));
+        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.3.15"));
         this.versions.add(ODVersion.fromString("opendiscord:livestatus", "v2.0.0"));
         this.debugfile = managers.debugfile;
         this.console = managers.console;

package/dist/api/modules/responder.js

@@ -170,7 +170,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getString(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getString() slash command option not found!");
             }
         }
@@ -189,7 +190,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getBoolean(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getBoolean() slash command option not found!");
             }
         }
@@ -208,7 +210,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getNumber(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getNumber() slash command option not found!");
             }
         }
@@ -227,7 +230,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getChannel(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getChannel() slash command option not found!");
             }
         }
@@ -246,7 +250,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getRole(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getRole() slash command option not found!");
             }
         }
@@ -265,7 +270,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getUser(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getUser() slash command option not found!");
             }
         }
@@ -287,7 +293,8 @@ export class ODCommandResponderInstanceOptions {
                     throw new ODSystemError("ODCommandResponderInstanceOptions:getGuildMember() slash command option not found!");
                 return member;
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getGuildMember() slash command option not found!");
             }
         }
@@ -306,7 +313,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getMentionable(name, required);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getGuildMember() slash command option not found!");
             }
         }
@@ -325,7 +333,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getSubcommandGroup(true);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getSubGroup() slash command option not found!");
             }
         }
@@ -342,7 +351,8 @@ export class ODCommandResponderInstanceOptions {
             try {
                 return this.interaction.options.getSubcommand(true);
             }
-            catch {
+            catch (err) {
+                process.emit("uncaughtException", err);
                 throw new ODSystemError("ODCommandResponderInstanceOptions:getSubCommand() slash command option not found!");
             }
         }
@@ -444,7 +454,8 @@ export class ODCommandResponderInstance extends ODBaseResponderInstance {
             else
                 return { success: false };
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -608,7 +619,8 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -627,7 +639,8 @@ export class ODButtonResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -771,7 +784,8 @@ export class ODDropdownResponderInstanceValues {
         try {
             return this.interaction.values;
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             throw new ODSystemError("ODDropdownResponderInstanceValues:getStringValues() invalid values!");
         }
     }
@@ -790,7 +804,8 @@ export class ODDropdownResponderInstanceValues {
             }
             return result;
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             throw new ODSystemError("ODDropdownResponderInstanceValues:getRoleValues() invalid values!");
         }
     }
@@ -807,7 +822,8 @@ export class ODDropdownResponderInstanceValues {
             }
             return result;
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             throw new ODSystemError("ODDropdownResponderInstanceValues:getUserValues() invalid values!");
         }
     }
@@ -826,7 +842,8 @@ export class ODDropdownResponderInstanceValues {
             }
             return result;
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             throw new ODSystemError("ODDropdownResponderInstanceValues:getChannelValues() invalid values!");
         }
     }
@@ -916,7 +933,8 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -935,7 +953,8 @@ export class ODDropdownResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -1075,7 +1094,8 @@ export class ODModalResponderInstanceValues {
                 throw new ODSystemError("ODModalResponderInstanceValues:getTextField() field not found!");
             return (data) ? data.value : null;
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             throw new ODSystemError("ODModalResponderInstanceValues:getTextField() field not found!");
         }
     }
@@ -1130,11 +1150,12 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
     async reply(build) {
         try {
             const finalMessage = this.getMessageFromBuildResult(build, "interaction");
-            const sent = await this.interaction.followUp(finalMessage);
+            const sent = await this.interaction.reply(finalMessage);
             this.ignoreResponderTimeout = true;
-            return { success: true, message: sent, ephemeral: build.ephemeral };
+            return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -1153,7 +1174,8 @@ export class ODModalResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -1304,7 +1326,8 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
                 return { success: true, message: await sent.fetch(), ephemeral: build.ephemeral };
             }
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }
@@ -1320,7 +1343,8 @@ export class ODContextMenuResponderInstance extends ODBaseResponderInstance {
             else
                 throw new ODSystemError("Unable to update context menu interaction!");
         }
-        catch {
+        catch (err) {
+            process.emit("uncaughtException", err);
             return { success: false };
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.3.14",
+    "version": "0.3.15",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",

package/src/api/index.ts

@@ -1,31 +0,0 @@
-//MAIN MODULE
-export * from "./main.js"
-
-//BASE MODULES
-export * from "./modules/action.js"
-export * from "./modules/base.js"
-export * from "./modules/builder.js"
-export * from "./modules/checker.js"
-export * from "./modules/client.js"
-export * from "./modules/code.js"
-export * from "./modules/component.js"
-export * from "./modules/config.js"
-export * from "./modules/console.js"
-export * from "./modules/cooldown.js"
-export * from "./modules/database.js"
-export * from "./modules/event.js"
-export * from "./modules/flag.js"
-export * from "./modules/fuse.js"
-export * from "./modules/helpmenu.js"
-export * from "./modules/language.js"
-export * from "./modules/permission.js"
-export * from "./modules/plugin.js"
-export * from "./modules/post.js"
-export * from "./modules/progressbar.js"
-export * from "./modules/responder.js"
-export * from "./modules/session.js"
-export * from "./modules/startscreen.js"
-export * from "./modules/state.js"
-export * from "./modules/statistic.js"
-export * from "./modules/verifybar.js"
-export * from "./modules/worker.js"

package/src/api/main.ts

@@ -1,203 +0,0 @@
-//BASE MODULES
-import { ODEnvHelper, ODProjectType, ODVersion, ODVersionManager } from "./modules/base.js"
-import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager } from "./modules/console.js"
-import { ODCheckerManager } from "./modules/checker.js"
-import { ODEventManager } from "./modules/event.js"
-import { ODPluginManager } from "./modules/plugin.js"
-import { ODFlagManager } from "./modules/flag.js"
-import { ODProgressBarManager } from "./modules/progressbar.js"
-import { ODConfigManager } from "./modules/config.js"
-import { ODDatabaseManager } from "./modules/database.js"
-import { ODSessionManager } from "./modules/session.js"
-import { ODLanguageManager } from "./modules/language.js"
-import { ODBuilderManager } from "./modules/builder.js"
-import { ODResponderManager } from "./modules/responder.js"
-import { ODActionManager } from "./modules/action.js"
-import { ODVerifyBarManager } from "./modules/verifybar.js"
-import { ODPermissionManager } from "./modules/permission.js"
-import { ODCooldownManager } from "./modules/cooldown.js"
-import { ODHelpMenuManager } from "./modules/helpmenu.js"
-import { ODStatisticManager } from "./modules/statistic.js"
-import { ODCodeManager } from "./modules/code.js"
-import { ODPostManager } from "./modules/post.js"
-import { ODClientManager } from "./modules/client.js"
-import { ODSharedFuseManager } from "./modules/fuse.js"
-import { ODStartScreenManager } from "./modules/startscreen.js"
-import { ODComponentManager } from "./modules/component.js"
-import { ODStateManager } from "./modules/state.js"
-
-/**## ODMainManagers `interface`
- * The global properties for the main class of the bot.
- */
-export interface ODMainManagers {
-    /**A collection of versions of the bot, systems, frameworks & services. */
-    versions: ODVersionManager
-
-    /**The timestamp that the (node.js) process of the bot started. */
-    processStartupDate: Date
-    /**The timestamp that the bot finished loading and is ready for usage. */
-    readyStartupDate: Date|null
-
-    /**The manager responsible for the debug file. (`...debug.txt`) */
-    debugfile: ODDebugFileManager
-    /**The manager responsible for the console system. (logs, errors, etc) */
-    console: ODConsoleManager
-    /**The manager responsible for sending debug logs to the debug file. (`...debug.txt`) */
-    debug: ODDebugger
-    /**The manager containing all Open Discord events. */
-    events: ODEventManager
-
-    /**The manager that handles & executes all plugins in the bot. */
-    plugins: ODPluginManager
-    /**The manager that manages & checks all the console flags of the bot. (like `--debug`) */
-    flags: ODFlagManager
-    /**The manager responsible for displaying progress bars in the console. */
-    progressbars: ODProgressBarManager
-    /**A collection of all the config files of the bot and plugins. (like `config/general.json`) */
-    configs: ODConfigManager
-    /**A collection of all the databases of the bot and plugins. (like `database/global.json`) */
-    databases: ODDatabaseManager
-    /**A collection of all the sessions of the bot. (Sessions are temporary objects stored in memory) */
-    sessions: ODSessionManager
-    /**The global translation manager which manges all language files, translations & switches between them. (Does not manage translations for plugins) */
-    languages: ODLanguageManager
-    
-    /**The manager responsible for checking the bot & plugin configs. (it checks for mistakes in your config) */
-    checkers: ODCheckerManager
-    /**A collection of button, dropdown, embed, ... templates which can be used to construct messages and modals.
-     * ### (🚨 Better alternative: `opendiscord.components (ODComponentManager)`)
-     */
-    builders: ODBuilderManager
-    /**A collection of building blocks and templates for messages & modals with native support for Discord Components v2. (e.g. buttons, dropdowns, checkboxes, radio groups, file uploads, ...)
-     * ### (✅ New replacement for: `opendiscord.builders (ODBuilderManager)`)
-     */
-    components: ODComponentManager
-    /**The manager that handles responses to all interactions of the bot. (e.g. slash/text commands, buttons, dropdowns, modals) */
-    responders: ODResponderManager
-    /**A collection of procedures. A procedure is a complex task which can be executed from multiple responders or events. (e.g. ticket-creation, ticket-deletion, ticket-claiming, ...) */
-    actions: ODActionManager
-    /**A collection of verify bars from the bot. (the ✅ ❌ buttons in messages) */
-    verifybars: ODVerifyBarManager
-    /**A manager which will help with calculating permissions for commands & actions. */
-    permissions: ODPermissionManager
-    /**The manager which will manage cooldowns in the bot. (e.g. ticket-create cooldowns) */
-    cooldowns: ODCooldownManager
-    /**The manager that collects & renders the Open Discord help menu contents. (not the final embed) */
-    helpmenu: ODHelpMenuManager
-    /**The manager that registers, saves & updates statistics in the database. */
-    statistics: ODStatisticManager
-    /**A place where you can put general-purpose code which will start on startup of the bot. (Perfect for background tasks) */
-    code: ODCodeManager
-    /**A collection of static Discord post channels. It allows the bot to find back log, transcript or configured channels based on a linked ID. */
-    posts: ODPostManager
-    /**A system for tracking messages or linking metadata, states or progress to Discord messages (ID-based). Features automatic garbage collection. */
-    states: ODStateManager
-    
-    /**A wrapper around the `discord.Client` class. It handles client login, activity and registering text/slash commands. */
-    client: ODClientManager
-    /**Shared fuses between Open Discord bots. Turn off "default behaviours" from the bot which is useful for replacing default behaviour with a custom implementation.  */
-    sharedFuses: ODSharedFuseManager
-    /**A manager which collects variables from the Process ENV and `.env` file. */
-    env: ODEnvHelper
-    /**LiveStatus is a protocol which displays live updates from DJdj Development in the startscreen of the bot. (e.g. new version available) */
-    livestatus: ODLiveStatusManager
-    /**The manager responsible for rendering the startscreen of the bot. */
-    startscreen: ODStartScreenManager
-}
-
-/**## ODMain `class`
- * This is the main Open Discord class.
- * It contains all managers from the entire bot & has shortcuts to the event & logging system.
- * 
- * This class can't be overwritten or extended & is available as the global variable `opendiscord`!
- */
-export abstract class ODMain implements ODMainManagers {
-    readonly project: ODProjectType
-
-    readonly versions: ODVersionManager
-    readonly processStartupDate: Date = new Date()
-    readyStartupDate: Date|null = null
-
-    readonly debugfile: ODDebugFileManager
-    readonly console: ODConsoleManager
-    readonly debug: ODDebugger
-    readonly events: ODEventManager
-
-    readonly plugins: ODPluginManager
-    readonly flags: ODFlagManager
-    readonly progressbars: ODProgressBarManager
-    readonly configs: ODConfigManager
-    readonly databases: ODDatabaseManager
-    readonly sessions: ODSessionManager
-    readonly languages: ODLanguageManager
-    
-    readonly checkers: ODCheckerManager
-    readonly builders: ODBuilderManager
-    readonly components: ODComponentManager
-    readonly responders: ODResponderManager
-    readonly actions: ODActionManager
-    readonly verifybars: ODVerifyBarManager
-    readonly permissions: ODPermissionManager
-    readonly cooldowns: ODCooldownManager
-    readonly helpmenu: ODHelpMenuManager
-    readonly statistics: ODStatisticManager
-    readonly code: ODCodeManager
-    readonly posts: ODPostManager
-    readonly states: ODStateManager
-    
-    readonly client: ODClientManager
-    readonly sharedFuses: ODSharedFuseManager
-    readonly env: ODEnvHelper
-    readonly livestatus: ODLiveStatusManager
-    readonly startscreen: ODStartScreenManager
-
-    constructor(managers:ODMainManagers,project:ODProjectType){
-        this.project = project
-        this.versions = managers.versions
-        this.versions.add(ODVersion.fromString("opendiscord:api","v0.3.14"))
-        this.versions.add(ODVersion.fromString("opendiscord:livestatus","v2.0.0"))
-
-        this.debugfile = managers.debugfile
-        this.console = managers.console
-        this.debug = managers.debug
-        this.events  = managers.events
-        
-        this.plugins = managers.plugins
-        this.flags = managers.flags
-        this.progressbars = managers.progressbars
-        this.configs = managers.configs
-        this.databases = managers.databases
-        this.sessions = managers.sessions
-        this.languages = managers.languages
-        
-        this.checkers = managers.checkers
-        this.builders = managers.builders
-        this.components = managers.components
-        this.client = managers.client
-        this.responders = managers.responders
-        this.actions = managers.actions
-        this.verifybars = managers.verifybars
-        this.permissions = managers.permissions
-        this.cooldowns = managers.cooldowns
-        this.helpmenu = managers.helpmenu
-        this.statistics = managers.statistics
-        this.code = managers.code
-        this.posts = managers.posts
-        this.states = managers.states
-        
-        this.sharedFuses = managers.sharedFuses
-        this.env = managers.env
-        this.livestatus = managers.livestatus
-        this.startscreen = managers.startscreen
-    }
-    
-    /**Log a message to the console. But in the Open Discord style :) */
-    log(message:ODConsoleMessage): void
-    log(message:ODError): void
-    log(message:string, type?:ODConsoleMessageTypes, params?:ODConsoleMessageParam[]): void
-    log(message:ODConsoleMessage|ODError|string, type?:ODConsoleMessageTypes, params?:ODConsoleMessageParam[]){
-        if (message instanceof ODConsoleMessage) this.console.log(message)
-        else if (message instanceof ODError) this.console.log(message)
-        else if (["string","number","boolean","object"].includes(typeof message)) this.console.log(message,type,params)
-    }
-}

package/src/api/modules/action.ts

@@ -1,89 +0,0 @@
-///////////////////////////////////////
-//ACTION MODULE
-///////////////////////////////////////
-import { ODId, ODManager, ODValidId, ODSystemError, ODManagerData, ODNoGeneric } from "./base.js"
-import { ODWorkerManager, ODWorkerCallback, ODWorker } from "./worker.js"
-import { ODDebugger } from "./console.js"
-
-/**## ODActionImplementation `class`
- * This is an Open Discord action implementation.
- * 
- * It is a basic implementation of the `ODWorkerManager` used by all `ODAction` classes.
- * 
- * This class can't be used stand-alone & needs to be extended from!
- */
-export abstract class ODActionImplementation<Origin extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODManagerData {
-    /**The manager that has all workers of this implementation */
-    workers: ODWorkerManager<Partial<Result>,Origin,Params,WorkerIds>
-
-    constructor(id:ODValidId, callback?:ODWorkerCallback<Partial<Result>,Origin,Params>, priority?:number, callbackId?:ODValidId){
-        super(id)
-        this.workers = new ODWorkerManager("descending")
-        if (callback) this.workers.add(new ODWorker(callbackId ? callbackId : id,priority ?? 0,callback))
-    }
-    /**Execute all workers & return the result. */
-    abstract run(origin:Origin, params:Params): Promise<Partial<Result>>
-}
-
-/**## ODActionManagerIdConstraint `type`
- * The constraint/layout for id mappings/interfaces of the `ODActionManager` class.
- */
-export type ODActionManagerIdConstraint = Record<string,{origin:string,params:object,result:object,workers:string}>
-
-/**## ODActionManager `class`
- * This is an Open Discord action manager.
- * 
- * It contains all Open Discord actions. You can compare actions with some sort of "procedure".
- * It's a complicated task that is divided into multiple functions.
- * 
- * Some examples are `ticket-creation`, `ticket-closing`, `ticket-claiming`, ...
- * 
- * It's recommended to use this system in combination with Open Discord responders!
- */
-export class ODActionManager<IdList extends ODActionManagerIdConstraint = ODActionManagerIdConstraint> extends ODManager<ODAction<string,{},{},string>> {
-    constructor(debug:ODDebugger){
-        super(debug,"action")
-    }
-
-    get<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
-    get(id:ODValidId): ODAction<string,{},{},string>|null
-    
-    get(id:ODValidId): ODAction<string,{},{},string>|null {
-        return super.get(id)
-    }
-
-    remove<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
-    remove(id:ODValidId): ODAction<string,{},{},string>|null
-    
-    remove(id:ODValidId): ODAction<string,{},{},string>|null {
-        return super.remove(id)
-    }
-
-    exists(id:keyof ODNoGeneric<IdList>): boolean
-    exists(id:ODValidId): boolean
-    
-    exists(id:ODValidId): boolean {
-        return super.exists(id)
-    }
-}
-
-/**## ODAction `class`
- * This is an Open Discord action.
- * 
- * It is a collection of functions/workers to execute a complex workflow (e.g. creating a ticket, banning a user, ...).
- * 
- * Can be used standalone.
- */
-export class ODAction<Origin extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODActionImplementation<Origin,Params,Result,WorkerIds> {
-    /**Run this action */
-    async run(origin:Origin, params:Params): Promise<Partial<Result>> {
-        //create instance
-        const instance = {}
-        
-        //wait for workers to finish
-        await this.workers.executeWorkers(instance,origin,params)
-
-        //return data generated by workers
-        return instance
-    }
-}