@stelliajs/framework 1.2.0 → 1.2.3

package/README.md

@@ -3,7 +3,7 @@
 ## About
 
 StelliaJS is built using Discord JS V14 and TypeScript. It allows you to quickly set up a new bot with a simple and complete architecture.
-A CLI is currently being developed and will soon be available for even greater convenience.
+A CLI is available to help you set up a project with StelliaJS : [link to the CLI](https://github.com/StelliaJS/cli)
 
 ## Architecture
 Recommended architecture for StelliaJS project.
@@ -19,6 +19,10 @@ Recommended architecture for StelliaJS project.
 │   │       │   ├── ban.ts
 │   │       │   └── mute.ts
 │   │       └── ping.ts
+│   ├── environments/
+│   │   ├── environment.development.ts
+│   │   ├── environment.model.ts
+│   │   └── environment.ts
 │   ├── events/
 │   │   ├── ready.ts
 │   │   └── interactionCreate.ts
@@ -36,16 +40,17 @@ Recommended architecture for StelliaJS project.
 ├── .env
 ├── package.json
 ├── package-lock.json
+├── stellia.json
 └── tsconfig.json
 ```
+
 ## Examples
 
-### Simple client
+### Simple client with environment
 
 ```js
 import { StelliaClient } from "@stelliajs/framework";
-import { GatewayIntentBits } from "discord-api-types/v10";
-import { Partials } from "discord.js";
+import { GatewayIntentBits, Partials } from "discord.js";
 
 const client = new StelliaClient({
     intents: [
@@ -56,26 +61,31 @@ const client = new StelliaClient({
     ],
     partials: [Partials.Message, Partials.GuildMember]
 }, {
-    autoCompletes: {
-        directoryPath: "./interactions/autoCompletes"
-    },
-    buttons: {
-        directoryPath: "./interactions/buttons"
-    },
-    commands: {
-        directoryPath: "./commands/slash"
-    },
-    contextMenus: {
-        directoryPath: "./commands/contextMenus"
-    },
-    events: {
-        directoryPath: "./events"
-    },
-    modals: {
-        directoryPath: "./interactions/modals"
+    managers: {
+        autoCompletes: {
+            directoryPath: "./interactions/autoCompletes"
+        },
+        buttons: {
+            directoryPath: "./interactions/buttons"
+        },
+        commands: {
+            directoryPath: "./commands/slash"
+        },
+        contextMenus: {
+            directoryPath: "./commands/contextMenus"
+        },
+        events: {
+            directoryPath: "./events"
+        },
+        modals: {
+            directoryPath: "./interactions/modals"
+        },
+        selectMenus: {
+            directoryPath: "./interactions/selectMenus"
+        }
     },
-    selectMenus: {
-        directoryPath: "./interactions/selectMenus"
+    environment: {
+        areEnvironmentsEnabled: true
     }
 });
 
@@ -84,34 +94,36 @@ await client.connect(process.env.TOKEN);
 
 ### Simple event
 
-#### Ready event
+#### Ready event with environment
 ```js
 import { type StelliaClient, type EventStructure } from "@stelliajs/framework";
 import { Events } from "discord.js";
+import { type CustomEnvironment } from "@environments/environment.model.ts";
 
 export default {
     data: {
         name: Events.ClientReady,
         once: true
     },
-    async execute(client: StelliaClient<true>) { // <true> ensures that the client is Ready
+    async execute(client: StelliaClient<true>, environment: CustomEnvironment) { // <true> ensures that the client is Ready
         console.log(`Logged in as ${client.user.tag}`);
         await client.initializeCommands(); // Used to initialise registered commands
     }
 } as EventStructure;
 ```
 
-#### InteractionCreate event
+#### InteractionCreate event with environment
 ```js
 import { type StelliaClient, type EventStructure } from "@stelliajs/framework";
 import { Events, type Interaction } from "discord.js";
+import { type CustomEnvironment } from "@environments/environment.model.ts";
 
 export default {
     data: {
         name: Events.InteractionCreate,
         once: false
     },
-    async execute(client: StelliaClient<true>, interaction: Interaction) {
+    async execute(client: StelliaClient<true>, environment: CustomEnvironment, interaction: Interaction) {
         if (interaction.inCachedGuild()) {
             await client.handleInteraction(interaction); // Automatic interaction handling
         }
@@ -124,11 +136,12 @@ export default {
 ```js
 import { type CommandStructure, ephemeralFollowUpResponse, type StelliaClient } from "@stelliajs/framework";
 import { type ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
+import { type CustomEnvironment } from "@environments/environment.model.ts";
 
 export default {
     data: new SlashCommandBuilder()
         .setName("ping"),
-    async execute(client: StelliaClient, interaction: ChatInputCommandInteraction<"cached">) { // All interactions are cached
+    async execute(client: StelliaClient, environment: CustomEnvironment, interaction: ChatInputCommandInteraction<"cached">) { // All interactions are cached
         await ephemeralFollowUpResponse(interaction, "Pong!", true); // Response is ephemeral and deleted after 60 seconds
     }
 } as CommandStructure;

package/dist/client/StelliaClient.d.ts

@@ -1,6 +1,6 @@
-import { Client, type ClientOptions } from "discord.js";
+import { Client, type ClientOptions, type Interaction } from "discord.js";
 import { type ManagerOptions } from "../managers/index.js";
-import { type AnyInteraction, type Environment, type EnvironmentConfiguration, type Managers } from "../typescript/index.js";
+import { type Environment, type EnvironmentConfiguration, type Managers } from "../typescript/index.js";
 export declare class StelliaClient<Ready extends boolean = boolean> extends Client<Ready> {
     private readonly utils;
     readonly managers: Managers;
@@ -9,7 +9,7 @@ export declare class StelliaClient<Ready extends boolean = boolean> extends Clie
     connect: (token: string) => Promise<void>;
     initializeCommands: () => Promise<void>;
     getEnvironment: <CustomEnvironment extends EnvironmentConfiguration>() => Promise<CustomEnvironment>;
-    handleInteraction: (interaction: AnyInteraction) => Promise<void>;
+    handleInteraction: (interaction: Interaction<"cached">) => Promise<void>;
     private areManagersLoaded;
     private static convertFilePathToProduction;
 }

package/dist/client/StelliaUtils.d.ts

@@ -1,12 +1,12 @@
 import { type StelliaClient } from "./index.js";
-import { type AnyInteraction } from "../typescript/index.js";
+import { type Interaction } from "discord.js";
 export declare class StelliaUtils {
     readonly client: StelliaClient;
     private readonly interactionHandlers;
     private environment;
     constructor(client: StelliaClient);
     initializeCommands: () => Promise<void>;
-    handleInteraction: (interaction: AnyInteraction) => Promise<void>;
+    handleInteraction: (interaction: Interaction<"cached">) => Promise<void>;
     private handleAutoCompleteInteraction;
     private handleButtonInteraction;
     private handleCommandInteraction;

package/dist/client/StelliaUtils.js

@@ -15,7 +15,7 @@ export class StelliaUtils {
             [InteractionType.ModalSubmit, this.handleModalInteraction],
             [InteractionType.SelectMenu, this.handleSelectMenuInteraction]
         ]);
-        if (this.client.environment.isEnvironmentsEnabled) {
+        if (this.client.environment.areEnvironmentsEnabled) {
             this.client.getEnvironment()
                 .then((environment) => {
                 this.environment = environment;
@@ -59,7 +59,7 @@ export class StelliaUtils {
             const autoComplete = autoCompleteManager.getByCustomId(interactionAutoComplete.commandName);
             if (!autoComplete)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await autoComplete.execute(this.client, this.environment, interactionAutoComplete);
                 return;
             }
@@ -78,7 +78,7 @@ export class StelliaUtils {
             const button = buttonManager.getByCustomId(buttonInteraction.customId) || buttonManager.getByRegex(buttonInteraction.customId);
             if (!button)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await button.execute(this.client, this.environment, buttonInteraction);
                 return;
             }
@@ -97,7 +97,7 @@ export class StelliaUtils {
             const command = commandManager.getByCustomId(interactionCommand.commandName);
             if (!command)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await command.execute(this.client, this.environment, interactionCommand);
                 return;
             }
@@ -132,7 +132,7 @@ export class StelliaUtils {
             const modal = modalManager.getByCustomId(interactionModal.customId) || modalManager.getByRegex(interactionModal.customId);
             if (!modal)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await modal.execute(this.client, this.environment, interactionModal);
                 return;
             }
@@ -151,7 +151,7 @@ export class StelliaUtils {
             const selectMenu = selectMenuManager.getByCustomId(interactionSelectMenu.customId) || selectMenuManager.getByRegex(interactionSelectMenu.customId);
             if (!selectMenu)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await selectMenu.execute(this.client, this.environment, interactionSelectMenu);
                 return;
             }
@@ -169,7 +169,7 @@ export class StelliaUtils {
             const messageContextMenu = contextMenuManager.getByCustomId(interaction.commandName);
             if (!messageContextMenu)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await messageContextMenu.execute(this.client, this.environment, interaction);
                 return;
             }
@@ -187,7 +187,7 @@ export class StelliaUtils {
             const userContextMenu = contextMenuManager.getByCustomId(interaction.commandName);
             if (!userContextMenu)
                 return;
-            if (this.client.environment.isEnvironmentsEnabled) {
+            if (this.client.environment.areEnvironmentsEnabled) {
                 await userContextMenu.execute(this.client, this.environment, interaction);
                 return;
             }

package/dist/managers/EventManager.js

@@ -11,11 +11,30 @@ export class EventManager extends BaseManager {
         this.interactions = events;
         for (const event of this.interactions.values()) {
             const { name, once } = event.data;
-            if (once) {
-                this.client.once(name, (...args) => event.execute(this.client, ...args));
+            if (this.client.environment.areEnvironmentsEnabled) {
+                const environment = await this.client.getEnvironment();
+                if (name == Events.ClientReady) {
+                    this.client.once(name, () => event.execute(this.client, environment));
+                    continue;
+                }
+                if (once) {
+                    this.client.once(name, (...args) => event.execute(this.client, environment, ...args));
+                }
+                else {
+                    this.client.on(name, (...args) => event.execute(this.client, environment, ...args));
+                }
             }
             else {
-                this.client.on(name, (...args) => event.execute(this.client, ...args));
+                if (name == Events.ClientReady) {
+                    this.client.once(name, () => event.execute(this.client));
+                    continue;
+                }
+                if (once) {
+                    this.client.once(name, (...args) => event.execute(this.client, ...args));
+                }
+                else {
+                    this.client.on(name, (...args) => event.execute(this.client, ...args));
+                }
             }
         }
         this.client.on(Events.Error, (error) => console.error(error));

package/dist/structures/Event.d.ts

@@ -1,9 +1,14 @@
 import { type Awaitable, type ClientEvents } from "discord.js";
 import { type StelliaClient } from "../client/index.js";
+import type { EnvironmentConfiguration } from "../typescript/types.js";
 export interface EventStructure<Event extends keyof ClientEvents = keyof ClientEvents> {
     data: {
         name: Event;
         once: boolean;
     };
+    execute(client: StelliaClient): Awaitable<unknown>;
+    execute(...args: ClientEvents[Event]): Awaitable<unknown>;
     execute(client: StelliaClient, ...args: ClientEvents[Event]): Awaitable<unknown>;
+    execute<CustomEnvironment extends EnvironmentConfiguration>(client: StelliaClient, environment: CustomEnvironment): Awaitable<unknown>;
+    execute<CustomEnvironment extends EnvironmentConfiguration>(client: StelliaClient, environment: CustomEnvironment, ...args: ClientEvents[Event]): Awaitable<unknown>;
 }

package/dist/typescript/types.d.ts

@@ -1,8 +1,6 @@
-import { type AnySelectMenuInteraction, type AutocompleteInteraction, type ButtonInteraction, type ChatInputCommandInteraction, type ContextMenuCommandInteraction, type ModalSubmitInteraction, type UserContextMenuCommandInteraction } from "discord.js";
 import { type AutoCompleteManager, type ButtonManager, type CommandManager, type ContextMenuManager, type EventManager, type ModalManager, type SelectMenuManager } from "../managers/index.js";
 export type StructureCustomId = string | RegExp;
 export type InteractionCustomId = string;
-export type AnyInteraction = AutocompleteInteraction<"cached"> | ButtonInteraction<"cached"> | ChatInputCommandInteraction<"cached"> | ContextMenuCommandInteraction<"cached"> | ModalSubmitInteraction<"cached"> | AnySelectMenuInteraction<"cached"> | UserContextMenuCommandInteraction<"cached">;
 export declare enum InteractionType {
     Autocomplete = "Autocomplete",
     Button = "Button",
@@ -23,7 +21,7 @@ export interface Managers {
     modals?: ModalManager;
 }
 export interface Environment {
-    isEnvironmentsEnabled: boolean;
+    areEnvironmentsEnabled: boolean;
 }
 export interface EnvironmentConfiguration {
     [key: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stelliajs/framework",
-  "version": "1.2.0",
+  "version": "1.2.3",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
@@ -16,7 +16,7 @@
   "keywords": ["discord", "bot", "discordjs", "typescript", "framework"],
   "dependencies": {
     "discord-api-types": "^0.37.119",
-    "discord.js": "^14.17.3"
+    "discord.js": "^14.18.0"
   },
   "devDependencies": {
     "ts-node": "^10.9.2",