@open-discord-bots/framework 0.2.17 → 0.3.1

package/dist/api/index.d.ts

@@ -1,26 +1,27 @@
 export * from "./main.js";
+export * from "./modules/action.js";
 export * from "./modules/base.js";
-export * from "./modules/event.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/language.js";
+export * from "./modules/event.js";
 export * from "./modules/flag.js";
-export * from "./modules/console.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/checker.js";
-export * from "./modules/client.js";
-export * from "./modules/worker.js";
-export * from "./modules/builder.js";
+export * from "./modules/post.js";
+export * from "./modules/progressbar.js";
 export * from "./modules/responder.js";
-export * from "./modules/action.js";
-export * from "./modules/permission.js";
-export * from "./modules/helpmenu.js";
 export * from "./modules/session.js";
+export * from "./modules/startscreen.js";
 export * from "./modules/statistic.js";
-export * from "./modules/code.js";
-export * from "./modules/cooldown.js";
-export * from "./modules/post.js";
 export * from "./modules/verifybar.js";
-export * from "./modules/progressbar.js";
-export * from "./modules/startscreen.js";
+export * from "./modules/worker.js";

package/dist/api/index.js

@@ -1,28 +1,29 @@
 //MAIN MODULE
 export * from "./main.js";
 //BASE MODULES
+export * from "./modules/action.js";
 export * from "./modules/base.js";
-export * from "./modules/event.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/language.js";
+export * from "./modules/event.js";
 export * from "./modules/flag.js";
-export * from "./modules/console.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/checker.js";
-export * from "./modules/client.js";
-export * from "./modules/worker.js";
-export * from "./modules/builder.js";
+export * from "./modules/post.js";
+export * from "./modules/progressbar.js";
 export * from "./modules/responder.js";
-export * from "./modules/action.js";
-export * from "./modules/permission.js";
-export * from "./modules/helpmenu.js";
 export * from "./modules/session.js";
+export * from "./modules/startscreen.js";
 export * from "./modules/statistic.js";
-export * from "./modules/code.js";
-export * from "./modules/cooldown.js";
-export * from "./modules/post.js";
 export * from "./modules/verifybar.js";
-export * from "./modules/progressbar.js";
-export * from "./modules/startscreen.js";
+export * from "./modules/worker.js";

package/dist/api/main.d.ts

@@ -22,11 +22,12 @@ 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";
 /**## ODMainManagers `interface`
  * The global properties for the main class of the bot.
  */
 export interface ODMainManagers {
-    /**The manager that handles all versions in the bot. */
+    /**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;
@@ -44,47 +45,53 @@ export interface ODMainManagers {
     plugins: ODPluginManager;
     /**The manager that manages & checks all the console flags of the bot. (like `--debug`) */
     flags: ODFlagManager;
-    /**The manager responsible for progress bars in the console. */
+    /**The manager responsible for displaying progress bars in the console. */
     progressbars: ODProgressBarManager;
-    /**The manager that manages & contains all the config files of the bot. (like `config/general.json`) */
+    /**A collection of all the config files of the bot and plugins. (like `config/general.json`) */
     configs: ODConfigManager;
-    /**The manager that manages & contains all the databases of the bot. (like `database/global.json`) */
+    /**A collection of all the databases of the bot and plugins. (like `database/global.json`) */
     databases: ODDatabaseManager;
-    /**The manager that manages all the data sessions of the bot. (it's a temporary database) */
+    /**A collection of all the sessions of the bot. (Sessions are temporary objects stored in memory) */
     sessions: ODSessionManager;
-    /**The manager that manages all languages & translations of the bot. (but not for plugins) */
+    /**The global translation manager which manges all language files, translations & switches between them. (Does not manage translations for plugins) */
     languages: ODLanguageManager;
-    /**The manager that handles & executes all config checkers in the bot. (the code that checks if you have something wrong in your config) */
+    /**The manager responsible for checking the bot & plugin configs. (it checks for mistakes in your config) */
     checkers: ODCheckerManager;
-    /**The manager that manages all builders in the bot. (e.g. buttons, dropdowns, messages, modals, etc) */
+    /**A collection of button, dropdown, embed, ... templates which can be used to construct messages and modals.
+     * ### (🚨 Better alternative: `opendiscord.components (ODComponentManager)`)
+     */
     builders: ODBuilderManager;
-    /**The manager that manages all responders in the bot. (e.g. commands, buttons, dropdowns, modals) */
+    /**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;
-    /**The manager that manages all actions or procedures in the bot. (e.g. ticket-creation, ticket-deletion, ticket-claiming, etc) */
+    /**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;
-    /**The manager that manages all verify bars in the bot. (the ✅ ❌ buttons) */
+    /**A collection of verify bars from the bot. (the ✅ ❌ buttons in messages) */
     verifybars: ODVerifyBarManager;
-    /**The manager that contains all permissions for commands & actions in the bot. (use it to check if someone has admin perms or not) */
+    /**A manager which will help with calculating permissions for commands & actions. */
     permissions: ODPermissionManager;
-    /**The manager that contains all cooldowns of the bot. (e.g. ticket-cooldowns) */
+    /**The manager which will manage cooldowns in the bot. (e.g. ticket-create cooldowns) */
     cooldowns: ODCooldownManager;
-    /**The manager that manages & renders the Open Discord help menu. (not the embed, but the text) */
+    /**The manager that collects & renders the Open Discord help menu contents. (not the final embed) */
     helpmenu: ODHelpMenuManager;
-    /**The manager that manages, saves & renders the Open Discord statistics. (not the embed, but the text & database) */
+    /**The manager that registers, saves & updates statistics in the database. */
     statistics: ODStatisticManager;
-    /**This manager is a place where you can put code that executes when the bot almost finishes the setup. (can be used for less important stuff that doesn't require an exact time-order) */
+    /**A place where you can put general-purpose code which will start on startup of the bot. (Perfect for background tasks) */
     code: ODCodeManager;
-    /**The manager that manages all posts (static discord channels) in the bot. (e.g. transcripts, logs, etc) */
+    /**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;
-    /**The manager responsible for everything related to the client. (e.g. status, login, slash & text commands, etc) */
+    /**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. With these fuses/switches, you can turn off "default behaviours" from the bot. Useful for replacing default behaviour with a custom implementation.  */
+    /**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;
-    /**This manager manages all the variables in the ENV. It reads from both the `.env` file & the `process.env`. (these 2 will be combined)  */
+    /**A manager which collects variables from the Process ENV and `.env` file. */
     env: ODEnvHelper;
-    /**The manager responsible for the livestatus system. (remote console logs) */
+    /**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 the livestatus system. (remote console logs) */
+    /**The manager responsible for rendering the startscreen of the bot. */
     startscreen: ODStartScreenManager;
 }
 /**## ODMain `class`
@@ -93,7 +100,7 @@ export interface ODMainManagers {
  *
  * This class can't be overwritten or extended & is available as the global variable `opendiscord`!
  */
