@somehiddenkey/discord-command-utils 2.1.1 → 2.2.0

package/README.md

@@ -27,27 +27,14 @@ export const localConfig = LocalConfig.load("./configs/local_config.json");
 Your local configuration JSON file should look like this:
 ```json
 {
-	"production": {
-		"prefix": "!",
-		"client_id": "123456789123456789",
-		"local": {
-            "any_local_configuration": "any values"
-		},
-		"rest_options" : {
-			"version": "10",
-			"rejectOnRateLimit": ["/channels"]
-		}
+	"prefix": "!",
+	"client_id": "123456789123456789",
+	"local": {
+		"any_local_configuration": "any values"
 	},
-	"development": {
-		"prefix": "!",
-    	"client_id": "123456789123456789",
-		"local": {
-			"any_local_configuration": "any values"
-		},
-    	"rest_options" : {
-			"version": "10",
-			"rejectOnRateLimit": ["/channels"]
-		}
+	"rest_options" : {
+		"version": "10",
+		"rejectOnRateLimit": ["/channels"]
 	},
 	"activity": {
 		"name": "the communities",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@somehiddenkey/discord-command-utils",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "A utility library for building Discord bot commands using discord.js",
   "author": {
     "email": "k3y.throwaway@gmail.com",

package/src/Configs/GlobalConfig/GlobalConfig.js

@@ -3,19 +3,22 @@
  */
 
 import fs from 'fs';
-import consola from 'consola';
 import { InteractionScope } from "../../Utils/enums.js";
-import {default as GuildMain} from './GlobalConfigMain.js';
-import {default as GuildCommunity} from './GlobalConfigCommunity.js';
-import {default as GuildTutor} from './GlobalConfigTutor.js';
-import {default as GuildStaff} from './GlobalConfigStaff.js';
+import GuildMain from './GlobalConfigMain.js';
+import GuildCommunity from './GlobalConfigCommunity.js';
+import GuildTutor from './GlobalConfigTutor.js';
+import GuildStaff from './GlobalConfigStaff.js';
 import { GuildBased } from '../NestedGlobalConfig.js';
 import { Client } from 'discord.js';
 
 export default class GlobalConfig {
+    /** @type {GuildMain} */
     main
+    /** @type {GuildCommunity} */
     community
+    /** @type {GuildTutor} */
     tutor
+    /** @type {GuildStaff} */
     staff
     
     /**
@@ -29,11 +32,10 @@ export default class GlobalConfig {
         try {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });
             json = JSON.parse(raw);
+            return new GlobalConfig(json.guilds, bot);
         } catch (error) {
-            consola.error(`Failed to load GlobalConfig from path: ${path}`, error);
-            throw error;
+            throw new ConfigError(`Failed to load GlobalConfig from path: ${path}`, error);
         }
-        return new GlobalConfig(json.guilds, bot);
     }
 
         /**
@@ -75,10 +77,14 @@ export default class GlobalConfig {
     }
 
     constructor(data, bot) {
-        this.main = new GuildMain(data.main, bot);
-        this.community = new GuildCommunity(data.community, bot);
-        this.tutor = new GuildTutor(data.tutor, bot);
-        this.staff = new GuildStaff(data.staff, bot);
+        const { main, community, tutor, staff } = data;
+        if (!main || !community || !tutor || !staff)
+            throw new ConfigError('All guild sections (main, community, tutor, staff) are required to initialize GlobalConfig');
+
+        this.main = new GuildMain(main, bot);
+        this.community = new GuildCommunity(community, bot);
+        this.tutor = new GuildTutor(tutor, bot);
+        this.staff = new GuildStaff(staff, bot);
     }
 }
 

package/src/Configs/GlobalConfig/GlobalConfigCommunity.js

@@ -7,14 +7,14 @@ import pkg from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
-export default class Guild extends GuildBased {
-    /** @type {Categories} */
+export default class GuildCommunity extends GuildBased {
+    /** @type {CategoriesCommunity} */
     categories;
-    /** @type {Channels} */
+    /** @type {ChannelsCommunity} */
     channels;
-    /** @type {Logs} */
+    /** @type {LogsCommunity} */
     logs;
-    /** @type {Roles} */
+    /** @type {RolesCommunity} */
     roles;
 
     constructor(data) {
@@ -22,17 +22,17 @@ export default class Guild extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data);
-        this.categories = new Categories(data.categories, data.id);
-        this.channels = new Channels(data.channels, data.id);
-        this.logs = new Logs(data.logs, data.id);
-        this.roles = new Roles(data.roles, data.id);
+        this.categories = new CategoriesCommunity(data.categories, this.guild);
+        this.channels = new ChannelsCommunity(data.channels, this.guild);
+        this.logs = new LogsCommunity(data.logs, this.guild);
+        this.roles = new RolesCommunity(data.roles, this.guild);
     }
 }
 
-class Categories extends ChannelBased {}
+class CategoriesCommunity extends ChannelBased {}
 
-class Channels extends ChannelBased {}
+class ChannelsCommunity extends ChannelBased {}
 
-class Logs extends ChannelBased {}
+class LogsCommunity extends ChannelBased {}
 
-class Roles extends RoleBased {}
+class RolesCommunity extends RoleBased {}

package/src/Configs/GlobalConfig/GlobalConfigMain.js

@@ -7,14 +7,14 @@ import pkg from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
-export default class Guild extends GuildBased {
-    /** @type {Categories} */
+export default class GuildMain extends GuildBased {
+    /** @type {CategoriesMain} */
     categories;
-    /** @type {Channels} */
+    /** @type {ChannelsMain} */
     channels;
-    /** @type {Logs} */
+    /** @type {LogsMain} */
     logs;
-    /** @type {Roles} */
+    /** @type {RolesMain} */
     roles;
 
     constructor(data, bot) {
@@ -22,14 +22,14 @@ export default class Guild extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data, bot);
-        this.categories = new Categories(data.categories, this.guild);
-        this.channels = new Channels(data.channels, this.guild);
-        this.logs = new Logs(data.logs, this.guild);
-        this.roles = new Roles(data.roles, this.guild);
+        this.categories = new CategoriesMain(data.categories, this.guild);
+        this.channels = new ChannelsMain(data.channels, this.guild);
+        this.logs = new LogsMain(data.logs, this.guild);
+        this.roles = new RolesMain(data.roles, this.guild);
     }
 }
 
-class Categories extends ChannelBased {
+class CategoriesMain extends ChannelBased {
     /** @type {Set<Snowflake>} */
     custom_rooms;       
     /** @type {Set<Snowflake>} */
@@ -72,7 +72,7 @@ class Categories extends ChannelBased {
     }
 }
 
-class Channels extends ChannelBased {
+class ChannelsMain extends ChannelBased {
     /** @type {GuildBasedChannel} */
     timer_control;
     /** @type {GuildBasedChannel} */
@@ -101,7 +101,7 @@ class Channels extends ChannelBased {
     welcome;
 }
 
-class Logs extends ChannelBased {
+class LogsMain extends ChannelBased {
     /** @type {GuildBasedChannel} */
     error;
     /** @type {GuildBasedChannel} */
@@ -118,7 +118,7 @@ class Logs extends ChannelBased {
     communities;
 }
 
-class Roles extends RoleBased {
+class RolesMain extends RoleBased {
     /** @type {Snowflake} */
     cuckoo_ping;
     /** @type {Snowflake} */

package/src/Configs/GlobalConfig/GlobalConfigStaff.js

@@ -7,14 +7,14 @@ import pkg from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
-export default class Guild extends GuildBased {
-    /** @type {Categories} */
+export default class GuildStaff extends GuildBased {
+    /** @type {CategoriesStaff} */
     categories;
-    /** @type {Channels} */
+    /** @type {ChannelsStaff} */
     channels;
-    /** @type {Logs} */
+    /** @type {LogsStaff} */
     logs;
-    /** @type {Roles} */
+    /** @type {RolesStaff} */
     roles;
 
     constructor(data, bot) {
@@ -22,17 +22,17 @@ export default class Guild extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data, bot);
-        this.categories = new Categories(data.categories, data.id);
-        this.channels = new Channels(data.channels, data.id);
-        this.logs = new Logs(data.logs, data.id);
-        this.roles = new Roles(data.roles, data.id);
+        this.categories = new CategoriesStaff(data.categories, this.guild);
+        this.channels = new ChannelsStaff(data.channels, this.guild);
+        this.logs = new LogsStaff(data.logs, this.guild);
+        this.roles = new RolesStaff(data.roles, this.guild);
     }
 }
 
-class Categories extends ChannelBased {}
+class CategoriesStaff extends ChannelBased {}
 
-class Channels extends ChannelBased {}
+class ChannelsStaff extends ChannelBased {}
 
-class Logs extends ChannelBased {}
+class LogsStaff extends ChannelBased {}
 
-class Roles extends RoleBased {}
+class RolesStaff extends RoleBased {}

package/src/Configs/GlobalConfig/GlobalConfigTutor.js

@@ -7,14 +7,14 @@ import pkg from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
-export default class Guild extends GuildBased {
-    /** @type {Categories} */
+export default class GuildTutor extends GuildBased {
+    /** @type {CategoriesTutor} */
     categories;
-    /** @type {Channels} */
+    /** @type {ChannelsTutor} */
     channels;
-    /** @type {Logs} */
+    /** @type {LogsTutor} */
     logs;
-    /** @type {Roles} */
+    /** @type {RolesTutor} */
     roles;
 
     constructor(data, bot) {
@@ -22,17 +22,17 @@ export default class Guild extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data, bot);
-        this.categories = new Categories(data.categories, data.id);
-        this.channels = new Channels(data.channels, data.id);
-        this.logs = new Logs(data.logs, data.id);
-        this.roles = new Roles(data.roles, data.id);
+        this.categories = new CategoriesTutor(data.categories, this.guild);
+        this.channels = new ChannelsTutor(data.channels, this.guild);
+        this.logs = new LogsTutor(data.logs, this.guild);
+        this.roles = new RolesTutor(data.roles, this.guild);
     }
 }
 
-class Categories extends ChannelBased {}
+class CategoriesTutor extends ChannelBased {}
 
-class Channels extends ChannelBased {}
+class ChannelsTutor extends ChannelBased {}
 
-class Logs extends ChannelBased {}
+class LogsTutor extends ChannelBased {}
 
-class Roles extends RoleBased {}
+class RolesTutor extends RoleBased {}

package/src/Configs/LocalConfig.js

@@ -33,21 +33,16 @@ export default class LocalConfig {
     /**
      * Loads the JSON file and returns a GlobalConfig instance.
      * @param {string} path
-     * @param {string} environment
      * @returns {LocalConfig}
      */
-    static async load(path, environment) {
+    static async load(path) {
         var json
         try {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });
             json = JSON.parse(raw);
+            return new LocalConfig(json);
         } catch (error) {
-            consola.error(`Failed to load LocalConfig from path: ${path}`, error);
-            throw error;
+            throw new ConfigError(`Failed to load LocalConfig from path: ${path}`, error);
         }
-        if (environment == "production") 
-            return new LocalConfig({...json.production || json.activity});
-        else 
-            return new LocalConfig({...json.development || json.activity});
     }
 }

package/src/Configs/SecretConfig.js

@@ -27,7 +27,7 @@ export default class SecretConfig {
         this.token = env.TOKEN;
 
         var databaseConfigs = [];
-        for (let index = 0, section = "DATABASE__"+index; !!env[section+"__NAME"]; index++) {
+        for (let index = 0, section = "DATABASE__"+index; !!env[section+"__NAME"]; index++, section = "DATABASE__"+index) {
             try {
                 let db_config = {
                     client: 'mysql',