zumito-framework 1.1.64 → 1.1.66

package/dist/ZumitoFramework.d.ts

@@ -1,10 +1,12 @@
-import { GuildMember, TextChannel, Client } from 'discord.js';
+import { Client, GuildMember, TextChannel } from 'discord.js';
 import { Command } from './types/Command.js';
+import { DatabaseModel } from './types/DatabaseModel.js';
+import { EventEmitter } from 'events';
+import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { FrameworkSettings } from './types/FrameworkSettings.js';
 import { Module } from './types/Module.js';
-import { FrameworkEvent } from './types/FrameworkEvent.js';
+import { StatusManager } from './managers/StatusManager.js';
 import { TranslationManager } from './TranslationManager.js';
-import { DatabaseModel } from './types/DatabaseModel.js';
 /**
  * @class ZumitoFramework
  * @description The main class of the framework.
@@ -82,6 +84,21 @@ export declare class ZumitoFramework {
      * @see {@link https://expressjs.com/en/4x/api.html#app}
      */
     app: any;
+    /**
+     * The Status Manager instance.
+     * @type {StatusManager}
+     * @private
+     * @see {@link StatusManager}
+     */
+    statusManager: StatusManager;
+    /**
+     * Event emitter for the framework.
+     * All events related to the framework are emitted from here.
+     * @type {EventEmitter}
+     * @private
+     * @see {@link https://nodejs.org/api/events.html#events_class_eventemitter}
+     */
+    eventEmitter: EventEmitter;
     /**
      * @constructor
      * @param {FrameworkSettings} settings - The settings to use for the framework.

package/dist/ZumitoFramework.js

@@ -1,22 +1,24 @@
-import { SlashCommandBuilder, Client, } from 'discord.js';
-import { Module } from './types/Module.js';
-import { ApiResponse } from './definitions/ApiResponse.js';
-import { baseModule } from './baseModule/index.js';
-import { TranslationManager } from './TranslationManager.js';
-import express from 'express';
 import * as fs from 'fs';
-import path from 'path';
-// import better-logging
-import { betterLogging } from 'better-logging';
-betterLogging(console);
+import * as url from 'url';
+import { Client, SlashCommandBuilder, } from 'discord.js';
+import { ApiResponse } from './definitions/ApiResponse.js';
+import { CommandType } from './types/CommandType.js';
+import { EventEmitter } from 'events';
+import { Module } from './types/Module.js';
 import { REST } from '@discordjs/rest';
 import { Routes } from 'discord-api-types/v9';
+import { StatusManager } from './managers/StatusManager.js';
+import { TranslationManager } from './TranslationManager.js';
+import { baseModule } from './baseModule/index.js';
+import { betterLogging } from 'better-logging';
 import canario from 'canario';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
+import express from 'express';
 import http from 'http';
-import * as url from 'url';
-import { CommandType } from './types/CommandType.js';
+import path from 'path';
+// import better-logging
+betterLogging(console);
 /**
  * @class ZumitoFramework
  * @description The main class of the framework.
@@ -94,6 +96,21 @@ export class ZumitoFramework {
      * @see {@link https://expressjs.com/en/4x/api.html#app}
      */
     app;
