@open-discord-bots/framework 0.2.11 → 0.2.12

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

@@ -2,7 +2,7 @@ import { ODManager, ODManagerData, ODValidId } from "./base";
 /**## ODWorkerCallback `type`
  * This is the callback used in `ODWorker`!
  */
-export type ODWorkerCallback<Instance, Source extends string, Params> = (instance: Instance, params: Params, source: Source, cancel: () => void) => void | Promise<void>;
+export type ODWorkerCallback<Instance, Origin extends string, Params> = (instance: Instance, params: Params, origin: Origin, cancel: () => void) => void | Promise<void>;
 /**## ODWorker `class`
  * This is an Open Discord worker.
  *
@@ -10,15 +10,15 @@ export type ODWorkerCallback<Instance, Source extends string, Params> = (instanc
  *
  * - It has an `id` for identification of the function
  * - A `priority` to know when to execute this callback (related to others)
- * - It knows who called this callback (`source`)
+ * - It knows who called this callback (`origin`)
  * - And much more!
  */
-export declare class ODWorker<Instance, Source extends string, Params> extends ODManagerData {
+export declare class ODWorker<Instance, Origin extends string, Params> extends ODManagerData {
     /**The priority of this worker */
     priority: number;
     /**The main callback of this worker */
-    callback: ODWorkerCallback<Instance, Source, Params>;
-    constructor(id: ODValidId, priority: number, callback: ODWorkerCallback<Instance, Source, Params>);
+    callback: ODWorkerCallback<Instance, Origin, Params>;
+    constructor(id: ODValidId, priority: number, callback: ODWorkerCallback<Instance, Origin, Params>);
 }
 /**## ODWorker `class`
  * This is an Open Discord worker manager.
@@ -27,21 +27,21 @@ export declare class ODWorker<Instance, Source extends string, Params> extends O
  *
  * You can register a custom worker in this class to create a message or button.
  */
-export declare class ODWorkerManager<Instance, Source extends string, Params, WorkerIds extends string = string> extends ODManager<ODWorker<Instance, Source, Params>> {
+export declare class ODWorkerManager<Instance, Origin extends string, Params, WorkerIds extends string = string> extends ODManager<ODWorker<Instance, Origin, Params>> {
     #private;
     /**The backup worker will be executed when one of the workers fails or cancels execution. */
     backupWorker: ODWorker<{
         reason: "error" | "cancel";
-    }, Source, Params> | null;
+    }, Origin, Params> | null;
     constructor(priorityOrder: "ascending" | "descending");
     /**Get all workers in sorted order. */
-    getSortedWorkers(priority: "ascending" | "descending"): ODWorker<Instance, Source, Params>[];
-    /**Execute all workers on an instance using the given source & parameters. */
-    executeWorkers(instance: Instance, source: Source, params: Params): Promise<void>;
-    get(id: WorkerIds): ODWorker<Instance, Source, Params>;
-    get(id: ODValidId): ODWorker<Instance, Source, Params> | null;
-    remove(id: WorkerIds): ODWorker<Instance, Source, Params>;
-    remove(id: ODValidId): ODWorker<Instance, Source, Params> | null;
+    getSortedWorkers(priority: "ascending" | "descending"): ODWorker<Instance, Origin, Params>[];
+    /**Execute all workers on an instance using the given origin & parameters. */
+    executeWorkers(instance: Instance, origin: Origin, params: Params): Promise<void>;
+    get(id: WorkerIds): ODWorker<Instance, Origin, Params>;
+    get(id: ODValidId): ODWorker<Instance, Origin, Params> | null;
+    remove(id: WorkerIds): ODWorker<Instance, Origin, Params>;
+    remove(id: ODValidId): ODWorker<Instance, Origin, Params> | null;
     exists(id: WorkerIds): boolean;
     exists(id: ODValidId): boolean;
 }

package/dist/api/modules/worker.js

@@ -12,7 +12,7 @@ const base_1 = require("./base");
  *
  * - It has an `id` for identification of the function
  * - A `priority` to know when to execute this callback (related to others)
- * - It knows who called this callback (`source`)
+ * - It knows who called this callback (`origin`)
  * - And much more!
  */
 class ODWorker extends base_1.ODManagerData {
@@ -53,8 +53,8 @@ class ODWorkerManager extends base_1.ODManager {
                 return b.priority - a.priority;
         });
     }
