@open-discord-bots/framework 0.3.0 → 0.3.1

package/src/api/modules/session.ts

@@ -72,23 +72,23 @@ export type ODSessionTimeoutCallback = (id:string, timeout:"default"|"custom", d
  */
 export class ODSession extends ODManagerData {
     /**The history of previously generated instance ids. Used to reduce the risk of generating the same id twice. */
-    #idHistory: string[] = []
+    protected idHistory: string[] = []
     /**The max length of the instance id history. */
-    #maxIdHistoryLength: number = 500
+    protected maxIdHistoryLength: number = 500
     /**An array of all the currently active session instances. */
     sessions: ODSessionInstance[] = []
     /**The default amount of minutes before a session automatically stops. */
     timeoutMinutes: number = 30
     /**The id of the auto-timeout session checker interval */
-    #intervalId: NodeJS.Timeout
+    protected intervalId: NodeJS.Timeout
     /**Listeners for when a session times-out. */
-    #timeoutListeners: ODSessionTimeoutCallback[] = []
+    protected timeoutListeners: ODSessionTimeoutCallback[] = []
 
     constructor(id:ODValidId, intervalSeconds?:number){
         super(id)
 
         //create the auto-timeout session checker
-        this.#intervalId = setInterval(() => {
+        this.intervalId = setInterval(() => {
             const deletableSessions: {instance:ODSessionInstance,reason:"default"|"custom"}[] = []
             
             //collect all deletable sessions
@@ -108,31 +108,31 @@ export class ODSession extends ODManagerData {
                 this.sessions.splice(index,1)
 
                 //emit timeout listeners
-                this.#timeoutListeners.forEach((cb) => cb(session.instance.id,session.reason,session.instance.data,new Date(session.instance.creation)))
+                this.timeoutListeners.forEach((cb) => cb(session.instance.id,session.reason,session.instance.data,new Date(session.instance.creation)))
             })
 
         },((intervalSeconds) ? (intervalSeconds * 1000) : 60000))
     }
 
     /**Create a unique hex id of 8 characters and add it to the instance id history */
-    #createUniqueId(): string {
+    protected createUniqueId(): string {
         const hex = crypto.randomBytes(4).toString("hex")
-        if (this.#idHistory.includes(hex)){
-            return this.#createUniqueId()
+        if (this.idHistory.includes(hex)){
+            return this.createUniqueId()
         }else{
-            this.#idHistory.push(hex)
-            if (this.#idHistory.length > this.#maxIdHistoryLength) this.#idHistory.shift()
+            this.idHistory.push(hex)
+            if (this.idHistory.length > this.maxIdHistoryLength) this.idHistory.shift()
             return hex
         }
     }
     /**Stop the global interval that automatically deletes timed-out sessions. (This action can't be reverted!) */
     stopAutoTimeout(){
-        clearInterval(this.#intervalId)
+        clearInterval(this.intervalId)
     }
 
     /**Start a session instance with data. Returns the unique id required to access the session. */
     start(data?:any): string {
-        const id = this.#createUniqueId()
+        const id = this.createUniqueId()
         this.sessions.push({
             id,data,
             creation:new Date().getTime(),
@@ -176,6 +176,6 @@ export class ODSession extends ODManagerData {
     }
     /**Listen for a session timeout (default or custom) */
     onTimeout(callback:ODSessionTimeoutCallback){
-        this.#timeoutListeners.push(callback)
+        this.timeoutListeners.push(callback)
     }
 }

package/src/api/modules/startscreen.ts

@@ -24,14 +24,11 @@ export type ODStartScreenManagerIdConstraint = Record<string,ODStartScreenCompon
  * The startscreen is the part you see when the bot has started up successfully. (e.g. the Open Discord logo, logs, livestatus, flags, ...)
  */
 export class ODStartScreenManager<IdList extends ODStartScreenManagerIdConstraint = ODStartScreenManagerIdConstraint,LiveStatus extends ODLiveStatusManager = ODLiveStatusManager> extends ODManager<ODStartScreenComponent> {
-    /**Alias to the Open Discord debugger. */
-    #debug: ODDebugger
     /**Alias to the livestatus manager. */
     livestatus: LiveStatus
 
     constructor(debug:ODDebugger,livestatus:LiveStatus){
         super(debug,"startscreen component")
-        this.#debug = debug
         this.livestatus = livestatus
     }
 
@@ -51,10 +48,10 @@ export class ODStartScreenManager<IdList extends ODStartScreenManagerIdConstrain
             try {
                 const renderedText = await component.renderAll(location)
                 console.log(renderedText)
-                this.#debug.console.debugfile.writeText("[STARTSCREEN] Component: \""+component.id+"\"\n"+ansis.strip(renderedText))
+                this.debug?.console.debugfile.writeText("[STARTSCREEN] Component: \""+component.id+"\"\n"+ansis.strip(renderedText))
             }catch(e){
-                this.#debug.console.log("Unable to render \""+component.id+"\" startscreen component!","error")
-                this.#debug.console.debugfile.writeErrorMessage(new ODError(e,"uncaughtException"))
+                this.debug?.console.log("Unable to render \""+component.id+"\" startscreen component!","error")
+                this.debug?.console.debugfile.writeErrorMessage(new ODError(e,"uncaughtException"))
             }
             location++
         }

package/src/api/modules/statistic.ts

@@ -37,16 +37,13 @@ export type ODStatisticManagerIdConstraint = Record<string,ODStatisticScope>
  * Statistic can be accessed in the individual scopes.
  */
 export class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint = ODStatisticManagerIdConstraint> extends ODManager<ODStatisticScope> {
-    /**Alias to Open Discord debugger. */
-    #debug: ODDebugger
     /**Alias to Open Discord statistics database. */
     database: ODDatabase<ODDatabaseIdConstraint>|null = null
     /**All the listeners for the init event. */
-    #initListeners: ODStatisticManagerInitCallback[] = []
+    protected initListeners: ODStatisticManagerInitCallback[] = []
 
     constructor(debug:ODDebugger){
         super(debug,"statistic scope")
-        this.#debug = debug
     }
 
     /**Select the database to use to read/write all statistics from/to. */
@@ -54,7 +51,7 @@ export class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint =
         this.database = database
     }
     add(data:ODStatisticScope, overwrite?:boolean): boolean {
-        data.useDebug(this.#debug,"stat")
+        data.useDebug(this.debug,"stat")
         if (this.database) data.useDatabase(this.database)
         return super.add(data,overwrite)
     }
@@ -76,7 +73,7 @@ export class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint =
         })
 
         //do additional deletion
-        for (const cb of this.#initListeners){
+        for (const cb of this.initListeners){
             await cb(data,deletableStats)
         }
         
@@ -96,7 +93,7 @@ export class ODStatisticManager<IdList extends ODStatisticManagerIdConstraint =
     }
     /**Run a function when the statistics are initialized. This can be used to clear statistics from users that left the server or tickets which don't exist anymore. */
     onInit(callback:ODStatisticManagerInitCallback){
-        this.#initListeners.push(callback)
+        this.initListeners.push(callback)
     }
 
     get<ScopeId extends keyof ODNoGeneric<IdList>>(id:ScopeId): IdList[ScopeId]

package/src/api/modules/worker.ts

@@ -40,13 +40,13 @@ export class ODWorker<Instance, Origin extends string, Params> extends ODManager
  */
 export class ODWorkerManager<Instance, Origin extends string, Params,WorkerIds extends string = string> extends ODManager<ODWorker<Instance,Origin,Params>> {
     /**The order of execution for workers inside this manager. */
-    #priorityOrder: "ascending"|"descending"
+    protected priorityOrder: "ascending"|"descending"
     /**The backup worker will be executed when one of the workers fails or cancels execution. */
     backupWorker: ODWorker<{reason:"error"|"cancel"},Origin,Params>|null = null
     
     constructor(priorityOrder:"ascending"|"descending"){
         super()
-        this.#priorityOrder = priorityOrder
+        this.priorityOrder = priorityOrder
     }
     
     /**Get all workers in sorted order. */
@@ -61,7 +61,7 @@ export class ODWorkerManager<Instance, Origin extends string, Params,WorkerIds e
     /**Execute all workers on an instance using the given origin & parameters. */
     async executeWorkers(instance:Instance, origin:Origin, params:Params){
         const derefParams = {...params}
-        const workers = this.getSortedWorkers(this.#priorityOrder)
+        const workers = this.getSortedWorkers(this.priorityOrder)
         let didCancel = false
         let didCrash = false