+    /**
+     * The Status Manager instance.
+     * @type {StatusManager}
+     * @private
+     * @see {@link StatusManager}
+     */
+    statusManager;
+    /**
+     * Event emitter for the framework.
+     * All events related to the framework are emitted from here.
+     * @type {EventEmitter}
+     * @private
+     * @see {@link https://nodejs.org/api/events.html#events_class_eventemitter}
+     */
+    eventEmitter = new EventEmitter();
     /**
      * @constructor
      * @param {FrameworkSettings} settings - The settings to use for the framework.
@@ -132,6 +149,9 @@ export class ZumitoFramework {
         this.startApiServer();
         await this.registerModules();
         await this.refreshSlashCommands();
+        if (this.settings.statusOptions) {
+            this.statusManager = new StatusManager(this, this.settings.statusOptions);
+        }
     }
     async initializeDatabase() {
         const folders = ['db', 'db/tingodb'];

package/dist/baseModule/events/discord/messageCreate.d.ts

@@ -7,7 +7,7 @@ export declare class MessageCreate extends FrameworkEvent {
     autocorrect(str: string, words: string[]): any;
     getErrorEmbed(error: any, parse: any): {
         embeds: EmbedBuilder[];
-        components: ActionRowBuilder<import("discord.js").AnyComponentBuilder>[];
+        components: ActionRowBuilder<import("@discordjs/builders").AnyComponentBuilder>[];
         allowedMentions: {
             repliedUser: boolean;
         };

package/dist/baseModule/events/discord/messageCreate.js

@@ -1,5 +1,5 @@
 import * as url from 'url';
-import { ActionRowBuilder, ButtonBuilder, ButtonStyle, EmbedBuilder, PermissionsBitField, } from 'discord.js';
+import { ActionRowBuilder, ButtonBuilder, ButtonStyle, ChannelType, EmbedBuilder, PermissionsBitField, } from 'discord.js';
 import ErrorStackParser from 'error-stack-parser';
 import { FrameworkEvent } from '../../../types/FrameworkEvent.js';
 import { ZumitoFramework } from '../../../ZumitoFramework.js';
@@ -141,7 +141,9 @@ export class MessageCreate extends FrameworkEvent {
                     message.reply(content);
                 }
                 catch (e) {
-                    channel.send(content);
+                    if (channel.type !== ChannelType.GuildStageVoice) {
+                        channel.send(content);
+                    }
                 }
             }
         }

package/dist/index.d.ts

@@ -1,20 +1,23 @@
+import { PresenceDataRule, RuledPresenceData, StatusManagerOptions } from './types/StatusManagerOptions.js';
 import { ApiResponse } from './definitions/ApiResponse.js';
-import { TranslationManager } from './TranslationManager.js';
+import { ButtonPressed } from './types/Commands/ButtonPressed.js';
+import { ButtonPressedParams } from './types/Commands/ButtonPressedParams.js';
 import { Command } from './types/Command.js';
 import { CommandArgDefinition } from './types/CommandArgDefinition.js';
 import { CommandArguments } from './types/CommandArguments.js';
 import { CommandChoiceDefinition } from './types/CommandChoiceDefinition.js';
 import { CommandParameters } from './types/CommandParameters.js';
-import { ButtonPressed } from './types/Commands/ButtonPressed.js';
-import { ButtonPressedParams } from './types/Commands/ButtonPressedParams.js';
 import { CommandType } from './types/CommandType.js';
+import { DatabaseConfigLoader } from './utils/DatabaseConfigLoader.js';
+import { DatabaseModel } from './types/DatabaseModel.js';
+import { EmojiFallback } from './utils/EmojiFallback.js';
 import { FrameworkEvent } from './types/FrameworkEvent.js';
 import { FrameworkSettings } from './types/FrameworkSettings.js';
 import { Module } from './types/Module.js';
 import { SelectMenuParameters } from './types/SelectMenuParameters.js';
-import { Translation } from './types/Translation.js';
-import { DatabaseConfigLoader } from './utils/DatabaseConfigLoader.js';
-import { EmojiFallback } from './utils/EmojiFallback.js';
 import { TextFormatter } from './utils/TextFormatter.js';
+import { Translation } from './types/Translation.js';
+import { TranslationManager } from './TranslationManager.js';
 import { ZumitoFramework } from './ZumitoFramework.js';
-export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, };
+import * as discord from 'discord.js';
+export { ZumitoFramework, FrameworkSettings, Command, Module, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, PresenceDataRule, RuledPresenceData, StatusManagerOptions, discord, };

package/dist/index.js

@@ -1,14 +1,16 @@
 import { ApiResponse } from './definitions/ApiResponse.js';
-import { TranslationManager } from './TranslationManager.js';
+import { ButtonPressed } from './types/Commands/ButtonPressed.js';
 import { Command } from './types/Command.js';
 import { CommandArguments } from './types/CommandArguments.js';
-import { ButtonPressed } from './types/Commands/ButtonPressed.js';
 import { CommandType } from './types/CommandType.js';
-import { FrameworkEvent } from './types/FrameworkEvent.js';
-import { Module } from './types/Module.js';
-import { Translation } from './types/Translation.js';
 import { DatabaseConfigLoader } from './utils/DatabaseConfigLoader.js';
+import { DatabaseModel } from './types/DatabaseModel.js';
 import { EmojiFallback } from './utils/EmojiFallback.js';
+import { FrameworkEvent } from './types/FrameworkEvent.js';
+import { Module } from './types/Module.js';
 import { TextFormatter } from './utils/TextFormatter.js';
+import { Translation } from './types/Translation.js';
+import { TranslationManager } from './TranslationManager.js';
 import { ZumitoFramework } from './ZumitoFramework.js';
-export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, };
+import * as discord from 'discord.js';
+export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, discord, };

package/dist/managers/StatusManager.d.ts

@@ -0,0 +1,46 @@
+import { PresenceData } from "discord.js";
+import { StatusManagerOptions } from "../types/StatusManagerOptions";
+import { ZumitoFramework } from "../ZumitoFramework";
+export declare class StatusManager {
+    /**
+     * @param {ZumitoFramework} framework - The framework instance.
+     * @param {StatusManagerOptions} options - The options for the status manager.
+     */
+    framework: ZumitoFramework;
+    options: StatusManagerOptions;
+    statusQueue: PresenceData[];
+    currentStatusIndex: number;
+    constructor(framework: ZumitoFramework, options: StatusManagerOptions);
+    /**
+     * Delegates the events.
+     * @returns {void}
+     * @private
+     */
+    private delegateEvents;
+    /**
+     * Sets the status of the bot.
+     * If no presence data is provided, the status will be set to next in the queue.
+     * @param {PresenceData} presenceData - The presence data to set.
+     * @returns {void}
+     * @example
+     */
+    setStatus(presenceData?: PresenceData): void;
+    /**
+     * Gets list of all statuses matching rules if any.
+     * @returns {PresenceData[]}
+     * @public
+     */
+    getMatchingStatuses(): PresenceData[];
+    /**
+     * Gets the next status in the queue.
+     * @returns {PresenceData}
+     * @private
+     */
+    private getNextStatus;
+    /**
+     * Gets a random status.
+     * @returns {PresenceData}
+     * @public
+     */
+    getRandomStatus(): PresenceData;
+}

