@open-discord-bots/framework 0.3.6 → 0.3.8

package/src/api/modules/state.ts

@@ -73,7 +73,7 @@ export interface ODStateSettings {
  * 
  * Features automatic garbage collection to clear expired states. 
  */
-export class ODState<StateData extends any,WithGuildKey extends boolean = true,WithUserKey extends boolean = true> extends ODManagerData {
+export class ODState<StateData extends any,WithGuildKey extends boolean,WithUserKey extends boolean> extends ODManagerData {
     /**Alias to Open Discord message states database. */
     protected database: ODDatabase<ODDatabaseIdConstraint>
     /**Alias to Open Discord client manager. */
@@ -251,14 +251,14 @@ export class ODState<StateData extends any,WithGuildKey extends boolean = true,W
 /**## ODStateManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODStateManager` class.
  */
-export type ODStateManagerIdConstraint = Record<string,ODState<any>>
+export type ODStateManagerIdConstraint = Record<string,ODState<any,boolean,boolean>>
 
 /**## ODStateManager `class`
  * The Open Discord state manager is a system for tracking messages or linking metadata, states or progress to Discord messages (ID-based).
  * 
  * Features automatic garbage collection to clear expired states. 
  */
-export class ODStateManager<IdList extends ODStateManagerIdConstraint = ODStateManagerIdConstraint> extends ODManager<ODState<any>> {
+export class ODStateManager<IdList extends ODStateManagerIdConstraint = ODStateManagerIdConstraint> extends ODManager<ODState<any,boolean,boolean>> {
     constructor(debug:ODDebugger){
         super(debug,"state")
     }
@@ -270,22 +270,22 @@ export class ODStateManager<IdList extends ODStateManagerIdConstraint = ODStateM
         }
     }
 
-    add(data:ODState<any>, overwrite?:boolean): boolean {
+    add(data:ODState<any,boolean,boolean>, overwrite?:boolean): boolean {
         data.useDebug(this.debug)
         return super.add(data,overwrite)
     }
 
     get<StateId extends keyof ODNoGeneric<IdList>>(id:StateId): IdList[StateId]
-    get(id:ODValidId): ODState<any>|null
+    get(id:ODValidId): ODState<any,boolean,boolean>|null
     
-    get(id:ODValidId): ODState<any>|null {
+    get(id:ODValidId): ODState<any,boolean,boolean>|null {
         return super.get(id)
     }
 
     remove<StateId extends keyof ODNoGeneric<IdList>>(id:StateId): IdList[StateId]
-    remove(id:ODValidId): ODState<any>|null
+    remove(id:ODValidId): ODState<any,boolean,boolean>|null
     
-    remove(id:ODValidId): ODState<any>|null {
+    remove(id:ODValidId): ODState<any,boolean,boolean>|null {
         return super.remove(id)
     }
 

package/src/api/modules/verifybar.ts

@@ -9,6 +9,7 @@ import * as discord from "discord.js"
 import { ODWorkerManager } from "./worker.js"
 
 /**## ODVerifyBar `class`
+ * @deprecated Use `ODMessageComponentModifier`'s instead.
  * This is an Open Discord verifybar.
  * 
  * It is contains 2 sets of workers and a lot of utilities for the (✅ ❌) verifybars in the bot.
@@ -47,14 +48,15 @@ export class ODVerifyBar<SuccessWorkerIds extends string = string,FailureWorkerI
 }
 
 /**## ODVerifyBarManagerIdConstraint `type`
+ * @deprecated Use `ODMessageComponentModifier`'s instead.
  * The constraint/layout for id mappings/interfaces of the `ODVerifyBarManager` class.
  */
 export type ODVerifyBarManagerIdConstraint = Record<string,{successWorkerIds:string,failureWorkerIds:string}>
 
 /**## ODVerifyBarManager `class`
- * This is an Open Discord verifybar manager.
+ * @deprecated Use `ODMessageComponentModifier`'s instead.
  * 
- * It contains all (✅ ❌) verifybars in the bot.
+ * The Open Discord verifybar manager manages all (✅ ❌) 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.

package/src/api/modules/worker.ts

@@ -29,6 +29,11 @@ export class ODWorker<Instance, Origin extends string, Params> extends ODManager
         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?:ODValidId): ODWorker<Instance,Origin,Params> {
+        return new ODWorker<Instance,Origin,Params>(newId ?? this.id.value,this.priority,this.callback)
+    }
 }
 
 /**## ODWorker `class`