@open-discord-bots/framework 0.5.2 → 0.5.4

package/dist/api/index.d.ts

@@ -4,7 +4,6 @@ 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";
@@ -24,5 +23,6 @@ export * from "./modules/session.js";
 export * from "./modules/startscreen.js";
 export * from "./modules/state.js";
 export * from "./modules/statistic.js";
+export * from "./modules/task.js";
 export * from "./modules/verifybar.js";
 export * from "./modules/worker.js";

package/dist/api/index.js

@@ -6,7 +6,6 @@ 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";
@@ -26,5 +25,6 @@ export * from "./modules/session.js";
 export * from "./modules/startscreen.js";
 export * from "./modules/state.js";
 export * from "./modules/statistic.js";
+export * from "./modules/task.js";
 export * from "./modules/verifybar.js";
 export * from "./modules/worker.js";

package/dist/api/main.d.ts

@@ -17,7 +17,7 @@ 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 { ODTaskManager } from "./modules/task.js";
 import { ODPostManager } from "./modules/post.js";
 import { ODClientManager } from "./modules/client.js";
 import { ODSharedFuseManager } from "./modules/fuse.js";
@@ -80,8 +80,8 @@ export interface ODMainManagers {
     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 place to put general-purpose code and background tasks which will execute on startup. */
+    tasks: ODTaskManager;
     /**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. */
@@ -129,7 +129,7 @@ export declare abstract class ODMain implements ODMainManagers {
     readonly cooldowns: ODCooldownManager;
     readonly helpmenu: ODHelpMenuManager;
     readonly statistics: ODStatisticManager;
-    readonly code: ODCodeManager;
+    readonly tasks: ODTaskManager;
     readonly posts: ODPostManager;
     readonly states: ODStateManager;
     readonly client: ODClientManager;

package/dist/api/main.js

@@ -33,7 +33,7 @@ export class ODMain {
     cooldowns;
     helpmenu;
     statistics;
-    code;
+    tasks;
     posts;
     states;
     client;
@@ -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.5.2"));
+        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.5.4"));
         this.versions.add(ODVersion.fromString("opendiscord:livestatus", "v2.0.0"));
         this.debugfile = managers.debugfile;
         this.console = managers.console;
@@ -68,7 +68,7 @@ export class ODMain {
         this.cooldowns = managers.cooldowns;
         this.helpmenu = managers.helpmenu;
         this.statistics = managers.statistics;
-        this.code = managers.code;
+        this.tasks = managers.tasks;
         this.posts = managers.posts;
         this.states = managers.states;
         this.sharedFuses = managers.sharedFuses;

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

@@ -97,6 +97,7 @@ export declare class ODJsonDatabase<IdList extends ODDatabaseIdConstraint = ODDa
      * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
      * //You need an ODJsonDatabase class named "database" for this example to work!
      */
+    set<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string, value: IdList[CategoryId]): ODOptionalPromise<boolean>;
     set(category: string, key: string, value: ODValidJsonType): ODOptionalPromise<boolean>;
     /**Get the value of `category` & `key`. Returns `undefined` when non-existent!
      * @example
@@ -110,8 +111,10 @@ export declare class ODJsonDatabase<IdList extends ODDatabaseIdConstraint = ODDa
      * const didExist = database.deleteData("category","key") //delete this value
      * //You need an ODJsonDatabase class named "database" for this example to work!
      */
+    delete<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<boolean>;
     delete(category: string, key: string): ODOptionalPromise<boolean>;
     /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
+    exists(category: keyof ODNoGeneric<IdList>, key: string): ODOptionalPromise<boolean>;
     exists(category: string, key: string): ODOptionalPromise<boolean>;
     /**Get all values in `category`. Returns `undefined` when non-existent! */
     getCategory<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId): ODOptionalPromise<{
@@ -145,6 +148,7 @@ export declare class ODFormattedJsonDatabase<IdList extends ODDatabaseIdConstrai
      * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
      * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
      */
+    set<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string, value: IdList[CategoryId]): ODOptionalPromise<boolean>;
     set(category: string, key: string, value: ODValidJsonType): ODOptionalPromise<boolean>;
     /**Get the value of `category` & `key`. Returns `undefined` when non-existent!
      * @example
@@ -158,8 +162,10 @@ export declare class ODFormattedJsonDatabase<IdList extends ODDatabaseIdConstrai
      * const didExist = database.deleteData("category","key") //delete this value
      * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
      */
+    delete<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId, key: string): ODOptionalPromise<boolean>;
     delete(category: string, key: string): ODOptionalPromise<boolean>;
     /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
+    exists(category: keyof ODNoGeneric<IdList>, key: string): ODOptionalPromise<boolean>;
     exists(category: string, key: string): ODOptionalPromise<boolean>;
     /**Get all values in `category`. Returns `undefined` when non-existent! */
     getCategory<CategoryId extends keyof ODNoGeneric<IdList>>(category: CategoryId): ODOptionalPromise<{

package/dist/api/modules/database.js

@@ -65,11 +65,6 @@ export class ODJsonDatabase extends ODDatabase {
     init() {
         this.#system.getData();
     }
-    /**Set/overwrite the value of `category` & `key`. Returns `true` when overwritten!
-     * @example
-     * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
-     * //You need an ODJsonDatabase class named "database" for this example to work!
-     */
     set(category, key, value) {
         const currentList = this.#system.getData();
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key));
@@ -88,11 +83,6 @@ export class ODJsonDatabase extends ODDatabase {
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key));
         return tempresult ? tempresult.value : undefined;
     }
