@open-discord-bots/framework 0.2.17 → 0.3.0

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

@@ -31,7 +31,7 @@ export declare class ODConfigManager<IdList extends ODConfigManagerIdConstraint
  *
  * You can use this class if you want to create your own config implementation (e.g. `yml`, `xml`,...)!
  */
-export declare class ODConfig<Data extends any> extends ODManagerData {
+export declare abstract class ODConfig<Data extends any> extends ODManagerData {
     /**The name of the file with extension. */
     file: string;
     /**The path to the file relative to the main directory. */
@@ -78,3 +78,32 @@ export declare class ODJsonConfig<Data extends any> extends ODConfig<Data> {
     /**Save the edited config to the filesystem. This is used by the Interactive Setup CLI. It's not recommended to use this while the bot is running. */
     save(): ODPromiseVoid;
 }
+/**## ODJsonCommentsConfig `class`
+ * An Open Discord JSONC (`.jsonc`) config.
+ * Use this class to get & edit variables from the config files or to create your own JSON config!
+ * @example
+ * //create a config from: ./config/test.jsonc with the id "some-config"
+ * const config = new api.ODJsonCommentsConfig("some-config","test.jsonc")
+ *
+ * //create a config with custom dir: ./plugins/testplugin/test.jsonc
+ * const config = new api.ODJsonCommentsConfig("plugin-config","test.jsonc","./plugins/testplugin/")
+ */
+export declare class ODJsonCommentsConfig<Data extends any> extends ODConfig<Data> {
+    formatter: fjs.custom.BaseFormatter;
+    constructor(id: ODValidId, file: string, customPath?: string, formatter?: fjs.custom.BaseFormatter);
+    /**Init the config. */
+    init(): ODPromiseVoid;
+    /**Reload the config. Be aware that this doesn't update the config data everywhere in the bot! */
+    reload(): void;
+    /**Save the edited config to the filesystem. This is used by the Interactive Setup CLI. It's not recommended to use this while the bot is running. */
+    save(): ODPromiseVoid;
+}
+/**## ODMemoryConfig `class`
+ * An Open Discord memory config.
+ * This config lives in-memory and does not have any connection to the filesystem.
+ *
+ * It is perfect for temporary configs or using the `ODChecker` without a real config file.
+ */
+export declare class ODMemoryConfig<Data extends any> extends ODConfig<Data> {
+    constructor(id: ODValidId, data: Data);
+}

package/dist/api/modules/config.js

@@ -5,6 +5,7 @@ import { ODManager, ODManagerData, ODSystemError } from "./base.js";
 import nodepath from "path";
 import fs from "fs";
 import * as fjs from "formatted-json-stringify";
+import { jsonc } from "jsonc";
 /**## ODConfigManager `class`
  * This is an Open Discord config manager.
  *
@@ -171,3 +172,83 @@ export class ODJsonConfig extends ODConfig {
         }
     }
 }
+/**## ODJsonCommentsConfig `class`
+ * An Open Discord JSONC (`.jsonc`) config.
+ * Use this class to get & edit variables from the config files or to create your own JSON config!
+ * @example
+ * //create a config from: ./config/test.jsonc with the id "some-config"
+ * const config = new api.ODJsonCommentsConfig("some-config","test.jsonc")
+ *
+ * //create a config with custom dir: ./plugins/testplugin/test.jsonc
+ * const config = new api.ODJsonCommentsConfig("plugin-config","test.jsonc","./plugins/testplugin/")
+ */
+export class ODJsonCommentsConfig extends ODConfig {
+    formatter;
+    constructor(id, file, customPath, formatter) {
+        super(id, {});
+        this.file = (file.endsWith(".jsonc")) ? file : file + ".jsonc";
+        this.path = customPath ? nodepath.join("./", customPath, this.file) : nodepath.join("./config/", this.file);
+        this.formatter = formatter ?? new fjs.DefaultFormatter(null, true, "    ");
+    }
+    /**Init the config. */
+    init() {
+        if (!fs.existsSync(this.path))
+            throw new ODSystemError("Unable to parse JSONC config \"" + nodepath.join("./", this.path) + "\", the file doesn't exist!");
+        try {
+            this.data = jsonc.parse(fs.readFileSync(this.path).toString());
+            super.init();
+        }
+        catch (err) {
+            process.emit("uncaughtException", err);
+            throw new ODSystemError("Unable to parse JSONC config \"" + nodepath.join("./", this.path) + "\"!");
+        }
+    }
+    /**Reload the config. Be aware that this doesn't update the config data everywhere in the bot! */
+    reload() {
+        if (!this.initiated)
+            throw new ODSystemError("Unable to reload JSONC config \"" + nodepath.join("./", this.path) + "\", the file hasn't been initiated yet!");
+        if (!fs.existsSync(this.path))
+            throw new ODSystemError("Unable to JSONC reload config \"" + nodepath.join("./", this.path) + "\", the file doesn't exist!");
+        try {
+            this.data = jsonc.parse(fs.readFileSync(this.path).toString());
+            super.reload();
+            this.reloadListeners.forEach((cb) => {
+                try {
+                    cb();
+                }
+                catch (err) {
+                    process.emit("uncaughtException", err);
+                }
+            });
+        }
+        catch (err) {
+            process.emit("uncaughtException", err);
+            throw new ODSystemError("Unable to reload JSONC config \"" + nodepath.join("./", this.path) + "\"!");
+        }
+    }
+    /**Save the edited config to the filesystem. This is used by the Interactive Setup CLI. It's not recommended to use this while the bot is running. */
+    save() {
+        if (!this.initiated)
+            throw new ODSystemError("Unable to save JSONC config \"" + nodepath.join("./", this.path) + "\", the file hasn't been initiated yet!");
+        try {
+            const contents = this.formatter.stringify(this.data);
+            fs.writeFileSync(this.path, contents);
+            super.save();
+        }
+        catch (err) {
+            process.emit("uncaughtException", err);
+            throw new ODSystemError("Unable to save JSONC config \"" + nodepath.join("./", this.path) + "\"!");
+        }
+    }
+}
+/**## ODMemoryConfig `class`
+ * An Open Discord memory config.
+ * This config lives in-memory and does not have any connection to the filesystem.
+ *
+ * It is perfect for temporary configs or using the `ODChecker` without a real config file.
+ */
+export class ODMemoryConfig extends ODConfig {
+    constructor(id, data) {
+        super(id, data);
+    }
+}

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

@@ -42,19 +42,19 @@ export declare class ODCooldownData<Data extends object> extends ODManagerData {
  *
  * There are also premade cooldowns available in the bot!
  */
-export declare class ODCooldown<Data extends object> extends ODManagerData {
+export declare abstract class ODCooldown<Data extends object> extends ODManagerData {
     data: ODManager<ODCooldownData<Data>>;
     /**Is this cooldown already initialized? */
     ready: boolean;
     constructor(id: ODValidId);
     /**Check this id and start cooldown when it exeeds the limit! Returns `true` when on cooldown! */
-    use(id: string): boolean;
+    abstract use(id: string): boolean;
     /**Check this id without starting or updating the cooldown. Returns `true` when on cooldown! */
-    check(id: string): boolean;
+    abstract check(id: string): boolean;
     /**Remove the cooldown for an id when available.*/
-    delete(id: string): void;
+    abstract delete(id: string): void;
     /**Initialize the internal systems of this cooldown. */
-    init(): Promise<void>;
+    abstract init(): Promise<void> | void;
 }
 /**## ODCounterCooldown `class`
  * This is an Open Discord counter cooldown.

package/dist/api/modules/cooldown.js

@@ -1,7 +1,7 @@
 ///////////////////////////////////////
 //COOLDOWN MODULE
 ///////////////////////////////////////
-import { ODManager, ODSystemError, ODManagerData } from "./base.js";
+import { ODManager, ODManagerData } from "./base.js";
 /**## ODCooldownManager `class`
  * This is an Open Discord cooldown manager.
  *
@@ -60,22 +60,6 @@ export class ODCooldown extends ODManagerData {
     constructor(id) {
         super(id);
     }
-    /**Check this id and start cooldown when it exeeds the limit! Returns `true` when on cooldown! */
-    use(id) {
-        throw new ODSystemError("Tried to use an unimplemented ODCooldown!");
-    }
-    /**Check this id without starting or updating the cooldown. Returns `true` when on cooldown! */
-    check(id) {
-        throw new ODSystemError("Tried to use an unimplemented ODCooldown!");
-    }
-    /**Remove the cooldown for an id when available.*/
-    delete(id) {
-        throw new ODSystemError("Tried to use an unimplemented ODCooldown!");
-    }
-    /**Initialize the internal systems of this cooldown. */
-    async init() {
-        throw new ODSystemError("Tried to use an unimplemented ODCooldown!");
-    }
 }
 /**## ODCounterCooldown `class`
  * This is an Open Discord counter cooldown.

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

@@ -33,36 +33,44 @@ export type ODDatabaseIdConstraint = Record<string, ODValidJsonType>;
  *
  * You can use this class if you want to create your own database implementation (e.g. `mongodb`, `mysql`,...)!
  */
-export declare class ODDatabase<IdList extends ODDatabaseIdConstraint = ODDatabaseIdConstraint> extends ODManagerData {
+export declare abstract class ODDatabase<IdList extends ODDatabaseIdConstraint = ODDatabaseIdConstraint> extends ODManagerData {
     /**The name of the file with extension. */
     file: string;
     /**The path to the file relative to the main directory. */
     path: string;
     /**Init the database. */
-    init(): ODPromiseVoid;
+    abstract init(): ODPromiseVoid;
     /**Add/Overwrite a specific category & key in the database. Returns `true` when overwritten. */
-    set<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string, value: IdList[CategoryId]): ODOptionalPromise<boolean>;
-    set(category: string, key: string, value: ODValidJsonType): ODOptionalPromise<boolean>;
+    abstract set<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string, value: IdList[CategoryId]): ODOptionalPromise<boolean>;
+    abstract set(category: string, key: string, value: ODValidJsonType): ODOptionalPromise<boolean>;
+    abstract set(category: string, key: string, value: ODValidJsonType): ODOptionalPromise<boolean>;
     /**Get a specific category & key in the database */
-    get<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<IdList[CategoryId] | undefined>;
-    get(category: string, key: string): ODOptionalPromise<ODValidJsonType | undefined>;
+    abstract get<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<IdList[CategoryId] | undefined>;
+    abstract get(category: string, key: string): ODOptionalPromise<ODValidJsonType | undefined>;
+    abstract get(category: string, key: string): ODOptionalPromise<ODValidJsonType | undefined>;
     /**Delete a specific category & key in the database */
-    delete<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<boolean>;
-    delete(category: string, key: string): ODOptionalPromise<boolean>;
+    abstract delete<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<boolean>;
+    abstract delete(category: string, key: string): ODOptionalPromise<boolean>;
+    abstract delete(category: string, key: string): ODOptionalPromise<boolean>;
     /**Check if a specific category & key exists in the database */
-    exists(category: keyof ODNoGeneric<IdList>, key: string): ODOptionalPromise<boolean>;
-    exists(category: string, key: string): ODOptionalPromise<boolean>;
+    abstract exists(category: keyof ODNoGeneric<IdList>, key: string): ODOptionalPromise<boolean>;
+    abstract exists(category: string, key: string): ODOptionalPromise<boolean>;
+    abstract exists(category: string, key: string): ODOptionalPromise<boolean>;
     /**Get a specific category in the database */
-    getCategory<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId): ODOptionalPromise<{
+    abstract getCategory<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId): ODOptionalPromise<{
         key: string;
         value: IdList[CategoryId];
     }[] | undefined>;
-    getCategory(category: string): ODOptionalPromise<{
+    abstract getCategory(category: string): ODOptionalPromise<{
+        key: string;
+        value: ODValidJsonType;
+    }[] | undefined>;
+    abstract getCategory(category: string): ODOptionalPromise<{
         key: string;
         value: ODValidJsonType;
     }[] | undefined>;
     /**Get all values in the database */
-    getAll(): ODOptionalPromise<ODJsonDatabaseStructure>;
+    abstract getAll(): ODOptionalPromise<ODJsonDatabaseStructure>;
 }
 /**## ODJsonDatabaseStructure `type`
  * This is the structure of how a JSON database file!

package/dist/api/modules/database.js

@@ -47,29 +47,6 @@ export class ODDatabase extends ODManagerData {
     file = "";
     /**The path to the file relative to the main directory. */
     path = "";
-    /**Init the database. */
-    init() {
-        //nothing
-    }
-    set(category, key, value) {
-        return false;
-    }
-    get(category, key) {
-        return undefined;
-    }
-    delete(category, key) {
-        return false;
-    }
-    exists(category, key) {
-        return false;
-    }
-    getCategory(category) {
-        return undefined;
-    }
-    /**Get all values in the database */
-    getAll() {
-        return [];
-    }
 }
 /**## ODJsonDatabase `class`
  * This is an Open Discord JSON database.

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

@@ -1,20 +1,16 @@
 import { ODId, ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js";
 import { ODDebugger } from "./console.js";
-/**## ODHelpMenuComponentRenderer `type`
- * This is the callback of the help menu component renderer. It also contains information about how & where it is rendered.
- */
-export type ODHelpMenuComponentRenderer = (page: number, category: number, location: number, mode: "slash" | "text") => string | Promise<string>;
 /**## ODHelpMenuComponent `class`
  * This is an Open Discord help menu component.
  *
  * It can render something on the Open Discord help menu.
  */
-export declare class ODHelpMenuComponent extends ODManagerData {
+export declare abstract class ODHelpMenuComponent extends ODManagerData {
     /**The priority of this component. The higher, the earlier it will appear in the help menu. */
     priority: number;
+    constructor(id: ODValidId, priority: number);
     /**The render function for this component. */
-    render: ODHelpMenuComponentRenderer;
-    constructor(id: ODValidId, priority: number, render: ODHelpMenuComponentRenderer);
+    abstract render(page: number, category: number, location: number, mode: "slash" | "text"): string | Promise<string>;
 }
 /**## ODHelpMenuTextComponent `class`
  * This is an Open Discord help menu text component.
@@ -22,7 +18,10 @@ export declare class ODHelpMenuComponent extends ODManagerData {
  * It can render a static piece of text on the Open Discord help menu.
  */
 export declare class ODHelpMenuTextComponent extends ODHelpMenuComponent {
+    /**The text of this help menu component. */
+    text: string;
     constructor(id: ODValidId, priority: number, text: string);
+    render(page: number, category: number, location: number, mode: "slash" | "text"): string;
 }
 /**## ODHelpMenuCommandComponentOption `interface`
  * This interface contains a command option for the `ODHelpMenuCommandComponent`.
@@ -57,7 +56,10 @@ export interface ODHelpMenuCommandComponentSettings {
  */
 export declare class ODHelpMenuCommandComponent extends ODHelpMenuComponent {
     #private;
+    /**The settings for this help menu component. */
+    settings: ODHelpMenuCommandComponentSettings;
     constructor(id: ODValidId, priority: number, settings: ODHelpMenuCommandComponentSettings);
+    render(page: number, category: number, location: number, mode: "slash" | "text"): string;
 }
 /**## ODHelpMenuCategoryIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODHelpMenuCategory` class.

package/dist/api/modules/helpmenu.js

@@ -10,12 +10,9 @@ import { ODId, ODManager, ODManagerData, ODSystemError } from "./base.js";
 export class ODHelpMenuComponent extends ODManagerData {
     /**The priority of this component. The higher, the earlier it will appear in the help menu. */
     priority;
-    /**The render function for this component. */
-    render;
-    constructor(id, priority, render) {
+    constructor(id, priority) {
         super(id);
         this.priority = priority;
-        this.render = render;
     }
 }
 /**## ODHelpMenuTextComponent `class`
@@ -24,10 +21,14 @@ export class ODHelpMenuComponent extends ODManagerData {
  * It can render a static piece of text on the Open Discord help menu.
  */
 export class ODHelpMenuTextComponent extends ODHelpMenuComponent {
+    /**The text of this help menu component. */
+    text;
     constructor(id, priority, text) {
-        super(id, priority, () => {
-            return text;
-        });
+        super(id, priority);
+        this.text = text;
+    }
+    render(page, category, location, mode) {
+        return this.text;
     }
 }
 /**## ODHelpMenuCommandComponent `class`
@@ -36,17 +37,21 @@ export class ODHelpMenuTextComponent extends ODHelpMenuComponent {
  * It contains a useful helper to render a command in the Open Discord help menu.
  */
 export class ODHelpMenuCommandComponent extends ODHelpMenuComponent {
+    /**The settings for this help menu component. */
+    settings;
     constructor(id, priority, settings) {
-        super(id, priority, (page, category, location, mode) => {
-            if (mode == "slash" && settings.slashName) {
-                return `\`${settings.slashName}${(settings.slashOptions) ? this.#renderOptions(settings.slashOptions) : ""}\` ➜ ${settings.slashDescription ?? ""}`;
-            }
-            else if (mode == "text" && settings.textName) {
-                return `\`${settings.textName}${(settings.textOptions) ? this.#renderOptions(settings.textOptions) : ""}\` ➜ ${settings.textDescription ?? ""}`;
-            }
-            else
-                return "";
-        });
+        super(id, priority);
+        this.settings = settings;
+    }
+    render(page, category, location, mode) {
+        if (mode == "slash" && this.settings.slashName) {
+            return `\`${this.settings.slashName}${(this.settings.slashOptions) ? this.#renderOptions(this.settings.slashOptions) : ""}\` ➜ ${this.settings.slashDescription ?? ""}`;
+        }
+        else if (mode == "text" && this.settings.textName) {
+            return `\`${this.settings.textName}${(this.settings.textOptions) ? this.#renderOptions(this.settings.textOptions) : ""}\` ➜ ${this.settings.textDescription ?? ""}`;
+        }
+        else
+            return "";
     }
     /**Utility function to render all command options. */
     #renderOptions(options) {

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

@@ -71,7 +71,7 @@ export declare class ODLanguageManager<IdList extends ODLanguageManagerIdConstra
  *
  * JSON languages should be created using the `ODJsonLanguage` class instead!
  */
-export declare class ODLanguage extends ODManagerData {
+export declare abstract class ODLanguage extends ODManagerData {
     /**The name of the file with extension. */
     file: string;
     /**The path to the file relative to the main directory. */
@@ -82,7 +82,7 @@ export declare class ODLanguage extends ODManagerData {
     metadata: ODLanguageMetadata | null;
     constructor(id: ODValidId, data: any);
     /**Init the language. */
-    init(): ODPromiseVoid;
+    abstract init(): ODPromiseVoid;
 }
 /**## ODJsonLanguage `class`
  * This is an Open Discord JSON language file.

package/dist/api/modules/language.js

@@ -22,9 +22,9 @@ export class ODLanguageManager extends ODManager {
     constructor(debug, presets) {
         super(debug, "language");
         if (presets)
-            this.add(new ODLanguage("english", "english.json"));
-        this.current = presets ? new ODLanguage("english", "english.json") : null;
-        this.backup = presets ? new ODLanguage("english", "english.json") : null;
+            this.add(new ODJsonLanguage("english", "english.json"));
+        this.current = presets ? new ODJsonLanguage("english", "english.json") : null;
+        this.backup = presets ? new ODJsonLanguage("english", "english.json") : null;
         this.#debug = debug;
     }
     setCurrentLanguage(id) {
@@ -155,10 +155,6 @@ export class ODLanguage extends ODManagerData {
         super(id);
         this.data = data;
     }
-    /**Init the language. */
-    init() {
-        //nothing
-    }
 }
 /**## ODJsonLanguage `class`
  * This is an Open Discord JSON language file.

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

@@ -59,6 +59,7 @@ export declare class ODProgressBarRenderer<Settings extends {}> extends ODManage
     constructor(id: ODValidId, render: ODProgressBarRenderFunc<Settings>, settings: Settings);
     /**Render a progress bar using this renderer. */
     render(min: number, max: number, value: number, prefix: string | null, suffix: string | null): string;
+    /**Create a clone of this progress bar renderer, but with additional settings. */
     withAdditionalSettings(settings: Partial<Settings>): ODProgressBarRenderer<Settings>;
 }
 /**## ODProgressBar `class`
@@ -69,7 +70,7 @@ export declare class ODProgressBarRenderer<Settings extends {}> extends ODManage
  *
  * Use other classes as existing templates or create your own progress bar from scratch using this class.
  */
-export declare class ODProgressBar extends ODManagerData {
+export declare abstract class ODProgressBar extends ODManagerData {
     #private;
     /**The renderer of this progress bar. */
     renderer: ODProgressBarRenderer<{}>;

package/dist/api/modules/progressbar.js

@@ -74,13 +74,13 @@ export class ODProgressBarRenderer extends ODManagerData {
             return "<PROGRESS-BAR-ERROR>";
         }
     }
+    /**Create a clone of this progress bar renderer, but with additional settings. */
     withAdditionalSettings(settings) {
         const newSettings = { ...this.settings };
         for (const key of Object.keys(settings)) {
             if (typeof settings[key] != "undefined")
                 newSettings[key] = settings[key];
         }
-        const idk = Object.keys(settings);
         return new ODProgressBarRenderer(this.id, this.#render, newSettings);
     }
 }

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

@@ -11,14 +11,14 @@ import { ODDropdownData, ODMessageBuildResult, ODMessageBuildSentResult, ODModal
  *
  * This class can't be used stand-alone & needs to be extended from!
  */
-export declare class ODResponderImplementation<Instance, Origin extends string, Params, WorkerIds extends string = string> extends ODManagerData {
+export declare abstract class ODResponderImplementation<Instance, Origin extends string, Params, WorkerIds extends string = string> extends ODManagerData {
     /**The manager that has all workers of this implementation */
     workers: ODWorkerManager<Instance, Origin, Params, WorkerIds>;
     /**The `commandName` or `customId` needs to match this string or regex for this responder to be executed. */
     match: string | RegExp;
     constructor(id: ODValidId, match: string | RegExp, callback?: ODWorkerCallback<Instance, Origin, Params>, priority?: number, callbackId?: ODValidId);
     /**Execute all workers & return the result. */
-    respond(instance: Instance, origin: Origin, params: Params): Promise<void>;
+    abstract respond(instance: Instance, origin: Origin, params: Params): Promise<void>;
 }
 /**## ODResponderTimeoutErrorCallback `type`
  * This is the callback for the responder timeout function. It will be executed when something went wrong or the action takes too much time.

package/dist/api/modules/responder.js

@@ -24,10 +24,6 @@ export class ODResponderImplementation extends ODManagerData {
         if (callback)
             this.workers.add(new ODWorker(callbackId ? callbackId : id, priority ?? 0, callback));
     }
-    /**Execute all workers & return the result. */
-    async respond(instance, origin, params) {
-        throw new ODSystemError("Tried to build an unimplemented ODResponderImplementation");
-    }
 }
 /**## ODResponderManager `class`
  * This is an Open Discord responder manager.

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

@@ -41,7 +41,7 @@ export type ODSessionTimeoutCallback = (id: string, timeout: "default" | "custom
 /**## ODSession `class`
  * This is an Open Discord session.
  *
- * It can be used to create 100% unique id's for usage in the bot. An id can also store additional data which isn't saved to the filesystem.
+ * It can be used to create unique user sessions with an ID. Each session can store additional data which isn't saved to the filesystem.
  * You can almost compare it to the PHP session system.
  */
 export declare class ODSession extends ODManagerData {

package/dist/api/modules/session.js

@@ -28,7 +28,7 @@ export class ODSessionManager extends ODManager {
 /**## ODSession `class`
  * This is an Open Discord session.
  *
- * It can be used to create 100% unique id's for usage in the bot. An id can also store additional data which isn't saved to the filesystem.
+ * It can be used to create unique user sessions with an ID. Each session can store additional data which isn't saved to the filesystem.
  * You can almost compare it to the PHP session system.
  */
 export class ODSession extends ODManagerData {

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

@@ -40,7 +40,7 @@ export declare class ODStartScreenManager<IdList extends ODStartScreenManagerIdC
  *
  * It's recommended to use pre-built components except if you really need a custom one.
  */
-export declare class ODStartScreenComponent extends ODManagerData {
+export declare abstract class ODStartScreenComponent extends ODManagerData {
     /**The priority of this component. */
     priority: number;
     /**An optional render function which will be inserted before the default renderer. */
@@ -49,7 +49,7 @@ export declare class ODStartScreenComponent extends ODManagerData {
     render: ODStartScreenComponentRenderCallback;
     /**An optional render function which will be inserted behind the default renderer. */
     renderAfter: ODStartScreenComponentRenderCallback | null;
-    constructor(id: ODValidId, priority: number, render: ODStartScreenComponentRenderCallback);
+    constructor(id: ODValidId, priority: number, render: ODStartScreenComponentRenderCallback, renderBefore?: ODStartScreenComponentRenderCallback, renderAfter?: ODStartScreenComponentRenderCallback);
     /**Render this component and combine it with the `renderBefore` & `renderAfter` contents. */
     renderAll(location: number): Promise<string>;
 }

package/dist/api/modules/startscreen.js

@@ -68,15 +68,17 @@ export class ODStartScreenComponent extends ODManagerData {
     /**The priority of this component. */
     priority;
     /**An optional render function which will be inserted before the default renderer. */
-    renderBefore = null;
+    renderBefore;
     /**The render function which will render the contents of this component. */
     render;
     /**An optional render function which will be inserted behind the default renderer. */
-    renderAfter = null;
-    constructor(id, priority, render) {
+    renderAfter;
+    constructor(id, priority, render, renderBefore, renderAfter) {
         super(id);
         this.priority = priority;
         this.render = render;
+        this.renderBefore = renderBefore ?? null;
+        this.renderAfter = renderAfter ?? null;
     }
     /**Render this component and combine it with the `renderBefore` & `renderAfter` contents. */
     async renderAll(location) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.17",
+    "version": "0.3.0",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -16,7 +16,8 @@
         "@types/terminal-kit": "^2.5.7",
         "ansis": "^4.2.0",
         "discord.js": "^14.26.3",
-        "formatted-json-stringify": "^1.3.0",
+        "formatted-json-stringify": "^1.3.1",
+        "jsonc": "^2.0.0",
         "terminal-kit": "^3.1.2",
         "typescript": "^6.0.3"
     },

package/src/api/index.ts

@@ -2,28 +2,29 @@
 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"