@open-discord-bots/framework 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,104 @@
+<p align="center">
+<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Ticket" width="650px"><br>
+<span align="center"><b>A modular framework for the next-generation of Discord bots</b></span><br><br>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" height="55px"></a>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" height="60px"></a><br><br>
+<a href="https://discord.com/invite/26vT9wt3n3"><img alt="Discord Invite Link" src="https://img.shields.io/badge/discord-support%20server-5865F2.svg?style=flat-square&logo=discord"></img></a>
+<a href="https://github.com/open-discord-bots/plugins/blob/main/LICENSE"><img alt="Open Discord Plugins License" src="https://img.shields.io/badge/license-MIT-important.svg?style=flat-square"></img></a>
+<a href="https://discord.dj-dj.be"><img alt="Open Discord Plugins Stars" src="https://img.shields.io/github/stars/open-discord-bots/framework?color=yellow&label=stars&logo=github&style=flat-square"></img></a>
+<a href="https://github.com/sponsors/DJj123dj"><img alt="Sponsor DJj123dj" src="https://img.shields.io/badge/sponsor-DJj123dj-ea4aaa?style=flat-square&logo=githubsponsors"></img></a>
+</p>
+
+<p align="center">
+Open Discord is a modular plugin-driven framework built on top of discord.js that provides a structured foundation for building advanced Discord bots.
+It powers <a href="https://otgithub.dj-dj.be"><b>Open Ticket</b></a> and <a href="https://omgithub.dj-dj.be/"><b>Open Moderation</b></a>, offering shared utilities, plugin support, translations, config/database and a scalable architecture for the most advanced open-source discord bots.<br><br>
+<b>⚠️ Warning!</b><br>
+We do currently <b>NOT</b> provide support <b>3rd party implementations</b> of the framework!<br>More information can be found in our <a href="https://discord.dj-dj.be">discord server</a>.
+</p>
+
+### 📌 Primary Features
+- **Shared Utilities** - Text/emoji formatting, client functions, modules, timing & promise handling.
+
+- **Logs & Errors** - Advanced multi-color logging, debug file & error handling system.
+
+- **Plugins** - Includes an advanced and modular plugin system for almost any scenario.
+
+- **Debugging Tools** - Powerful debugging tools, dump commands, debug logs, tests & flags.
+
+- **Client Layer** - A powerful layer between `discord.js` and the bot to simplify permissions, activity/status & privilleges.
+
+- **Registration** - Register slash & text-based commands in one go! Registration is handled automatically.
+
+- **Builders** - Advanced template-based message, embed, modal & component builders for extensible layouts.
+
+- **Responders** - Respond to slash & text-based commands in one go with the same code!
+
+- **Config** - Register JSON config files, use an advanced checker for validation or save/reload files in real-time.
+
+- **Database** - Register JSON databases and use simple methods to access and write data.
+
+- **Version Migration** - Migrate data between versions and apply changes before the main process starts.
+
+- **Fuses** - Toggle fuses using plugins to disable built-in systems and replace them with 3rd party alternatives.
+
+- **Languages** - A powerful system for translating sentences, managing language files & handling backup languages.
+
+- **Permissions** - An easy to use system for managing bot permissions for users, roles & channels at the same time.
+
+- **Stats** - Save, modify and keep track of statistics for users, channels, roles or custom entities.
+
+- **Workers** - Many features use a worker-based system to allow extensible/overwritable code by plugins.
+
+- **Console** - Interact with the console using a startscreen, progress bars & interactive menu's.
+
+- **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!
+
+<table>
+<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>
+</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>
+</tr>
+</table>
+
+**Past Sponsors:**<br>
+<a href="https://github.com/sponsors/DJj123dj">
+<img src="https://github.com/SpyEye2.png" alt="SpyEye" width="40px">
+<img src="https://github.com/mods-hd.png" alt="Mods HD" width="40px">
+<img src="https://github.com/DOSEV5.png" alt="DOSEV5" width="40px">
+<img src="https://github.com/BENZORICH.png" alt="BENZORICH" width="40px">
+</a>
+
+---
+<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Ticket Logo" width="170px">
+
+**README.md**<br>
+[Open Ticket](https://otgithub.dj-dj.be) - [Open Moderation](https://omgithub.dj-dj.be) - [Plugin Directory](https://odplugins.dj-dj.be) - [Support Server](https://discord.dj-dj.be) - [License](./LICENSE.md)<br>
+
+© 2021 - 2026 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms) - [Privacy Policy](https://www.dj-dj.be/privacy) - [Support Us](https://github.com/sponsors/DJj123dj)

package/dist/api/api.d.ts

@@ -0,0 +1,26 @@
+export * from "./main";
+export * from "./modules/base";
+export * from "./modules/event";
+export * from "./modules/config";
+export * from "./modules/database";
+export * from "./modules/language";
+export * from "./modules/flag";
+export * from "./modules/console";
+export * from "./modules/fuse";
+export * from "./modules/plugin";
+export * from "./modules/checker";
+export * from "./modules/client";
+export * from "./modules/worker";
+export * from "./modules/builder";
+export * from "./modules/responder";
+export * from "./modules/action";
+export * from "./modules/permission";
+export * from "./modules/helpmenu";
+export * from "./modules/session";
+export * from "./modules/stat";
+export * from "./modules/code";
+export * from "./modules/cooldown";
+export * from "./modules/post";
+export * from "./modules/verifybar";
+export * from "./modules/progressbar";
+export * from "./modules/startscreen";

package/dist/api/api.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//MAIN MODULE
+__exportStar(require("./main"), exports);
+//BASE MODULES
+__exportStar(require("./modules/base"), exports);
+__exportStar(require("./modules/event"), exports);
+__exportStar(require("./modules/config"), exports);
+__exportStar(require("./modules/database"), exports);
+__exportStar(require("./modules/language"), exports);
+__exportStar(require("./modules/flag"), exports);
+__exportStar(require("./modules/console"), exports);
+__exportStar(require("./modules/fuse"), exports);
+__exportStar(require("./modules/plugin"), exports);
+__exportStar(require("./modules/checker"), exports);
+__exportStar(require("./modules/client"), exports);
+__exportStar(require("./modules/worker"), exports);
+__exportStar(require("./modules/builder"), exports);
+__exportStar(require("./modules/responder"), exports);
+__exportStar(require("./modules/action"), exports);
+__exportStar(require("./modules/permission"), exports);
+__exportStar(require("./modules/helpmenu"), exports);
+__exportStar(require("./modules/session"), exports);
+__exportStar(require("./modules/stat"), exports);
+__exportStar(require("./modules/code"), exports);
+__exportStar(require("./modules/cooldown"), exports);
+__exportStar(require("./modules/post"), exports);
+__exportStar(require("./modules/verifybar"), exports);
+__exportStar(require("./modules/progressbar"), exports);
+__exportStar(require("./modules/startscreen"), exports);

package/dist/api/main.d.ts

@@ -0,0 +1,133 @@
+import { ODEnvHelper, ODProjectType, ODVersionManager } from "./modules/base";
+import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager } from "./modules/console";
+import { ODCheckerManager } from "./modules/checker";
+import { ODEventManager } from "./modules/event";
+import { ODPluginManager } from "./modules/plugin";
+import { ODFlagManager } from "./modules/flag";
+import { ODProgressBarManager } from "./modules/progressbar";
+import { ODConfigManager } from "./modules/config";
+import { ODDatabaseManager } from "./modules/database";
+import { ODSessionManager } from "./modules/session";
+import { ODLanguageManager } from "./modules/language";
+import { ODBuilderManager } from "./modules/builder";
+import { ODResponderManager } from "./modules/responder";
+import { ODActionManager } from "./modules/action";
+import { ODVerifyBarManager } from "./modules/verifybar";
+import { ODPermissionManager } from "./modules/permission";
+import { ODCooldownManager } from "./modules/cooldown";
+import { ODHelpMenuManager } from "./modules/helpmenu";
+import { ODStatsManager } from "./modules/stat";
+import { ODCodeManager } from "./modules/code";
+import { ODPostManager } from "./modules/post";
+import { ODClientManager } from "./modules/client";
+import { ODSharedFuseManager } from "./modules/fuse";
+import { ODStartScreenManager } from "./modules/startscreen";
+/**## ODMainManagers `interface`
+ * The global properties for the main class of the bot.
+ */
+export interface ODMainManagers {
+    /**The manager that handles all versions in the bot. */
+    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 progress bars in the console. */
+    progressbars: ODProgressBarManager;
+    /**The manager that manages & contains all the config files of the bot. (like `config/general.json`) */
+    configs: ODConfigManager;
+    /**The manager that manages & contains all the databases of the bot. (like `database/global.json`) */
+    databases: ODDatabaseManager;
+    /**The manager that manages all the data sessions of the bot. (it's a temporary database) */
+    sessions: ODSessionManager;
+    /**The manager that manages all languages & translations of the bot. (but not 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) */
+    checkers: ODCheckerManager;
+    /**The manager that manages all builders in the bot. (e.g. buttons, dropdowns, messages, modals, etc) */
+    builders: ODBuilderManager;
+    /**The manager that manages all responders in the bot. (e.g. 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) */
+    actions: ODActionManager;
+    /**The manager that manages all verify bars in the bot. (the ✅ ❌ buttons) */
+    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) */
+    permissions: ODPermissionManager;
+    /**The manager that contains all cooldowns of the bot. (e.g. ticket-cooldowns) */
+    cooldowns: ODCooldownManager;
+    /**The manager that manages & renders the Open Discord help menu. (not the embed, but the text) */
+    helpmenu: ODHelpMenuManager;
+    /**The manager that manages, saves & renders the Open Discord statistics. (not the embed, but the text & database) */
+    stats: ODStatsManager;
+    /**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) */
+    code: ODCodeManager;
+    /**The manager that manages all posts (static discord channels) in the bot. (e.g. transcripts, logs, etc) */
+    posts: ODPostManager;
+    /**The manager responsible for everything related to the client. (e.g. status, login, slash & text commands, etc) */
+    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.  */
+    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)  */
+    env: ODEnvHelper;
+    /**The manager responsible for the livestatus system. (remote console logs) */
+    livestatus: ODLiveStatusManager;
+    /**The manager responsible for the livestatus system. (remote console logs) */
+    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 declare class ODMain implements ODMainManagers {
+    readonly project: ODProjectType;
+    readonly versions: ODVersionManager;
+    readonly processStartupDate: Date;
+    readyStartupDate: Date | 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 responders: ODResponderManager;
+    readonly actions: ODActionManager;
+    readonly verifybars: ODVerifyBarManager;
+    readonly permissions: ODPermissionManager;
+    readonly cooldowns: ODCooldownManager;
+    readonly helpmenu: ODHelpMenuManager;
+    readonly stats: ODStatsManager;
+    readonly code: ODCodeManager;
+    readonly posts: ODPostManager;
+    readonly client: ODClientManager;
+    readonly sharedFuses: ODSharedFuseManager;
+    readonly env: ODEnvHelper;
+    readonly livestatus: ODLiveStatusManager;
+    readonly startscreen: ODStartScreenManager;
+    constructor(managers: ODMainManagers, project: ODProjectType);
+    /**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;
+}

package/dist/api/main.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ODMain = void 0;
+//BASE MODULES
+const base_1 = require("./modules/base");
+const console_1 = require("./modules/console");
+/**## 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`!
+ */
+class ODMain {
+    project;
+    versions;
+    processStartupDate = new Date();
+    readyStartupDate = null;
+    debugfile;
+    console;
+    debug;
+    events;
+    plugins;
+    flags;
+    progressbars;
+    configs;
+    databases;
+    sessions;
+    languages;
+    checkers;
+    builders;
+    responders;
+    actions;
+    verifybars;
+    permissions;
+    cooldowns;
+    helpmenu;
+    stats;
+    code;
+    posts;
+    client;
+    sharedFuses;
+    env;
+    livestatus;
+    startscreen;
+    constructor(managers, project) {
+        this.project = project;
+        this.versions = managers.versions;
+        this.versions.add(base_1.ODVersion.fromString("opendiscord:api", "v1.0.0"));
+        this.versions.add(base_1.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.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.stats = managers.stats;
+        this.code = managers.code;
+        this.posts = managers.posts;
+        this.sharedFuses = managers.sharedFuses;
+        this.env = managers.env;
+        this.livestatus = managers.livestatus;
+        this.startscreen = managers.startscreen;
+    }
+    log(message, type, params) {
+        if (message instanceof console_1.ODConsoleMessage)
+            this.console.log(message);
+        else if (message instanceof console_1.ODError)
+            this.console.log(message);
+        else if (["string", "number", "boolean", "object"].includes(typeof message))
+            this.console.log(message, type, params);
+    }
+}
+exports.ODMain = ODMain;

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

@@ -0,0 +1,34 @@
+import { ODManager, ODValidId, ODManagerData } from "./base";
+import { ODWorkerManager, ODWorkerCallback } from "./worker";
+import { ODDebugger } from "./console";
+/**## 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 declare class ODActionImplementation<Source extends string, Params extends object, Result extends object> extends ODManagerData {
+    /**The manager that has all workers of this implementation */
+    workers: ODWorkerManager<object, Source, Params>;
+    constructor(id: ODValidId, callback?: ODWorkerCallback<object, Source, Params>, priority?: number, callbackId?: ODValidId);
+    /**Execute all workers & return the result. */
+    run(source: Source, params: Params): Promise<Partial<Result>>;
+}
+/**## 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 declare class ODActionManager extends ODManager<ODAction<string, {}, {}>> {
+    constructor(debug: ODDebugger);
+}
+export declare class ODAction<Source extends string, Params extends object, Result extends object> extends ODActionImplementation<Source, Params, Result> {
+    /**Run this action */
+    run(source: Source, params: Params): Promise<Partial<Result>>;
+}

