@open-discord-bots/framework 0.2.0 → 0.2.2

package/README.md

@@ -54,25 +54,6 @@ We do currently <b>NOT</b> provide support for <b>3rd party implementations</b>
 - **Large Ecosystem** - The same plugin is able to work in all projects using Open discord (e.g. Open Ticket / Moderation)
 
 ## 🛠️ Contributors
-### 🖥️ Team & Contributors
-A list of people that contributed or provided support for Open Ticket, Open Moderation & Open Discord.
-<table>
-<tr>
-<td align="center"><img src="https://github.com/DJj123dj.png" alt="Profile Picture" width="80px"></td>
-<td align="center"><img src="https://github.com/guillee3.png" alt="Profile Picture" width="80px"></td>
-<td align="center"><img src="https://github.com/smetsliam.png" alt="Profile Picture" width="80px"></td>
-<td align="center"><img src="https://github.com/FrankVissers.png" alt="Profile Picture" width="80px"></td>
-<td align="center"><img src="https://github.com/Sank34.png" alt="Profile Picture" width="80px"></td>
-</tr>
-<tr>
-<th><a href="https://github.com/DJj123dj">💻🧩💬 DJj123dj</a></th>
-<th><a href="https://github.com/guillee3">🧩💬 Guillee3</a></th>
-<th><a href="https://github.com/smetsliam">💬 smetsliam</a></th>
-<th><a href="https://github.com/FrankVissers">💬 Frank Vissers</a></th>
-<th><a href="https://github.com/Sank34">💬 Sanke</a></th>
-</tr>
-</table>
-
 ### ❤️ Sponsors
 A big thanks to all our sponsors! Without them, it wouldn't be possible to create this project!
 
@@ -80,10 +61,12 @@ A big thanks to all our sponsors! Without them, it wouldn't be possible to creat
 <tr>
 <td><img src="https://github.com/guillee3.png" alt="Profile Picture" width="100px"></td>
 <td><img src="https://github.com/yeeetSK.png" alt="Profile Picture" width="100px"></td>
+<td><img src="https://github.com/jacobhumston.png" alt="Profile Picture" width="100px"></td>
 </tr>
 <tr>
 <td align="center"><a href="https://github.com/guillee3"><b>guillee3</b></a></td>
 <td align="center"><a href="https://github.com/yeeetSK"><b>yeeetSK</b></a></td>
+<td align="center"><a href="https://github.com/jacobhumston"><b>jacobhumston</b></a></td>
 </tr>
 </table>
 
@@ -95,6 +78,25 @@ A big thanks to all our sponsors! Without them, it wouldn't be possible to creat
 <img src="https://github.com/BENZORICH.png" alt="BENZORICH" width="40px">
 </a>
 
+### 🖥️ Team & Contributors
+A list of people that contributed or provided support for Open Ticket, Open Moderation & Open Discord.
+<table>
+<tr>
+<td align="center"><img src="https://github.com/DJj123dj.png" alt="Profile Picture" width="80px"></td>
+<td align="center"><img src="https://github.com/guillee3.png" alt="Profile Picture" width="80px"></td>
+<td align="center"><img src="https://github.com/smetsliam.png" alt="Profile Picture" width="80px"></td>
+<td align="center"><img src="https://github.com/FrankVissers.png" alt="Profile Picture" width="80px"></td>
+<td align="center"><img src="https://github.com/Sank34.png" alt="Profile Picture" width="80px"></td>
+</tr>
+<tr>
+<th><a href="https://github.com/DJj123dj">💻🧩💬 DJj123dj</a></th>
+<th><a href="https://github.com/guillee3">🧩💬 Guillee3</a></th>
+<th><a href="https://github.com/smetsliam">💬 smetsliam</a></th>
+<th><a href="https://github.com/FrankVissers">💬 Frank Vissers</a></th>
+<th><a href="https://github.com/Sank34">💬 Sanke</a></th>
+</tr>
+</table>
+
 ---
 <img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Ticket Logo" width="170px">
 

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

@@ -1,12 +1,16 @@
-import { ODManagerData, ODManager, ODValidId } from "./base";
+import { ODManagerData, ODManager, ODValidId, ODPromiseVoid } from "./base";
 import { ODDebugger } from "./console";
+/**## ODEventCallback `type`
+ * The base callback function for events.
+ */
+export type ODEventCallback = (...args: any) => ODPromiseVoid;
 /**## ODEvent `class`
  * This is an Open Discord event.
  *
  * This class is made to work with the `ODEventManager` to handle events.
  * The function of this specific class is to manage all listeners for a specifc event!
  */
