@somehiddenkey/discord-command-utils 2.2.0 → 2.4.0

package/package.json

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

package/src/Configs/ConfigError.js

@@ -1,6 +1,10 @@
 export default class ConfigError extends Error {
-  constructor(message) {
-    super(message);
+  constructor(message, cause) {
+    if (cause) {
+      super(message, { cause });
+    } else {
+      super(message);
+    }
     this.name = "ConfigError";
   }
 }

package/src/Configs/GlobalConfig/GlobalConfig.js

@@ -10,6 +10,7 @@ import GuildTutor from './GlobalConfigTutor.js';
 import GuildStaff from './GlobalConfigStaff.js';
 import { GuildBased } from '../NestedGlobalConfig.js';
 import { Client } from 'discord.js';
+import ConfigError from '../ConfigError.js';
 
 export default class GlobalConfig {
     /** @type {GuildMain} */
@@ -27,18 +28,20 @@ export default class GlobalConfig {
      * @param {Client} bot
      * @returns {GlobalConfig}
      */
-    static async load(path, bot) {
+    static load(path, bot) {
         var json;
         try {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });
             json = JSON.parse(raw);
-            return new GlobalConfig(json.guilds, bot);
+            const g = new GlobalConfig(json.guilds, bot);
+            consola.start(`Loaded GlobalConfig from path: ${path}`);
+            return g;
         } catch (error) {
             throw new ConfigError(`Failed to load GlobalConfig from path: ${path}`, error);
         }
     }
 
-        /**
+    /**
      * @param {Snowflake} guild_id 
      * @returns {InteractionScope} scope
      */

package/src/Configs/GlobalConfig/GlobalConfigCommunity.js

@@ -31,8 +31,25 @@ export default class GuildCommunity extends GuildBased {
 
 class CategoriesCommunity extends ChannelBased {}
 
-class ChannelsCommunity 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;
 
@@ -29,10 +29,42 @@ export default class GuildStaff extends GuildBased {
     }
 }
 
-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;
 
@@ -29,10 +29,31 @@ export default class GuildTutor extends GuildBased {
     }
 }
 
-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

@@ -35,7 +35,7 @@ export default class LocalConfig {
      * @param {string} path
      * @returns {LocalConfig}
      */
-    static async load(path) {
+    static load(path) {
         var json
         try {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });

package/src/Configs/SecretConfig.js

@@ -40,12 +40,12 @@ export default class SecretConfig {
                 }
 
                 databaseConfigs.push(db_config);
-                consola.start(`Loaded database config for section: ${section}`);
             } catch (error) {
                 consola.error(`Failed to load database config for section: ${section}`, error);
                 throw error;
             }
         }
         this.databaseConfig = databaseConfigs;
+        consola.start(`Loaded SecretConfig for environment: ${this.environment}`);
     }
 }