zumito-framework 1.2.11 → 1.2.13

package/dist/ZumitoFramework.d.ts

@@ -8,6 +8,7 @@ import { TranslationManager } from './services/TranslationManager.js';
 import { EventManager } from './services/EventManager.js';
 import { CommandManager } from './services/CommandManager.js';
 import { ModuleManager } from './services/ModuleManager.js';
+import { Route } from './definitions/Route.js';
 /**
  * @class ZumitoFramework
  * @description The main class of the framework.
@@ -64,7 +65,7 @@ export declare class ZumitoFramework {
      * @see {@link TranslationManager}
      */
     translations: TranslationManager;
-    routes: any;
+    routes: Route[];
     /**
      * The database models loaded in the framework.
      * @type {Array<DatabaseModel>}
@@ -137,6 +138,7 @@ export declare class ZumitoFramework {
      */
     private registerModules;
     private registerModule;
+    private registerBundle;
     /**
      * Initializes the Discord client using the Discord.js library.
      * Logs in to the Discord API using the provided token and logs a message when the client is ready.
@@ -154,7 +156,7 @@ export declare class ZumitoFramework {
      *
      * @deprecated
      */
-    memberHasPermission(member: GuildMember, channel: TextChannel, permission: bigint): Promise<any>;
+    memberHasPermission(member: GuildMember, channel: TextChannel, permission: bigint): Promise<boolean>;
     /**
      * Use GuildDataGetter service
      *
@@ -165,4 +167,5 @@ export declare class ZumitoFramework {
      * @deprecated
      */
     refreshSlashCommands(): Promise<void>;
+    registerRoute(route: Route): Promise<void>;
 }

package/dist/ZumitoFramework.js

