@open-discord-bots/framework 0.3.7 → 0.3.9

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

@@ -1,68 +1,39 @@
 import { ODManager, ODManagerData, ODNoGeneric, ODValidId } from "./base.js";
-import { ODMessage } from "./builder.js";
 import { ODDebugger } from "./console.js";
 import { ODButtonResponderInstance } from "./responder.js";
-import * as discord from "discord.js";
 import { ODWorkerManager } from "./worker.js";
 /**## ODVerifyBar `class`
- * This is an Open Discord verifybar.
+ * This is an Open Discord verifybar responder.
  *
- * It is contains 2 sets of workers and a lot of utilities for the (✅ ❌) verifybars in the bot.
+ * It contain `ODWorkerManager`'s that will be fired when the continue/stop (✅ ❌) buttons are pressed.
  *
- * It doesn't contain the code which activates or spawns the verifybars!
+ * Verifybars don't automatically trigger these workers. The button responders of the verifybars should implement it manually.
  */
-export declare class ODVerifyBar<SuccessWorkerIds extends string = string, FailureWorkerIds extends string = string> extends ODManagerData {
-    /**All workers that will run when the verifybar is accepted. */
-    success: ODWorkerManager<ODButtonResponderInstance, "verifybar", {
-        data: string | null;
-        verifybarMessage: discord.Message<boolean> | null;
-    }, SuccessWorkerIds>;
-    /**All workers that will run when the verifybar is stopped. */
-    failure: ODWorkerManager<ODButtonResponderInstance, "verifybar", {
-        data: string | null;
-        verifybarMessage: discord.Message<boolean> | null;
-    }, FailureWorkerIds>;
-    /**The message that will be built wen activating this verifybar. */
-    message: ODMessage<"verifybar", {
-        guild: discord.Guild | null;
-        channel: discord.TextBasedChannel;
-        user: discord.User;
-        verifybar: ODVerifyBar;
-        originalMessage: discord.Message<boolean>;
-    }>;
-    /**When disabled, it will skip the verifybar and instantly fire the `success` workers. */
-    enabled: boolean;
-    constructor(id: ODValidId, message: ODMessage<"verifybar", {
-        guild: discord.Guild | null;
-        channel: discord.TextBasedChannel;
-        user: discord.User;
-        verifybar: ODVerifyBar;
-        originalMessage: discord.Message<boolean>;
-    }>, enabled?: boolean);
-    /**Build the message and reply to a button with this verifybar. */
-    activate(responder: ODButtonResponderInstance): Promise<void>;
+export declare class ODVerifyBar<ButtonIds extends string, WorkerIds extends string = string> extends ODManagerData {
+    /**All workers that will run when a button in the verifybar is pressed. */
+    workers: ODWorkerManager<ODButtonResponderInstance, "verifybar", {
+        selectedButtonId: ButtonIds;
+    }, WorkerIds>;
+    constructor(id: ODValidId);
+    /**Activate the verifybar response to this button. */
+    activate(responder: ODButtonResponderInstance, selectedButtonId: ButtonIds): Promise<void>;
 }
 /**## ODVerifyBarManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODVerifyBarManager` class.
  */
-export type ODVerifyBarManagerIdConstraint = Record<string, {
-    successWorkerIds: string;
-    failureWorkerIds: string;
-}>;
+export type ODVerifyBarManagerIdConstraint = Record<string, ODVerifyBar<string>>;
 /**## ODVerifyBarManager `class`
- * This is an Open Discord verifybar manager.
- *
- * It contains all (✅ ❌) verifybars in the bot.
+ * The Open Discord verifybar manager manages all responders for (✅ ❌) verifybars in the bot.
  * The `ODVerifyBar` classes contain `ODWorkerManager`'s that will be fired when the continue/stop buttons are pressed.
  *
- * It doesn't contain the code which activates the verifybars! This should be implemented by your own.
+ * Verifybars don't automatically trigger these workers. The button responders of the verifybars should implement it manually.
  */
-export declare class ODVerifyBarManager<IdList extends ODVerifyBarManagerIdConstraint = ODVerifyBarManagerIdConstraint> extends ODManager<ODVerifyBar> {
+export declare class ODVerifyBarManager<IdList extends ODVerifyBarManagerIdConstraint = ODVerifyBarManagerIdConstraint> extends ODManager<ODVerifyBar<string>> {
     constructor(debug: ODDebugger);
-    get<VerifyBarId extends keyof ODNoGeneric<IdList>>(id: VerifyBarId): ODVerifyBar<IdList[VerifyBarId]["successWorkerIds"], IdList[VerifyBarId]["failureWorkerIds"]>;
-    get(id: ODValidId): ODVerifyBar | null;
-    remove<VerifyBarId extends keyof ODNoGeneric<IdList>>(id: VerifyBarId): ODVerifyBar<IdList[VerifyBarId]["successWorkerIds"], IdList[VerifyBarId]["failureWorkerIds"]>;
-    remove(id: ODValidId): ODVerifyBar | null;
+    get<VerifyBarId extends keyof ODNoGeneric<IdList>>(id: VerifyBarId): IdList[VerifyBarId];
+    get(id: ODValidId): ODVerifyBar<string> | null;
+    remove<VerifyBarId extends keyof ODNoGeneric<IdList>>(id: VerifyBarId): IdList[VerifyBarId];
+    remove(id: ODValidId): ODVerifyBar<string> | null;
     exists(id: keyof ODNoGeneric<IdList>): boolean;
     exists(id: ODValidId): boolean;
 }

package/dist/api/modules/verifybar.js

@@ -4,49 +4,29 @@
 import { ODManager, ODManagerData } from "./base.js";
 import { ODWorkerManager } from "./worker.js";
 /**## ODVerifyBar `class`
- * This is an Open Discord verifybar.
+ * This is an Open Discord verifybar responder.
  *
- * It is contains 2 sets of workers and a lot of utilities for the (✅ ❌) verifybars in the bot.
+ * It contain `ODWorkerManager`'s that will be fired when the continue/stop (✅ ❌) buttons are pressed.
  *
- * It doesn't contain the code which activates or spawns the verifybars!
+ * Verifybars don't automatically trigger these workers. The button responders of the verifybars should implement it manually.
  */
 export class ODVerifyBar extends ODManagerData {
-    /**All workers that will run when the verifybar is accepted. */
-    success;
-    /**All workers that will run when the verifybar is stopped. */
-    failure;
-    /**The message that will be built wen activating this verifybar. */
-    message;
-    /**When disabled, it will skip the verifybar and instantly fire the `success` workers. */
-    enabled;
-    constructor(id, message, enabled) {
+    /**All workers that will run when a button in the verifybar is pressed. */
+    workers;
+    constructor(id) {
         super(id);
-        this.success = new ODWorkerManager("descending");
-        this.failure = new ODWorkerManager("descending");
-        this.message = message;
-        this.enabled = enabled ?? true;
+        this.workers = new ODWorkerManager("descending");
     }
-    /**Build the message and reply to a button with this verifybar. */
-    async activate(responder) {
-        if (this.enabled) {
-            //show verifybar
-            const { guild, channel, user, message } = responder;
-            await responder.update(await this.message.build("verifybar", { guild, channel, user, verifybar: this, originalMessage: message }));
-        }
-        else {
-            //instant success
-            if (this.success)
-                await this.success.executeWorkers(responder, "verifybar", { data: null, verifybarMessage: null });
-        }
+    /**Activate the verifybar response to this button. */
+    async activate(responder, selectedButtonId) {
+        await this.workers.executeWorkers(responder, "verifybar", { selectedButtonId });
     }
 }
 /**## ODVerifyBarManager `class`
- * This is an Open Discord verifybar manager.
- *
- * It contains all (✅ ❌) verifybars in the bot.
+ * The Open Discord verifybar manager manages all responders for (✅ ❌) verifybars in the bot.
  * The `ODVerifyBar` classes contain `ODWorkerManager`'s that will be fired when the continue/stop buttons are pressed.
  *
- * It doesn't contain the code which activates the verifybars! This should be implemented by your own.
+ * Verifybars don't automatically trigger these workers. The button responders of the verifybars should implement it manually.
  */
 export class ODVerifyBarManager extends ODManager {
     constructor(debug) {

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

@@ -19,6 +19,8 @@ export declare class ODWorker<Instance, Origin extends string, Params> extends O
     /**The main callback of this worker */
     callback: ODWorkerCallback<Instance, Origin, Params>;
     constructor(id: ODValidId, priority: number, callback: ODWorkerCallback<Instance, Origin, Params>);
+    /**Duplicate this worker. Warning: If the callback accesses external variables (outside parameters), the clone will still use those variables. This might result in unexpected behaviour! */
+    duplicate(newId?: ODValidId): ODWorker<Instance, Origin, Params>;
 }
 /**## ODWorker `class`
  * This is an Open Discord worker manager.

package/dist/api/modules/worker.js

@@ -22,6 +22,10 @@ export class ODWorker extends ODManagerData {
         this.priority = priority;
         this.callback = callback;
     }
+    /**Duplicate this worker. Warning: If the callback accesses external variables (outside parameters), the clone will still use those variables. This might result in unexpected behaviour! */
+    duplicate(newId) {
+        return new ODWorker(newId ?? this.id.value, this.priority, this.callback);
+    }
 }
 /**## ODWorker `class`
  * This is an Open Discord worker manager.

package/package.json

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

package/src/api/main.ts

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

package/src/api/modules/builder.ts

@@ -1469,6 +1469,14 @@ export class ODMessage<Origin extends string,Params,WorkerIds extends string = s
         this.didCache = true
         return result
     }
+    /**Duplicate this message. Warning: If workers access external variables (outside parameters), the clone will still use those variables. This might result in unexpected behaviour! */
+    duplicate(newId?:ODValidId): ODMessage<Origin,Params,WorkerIds> {
+        const newMessage = new ODMessage<Origin,Params,WorkerIds>(newId ?? this.id.value)
+        for (const worker of this.workers.getAll()){
+            newMessage.workers.add(worker.duplicate())
+        }
+        return newMessage
+    }
 }
 
 /**## ODQuickMessage `class`