package/dist/managers/StatusManager.js

@@ -0,0 +1,95 @@
+export class StatusManager {
+    /**
+     * @param {ZumitoFramework} framework - The framework instance.
+     * @param {StatusManagerOptions} options - The options for the status manager.
+     */
+    framework;
+    options;
+    statusQueue = [];
+    currentStatusIndex = 0;
+    constructor(framework, options) {
+        this.framework = framework;
+        this.options = options;
+        this.delegateEvents();
+    }
+    /**
+     * Delegates the events.
+     * @returns {void}
+     * @private
+     */
+    delegateEvents() {
+        this.framework.client.on("ready", () => {
+            this.setStatus();
+            setInterval(() => {
+                this.setStatus();
+            }, this.options.updateInterval);
+        });
+    }
+    /**
+     * Sets the status of the bot.
+     * If no presence data is provided, the status will be set to next in the queue.
+     * @param {PresenceData} presenceData - The presence data to set.
+     * @returns {void}
+     * @example
+     */
+    setStatus(presenceData) {
+        if (presenceData) {
+            this.framework.client.user.setPresence(presenceData);
+            this.framework.eventEmitter.emit("statusChanged", presenceData);
+        }
+        else {
+            let status = this.getNextStatus();
+            if (status) {
+                this.framework.client.user.setPresence(status);
+                this.framework.eventEmitter.emit("statusChanged", status);
+            }
+        }
+    }
+    /**
+     * Gets list of all statuses matching rules if any.
+     * @returns {PresenceData[]}
+     * @public
+     */
+    getMatchingStatuses() {
+        const now = new Date();
+        const matchingStatuses = [];
+        this.options.statuses.forEach((status) => matchingStatuses.push(status));
+        this.options.RuledStatuses.forEach((status) => {
+            let match = status.rules.some((rule) => {
+                if (rule.startTime && rule.startTime > now)
+                    return false;
+                if (rule.endTime && rule.endTime < now)
+                    return false;
+                return true;
+            });
+            if (match)
+                matchingStatuses.push(status);
+        });
+        return matchingStatuses;
+    }
+    /**
+     * Gets the next status in the queue.
+     * @returns {PresenceData}
+     * @private
+     */
+    getNextStatus() {
+        let statuses = this.getMatchingStatuses();
+        if (statuses.length === 0)
+            return undefined;
+        if (this.options.order === "random") {
+            return this.getRandomStatus();
+        }
+        else {
+            this.currentStatusIndex = (this.currentStatusIndex + 1) % statuses.length;
+            return statuses[this.currentStatusIndex];
+        }
+    }
+    /**
+     * Gets a random status.
+     * @returns {PresenceData}
+     * @public
+     */
+    getRandomStatus() {
+        return this.getMatchingStatuses()[Math.floor(Math.random() * this.getMatchingStatuses().length)];
+    }
+}