@@ -79,7 +79,7 @@ export class ZumitoFramework {
      * @see {@link TranslationManager}
      */
     translations;
-    routes;
+    routes = [];
     /**
      * The database models loaded in the framework.
      * @type {Array<DatabaseModel>}
@@ -161,11 +161,11 @@ export class ZumitoFramework {
     async initialize() {
         await this.initializeDatabase();
         await this.initializeDiscordClient();
-        this.startApiServer();
         this.eventManager.addEventEmitter('discord', this.client);
         this.eventManager.addEventEmitter('framework', this.eventEmitter);
         await this.registerModules();
         await this.refreshSlashCommands();
+        this.startApiServer();
         if (this.settings.statusOptions) {
             this.statusManager = new StatusManager(this, this.settings.statusOptions);
         }
@@ -215,6 +215,11 @@ export class ZumitoFramework {
         //Route Prefixes
         //this.app.use("/", indexRouter);
         //this.app.use("/api/", apiRouter);
+        this.routes.forEach(route => {
+            this.app[route.method](route.path, function (req, res) {
+                return route.execute(req, res);
+            });
+        });
         // throw 404 if URL not found
         this.app.all('*', function (req, res) {
             return ApiResponse.notFoundResponse(res, 'Page not found');
@@ -241,7 +246,18 @@ export class ZumitoFramework {
             modulesFolder = `${process.cwd()}/src/modules`;
         }
         const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+        if (this.settings.bundles && this.settings.bundles.length > 0) {
+            for (let bundle of this.settings.bundles) {
+                await this.registerBundle(bundle.path, bundle.options);
+            }
+        }
         await this.registerModule(path.join(__dirname, 'modules', 'core'), 'baseModule');
+        if (fs.existsSync(`${process.cwd()}/node_modules/.zumitoBundles`)) {
+            const files = fs.readdirSync(`${process.cwd()}/node_modules/.zumitoBundles`);
+            for (const file of files) {
+                await this.registerModule(`${process.cwd()}/node_modules/.zumitoBundles`, file);
+            }
+        }
         if (modulesFolder) {
             const files = fs.readdirSync(modulesFolder);
             for (const file of files) {
@@ -277,6 +293,13 @@ export class ZumitoFramework {
         // Register module in the framework
         this.modules.registerModule(moduleInstance);
     }
+    async registerBundle(bundlePath, bundleOptions) {
+        console.log(bundlePath);
+        const bundle = await this.modules.loadModuleFile(bundlePath);
+        const bundleName = path.basename(bundlePath);
+        const moduleInstance = await this.modules.instanceModule(bundle, bundlePath, bundleName, bundleOptions);
+        this.modules.registerModule(moduleInstance);
+    }
     /**
      * Initializes the Discord client using the Discord.js library.
      * Logs in to the Discord API using the provided token and logs a message when the client is ready.
@@ -311,7 +334,7 @@ export class ZumitoFramework {
      */
     async memberHasPermission(member, channel, permission) {
         const memberPermissionChecker = ServiceContainer.getService(MemberPermissionChecker);
-        return await memberPermissionChecker(member, channel, permission);
+        return await memberPermissionChecker.hasPermissionOnChannel(member, channel, permission);
     }
     /**
      * Use GuildDataGetter service
@@ -329,4 +352,7 @@ export class ZumitoFramework {
         const slashCommandRefresher = ServiceContainer.getService(SlashCommandRefresher);
         slashCommandRefresher.refreshSlashCommands();
     }
+    async registerRoute(route) {
+        this.routes.push(route);
+    }
 }

package/dist/definitions/FrameworkEvent.d.ts

@@ -1,5 +1,6 @@
 export declare abstract class FrameworkEvent {
-    once: boolean;
     disabled: boolean;
+    once: boolean;
+    source: string;
     abstract execute(...args: any[]): any;
 }

package/dist/definitions/FrameworkEvent.js

@@ -1,4 +1,5 @@
 export class FrameworkEvent {
-    once = false;
     disabled = false;
+    once = false;
+    source;
 }

package/dist/definitions/FrameworkSettings.d.ts

@@ -1,3 +1,4 @@
+import { ModuleParameters } from "./parameters/ModuleParameters";
 import { StatusManagerOptions } from "./StatusManagerOptions";
 export interface FrameworkSettings {
     database: any;
@@ -11,4 +12,8 @@ export interface FrameworkSettings {
     defaultPrefix?: string;
     statusOptions?: StatusManagerOptions;
     srcMode?: 'multiBundle' | 'monoBundle' | undefined;
+    bundles?: {
+        path: string;
+        options?: ModuleParameters;
+    }[];
 }

package/dist/definitions/Module.d.ts

@@ -24,4 +24,6 @@ export declare abstract class Module {
     registerTranslations(subpath?: string): Promise<void>;
     registerModels(): Promise<void>;
     getModels(): Array<DatabaseModel>;
+    registerRoutes(): Promise<void>;
+    registerRoutesFolder(folder: string): Promise<void>;
 }

package/dist/definitions/Module.js

@@ -23,6 +23,7 @@ export class Module {
         await this.registerEvents();
         await this.registerTranslations();
         await this.registerModels();
+        await this.registerRoutes();
     }
     async registerCommands() {
         const commandsFolder = path.join(this.path, 'commands');
@@ -69,7 +70,7 @@ export class Module {
                 event = Object.values(event)[0];
                 event = new event();
                 this.events.set(event.constructor.name.toLowerCase(), event);
-                this.registerEvent(event, folder);
+                this.registerEvent(event, event.source);
             }
         }
     }
@@ -130,4 +131,28 @@ export class Module {
     getModels() {
         return this.models;
     }
+    async registerRoutes() {
+        const folderPath = path.join(this.path, 'routes');
+        if (fs.existsSync(folderPath)) {
+            await this.registerRoutesFolder('');
+        }
+    }
+    async registerRoutesFolder(folder) {
+        const folderPath = path.join(this.path, 'routes', folder);
+        if (!fs.existsSync(folderPath))
+            throw new Error(`Folder ${folder} doesn't exist`);
+        const files = fs.readdirSync(folderPath);
+        for (const file of files) {
+            if (file.endsWith('d.ts'))
+                continue;
+            if (file.endsWith('.js') || file.endsWith('.ts')) {
+                let route = await import('file://' + path.join(folderPath, file)).catch((e) => {
+                    console.error(`[🔄🔴 ] Error loading ${file.slice(0, -3)} route on module ${this.constructor.name}`);
+                });
+                route = Object.values(route)[0];
+                route = new route();
+                this.framework.registerRoute(route);
+            }
+        }
+    }
 }

package/dist/definitions/Route.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response } from "express";
+export declare enum RouteMethod {
+    get = "get",
+    post = "post",
+    put = "put",
+    delete = "delete",
+    all = "all"
+}
+export declare abstract class Route {
+    method: RouteMethod;
+    path: string;
+    abstract execute(req: Request, res: Response): any;
+}

package/dist/definitions/Route.js

@@ -0,0 +1,12 @@
+export var RouteMethod;
+(function (RouteMethod) {
+    RouteMethod["get"] = "get";
+    RouteMethod["post"] = "post";
+    RouteMethod["put"] = "put";
+    RouteMethod["delete"] = "delete";
+    RouteMethod["all"] = "all";
+})(RouteMethod || (RouteMethod = {}));
+export class Route {
+    method;
+    path;
+}

package/dist/index.d.ts

@@ -26,4 +26,5 @@ import { GuildDataGetter } from './services/GuildDataGetter.js';
 import { CommandParser } from './services/CommandParser.js';
 import { SlashCommandRefresher } from './services/SlashCommandRefresher.js';
 import { ErrorHandler } from './services/ErrorHandler.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, EventParameters, ServiceContainer, GuildDataGetter, SlashCommandRefresher, CommandParser, ErrorHandler, };
+import { Route, RouteMethod } from './definitions/Route.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, EventParameters, ServiceContainer, GuildDataGetter, SlashCommandRefresher, CommandParser, ErrorHandler, Route, RouteMethod };

package/dist/index.js

@@ -19,11 +19,12 @@ import { MemberPermissionChecker } from './services/MemberPermissionChecker.js';
 import { CommandParser } from './services/CommandParser.js';
 import { SlashCommandRefresher } from './services/SlashCommandRefresher.js';
 import { ErrorHandler } from './services/ErrorHandler.js';
+import { Route, RouteMethod } from './definitions/Route.js';
 ServiceContainer.addService(TextFormatter, []);
-ServiceContainer.addService(EmojiFallback, []);
+ServiceContainer.addService(EmojiFallback, [discord.Client.name, TranslationManager.name]);
 ServiceContainer.addService(GuildDataGetter, [ZumitoFramework.name]);
 ServiceContainer.addService(MemberPermissionChecker, []);
 ServiceContainer.addService(CommandParser, []);
 ServiceContainer.addService(SlashCommandRefresher, [ZumitoFramework.name]);
 ServiceContainer.addService(ErrorHandler, ['ZumitoFramework']);
-export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, discord, ServiceContainer, GuildDataGetter, SlashCommandRefresher, CommandParser, ErrorHandler, };
+export { ZumitoFramework, Command, Module, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, CommandType, ButtonPressed, TextFormatter, EmojiFallback, DatabaseConfigLoader, DatabaseModel, discord, ServiceContainer, GuildDataGetter, SlashCommandRefresher, CommandParser, ErrorHandler, Route, RouteMethod };

package/dist/modules/core/baseModule/events/discord/InteractionCreate.d.ts

@@ -3,6 +3,7 @@ import { EventParameters } from '../../../../../definitions/parameters/EventPara
 import { FrameworkEvent } from '../../../../../definitions/FrameworkEvent.js';
 export declare class InteractionCreate extends FrameworkEvent {
     once: boolean;
+    source: string;
     execute({ interaction, client, framework, }: EventParameters): Promise<void>;
     getTransMethod(commandInstance: Command, framework: any, guildSettings: any): (key: string, params?: any) => any;
 }

package/dist/modules/core/baseModule/events/discord/InteractionCreate.js

@@ -2,6 +2,7 @@ import { CommandType } from '../../../../../definitions/commands/CommandType.js'
 import { FrameworkEvent } from '../../../../../definitions/FrameworkEvent.js';
 export class InteractionCreate extends FrameworkEvent {
     once = false;
+    source = 'discord';
     async execute({ interaction, client, framework, }) {
         let guildSettings;
         if (interaction.guildId) {

package/dist/modules/core/baseModule/events/discord/MessageCreate.d.ts

@@ -3,6 +3,7 @@ import { EventParameters } from '../../../../../definitions/parameters/EventPara
 import { FrameworkEvent } from '../../../../../definitions/FrameworkEvent.js';
 export declare class MessageCreate extends FrameworkEvent {
     once: boolean;
+    source: string;
     execute({ message, framework }: EventParameters): Promise<import("discord.js").Message<boolean>>;
     autocorrect(str: string, words: string[]): any;
     getErrorEmbed(error: any, parse: any): {

package/dist/modules/core/baseModule/events/discord/MessageCreate.js

@@ -7,6 +7,7 @@ import path from 'path';
 import { InteractionIdGenerator } from '../../../../../services/InteractionIdGenerator.js';
 export class MessageCreate extends FrameworkEvent {
     once = false;
+    source = 'discord';
     async execute({ message, framework }) {
         const channel = message.channel;
         const prefix = framework.settings.defaultPrefix;

package/dist/services/EmojiFallback.d.ts

@@ -1,6 +1,10 @@
 import { Client } from 'discord.js';
+import { TranslationManager } from './TranslationManager';
 export declare class EmojiFallback {
-    static getEmoji(client: Client, emojiId: string, fallbackEmoji: any): any;
-    static getEmojiByName(client: Client, emojiName: string, fallbackEmoji: any): any;
-    static getEmojiByIdentifier(client: Client, emojiId: string, fallbackEmoji: any): any;
+    client: Client;
+    translator: TranslationManager;
+    constructor(client: Client, translator: TranslationManager);
+    getEmoji(emojiId: string, fallbackEmoji: any): any;
+    getEmojiByName(emojiName: string, fallbackEmoji: any): any;
+    getEmojiByIdentifier(emojiId: string, fallbackEmoji: any): any;
 }

package/dist/services/EmojiFallback.js

@@ -1,14 +1,26 @@
 export class EmojiFallback {
-    static getEmoji(client, emojiId, fallbackEmoji) {
-        const emoji = client.emojis.cache.get(emojiId);
+    client;
+    translator;
+    constructor(client, translator) {
+        this.client = client;
+        this.translator = translator;
+    }
+    getEmoji(emojiId, fallbackEmoji) {
+        if (this.translator.has(emojiId)) {
+            emojiId = this.translator.get(emojiId);
+        }
+        const emoji = this.client.emojis.cache.get(emojiId);
         return emoji?.toString() || fallbackEmoji;
     }
-    static getEmojiByName(client, emojiName, fallbackEmoji) {
-        const emoji = client.emojis.cache.find((emoji) => emoji.name === emojiName);
+    getEmojiByName(emojiName, fallbackEmoji) {
+        const emoji = this.client.emojis.cache.find((emoji) => emoji.name === emojiName);
         return emoji?.toString() || fallbackEmoji;
     }
-    static getEmojiByIdentifier(client, emojiId, fallbackEmoji) {
-        const emoji = client.emojis.cache.find((emoji) => emoji.id === emojiId);
+    getEmojiByIdentifier(emojiId, fallbackEmoji) {
+        if (this.translator.has(emojiId)) {
+            emojiId = this.translator.get(emojiId);
+        }
+        const emoji = this.client.emojis.cache.find((emoji) => emoji.id === emojiId);
         return emoji?.toString() || fallbackEmoji;
     }
 }

package/dist/services/ModuleManager.d.ts

@@ -1,5 +1,6 @@
 import { ZumitoFramework } from "../ZumitoFramework.js";
 import { Module } from "../definitions/Module.js";
+import { ModuleParameters } from "../definitions/parameters/ModuleParameters.js";
 export declare class ModuleManager {
     protected modules: Map<string, Module>;
     protected framework: ZumitoFramework;
@@ -13,5 +14,5 @@ export declare class ModuleManager {
     get size(): number;
     loadModuleFile(folderPath: string): Promise<unknown>;
     registerModule(module: InstanceType<typeof Module>): void;
-    instanceModule(module: any, rootPath: string, name?: string): Promise<Module>;
+    instanceModule(module: any, rootPath: string, name?: string, options?: ModuleParameters): Promise<Module>;
 }

package/dist/services/ModuleManager.js

@@ -57,11 +57,11 @@ export class ModuleManager {
 
         */
     }
