@open-discord-bots/framework 0.0.1 → 0.0.2

package/dist/api/modules/post.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ODPost = exports.ODPostManager = void 0;
+///////////////////////////////////////
+//POST MODULE
+///////////////////////////////////////
+const base_1 = require("./base");
+/**## ODPostManager `class`
+ * This is an Open Discord post manager.
+ *
+ * It manages `ODPosts`'s for you.
+ *
+ * You can use this to get the logs channel of the bot (or some other static channel/category).
+ */
+class ODPostManager extends base_1.ODManager {
+    /**A reference to the main server of the bot */
+    #guild = null;
+    constructor(debug) {
+        super(debug, "post");
+    }
+    add(data, overwrite) {
+        if (this.#guild)
+            data.useGuild(this.#guild);
+        return super.add(data, overwrite);
+    }
+    /**Initialize the post manager & all posts. */
+    async init(guild) {
+        this.#guild = guild;
+        for (const post of this.getAll()) {
+            post.useGuild(guild);
+            await post.init();
+        }
+    }
+}
+exports.ODPostManager = ODPostManager;
+/**## ODPost `class`
+ * This is an Open Discord post class.
+ *
+ * A post is just a shortcut to a static discord channel or category.
+ * This can be used to get a specific channel over and over again!
+ *
+ * This class also contains utilities for sending messages via the Open Discord builders.
+ */
+class ODPost extends base_1.ODManagerData {
+    /**A reference to the main server of the bot */
+    #guild = null;
+    /**Is this post already initialized? */
+    ready = false;
+    /**The discord.js channel */
+    channel = null;
+    /**The discord channel id */
+    channelId;
+    constructor(id, channelId) {
+        super(id);
+        this.channelId = channelId;
+    }
+    /**Use a specific guild in this class for fetching the channel*/
+    useGuild(guild) {
+        this.#guild = guild;
+    }
+    /**Change the channel id to another channel! */
+    setChannelId(id) {
+        this.channelId = id;
+    }
+    /**Initialize the discord.js channel of this post. */
+    async init() {
+        if (this.ready)
+            return;
+        if (!this.#guild)
+            return this.channel = null;
+        try {
+            this.channel = await this.#guild.channels.fetch(this.channelId);
+        }
+        catch {
+            this.channel = null;
+        }
+        this.ready = true;
+    }
+    /**Send a message to this channel using the Open Discord builder system */
+    async send(msg) {
+        if (!this.channel || !this.channel.isTextBased())
+            return { success: false, message: null };
+        try {
+            const sent = await this.channel.send(msg.message);
+            return { success: true, message: sent };
+        }
+        catch {
+            return { success: false, message: null };
+        }
+    }
+}
+exports.ODPost = ODPost;

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

@@ -0,0 +1,108 @@
+import { ODManager, ODManagerData, ODValidId } from "./base";
+import { ODDebugger } from "./console";
+/**## ODProgressBarRendererManager `class`
+ * This is an Open Discord progress bar renderer manager.
+ *
+ * It is responsible for managing all console progress bar renderers in Open Discord.
+ *
+ * A renderer is a function which will try to visualize the progress bar in the console.
+ */
+export declare class ODProgressBarRendererManager extends ODManager<ODProgressBarRenderer<{}>> {
+    constructor(debug: ODDebugger);
+}
+/**## ODProgressBarManager `class`
+ * This is an Open Discord progress bar manager.
+ *
+ * It is responsible for managing all console progress bars in Open Discord. An example of this is the slash command registration progress bar.
+ *
+ * There are many types of progress bars available, but you can also create your own!
+ */
+export declare class ODProgressBarManager extends ODManager<ODProgressBar> {
+    renderers: ODProgressBarRendererManager;
+    constructor(debug: ODDebugger);
+}
+/**## ODProgressBarRenderFunc `type`
+ * This is the render function for an Open Discord console progress bar.
+ */
+export type ODProgressBarRenderFunc<Settings extends {}> = (settings: Settings, min: number, max: number, value: number, prefix: string | null, suffix: string | null) => string;
+/**## ODProgressBarRenderer `class`
+ * This is an Open Discord console progress bar renderer.
+ *
+ * It is used to render a progress bar in the console of the bot.
+ *
+ * There are already a lot of default options available if you just want an easy progress bar!
+ */
+export declare class ODProgressBarRenderer<Settings extends {}> extends ODManagerData {
+    #private;
+    settings: Settings;
+    constructor(id: ODValidId, render: ODProgressBarRenderFunc<Settings>, settings: Settings);
+    /**Render a progress bar using this renderer. */
+    render(min: number, max: number, value: number, prefix: string | null, suffix: string | null): string;
+    withAdditionalSettings(settings: Partial<Settings>): ODProgressBarRenderer<Settings>;
+}
+/**## ODProgressBar `class`
+ * This is an Open Discord console progress bar.
+ *
+ * It is used to create a simple or advanced progress bar in the console of the bot.
+ * These progress bars are not visible in the `debug.txt` file and should only be used as extra visuals.
+ *
+ * Use other classes as existing templates or create your own progress bar from scratch using this class.
+ */
+export declare class ODProgressBar extends ODManagerData {
+    #private;
+    /**The renderer of this progress bar. */
+    renderer: ODProgressBarRenderer<{}>;
+    /**The current value of the progress bar. */
+    protected value: number;
+    /**The minimum value of the progress bar. */
+    min: number;
+    /**The maximum value of the progress bar. */
+    max: number;
+    /**The initial value of the progress bar. */
+    initialValue: number;
+    /**The prefix displayed in the progress bar. */
+    prefix: string | null;
+    /**The prefix displayed in the progress bar. */
+    suffix: string | null;
+    /**Enable automatic stopping when reaching `min` or `max`. */
+    autoStop: null | "min" | "max";
+    constructor(id: ODValidId, renderer: ODProgressBarRenderer<{}>, min: number, max: number, value: number, autoStop: null | "min" | "max", prefix: string | null, suffix: string | null);
+    /**Start showing this progress bar in the console. */
+    start(): boolean;
+    /**Update this progress bar while active. (will automatically update the progress bar in the console) */
+    protected update(value: number, stop?: boolean): boolean;
+    /**Wait for the progress bar to finish. */
+    finished(): Promise<void>;
+}
+/**## ODTimedProgressBar `class`
+ * This is an Open Discord timed console progress bar.
+ *
+ * It is used to create a simple timed progress bar in the console.
+ * You can set a fixed duration (milliseconds) in the constructor.
+ */
+export declare class ODTimedProgressBar extends ODProgressBar {
+    #private;
+    /**The time in milliseconds. */
+    time: number;
+    /**The mode of the timer. */
+    mode: "increasing" | "decreasing";
+    constructor(id: ODValidId, renderer: ODProgressBarRenderer<{}>, time: number, mode: "increasing" | "decreasing", prefix: string | null, suffix: string | null);
+    start(): boolean;
+}
+/**## ODManualProgressBar `class`
+ * This is an Open Discord manual console progress bar.
+ *
+ * It is used to create a simple manual progress bar in the console.
+ * You can update the progress manually using `update()`.
+ */
+export declare class ODManualProgressBar extends ODProgressBar {
+    constructor(id: ODValidId, renderer: ODProgressBarRenderer<{}>, amount: number, autoStop: null | "min" | "max", prefix: string | null, suffix: string | null);
+    /**Set the value of the progress bar. */
+    set(value: number, stop?: boolean): void;
+    /**Get the current value of the progress bar. */
+    get(): number;
+    /**Increase the value of the progress bar. */
+    increase(amount: number, stop?: boolean): void;
+    /**Decrease the value of the progress bar. */
+    decrease(amount: number, stop?: boolean): void;
+}

package/dist/api/modules/progressbar.js

@@ -0,0 +1,233 @@
+"use strict";
+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;
+///////////////////////////////////////
+//PROGRESS BAR MODULE
+///////////////////////////////////////
+const base_1 = require("./base");
+const readline_1 = __importDefault(require("readline"));
+/**## ODProgressBarRendererManager `class`
+ * This is an Open Discord progress bar renderer manager.
+ *
+ * It is responsible for managing all console progress bar renderers in Open Discord.
+ *
+ * A renderer is a function which will try to visualize the progress bar in the console.
+ */
+class ODProgressBarRendererManager extends base_1.ODManager {
+    constructor(debug) {
+        super(debug, "progress bar renderer");
+    }
+}
+exports.ODProgressBarRendererManager = ODProgressBarRendererManager;
+/**## ODProgressBarManager `class`
+ * This is an Open Discord progress bar manager.
+ *
+ * It is responsible for managing all console progress bars in Open Discord. An example of this is the slash command registration progress bar.
+ *
+ * There are many types of progress bars available, but you can also create your own!
+ */
+class ODProgressBarManager extends base_1.ODManager {
+    renderers;
+    constructor(debug) {
+        super(debug, "progress bar");
+        this.renderers = new ODProgressBarRendererManager(debug);
+    }
+}
+exports.ODProgressBarManager = ODProgressBarManager;
+/**## ODProgressBarRenderer `class`
+ * This is an Open Discord console progress bar renderer.
+ *
+ * It is used to render a progress bar in the console of the bot.
+ *
+ * There are already a lot of default options available if you just want an easy progress bar!
+ */
+class ODProgressBarRenderer extends base_1.ODManagerData {
+    settings;
+    #render;
+    constructor(id, render, settings) {
+        super(id);
+        this.#render = render;
+        this.settings = settings;
+    }
+    /**Render a progress bar using this renderer. */
+    render(min, max, value, prefix, suffix) {
+        try {
+            return this.#render(this.settings, min, max, value, prefix, suffix);
+        }
+        catch (err) {
+            process.emit("uncaughtException", err);
+            return "<PROGRESS-BAR-ERROR>";
+        }
+    }
+    withAdditionalSettings(settings) {
+        const newSettings = { ...this.settings };
+        for (const key of Object.keys(settings)) {
+            if (typeof settings[key] != "undefined")
+                newSettings[key] = settings[key];
+        }
+        return new ODProgressBarRenderer(this.id, this.#render, newSettings);
+    }
+}
+exports.ODProgressBarRenderer = ODProgressBarRenderer;
+/**## ODProgressBar `class`
+ * This is an Open Discord console progress bar.
+ *
+ * It is used to create a simple or advanced progress bar in the console of the bot.
+ * These progress bars are not visible in the `debug.txt` file and should only be used as extra visuals.
+ *
+ * Use other classes as existing templates or create your own progress bar from scratch using this class.
+ */
+class ODProgressBar extends base_1.ODManagerData {
+    /**The renderer of this progress bar. */
+    renderer;
+    /**Is this progress bar currently active? */
+    #active = false;
+    /**A list of listeners when the progress bar stops. */
+    #stopListeners = [];
+    /**The current value of the progress bar. */
+    value;
+    /**The minimum value of the progress bar. */
+    min;
+    /**The maximum value of the progress bar. */
+    max;
+    /**The initial value of the progress bar. */
+    initialValue;
+    /**The prefix displayed in the progress bar. */
+    prefix;
+    /**The prefix displayed in the progress bar. */
+    suffix;
+    /**Enable automatic stopping when reaching `min` or `max`. */
+    autoStop;
+    constructor(id, renderer, min, max, value, autoStop, prefix, suffix) {
+        super(id);
+        this.renderer = renderer;
+        this.min = min;
+        this.max = max;
+        this.initialValue = this.#parseValue(value);
+        this.value = this.#parseValue(value);
+        this.autoStop = autoStop;
+        this.prefix = prefix;
+        this.suffix = suffix;
+    }
+    /**Parse a value in such a way that it doesn't go below/above the min/max limits. */
+    #parseValue(value) {
+        if (value > this.max)
+            return this.max;
+        else if (value < this.min)
+            return this.min;
+        else
+            return value;
+    }
+    /**Render progress bar to the console. */
+    #renderStdout() {
+        if (!this.#active)
+            return;
+        readline_1.default.clearLine(process.stdout, 0);
+        readline_1.default.cursorTo(process.stdout, 0);
+        process.stdout.write(this.renderer.render(this.min, this.max, this.value, this.prefix, this.suffix));
+    }
+    /**Start showing this progress bar in the console. */
+    start() {
+        if (this.#active)
+            return false;
+        this.value = this.#parseValue(this.initialValue);
+        this.#active = true;
+        this.#renderStdout();
+        return true;
+    }
+    /**Update this progress bar while active. (will automatically update the progress bar in the console) */
+    update(value, stop) {
+        if (!this.#active)
+            return false;
+        this.value = this.#parseValue(value);
+        this.#renderStdout();
+        if (stop || (this.autoStop == "max" && this.value == this.max) || (this.autoStop == "min" && this.value == this.min)) {
+            process.stdout.write("\n");
+            this.#active = false;
+            this.#stopListeners.forEach((cb) => cb());
+            this.#stopListeners = [];
+        }
+        return true;
+    }
+    /**Wait for the progress bar to finish. */
+    finished() {
+        return new Promise((resolve) => {
+            this.#stopListeners.push(resolve);
+        });
+    }
+}
+exports.ODProgressBar = ODProgressBar;
+/**## ODTimedProgressBar `class`
+ * This is an Open Discord timed console progress bar.
+ *
+ * It is used to create a simple timed progress bar in the console.
+ * You can set a fixed duration (milliseconds) in the constructor.
+ */
+class ODTimedProgressBar extends ODProgressBar {
+    /**The time in milliseconds. */
+    time;
+    /**The mode of the timer. */
+    mode;
+    constructor(id, renderer, time, mode, prefix, suffix) {
+        super(id, renderer, 0, time, 0, (mode == "increasing") ? "max" : "min", prefix, suffix);
+        this.time = time;
+        this.mode = mode;
+    }
+    /**The timer which is used. */
+    async #timer(ms) {
+        return new Promise((resolve) => {
+            setTimeout(() => {
+                resolve();
+            }, ms);
+        });
+    }
+    /**Run the timed progress bar. */
+    async #execute() {
+        let i = 0;
+        const fragment = this.time / 100;
+        while (i < 100) {
+            await this.#timer(fragment);
+            i++;
+            super.update((this.mode == "increasing") ? (i * fragment) : this.time - (i * fragment));
+        }
+    }
+    start() {
+        const res = super.start();
+        if (!res)
+            return false;
+        this.#execute();
+        return true;
+    }
+}
+exports.ODTimedProgressBar = ODTimedProgressBar;
+/**## ODManualProgressBar `class`
+ * This is an Open Discord manual console progress bar.
+ *
+ * It is used to create a simple manual progress bar in the console.
+ * You can update the progress manually using `update()`.
+ */
+class ODManualProgressBar extends ODProgressBar {
+    constructor(id, renderer, amount, autoStop, prefix, suffix) {
+        super(id, renderer, 0, amount, 0, autoStop, prefix, suffix);
+    }
+    /**Set the value of the progress bar. */
+    set(value, stop) {
+        super.update(value, stop);
+    }
+    /**Get the current value of the progress bar. */
+    get() {
+        return this.value;
+    }
+    /**Increase the value of the progress bar. */
+    increase(amount, stop) {
+        super.update(this.value + amount, stop);
+    }
+    /**Decrease the value of the progress bar. */
+    decrease(amount, stop) {
+        super.update(this.value - amount, stop);
+    }
+}
+exports.ODManualProgressBar = ODManualProgressBar;