-    /**Remove the value of `category` & `key`. Returns `undefined` when non-existent!
-     * @example
-     * const didExist = database.deleteData("category","key") //delete this value
-     * //You need an ODJsonDatabase class named "database" for this example to work!
-     */
     delete(category, key) {
         const currentList = this.#system.getData();
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key));
@@ -101,7 +91,6 @@ export class ODJsonDatabase extends ODDatabase {
         this.#system.setData(currentList);
         return currentData ? true : false;
     }
-    /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
     exists(category, key) {
         const currentList = this.#system.getData();
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key));
@@ -160,11 +149,6 @@ export class ODFormattedJsonDatabase extends ODDatabase {
     init() {
         this.#system.getData();
     }
-    /**Set/overwrite the value of `category` & `key`. Returns `true` when overwritten!
-     * @example
-     * const didOverwrite = database.setData("category","key","value") //value can be any of the valid types
-     * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
-     */
     set(category, key, value) {
         const currentList = this.#system.getData();
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key));
@@ -183,11 +167,6 @@ export class ODFormattedJsonDatabase extends ODDatabase {
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key));
         return tempresult ? tempresult.value : undefined;
     }
-    /**Remove the value of `category` & `key`. Returns `undefined` when non-existent!
-     * @example
-     * const didExist = database.deleteData("category","key") //delete this value
-     * //You need an ODFormattedJsonDatabase class named "database" for this example to work!
-     */
     delete(category, key) {
         const currentList = this.#system.getData();
         const currentData = currentList.find((d) => (d.category === category) && (d.key === key));
@@ -196,7 +175,6 @@ export class ODFormattedJsonDatabase extends ODDatabase {
         this.#system.setData(currentList);
         return currentData ? true : false;
     }
-    /**Check if a value of `category` & `key` exists. Returns `false` when non-existent! */
     exists(category, key) {
         const currentList = this.#system.getData();
         const tempresult = currentList.find((d) => (d.category === category) && (d.key === key));

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

@@ -198,10 +198,10 @@ export interface ODSharedFuseList {
     statisticLoading: boolean;
     /**Initiate the default Open Discord statistics. */
     statisticInitiating: boolean;
-    /**Load the default Open Discord code/functions. */
-    codeLoading: boolean;
-    /**Execute the default Open Discord code/functions. */
-    codeExecution: boolean;
+    /**Load the default Open Discord task/functions. */
+    taskLoading: boolean;
+    /**Execute the default Open Discord task/functions. */
+    taskExecution: boolean;
     /**Load the default Open Discord livestatus. */
     liveStatusLoading: boolean;
     /**Load the default Open Discord startscreen. */

package/dist/api/modules/fuse.js

@@ -110,8 +110,8 @@ export class ODSharedFuseManager extends ODFuseManager {
             statisticScopesLoading: true,
             statisticLoading: true,
             statisticInitiating: true,
-            codeLoading: true,
-            codeExecution: true,
+            taskLoading: true,
+            taskExecution: true,
             liveStatusLoading: true,
             startScreenLoading: true,
             startScreenRendering: true,

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

@@ -0,0 +1,43 @@
+import { ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js";
+import { ODDebugger } from "./console.js";
+/**## ODTask `class`
+ * This is an Open Discord task runner.
+ *
+ * Use this to execute a function just before the startup screen. (with more than 90% of the code already loaded)
+ * You can also specify a priority to change the execution order.
+ * In Open Ticket, this is used for the following processes:
+ * - Autoclose/delete
+ * - Database syncronisation (with tickets, statistics & used options)
+ * - Panel auto-update
+ * - Database Garbage Collection (removing tickets that don't exist anymore)
+ * - And more!
+ */
+export declare class ODTask extends ODManagerData {
+    /**The priority of this task */
+    priority: number;
+    /**The main function of this task */
+    func: () => void | Promise<void>;
+    constructor(id: ODValidId, priority: number, func: () => void | Promise<void>);
+}
+/**## ODTaskManagerIdConstraint `type`
+ * The constraint/layout for id mappings/interfaces of the `ODTaskManager` class.
+ */
+export type ODTaskManagerIdConstraint = Record<string, ODTask>;
+/**## ODTaskManager `class`
+ * This is an Open Discord task manager.
+ *
+ * It manages & executes `ODTask`'s in the correct order.
+ *
+ * Register functions/tasks that execute just before the startup screen. (with more than 90% of the code already loaded)
+ */
+export declare class ODTaskManager<IdList extends ODTaskManagerIdConstraint = ODTaskManagerIdConstraint> extends ODManager<ODTask> {
+    constructor(debug: ODDebugger);
+    /**Execute all `ODTask` functions in order of their priority (high to low). */
+    execute(): Promise<void>;
+    get<TaskId extends keyof ODNoGeneric<IdList>>(id: TaskId): IdList[TaskId];
+    get(id: ODValidId): ODTask | null;
+    remove<TaskId extends keyof ODNoGeneric<IdList>>(id: TaskId): IdList[TaskId];
+    remove(id: ODValidId): ODTask | null;
+    exists(id: keyof ODNoGeneric<IdList>): boolean;
+    exists(id: ODValidId): boolean;
+}

package/dist/api/modules/{code.js → task.js}

@@ -1,23 +1,23 @@
 ///////////////////////////////////////
-//CODE MODULE
+//TASK MODULE
 ///////////////////////////////////////
 import { ODManager, ODManagerData } from "./base.js";
-/**## ODCode `class`
- * This is an Open Discord code runner.
+/**## ODTask `class`
+ * This is an Open Discord task runner.
  *
- * Using this, you're able to execute a function just before the startup screen. (90% of the code is already loaded)
+ * Use this to execute a function just before the startup screen. (with more than 90% of the code already loaded)
  * You can also specify a priority to change the execution order.
- * In Open Discord, this is used for the following processes:
+ * In Open Ticket, this is used for the following processes:
  * - Autoclose/delete
  * - Database syncronisation (with tickets, statistics & used options)
  * - Panel auto-update
  * - Database Garbage Collection (removing tickets that don't exist anymore)
  * - And more!
  */
-export class ODCode extends ODManagerData {
-    /**The priority of this code */
+export class ODTask extends ODManagerData {
+    /**The priority of this task */
     priority;
-    /**The main function of this code */
+    /**The main function of this task */
     func;
     constructor(id, priority, func) {
         super(id);
@@ -25,18 +25,18 @@ export class ODCode extends ODManagerData {
         this.func = func;
     }
 }
-/**## ODCodeManager `class`
- * This is an Open Discord code manager.
+/**## ODTaskManager `class`
+ * This is an Open Discord task manager.
  *
- * It manages & executes `ODCode`'s in the correct order.
+ * It manages & executes `ODTask`'s in the correct order.
  *
- * Use this to register a function/code which executes just before the startup screen. (90% is already loaded)
+ * Register functions/tasks that execute just before the startup screen. (with more than 90% of the code already loaded)
  */
-export class ODCodeManager extends ODManager {
+export class ODTaskManager extends ODManager {
     constructor(debug) {
-        super(debug, "code");
+        super(debug, "task");
     }
-    /**Execute all `ODCode` functions in order of their priority (high to low). */
+    /**Execute all `ODTask` functions in order of their priority (high to low). */
     async execute() {
         const derefArray = [...this.getAll()];
         const workers = derefArray.sort((a, b) => b.priority - a.priority);

package/package.json

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

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

@@ -1,43 +0,0 @@
-import { ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js";
-import { ODDebugger } from "./console.js";
-/**## ODCode `class`
- * This is an Open Discord code runner.
- *
- * Using this, you're able to execute a function just before the startup screen. (90% of the code is already loaded)
- * You can also specify a priority to change the execution order.
- * In Open Discord, this is used for the following processes:
- * - Autoclose/delete
- * - Database syncronisation (with tickets, statistics & used options)
- * - Panel auto-update
- * - Database Garbage Collection (removing tickets that don't exist anymore)
- * - And more!
- */
-export declare class ODCode extends ODManagerData {
-    /**The priority of this code */
-    priority: number;
-    /**The main function of this code */
-    func: () => void | Promise<void>;
-    constructor(id: ODValidId, priority: number, func: () => void | Promise<void>);
-}
-/**## ODCodeManagerIdConstraint `type`
- * The constraint/layout for id mappings/interfaces of the `ODCodeManager` class.
- */
-export type ODCodeManagerIdConstraint = Record<string, ODCode>;
-/**## ODCodeManager `class`
- * This is an Open Discord code manager.
- *
- * It manages & executes `ODCode`'s in the correct order.
- *
- * Use this to register a function/code which executes just before the startup screen. (90% is already loaded)
- */
-export declare class ODCodeManager<IdList extends ODCodeManagerIdConstraint = ODCodeManagerIdConstraint> extends ODManager<ODCode> {
-    constructor(debug: ODDebugger);
-    /**Execute all `ODCode` functions in order of their priority (high to low). */
-    execute(): Promise<void>;
-    get<CodeId extends keyof ODNoGeneric<IdList>>(id: CodeId): IdList[CodeId];
-    get(id: ODValidId): ODCode | null;
-    remove<CodeId extends keyof ODNoGeneric<IdList>>(id: CodeId): IdList[CodeId];
-    remove(id: ODValidId): ODCode | null;
-    exists(id: keyof ODNoGeneric<IdList>): boolean;
-    exists(id: ODValidId): boolean;
-}