-    async instanceModule(module, rootPath, name) {
+    async instanceModule(module, rootPath, name, options) {
         let moduleInstance;
         if (module.constructor) {
             try {
-                moduleInstance = new module(rootPath);
+                moduleInstance = new module(rootPath, options);
                 await moduleInstance.initialize();
                 this.modules.set(name || moduleInstance.constructor.name, moduleInstance);
             }

package/dist/services/ServiceContainer.d.ts

@@ -1,8 +1 @@
-declare class ServiceContainerManager {
-    private services;
-    addService(serviceClass: any, dependencies: string[], singleton?: boolean, instance?: any): void;
-    getService(serviceClass: any): any;
-    addInstance(serviceClass: any, instance: any): void;
-}
-export declare const ServiceContainer: ServiceContainerManager;
-export {};
+export declare const ServiceContainer: any;

package/dist/services/ServiceContainer.js

@@ -28,4 +28,6 @@ class ServiceContainerManager {
         this.services.get(serviceName).instance = instance;
     }
 }
-export const ServiceContainer = new ServiceContainerManager();
+if (!global.ServiceContainer)
+    global.ServiceContainer = new ServiceContainerManager();
+export const ServiceContainer = global.ServiceContainer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.2.11",
+  "version": "1.2.13",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -22,10 +22,10 @@
   <p align="center">
     Fast and scalable discord bot framework to jumpstart your projects!
     <br />
-    <a href="https://docs.zumito.ga/"><strong>Explore the docs »</strong></a>
+    <a href="https://docs.zumito.dev/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://zumito.ga">View Demo</a>
+    <a href="#">View Demo (Coming soon)</a>
     ·
     <a href="https://github.com/ZumitoTeam/zumito-framework/issues">Report Bug</a>
     ·
@@ -72,7 +72,7 @@ With this framework, you can easily create a feature-rich bot that solves a prob
 
 The framework is constantly evolving, with new features and updates being added on a regular basis. You can also suggest changes and contribute to the development of the framework by forking the repo and creating a pull request or opening an issue. Thanks to all the contributors who have helped expand this framework!
 
-To get started, simply visit the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.ga/docs/custom/quickstart) and start building your bot today!
+To get started, simply visit the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.dev/guides/start/) and start building your bot today!
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -85,9 +85,7 @@ This section lists the major frameworks and libraries that the framework is buil
 * [Node.js](https://nodejs.org/en/)
 * [TypeScript](https://www.typescriptlang.org/)
 * [Discord.js](https://discord.js.org/#/)
-* [MongoDB](https://www.mongodb.com/)
 * [Express](https://expressjs.com/)
-* [Mongoose](https://mongoosejs.com/)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -98,7 +96,7 @@ This section lists the major frameworks and libraries that the framework is buil
 
 This is a guide of how you can set up the project locally to start contributing to the framework. 
 
-:warning: If you're here to create your own bot, refer to the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.ga/docs/custom/quickstart).
+:warning: If you're here to create your own bot, refer to the quickstart guide at [docs.zumito.dev/guides/start](https://docs.zumito.dev/guides/start/).
 
 ### Prerequisites
 
@@ -135,7 +133,7 @@ For build the source code, run the following command:
 npm run build
 ```
 
-Then for test it, you will need to create a bot, you can find a guide [here](https://docs.zumito.ga/docs/custom/quickstart).
+Then for test it, you will need to create a bot, you can find a guide [here](https://docs.zumito.dev/guides/start).
 
 for link the framework to your bot, you will need to run these commands
 1. In the root of framework:
@@ -148,8 +146,6 @@ for link the framework to your bot, you will need to run these commands
     npm link zumito-framework
     ```
 
-_For more info of the framework, please refer to the [Documentation](https://docs.zumito.ga/docs/category/zumito-framework)_
-
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
@@ -157,9 +153,9 @@ _For more info of the framework, please refer to the [Documentation](https://doc
 <!-- ROADMAP -->
 ## Roadmap
 
-- [X] Add Quick start template
-- [ ] Add more documentation, examples, and guides
-- [ ] Add cli for easy command, events, etc boilerplate generation.
+<!-- issueTable -->
+
+<!-- issueTable -->
 
 See the [open issues](https://github.com/ZumitoTeam/zumito-framework/issues) for a full list of proposed features (and known issues).
 
@@ -209,6 +205,7 @@ Any questions or suggestions? Come to our [Discord server](https://discord.gg/rF
 We would like to thank the following projects for their inspiration and/or help:
 
 * [Discord.js](https://discord.js.org)
+* [Caminte](https://github.com/biggora/caminte)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>