@stelliajs/framework 1.0.4 → 1.0.6

package/README.md

@@ -5,6 +5,39 @@
 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.
 
+## Architecture
+Recommended architecture for StelliaJS project.
+```
+.
+├── dist // Build folder
+├── src/
+│   ├── commands/
+│   │   ├── contextMenus/
+│   │   │   └── mute.ts
+│   │   └── slash/
+│   │       ├── moderation // You can create folders, everything is loaded recursively
+│   │       │   ├── ban.ts
+│   │       │   └── mute.ts
+│   │       └── ping.ts
+│   ├── events/
+│   │   ├── ready.ts
+│   │   └── interactionCreate.ts
+│   ├── interactions/
+│   │   ├── autoCompletes/
+│   │   │   └── song.ts
+│   │   ├── buttons/
+│   │   │   └── colorChoice.ts
+│   │   ├── modals/
+│   │   │   └── form.ts
+│   │   └── selectMenus/
+│   │       └── settings.ts
+│   ├── environment.d.ts
+│   └── index.ts
+├── .env
+├── package.json
+├── package-lock.json
+└── tsconfig.json
+```
 ## Examples
 
 ### Simple client
@@ -24,25 +57,25 @@ const client = new StelliaClient({
     partials: [Partials.Message, Partials.GuildMember]
 }, {
     autoCompletes: {
-        directoryPath: "./src/interactions/autoCompletes"
+        directoryPath: "./interactions/autoCompletes"
     },
     buttons: {
-        directoryPath: "./src/interactions/buttons"
+        directoryPath: "./interactions/buttons"
     },
     commands: {
-        directoryPath: "./src/commands/slash"
+        directoryPath: "./commands/slash"
     },
     contextMenus: {
-        directoryPath: "./src/commands/contextMenus"
+        directoryPath: "./commands/contextMenus"
     },
     events: {
-        directoryPath: "./src/events"
+        directoryPath: "./events"
     },
     modals: {
-        directoryPath: "./src/interactions/modals"
+        directoryPath: "./interactions/modals"
     },
     selectMenus: {
-        directoryPath: "./src/interactions/selectMenus"
+        directoryPath: "./interactions/selectMenus"
     }
 });
 
@@ -51,6 +84,7 @@ await client.connect(process.env.TOKEN);
 
 ### Simple event
 
+#### Ready event
 ```js
 import { type StelliaClient, type EventStructure } from "@stelliajs/framework";
 import { Events } from "discord.js";
@@ -67,17 +101,35 @@ export default {
 } as EventStructure;
 ```
 
+#### InteractionCreate event
+```js
+import { type StelliaClient, type EventStructure } from "@stelliajs/framework";
+import { Events, type Interaction } from "discord.js";
+
+export default {
+    data: {
+        name: Events.InteractionCreate,
+        once: false
+    },
+    async execute(client: StelliaClient<true>, interaction: Interaction) {
+        if (interaction.inCachedGuild()) {
+            await client.handleInteraction(interaction); // Automatic interaction handling
+        }
+    }
+} as EventStructure;
+```
+
 ### Simple command
 
 ```js
-import { type CommandStructure, type StelliaClient } from "@stelliajs/framework";
+import { type CommandStructure, ephemeralFollowUpResponse, type StelliaClient } from "@stelliajs/framework";
 import { type ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
 
 export default {
     data: new SlashCommandBuilder()
         .setName("ping"),
     async execute(client: StelliaClient, interaction: ChatInputCommandInteraction<"cached">) { // All interactions are cached
-        await interaction.reply("Pong!");
+        await ephemeralFollowUpResponse(interaction, "Pong!", true); // Response is ephemeral and deleted after 60 seconds
     }
 } as CommandStructure;
 ```

package/dist/client/StelliaUtils.js

@@ -108,7 +108,7 @@ export class StelliaUtils {
     handleSelectMenuInteraction = async (interaction) => {
         try {
             const interactionSelectMenu = interaction;
-            const selectMenu = this.client.managers.modals?.get(interactionSelectMenu.customId);
+            const selectMenu = this.client.managers.selectMenus?.get(interactionSelectMenu.customId);
             if (!selectMenu)
                 return;
             await selectMenu.execute(this.client, interactionSelectMenu);

package/dist/utils/files.js

@@ -3,7 +3,7 @@ import { readdirSync, statSync } from "fs";
 import path from "path";
 export const requiredFiles = async (directoryPath) => {
     const collection = new Collection();
-    const filesPath = getAllFilesPath(directoryPath).filter((file) => /\.(js|[^d]\.ts)$/.test(file));
+    const filesPath = getAllFilesPath(directoryPath).filter((file) => !file.endsWith(".d.ts") && (file.endsWith(".js") || file.endsWith(".ts")));
     for (const filePath of filesPath) {
         const data = await loadInteraction(filePath);
         collection.set(data.data.name, data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stelliajs/framework",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
@@ -12,6 +12,8 @@
   },
   "author": "Tweenty_",
   "license": "ISC",
+  "description": "A framework for simplify the creation of discord bots",
+  "keywords": ["discord", "bot", "discordjs", "typescript", "framework"],
   "dependencies": {
     "discord-api-types": "^0.37.92",
     "discord.js": "^14.15.3"