package/dist/api/modules/action.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ODAction = exports.ODActionManager = exports.ODActionImplementation = void 0;
+///////////////////////////////////////
+//ACTION MODULE
+///////////////////////////////////////
+const base_1 = require("./base");
+const worker_1 = require("./worker");
+/**## 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!
+ */
+class ODActionImplementation extends base_1.ODManagerData {
+    /**The manager that has all workers of this implementation */
+    workers;
+    constructor(id, callback, priority, callbackId) {
+        super(id);
+        this.workers = new worker_1.ODWorkerManager("descending");
+        if (callback)
+            this.workers.add(new worker_1.ODWorker(callbackId ? callbackId : id, priority ?? 0, callback));
+    }
+    /**Execute all workers & return the result. */
+    async run(source, params) {
+        throw new base_1.ODSystemError("Tried to build an unimplemented ODResponderImplementation");
+    }
+}
+exports.ODActionImplementation = ODActionImplementation;
+/**## 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!
+ */
+class ODActionManager extends base_1.ODManager {
+    constructor(debug) {
+        super(debug, "action");
+    }
+}
+exports.ODActionManager = ODActionManager;
+class ODAction extends ODActionImplementation {
+    /**Run this action */
+    async run(source, params) {
+        //create instance
+        const instance = {};
+        //wait for workers to finish
+        await this.workers.executeWorkers(instance, source, params);
+        //return data generated by workers
+        return instance;
+    }
+}
+exports.ODAction = ODAction;