@somehiddenkey/discord-command-utils 2.1.2 → 2.3.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.2",
+  "version": "2.3.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,7 +3,6 @@
  */
 
 import fs from 'fs';
-import consola from 'consola';
 import { InteractionScope } from "../../Utils/enums.js";
 import GuildMain from './GlobalConfigMain.js';
 import GuildCommunity from './GlobalConfigCommunity.js';
@@ -33,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);
     }
 
         /**
@@ -79,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

@@ -22,17 +22,34 @@ export default class GuildCommunity extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data);
-        this.categories = new CategoriesCommunity(data.categories, data.id);
-        this.channels = new ChannelsCommunity(data.channels, data.id);
-        this.logs = new LogsCommunity(data.logs, data.id);
-        this.roles = new RolesCommunity(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 CategoriesCommunity extends ChannelBased {}
 
-class Channels extends ChannelBased {}
+class ChannelsCommunity extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    general;
+    /** @type {GuildBasedChannel} */
+    com_requests;
+    /** @type {GuildBasedChannel} */
+    managers;
+    /** @type {GuildBasedChannel} */
+    staff;
+}
 
-class LogsCommunity extends ChannelBased {}
+class LogsCommunity extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    communities;
+}
 
-class RolesCommunity extends RoleBased {}
+class RolesCommunity extends RoleBased {
+    /** @type {Role} */
+    staff;
+    /** @type {Role} */
+    com_manager;
+}

package/src/Configs/GlobalConfig/GlobalConfigMain.js

@@ -3,7 +3,7 @@
  */
 
 import ConfigError from "../ConfigError.js";
-import pkg from 'discord.js';
+import pkg, { Role } from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
@@ -114,52 +114,50 @@ class LogsMain extends ChannelBased {
     invites;
     /** @type {GuildBasedChannel} */
     command;    
-    /** @type {GuildBasedChannel} */
-    communities;
 }
 
 class RolesMain extends RoleBased {
-    /** @type {Snowflake} */
+    /** @type {Role} */
     cuckoo_ping;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     developer
-    /** @type {Snowflake} */
+    /** @type {Role} */
     forest_ping;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     helper;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     member;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     music;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     muted;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     no_pc;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     screen_cam;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     studying;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     timer_25;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     timer_50;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     tutor;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     verified_com;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     water_ping;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     deepfocus;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     sr_staff;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     staff;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     jr_staff;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     st_team;
-    /** @type {Snowflake} */
+    /** @type {Role} */
     coordinator;
 
     /** @type {Set<Snowflake>} */
@@ -168,6 +166,6 @@ class RolesMain extends RoleBased {
 
     constructor(data, guild) {        
         super(data, guild);
-        this.all_staff = [this.jr_staff, this.sr_staff, this.st_team, this.coordinator];
+        this.all_staff = new Set([data.jr_staff, data.sr_staff, data.st_team, data.coordinator]);
     }
 }

package/src/Configs/GlobalConfig/GlobalConfigStaff.js

@@ -3,7 +3,7 @@
  */
 
 import ConfigError from "../ConfigError.js";
-import pkg from 'discord.js';
+import pkg, {Role} from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
@@ -22,17 +22,49 @@ export default class GuildStaff extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data, bot);
-        this.categories = new CategoriesStaff(data.categories, data.id);
-        this.channels = new ChannelsStaff(data.channels, data.id);
-        this.logs = new LogsStaff(data.logs, data.id);
-        this.roles = new RolesStaff(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 CategoriesStaff extends ChannelBased {}
-
-class ChannelsStaff extends ChannelBased {}
+class CategoriesStaff extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    modmail;
+}
 
+class ChannelsStaff extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    staff;
+    /** @type {GuildBasedChannel} */
+    sr_staff;
+    /** @type {GuildBasedChannel} */
+    developer;
+    /** @type {GuildBasedChannel} */
+    commands;
+}
 class LogsStaff extends ChannelBased {}
 
-class RolesStaff extends RoleBased {}
+class RolesStaff extends RoleBased {
+    /** @type {Role} */
+    int_coordinator;
+    /** @type {Role} */
+    ext_coordinator;
+    /** @type {Role} */
+    modmail_access;
+    /** @type {Role} */
+    sr_staff;
+    /** @type {Role} */
+    staff;
+    /** @type {Role} */
+    jr_staff;
+    /** @type {Role} */
+    developer;
+    /** @type {Role} */
+    sr_developer;
+    /** @type {Role} */
+    helper;
+    /** @type {Role} */
+    events;
+}

package/src/Configs/GlobalConfig/GlobalConfigTutor.js

@@ -3,7 +3,7 @@
  */
 
 import ConfigError from "../ConfigError.js";
-import pkg from 'discord.js';
+import pkg, {Role} from 'discord.js';
 import { GuildBased, ChannelBased, RoleBased } from '../NestedGlobalConfig.js';
 const { GuildBasedChannel } = pkg;
 
@@ -22,17 +22,38 @@ export default class GuildTutor extends GuildBased {
             throw new ConfigError('No data initialized for GlobalConfig');
 
         super(data, bot);
-        this.categories = new CategoriesTutor(data.categories, data.id);
-        this.channels = new ChannelsTutor(data.channels, data.id);
-        this.logs = new LogsTutor(data.logs, data.id);
-        this.roles = new RolesTutor(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 CategoriesTutor extends ChannelBased {}
+class CategoriesTutor extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    staff;
+}
 
-class ChannelsTutor extends ChannelBased {}
+class ChannelsTutor extends ChannelBased {
+    /** @type {GuildBasedChannel} */
+    general;
+    /** @type {GuildBasedChannel} */
+    commands;
+    /** @type {GuildBasedChannel} */
+    staff_commands;
+    /** @type {GuildBasedChannel} */
+    applications;
+}
 
 class LogsTutor extends ChannelBased {}
 
-class RolesTutor extends RoleBased {}
+class RolesTutor extends RoleBased {
+    /** @type {Role} */
+    staff;
+    /** @type {Role} */
+    dev;
+    /** @type {Role} */
+    tutor;
+    /** @type {Role} */
+    sr_tutor;
+}

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});
     }
 }