djs-builder 0.5.42 → 0.6.1

package/README.md

@@ -1,19 +1,16 @@
 ![Example Image](https://i.ibb.co/bbpMpQz/Picsart-24-06-06-21-22-44-570.jpg)
 
 ## [![Typing SVG](https://readme-typing-svg.herokuapp.com?font=Fira+Code&pause=1000&color=00EDFF&repeat=false&width=435&lines=👋+WELCOME+TO+DJS-BUILDER)](#)
+
 **Welcome to the Discord Bot Utilities package! 🥏**
-**This package provides a set of utility classes/interfaces to simplify 🎍**
-**common tasks when developing Discord bots using the Discord.js library ✨.**
 
 ## Table of Contents
 
-1. [Starter](#Features)
-2. [ButtonManager](#Easyest)
-3. [MenuManager](#Easyest)
-4. [PermissionChecker](#Easyest)
-5. [Options](#options)
+1. [Starter](#Easiest)
+2. [Function](#Easiest)
+3. [Command](#Easiest)
 
-## [![Typing SVG](https://readme-typing-svg.herokuapp.com?font=Fira+Code&pause=1000&color=00F701&repeat=false&width=435&lines=🎯+STARTER)](#)
+## 🎯 STARTER
 
 Starter provides functionality for initializing and starting a Discord bot 🤖.
 
@@ -26,402 +23,228 @@ Starter provides functionality for initializing and starting a Discord bot 🤖.
 - **🔋 Direct connection with MongoDB 📥**
 - **📑 Logging for slash and prefix command usage with comprehensive information 🧭**
 
-> [`⚠️ NOTE:` Any option you don't want, just `DELETE 🗑️` the option `LINE ➖`!](https://fivesobes.gitbook.io/canvafy/welcome/resolve-errors)
+> 💡 **Tip:** Any option you don't want, just `DELETE 🗑️` the option .
 
 <details>
-    <summary>Quick setup ⚡</summary>
-  
-```js
-    const { Starter } = require('djs-builder'); // cjs module .js
-
-    const { Client, GatewayIntentBits, Partials } = require('discord.js');
-    const client = new Client({
-      intents: Object.keys(GatewayIntentBits).map((a) => {
-        return GatewayIntentBits[a];
-      }),
-    });
-
-    // Define starter options
-    const starterOptions = {
-        bot: {
-            token: 'YOUR_BOT_TOKEN', // [OPTIONAL] Discord bot token
-            logs: {
-                terminal: true // [OPTIONAL] Log messages to terminal
-            },
-            Status: {
-                state: 'online', // Required: Bot presence state ['online', 'offline', 'dnd', 'idle', 'Streaming']
-                activities: ['Game 1', 'Game 2'], // [OPTIONAL] Bot activities
-                type: 0, // [OPTIONAL] Bot activity type
-                delay: 60000 // [OPTIONAL] Activity rotation delay in milliseconds
-            },
-            Database: {
-              mongo: {
-                mongoURI: 'mongodb://localhost:27017', // Required: MongoDB connection URI
-                dbName: 'your_database_name' // [OPTIONAL] MongoDB database name
-              },
-              verse: {
-                adapterType: 'json', // Required: Database adapter type ['json', 'yaml', 'sql']
-                path: '/database/folder', // Required: Path to database folder [Note: "Not path to file!"]
-                dev: {
-                    enable: true, // Required: Enable development mode
-                    logsPath: '/path/to/logs' // [OPTIONAL] Path to development logs [Note: "It will create logs file for database executions logs!"]
-                },
-                secure: { enable: false, secret:'your_encryption_key'} // [OPTIONAL] To secure Data File by encrypting it with secret key
-              }
-            }
-        },
-        slash: {
-            path: './path/to/slash_commands', // Required: Path to slash commands
-            global: true, // [OPTIONAL] Register slash commands globally
-            serverId: '123456789012345678', // [OPTIONAL] Discord server ID
-            logsId: '123456789012345678' // [OPTIONAL] Logs channel ID
-        },
-        prefix: {
-            path: './path/to/prefixes', // Required: Path to prefix settings
-            prefix: '!', // Required: Default bot prefix
-            global: true, // [OPTIONAL] Use global prefix
-            serverIds: ['123456789012345678'], // [OPTIONAL] Discord server IDs
-            logsId: '123456789012345678' // [OPTIONAL] Logs channel ID
-        },
-        events: {
-            path: './path/to/events', // Required: Path to event handlers
-            recursive: true, // [OPTIONAL] Enable recursive event loading
-            eventBlacklist: ['path/to the event/file.js', 'path/to the event/file.js'] // [OPTIONAL] Blacklisted events
-        },
-        anticrash: {
-            enable: true, // Required: Enable anti-crash feature
-            webhookURL: 'https://your.crash.webhook.url', // Required: Webhook URL for crash alerts
-            mention: '<@123456789012345678>' // [OPTIONAL] User ID to mention in crash alerts
-        }
-    };
-
-    const bot = new Starter();
-    bot.start(client, starterOptions);
-
-```
-</details>
-
-<details>
-    <summary>ALL Options ⚙️</summary>
-
-```js
-    const { Starter } = require('djs-builder'); // cjs module .js
-
-    const { Client, GatewayIntentBits, Partials } = require('discord.js');
-    const client = new Client({
-      intents: Object.keys(GatewayIntentBits).map((a) => {
-        return GatewayIntentBits[a];
-      }),
-    });
-
-    // OR
-    import { Starter } from 'djs-builder'; // Ejs module .mjs or Ts
-
-    import { Client, GatewayIntentBits, Partials, PermissionFlagsBits } from 'discord.js';
-
-    const intentsArray = Object.keys(GatewayIntentBits)
-        .map((a) => GatewayIntentBits[a as keyof typeof GatewayIntentBits]);
-    const intents = intentsArray.reduce((acc, curr) => acc | curr, 0);
-
-    const client = new Client({
-        intents,
-        partials: Object.values(Partials) as Partials[],
-    });
-
-    // Define starter options
-    const starterOptions = {
-        bot: {
-
-        token: 'YOUR_BOT_TOKEN', // [OPTIONAL] Discord bot token
-        logs: {
-            devLogs: {
-                enable: true, // Required: Enable developer logs
-                pathToWatch: '/path/to/watch', // Required: Path to watch for file changes
-                webhookURL: 'https://your.webhook.url', // Required: Webhook URL for logging
-                mention: '<@123456789012345678>' // [OPTIONAL] User ID to mention in logs
-            },
-            terminal: true // [OPTIONAL] Log messages to terminal
-        },
-        name: 'Your Bot Name', // [OPTIONAL] Bot name
-        avatar: 'https://your.bot/avatar.png', // [OPTIONAL] Bot avatar URL or local path image
-        banner: 'https://your.bot/banner.png', // [OPTIONAL] Bot banner URL or local path image
-        BotInfo: {
-            perms: ['SendMessages', 'BotMessages'], // [OPTIONAL] Bot permissions to work in any server
-            serverId: '123456789012345678', // [OPTIONAL] Discord server ID
-            botInvite: 'https://discord.com/invite/your-bot-invite', // [OPTIONAL] Bot invite URL
-            serverInvite: 'https://discord.com/invite/your-server-invite', // [OPTIONAL] Server invite URL
-            ownerId: '123456789012345678', // [OPTIONAL] Bot owner's user ID
-            partners: ['partner1', 'partner2'] // [OPTIONAL] Bot partners
-        },
-        Status: {
-            state: 'online', // Required: Bot presence state ['online', 'offline', 'dnd', 'idle', 'Streaming']
-            activities: ['Game 1', 'Game 2'], // [OPTIONAL] Bot activities
-            type: 0, // [OPTIONAL] Bot activity type
-            delay: 60000 // [OPTIONAL] Activity rotation delay in milliseconds
-        },
-        Database: {
-            mongo: {
-                mongoURI: 'mongodb://localhost:27017', // Required: MongoDB connection URI
-                dbName: 'your_database_name' // [OPTIONAL] MongoDB database name
-            },
-            verse: {
-                adapterType: 'json', // Required: Database adapter type ['json', 'yaml', 'sql']
-                path: '/database/folder', // Required: Path to database folder [Note: "Not path to file!"]
-                dev: {
-                    enable: true, // Required: Enable development mode
-                    logsPath: '/path/to/logs' // [OPTIONAL] Path to development logs [Note: "It will create logs file for database executions logs!"]
-                },
-                secure: { enable: false, secret:'your_encryption_key'} // [OPTIONAL] To secure Data File by encrypting it with secret key
-            }
-        }
-    },
-    slash: {
-        path: './path/to/slash_commands', // Required: Path to slash commands
-        global: true, // [OPTIONAL] Register slash commands globally
-        serverId: '123456789012345678', // [OPTIONAL] Discord server ID
-        logsId: '123456789012345678' // [OPTIONAL] Logs channel ID
-    },
-    prefix: {
-        path: './path/to/prefixes', // Required: Path to prefix settings
-        prefix: '!', // Required: Default bot prefix
-        global: true, // [OPTIONAL] Use global prefix
-        serverIds: ['123456789012345678'], // [OPTIONAL] Discord server IDs
-        logsId: '123456789012345678' // [OPTIONAL] Logs channel ID
-    },
-    events: {
-        path: './path/to/events', // Required: Path to event handlers
-        recursive: true, // [OPTIONAL] Enable recursive event loading
-        eventBlacklist: ['path/to the event/file.js', 'path/to the event/file.js'] // [OPTIONAL] Blacklisted events
-    },
-    anticrash: {
-        enable: true, // Required: Enable anti-crash feature
-        webhookURL: 'https://your.crash.webhook.url', // Required: Webhook URL for crash alerts
-        mention: '<@123456789012345678>' // [OPTIONAL] User ID to mention in crash alerts
-    }
-};
-
-// Define the starter instance
-const bot = new Starter();
-
-async function botStart() {
-const botstarted = await bot.start(client, starterOptions);
-    const mongodb = await botstarted.mongodb;
-    const versedb = await botstarted.versedb;
-    const slashSize = await botstarted.slashSize;
-    const prefixSize = await botstarted.prefixSize;
-    const eventSize = await botstarted.eventSize;
-    return {
-        getDb: mongodb,
-        db: versedb,
-        slashSize: slashSize,
-        prefixSize: prefixSize,
-        eventSize: eventSize
-    }
-}
-module.exports = { botStart };
-// Or
-export { botStart };
-```
-
-- **Usage for the returned values from botStart() funtion**:
+    <summary>Starter ⚙️</summary>
 
 ```js
-const { botStart } = require('path/to/file/where botStart is exported from');
-// Or
-import { botStart } from 'path/to/file/where botStart is exported from';
+   const { starter } = require("djs-builder");
 
-async function test() {
-    const client = await botStart();
+const { Client, GatewayIntentBits } = require("discord.js");
+const client = new Client({
+  intents: Object.keys(GatewayIntentBits).map((a) => {
+    return GatewayIntentBits[a];
+  }),
+});
 
-    // Usage for mongoDb
-    const db = await client.getDb;
-    await db.collection('collectionName'); // See more usage at https://www.mongodb.com
+// Define starter options
+const starterOptions = {
+  bot: {
+    token: "YOUR_BOT_TOKEN", // [OPTIONAL] Discord bot token
+    ownerId: "YOUR_USER_ID",
+  },
+  terminal: true,
+  Status: {
+    status: "online", // Required: Bot presence state ['online', 'offline', 'dnd', 'idle', 'Streaming']
+    activities: ["Game 1", "Game 2"], // [OPTIONAL] Bot activities
+    type: 0, // [OPTIONAL] Bot activity type
+    time: 60000, // [OPTIONAL] Activity rotation delay in milliseconds
+  },
+  database: {
+    url: "mongodb://localhost:27017", // Required: MongoDB connection URI
+  },
 
-    // Usage for verseDb
-    const db = await client.db;
-    await db.load('collectionName'); // See more usage at https://versedb.jedi-studio.com
+  slash: {
+    path: "./path/to/slash_commands", // Required: Path to slash commands
+    log: "", // id of log channel
+  },
+  prefix: {
+    path: "./path/to/prefixes", // Required: Path to prefix settings
+    prefix: "!", // Required: Default bot prefix
+    log: "", // id of log channel
+  },
+  events: {
+    path: "./path/to/events", // Required: Path to event handlers
+  },
+  anticrash: {
+    url: "https://your.crash.webhook.url", // Required: Webhook URL for crash alerts
+    mention_id: "YOUR_USER_ID", // [OPTIONAL] User ID to mention in crash alerts
+  },
+};
 
-    // Usage for slashSize/prefixSize/eventSize
-    console.log(`loaded slash Commands: ${client.slashSize}`);
-    console.log(`loaded prefix Commands: ${client.prefixSize}`);
-    console.log(`loaded events: ${client.eventSize}`);
-}
+await starter(client, starterOptions);
 
-test()
 ```
+
 </details>
 
-## [![Typing SVG](https://readme-typing-svg.herokuapp.com?font=Fira+Code&pause=1000&color=FF0000&repeat=false&width=435&lines=🧱+Builder)](#)
+## ⚙️ function
 
-**Build 🔵Button , 🧾Menu or 🏅PermissionChecker**
 - **Easyest ✨**
 - **Fastest ⚡**
 - **Clear 🧵**
 
 **Than the discord.js**
 
-
-
-
-
 <details>
-    <summary>🔵 ButtonManager</summary>
-
+    <summary>CreateRow 🔵</summary>
 
+**🔵 CreateRow is a utility for managing the creation of Discord Row ✨.**
 
-**🔵 ButtonManager is a utility class for managing the creation of Discord buttons ✨.**
+```js
+const { CreateRow } = require('djs-builder');
 
-```typescript
-const { ButtonManager } = require('djs-builder'); // Cjs module .js
-// OR
-import { ButtonManager } from 'djs-builder'; // Ejs module .mjs or Ts
+const actionRow = new CreateRow([
 
-// Define button data
-const buttonsData = [
-  {
-    customId: 'button1',
-    style: 'Primary',// style: Primary, Secondary, Link, Danger, Success
+//// for any row add new [] or {}
+// for buttom
+[
+      {
+    id: 'button1', //  ID for the button customId
+    style: 1,  // style: Primary(1), Secondary(2), Success(3), Danger(4), Link(5)
     label: 'Primary Button',
     emoji: '😃',  // Emoji for the button
-    disabled: false,  // Whether the button is disabled
+    enabled: false,  // Whether the button is disabled
   },
   {
-    customId: 'button2',
-    style: 'Secondary',
-    label: 'Secondary Button',
+    id: 'button2',
+    style: 2,
     emoji: '🚀',
-    disabled: true,
-  },
-  {
-    style: 'Link',
-    label: 'Link Button',
-    url: 'https://example.com',  // URL for link-style button
-    emoji: '🔗',
-  },
-];
-
-// Create an instance of ButtonManager
-const actionRow = new ButtonManager(buttonsData);
+    enabled: true,
+  }
+], ///// now it is row 1 for button and you can add more rows
+{
+    type : "string" /// you can select from ["role" , "user" , "channel" ]
+    options : {
+        id: "menu", // ID for the select menu customId
+        placeholder: "Select an option", // Placeholder text for the select menu
+        min: 1, // Minimum number of selected values
+        max: 2, // Maximum number of selected values
+        data: [ // you shuld add your options (it not work for role , user and channel)
+          { name: 'Option 1', id: 'option1', about: 'Description for Option 1', icon: '🌟' },
+          { name: 'Option 2', id: 'option2', about: 'Description for Option 2', icon: '🚀' },
+          { name: 'Option 3', id: 'option3', about: 'Description for Option 3', icon: '🔗' },
+        ],  //// is should not look like this ,you selecit it in next step
+        value: "id", // here you can set the value of the selected option ( defult the value is will be index (0,1,2 .....) )
+        description: "about" // here you can set the description of the selected option ( defult the description not work )
+        label: "name" // here you can set the label of the selected option ( defult the label is (Option 1 , Option 2 , Option 3) )
+        emoji: "icon" // here you can set the emoji of the selected option ( defult the emoji not work )
 
-// Buttons Row add it into components
-const row = actionRow.ButtonBuild();
+    }
+}
+]);
 
-// Exmaple 
-const message = await interaction.channel.send({ content: 'Here are some buttons:', components: [row] });
-// OR
-const message = await message.channel.send({ content: 'Here are some buttons:', components: [row] });
 ```
+
 </details>
 
+<details>
+    <summary>CreateBar 🧾</summary>
 
+**🧾 CreateBar it ✨.**
 
-<details>
-    <summary>🧾 MenuManager</summary>
+```js
+const { CreateBar } = require("djs-builder");
+
+const menu = new CreateBar(0, 100, {
+  lenth: 20,
+  fill: "✅",
+  empty: "❌",
+  partialChar: "⏳",
+  showPercent: true,
+  left: "[",
+  right: "]",
+});
+```
 
+you can do any type of bar you want like
 
+```js
+createProgressBar(3.7, 5, {
+  filledChar: '🟦',
+  emptyChar: '⬛',
+  partialChar: '🟨',
+  leftEdge: '❰',
+  rightEdge: '❱',
+  precision: 1
+});
+// ❰🟦🟦🟦🟨⬛❱ 74.0%
 
-**🧾 MenuManager facilitates the creation of select menus (dropdown menus) in Discord ✨.**
 
-```typescript
-const { MenuManager } = require('djs-builder'); // Cjs module .js
-// OR
-import { MenuManager } from 'djs-builder'; // Ejs module .mjs or ts
 
-// Define select menu options
-const selectMenuOptions = [
-  { label: 'Option 1', value: 'option1', description: 'Description for Option 1', emoji: '🌟', default: true },
-  { label: 'Option 2', value: 'option2', description: 'Description for Option 2', emoji: '🚀' },
-  { label: 'Option 3', value: 'option3', description: 'Description for Option 3', emoji: '🔗' },
-];
+console.log(createProgressBar(7, 10, {
+  length: 20,
+  filledChar: '💚',
+  emptyChar: '🖤',
+}));
 
-// Create an instance of SelectMenuManager
-const selectMenuManager = new MenuManager(
-  selectMenuOptions,
-  'customSelectMenuId',  // Custom ID for the select menu
-  'Select an option',    // Placeholder text for the select menu
-  1,                      // Minimum number of selected values
-  2,                       // Maximum number of selected values
-  false                   // Disabled state for meny (true or false)
-);
 
-// Create a select menu with the specified options
-const selectMenuRow = selectMenuManager.createSelectMenu();
 
-// Define a message with the select menu
- message.reply({
-  content: 'Please choose an option:',
-  components: [selectMenuRow],
-});
+[💚💚💚💚💚💚💚🖤🖤🖤🖤🖤🖤🖤🖤🖤🖤🖤🖤] 70%
+
 
-// Define a interaction with the select menu
- interaction.reply({
-  content: 'Please choose an option:',
-  components: [selectMenuRow],
-});
 ```
 
 </details>
 
 <details>
-    <summary>🏅 PermissionChecker</summary>
-
-
-
-**PermissionChecker provides functionality for checking user permissions in a Discord guild ✨.**
+    <summary>Wait ⏰</summary>
 
-```typescript
-const { PermissionChecker } =  require('djs-builder'); // Cjs module .js
-// OR
-import { PermissionChecker } from 'djs-builder'; // Ejs module .mjs or ts
+**⏰ Wait insted of collecter 🤮 ✨.**
 
-const perms = new PermissionChecker();
-
-// Interaction case
-const userId = interaction.user.id;
-const guild = interaction.guild;
-// Message Case
-const guild = message.guild;
-const memberId = message.author.id;
-
-// Usage:
+```js
+const { Wait } =  require('djs-builder');
 
-const permToCheck = ['ManageGuild', 'BanMembers']
-perms.checker(userId, guild, permToCheck)
+const message = await Wait({
+    context: message, /// message or interaction
+    userId : (message.author.id || interaction.user.id), /// user id
+     type: "button", /// message or button or both 💪
+      time: 30000 /// time in ms
+      message_Wait : message /// message of button (for button or both)
+       });
 
 ```
-</details>
 
-## Options: 
- 
-- **Slash 🔧**
-<details>
-<summary>Options</summary>
-
-- Cooldown ⏳
 </details>
 
-- **Prefix ➕**
 <details>
-<summary>Options</summary>
+    <summary>log 📸</summary>
 
-- Cooldown ⏳
-- Owner 👑
-- Usage 🙎‍♂️
-- Description 📜
-- Category 📁
+**📸 Log For All Discord Events ✨.**
+
+```js
+const { log } = require("djs-builder");
+
+module.exports = {
+  name: "ready",
+  async run(client) {
+    await log(
+      client,
+      "YOUR_GUILD_ID", /// your guild id
+      "YOUR_CHANNEL_ID" /// your log channel id
+    );
+  },
+};
+```
 
 </details>
 
-- **Events 🎊**
+## 🔧 Commands
+
+- **Slash 🔧** and **Prefix 📨** Have Same Options
 <details>
 <summary>Options</summary>
 
-- intializer
-- retryAttempts
-- execute once
-- execute for specific times
-- timeout
-- name
+```js
+cooldown : 5, /// cooldown in seconds
+permissions : ["ADMINISTRATOR"], /// permission for slash command
+ownerOnly : true ,/// only owner can use slash command
+devOnly : true /// only dev can use slash command
+guildOnly : true /// only guild can use slash command
+dmOnly : true /// only dm can use slash command
+```
+
 </details>
 
 ## Contributions
@@ -429,4 +252,3 @@ perms.checker(userId, guild, permToCheck)
 Contributions are welcome! If you have any suggestions, bug reports, or feature requests, feel free to contact us on discord.
 
 [![Discord Banner](https://api.weblutions.com/discord/invite/CS2NRSPyze/)](https://discord.gg/CS2NRSPyze)
-Package Sidebar