package/dist/types/FrameworkSettings.d.ts

@@ -1,3 +1,4 @@
+import { StatusManagerOptions } from "./StatusManagerOptions";
 export interface FrameworkSettings {
     database: any;
     logLevel?: number;
@@ -8,4 +9,5 @@ export interface FrameworkSettings {
         clientId: string;
     };
     defaultPrefix?: string;
+    statusOptions?: StatusManagerOptions;
 }

package/dist/types/Module.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import boxen from 'boxen';
 import * as fs from 'fs';
 import path from 'path';
-import { ButtonInteraction, CommandInteraction, SelectMenuInteraction, } from 'discord.js';
+import { ButtonInteraction, CommandInteraction, StringSelectMenuInteraction, } from 'discord.js';
 export class Module {
     path;
     framework;
@@ -135,7 +135,7 @@ export class Module {
         args.forEach((arg) => {
             finalArgs[arg.constructor.name.toLowerCase()] = arg;
         });
-        const interaction = args.find((arg) => arg instanceof SelectMenuInteraction ||
+        const interaction = args.find((arg) => arg instanceof StringSelectMenuInteraction ||
             arg instanceof CommandInteraction ||
             arg instanceof ButtonInteraction);
         if (interaction) {

package/dist/types/StatusManagerOptions.d.ts

@@ -0,0 +1,14 @@
+import type { PresenceData } from "discord.js";
+export interface PresenceDataRule {
+    startTime?: Date;
+    endTime?: Date;
+}
+export interface RuledPresenceData extends PresenceData {
+    rules: PresenceDataRule[];
+}
+export interface StatusManagerOptions {
+    statuses: PresenceData[];
+    RuledStatuses: RuledPresenceData[];
+    updateInterval: number;
+    order: "random" | "sequential";
+}

package/dist/types/StatusManagerOptions.js

@@ -0,0 +1,2 @@
+;
+export {};

package/dist/utils/DatabaseConfigLoader.js

@@ -26,7 +26,13 @@ export class DatabaseConfigLoader {
             config.database = process.env.DATABASE_NAME;
         }
         else if (config.type == 'mongodb') {
-            config.uri = process.env.DATABASE_URI;
+            config.host = process.env.DATABASE_HOST || 'localhost';
+            config.port = process.env.DATABASE_PORT || 27017;
+            config.username = process.env.DATABASE_USERNAME || 'root';
+            config.password = process.env.DATABASE_PASSWORD;
+            if (process.env.DATABASE_NAME) {
+                config.database = process.env.DATABASE_NAME;
+            }
         }
         else if (config.type == 'tingodb') {
             config.database = './db/tingodb';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.1.64",
+  "version": "1.1.66",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,7 +29,7 @@
     "chokidar": "^3.5.3",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "discord.js": "^14.3.0",
+    "discord.js": "^14.9.0",
     "error-stack-parser": "^2.1.4",
     "express": "^4.18.1",
     "leven": "^4.0.0",