-export declare class ODMain implements ODMainManagers {
+export declare abstract class ODMain implements ODMainManagers {
     readonly project: ODProjectType;
     readonly versions: ODVersionManager;
     readonly processStartupDate: Date;
@@ -111,6 +118,7 @@ export declare class ODMain implements ODMainManagers {
     readonly languages: ODLanguageManager;
     readonly checkers: ODCheckerManager;
     readonly builders: ODBuilderManager;
+    readonly components: ODComponentManager;
     readonly responders: ODResponderManager;
     readonly actions: ODActionManager;
     readonly verifybars: ODVerifyBarManager;

package/dist/api/main.js

@@ -25,6 +25,7 @@ export class ODMain {
     languages;
     checkers;
     builders;
+    components;
     responders;
     actions;
     verifybars;
@@ -42,7 +43,7 @@ export class ODMain {
     constructor(managers, project) {
         this.project = project;
         this.versions = managers.versions;
-        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.2.17"));
+        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.3.1"));
         this.versions.add(ODVersion.fromString("opendiscord:livestatus", "v2.0.0"));
         this.debugfile = managers.debugfile;
         this.console = managers.console;
@@ -57,6 +58,7 @@ export class ODMain {
         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;

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

@@ -8,12 +8,12 @@ import { ODDebugger } from "./console.js";
  *
  * This class can't be used stand-alone & needs to be extended from!
  */
-export declare class ODActionImplementation<Origin extends string, Params extends object, Result extends object, WorkerIds extends string = string> extends ODManagerData {
+export declare 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);
     /**Execute all workers & return the result. */
-    run(origin: Origin, params: Params): Promise<Partial<Result>>;
+    abstract run(origin: Origin, params: Params): Promise<Partial<Result>>;
 }
 /**## ODActionManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODActionManager` class.

package/dist/api/modules/action.js

@@ -1,7 +1,7 @@
 ///////////////////////////////////////
 //ACTION MODULE
 ///////////////////////////////////////
-import { ODManager, ODSystemError, ODManagerData } from "./base.js";
+import { ODManager, ODManagerData } from "./base.js";
 import { ODWorkerManager, ODWorker } from "./worker.js";
 /**## ODActionImplementation `class`
  * This is an Open Discord action implementation.
@@ -19,10 +19,6 @@ export class ODActionImplementation extends ODManagerData {
         if (callback)
             this.workers.add(new ODWorker(callbackId ? callbackId : id, priority ?? 0, callback));
     }
-    /**Execute all workers & return the result. */
-    async run(origin, params) {
-        throw new ODSystemError("Tried to build an unimplemented ODResponderImplementation");
-    }
 }
 /**## ODActionManager `class`
  * This is an Open Discord action manager.

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

@@ -52,11 +52,14 @@ export type ODNoGeneric<T extends Record<string | number | symbol, any>> = {
  * You can use this class to assign a unique id when creating configs, databases, languages & more!
  */
 export declare class ODId {
-    #private;
+    /**The raw value of this `ODId` as a `string`. */
+    private rawValue;
+    /**The change listener for the parent `ODManager` of this `ODId`. */
+    private changeListener;
+    constructor(id: ODValidId);
     /**The full value of this `ODId` as a `string`. */
     set value(id: string);
     get value(): string;
-    constructor(id: ODValidId);
     /**Returns a string representation of this id. (same as `this.value`) */
     toString(): string;
     /**The namespace of the id before `:`. (e.g. `opendiscord` for `opendiscord:autoclose-enabled`) */
@@ -74,8 +77,8 @@ export declare class ODId {
  * It is used to let the "onChange" event in the `ODManager` class work.
  * You can use this class when extending your own `ODManager`
  */
-export declare class ODManagerChangeHelper {
-    #private;
+export declare abstract class ODManagerChangeHelper {
+    private changeListener;
     /**Trigger an `onChange()` event in the parent `ODManager` of this class. */
     protected _change(): void;
     /****(❌ SYSTEM ONLY!!)** Set the callback executed when a value inside this class changes. */
@@ -88,7 +91,7 @@ export declare class ODManagerChangeHelper {
  *
  * There is an `id:ODId` property & also some events used in the manager.
  */
-export declare class ODManagerData extends ODManagerChangeHelper {
+export declare abstract class ODManagerData extends ODManagerChangeHelper {
     /**The id of this data. */
     id: ODId;
     constructor(id: ODValidId);
@@ -111,7 +114,18 @@ export type ODManagerAddCallback<DataType extends ODManagerData> = (data: DataTy
  * This class has many useful functions based on `ODId` (add, get, remove, getAll, getFiltered, exists, loopAll, ...)
  */
 export declare class ODManager<DataType extends ODManagerData> extends ODManagerChangeHelper {
-    #private;
+    /**Alias to Open Discord debugger. */
+    protected debug?: ODDebugger;
+    /**The message to send when debugging this manager. */
+    protected debugname?: string;
+    /**The map storing all data classes in this manager. */
+    private data;
+    /**An array storing all listeners when data is added. */
+    private addListeners;
+    /**An array storing all listeners when data has changed. */
+    private changeListeners;
+    /**An array storing all listeners when data is removed. */
+    private removeListeners;
     constructor(debug?: ODDebugger, debugname?: string);
     /**Add data to the manager. The `ODId` in the data class will be used as identifier! You can optionally select to overwrite existing data!*/
     add(data: DataType | DataType[], overwrite?: boolean): boolean;
@@ -149,8 +163,9 @@ export declare class ODManager<DataType extends ODManagerData> extends ODManager
  * The `getSafe()` function will always return data, because when it doesn't find an id, it returns pre-configured backup data.
  */
 export declare class ODManagerWithSafety<DataType extends ODManagerData> extends ODManager<DataType> {
-    #private;
-    constructor(backupCreator: () => DataType, debug?: ODDebugger, debugname?: string);
+    /**The function that creates backup data returned in `getSafe()` when an id is missing in this manager. */
+    protected backupGenerator: () => DataType;
+    constructor(backupGenerator: () => DataType, debug?: ODDebugger, debugname?: string);
     /**Get data that matches the `ODId`. Returns the backup data when not found.
      *
      * ### ⚠️ This should only be used when the data doesn't need to be written/edited
@@ -234,10 +249,13 @@ export declare class ODVersion extends ODManagerData {
  * It shouldn't be used by plugins because this is an internal API feature!
  */
 export declare class ODVersionMigration {
-    #private;
     /**The version to migrate data to */
     version: ODVersion;
-    constructor(version: ODVersion, func: () => void | Promise<void>, afterInitFunc: () => void | Promise<void>);
+    /**The migration function */
+    private migrateFunc;
+    /**The migration function */
+    private migrateAfterInitFunc;
+    constructor(version: ODVersion, migrateFunc: () => void | Promise<void>, migrateAfterInitFunc: () => void | Promise<void>);
     /**Run this version migration as a plugin. Returns `false` when something goes wrong. */
     migrate(): Promise<boolean>;
     /**Run this version migration as a plugin (after other plugins have loaded). Returns `false` when something goes wrong. */
@@ -309,7 +327,6 @@ export declare class ODHTTPPostRequest {
  * const variableA = envHelper.getVariable("value-c","env") //only get from process.env
  */
 export declare class ODEnvHelper {
-    #private;
     /**All variables found in the `.env` file */
     dotenv: Record<string, any>;
     /**All variables found in `process.env` */
@@ -317,6 +334,7 @@ export declare class ODEnvHelper {
     constructor(customEnvPath?: string);
     /**Get a variable from the env */
     getVariable(name: string, source?: "dotenv" | "env"): any | undefined;
+    protected readDotEnv(src: Buffer): Record<string, any>;
 }
 /**## ODSystemError `class`
  * A wrapper for the node.js `Error` class that makes the error look better in the console!