-export declare class ODEvent extends ODManagerData {
+export declare class ODEvent<Callback extends ODEventCallback = ODEventCallback> extends ODManagerData {
     #private;
     /**The list of permanent listeners. */
     listeners: Function[];
@@ -19,13 +23,13 @@ export declare class ODEvent extends ODManagerData {
     /**Edit the listener limit */
     setListenerLimit(limit: number): void;
     /**Add a permanent callback to this event. This will stay as long as the bot is running! */
-    listen(callback: Function): void;
+    listen(callback: Callback): void;
     /**Add a one-time-only callback to this event. This will only trigger the callback once! */
-    listenOnce(callback: Function): void;
+    listenOnce(callback: Callback): void;
     /**Wait until this event is fired! Be carefull with it, because it could block the entire bot when wrongly used! */
-    wait(): Promise<any[]>;
+    wait(): Promise<Parameters<Callback>>;
     /**Emit this event to all listeners. You are required to provide all parameters of the event! */
-    emit(params: any[]): Promise<void>;
+    emit(params: Parameters<Callback>): Promise<void>;
 }
 /**## ODEventManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODEventManager` class.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -11,10 +11,10 @@
     "keywords": [],
     "license": "GPL-3.0-only",
     "dependencies": {
-        "@discordjs/rest": "^2.6.0",
+        "@discordjs/rest": "^2.6.1",
         "@types/terminal-kit": "^2.5.7",
         "ansis": "^4.2.0",
-        "discord.js": "^14.25.1",
+        "discord.js": "^14.26.0",
         "formatted-json-stringify": "^1.2.1",
         "terminal-kit": "^3.1.2",
         "typescript": "^5.9.3"

package/src/api/modules/event.ts

@@ -1,16 +1,21 @@
 ///////////////////////////////////////
 //EVENT MODULE
 ///////////////////////////////////////
-import { ODManagerData, ODManager, ODValidId } from "./base"
+import { ODManagerData, ODManager, ODValidId, ODPromiseVoid } from "./base"
 import { ODConsoleWarningMessage, ODDebugger } from "./console"
 
+/**## ODEventCallback `type`
+ * The base callback function for events.
+ */
+export type ODEventCallback = (...args:any) => ODPromiseVoid
+
 /**## ODEvent `class`
  * This is an Open Discord event.
  * 
  * This class is made to work with the `ODEventManager` to handle events.
  * The function of this specific class is to manage all listeners for a specifc event!
  */
-export class ODEvent extends ODManagerData {
+export class ODEvent<Callback extends ODEventCallback = ODEventCallback> extends ODManagerData {
     /**Alias to Open Discord debugger. */
     #debug?: ODDebugger
     /**The list of permanent listeners. */
@@ -38,7 +43,7 @@ export class ODEvent extends ODManagerData {
         this.listenerLimit = limit
     }
     /**Add a permanent callback to this event. This will stay as long as the bot is running! */
-    listen(callback:Function){
+    listen(callback:Callback){
         this.listeners.push(callback)
 
         if (this.listeners.length > this.listenerLimit){
@@ -49,17 +54,17 @@ export class ODEvent extends ODManagerData {
         }
     }
     /**Add a one-time-only callback to this event. This will only trigger the callback once! */
-    listenOnce(callback:Function){
+    listenOnce(callback:Callback){
         this.oncelisteners.push(callback)
     }
     /**Wait until this event is fired! Be carefull with it, because it could block the entire bot when wrongly used! */
-    async wait(): Promise<any[]> {
+    async wait(): Promise<Parameters<Callback>> {
         return new Promise((resolve,reject) => {
             this.oncelisteners.push((...args:any) => {resolve(args)})
         })
     }
     /**Emit this event to all listeners. You are required to provide all parameters of the event! */
-    async emit(params:any[]): Promise<void> {
+    async emit(params:Parameters<Callback>): Promise<void> {
         for (const listener of this.#getCurrentListeners()){
             try{
                 await listener(...params)

package/src/api/modules/helpmenu.ts

@@ -95,7 +95,7 @@ export class ODHelpMenuCommandComponent extends ODHelpMenuComponent {
 /**## ODHelpMenuCategoryIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODHelpMenuCategory` class.
  */
-export type ODHelpMenuCategoryIdConstraint = Record<string,ODHelpMenuComponent>
+export type ODHelpMenuCategoryIdConstraint = Record<string,ODHelpMenuComponent|null>
 
 /**## ODHelpMenuCategory `class`
  * This is an Open Discord help menu category.

package/src/api/modules/post.ts

@@ -9,7 +9,7 @@ import * as discord from "discord.js"
 /**## ODPostManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODPostManager` class.
  */
-export type ODPostManagerIdConstraint = Record<string,ODPost<discord.GuildBasedChannel>>
+export type ODPostManagerIdConstraint = Record<string,ODPost<discord.GuildBasedChannel>|null>
 
 /**## ODPostManager `class`
  * This is an Open Discord post manager.