@open-discord-bots/framework 0.2.3 → 0.2.4

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

@@ -1,5 +1,5 @@
 import { ODManager, ODManagerData, ODValidId } from "./base";
-import { ODDebugger } from "./console";
+import { ODDebugger, ODValidConsoleColor } from "./console";
 /**## ODProgressBarRendererManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODProgressBarRendererManager` class.
  */
@@ -127,3 +127,48 @@ export declare class ODManualProgressBar extends ODProgressBar {
     /**Decrease the value of the progress bar. */
     decrease(amount: number, stop?: boolean): void;
 }
+/**## 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 declare class ODDefaultProgressBarRenderer extends ODProgressBarRenderer<ODDefaultProgressBarRendererSettings> {
+    #private;
+    constructor(id: ODValidId, settings: ODDefaultProgressBarRendererSettings);
+}

package/dist/api/modules/progressbar.js

@@ -3,12 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ODManualProgressBar = exports.ODTimedProgressBar = exports.ODProgressBar = exports.ODProgressBarRenderer = exports.ODProgressBarManager = exports.ODProgressBarRendererManager = void 0;
+exports.ODDefaultProgressBarRenderer = exports.ODManualProgressBar = exports.ODTimedProgressBar = exports.ODProgressBar = exports.ODProgressBarRenderer = exports.ODProgressBarManager = exports.ODProgressBarRendererManager = void 0;
 ///////////////////////////////////////
 //PROGRESS BAR MODULE
 ///////////////////////////////////////
 const base_1 = require("./base");
 const readline_1 = __importDefault(require("readline"));
+const ansis_1 = __importDefault(require("ansis"));
 /**## ODProgressBarRendererManager `class`
  * This is an Open Discord progress bar renderer manager.
  *
@@ -250,3 +251,44 @@ class ODManualProgressBar extends ODProgressBar {
     }
 }
 exports.ODManualProgressBar = ODManualProgressBar;
+class ODDefaultProgressBarRenderer extends ODProgressBarRenderer {
+    constructor(id, settings) {
+        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;
+            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) {
+        return (c === "openticket") ? ansis_1.default.hex("#f8ba00") : (c === "openmoderation") ? ansis_1.default.hex("#1690ff") : ansis_1.default[c];
+    }
+}
+exports.ODDefaultProgressBarRenderer = ODDefaultProgressBarRenderer;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.2.3",
+    "version": "0.2.4",
     "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/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]
+    }
 }