@open-discord-bots/framework 0.2.3 → 0.2.5

package/dist/api/modules/{stat.js → statistic.js}

@@ -1,30 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ODDynamicStat = exports.ODBasicStat = exports.ODStat = exports.ODStatGlobalScope = exports.ODStatScope = exports.ODStatsManager = void 0;
+exports.ODDynamicStatistic = exports.ODBaseStatistic = exports.ODStatistic = exports.ODStatisticGlobalScope = exports.ODStatisticScope = exports.ODStatisticManager = void 0;
 ///////////////////////////////////////
-//STAT MODULE
+//STATISTIC MODULE
 ///////////////////////////////////////
 const base_1 = require("./base");
-/**## ODStatsManager `class`
- * This is an Open Discord stats manager.
+/**## ODStatisticManager `class`
+ * This is an Open Discord statistics manager.
  *
- * This class is responsible for managing all stats of the bot.
- * Stats are categorized in "scopes" which can be accessed in this manager.
+ * This class is responsible for managing all statistics of the bot.
+ * Statistic are categorized in "scopes" which can be accessed in this manager.
  *
- * Stats can be accessed in the individual scopes.
+ * Statistic can be accessed in the individual scopes.
  */
-class ODStatsManager extends base_1.ODManager {
+class ODStatisticManager extends base_1.ODManager {
     /**Alias to Open Discord debugger. */
     #debug;
-    /**Alias to Open Discord stats database. */
+    /**Alias to Open Discord statistics database. */
     database = null;
     /**All the listeners for the init event. */
     #initListeners = [];
     constructor(debug) {
-        super(debug, "stat scope");
+        super(debug, "statistic scope");
         this.#debug = debug;
     }
-    /**Select the database to use to read/write all stats from/to. */
+    /**Select the database to use to read/write all statistics from/to. */
     useDatabase(database) {
         this.database = database;
     }
@@ -34,16 +34,16 @@ class ODStatsManager extends base_1.ODManager {
             data.useDatabase(this.database);
         return super.add(data, overwrite);
     }
-    /**Init all stats and run `onInit()` listeners. */
+    /**Init all statistics and run `onInit()` listeners. */
     async init() {
         if (!this.database)
-            throw new base_1.ODSystemError("Unable to initialize stats scopes due to missing database!");
+            throw new base_1.ODSystemError("Unable to initialize statistics scopes due to missing database!");
         //get all valid categories
         const validCategories = [];
         for (const scope of this.getAll()) {
             validCategories.push(...scope.init());
         }
-        //filter out the deletable stats
+        //filter out the deletable statistics
         const deletableStats = [];
         const data = await this.database.getAll();
         data.forEach((data) => {
@@ -54,14 +54,14 @@ class ODStatsManager extends base_1.ODManager {
         for (const cb of this.#initListeners) {
             await cb(data, deletableStats);
         }
-        //delete all deletable stats
+        //delete all deletable statistics
         for (const data of deletableStats) {
             if (!this.database)
                 return;
             await this.database.delete(data.category, data.key);
         }
     }
-    /**Reset all stats. (clears the entire database) */
+    /**Reset all statistics. (clears the entire database) */
     async reset() {
         if (!this.database)
             return;
@@ -72,7 +72,7 @@ class ODStatsManager extends base_1.ODManager {
             await this.database.delete(d.category, d.key);
         }
     }
-    /**Run a function when the stats are initialized. This can be used to clear stats from users that left the server or tickets which don't exist anymore. */
+    /**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) {
         this.#initListeners.push(callback);
     }
@@ -86,21 +86,21 @@ class ODStatsManager extends base_1.ODManager {
         return super.exists(id);
     }
 }
-exports.ODStatsManager = ODStatsManager;
-/**## ODStatScope `class`
- * This is an Open Discord stat scope.
+exports.ODStatisticManager = ODStatisticManager;
+/**## ODStatisticScope `class`
+ * This is an Open Discord statistic scope.
  *
- * A scope can contain multiple stats. Every scope is seperated from other scopes.
- * Here, you can read & write the values of all stats.
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
  *
  * The built-in Open Discord scopes are: `global`, `user`, `ticket`
  */
-class ODStatScope extends base_1.ODManager {
+class ODStatisticScope extends base_1.ODManager {
     /**The id of this statistics scope. */
     id;
-    /**Is this stat scope already initialized? */
+    /**Is this scope already initialized? */
     ready = false;
-    /**Alias to Open Discord stats database. */
+    /**Alias to Open Discord statistics database. */
     database = null;
     /**The name of this scope (used in embed title) */
     name;
@@ -109,7 +109,7 @@ class ODStatScope extends base_1.ODManager {
         this.id = new base_1.ODId(id);
         this.name = name;
     }
-    /**Select the database to use to read/write all stats from/to. (Automatically assigned when used in `ODStatsManager`) */
+    /**Select the database to use to read/write all statistics from/to. (Automatically assigned when used in `ODStatisticManager`) */
     useDatabase(database) {
         this.database = database;
     }
@@ -119,7 +119,7 @@ class ODStatScope extends base_1.ODManager {
         const newId = new base_1.ODId(id);
         const data = await this.database.get(this.id.value + "_" + newId.value, scopeId);
         if (typeof data == "undefined") {
-            //set stats to default value & return
+            //set statistics to default value & return
             return this.resetStat(id, scopeId);
         }
         else if (typeof data == "string" || typeof data == "boolean" || typeof data == "number") {
@@ -179,13 +179,13 @@ class ODStatScope extends base_1.ODManager {
             await this.database.set(this.id.value + "_" + stat.id.value, scopeId, stat.value);
         return stat.value;
     }
-    /**Initialize this stat scope & return a list of all statistic ids in the following format: `<scopeid>_<statid>`  */
+    /**Initialize this statistic scope & return a list of all statistic ids in the following format: `<scopeid>_<statid>`  */
     init() {
-        //get all valid stats categories
+        //get all valid statistics categories
         this.ready = true;
         return this.getAll().map((stat) => this.id.value + "_" + stat.id.value);
     }
-    /**Render all stats in this scope for usage in a discord message/embed. */
+    /**Render all statistics in this scope for usage in a discord message/embed. */
     async render(scopeId, guild, channel, user) {
         //sort from high priority to low
         const derefArray = [...this.getAll()];
@@ -195,7 +195,7 @@ class ODStatScope extends base_1.ODManager {
         const result = [];
         for (const stat of derefArray) {
             try {
-                if (stat instanceof ODDynamicStat) {
+                if (stat instanceof ODDynamicStatistic) {
                     //dynamic render (without value)
                     result.push(await stat.render("", scopeId, guild, channel, user));
                 }
@@ -222,16 +222,16 @@ class ODStatScope extends base_1.ODManager {
         return super.exists(id);
     }
 }
-exports.ODStatScope = ODStatScope;
-/**## ODStatGlobalScope `class`
- * This is an Open Discord stat global scope.
+exports.ODStatisticScope = ODStatisticScope;
+/**## ODStatisticGlobalScope `class`
+ * This is an Open Discord statistic global scope.
  *
- * A scope can contain multiple stats. Every scope is seperated from other scopes.
- * Here, you can read & write the values of all stats.
+ * A scope can contain multiple statistics. Every scope is seperated from other scopes.
+ * Here, you can read & write the values of all statistics.
  *
- * This scope is made specifically for the global stats of Open Discord.
+ * This scope is made specifically for the global statistics of Open Discord.
  */
-class ODStatGlobalScope extends ODStatScope {
+class ODStatisticGlobalScope extends ODStatisticScope {
     getStat(id) {
         return super.getStat(id, "GLOBAL");
     }
@@ -248,16 +248,16 @@ class ODStatGlobalScope extends ODStatScope {
         return super.render("GLOBAL", guild, channel, user);
     }
 }
-exports.ODStatGlobalScope = ODStatGlobalScope;
-/**## ODStat `class`
+exports.ODStatisticGlobalScope = ODStatisticGlobalScope;
+/**## ODStatistic `class`
  * This is an Open Discord statistic.
  *
  * This single statistic doesn't do anything except defining the rules of this statistic.
- * Use it in a stats scope to register a new statistic. A statistic can also include a priority to choose the render priority.
+ * Use it in a statistics scope to register a new statistic. A statistic can also include a priority to choose the render priority.
  *
- * It's recommended to use the `ODBasicStat` & `ODDynamicStat` classes instead of this one!
+ * It's recommended to use the `ODBaseStatistic` & `ODDynamicStatistic` classes instead of this one!
  */
-class ODStat extends base_1.ODManagerData {
+class ODStatistic extends base_1.ODManagerData {
     /**The priority of this statistic. */
     priority;
     /**The render function of this statistic. */
@@ -271,15 +271,15 @@ class ODStat extends base_1.ODManagerData {
         this.value = value ?? null;
     }
 }
-exports.ODStat = ODStat;
-/**## ODBasicStat `class`
+exports.ODStatistic = ODStatistic;
+/**## ODBaseStatistic `class`
  * This is an Open Discord basic statistic.
  *
  * This single statistic will store a number, boolean or string in the database.
- * Use it to create a simple statistic for any stats scope.
+ * Use it to create a simple statistic for any statistics scope.
  */
-class ODBasicStat extends ODStat {
-    /**The name of this stat. Rendered in discord embeds/messages. */
+class ODBaseStatistic extends ODStatistic {
+    /**The name of this statistic. Rendered in discord embeds/messages. */
     name;
     constructor(id, priority, name, value) {
         super(id, priority, (value) => {
@@ -288,8 +288,8 @@ class ODBasicStat extends ODStat {
         this.name = name;
     }
 }
-exports.ODBasicStat = ODBasicStat;
-/**## ODDynamicStat `class`
+exports.ODBaseStatistic = ODBaseStatistic;
+/**## ODDynamicStatistic `class`
  * This is an Open Discord dynamic statistic.
  *
  * A dynamic statistic does not store anything in the database! Instead, it will execute a function to return a custom result.
@@ -297,11 +297,11 @@ exports.ODBasicStat = ODBasicStat;
  *
  * This is used in Open Discord for the live ticket status, participants & system status.
  */
-class ODDynamicStat extends ODStat {
+class ODDynamicStatistic extends ODStatistic {
     constructor(id, priority, render) {
         super(id, priority, (value, scopeId, guild, channel, user) => {
             return render(scopeId, guild, channel, user);
         });
     }
 }
-exports.ODDynamicStat = ODDynamicStat;
+exports.ODDynamicStatistic = ODDynamicStatistic;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.3",
+    "version": "0.2.5",
     "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/index.ts

@@ -20,7 +20,7 @@ export * from "./modules/action"
 export * from "./modules/permission"
 export * from "./modules/helpmenu"
 export * from "./modules/session"
-export * from "./modules/stat"
+export * from "./modules/statistic"
 export * from "./modules/code"
 export * from "./modules/cooldown"
 export * from "./modules/post"

package/src/api/main.ts

@@ -1,26 +1,26 @@
 //BASE MODULES
-import { ODEnvHelper, ODProjectType, ODVersion, ODVersionManager, ODVersionManagerIdConstraint } from "./modules/base"
-import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager, ODLiveStatusManagerIdConstraint } from "./modules/console"
-import { ODCheckerFunctionManagerIdConstraint, ODCheckerManager, ODCheckerManagerIdConstraint, ODCheckerRenderer } from "./modules/checker"
+import { ODEnvHelper, ODProjectType, ODVersion, ODVersionManager } from "./modules/base"
+import { ODConsoleManager, ODConsoleMessage, ODConsoleMessageParam, ODConsoleMessageTypes, ODDebugFileManager, ODDebugger, ODError, ODLiveStatusManager } from "./modules/console"
+import { ODCheckerManager } from "./modules/checker"
 import { ODEventManager } from "./modules/event"
 import { ODPluginManager } from "./modules/plugin"
 import { ODFlagManager } from "./modules/flag"
 import { ODProgressBarManager } from "./modules/progressbar"
-import { ODConfigManager, ODConfigManagerIdConstraint } from "./modules/config"
-import { ODDatabaseManager, ODDatabaseManagerIdConstraint } from "./modules/database"
+import { ODConfigManager } from "./modules/config"
+import { ODDatabaseManager } from "./modules/database"
 import { ODSessionManager } from "./modules/session"
 import { ODLanguageManager } from "./modules/language"
-import { ODBuilderManager, ODButtonManagerIdConstraint, ODDropdownManagerIdConstraint, ODEmbedManagerIdConstraint, ODFileManagerIdConstraint, ODMessageManagerIdConstraint, ODModalManagerIdConstraint } from "./modules/builder"
+import { ODBuilderManager } from "./modules/builder"
 import { ODResponderManager } from "./modules/responder"
-import { ODActionManager, ODActionManagerIdConstraint } from "./modules/action"
+import { ODActionManager } from "./modules/action"
 import { ODVerifyBarManager } from "./modules/verifybar"
 import { ODPermissionManager } from "./modules/permission"
-import { ODCooldownManager, ODCooldownManagerIdConstraint } from "./modules/cooldown"
+import { ODCooldownManager } from "./modules/cooldown"
 import { ODHelpMenuManager } from "./modules/helpmenu"
-import { ODStatsManager } from "./modules/stat"
-import { ODCodeManager, ODCodeManagerIdConstraint } from "./modules/code"
+import { ODStatisticManager } from "./modules/statistic"
+import { ODCodeManager } from "./modules/code"
 import { ODPostManager } from "./modules/post"
-import { ODClientManager, ODContextMenuManagerIdConstraint, ODSlashCommandManagerIdConstraint, ODTextCommandManagerIdConstraint } from "./modules/client"
+import { ODClientManager } from "./modules/client"
 import { ODSharedFuseManager } from "./modules/fuse"
 import { ODStartScreenManager } from "./modules/startscreen"
 
@@ -77,7 +77,7 @@ export interface ODMainManagers {
     /**The manager that manages & renders the Open Discord help menu. (not the embed, but the text) */
     helpmenu: ODHelpMenuManager
     /**The manager that manages, saves & renders the Open Discord statistics. (not the embed, but the text & database) */
-    stats: ODStatsManager
+    statistics: ODStatisticManager
     /**This manager is a place where you can put code that executes when the bot almost finishes the setup. (can be used for less important stuff that doesn't require an exact time-order) */
     code: ODCodeManager
     /**The manager that manages all posts (static discord channels) in the bot. (e.g. transcripts, logs, etc) */
@@ -129,7 +129,7 @@ export class ODMain implements ODMainManagers {
     readonly permissions: ODPermissionManager
     readonly cooldowns: ODCooldownManager
     readonly helpmenu: ODHelpMenuManager
-    readonly stats: ODStatsManager
+    readonly statistics: ODStatisticManager
     readonly code: ODCodeManager
     readonly posts: ODPostManager
     
@@ -167,7 +167,7 @@ export class ODMain implements ODMainManagers {
         this.permissions = managers.permissions
         this.cooldowns = managers.cooldowns
         this.helpmenu = managers.helpmenu
-        this.stats = managers.stats
+        this.statistics = managers.statistics
         this.code = managers.code
         this.posts = managers.posts
         

package/src/api/modules/code.ts

@@ -12,7 +12,7 @@ import { ODDebugger } from "./console"
  * 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, stats & used options)
+ * - Database syncronisation (with tickets, statistics & used options)
  * - Panel auto-update
  * - Database Garbage Collection (removing tickets that don't exist anymore)
  * - And more!

package/src/api/modules/console.ts

@@ -347,7 +347,7 @@ export class ODDebugFileManager {
             fs.writeFileSync(this.path,newtext)
         }
     }
-    /**Generate the stats/header of the debug file (containing the version) */
+    /**Generate the statistics/header of the debug file (containing the version) */
     #createStatsText(){
         const date = new Date()
         const dstring = `${date.getDate()}/${date.getMonth()+1}/${date.getFullYear()} ${date.getHours()}:${date.getMinutes()}:${date.getSeconds()}`
@@ -359,7 +359,7 @@ export class ODDebugFileManager {
             "=========================\n\n"
         ].join("\n")
     }
-    /**Write the stats/header to the debug file on startup */
+    /**Write the statistics/header to the debug file on startup */
     #writeStartupStats(){
         const currenttext = this.#readDebugFile()
         if (currenttext){

package/src/api/modules/fuse.ts

@@ -212,12 +212,12 @@ export interface ODSharedFuseList {
     /**Load the default Open Discord help menu components. */
     helpMenuComponentLoading:boolean,
 
-    /**Load the default Open Discord stat scopes. */
-    statScopesLoading:boolean,
-    /**Load the default Open Discord stats. */
-    statLoading:boolean,
-    /**Initiate the default Open Discord stats. */
-    statInitiating:boolean,
+    /**Load the default Open Discord statistic scopes. */
+    statisticScopesLoading:boolean,
+    /**Load the default Open Discord statistics. */
+    statisticLoading:boolean,
+    /**Initiate the default Open Discord statistics. */
+    statisticInitiating:boolean,
 
     /**Load the default Open Discord code/functions. */
     codeLoading:boolean,
@@ -329,9 +329,9 @@ export class ODSharedFuseManager extends ODFuseManager<ODSharedFuseList> {
             helpMenuCategoryLoading:true,
             helpMenuComponentLoading:true,
 
-            statScopesLoading:true,
-            statLoading:true,
-            statInitiating:true,
+            statisticScopesLoading:true,
+            statisticLoading:true,
+            statisticInitiating:true,
 
             codeLoading:true,
             codeExecution:true,

package/src/api/modules/progressbar.ts

@@ -2,8 +2,9 @@
 //PROGRESS BAR MODULE
 ///////////////////////////////////////
 import { ODSystemError, ODManager, ODManagerData, ODValidId } from "./base"
-import { ODDebugger } from "./console"
+import { ODDebugger, ODValidConsoleColor } from "./console"
 import readline from "readline"
+import ansis from "ansis"
 
 /**## ODProgressBarRendererManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODProgressBarRendererManager` class.
@@ -282,4 +283,87 @@ export class ODManualProgressBar extends ODProgressBar {
     decrease(amount:number,stop?:boolean){
         super.update(this.value-amount,stop)
     }
+}
+
+/**## ODDefaultProgressBarRendererLabel `type`
+ * All available label types for the default progress bar renderer
+ */
+export type ODDefaultProgressBarRendererLabel = "value"|"percentage"|"fraction"|"time-ms"|"time-sec"|"time-min"
+
+/**## ODDefaultProgressBarRendererSettings `interface`
+ * All settings for the default progress bar renderer.
+ */
+export interface ODDefaultProgressBarRendererSettings {
+    /**The color of the progress bar border. */
+    borderColor:ODValidConsoleColor|"openticket"|"openmoderation",
+    /**The color of the progress bar (filled side). */
+    filledBarColor:ODValidConsoleColor|"openticket"|"openmoderation",
+    /**The color of the progress bar (empty side). */
+    emptyBarColor:ODValidConsoleColor|"openticket"|"openmoderation",
+    /**The color of the text before the progress bar. */
+    prefixColor:ODValidConsoleColor|"openticket"|"openmoderation",
+    /**The color of the text after the progress bar. */
+    suffixColor:ODValidConsoleColor|"openticket"|"openmoderation",
+    /**The color of the progress bar label. */
+    labelColor:ODValidConsoleColor|"openticket"|"openmoderation",
+
+    /**The character used in the left border. */
+    leftBorderChar:string,
+    /**The character used in the right border. */
+    rightBorderChar:string,
+    /**The character used in the filled side of the progress bar. */
+    filledBarChar:string,
+    /**The character used in the empty side of the progress bar. */
+    emptyBarChar:string,
+    /**The label type. (will show a number related to the progress) */
+    labelType:ODDefaultProgressBarRendererLabel,
+    /**The position of the label. */
+    labelPosition:"start"|"end",
+    /**The width of the bar. (50 characters by default) */
+    barWidth:number,
+
+    /**Show the bar. */
+    showBar:boolean,
+    /**Show the label. */
+    showLabel:boolean,
+    /**Show the border. */
+    showBorder:boolean,
+}
+
+export class ODDefaultProgressBarRenderer extends ODProgressBarRenderer<ODDefaultProgressBarRendererSettings> {
+    constructor(id:ODValidId,settings:ODDefaultProgressBarRendererSettings){
+        super(id,(settings,min,max,value,rawPrefix,rawSuffix) => {
+            const percentage = (value-min)/(max-min)
+            const barLevel = Math.round(percentage*settings.barWidth)
+
+            const borderAnsis = this.#switchColorAnsis(settings.borderColor)
+            const filledBarAnsis = this.#switchColorAnsis(settings.filledBarColor)
+            const emptyBarAnsis = this.#switchColorAnsis(settings.emptyBarColor)
+            const labelAnsis = this.#switchColorAnsis(settings.labelColor)
+            const prefixAnsis = this.#switchColorAnsis(settings.prefixColor)
+            const suffixAnsis = this.#switchColorAnsis(settings.suffixColor)
+
+            const leftBorder = (settings.showBorder) ? borderAnsis(settings.leftBorderChar) : ""
+            const rightBorder = (settings.showBorder) ? borderAnsis(settings.rightBorderChar) : ""
+            const bar = (settings.showBar) ? filledBarAnsis(settings.filledBarChar.repeat(barLevel))+emptyBarAnsis(settings.emptyBarChar.repeat(settings.barWidth-barLevel)) : ""
+            const prefix = (rawPrefix) ? prefixAnsis(rawPrefix)+" " : ""
+            const suffix = (rawSuffix) ? " "+suffixAnsis(rawSuffix) : ""
+            let label: string
+            if (!settings.showLabel) label = ""
+            if (settings.labelType == "fraction") label = labelAnsis(value+"/"+max)
+            else if (settings.labelType == "percentage") label = labelAnsis(Math.round(percentage*100)+"%")
+            else if (settings.labelType == "time-ms") label = labelAnsis(value+"ms")
+            else if (settings.labelType == "time-sec") label = labelAnsis(Math.round(value*10)/10+"sec")
+            else if (settings.labelType == "time-min") label = labelAnsis(Math.round(value*10)/10+"min")
+            else label = labelAnsis(value.toString())
+
+            const labelWithPrefixAndSuffix = prefix+label+suffix
+            return (settings.labelPosition == "start") ? labelWithPrefixAndSuffix+" "+leftBorder+bar+rightBorder : leftBorder+bar+rightBorder+" "+labelWithPrefixAndSuffix
+        },settings)
+    }
+
+    /**Switch between Ansis functions based on the specified color. */
+    #switchColorAnsis(c:ODValidConsoleColor|"openticket"|"openmoderation"){
+        return (c === "openticket") ? ansis.hex("#f8ba00") : (c === "openmoderation") ? ansis.hex("#1690ff") : ansis[c]
+    }
 }