-    /**Execute all workers on an instance using the given source & parameters. */
-    async executeWorkers(instance, source, params) {
+    /**Execute all workers on an instance using the given origin & parameters. */
+    async executeWorkers(instance, origin, params) {
         const derefParams = { ...params };
         const workers = this.getSortedWorkers(this.#priorityOrder);
         let didCancel = false;
@@ -63,29 +63,29 @@ class ODWorkerManager extends base_1.ODManager {
             if (didCancel)
                 break;
             try {
-                await worker.callback(instance, derefParams, source, () => {
+                await worker.callback(instance, derefParams, origin, () => {
                     didCancel = true;
                 });
             }
             catch (err) {
-                process.emit("uncaughtException", err);
+                process.emit("uncaughtException", new base_1.ODSystemError(err));
                 didCrash = true;
             }
         }
         if (didCancel && this.backupWorker) {
             try {
-                await this.backupWorker.callback({ reason: "cancel" }, derefParams, source, () => { });
+                await this.backupWorker.callback({ reason: "cancel" }, derefParams, origin, () => { });
             }
             catch (err) {
-                process.emit("uncaughtException", err);
+                process.emit("uncaughtException", new base_1.ODSystemError(err));
             }
         }
         else if (didCrash && this.backupWorker) {
             try {
-                await this.backupWorker.callback({ reason: "error" }, derefParams, source, () => { });
+                await this.backupWorker.callback({ reason: "error" }, derefParams, origin, () => { });
             }
             catch (err) {
-                process.emit("uncaughtException", err);
+                process.emit("uncaughtException", new base_1.ODSystemError(err));
             }
         }
     }

package/dist/cli/editConfig.js

@@ -522,7 +522,7 @@ class ODCliEditConfigInstance {
             if (!structure.options.cliDisplayKeyInParentArray)
                 return "Object".length;
             else
-                return data[structure.options.cliDisplayKeyInParentArray].toString().length;
+                return data[structure.options.cliDisplayKeyInParentArray]?.toString().length ?? 0;
         }
         else if (structure instanceof api.ODCheckerEnabledObjectStructure && typeof data == "object" && !Array.isArray(data) && data) {
             const subStructure = structure.options.checker;
@@ -571,11 +571,11 @@ class ODCliEditConfigInstance {
         else if (structure instanceof api.ODCheckerArrayStructure && Array.isArray(data))
             return "Array";
         else if (structure instanceof api.ODCheckerObjectStructure && typeof data == "object" && !Array.isArray(data) && data) {
-            const additionalKeys = (structure.options.cliDisplayAdditionalKeysInParentArray ?? []).map((key) => key + ": " + data[key].toString()).join(", ");
+            const additionalKeys = (structure.options.cliDisplayAdditionalKeysInParentArray ?? []).map((key) => key + ": " + data[key]?.toString()).join(", ");
             if (!structure.options.cliDisplayKeyInParentArray)
                 return "Object";
             else
-                return data[structure.options.cliDisplayKeyInParentArray].toString().padEnd(nameLength + 5, " ") + ansis_1.default.gray(additionalKeys.length > 0 ? "(" + additionalKeys + ")" : "");
+                return data[structure.options.cliDisplayKeyInParentArray]?.toString().padEnd(nameLength + 5, " ") + ansis_1.default.gray(additionalKeys.length > 0 ? "(" + additionalKeys + ")" : "");
         }
         else if (structure instanceof api.ODCheckerEnabledObjectStructure && typeof data == "object" && !Array.isArray(data) && data) {
             const subStructure = structure.options.checker;
@@ -715,15 +715,8 @@ class ODCliEditConfigInstance {
             else {
                 localData[enabledProperty] = data;
                 //copy old object checker to new object checker => all options get de-referenced (this is needed for the new object skip keys are temporary)
-                const newStructure = new api.ODCheckerObjectStructure(subStructure.id, { children: [] });
-                //copy all options over to the new checker
-                newStructure.options.children = [...subStructure.options.children];
-                newStructure.options.cliInitSkipKeys = subStructure.options.children.map((child) => child.key);
-                for (const key of Object.keys(subStructure.options)) {
-                    if (key != "children" && key != "cliInitSkipKeys")
-                        newStructure.options[key] = subStructure.options[key];
-                }
-                //adds all properties to object as "skipKeys", then continues to next function
+                const newStructure = new api.ODCheckerObjectStructure(subStructure.id, structuredClone(subStructure.options));
+                //continues to next function
                 await this.renderAdditionConfigObjectStructure(checker, async () => { await this.renderAdditionConfigEnabledObjectStructure(checker, backFn, nextFn, structure, parent, parentIndex, path, localPath); }, nextFn, newStructure, parent, parentIndex, path, localPath, localData);
                 await nextFn(localData);
             }
@@ -745,14 +738,7 @@ class ODCliEditConfigInstance {
         const objectTemplate = structure.options.objects[answer.selectedIndex];
         //copy old object checker to new object checker => all options get de-referenced (this is needed for the new object switch properties which are temporary)
         const oldStructure = objectTemplate.checker;
-        const newStructure = new api.ODCheckerObjectStructure(oldStructure.id, { children: [] });
-        //copy all options over to the new checker
-        newStructure.options.children = [...oldStructure.options.children];
-        newStructure.options.cliInitSkipKeys = [...(oldStructure.options.cliInitSkipKeys ?? [])];
-        for (const key of Object.keys(oldStructure.options)) {
-            if (key != "children" && key != "cliInitSkipKeys")
-                newStructure.options[key] = oldStructure.options[key];
-        }
+        const newStructure = new api.ODCheckerObjectStructure(oldStructure.id, structuredClone(oldStructure.options));
         //add the keys of the object switch properties to the 'cliInitSkipKeys' because they need to be skipped.
         objectTemplate.properties.map((p) => p.key).forEach((p) => {
             if (!newStructure.options.cliInitSkipKeys)

package/dist/startup/pluginLauncher.js

@@ -53,17 +53,19 @@ const loadAllPlugins = async (opendiscord) => {
     for (const p of plugins) {
         //prechecks
         if (p === ".DS_Store")
-            return; //ignore MacOS DS_Store file
-        if (!fs_1.default.statSync("./plugins/" + p).isDirectory())
-            return opendiscord.log("Plugin is not a directory, canceling plugin execution...", "plugin", [
+            continue; //ignore MacOS DS_Store file
+        if (!fs_1.default.statSync("./plugins/" + p).isDirectory()) {
+            opendiscord.log("Plugin is not a directory, canceling plugin execution...", "plugin", [
                 { key: "plugin", value: "./plugins/" + p }
             ]);
+            continue;
+        }
         if (!fs_1.default.existsSync("./plugins/" + p + "/plugin.json")) {
             initPluginError = true;
             opendiscord.log("Plugin doesn't have a plugin.json, canceling plugin execution...", "plugin", [
                 { key: "plugin", value: "./plugins/" + p }
             ]);
-            return;
+            continue;
         }
         //plugin loading
         try {

package/dist/utilities/index.d.ts

@@ -38,7 +38,7 @@ export declare function timedAwait<ReturnValue>(promise: ReturnValue, timeout: n
 /**## dateString `utility function`
  * Use this function to create a short date string in the following format: `DD/MM/YYYY HH:MM:SS`
  */
-export declare function dateString(date: any): string;
+export declare function dateString(date: Date): string;
 /**## asyncReplace `utility function`
  * Same as `string.replace(search, value)` but with async compatibility
  */
@@ -54,7 +54,7 @@ export declare function ordinalNumber(num: number): string;
 /**## trimEmojis `utility function`
  * Trim/remove all emoji's from a Javascript string.
  */
-export declare function trimEmojis(text: any): any;
+export declare function trimEmojis(text: string): string;
 /**## easterEggs `utility object`
  * Object containing data for Open Ticket easter eggs.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.11",
+    "version": "0.2.12",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -14,10 +14,10 @@
         "@discordjs/rest": "^2.6.1",
         "@types/terminal-kit": "^2.5.7",
         "ansis": "^4.2.0",
-        "discord.js": "^14.26.0",
-        "formatted-json-stringify": "^1.2.1",
+        "discord.js": "^14.26.3",
+        "formatted-json-stringify": "^1.3.0",
         "terminal-kit": "^3.1.2",
-        "typescript": "^5.9.3"
+        "typescript": "^6.0.3"
     },
     "repository": {
         "type": "git",

package/src/api/main.ts

@@ -142,7 +142,7 @@ export class ODMain implements ODMainManagers {
     constructor(managers:ODMainManagers,project:ODProjectType){
         this.project = project
         this.versions = managers.versions
-        this.versions.add(ODVersion.fromString("opendiscord:api","v0.2.11"))
+        this.versions.add(ODVersion.fromString("opendiscord:api","v0.2.12"))
         this.versions.add(ODVersion.fromString("opendiscord:livestatus","v2.0.0"))
 
         this.debugfile = managers.debugfile

package/src/api/modules/action.ts

@@ -12,17 +12,17 @@ import { ODDebugger } from "./console"
  * 
  * This class can't be used stand-alone & needs to be extended from!
  */
-export class ODActionImplementation<Source extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODManagerData {
+export 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>,Source,Params,WorkerIds>
+    workers: ODWorkerManager<Partial<Result>,Origin,Params,WorkerIds>
 
-    constructor(id:ODValidId, callback?:ODWorkerCallback<Result,Source,Params>, priority?:number, callbackId?:ODValidId){
+    constructor(id:ODValidId, callback?:ODWorkerCallback<Partial<Result>,Origin,Params>, priority?:number, callbackId?:ODValidId){
         super(id)
         this.workers = new ODWorkerManager("descending")
         if (callback) this.workers.add(new ODWorker(callbackId ? callbackId : id,priority ?? 0,callback))
     }
     /**Execute all workers & return the result. */
-    async run(source:Source, params:Params): Promise<Partial<Result>> {
+    async run(origin:Origin, params:Params): Promise<Partial<Result>> {
         throw new ODSystemError("Tried to build an unimplemented ODResponderImplementation")
     }
 }
@@ -30,7 +30,7 @@ export class ODActionImplementation<Source extends string,Params extends object,
 /**## ODActionManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODActionManager` class.
  */
-export type ODActionManagerIdConstraint = Record<string,{source:string,params:object,result:object,workers:string}>
+export type ODActionManagerIdConstraint = Record<string,{origin:string,params:object,result:object,workers:string}>
 
 /**## ODActionManager `class`
  * This is an Open Discord action manager.
@@ -47,14 +47,14 @@ export class ODActionManager<IdList extends ODActionManagerIdConstraint = ODActi
         super(debug,"action")
     }
 
-    get<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["source"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
+    get<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
     get(id:ODValidId): ODAction<string,{},{},string>|null
     
     get(id:ODValidId): ODAction<string,{},{},string>|null {
         return super.get(id)
     }
 
-    remove<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["source"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
+    remove<ActionId extends keyof ODNoGeneric<IdList>>(id:ActionId): ODAction<IdList[ActionId]["origin"],IdList[ActionId]["params"],IdList[ActionId]["result"],IdList[ActionId]["workers"]>
     remove(id:ODValidId): ODAction<string,{},{},string>|null
     
     remove(id:ODValidId): ODAction<string,{},{},string>|null {
@@ -76,14 +76,14 @@ export class ODActionManager<IdList extends ODActionManagerIdConstraint = ODActi
  * 
  * Can be used standalone.
  */
-export class ODAction<Source extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODActionImplementation<Source,Params,Result,WorkerIds> {
+export class ODAction<Origin extends string,Params extends object,Result extends object,WorkerIds extends string = string> extends ODActionImplementation<Origin,Params,Result,WorkerIds> {
     /**Run this action */
-    async run(source:Source, params:Params): Promise<Partial<Result>> {
+    async run(origin:Origin, params:Params): Promise<Partial<Result>> {
         //create instance
         const instance = {}
         
         //wait for workers to finish
-        await this.workers.executeWorkers(instance,source,params)
+        await this.workers.executeWorkers(instance,origin,params)
 
         //return data generated by workers
         return instance

package/src/api/modules/base.ts

@@ -37,7 +37,7 @@ export type ODValidId = string|number|symbol|ODId
  * 
  * list: `string`, `number`, `boolean`, `array`, `object`, `null`
  */
-export type ODValidJsonType = string|number|boolean|object|ODValidJsonType[]|null
+export type ODValidJsonType = string|number|boolean|{[key:string]:ODValidJsonType}|ODValidJsonType[]|null
 
 /**## ODInterfaceWithPartialProperty `type`
  * A utility type to create an interface where some properties are optional!
@@ -734,9 +734,9 @@ export class ODHTTPPostRequest {
  */
 export class ODEnvHelper {
     /**All variables found in the `.env` file */
-    dotenv: object
+    dotenv: Record<string,any>
     /**All variables found in `process.env` */
-    env: object
+    env: Record<string,any>
 
     constructor(customEnvPath?:string){
         if (typeof customEnvPath != "undefined" && typeof customEnvPath != "string") throw new ODSystemError("Invalid constructor parameter => customEnvPath?:string")
@@ -767,7 +767,7 @@ export class ODEnvHelper {
     //Source: https://github.com/motdotla/dotenv/blob/master/lib/main.js#L12
     #readDotEnv(src:Buffer){
         const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
-        const obj = {}
+        const obj: Record<string,any> = {}
         
         // Convert buffer to string
         let lines = src.toString()
@@ -815,8 +815,10 @@ export class ODSystemError extends Error {
 
     /**Create an `ODSystemError` directly from an `Error` class */
     static fromError(err:Error){
-        err["_ODErrorType"] = "system"
-        return err as ODSystemError
+        const modifiedErr: ODSystemError = Object.assign(err,{
+            _ODErrorType:"system"
+        })
+        return modifiedErr as ODSystemError
     }
 }
 
@@ -831,8 +833,10 @@ export class ODPluginError extends Error {
 
     /**Create an `ODPluginError` directly from an `Error` class */
     static fromError(err:Error){
-        err["_ODErrorType"] = "plugin"
-        return err as ODPluginError
+        const modifiedErr: ODPluginError = Object.assign(err,{
+            _ODErrorType:"plugin"
+        })
+        return modifiedErr as ODPluginError
     }
 }